Skip to main content

Introduction

The Interactable Switch component enables a switch to be turned on/off.

"Interactable Switch"

Fields#

NameDescription
On Bool AnimBoolean parameter to set on the animator
Activate TextText to display when the switch can be activated
Deactivate TextText to displayw hen the switch can be deactivated
On Switch OnEvent raised when the switch is activated
On Switch OffEvent raised when the switch is deactivated
InteractableDetermines if this object is interactable
Action TextText associated with this action
Action ImageImage associated with the action
Show Alt TextDisplay message when object is not interactable
Alternate TextText associated with this action when not interactable
Custom SourceSource of custom UI
Custom UIReference of Custom UI to use instead of the normal Interactor UI
Custom IdId of Custom UI to use instead of the normal Interactor UI
Audio Pool ChannelName of the broadcaster channel to use with the audio ppol
Action SoundSound to play when interacting
On InteractEvent raised when the object is interacted with

Properties#

NameDescription
AnimatorAttached Animator
InteractionTextText to display in the UI
IsOnIs the switch active
CallbacksList of callbacks to be used by the Interactor UI
CurrentAgentCurrently active Interactor
InteractionImageImage to display in the UI
IsInteractableIs the object currently interactable
ParametersList of parameters to be used by the Interactor UI

Methods#

NameDescription
InteractInteract with the object
SetInteractableSet the interactable state of the object