api:guest

Table of Contents

GUEST
- Properties
- Functions
  - createGuestVisitor

GUEST

Category: Asset

Parent class: ASSET

List of GUEST assets

Properties

OptionalName

Type: string
Expected: string value

Profile

Type: AGENT_PROFILE
Expected: asset ID

GuestRequirementList

Type: list< GUEST_REQUIREMENT>
Expected: list of asset IDs

SupportedGender

Type: bitfield< GENDER>
Default value: { GENDER.MALE | GENDER.FEMALE }

LodgingBuildingFunctionList

Type: list< BUILDING_FUNCTION_LODGING>
Expected: list of asset IDs

BehaviorOverride

Type: BEHAVIOR_TREE
Expected: asset ID
Default value: nil

DataGameActionOnSpawnList

Type: list< GAME_ACTION>
Expected: list of GAME_ACTION values

DataGameActionOnDespawnList

Type: list< GAME_ACTION>
Expected: list of GAME_ACTION values

Functions

createGuestVisitor

COMP_GUEST createGuestVisitor(isSilentGuest)

Name	Type	Description
`isSilentGuest`	`boolean`

api/guest.txt · Last modified: 2026/10/08 10:22 by 127.0.0.1