Skip to main content

FB2Character

Overview

  • Simulation-side character (Zoi); the root entity that owns the B2 simulation components.

Metadata

FieldValue
Kindstruct
EnvironmentB2 - Simulation
Categorystructs
ExtendsFB2Actor
Requirerequire('Objects.B2Character')

Properties (65)

NameTypeDescription
AccSlowTickDeltanumber
ActionContextstable<string, any>
ActionsPerformedInThePastHourHintstable<string, FB2SituationHint>Key : InteractionBagId, Value : Hint Data
AppearanceOutfitPresetIdstring
AppearancePresetIdstring
AutonomyOptionFB1AutonomyOption
AutonomyOptionCacheFB1AutonomyOptionCache
BabysitterServiceTimeTaskIdFB1TimeTaskId
BoundSiteIdFB1EntityIdBound site id: home site id for UniqueNPC; haunt-site id for ghosts; None for other homeless NPCs.
CharacterGroupTypeEB1CharacterGroupType
CharacterTypeInterfaceany
CheatHalfHeightScalenumber
ConceptIdstringConceptId used to manage a ConceptCharacter.
DLD_RequestTimelineRetryCountinteger
DLD_SmartZoiTimelineRequestCompleteany
DoorPrivilegeReasonstable<EB2DoorPrivilegeReason, boolean>
ExitVehicleTimeTaskIdFB1TimeTaskIdReplaces ExitVehicleLastCallTime; switched to a TimeTask-based approach.
GhostInteractionOnReasonstable<string, boolean>
GrabObjectHiddenReasonsstring[]
HiddenReasonsstring[]
HopeLifeIdstringAdded for the minimal (Gamescom) Hope-Life implementation rather than the full spec; to be removed once properly implemented (a B2HopeLifeComponent may be added).
HouseholdBizProfileFB1CharacterHouseholdBizProfile
KnockDoorVisitSitePrivilegeFB1EntityId
LastForceGoHomeTimeFDateTime
LastInteractionSuccessDateTimeFDateTime
MainIntervalnumber
MoveOverCoolTimenumber
NewUnlockedRewardObjectstable<FB1RewardCAZObjectData, boolean>
NextSafeControlTicksinteger
OwnedUnlockedObjectDataContainerFB1UnlockedRewardObjectDataContainer
OwningEntityIdstable<FB1EntityId, boolean>
PendingPostHitReactionScriptsFB2PendingPostHitReactionScripts
PendingPutDownTransformFTransformTransform where the object will be placed when put-down-on-floor executes.
PendingSlotNamestring
PendingUnlockFeedObjectsFB1RewardCAZObjectData[]Newly unlocked CAZ objects accumulated within the same tick (pending activity-feed post). In OnPostTick, hair/outfit are combined and posted once, then cleared.
PocketMarketGradeInfoFB1PocketMarketGradeInfo
PrivateCurrencyMaptable<string, integer>
RagdollAttackInstigatorFB1EntityIdMost recent active-attack ragdoll attacker (runtime-only, not saved). Granted 30s invulnerability right after standing up.
RealtimeIntervalnumber
RoleEB1CharacterRole
SafeControlFirstTryboolean
SavedHouseholdEntityIdFB1EntityId
SiteAccessRecordDataMaptable<string, FB1SiteAccessRecordData>
SmartZoiTagstring
SpaceAttributeinteger
StatDeltanumber
StayoverSiteIdFB1EntityId
TinyShopSiteEntityIdFB1EntityId
UniqueEventNpcIdstring
UsingCarriableObjectFB1EntityId
VehicleContextFB1VehicleContext
VisitedSitestable<string, boolean>
ZoiGroupIdFB1ZoiGroupId
bAllowHierarchyChangeboolean
bAttemptedMoveTogetherboolean
bGhostInteractionAvailabilityboolean
bHasInheritedVehicleboolean
bHasTrappedbooleanDebug Variables
bIsInWaterAreaboolean
bIsIndoorboolean
bIsPickedboolean
bIsWaitingForTimelineSLMboolean
bLockInPriorityQueueboolean
bNeedResetVehiclePacketboolean
bRequireUpdateOutfitsbooleanTemporary sync variable used until the IsInDoor check (currently in B1) moves to B2.

Functions (269)

FunctionParametersReturnsDescription
AddDisembarkInteractionInVehicleEntityId: FB1EntityId-Adds Disembark Interaction.
AddDoorPrivilegeInReason: EB2DoorPrivilegeReason-System-only API (used in non-cheat cases).
AddEnterShipInteractionInVehicleEntityId: FB1EntityId-Adds Enter Ship Interaction.
AddManagingHouseholdBizIdInHouseholdBizId: FB1EntityId-Adds Managing Household Biz Id.
AddOwningEntityIdInEntityId: FB1EntityId-Adds Owning Entity Id.
AddPocketMarketFollowerInFollwer: integer-Adds Pocket Market Follower.
AddRentalEntityIdInEntityId: FB1EntityId-Adds Rental Entity Id.
AddShipwreckInteractionInDisasterId: string-Adds Shipwreck Interaction.
AddUnlockRewardObjectByDataInObjectData: FB1RewardCAZObjectData, bSendPacket: boolean-Adds Unlock Reward Object By Data.
AddUnlockRewardObjectByDatasInObjectDatas: FB1RewardCAZObjectData[], bSendPacket: boolean, bNotifyUnlockFeed: boolean-Adds Unlock Reward Object By Datas.
AddUnlockRewardObjectByIdInObjectId: string, InUnlockRewardReason: EB1UnlockRewardReason, bSendPacket: boolean-Adds Unlock Reward Object By Id.
AddUnlockRewardObjectByIdsInObjectIds: string[], bSendPacket: boolean-Adds Unlock Reward Object By Ids.
AddUsingCarriableObjectInEntityId: FB1EntityId-Adds Using Carriable Object.
ApplyCharacterAttributeInCharacterAttribute: FB1CharacterAttribute, bApplyPreferenceRelatedTrait: boolean-Applies Character Attribute.
Ascend--
AttachCharacterInHandType: EB1HandType, InCharacter: FB2Characterboolean
AttachGameObjectInHandType: EB1HandType, InObject: FB2GameObjectboolean
AttachInventoryInInventoryId: FB1EntityIdboolean
CanAddLifeTrigger-booleanReturns whether it can Add Life Trigger.
CanAddPriorityEntity-booleanReturns whether it can Add Priority Entity.
CanApplyAppearanceSetting-booleanReturns whether it can Apply Appearance Setting.
CanBeSiteEventTarget-booleanReturns whether it can Be Site Event Target.
CanBeSocialEventTarget-booleanReturns whether it can Be Social Event Target.
CanDriveInVehicleType: EB1VehicleTypebooleanReturns whether it can Drive.
CanInteractWithGhost-booleanReturns whether it can Interact With Ghost.
CanJoinZoiGroup-booleanReturns whether it can Join Zoi Group.
CanMoveOver-booleanReturns whether it can Move Over.
CanUpdateAge-booleanReturns whether it can Update Age.
CanUsePortalTransportation-booleanReturns whether it can Use Portal Transportation.
CancelShopWorkerOrder--
CheckGhostInteractionReasonInReason: stringbooleanChecks 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.
ClearCharacterStateInCallFunc: string, InCallLine: integer, bInResetAnimation: boolean, bResetBaby: boolean, bRemoveGrab: boolean-Clears Character State.
ClearCharacterStateForCityMove--Clears Character State For City Move.
CoopProceedForAllCoopMembers--
DecrementAutonomyIntervalsDT: number-
DestroyRentalShip--
DetachCharacterInHandType: EB1HandType, InLocation: FVector, InRotator: FRotator, InApplyPacketTransform: booleanboolean
DetachFromParentObject-boolean
DetachGameObjectInHandType: EB1HandTypeboolean
DetachGameObjectAndDestroyInHandType: EB1HandTypeboolean
DetachGameObjectAndPutDownInHandType: EB1HandType, InLocation: FVector, InRotator: FRotator, InParentEntityId: FB1EntityIdFB2CarriableObject
DetachGameObjectAndPutDownOnFloorInHandType: EB1HandTypebooleanPlaces the game object held in hand onto the nearby floor during a scheduled move.
DetachGameObjectAndPutInInventoryInHandType: EB1HandTypeboolean
DetachGameObjectAndThrowInHandType: EB1HandType, InParam: FB1ActivePhysicsParamboolean
DetachInventoryInInventoryId: FB1EntityIdboolean
DoShopWorkerSettingSpawnLocation: FVector, LinkedObjectId: FB1EntityId, InPreferInteractionBagIds: string[], InRoleName: string-
FinishLookAtLocReason: EB1LookAtReason-
ForceGoHomeCurrentTime: FDateTime-
ForceIgnoreStat--
ForceLeaveWorking--
ForceMoveForInfant--
ForceSendMovementData--
GetAllCriminalBehaviorCount-integerReturns All Criminal Behavior Count.
GetAppearancePresetId-stringReturns Appearance Preset Id.
GetAttachingActor-FB2ActorReturns Attaching Actor.
GetAttachingActorLocation-FVectorReturns Attaching Actor Location.
GetAutonomyOption-FB1AutonomyOptionReturns Autonomy Option.
GetAutonomyOptionCache-FB1AutonomyOptionCacheReturns Autonomy Option Cache.
GetBodyAgeType-EB1BodyAgeTypeReturns Body Age Type.
GetBottomLocation-FVectorReturns Bottom Location.
GetBoundSiteId-FB1EntityIdReturns Bound Site Id.
GetCharacterDescription-FB2CharacterDescriptionReturns Character Description.
GetCharacterGroupType-EB1CharacterGroupTypeReturns Character Group Type.
GetCityMovePolicyMapInCityMoveDataPolicyType: EB1CityMoveDataPolicyTypetable<string, EB1CityMoveDataPolicy>Returns City Move Policy Map.
GetConceptId-stringReturns Concept Id.
GetCoopPartnerId-FB1EntityIdReturns Coop Partner Id.
GetCradleObjectSelf: FB2Character-Returns Cradle Object.
GetCriminalBehaviorCountCrimeId: stringintegerReturns Criminal Behavior Count.
GetCurrentScheduleSiteId-stringReturns Current Schedule Site Id.
GetDefaultCityMoveDataPolicy-EB1CityMoveDataPolicyReturns Default City Move Data Policy.
GetExportData-stringReturns Export Data.
GetFirstName-stringReturns First Name.
GetFixedSeatId-FB1EntityIdReturns Fixed Seat Id.
GetGenderType-EB1GenderTypeReturns Gender Type.
GetGrabBodyParts-EB1AnimBodyPartsReturns Grab Body Parts.
GetGrabbedCharacter-FB2CharacterReturns Grabbed Character.
GetGrabbingCharacter-FB2CharacterReturns Grabbing Character.
GetGrowthStep-EB1GrowthStepReturns Growth Step.
GetHalfHeight-numberReturns Half Height.
GetHomeSiteSelf: FB2Character, bForceOriginalHome: boolean-Returns Home Site.
GetHomeSiteEntityIdbForceOriginalHome: booleanFB1EntityIdReturns Home Site Entity Id.
GetHomeSiteIdbForceOriginalHome: booleanstringReturns Home Site Id.
GetHomeSiteSpawnLocationIndex: integer, bForceOriginalHome: booleanFVectorReturns Home Site Spawn Location.
GetHopeLifeId-stringReturns Hope Life Id.
GetImprisonmentCount-integerReturns Imprisonment Count.
GetInteractionPickedEntityIdInQueueId: B2InteractionQueueIdFB1EntityIdReturns Interaction Picked Entity Id.
GetInteractionTargetEntityIdInQueueId: B2InteractionQueueIdFB1EntityIdReturns Interaction Target Entity Id.
GetInteractionTargetSlotInTargetEntityId: FB1EntityIdFB2TargetSlotParamReturns Interaction Target Slot.
GetIsPicked-booleanC_PickCharacter
GetKnockDoorVisitSitePrivilege-FB1EntityIdReturns Knock Door Visit Site Privilege.
GetLastName-stringReturns Last Name.
GetMainInterval-numberReturns Main Interval.
GetMovementComponent-FB2CharacterMovementComponentReturns Movement Component.
GetNextSafeControlTicks-integerReturns Next Safe Control Ticks.
GetOutfitPresetId-stringReturns Outfit Preset Id.
GetOwnedVehicle-FB2VehicleReturns Owned Vehicle.
GetPastLifeHouseholdEntityId-FB1EntityIdReturns Past Life Household Entity Id.
GetPendingPutDownTransform-FTransformReturns Pending Put Down Transform.
GetPendingSlotName-stringReturns Pending Slot Name.
GetPocketMarketFollower-integerReturns Pocket Market Follower.
GetPocketMarketGrade-EB1PocketMarketGradeReturns Pocket Market Grade.
GetPocketMarketGradeInfo-FB1PocketMarketGradeInfoReturns Pocket Market Grade Info.
GetPostureId-stringReturns Posture Id.
GetPriorityState-EB2CharacterStatePriorityReturns Priority State.
GetPrivateCurrencyInId: stringintegerReturns Private Currency.
GetRabbitholeFinishTime-integerReturns Rabbithole Finish Time.
GetRadius-numberReturns Radius.
GetRealtimeInterval-numberReturns Realtime Interval.
GetRelationshipData-stringReturns Relationship Data.
GetResidenceSiteId-FB1EntityIdReturns Residence Site Id.
GetRestoreLocation-FVectorReturns Restore Location.
GetRestoreRotation-FRotatorReturns Restore Rotation.
GetRole-EB1CharacterRoleReturns Role.
GetSLMData-stringReturns SLMData.
GetSiteAccessRecordDataInSiteId: stringFB1SiteAccessRecordDataReturns Site Access Record Data.
GetSiteCenterRotationInSpawnLocation: FVectorFRotatorReturns Site Center Rotation.
GetSmartZoiTag-stringReturns Smart Zoi Tag.
GetSpaceAttribute-integerReturns Space Attribute.
GetTimelineData-stringReturns Timeline Data.
GetTinyShopEntityId-FB1EntityIdReturns Tiny Shop Entity Id.
GetTrialCount-integerReturns Trial Count.
GetType-EB2EntityTypeReturns Type.
GetUniqueEventNpcId-stringReturns Unique Event Npc Id.
GetUniqueName-stringReturns Unique Name.
GetUsingCarriableObject-FB1EntityIdReturns Using Carriable Object.
GetVelocity-FVectorReturns Velocity.
GetVoice-FB1VoiceSettingsReturns Voice.
GetZoiGroupId-FB1ZoiGroupIdReturns Zoi Group Id.
GhostConditionCheck-boolean
GrantKnockDoorVisitSitePrivilegeInDoorEntityId: FB1EntityId, InSiteEntityId: FB1EntityId-
HasAttemptedMoveTogether-booleanReturns whether it has Attempted Move Together.
HasAttemptedSafeControl-booleanReturns whether it has Attempted Safe Control.
HasConcept-booleanReturns whether it has Concept.
HasDoorPrivilege-booleanReturns whether it has Door Privilege.
HasDoorPrivilegeByReasonInReason: EB2DoorPrivilegeReasonbooleanReturns whether it has Door Privilege By Reason.
HasHomebForceOriginalHome: booleanbooleanReturns whether it has Home.
HasMergedActions-booleanReturns whether it has Merged Actions.
HasTrapped-booleanReturns whether it has Trapped.
HasUnlockedRewardObjectByDataInObjectData: FB1RewardCAZObjectDatabooleanReturns whether it has Unlocked Reward Object By Data.
HasUnlockedRewardObjectByIdInObjectId: stringbooleanReturns whether it has Unlocked Reward Object By Id.
InitRealtimeInterval--Initializes Realtime Interval.
InitRemainIntervalInType: EB2InitAutonomyIntervalType-Initializes Remain Interval.
IsAtHomeSite-booleanReturns whether At Home Site.
IsAttachingActor-booleanReturns whether Attaching Actor.
IsAttachingEntityTypeInType: EB2EntityTypebooleanReturns whether Attaching Entity Type.
IsAutonomyEnable-booleanChecks whether the character is in a state able to perform autonomous behavior (when autonomy is enabled).
IsAutonomySLM-booleanReturns whether Autonomy SLM.
IsCharacterHiddenInGame-booleanReturns whether Character Hidden In Game.
IsCurrentInteractionNeverInterrupt-booleanReturns whether Current Interaction Never Interrupt.
IsDeath-booleanReturns whether Death.
IsDisableAllowOwnership-booleanReturns whether Disable Allow Ownership.
IsForceSimulationLevelOfDetailZero-booleanReturns whether Force Simulation Level Of Detail Zero.
IsGenderDiversityAvailableCharacterType-booleanReturns whether Gender Diversity Available Character Type.
IsGrabObjectInEntityId: FB1EntityIdbooleanReturns whether Grab Object.
IsGrabObjectHiddenInGame-booleanReturns whether Grab Object Hidden In Game.
IsGrabbedBaby-booleanReturns whether Grabbed Baby.
IsGrabbingCharacter-booleanReturns whether Grabbing Character.
IsInRabbitHole-booleanReturns whether In Rabbit Hole.
IsInWaterArea-booleanReturns whether In Water Area.
IsIndoor-booleanReturns whether Indoor.
IsMinimalAutonomyEnablebReasoning: booleanbooleanChecks whether an SLM reasoning request can be made depending on bReasoning (when Smart Zoi is enabled); looser than IsAutonomyEnable.
IsNeedSpawnUpdate-booleanReturns whether Need Spawn Update.
IsNpcCharacter-booleanReturns whether Npc Character.
IsOwnedEntityIdInEntityId: FB1EntityIdbooleanReturns whether Owned Entity Id.
IsPlayingCoopBaby-booleanReturns whether Playing Coop Baby.
IsPlayingInteraction-booleanReturns whether Playing Interaction.
IsPlayingMainInteractionInQueueId: B2InteractionQueueIdbooleanReturns whether Playing Main Interaction.
IsRiddingVehicle-booleanReturns whether Ridding Vehicle.
IsTeleportableInLoc: FVectorbooleanReturns whether Teleportable.
IsTinyShopOwner-booleanReturns whether Tiny Shop Owner.
IsWalking-booleanReturns whether Walking.
MakeCharacterAttribute-FB1CharacterAttributeMakes Character Attribute.
NeedTeleportAfterProcess-boolean
OnAttemptMoveTogether--Callback invoked on Attempt Move Together.
OnBecameGhost--Callback invoked on Became Ghost.
OnBeginOverlapOtherEntityId: FB1EntityId-Callback invoked on Begin Overlap.
OnChangePostureByWaterAreabInActive: boolean-Callback invoked on Change Posture By Water Area.
OnCompleteInteraction_PlayReasonPlayReason: EB1InteractionPlayReason-Callback invoked on Complete Interaction_Play Reason.
OnEndOverlapOtherEntityId: FB1EntityId-Callback invoked on End Overlap.
OnLobbyCharacterSetting--Callback invoked on Lobby Character Setting.
OnPostFamilyMoveToSiteInSpawnLocation: 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--
PutDownGameObjectInPutDownEntityId: FB1EntityId, InLocation: FVector, InRotator: FRotator, InParentEntityId: FB1EntityIdFB2CarriableObject
PutInInventoryInPutInEntityId: FB1EntityIdboolean
RecoverHomesickInByUserInput: boolean-
RefreshAtHomeHomesickBuff--
RefreshAutonomyOptionCache--
RefreshB1SpawnbImmediate: boolean-
RefreshBoundSite--
RegisterExitVehicleTimeTask--Registers Exit Vehicle Time Task.
RegistryBabysitterServiceTimeTaskInTimeTaskId: FB1TimeTaskId-
RemoveDoorPrivilegeInReason: EB2DoorPrivilegeReason-Removes Door Privilege.
RemoveGrabEntity--Removes Grab Entity.
RemoveManagingHouseholdBizIdInHouseholdBizId: FB1EntityId-Removes Managing Household Biz Id.
RemoveOwningEntityIdInEntityId: FB1EntityId-Removes Owning Entity Id.
RemoveUsingCarriableObjectInEntityId: FB1EntityId-Removes Using Carriable Object.
RemoveZoiGroupId--Removes Zoi Group Id.
RequestAddChildEntityInEntityId: FB1EntityId, InAttachRule: EB1EntityAttachRule, InExtraRelativeTransform: FTransformbooleanHierarchy
RequestDie--Requests Die.
RequestRemoveChildEntityInEntityId: FB1EntityIdbooleanRequests Remove Child Entity.
RequestSnapToGround--Requests Snap To Ground.
ResetAttemptMoveTogether--Resets Attempt Move Together.
ResetMoveOverCoolTime--Resets Move Over Cool Time.
ResetOwnership-booleanResets Ownership.
ResetRentalEntityId--Resets Rental Entity Id.
ResetSafeControl--Resets Safe Control.
ResetShopWorkerSetting--Resets Shop Worker Setting.
ResolveValidTeleportLocationInLocation: FVector, InRotation: FRotatorFTransform
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.
SendUpdateAttachedCharacterRabbitHoleInRabbitHoleId: string-Sends Update Attached Character Rabbit Hole.
SetAppearancePresetIdInPresetId: string, InOutfitPresetId: string-Sets Appearance Preset Id.
SetAutonomySLMbInValue: boolean-Sets Autonomy SLM.
SetCharacterGroupTypeInCharacterGroupType: EB1CharacterGroupType, InFunctionName: string, InLine: integer-Sets Character Group Type.
SetCharacterHiddenInGameInNewHidden: boolean, InReason: string-Sets Character Hidden In Game.
SetConceptIdInConceptId: string-Sets Concept Id.
SetFloorLevelInFloorLevel: integer-Sets Floor Level.
SetGrabObjectHiddenInGameInNewHidden: boolean, InReason: string-Sets Grab Object Hidden In Game.
SetHopeLifeIdInHopeLifeId: string-Sets Hope Life Id.
SetHouseholdEntityIdInEntityId: FB1EntityId-Sets Household Entity Id.
SetIsIndoorbInIsIndoor: boolean-Sets Is Indoor.
SetIsPickedbInIsPicked: boolean-Sets Is Picked.
SetLocatedSiteIdInLocationSiteId: FB1EntityId-Sets Located Site Id.
SetLocationAndRotationOnlySimulInLocation: FVector, InRotation: FRotator, bDeferredRelativeUpdate: boolean-Sets Location And Rotation Only Simul.
SetLocationOnlySimulInLocation: FVector-Sets Location Only Simul.
SetLockInPriorityQueuebActive: boolean-Once the character has entered the PriorityQueue, it will not leave until this is set to false.
SetMainHouseholdBizIdInHouseholdBizId: FB1EntityId-Sets Main Household Biz Id.
SetPendingPutDownTransformInPutDownTransform: FTransform-Sets Pending Put Down Transform.
SetPendingSlotNameInSlotName: string-Sets Pending Slot Name.
SetPrivateCurrencyInId: string, InValue: integer-Sets Private Currency.
SetRotationOnlySimulInRotation: FRotator-Sets Rotation Only Simul.
SetTinyShopEntityIdInEntityId: FB1EntityId-Sets Tiny Shop Entity Id.
SetVoiceInVoice: FB1VoiceSettings, bSendPacket: boolean-Sets Voice.
SetZoiGroupIdInGroupId: FB1ZoiGroupId-Sets Zoi Group Id.
ShouldProcessTick-booleanReturns whether it should Process Tick.
StartLookAtLocLoc: FVector, Reason: EB1LookAtReason-Starts Look At Loc.
TeleportInLocation: FVector, InRotation: FRotator, InIsResponseReplyPosition: boolean, bTeleportOnGate: boolean, bPreventOverlap: boolean, bAdjustToFloorZ: boolean, bSkipSafeLocation: boolean, InLoadingContext: EB1LoadingContext, InTeleportReason: EB1TeleportReason-
TeleportToSafeLocInLoc: FVectorboolean
TryChangeDivePosture--
TryChangePostureByWaterArea--
TryChangeStateInState: EB2CharacterState, InReason: EB2EntityStateChangeReason-
TryDisembarkShipbForceDisembarkAtDock: booleanboolean
TryExitVehicle--
TrySendCharacterDataCacheTickInDeltaTime: number, bForceUpdate: boolean-
UnregisterExitVehicleTimeTask--Unregisters Exit Vehicle Time Task.
UpdateInDoorOutfitsbIsTakeOff: boolean-Updates In Door Outfits.
UpdateSafeControlTicks--Updates Safe Control Ticks.
UpdateShopWorkerRoleNameInRoleName: string, InSiteId: string-Updates Shop Worker Role Name.
UpdateSimulationTimeMetricDeltaTime: number-Updates Simulation Time Metric.
UpdateStatWhenEmbarkShip--Updates Stat When Embark Ship.
UpdatedAttendenceAbsentDay-boolean
UrnCreationCheck-boolean

Override points (111)

Implement these in Lua as FB2Character.Override_Name = function(...) end.

FunctionParametersReturnsDescription
Override_AddDisembarkInteractionInVehicleEntityId: FB1EntityId-Adds Disembark Interaction.
Override_AddDoorPrivilegeInReason: EB2DoorPrivilegeReason-System-only API (used in non-cheat cases).
Override_AddEnterShipInteractionInVehicleEntityId: FB1EntityId-Adds Enter Ship Interaction.
Override_AddManagingHouseholdBizIdInHouseholdBizId: FB1EntityId-Adds Managing Household Biz Id.
Override_AddOwningEntityIdInEntityId: FB1EntityId-Adds Owning Entity Id.
Override_AddPocketMarketFollowerInFollwer: integer-Adds Pocket Market Follower.
Override_AddShipwreckInteractionInDisasterId: string-Adds Shipwreck Interaction.
Override_AddUsingCarriableObjectInEntityId: FB1EntityId-Adds Using Carriable Object.
Override_ApplyCharacterAttributeInCharacterAttribute: FB1CharacterAttribute, bApplyPreferenceRelatedTrait: boolean-Applies Character Attribute.
Override_Ascend--
Override_AttachCharacterInHandType: EB1HandType, InAttachCharacter: FB2Characterboolean
Override_AttachGameObjectInHandType: EB1HandType, InObject: FB2GameObjectboolean
Override_AttachInventoryInInventoryId: FB1EntityIdboolean
Override_CanMoveOver-booleanReturns whether it can Move Over.
Override_CancelShopWorkerOrder--
Override_CleanUpContactsOnLeaveCity--
Override_CleanUpDataWhenDestroy--
Override_ClearActionContext--Clears Action Context.
Override_ClearCarriedGameObjectsForScheduleMove--Clears game objects held in hand during a scheduled move; carried characters are excluded.
Override_ClearCharacterStateInCallFunc: string, InCallLine: integer, bInResetAnimation: boolean, bResetBaby: boolean, bRemoveGrab: boolean-Clears Character State.
Override_ClearCharacterStateForCityMove--Clears Character State For City Move.
Override_CoopProceedForAllCoopMembers--
Override_DecrementAutonomyIntervalsDT: number-
Override_DestroyRentalShip--
Override_DetachCharacterInHandType: EB1HandType, InLocation: FVector, InRotator: FRotator, InApplyPacketTransform: booleanboolean
Override_DetachFromParentObject-boolean
Override_DetachGameObjectInHandType: EB1HandTypeboolean
Override_DetachGameObjectAndDestroyInHandType: EB1HandTypeboolean
Override_DetachGameObjectAndPutDownInHandType: EB1HandType, InLocation: FVector, InRotator: FRotator, InParentEntityId: FB1EntityIdFB2CarriableObject
Override_DetachGameObjectAndPutDownOnFloorInHandType: EB1HandTypebooleanPlaces the game object held in hand onto the nearby floor during a scheduled move.
Override_DetachGameObjectAndPutInInventoryInHandType: EB1HandTypeboolean
Override_DetachGameObjectAndThrowInHandType: EB1HandType, InParam: FB1ActivePhysicsParamboolean
Override_DetachInventoryInInventoryId: FB1EntityIdboolean
Override_DoShopWorkerSettingSpawnLocation: FVector, LinkedObjectId: FB1EntityId, InPreferInteractionBagIds: string[], InRoleName: string-
Override_FinishLookAtLocReason: EB1LookAtReason-
Override_ForceGoHomeCurrentTime: FDateTime-
Override_ForceIgnoreStat--
Override_ForceLeaveWorking--
Override_ForceMoveForInfant--
Override_ForceSendMovementData--
Override_GhostConditionCheck-boolean
Override_GrantKnockDoorVisitSitePrivilegeInDoorEntityId: FB1EntityId, InSiteEntityId: FB1EntityId-
Override_InitRealtimeInterval--Initializes Realtime Interval.
Override_InitRemainIntervalInType: EB2InitAutonomyIntervalType-Initializes Remain Interval.
Override_MakeCharacterAttribute-FB1CharacterAttributeMakes Character Attribute.
Override_NeedTeleportAfterProcess-boolean
Override_OnBecameGhost--Callback invoked on Became Ghost.
Override_OnBeginOverlapOtherEntityId: FB1EntityId-Callback invoked on Begin Overlap.
Override_OnChangePostureByWaterAreabInActive: boolean-Callback invoked on Change Posture By Water Area.
Override_OnCompleteInteraction_PlayReasonPlayReason: EB1InteractionPlayReason-Callback invoked on Complete Interaction_Play Reason.
Override_OnEndOverlapOtherEntityId: FB1EntityId-Callback invoked on End Overlap.
Override_OnLobbyCharacterSetting--Callback invoked on Lobby Character Setting.
Override_OnPossessedFamilyMemberDeathInGrowthStep: InGrowthStep-Callback invoked on Possessed Family Member Death.
Override_OnPostFamilyMoveToSiteInSpawnLocation: FVector, InTeleportToHome: boolean-Callback invoked on Post Family Move To Site.
Override_OnSimulationLevelPendingDemoted--Callback invoked on Simulation Level Pending Demoted.
Override_OnSpawnNpcBasicSetting--Callback invoked on Spawn Npc Basic Setting.
Override_OnSpawnNpcGrabObjectSetting--Callback invoked on Spawn Npc Grab Object Setting.
Override_OnSpawnedCharacter--Callback invoked on Spawned Character.
Override_OnSpawnedCharacterMesh--Callback invoked on Spawned Character Mesh.
Override_OnSpawnedGrabObject--Callback invoked on Spawned Grab Object.
Override_OnWASDMoving--Callback invoked on WASDMoving.
Override_ProcessBabySafety--
Override_ProcessCurrentSite--
Override_PutDownGameObjectInPutDownEntityId: FB1EntityId, InLocation: FVector, InRotator: FRotator, InParentEntityId: FB1EntityIdFB2CarriableObject
Override_PutInInventoryInPutInEntityId: FB1EntityIdboolean
Override_RecoverHomesickInByUserInput: boolean-
Override_RefreshAtHomeHomesickBuff--
Override_RefreshAutonomyOptionCache--
Override_RefreshB1SpawnbImmediate: boolean-
Override_RefreshBoundSite--
Override_RegisterExitVehicleTimeTask--Registers Exit Vehicle Time Task.
Override_RemoveDoorPrivilegeInReason: EB2DoorPrivilegeReason-Removes Door Privilege.
Override_RemoveGrabEntity--Removes Grab Entity.
Override_RemoveManagingHouseholdBizIdInHouseholdBizId: FB1EntityId-Removes Managing Household Biz Id.
Override_RemoveOwningEntityIdInEntityId: FB1EntityId-Removes Owning Entity Id.
Override_RemoveUsingCarriableObjectInEntityId: FB1EntityId-Removes Using Carriable Object.
Override_RemoveZoiGroupId--Removes Zoi Group Id.
Override_RequestAddChildEntityInEntityId: FB1EntityId, InAttachRule: EB1EntityAttachRule, InExtraRelativeTransform: FTransformbooleanHierarchy
Override_RequestDie--Requests Die.
Override_RequestRemoveChildEntityInEntityId: FB1EntityIdbooleanRequests Remove Child Entity.
Override_RequestSnapToGround--Requests Snap To Ground.
Override_ResetMoveOverCoolTime--Resets Move Over Cool Time.
Override_ResetOwnership-booleanResets Ownership.
Override_ResetRentalEntityId--Resets Rental Entity Id.
Override_ResetShopWorkerSetting--Resets Shop Worker Setting.
Override_ResolveValidTeleportLocationInLocation: FVector, InRotation: FRotatorFTransform
Override_RevokeKnockDoorVisitSitePrivilege--
Override_SendCancelWalkTo--Sends Cancel Walk To.
Override_SendCompactData--Sends Compact Data.
Override_SendPossessCharacterDataCache--Sends Possess Character Data Cache.
Override_SendRelationshipDataCache--Sends Relationship Data Cache.
Override_SendUnlockRewardObjectPacket--Sends Unlock Reward Object Packet.
Override_SendUpdateAttachedCharacterRabbitHoleInRabbitHoleId: string-Sends Update Attached Character Rabbit Hole.
Override_ShouldProcessTick-booleanReturns whether it should Process Tick.
Override_StartLookAtLocLoc: FVector, Reason: EB1LookAtReason-Starts Look At Loc.
Override_TeleportInLocation: FVector, InRotation: FRotator, InIsResponseReplyPosition: boolean, bTeleportOnGate: boolean, bPreventOverlap: boolean, bAdjustToFloorZ: boolean, bSkipSafeLocation: boolean, InLoadingContext: EB1LoadingContext, InTeleportReason: EB1TeleportReason-
Override_TeleportToSafeLocInLoc: FVectorboolean
Override_TryChangeDivePosture--
Override_TryChangePostureByWaterArea--
Override_TryChangeStateInState: EB2CharacterState, InReason: EB2EntityStateChangeReason-
Override_TryDisembarkShipbForceDisembarkAtDock: booleanboolean
Override_TryExitVehicle--
Override_TrySendCharacterDataCacheTickInDeltaTime: number, bForceUpdate: boolean-
Override_UnregisterExitVehicleTimeTask--Unregisters Exit Vehicle Time Task.
Override_UpdateInDoorOutfitsbIsTakeOff: boolean-Updates In Door Outfits.
Override_UpdateSafeControlTicks--Updates Safe Control Ticks.
Override_UpdateShopWorkerRoleNameInRoleName: string, InSiteId: string-Updates Shop Worker Role Name.
Override_UpdateSimulationTimeMetricDeltaTime: number-Updates Simulation Time Metric.
Override_UpdateStatWhenEmbarkShip--Updates Stat When Embark Ship.
Override_UpdatedAttendenceAbsentDay-boolean
Override_UrnCreationCheck-boolean