api:visitor
Table of Contents
VISITOR
Category: Component
Parent class: COMPONENT
Properties
Name
Destination
OverrideInteractiveLocationSetup
VisitorPurpose
- Expected:
enum value
- Default value:
INTERACTIVE_LOCATION_PURPOSE.VISIT
AssetVisitorStatus
TimeAtDestinationInSec
CurrentTimeLeftAtDestination
IsRequiredToVisitLocation
HasArrived
IsLeaving
- Type:
boolean
- Expected:
boolean value
- Default value:
false
Functions
setActionOnClick
void setActionOnClick(actionToClone, clickAudioKey)
Name | Type | Description |
---|---|---|
actionToClone | GAME_ACTION | |
clickAudioKey | string |
setActionOnLeaving
setCallbackOnClick
void setCallbackOnClick(onClickCallback)
Name | Type | Description |
---|---|---|
onClickCallback | function<void()> |
getActionOnClick
GAME_ACTION getActionOnClick()
setArrivingWorldGuiIcon
void setArrivingWorldGuiIcon(arrivingWorldGuiIcon)
Name | Type | Description |
---|---|---|
arrivingWorldGuiIcon | ATLAS_CELL |
setActionWorldGuiIcon
focusVisitor
void focusVisitor()
Events
ON_ARRIVED
ON_ARRIVED()
ON_TIME_LEFT_AT_DESTINATION_UPDATED
ON_TIME_LEFT_AT_DESTINATION_UPDATED(float)
api/visitor.txt · Last modified: 2024/02/06 13:54 by 127.0.0.1