Editor Scripting API
    Preparing search index...

    Class ScreenRegionComponent

    Component that defines a rectangular region on screen.

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

        const obj = scene.createSceneObject('ScreenRegionObj');
        const region = obj.addComponent('ScreenRegionComponent') as Editor.Components.ScreenRegionComponent;

        region.region = Editor.Components.ScreenRegionType.SafeRender;
        region.resizeWithKeyboard = true;
        console.log(`ScreenRegionComponent: region=${region.region}, resizeWithKeyboard=${region.resizeWithKeyboard}`);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    enabled id meta name region resizeWithKeyboard 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.

    region: ScreenRegionType

    The screen region type and bounds.

    resizeWithKeyboard: boolean

    Enable resizing the region with keyboard input.

    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