Skip to main content

Introduction

The RPG Action adds locking and unlocking to an Interactable RPG Object.

"RPG Lock Unlock Action"

Fields#

NameDescription
Can LockCan the object be locked by interaction
Unlock TextText to display when object can be unlocked
Lock TextText to display when object can be locked
Audio Pool ChannelName of the broadcaster channel to use with the audio ppol
Lock SoundSound to play on lock/unlock
On LockedEvent raised when the object becomes locked
On UnlockedEvent raised when the object becomes unlocked
Forbid When LockedList of actions to forbid when locked
Forbid When UnlockedList of actions to forbid when unlocked
On Lock State ChangedEvent raised when interaction should be locked

Properties#

NameDescription
preventActionsList of other action to prevent
callbackCallback to invoke when using this action
lockInteractionsGet/Set interaction lock state
parameterParameter (usually string display text) to use with this action
parentGets the parent Interactable RPG Object

Methods#

NameDescription
ForceUnlockForce unlock the object
LockLock the object
UnlockUnlock the object
OnInteractionCalledThis method is called whenever the Interaction UI is displayed
OnInteractorChangedThis method is called whenever the Current Interactor changes