Class ToggleButton

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

_offIcon _onIcon api editEventCallbacks enabled name onStateChanged sceneObject uniqueIdentifier updatePriority

Accessors

isToggledOn offIcon onIcon

Methods

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

Constructors

constructor

Properties

_offIcon

_offIcon: SceneObject

_onIcon

_onIcon: SceneObject

api

api: Record<string, any>

editEventCallbacks

editEventCallbacks: boolean = false

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

name

name: string

ReadonlyonStateChanged

onStateChanged: PublicApi<boolean> = ...

ReadonlysceneObject

sceneObject: SceneObject

ReadonlyuniqueIdentifier

uniqueIdentifier: string

updatePriority

updatePriority: number

Accessors

isToggledOn

  • get isToggledOn(): boolean

  • Returns boolean

    the current toggle state of the button

  • set isToggledOn(toggleOn): void

  • Parameters

    • toggleOn: boolean

      the new state of the button, invoking the toggle event if different than current state.

    Returns void

offIcon

  • get offIcon(): SceneObject

  • Returns SceneObject

    the icon to be shown when the button is toggled off

  • set offIcon(iconObject): void

  • Parameters

    • iconObject: SceneObject

      the icon to be shown when the button is toggled off

    Returns void

onIcon

  • get onIcon(): SceneObject

  • Returns SceneObject

    the icon to be shown when the button is toggled on

  • set onIcon(iconObject): void

  • Parameters

    • iconObject: SceneObject

      the icon to be shown when the button is toggled on

    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

toggle

  • toggle(): void

  • Toggles the state of the button

    Returns void

StaticgetTypeName

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods