Skip to main content

Introduction

The InteractorUI component provides UI prompts for the player for interactable objects. This prefab should be set on the Interface Manager.

"Item Interactor UI"

Fields#

NameDescription
Item UIElement displaying item information
IdId used to find object when not referenced directly
Ui TextDestination of the text
FormatFormat to use when setting text. {0} is replaced with the supplied interactable object text
Require HoldRequire button/key to be held to interact
Hold TimeSeconds to require hold before interaction
Hold ProgressbarProgressbar for hold time
On Held Time ChangedEvent raised when held time changes

Properties#

NameDescription
holdingGet/Set if the interaction button is being held
overrideInteractionGet if this UI is overriding the default interaction input
sourceGet/Set the interactor displaying this UI
targetGet/Set the target interactable object
timeHeldGet/Set the amount of time the interaction button has been held

Methods#

NameDescription
InitializeInitialize the object
InteractWithTargetInteract with the target
SetTextSet the text for the UI
UseActionPerform interaction using an Interactor UI Action