Render2DCanvas
Defined in: client/api.d.ts:314
Resource-owned root attached to one native Render2D layer.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Render2DCanvas():
Render2DCanvas
Returns
Section titled “Returns”Render2DCanvas
Methods
Section titled “Methods”clear()
Section titled “clear()”clear():
boolean
Defined in: client/api.d.ts:388
Destroys every node owned by this canvas.
Returns
Section titled “Returns”boolean
createContainer()
Section titled “createContainer()”createContainer(
options?):Render2DContainer|null
Defined in: client/api.d.ts:368
Creates a native parent node.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Render2DContainer | null
createRectangle()
Section titled “createRectangle()”createRectangle(
options?):Render2DRectangle|null
Defined in: client/api.d.ts:373
Creates a colored native rectangle.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Render2DRectangle | null
createText()
Section titled “createText()”createText(
options):Render2DText|null
Defined in: client/api.d.ts:378
Creates a native text region.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Render2DText | null
createTexture()
Section titled “createTexture()”createTexture(
options):Render2DTexture|null
Defined in: client/api.d.ts:383
Creates a textured native rectangle; unresolved resources remain hidden.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Render2DTexture | null
destroy()
Section titled “destroy()”destroy():
boolean
Defined in: client/api.d.ts:393
Destroys this canvas and all of its nodes.
Returns
Section titled “Returns”boolean
setClipRect()
Section titled “setClipRect()”setClipRect(
left,top,right,bottom):boolean
Defined in: client/api.d.ts:363
Sets the normalized clipping rectangle.
Parameters
Section titled “Parameters”number
number
number
bottom
Section titled “bottom”number
Returns
Section titled “Returns”boolean
Properties
Section titled “Properties”clipping
Section titled “clipping”clipping:
boolean
Defined in: client/api.d.ts:338
Canvas clipping state.
clipRect
Section titled “clipRect”
readonlyclipRect:Render2DRect
Defined in: client/api.d.ts:358
Current normalized clipping rectangle.
destroyed
Section titled “destroyed”
readonlydestroyed:boolean
Defined in: client/api.d.ts:328
Whether this handle is no longer valid.
readonlyid:number
Defined in: client/api.d.ts:318
Opaque canvas identifier.
readonlylayer:"foreground"|"hudHints"|"shopSubtitles"|"menus"|"phone"|"cutscene"|"hud"
Defined in: client/api.d.ts:323
Native layer name.
nonOverlapGroup
Section titled “nonOverlapGroup”nonOverlapGroup:
number
Defined in: client/api.d.ts:353
Native non-overlap group.
pixelClipping
Section titled “pixelClipping”pixelClipping:
boolean
Defined in: client/api.d.ts:343
Pixel clipping state.
useAllMonitors
Section titled “useAllMonitors”useAllMonitors:
boolean
Defined in: client/api.d.ts:348
Whether the canvas spans all monitors.
visible
Section titled “visible”visible:
boolean
Defined in: client/api.d.ts:333
Canvas visibility.