1. Epic GamesDeveloper
  3. FLayeredMoveGroup

FLayeredMoveGroup

A collection of layered moves affecting a movable actor.

API > API/Plugins > API/Plugins/Mover

References

   
Module Mover
Header /Engine/Plugins/Experimental/Mover/Source/Mover/Public/LayeredMove.h
Include #include "LayeredMove.h"

Syntax

USTRUCT (BlueprintType )  
struct FLayeredMoveGroup

Remarks

A collection of layered moves affecting a movable actor.

Variables

  Type Name Description
Protected variable TArray< TSharedPtr< FLayeredMoveBase > > ActiveLayeredMoves Layered moves currently active in this group
Public variable UProperty Category BlueprintReadOnly notreplicated, visibleanywhere bool bApplyResidualVelocity If true ResidualVelocity will be the next velocity used for this actor Note: This is set automatically when a layered move has ended based off of end velocity settings - it is not meant to be set by the user see @FLayeredMoveFinishVelocitySettings
Protected variable TArray< TSharedPtr< FLayeredMoveBase > > QueuedLayeredMoves Moves that are queued to become active next sim frame
Public variable UProperty Category BlueprintReadOnly notreplicated, visibleanywhere float ResidualClamping Clamps an actors velocity to this value when a layered move ends.
Public variable UProperty Category BlueprintReadOnly notreplicated, visibleanywhere FVector ResidualVelocity If bApplyResidualVelocity is true this actors velocity will be set to this.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void Exposes references to GC system
Protected function void

FlushMoveArrays ( const UMoverComponent* MoverComp,
UMoverBlackboard* SimBlackboard,
float CurrentSimTimeMs
)

 Clears out any finished or invalid active moves and adds any queued moves to the active moves.
Protected function void

GatherResidualVelocitySettings ( const TSharedPtr< FLayeredMoveBase >& Move,
bool& bResidualVelocityOverriden,
bool& bClampVelocityOverriden
)

 Helper function for gathering any residual velocity settings from layered moves that just ended.
Public function TArray< TSharedPtr< FLayeredMoveBase > >

GenerateActiveMoves ( const FMoverTimeStep& TimeStep,
const UMoverComponent* MoverComp,
UMoverBlackboard* SimBlackboard
)

 Generates active layered move list (by calling FlushMoveArrays) and returns the an array of all currently active layered moves.
Public function Const TArray< TSharedPtr< FLayeredMoveBase > >::TConstIterator Const access to active moves
Public function Const TArray< TSharedPtr< FLayeredMoveBase > >::TConstIterator Const access to queued moves
Public function Const bool  
Public function void

NetSerialize ( FArchive& Ar,
uint8 MaxNumMovesToSerialize
)

 Serialize all moves and their states for this group
Protected function Static void

NetSerializeLayeredMovesArray ( FArchive& Ar,
TArray< TSharedPtr< FLayeredMoveBase > >& LayeredMovesArray,
uint8 MaxNumLayeredMovesToSerialize
)

 Helper function for serializing array of root motion sources
Public function void  
Public function void Resets residual velocity related settings.
Public function Const FString Get a simplified string representation of this group. Typically for debugging.

Operators

  Type Name Description
Public function Const bool

operator!= ( const FLayeredMoveGroup& Other
)

 Comparison operator
Public function FLayeredMoveGroup &

operator= ( const FLayeredMoveGroup& Other
)

 Copy operator - deep copy so it can be used for archiving/saving off moves
Public function Const bool

operator== ( const FLayeredMoveGroup& Other
)

 Comparison operator - needs matching LayeredMoves along with identical states in those structs

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page