Class Layers

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

Hierarchy (View Summary)

Entity
- Layers

Index

Properties

canAdd combinedIds id meta type

Methods

add contains find getDirectlyReferencedEntities getMeta getOwnedEntities getTypeName getTypeName isOfType isSame remove

Properties

`Readonly`canAdd

canAdd: boolean

Check if another layer can be added to this entity.

`Readonly`combinedIds

combinedIds: LayerSet

The LayerSet which represents this entity.

`Readonly`id

id: Uuid

The unique id of the entity.

`Readonly`meta

meta: Meta

`Readonly`type

type: string

The entity's type.

Methods

add

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

contains

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

find

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

getDirectlyReferencedEntities

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

Returns Entity[]
Inherited from Entity.getDirectlyReferencedEntities

`Static`getMeta

getMeta(): Meta
Returns Meta
Overrides Entity.getMeta

getOwnedEntities

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

Returns Entity[]
Inherited from Entity.getOwnedEntities

`Static`getTypeName

getTypeName(): string
Returns string
Overrides Entity.getTypeName

getTypeName

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

isOfType

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

isSame

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

remove

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