Class Entity

The Entity class represents an entity in the Editor.

Hierarchy

  • Events
    • Entity

Internal

constructor addChild insertChild removeChild

Other

children history observer parent viewportEntity addComponent addScript delete depthFirst duplicate filter findByName get has insert isDescendantOf json jsonHierarchy latest listByTag removeComponent removeScript removeValue reparent set unset

Internal

constructor

addChild

insertChild

  • insertChild(entity: Entity, index?: number): boolean

    Inserts entity as a child at specified index.

    Parameters

    • entity: Entity

      The entity

    • index: number = undefined

      The index. If undefined the child will be added in the end.

    Returns boolean

    Whether the child was added

removeChild

Other

children

history

observer

parent

viewportEntity

addComponent

  • addComponent(component: string, data?: {}): void

    Adds a component to this Entity

    Parameters

    • component: string

      The component name

    • data: {} = {}

      Default component data. Defaults values will be used for any missing fields. For details on component properties see Entity.

    Returns void

    Example

    editor.entities.root.addComponent('model', {
        type: 'box'
    });

addScript

  • addScript(
        scriptName: string,
        options?: { attributes?: object; history?: boolean; index?: number },
    ): Promise<void>

    Adds a script to the script component of this entity. If a script component does not exist, this method will add the script component as well.

    Parameters

    • scriptName: string

      The name of the script.

    • options: { attributes?: object; history?: boolean; index?: number } = {}
      • Optionalattributes?: object

        The values of attributes. Each key is the name of the attributes and each value is the value for that attribute. Leave undefined to let the Editor set default values depending on the attribute types.

      • Optionalhistory?: boolean

        Whether to add a history action. Defaults to true.

      • Optionalindex?: number

        The desired index in the entity's scripts order to add this script.

    Returns Promise<void>

    A promise

delete

  • delete(options?: { history?: boolean }): Promise<void>

    Deletes entity (and its children)

    Parameters

    • options: { history?: boolean } = {}
      • Optionalhistory?: boolean

        Whether to record a history action. Defaults to true.

    Returns Promise<void>

    A promise

    Example

    editor.entities.root.findByName('door').delete();

depthFirst

  • depthFirst(fn: (entity: Entity) => void): void

    Executes function for this entity and its children in depth first order.

    Parameters

    • fn: (entity: Entity) => void

      A function that takes an entity as an argument

    Returns void

    Example

    // get a list of all entities in the graph in depth first order
    const entities = [];
    editor.entities.root.depthFirst(entity => entities.push(entity));

duplicate

  • duplicate(
        options?: { history?: boolean; rename?: boolean; select?: boolean },
    ): Promise<any>

    Duplicates entity under the same parent

    Parameters

    • options: { history?: boolean; rename?: boolean; select?: boolean } = {}
      • Optionalhistory?: boolean

        Whether to record a history action. Defaults to true.

      • Optionalrename?: boolean

        Whether to rename the duplicated entity. Defaults to false.

      • Optionalselect?: boolean

        Whether to select the new entity. Defaults to false.

    Returns Promise<any>

    The new entity

filter

  • filter(fn: (entity: Entity) => boolean): Entity[]

    Returns the entity and children that satisfy the function

    Parameters

    • fn: (entity: Entity) => boolean

      A function that takes an Entity and returns whether it should be included in the result

    Returns Entity[]

    The result

    Example

    const doors = editor.entities.root.filter(entity => entity.get('name').startsWith('door'));

findByName

  • findByName(name: string): Entity

    Finds first entity by name using depth-first search

    Parameters

    • name: string

      The name

    Returns Entity

    The entity

    Example

    const door = editor.entities.root.findByName('Door');

get

  • get(path: string): any

    Gets value at path. See Entity for a list of properties.

    Parameters

    • path: string

      The path

    Returns any

    The value

    Example

    console.log(entity.get('position'));

has

  • has(path: string): boolean

    Checks if path exists. See Entity for a list of properties.

    Parameters

    • path: string

      The path

    Returns boolean

    True if path exists

    Example

    console.log(entity.has('components.model'));

insert

  • insert(path: string, value: any, index?: number): boolean

    Inserts value in array at path, at specified index. See Entity for a list of properties.

    Parameters

    • path: string

      The path

    • value: any

      The value

    • Optionalindex: number

      The index (if undefined the value will be inserted in the end)

    Returns boolean

    Whether the value was inserted

    Example

    entity.insert('tags', 'a_tag');

isDescendantOf

json

jsonHierarchy

  • jsonHierarchy(): any

    Returns a JSON representation of entity data. The children array of the entity gets recursively converted to an array of entity data instead of containing children resource ids.

    Returns any

    • The data

    Example

    const data = entity.jsonHierarchy();
    console.log(data.children[0].name);

latest

listByTag

  • listByTag(...tags: any[]): Entity[]

    Finds all entities with specified tags

    Parameters

    • ...tags: any[]

      The tags. If multiple tags are specified then entities that contain ANY of the specified tags will be included. If an argument is an array of tags then entities that contain ALL of the tags in the array will be included.

    Returns Entity[]

    The entities

    Example

    // entities that have the following tag
    const entities = editor.entities.root.listByTag('tag');
    // entities that have any of the following tags
    const entities = editor.entities.root.listByTag('tag', 'tag2');
    // entities that have all of the following tags
    const entities = editor.entities.root.listByTag(['tag', 'tag2']);

removeComponent

  • removeComponent(component: string): void

    Removes a component from this Entity

    Parameters

    • component: string

      The component name

    Returns void

    Example

    editor.entities.root.removeComponent('model');

removeScript

  • removeScript(scriptName: string, options?: { history?: boolean }): void

    Removes a script from the entity's script component.

    Parameters

    • scriptName: string

      The name of the script.

    • options: { history?: boolean } = {}
      • Optionalhistory?: boolean

        Whether to record a history action. Defaults to true.

    Returns void

removeValue

  • removeValue(path: string, value: any): boolean

    Remove value from array at path. See Entity for a list of properties.

    Parameters

    • path: string

      The path

    • value: any

      The value

    Returns boolean

    Whether the value was removed

    Example

    entity.removeValue('tags', 'a_tag');

reparent

  • reparent(
        parent: Entity,
        index?: number,
        options?: { history?: boolean; preserveTransform?: boolean },
    ): void

    Reparents entity under new parent

    Parameters

    • parent: Entity

      The new parent

    • index: number = null

      The desired index. If undefined the entity will be added at the end of the parent's children.

    • options: { history?: boolean; preserveTransform?: boolean } = {}
      • Optionalhistory?: boolean

        Whether to record a history action. Defaults to true.

      • OptionalpreserveTransform?: boolean

        Whether to preserve the original transform after reparenting

    Returns void

    Example

    const redHouse = editor.entities.root.findByName('red house');
    const greenHouse = editor.entities.root.findByName('green house');
    const door = redHouse.findByName('door');
    door.reparent(greenHouse);

set

  • set(path: string, value: any): boolean

    Sets value at path. See Entity for a list of properties.

    Parameters

    • path: string

      The path

    • value: any

      The value

    Returns boolean

    Whether the value was set

    Example

    entity.set('position', [1, 0, 0]);

unset

  • unset(path: string): boolean

    Unsets value at path. See Entity for a list of properties.

    Parameters

    • path: string

      The path

    Returns boolean

    Whether the value was unset

    Example

    entity.unset('components.model');

Settings

Member Visibility

On This Page

Internal
Other