Editor API Reference - v1.1.4
    Preparing search index...

    Class Entities

    The entities editor API

    Hierarchy

    • Events
      • Entities
    Index

    Internal

    constructor add clear remove serverAdd serverRemove

    Other

    root addScript copyToClipboard create delete duplicate get list pasteFromClipboard removeScript reparent waitToExist

    Internal

    • Removes entity from the list

      Parameters

      • entity: Entity

        The entity

      • entityReferences: object = null

        A map of entity references to nullify when this entity is removed

      Returns void

    • Called when an entity is added from the server

      Parameters

      • entityData: { children: Entity[]; parent: Entity }

        The entity data

      Returns void

    • Called when an entity is removed from the server

      Parameters

      Returns void

    Other

    • Like Entity.addScript but works on multiple entities using a single history action.

      Parameters

      • entities: Entity[]

        The entities.

      • 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

    • Copy specified entities to localStorage clipboard. Can be used to paste these entities later on.

      Parameters

      • entities: Entity[]

        The entities

      Returns void

    • Creates new entity and adds it to the hierarchy

      Parameters

      • data: CreateEntityArguments = null

        Initial data for the entity

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

          Whether to record a history action. Defaults to true.

        • Optionalindex?: number

          The child index that this entity will have under its parent.

        • Optionalselect?: boolean

          Whether to select new Entity. Defaults to false.

      Returns Entity

      The new entity

      const root = editor.entities.create({
          name: 'parent',
      });

      const child = editor.entities.create({
          name: 'child',
          parent: root,
      });

    • Delete specified entities

      Parameters

      • entities: Entity | Entity[]

        The entities

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

          Whether to record a history action. Defaults to true.

      Returns Promise<void>

      await editor.entities.delete([entity1, entity2]);

    • Duplicates the specified entities under the same parent

      Parameters

      • entities: Entity[]

        The entities

      • 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 entities. Defaults to false.

        • Optionalselect?: boolean

          Whether to select the new entities. Defaults to false.

      Returns Promise<Entity[]>

      The duplicated entities

      const duplicated = await editor.entities.duplicate(entities);

    • Gets entity by resource id

      Parameters

      • id: string

        The entity's resource id

      Returns Entity

      The entity

      const entity = editor.entities.get(resourceId);

    • Returns array of all entities

      Returns any[]

      The entities

      const entities = editor.entities.list();
      console.log(entities.length);

    • Paste entities copied into clipboard under the specified parent.

      Parameters

      • parent: Entity

        The parent

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

          Whether to record a history action. Defaults to true.

      Returns Promise<Entity[]>

      The new entities

    • Like Entity.removeScript but works on multiple entities using a single history action.

      Parameters

      • entities: Entity[]

        The entities.

      • scriptName: string

        The name of the script.

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

          Whether to record a history action. Defaults to true.

      Returns void

    • Reparents entities under new parent.

      Parameters

      • data: ReparentArguments[]

        The reparenting data

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

          Whether to record history. Defaults to true

        • OptionalpreserveTransform?: boolean

          Whether to preserve the transform of the entities. Defaults to false.

      Returns void

      const child = editor.entities.create();
      const parent = editor.entities.create();
      editor.entities.reparent([{
          entity: child,
          parent: parent
      }])

    • Waits for specified entity ids to be added to the scene. Once they are the callback is called with the entities as its argument.

      Parameters

      • entityIds: string[]

        The ids of the entities to wait for

      • timeoutMs: number

        Number of ms to wait before stopping to wait

      • callback: (entities: Entity[]) => void

        The callback to call when all entities have been added. The signature is (Entity[]) => void.

      Returns () => void

      Returns a cancel function which can be called to cancel calling the callback when the entities are added.

    Settings

    Member Visibility

    On This Page

    Internal
    Other