====== GUEST ======

**Category**: Asset

Parent class: [[:api:asset | ASSET]]\\



[[:assets:guest| List of GUEST assets]]

===== Properties =====

----

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

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

----

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

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

----

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

  * **Type**: ''[[:data-types#list|list]]<[[:api:guest_requirement | GUEST_REQUIREMENT]]>''
  * **Expected**: ''list of asset IDs''

----

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

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

----

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

  * **Type**: ''[[:data-types#list|list]]<[[:api:building_function_lodging | BUILDING_FUNCTION_LODGING]]>''
  * **Expected**: ''list of asset IDs''

----

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

  * **Type**: ''[[:api:behavior_tree | BEHAVIOR_TREE]]''
  * **Expected**: ''asset ID''
  * **Default value**: ''nil''

----

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

  * **Type**: ''[[:data-types#list|list]]<[[:api:game_action | GAME_ACTION]]>''
  * **Expected**: ''list of GAME_ACTION values''

----

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

  * **Type**: ''[[:data-types#list|list]]<[[:api:game_action | GAME_ACTION]]>''
  * **Expected**: ''list of GAME_ACTION values''

===== Functions =====

----

==== createGuestVisitor ====

''[[:api:comp_guest | COMP_GUEST]] **createGuestVisitor**(//isSilentGuest//)''

^ Name ^ Type ^ Description ^
| //''isSilentGuest''// | ''[[:data-types#boolean|boolean]]'' |  |