User Tools

Site Tools


api:visitor

VISITOR

Category: Component

Parent class: COMPONENT

Properties


Name

Runtime only, Savegame

  • Type: string
  • Expected: string value

Destination

Runtime only, Savegame


OverrideInteractiveLocationSetup

VisitorPurpose

Runtime only, Savegame


AssetVisitorStatus

Runtime only, Savegame


TimeAtDestinationInSec

Runtime only, Savegame

  • Type: float
  • Expected: float value
  • Default value: 10.0f

CurrentTimeLeftAtDestination

Runtime only, Savegame

  • Type: float
  • Expected: float value
  • Default value: 0.0f

IsRequiredToVisitLocation

Runtime only, Savegame

  • Type: boolean
  • Expected: boolean value
  • Default value: false

HasArrived

Runtime only, Savegame

  • Type: boolean
  • Expected: boolean value
  • Default value: false

IsLeaving

Runtime only, Savegame

  • Type: boolean
  • Expected: boolean value
  • Default value: false

Functions


setActionOnClick

void setActionOnClick(actionToClone, clickAudioKey)

Name Type Description
actionToClone GAME_ACTION
clickAudioKey string

setActionOnLeaving

void setActionOnLeaving(actionToClone)

Name Type Description
actionToClone GAME_ACTION

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

void setActionWorldGuiIcon(actionWorldGuiIcon)

Name Type Description
actionWorldGuiIcon ATLAS_CELL

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

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki