Class Billboard

Binds scripts to Events and executes them when triggered. Any script can access the ScriptComponent executing them through the variable script. See also: Scripting Overview, Script Events Guide.

Example

// Bind a function to the MouthOpened event
function onMouthOpen(eventData)
{
    print("mouth was opened");
}
var event = script.createEvent("MouthOpenedEvent");
event.bind(onMouthOpen);

Hierarchy (view full)

Constructors

constructor

Properties

api duration enabled name sceneObject uniqueIdentifier updatePriority

Accessors

axisBufferDegrees axisEasing xAxisEnabled yAxisEnabled zAxisEnabled

Methods

createEvent destroy getReferencedEvents getSceneObject getTransform getTypeName isOfType isSame onAwake removeEvent snapToOffsetRotation getTypeName

Constructors

constructor

Properties

api

api: Record<string, any>

duration

duration: number = 0.033

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

name

name: string

ReadonlysceneObject

sceneObject: SceneObject

ReadonlyuniqueIdentifier

uniqueIdentifier: string

updatePriority

updatePriority: number

Accessors

axisBufferDegrees

  • get axisBufferDegrees(): vec3

  • Returns vec3

    the vector defining the buffer for each axis.

  • set axisBufferDegrees(bufferDegrees): void

  • Parameters

    • bufferDegrees: vec3

      the vector defining the buffer for each axis.

    Returns void

axisEasing

  • get axisEasing(): vec3

  • Returns vec3

    the vector defining the easing for each axis.

  • set axisEasing(easing): void

  • Parameters

    • easing: vec3

      the vector defining the easing for each axis. For instant follow, use easing = (1,1,1).

    Returns void

xAxisEnabled

  • get xAxisEnabled(): boolean

  • Returns boolean

    if the SceneObject billboards about the x-axis.

  • set xAxisEnabled(enabled): void

  • Parameters

    • enabled: boolean

      defines if the SceneObject billboards about the x-axis.

    Returns void

yAxisEnabled

  • get yAxisEnabled(): boolean

  • Returns boolean

    if the SceneObject billboards about the y-axis.

  • set yAxisEnabled(enabled): void

  • Parameters

    • enabled: boolean

      defines if the SceneObject billboards about the y-axis.

    Returns void

zAxisEnabled

  • get zAxisEnabled(): boolean

  • Returns boolean

    if the SceneObject billboards about the z-axis.

  • set zAxisEnabled(enabled): void

  • Parameters

    • enabled: boolean

      defines if the SceneObject billboards about the z-axis.

    Returns void

Methods

createEvent

destroy

getReferencedEvents

getSceneObject

getTransform

getTypeName

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

onAwake

  • onAwake(): void

  • Returns void

removeEvent

snapToOffsetRotation

  • snapToOffsetRotation(): void

  • Immediately resets the SceneObject to the rotation accroding to inputs regardless of easing.

    Returns void

StaticgetTypeName

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods