Interface Component

Description

The base class for all components. Components are attached to SceneObjects.

Example

//@input Component component
if(script.component.isOfType("Component.MaterialMeshVisual")){
    var mat = script.component.mainMaterial;
}
interface Component {
    enabled: boolean;
    uniqueIdentifier: string;
    destroy(): void;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

enabled uniqueIdentifier

Methods

destroy getSceneObject getTransform getTypeName isOfType isSame

Properties

enabled

enabled: boolean

Description

If disabled, the Component will stop enacting its behavior.

Readonly uniqueIdentifier

uniqueIdentifier: string

Methods

destroy

  • destroy(): void

  • Returns void

    Description

    Destroys the component.

getSceneObject

  • getSceneObject(): SceneObject

  • Returns SceneObject

    Description

    Returns the SceneObject the component is attached to.

getTransform

  • getTransform(): Transform

  • Returns Transform

    Description

    Returns the Transform this component is attached to.

getTypeName

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

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

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc