AddDisembarkInteraction | InVehicleEntityId: FB1EntityId | - | Adds Disembark Interaction. |
AddDoorPrivilege | InReason: EB2DoorPrivilegeReason | - | System-only API (used in non-cheat cases). |
AddEnterShipInteraction | InVehicleEntityId: FB1EntityId | - | Adds Enter Ship Interaction. |
AddManagingHouseholdBizId | InHouseholdBizId: FB1EntityId | - | Adds Managing Household Biz Id. |
AddOwningEntityId | InEntityId: FB1EntityId | - | Adds Owning Entity Id. |
AddPocketMarketFollower | InFollwer: integer | - | Adds Pocket Market Follower. |
AddRentalEntityId | InEntityId: FB1EntityId | - | Adds Rental Entity Id. |
AddShipwreckInteraction | InDisasterId: string | - | Adds Shipwreck Interaction. |
AddUnlockRewardObjectByData | InObjectData: FB1RewardCAZObjectData, bSendPacket: boolean | - | Adds Unlock Reward Object By Data. |
AddUnlockRewardObjectByDatas | InObjectDatas: FB1RewardCAZObjectData[], bSendPacket: boolean, bNotifyUnlockFeed: boolean | - | Adds Unlock Reward Object By Datas. |
AddUnlockRewardObjectById | InObjectId: string, InUnlockRewardReason: EB1UnlockRewardReason, bSendPacket: boolean | - | Adds Unlock Reward Object By Id. |
AddUnlockRewardObjectByIds | InObjectIds: string[], bSendPacket: boolean | - | Adds Unlock Reward Object By Ids. |
AddUsingCarriableObject | InEntityId: FB1EntityId | - | Adds Using Carriable Object. |
ApplyCharacterAttribute | InCharacterAttribute: FB1CharacterAttribute, bApplyPreferenceRelatedTrait: boolean | - | Applies Character Attribute. |
Ascend | - | - | |
AttachCharacter | InHandType: EB1HandType, InCharacter: FB2Character | boolean | |
AttachGameObject | InHandType: EB1HandType, InObject: FB2GameObject | boolean | |
AttachInventory | InInventoryId: FB1EntityId | boolean | |
CanAddLifeTrigger | - | boolean | Returns whether it can Add Life Trigger. |
CanAddPriorityEntity | - | boolean | Returns whether it can Add Priority Entity. |
CanApplyAppearanceSetting | - | boolean | Returns whether it can Apply Appearance Setting. |
CanBeSiteEventTarget | - | boolean | Returns whether it can Be Site Event Target. |
CanBeSocialEventTarget | - | boolean | Returns whether it can Be Social Event Target. |
CanDrive | InVehicleType: EB1VehicleType | boolean | Returns whether it can Drive. |
CanInteractWithGhost | - | boolean | Returns whether it can Interact With Ghost. |
CanJoinZoiGroup | - | boolean | Returns whether it can Join Zoi Group. |
CanMoveOver | - | boolean | Returns whether it can Move Over. |
CanUpdateAge | - | boolean | Returns whether it can Update Age. |
CanUsePortalTransportation | - | boolean | Returns whether it can Use Portal Transportation. |
CancelShopWorkerOrder | - | - | |
CheckGhostInteractionReason | InReason: string | boolean | Checks Ghost Interaction Reason. |
CleanUpContactsOnLeaveCity | - | - | |
CleanUpDataWhenDestroy | - | - | |
ClearActionContext | - | - | Clears Action Context. |
ClearBabysitterServiceTimeTask | - | - | Clears Babysitter Service Time Task. |
ClearCarriedGameObjectsForScheduleMove | - | - | Clears game objects held in hand during a scheduled move; carried characters are excluded. |
ClearCharacterState | InCallFunc: string, InCallLine: integer, bInResetAnimation: boolean, bResetBaby: boolean, bRemoveGrab: boolean | - | Clears Character State. |
ClearCharacterStateForCityMove | - | - | Clears Character State For City Move. |
CoopProceedForAllCoopMembers | - | - | |
DecrementAutonomyIntervals | DT: number | - | |
DestroyRentalShip | - | - | |
DetachCharacter | InHandType: EB1HandType, InLocation: FVector, InRotator: FRotator, InApplyPacketTransform: boolean | boolean | |
DetachFromParentObject | - | boolean | |
DetachGameObject | InHandType: EB1HandType | boolean | |
DetachGameObjectAndDestroy | InHandType: EB1HandType | boolean | |
DetachGameObjectAndPutDown | InHandType: EB1HandType, InLocation: FVector, InRotator: FRotator, InParentEntityId: FB1EntityId | FB2CarriableObject | |
DetachGameObjectAndPutDownOnFloor | InHandType: EB1HandType | boolean | Places the game object held in hand onto the nearby floor during a scheduled move. |
DetachGameObjectAndPutInInventory | InHandType: EB1HandType | boolean | |
DetachGameObjectAndThrow | InHandType: EB1HandType, InParam: FB1ActivePhysicsParam | boolean | |
DetachInventory | InInventoryId: FB1EntityId | boolean | |
DoShopWorkerSetting | SpawnLocation: FVector, LinkedObjectId: FB1EntityId, InPreferInteractionBagIds: string[], InRoleName: string | - | |
FinishLookAtLoc | Reason: EB1LookAtReason | - | |
ForceGoHome | CurrentTime: FDateTime | - | |
ForceIgnoreStat | - | - | |
ForceLeaveWorking | - | - | |
ForceMoveForInfant | - | - | |
ForceSendMovementData | - | - | |
GetAllCriminalBehaviorCount | - | integer | Returns All Criminal Behavior Count. |
GetAppearancePresetId | - | string | Returns Appearance Preset Id. |
GetAttachingActor | - | FB2Actor | Returns Attaching Actor. |
GetAttachingActorLocation | - | FVector | Returns Attaching Actor Location. |
GetAutonomyOption | - | FB1AutonomyOption | Returns Autonomy Option. |
GetAutonomyOptionCache | - | FB1AutonomyOptionCache | Returns Autonomy Option Cache. |
GetBodyAgeType | - | EB1BodyAgeType | Returns Body Age Type. |
GetBottomLocation | - | FVector | Returns Bottom Location. |
GetBoundSiteId | - | FB1EntityId | Returns Bound Site Id. |
GetCharacterDescription | - | FB2CharacterDescription | Returns Character Description. |
GetCharacterGroupType | - | EB1CharacterGroupType | Returns Character Group Type. |
GetCityMovePolicyMap | InCityMoveDataPolicyType: EB1CityMoveDataPolicyType | table<string, EB1CityMoveDataPolicy> | Returns City Move Policy Map. |
GetConceptId | - | string | Returns Concept Id. |
GetCoopPartnerId | - | FB1EntityId | Returns Coop Partner Id. |
GetCradleObject | Self: FB2Character | - | Returns Cradle Object. |
GetCriminalBehaviorCount | CrimeId: string | integer | Returns Criminal Behavior Count. |
GetCurrentScheduleSiteId | - | string | Returns Current Schedule Site Id. |
GetDefaultCityMoveDataPolicy | - | EB1CityMoveDataPolicy | Returns Default City Move Data Policy. |
GetExportData | - | string | Returns Export Data. |
GetFirstName | - | string | Returns First Name. |
GetFixedSeatId | - | FB1EntityId | Returns Fixed Seat Id. |
GetGenderType | - | EB1GenderType | Returns Gender Type. |
GetGrabBodyParts | - | EB1AnimBodyParts | Returns Grab Body Parts. |
GetGrabbedCharacter | - | FB2Character | Returns Grabbed Character. |
GetGrabbingCharacter | - | FB2Character | Returns Grabbing Character. |
GetGrowthStep | - | EB1GrowthStep | Returns Growth Step. |
GetHalfHeight | - | number | Returns Half Height. |
GetHomeSite | Self: FB2Character, bForceOriginalHome: boolean | - | Returns Home Site. |
GetHomeSiteEntityId | bForceOriginalHome: boolean | FB1EntityId | Returns Home Site Entity Id. |
GetHomeSiteId | bForceOriginalHome: boolean | string | Returns Home Site Id. |
GetHomeSiteSpawnLocation | Index: integer, bForceOriginalHome: boolean | FVector | Returns Home Site Spawn Location. |
GetHopeLifeId | - | string | Returns Hope Life Id. |
GetImprisonmentCount | - | integer | Returns Imprisonment Count. |
GetInteractionPickedEntityId | InQueueId: B2InteractionQueueId | FB1EntityId | Returns Interaction Picked Entity Id. |
GetInteractionTargetEntityId | InQueueId: B2InteractionQueueId | FB1EntityId | Returns Interaction Target Entity Id. |
GetInteractionTargetSlot | InTargetEntityId: FB1EntityId | FB2TargetSlotParam | Returns Interaction Target Slot. |
GetIsPicked | - | boolean | C_PickCharacter |
GetKnockDoorVisitSitePrivilege | - | FB1EntityId | Returns Knock Door Visit Site Privilege. |
GetLastName | - | string | Returns Last Name. |
GetMainInterval | - | number | Returns Main Interval. |
GetMovementComponent | - | FB2CharacterMovementComponent | Returns Movement Component. |
GetNextSafeControlTicks | - | integer | Returns Next Safe Control Ticks. |
GetOutfitPresetId | - | string | Returns Outfit Preset Id. |
GetOwnedVehicle | - | FB2Vehicle | Returns Owned Vehicle. |
GetPastLifeHouseholdEntityId | - | FB1EntityId | Returns Past Life Household Entity Id. |
GetPendingPutDownTransform | - | FTransform | Returns Pending Put Down Transform. |
GetPendingSlotName | - | string | Returns Pending Slot Name. |
GetPocketMarketFollower | - | integer | Returns Pocket Market Follower. |
GetPocketMarketGrade | - | EB1PocketMarketGrade | Returns Pocket Market Grade. |
GetPocketMarketGradeInfo | - | FB1PocketMarketGradeInfo | Returns Pocket Market Grade Info. |
GetPostureId | - | string | Returns Posture Id. |
GetPriorityState | - | EB2CharacterStatePriority | Returns Priority State. |
GetPrivateCurrency | InId: string | integer | Returns Private Currency. |
GetRabbitholeFinishTime | - | integer | Returns Rabbithole Finish Time. |
GetRadius | - | number | Returns Radius. |
GetRealtimeInterval | - | number | Returns Realtime Interval. |
GetRelationshipData | - | string | Returns Relationship Data. |
GetResidenceSiteId | - | FB1EntityId | Returns Residence Site Id. |
GetRestoreLocation | - | FVector | Returns Restore Location. |
GetRestoreRotation | - | FRotator | Returns Restore Rotation. |
GetRole | - | EB1CharacterRole | Returns Role. |
GetSLMData | - | string | Returns SLMData. |
GetSiteAccessRecordData | InSiteId: string | FB1SiteAccessRecordData | Returns Site Access Record Data. |
GetSiteCenterRotation | InSpawnLocation: FVector | FRotator | Returns Site Center Rotation. |
GetSmartZoiTag | - | string | Returns Smart Zoi Tag. |
GetSpaceAttribute | - | integer | Returns Space Attribute. |
GetTimelineData | - | string | Returns Timeline Data. |
GetTinyShopEntityId | - | FB1EntityId | Returns Tiny Shop Entity Id. |
GetTrialCount | - | integer | Returns Trial Count. |
GetType | - | EB2EntityType | Returns Type. |
GetUniqueEventNpcId | - | string | Returns Unique Event Npc Id. |
GetUniqueName | - | string | Returns Unique Name. |
GetUsingCarriableObject | - | FB1EntityId | Returns Using Carriable Object. |
GetVelocity | - | FVector | Returns Velocity. |
GetVoice | - | FB1VoiceSettings | Returns Voice. |
GetZoiGroupId | - | FB1ZoiGroupId | Returns Zoi Group Id. |
GhostConditionCheck | - | boolean | |
GrantKnockDoorVisitSitePrivilege | InDoorEntityId: FB1EntityId, InSiteEntityId: FB1EntityId | - | |
HasAttemptedMoveTogether | - | boolean | Returns whether it has Attempted Move Together. |
HasAttemptedSafeControl | - | boolean | Returns whether it has Attempted Safe Control. |
HasConcept | - | boolean | Returns whether it has Concept. |
HasDoorPrivilege | - | boolean | Returns whether it has Door Privilege. |
HasDoorPrivilegeByReason | InReason: EB2DoorPrivilegeReason | boolean | Returns whether it has Door Privilege By Reason. |
HasHome | bForceOriginalHome: boolean | boolean | Returns whether it has Home. |
HasMergedActions | - | boolean | Returns whether it has Merged Actions. |
HasTrapped | - | boolean | Returns whether it has Trapped. |
HasUnlockedRewardObjectByData | InObjectData: FB1RewardCAZObjectData | boolean | Returns whether it has Unlocked Reward Object By Data. |
HasUnlockedRewardObjectById | InObjectId: string | boolean | Returns whether it has Unlocked Reward Object By Id. |
InitRealtimeInterval | - | - | Initializes Realtime Interval. |
InitRemainInterval | InType: EB2InitAutonomyIntervalType | - | Initializes Remain Interval. |
IsAtHomeSite | - | boolean | Returns whether At Home Site. |
IsAttachingActor | - | boolean | Returns whether Attaching Actor. |
IsAttachingEntityType | InType: EB2EntityType | boolean | Returns whether Attaching Entity Type. |
IsAutonomyEnable | - | boolean | Checks whether the character is in a state able to perform autonomous behavior (when autonomy is enabled). |
IsAutonomySLM | - | boolean | Returns whether Autonomy SLM. |
IsCharacterHiddenInGame | - | boolean | Returns whether Character Hidden In Game. |
IsCurrentInteractionNeverInterrupt | - | boolean | Returns whether Current Interaction Never Interrupt. |
IsDeath | - | boolean | Returns whether Death. |
IsDisableAllowOwnership | - | boolean | Returns whether Disable Allow Ownership. |
IsForceSimulationLevelOfDetailZero | - | boolean | Returns whether Force Simulation Level Of Detail Zero. |
IsGenderDiversityAvailableCharacterType | - | boolean | Returns whether Gender Diversity Available Character Type. |
IsGrabObject | InEntityId: FB1EntityId | boolean | Returns whether Grab Object. |
IsGrabObjectHiddenInGame | - | boolean | Returns whether Grab Object Hidden In Game. |
IsGrabbedBaby | - | boolean | Returns whether Grabbed Baby. |
IsGrabbingCharacter | - | boolean | Returns whether Grabbing Character. |
IsInRabbitHole | - | boolean | Returns whether In Rabbit Hole. |
IsInWaterArea | - | boolean | Returns whether In Water Area. |
IsIndoor | - | boolean | Returns whether Indoor. |
IsMinimalAutonomyEnable | bReasoning: boolean | boolean | Checks whether an SLM reasoning request can be made depending on bReasoning (when Smart Zoi is enabled); looser than IsAutonomyEnable. |
IsNeedSpawnUpdate | - | boolean | Returns whether Need Spawn Update. |
IsNpcCharacter | - | boolean | Returns whether Npc Character. |
IsOwnedEntityId | InEntityId: FB1EntityId | boolean | Returns whether Owned Entity Id. |
IsPlayingCoopBaby | - | boolean | Returns whether Playing Coop Baby. |
IsPlayingInteraction | - | boolean | Returns whether Playing Interaction. |
IsPlayingMainInteraction | InQueueId: B2InteractionQueueId | boolean | Returns whether Playing Main Interaction. |
IsRiddingVehicle | - | boolean | Returns whether Ridding Vehicle. |
IsTeleportable | InLoc: FVector | boolean | Returns whether Teleportable. |
IsTinyShopOwner | - | boolean | Returns whether Tiny Shop Owner. |
IsWalking | - | boolean | Returns whether Walking. |
MakeCharacterAttribute | - | FB1CharacterAttribute | Makes Character Attribute. |
NeedTeleportAfterProcess | - | boolean | |
OnAttemptMoveTogether | - | - | Callback invoked on Attempt Move Together. |
OnBecameGhost | - | - | Callback invoked on Became Ghost. |
OnBeginOverlap | OtherEntityId: FB1EntityId | - | Callback invoked on Begin Overlap. |
OnChangePostureByWaterArea | bInActive: boolean | - | Callback invoked on Change Posture By Water Area. |
OnCompleteInteraction_PlayReason | PlayReason: EB1InteractionPlayReason | - | Callback invoked on Complete Interaction_Play Reason. |
OnEndOverlap | OtherEntityId: FB1EntityId | - | Callback invoked on End Overlap. |
OnLobbyCharacterSetting | - | - | Callback invoked on Lobby Character Setting. |
OnPostFamilyMoveToSite | InSpawnLocation: FVector, InTeleportToHome: boolean | - | Callback invoked on Post Family Move To Site. |
OnSpawnNpcBasicSetting | - | - | Callback invoked on Spawn Npc Basic Setting. |
OnSpawnNpcGrabObjectSetting | - | - | Callback invoked on Spawn Npc Grab Object Setting. |
OnSpawnedCharacter | - | - | Callback invoked on Spawned Character. |
OnSpawnedCharacterMesh | - | - | Callback invoked on Spawned Character Mesh. |
OnSpawnedGrabObject | - | - | Callback invoked on Spawned Grab Object. |
OnTrySafeControl | - | - | Callback invoked on Try Safe Control. |
OnWASDMoving | - | - | Callback invoked on WASDMoving. |
ProcessBabySafety | - | - | |
ProcessCurrentSite | - | - | |
PutDownGameObject | InPutDownEntityId: FB1EntityId, InLocation: FVector, InRotator: FRotator, InParentEntityId: FB1EntityId | FB2CarriableObject | |
PutInInventory | InPutInEntityId: FB1EntityId | boolean | |
RecoverHomesick | InByUserInput: boolean | - | |
RefreshAtHomeHomesickBuff | - | - | |
RefreshAutonomyOptionCache | - | - | |
RefreshB1Spawn | bImmediate: boolean | - | |
RefreshBoundSite | - | - | |
RegisterExitVehicleTimeTask | - | - | Registers Exit Vehicle Time Task. |
RegistryBabysitterServiceTimeTask | InTimeTaskId: FB1TimeTaskId | - | |
RemoveDoorPrivilege | InReason: EB2DoorPrivilegeReason | - | Removes Door Privilege. |
RemoveGrabEntity | - | - | Removes Grab Entity. |
RemoveManagingHouseholdBizId | InHouseholdBizId: FB1EntityId | - | Removes Managing Household Biz Id. |
RemoveOwningEntityId | InEntityId: FB1EntityId | - | Removes Owning Entity Id. |
RemoveUsingCarriableObject | InEntityId: FB1EntityId | - | Removes Using Carriable Object. |
RemoveZoiGroupId | - | - | Removes Zoi Group Id. |
RequestAddChildEntity | InEntityId: FB1EntityId, InAttachRule: EB1EntityAttachRule, InExtraRelativeTransform: FTransform | boolean | Hierarchy |
RequestDie | - | - | Requests Die. |
RequestRemoveChildEntity | InEntityId: FB1EntityId | boolean | Requests Remove Child Entity. |
RequestSnapToGround | - | - | Requests Snap To Ground. |
ResetAttemptMoveTogether | - | - | Resets Attempt Move Together. |
ResetMoveOverCoolTime | - | - | Resets Move Over Cool Time. |
ResetOwnership | - | boolean | Resets Ownership. |
ResetRentalEntityId | - | - | Resets Rental Entity Id. |
ResetSafeControl | - | - | Resets Safe Control. |
ResetShopWorkerSetting | - | - | Resets Shop Worker Setting. |
ResolveValidTeleportLocation | InLocation: FVector, InRotation: FRotator | FTransform | |
RevokeKnockDoorVisitSitePrivilege | - | - | |
SendCancelWalkTo | - | - | Sends Cancel Walk To. |
SendCompactData | - | - | Sends Compact Data. |
SendPossessCharacterDataCache | - | - | Sends Possess Character Data Cache. |
SendRelationshipDataCache | - | - | Sends Relationship Data Cache. |
SendUnlockRewardObjectPacket | - | - | Sends Unlock Reward Object Packet. |
SendUpdateAttachedCharacterRabbitHole | InRabbitHoleId: string | - | Sends Update Attached Character Rabbit Hole. |
SetAppearancePresetId | InPresetId: string, InOutfitPresetId: string | - | Sets Appearance Preset Id. |
SetAutonomySLM | bInValue: boolean | - | Sets Autonomy SLM. |
SetCharacterGroupType | InCharacterGroupType: EB1CharacterGroupType, InFunctionName: string, InLine: integer | - | Sets Character Group Type. |
SetCharacterHiddenInGame | InNewHidden: boolean, InReason: string | - | Sets Character Hidden In Game. |
SetConceptId | InConceptId: string | - | Sets Concept Id. |
SetFloorLevel | InFloorLevel: integer | - | Sets Floor Level. |
SetGrabObjectHiddenInGame | InNewHidden: boolean, InReason: string | - | Sets Grab Object Hidden In Game. |
SetHopeLifeId | InHopeLifeId: string | - | Sets Hope Life Id. |
SetHouseholdEntityId | InEntityId: FB1EntityId | - | Sets Household Entity Id. |
SetIsIndoor | bInIsIndoor: boolean | - | Sets Is Indoor. |
SetIsPicked | bInIsPicked: boolean | - | Sets Is Picked. |
SetLocatedSiteId | InLocationSiteId: FB1EntityId | - | Sets Located Site Id. |
SetLocationAndRotationOnlySimul | InLocation: FVector, InRotation: FRotator, bDeferredRelativeUpdate: boolean | - | Sets Location And Rotation Only Simul. |
SetLocationOnlySimul | InLocation: FVector | - | Sets Location Only Simul. |
SetLockInPriorityQueue | bActive: boolean | - | Once the character has entered the PriorityQueue, it will not leave until this is set to false. |
SetMainHouseholdBizId | InHouseholdBizId: FB1EntityId | - | Sets Main Household Biz Id. |
SetPendingPutDownTransform | InPutDownTransform: FTransform | - | Sets Pending Put Down Transform. |
SetPendingSlotName | InSlotName: string | - | Sets Pending Slot Name. |
SetPrivateCurrency | InId: string, InValue: integer | - | Sets Private Currency. |
SetRotationOnlySimul | InRotation: FRotator | - | Sets Rotation Only Simul. |
SetTinyShopEntityId | InEntityId: FB1EntityId | - | Sets Tiny Shop Entity Id. |
SetVoice | InVoice: FB1VoiceSettings, bSendPacket: boolean | - | Sets Voice. |
SetZoiGroupId | InGroupId: FB1ZoiGroupId | - | Sets Zoi Group Id. |
ShouldProcessTick | - | boolean | Returns whether it should Process Tick. |
StartLookAtLoc | Loc: FVector, Reason: EB1LookAtReason | - | Starts Look At Loc. |
Teleport | InLocation: FVector, InRotation: FRotator, InIsResponseReplyPosition: boolean, bTeleportOnGate: boolean, bPreventOverlap: boolean, bAdjustToFloorZ: boolean, bSkipSafeLocation: boolean, InLoadingContext: EB1LoadingContext, InTeleportReason: EB1TeleportReason | - | |
TeleportToSafeLoc | InLoc: FVector | boolean | |
TryChangeDivePosture | - | - | |
TryChangePostureByWaterArea | - | - | |
TryChangeState | InState: EB2CharacterState, InReason: EB2EntityStateChangeReason | - | |
TryDisembarkShip | bForceDisembarkAtDock: boolean | boolean | |
TryExitVehicle | - | - | |
TrySendCharacterDataCacheTick | InDeltaTime: number, bForceUpdate: boolean | - | |
UnregisterExitVehicleTimeTask | - | - | Unregisters Exit Vehicle Time Task. |
UpdateInDoorOutfits | bIsTakeOff: boolean | - | Updates In Door Outfits. |
UpdateSafeControlTicks | - | - | Updates Safe Control Ticks. |
UpdateShopWorkerRoleName | InRoleName: string, InSiteId: string | - | Updates Shop Worker Role Name. |
UpdateSimulationTimeMetric | DeltaTime: number | - | Updates Simulation Time Metric. |
UpdateStatWhenEmbarkShip | - | - | Updates Stat When Embark Ship. |
UpdatedAttendenceAbsentDay | - | boolean | |
UrnCreationCheck | - | boolean | |