FB2Script_Character

Overview

Character-domain game-rule script (Condition_/Execute_ static functions). Override in Lua with Override_.

Metadata

Field	Value
Kind	`script`
Environment	B2 - Simulation
Category	`scripts`
Require	`require('Scripts.B2Script_Character')`

Functions (41)

Function	Parameters	Returns
`Condition_CanInteractWithGhost` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_CheckGhostInteractionReason` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_CrowdGroup` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_HasBlockingChildNearby` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_HasPutableObjectOnHand` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_HasStolenObject` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsBabyBeingHeld` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsCharacterRole` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsGhostCharacter` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsGrabbingTargetCharacter` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsInSiteWithInTime` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsInWaterArea` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsMatchingRomanceTarget` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsOccupyingObjectOwnedBy` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsPlayerCharacter` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsPurchasable` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsRabbitHole` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsStaticNpc` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsSurfingResult` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsTinyShopOwner` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsUniqueEventNpc` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_RomanticOrientation` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Execute_Ascend` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_BanSprint` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_CompleteSteal` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_DetachCharacterFromParentObject` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_DisableSprint` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_EnableSprint` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_FinishLookAtLoc` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_ImpulseRagdoll` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_PickUpAttachCharacter` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_PlayVideo` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_PutDownDetachCharacter` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_PutDownDetachCharacterAttachToGameObject` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_SeizeAndFineStolenObjects` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_SetDoorPrivilege` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_SetGhostInteractionAvailability` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_SetKnockDoorVisitSitePrivilege` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_StartFloatingOnWater` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_StartLookAtLoc` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_StopFloatingOnWater` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`

Override points (41)

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

Function	Parameters	Returns	Description
`Override_Condition_CanInteractWithGhost` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_CheckGhostInteractionReason` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_CrowdGroup` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_HasBlockingChildNearby` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_HasPutableObjectOnHand` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_HasStolenObject` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsBabyBeingHeld` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsCharacterRole` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsGhostCharacter` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsGrabbingTargetCharacter` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsInSiteWithInTime` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsInWaterArea` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsMatchingRomanceTarget` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsOccupyingObjectOwnedBy` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsPlayerCharacter` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsPurchasable` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsRabbitHole` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsStaticNpc` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsSurfingResult` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsTinyShopOwner` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsUniqueEventNpc` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_RomanticOrientation` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Execute_Ascend` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_BanSprint` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_CompleteSteal` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_DetachCharacterFromParentObject` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_DisableSprint` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_EnableSprint` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_FinishLookAtLoc` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_ImpulseRagdoll` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_PickUpAttachCharacter` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_PlayVideo` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_PutDownDetachCharacter` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_PutDownDetachCharacterAttachToGameObject` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_SeizeAndFineStolenObjects` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_SetDoorPrivilege` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_SetGhostInteractionAvailability` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_SetKnockDoorVisitSitePrivilege` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_StartFloatingOnWater` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_StartLookAtLoc` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_StopFloatingOnWater` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.