Interface ScreenRegionComponent

Overrides the settings on a local ScreenTransform to fit a screen region on the device. See the Screen Transform guide for more information.

Example

// @input Component.ScreenRegionComponent screenRegionComponent

script.screenRegionComponent.region = ScreenRegionType.Capture;
interface ScreenRegionComponent {
    enabled: boolean;
    region: ScreenRegionType;
    sceneObject: SceneObject;
    uniqueIdentifier: string;
    destroy(): void;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

enabled region sceneObject uniqueIdentifier

Methods

destroy getSceneObject getTransform getTypeName isOfType isSame

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

region

region: ScreenRegionType

The region of the screen the local ScreenTransform will be fit to.

ReadonlysceneObject

sceneObject: SceneObject

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

destroy

  • destroy(): void

  • Destroys the component.

    Returns void

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods