====== VISITOR ======

**Category**: Component

Parent class:  [[:api:component|COMPONENT]]\\



===== Properties =====

----

==== Name ====
//[[:annotations#runtime_only|Runtime only]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

==== Destination ====
//[[:annotations#runtime_only|Runtime only]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:api:game_object|GAME_OBJECT]]''
  * **Expected**: ''GAME_OBJECT value''

----

==== OverrideInteractiveLocationSetup ====
//[[:annotations#runtime_only|Runtime only]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:api:interactive_location_setup|INTERACTIVE_LOCATION_SETUP]]''
  * **Expected**: ''asset ID''

----

==== VisitorPurpose ====
//[[:annotations#runtime_only|Runtime only]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:api:interactive_location_purpose|INTERACTIVE_LOCATION_PURPOSE]]''
  * **Expected**: ''enum value''
  * **Default value**: ''INTERACTIVE_LOCATION_PURPOSE.VISIT''

----

==== AssetVisitorStatus ====
//[[:annotations#runtime_only|Runtime only]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:api:villager_status|VILLAGER_STATUS]]''
  * **Expected**: ''asset ID''

----

==== TimeAtDestinationInSec ====
//[[:annotations#runtime_only|Runtime only]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''10.0f''

----

==== CurrentTimeLeftAtDestination ====
//[[:annotations#runtime_only|Runtime only]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''0.0f''

----

==== IsRequiredToVisitLocation ====
//[[:annotations#runtime_only|Runtime only]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''false''

----

==== HasArrived ====
//[[:annotations#runtime_only|Runtime only]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''false''

----

==== IsLeaving ====
//[[:annotations#runtime_only|Runtime only]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''false''

===== Functions =====

----

==== setActionOnClick ====

''void **setActionOnClick**(//actionToClone//, //clickAudioKey//)''

^ Name ^ Type ^ Description ^
| //''actionToClone''// | ''[[:api:game_action|GAME_ACTION]]'' |  |
| //''clickAudioKey''// | ''[[:data-types#string|string]]'' |  |

----

==== setActionOnLeaving ====

''void **setActionOnLeaving**(//actionToClone//)''

^ Name ^ Type ^ Description ^
| //''actionToClone''// | ''[[:api:game_action|GAME_ACTION]]'' |  |

----

==== setCallbackOnClick ====

''void **setCallbackOnClick**(//onClickCallback//)''

^ Name ^ Type ^ Description ^
| //''onClickCallback''// | ''function<void()>'' |  |

----

==== getActionOnClick ====

''[[:api:game_action|GAME_ACTION]] **getActionOnClick**()''


----

==== setArrivingWorldGuiIcon ====

''void **setArrivingWorldGuiIcon**(//arrivingWorldGuiIcon//)''

^ Name ^ Type ^ Description ^
| //''arrivingWorldGuiIcon''// | ''[[:api:atlas_cell|ATLAS_CELL]]'' |  |

----

==== setActionWorldGuiIcon ====

''void **setActionWorldGuiIcon**(//actionWorldGuiIcon//)''

^ Name ^ Type ^ Description ^
| //''actionWorldGuiIcon''// | ''[[:api:atlas_cell|ATLAS_CELL]]'' |  |

----

==== focusVisitor ====

''void **focusVisitor**()''


===== Events =====

----

==== ON_ARRIVED ====
''ON_ARRIVED()''

----

==== ON_TIME_LEFT_AT_DESTINATION_UPDATED ====
''ON_TIME_LEFT_AT_DESTINATION_UPDATED([[:data-types#float|float]])''