The icon to be shown when the button is toggled off.
The icon to be shown when the button is toggled on.
ReadonlyapiGeneric object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.
Enable this to add functions from another script to this component's callback events.
If disabled, the Component will stop enacting its behavior.
ReadonlyisReturns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.
ReadonlyonReadonlysceneThe SceneObject this component is on.
Readonlyuniquethe current toggle state of the button
the new state of the button, invoking the toggle event if different than current state.
the icon to be shown when the button is toggled off
the icon to be shown when the button is toggled off
the icon to be shown when the button is toggled on
the icon to be shown when the button is toggled on
Adds a new SceneEvent, triggered by eventType events, to the ScriptComponent.
Destroys the component.
Returns the SceneObject the component is attached to.
Returns the Transform this component is attached to.
StaticgetReturns the name of this object's type.
Returns true if the object matches or derives from the passed in type.
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Removes a previously added SceneEvent from the ScriptComponent.
Toggles the state of the button
This class provides basic toggle functionality for a prefab toggle button. It manages the toggle state and provides methods to handle toggle events and update the button's visual state.
Deprecated
in favor of using SpectaclesUIKit's ToggleButton component. See https://developers.snap.com/spectacles/spectacles-frameworks/spectacles-ui-kit/get-started for more details.