Class Layers`Beta`

The layers of a {@Editor.Assets.Scene}.

Hierarchy (View Summary, Expand)

Entity
- Layers

Index

Constructors

Properties

canAdd combinedIds id type

Methods

add contains find getDirectlyReferencedEntities getOwnedEntities getTypeName isOfType isSame remapReferences remove

Constructors

`Protected`constructor

new Layers(): Layers
Beta
Returns Layers
Overrides Entity.constructor

Properties

`Readonly` `Beta`canAdd

canAdd: boolean

Check if another layer can be added to this entity.

`Readonly` `Beta`combinedIds

combinedIds: LayerSet

The LayerSet which represents this entity.

`Readonly` `Beta`id

id: Uuid

The unique id of the entity.

`Readonly` `Beta`type

type: string

The entity's type.

Methods

add

add(layerId: LayerId): Layer
Beta
Add layerId to this entity.
Parameters
- layerId: LayerId
Returns Layer

contains

contains(layerId: LayerId): boolean
Beta
Whether the layers contain layerId.
Parameters
- layerId: LayerId
Returns boolean

find

find(layerId: LayerId): Layer
Beta
Get the layer with layerId if possible.
Parameters
- layerId: LayerId
Returns Layer

getDirectlyReferencedEntities

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

Returns Entity[]
Inherited from Entity.getDirectlyReferencedEntities

getOwnedEntities

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

Returns Entity[]
Inherited from Entity.getOwnedEntities

getTypeName

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

isOfType

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

isSame

isSame(other: ScriptObject): boolean
Beta
Parameters
- other: ScriptObject
Returns boolean
Inherited from Entity.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 Entity.remapReferences

remove

remove(layerId: LayerId): void
Beta
Remove layerId from this entity.
Parameters
- layerId: LayerId
Returns void