Editor Scripting API
    Preparing search index...

    Class Visual

    Base class for visual components that control rendering order and appearance.

        const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
        const scene = model.project.scene;

        const obj = scene.createSceneObject('VisualObj');
        const rmv = obj.addComponent('RenderMeshVisual') as Editor.Components.RenderMeshVisual;

        rmv.renderOrder = 5;
        console.log(`Visual (RenderMeshVisual): renderOrder=${rmv.renderOrder}`);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    enabled id meta name renderOrder sceneObject type

    Methods

    getDirectlyReferencedEntities getMeta getOwnedEntities getTypeName getTypeName isOfType isSame

    Constructors

    Properties

    enabled: boolean

    Whether the component is active.

    id: Uuid

    The unique id of the entity.

    meta: Meta

    Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

    name: string

    Name of the component.

    renderOrder: number

    Determines the order in which this visual component is rendered relative to others.

    sceneObject: SceneObject

    Scene object this component is attached to.

    type: string

    The entity's type.

    Methods

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods