Class ScreenRegionComponent

Overrides the settings on a local ScreenTransform to fit specific screen region on the device.

See

Screen Transform guide.

Example

// @input Component.ScreenRegionComponent screenRegionComponent

script.screenRegionComponent.region = ScreenRegionType.Capture;

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

enabled region sceneObject uniqueIdentifier

Methods

destroy getSceneObject getTransform getTypeName isOfType isSame

Constructors

Protectedconstructor

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

The scene object this component is on.

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: string): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): 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

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR