Interface LayersBeta

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

interface Layers {
    canAdd: boolean;
    combinedIds: Editor.Model.LayerSet;
    id: Uuid;
    type: string;
    add(layerId: LayerId): Layer;
    contains(layerId: LayerId): boolean;
    find(layerId: LayerId): Layer;
    getDirectlyReferencedEntities(): Entity[];
    getOwnedEntities(): Entity[];
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    remapReferences(referenceMapping: object): void;
    remove(layerId: LayerId): void;
}

Hierarchy (view full)

Properties

canAdd combinedIds id type

Methods

add contains find getDirectlyReferencedEntities getOwnedEntities getTypeName isOfType isSame remapReferences remove

Properties

Readonly BetacanAdd

canAdd: boolean

Check if another layer can be added to this entity.

Readonly BetacombinedIds

combinedIds: Editor.Model.LayerSet

The LayerSet which represents this entity.

Readonly Betaid

id: Uuid

The unique id of the entity.

Readonly Betatype

type: string

The entity's type.

Methods

add

  • add(layerId): Layer
  • Beta

    Add layerId to this entity.

    Parameters

    Returns Layer

contains

  • contains(layerId): boolean
  • Beta

    Whether the layers contain layerId.

    Parameters

    Returns boolean

find

  • find(layerId): Layer
  • Beta

    Get the layer with layerId if possible.

    Parameters

    Returns Layer

getDirectlyReferencedEntities

getOwnedEntities

getTypeName

isOfType

  • isOfType(type): boolean
  • Beta

    Parameters

    • type: string

    Returns boolean

isSame

remapReferences

  • remapReferences(referenceMapping): 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

remove

  • remove(layerId): void
  • Beta

    Remove layerId from this entity.

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods