Skip to main content

Introduction

This Interactable component enables an object to use up to 4 custom actions at a time.

"Interactable RPG Object"

Fields#

NameDescription
Include Forbidden ActionsInclude forbidden actions in message sent to Interactable UI
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
CallbacksList of callbacks to be used by the Interactor UI
CurrentAgentCurrently active Interactor
IsInteractableIs the object currently interactable
ParametersList of parameters to be used by the Interactor UI
InteractionImageImage to display in the UI
InteractionTextText to display in the UI

Methods#

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