Class Entities

Creates new API instance

Adds entity to list

Removes all entities from the list

Removes entity from the list

Called when an entity is added from the server

Called when an entity is removed from the server

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

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

Creates new entity and adds it to the hierarchy

Example

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

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

Delete specified entities

Example

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

Duplicates the specified entities under the same parent

Example

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

Gets entity by resource id

Example

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

Returns array of all entities

Example

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

Paste entities copied into clipboard under the specified parent.

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

Reparents entities under new parent.

Example

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

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