FB2CharacterMovementComponent

Overview

Component that manages character movement.

Metadata

Field	Value
Kind	`component`
Environment	B2 - Simulation
Category	`components`
Extends	`FB2Component`
Require	`require('Components.B2CharacterMovementComponent')`

Properties (44)

Name	Type	Description
`AvoidanceHandler`	`FB2AvoidanceHandler`
`DebugInfos`	`FB2MovementDebugInfo[]`
`DiveHandler`	`FB2DiveHandler`
`FloatingMoveOnWaterRadius`	`number`
`FloatingMoveOnWaterType`	`EB1FloatingMoveType`
`HalfHeight`	`number`
`HoldHandBreakDistance`	`number`
`HoldHandFollowTargetId`	`FB1EntityId`	Hold-hand follow-walk target.
`HoldHandLastGoalPos`	`FVector`
`HoldHandLeadTime`	`number`
`HoldHandSideOffset`	`number`
`InputVector`	`FVector`
`LadderHandler`	`FB2LadderHandler`
`LastTickLocation`	`FVector`
`LastTickTime`	`FDateTime`
`MotionWarping`	`FB2MotionWarpingParam`
`MoveReason`	`EB2CharacterMoveReason`
`OnBoardHandler`	`FB2OnBoardHandler`
`PathFollower`	`FB2PathFollower`
`PortalHandler`	`FB2PortalHandler`
`PostureComponent`	`any`
`RemainMoveDelta`	`FVector`
`RootMotion`	`FB2RootMotionMovementParams`
`RootMotion_MontageOnly`	`FB2RootMotionMovementParams`
`SafeMoveReason`	`table<string, boolean>`
`SitePortalHandler`	`FB2SitePortalHandler`
`SprintBanReasonSet`	`table<EB1SprintReason, boolean>`
`SprintReasonSet`	`table<EB1SprintReason, boolean>`
`SwimmingPoolHandler`	`FB2SwimmingPoolHandler`
`Velocity`	`FVector`
`WalkSpeed`	`number`
`bB1RecentlyRendered`	`boolean`
`bEscapeUnderwaterTriggered`	`boolean`
`bHoldHandFollowOnRight`	`boolean`
`bHoldHandLocomotionMoving`	`boolean`	This character reports its own B1 LocomotionState (Walk/Jog) every 0.1 seconds while holding hands. Read the partner component for the leader state; read this component for the follower stop state.
`bHoldHandSettled`	`boolean`	Runtime hysteresis: tolerate small position changes after settling.
`bHoldHandWasMainMoving`	`boolean`
`bIsB1PlayingMontage`	`boolean`	From B1
`bIsNearSeafloor`	`boolean`
`bIsProcessTeleport`	`boolean`
`bIsUpdatedSafeMoveState`	`boolean`
`bNeedCheckValidLocation`	`boolean`
`bNeedsAvoidanceUpdate`	`boolean`	For parallel processing: flag indicating an AvoidanceManager update is needed.
`bWasWalkToAction`	`boolean`

Functions (50)

