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

    Type Alias EntityProps

    Represents an Entity.

    What follows is a reference for all possible asset paths that can be passed to functions such as Entity#get and Entity#set.

    Common Entity Properties:

    type EntityProps = {
        children: string[];
        components: Components;
        enabled: boolean;
        name: string;
        parent: string;
        position: number[];
        resource_id: string;
        rotation: number[];
        scale: number[];
        tags: string[];
        template_ent_ids: Record<string, string>;
        template_id: number;
    }
    Index

    Properties

    children: string[]

    An array that contains the resource_id's of the entity's children.

    []
    
    components: Components

    A dictionary that contains the components of the entity and their data.

    enabled: boolean

    Whether the entity is enabled.

    true
    
    name: string

    The name of the entity.

    parent: string

    The resource_id of the parent entity.

    position: number[]

    The position of the entity in local space (x, y, z).

    [0,0,0]
    
    resource_id: string

    The unique GUID of the entity.

    rotation: number[]

    The rotation of the entity in local space (rx, ry, rz euler angles in degrees).

    [0,0,0]
    
    scale: number[]

    The scale of the entity in local space (sx, sy, sz).

    [1,1,1]
    
    tags: string[]

    The tags of the entity.

    []
    
    template_ent_ids: Record<string, string>

    A dictionary of <resource_id, resource_id> pairs that maps the entity (and its children) to the respective Entities in the template asset.

    template_id: number

    The id of the Template asset that this entity is linked to.