====== GAME_ACTION_VISIT ======

Deprecated names:
  * ACTION_VISIT

**Category**: Data

Parent class:  [[:api:game_action|GAME_ACTION]]\\

//[[:annotations#cloneable|Cloneable]]//

===== Properties =====

----

==== VisitorProfile ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:agent_profile|AGENT_PROFILE]]''
  * **Expected**: ''asset ID''

----

==== DescriptionKey ====
//[[:annotations#serialized|Serialized]]//

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

----

==== OverrideInteractiveLocationSetup ====
//[[:annotations#serialized|Serialized]]//

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

----

==== VisitorApproachingNotification ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:notification|NOTIFICATION]]''
  * **Expected**: ''asset ID''
  * **Default value**: ''nil''

----

==== VisitorPurpose ====
//[[:annotations#serialized|Serialized]]//

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

----

==== SupportedGender ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#bitfield|bitfield]]<[[:api:gender|GENDER]]>''
  * **Default value**: ''{ GENDER.MALE | GENDER.FEMALE }''

----

==== VisitorStatus ====
//[[:annotations#serialized|Serialized]]//

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

----

==== VisitorBehaviourTree ====
//[[:annotations#serialized|Serialized]]//

This behaviour override the default behaviour of a Visitor. If null, it will use the default behaviour.
  * **Type**: ''[[:api:behavior_tree|BEHAVIOR_TREE]]''
  * **Expected**: ''asset ID''
  * **Default value**: ''nil''

----

==== VisitorCount ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]''
  * **Expected**: ''integer value''
  * **Default value**: ''1''

----

==== IsNeedLocation ====
//[[:annotations#serialized|Serialized]]//

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

----

==== VisitClickAction ====
//[[:annotations#serialized|Serialized]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:api:game_action|GAME_ACTION]]''
  * **Expected**: ''GAME_ACTION value''

----

==== VisitLeavingAction ====
//[[:annotations#serialized|Serialized]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:api:game_action|GAME_ACTION]]''
  * **Expected**: ''GAME_ACTION value''
  * **Default value**: ''nil''

----

==== DaysAtDestination ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]''
  * **Expected**: ''integer value''
  * **Default value**: ''7''

----

==== ArrivingWorldGuiIcon ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:atlas_cell|ATLAS_CELL]]''
  * **Expected**: ''asset ID''
  * **Default value**: ''nil''

----

==== ActionWorldGuiIcon ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:atlas_cell|ATLAS_CELL]]''
  * **Expected**: ''asset ID''
  * **Default value**: ''nil''

----

==== VisitorClickAudioKey ====
//[[:annotations#serialized|Serialized]]//

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

----

==== IsTriggerClickActionOnExpire ====
//[[:annotations#serialized|Serialized]]//

Trigger click action when visitor leaves after m_daysAtDestination
  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''false''

===== Events =====

----

==== ON_VISITOR_SPAWNED ====
''ON_VISITOR_SPAWNED([[:api:visitor|VISITOR]])''