UCISRootMotionMovementTask

MODULECharacterInteractionSystemINCLUDECommon/CISRootMotionMovementTask.hPARENTUBlueprintAsyncActionBase

An async action that moves a character to a point with a root motion source, and reports when the move ends. Create it with RootMotionMoveTo. Call FinishMovement (StopMovement in Blueprints) to end the move before it arrives.

Functions

AUTHORITY · server, every machineLOCAL · this machinePURE · read only

UCISRootMotionMovementTask* RootMotionMoveTo( ACharacter* Character, FVector TargetLocation, ECollisionChannel CollisionCheckTraceType = ECC_WorldStatic, float MoveToDistance = 0.f, EMovementMode MovementMode = EMovementMode::MOVE_Walking, ERootMotionAccumulateMode RootMotionAccumulateMode = ERootMotionAccumulateMode::Override, bool bWithCustomMoveSpeed = false, float CustomMoveSpeed = 0.f, float TimeOut = 2.f, float VerticalOffset = 0.f)

Moves Character to TargetLocation (put on the ground found below it by CollisionCheckTraceType, plus VerticalOffset) with a root motion source at its MaxWalkSpeed or at CustomMoveSpeed. Finishes when the movement ends or after TimeOut seconds, then OnTimeOut follows. A move that needs longer than TimeOut ends at the time-out, before the character arrives. With a speed of 0 the character stays where it is until TimeOut. MoveToDistance is not used; kept for compatibility

Category

CIS|RootMotionMovement

void FinishMovement()

Stops the move: removes its root motion source, restores the movement mode and, when a custom speed was set, the walk speed. Then it runs OnRootMotionMovementFinished and releases the task. Does nothing when the move has already ended. Shown as StopMovement in Blueprints.

Category

CIS|RootMotionMovement

Events

FCISOnRootMotionMovementCreated OnRootMotionMovementCreated

(UCISRootMotionMovementTask* Task)

Runs when the move has started and its root motion source is applied. The task is passed, so that a Blueprint can keep it.

Category

CIS|Delegates

FCISOnRootMotionMovementEvent OnRootMotionMovementFinished

()

Runs when the move ends: when the character arrives, when StopMovement ends it, or when the character is no longer valid. It runs before OnTimeOut when the time-out ends the move.

Category

CIS|Delegates

FCISOnRootMotionMovementEvent OnTimeOut

()

Runs when TimeOut ends the move before the character arrived. It runs after OnRootMotionMovementFinished.

Category

CIS|Settings