Class Canvas`Beta`

Settings used with LensScripting.Canvas.

Hierarchy (View Summary, Expand)

Component
- Canvas

Index

Constructors

Properties

enabled id name pivot sceneObject sortingType type unitType worldSpaceRect

Methods

getDirectlyReferencedEntities getOwnedEntities getTypeName isOfType isSame remapReferences

Constructors

`Protected`constructor

new Canvas(): Canvas
Beta
Returns Canvas
Overrides Component.constructor

Properties

`Beta`enabled

enabled: boolean

`Readonly` `Beta`id

id: Uuid

The unique id of the entity.

`Beta`name

name: string

`Beta`pivot

pivot: vec2

`Readonly` `Beta`sceneObject

sceneObject: SceneObject

`Beta`sortingType

sortingType: SortingType

`Readonly` `Beta`type

type: string

The entity's type.

`Beta`unitType

unitType: UnitType

`Beta`worldSpaceRect

worldSpaceRect: Editor.Rect

Methods

getDirectlyReferencedEntities

getDirectlyReferencedEntities(): Entity[]
Beta
A list of entities which this entity has a reference to.

Returns Entity[]
Inherited from Component.getDirectlyReferencedEntities

getOwnedEntities

getOwnedEntities(): Entity[]
Beta
A list of entities which has a reference to this entity.

Returns Entity[]
Inherited from Component.getOwnedEntities

getTypeName

getTypeName(): string
Beta
Returns string
Inherited from Component.getTypeName

isOfType

isOfType(type: string): boolean
Beta
Parameters
- type: string
Returns boolean
Inherited from Component.isOfType

isSame

isSame(other: ScriptObject): boolean
Beta
Parameters
- other: ScriptObject
Returns boolean
Inherited from Component.isSame

remapReferences

remapReferences(referenceMapping: object): void
Beta
Swap this entity for another one based on a JSON of the current entity id and the target entity id.
Parameters
- referenceMapping: object
Returns void
Inherited from Component.remapReferences