Function	Parameters	Returns	Description
`CanTravel`	`-`	`boolean`	Returns whether it can Travel.
`ClearAvoidanceUpdateFlag`	`-`	`-`	Clears Avoidance Update Flag.
`ClearData`	`-`	`-`	Clears Data.
`FinishTeleport`	`-`	`-`
`GetCityMovePolicyMap`	InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`table<string, EB1CityMoveDataPolicy>`	Returns City Move Policy Map.
`GetCurrentNode`	`-`	`FB1NavigationNode`	Returns Current Node.
`GetCurrentNodeFloorZ`	OutFloorZ: `number`	`boolean`	Returns Current Node Floor Z.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetInputVector`	`-`	`FVector`	Returns Input Vector.
`GetLastTickTime`	`-`	`FDateTime`	Returns Last Tick Time.
`GetMotionWarpingBlendTime`	`-`	`number`	Returns Motion Warping Blend Time.
`GetMotionWarpingParam`	`-`	`FB2MotionWarpingParam`	Returns Motion Warping Param.
`GetMoveReason`	`-`	`EB2CharacterMoveReason`	Returns Move Reason.
`GetOwnerCharacter`	Self: `FB2CharacterMovementComponent`	`-`	Returns Owner Character.
`GetVelocity`	`-`	`FVector`	Returns Velocity.
`GetWalkStartRotation`	`-`	`FRotator`	Returns Walk Start Rotation.
`IsAvoidanceHandlerActive`	`-`	`boolean`	Returns whether Avoidance Handler Active.
`IsBlendingOutMotionWarping`	`-`	`boolean`	Returns whether Blending Out Motion Warping.
`IsDiving`	`-`	`boolean`	Returns whether Diving.
`IsEnableMotionWarping`	`-`	`boolean`	Returns whether Enable Motion Warping.
`IsHoldHandFollowing`	`-`	`boolean`	Returns whether Hold Hand Following.
`IsNearSeafloor`	`-`	`boolean`	Returns whether Near Seafloor.
`IsSafeMove`	`-`	`boolean`	Returns whether Safe Move.
`NeedsAvoidanceUpdate`	`-`	`boolean`	Returns whether an avoidance update is needed (collected after parallel processing).
`OnAsyncQueryPath`	`-`	`-`	Callback invoked on Async Query Path.
`OnB2PreBeginPlay`	`-`	`-`	Callback invoked on B2 Pre Begin Play.
`OnReceiveB1ChangeNode`	InNewNodeIndex: `integer`, InAdjustedLocation: `FVector`	`-`	Callback invoked on Receive B1 Change Node.
`OnScheduledTick`	DeltaTime: `number`, CurrentTime: `FDateTime`, GameDeltaMinutes: `number`	`-`	Scheduler-based tick called by the MovementUpdateSystem.
`OnScheduledTick_Parallel`	DeltaTime: `number`, CurrentTime: `FDateTime`, GameDeltaMinutes: `number`	`-`	Split function for parallel processing.
`OnScheduledTick_PostProcess`	`-`	`-`	Callback invoked on Scheduled Tick_Post Process.
`QuitPathFollow`	`-`	`-`
`RequestDiveProcess`	bStartDive: `boolean`	`-`	Requests Dive Process.
`RequestMotionWarping`	InParam: `FB2MotionWarpingParam`, InMontage: `FB1MontageTableRow`	`-`	MotionWarping
`ResetDiveHandler`	`-`	`-`	Resets Dive Handler.
`ResetMotionWarping`	`-`	`-`	Resets Motion Warping.
`ResetMotionWarpingSyncWithB1`	`-`	`-`	Resets Motion Warping Sync With B1.
`SendMovementData`	`-`	`-`	To B1
`SetBanSprint`	bIsBanSprint: `boolean`, Reason: `EB1SprintReason`	`-`	Sets Ban Sprint.
`SetFloatingMoveOnWater`	InFloatingMoveType: `EB1FloatingMoveType`, InRadius: `number`	`-`	Sets Floating Move On Water.
`SetHoldHandBreakDistance`	InDistance: `number`	`-`	Sets Hold Hand Break Distance.
`SetHoldHandLeadTime`	InLeadTime: `number`	`-`	Sets Hold Hand Lead Time.
`SetHoldHandSideOffset`	InSideOffset: `number`	`-`	Sets Hold Hand Side Offset.
`SetSprint`	bIsSprint: `boolean`, InSprintReason: `EB1SprintReason`	`-`	Sets Sprint.
`StartHoldHandFollow`	InPossessedEntityId: `FB1EntityId`, bOnRight: `boolean`	`-`	Starts hold-hand follow-walking.
`StopHoldHandFollow`	`-`	`-`	Stops Hold Hand Follow.
`Teleport`	InLocation: `FVector`, InRotation: `FRotator`, InbIsProcessTeleport: `boolean`, bSkipSafeLocation: `boolean`	`-`
`TrySetSafeValidLocation`	bIsTeleport: `boolean`, InNavFloorQueryExtent: `FVector`	`-`
`UpdateSafeMove`	bIsSafeMove: `boolean`, InReason: `string`	`-`	Updates Safe Move.
`WasWalkToAction`	`-`	`boolean`
`WriteReportSlack`	`-`	`-`

Override points (21)

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

Function	Parameters	Returns	Description
`Override_ClearData`	`-`	`-`	Clears Data.
`Override_FinishTeleport`	`-`	`-`
`Override_OnAsyncQueryPath`	`-`	`-`	Callback invoked on Async Query Path.
`Override_OnB2PreBeginPlay`	`-`	`-`	Callback invoked on B2 Pre Begin Play.
`Override_OnReceiveB1ChangeNode`	InNewNodeIndex: `integer`, InAdjustedLocation: `FVector`	`-`	Callback invoked on Receive B1 Change Node.
`Override_OnScheduledTick`	DeltaTime: `number`, CurrentTime: `FDateTime`, GameDeltaMinutes: `number`	`-`	Scheduler-based tick called by the MovementUpdateSystem.
`Override_OnScheduledTick_Parallel`	DeltaTime: `number`, CurrentTime: `FDateTime`, GameDeltaMinutes: `number`	`-`	Split function for parallel processing.
`Override_OnScheduledTick_PostProcess`	`-`	`-`	Callback invoked on Scheduled Tick_Post Process.
`Override_QuitPathFollow`	`-`	`-`
`Override_RequestDiveProcess`	bStartDive: `boolean`	`-`	Requests Dive Process.
`Override_RequestMotionWarping`	InParam: `FB2MotionWarpingParam`, InMontage: `FB1MontageTableRow`	`-`	MotionWarping
`Override_ResetMotionWarping`	`-`	`-`	Resets Motion Warping.
`Override_ResetMotionWarpingSyncWithB1`	`-`	`-`	Resets Motion Warping Sync With B1.
`Override_SendMovementData`	`-`	`-`	To B1
`Override_SetFloatingMoveOnWater`	InFloatingMoveType: `EB1FloatingMoveType`, InRadius: `number`	`-`	Sets Floating Move On Water.
`Override_StartHoldHandFollow`	InPossessedEntityId: `FB1EntityId`, bOnRight: `boolean`	`-`	Starts hold-hand follow-walking.
`Override_StopHoldHandFollow`	`-`	`-`	Stops Hold Hand Follow.
`Override_Teleport`	InLocation: `FVector`, InRotation: `FRotator`, InbIsProcessTeleport: `boolean`, bSkipSafeLocation: `boolean`	`-`
`Override_TrySetSafeValidLocation`	bIsTeleport: `boolean`, InNavFloorQueryExten: `FVector`	`-`
`Override_UpdateSafeMove`	bIsSafeMove: `boolean`, InReason: `string`	`-`	Updates Safe Move.
`Override_WriteReportSlack`	`-`	`-`