1. Epic GamesDeveloper
  3. FLayeredMoveInstanceGroup

FLayeredMoveInstanceGroup

The group of information about currently active and queued moves.

API > API/Plugins > API/Plugins/Mover

The group of information about currently active and queued moves. This replicates info for FLayeredMoveInstancedData only - it is expected that the corresponding ULayeredMoveLogic is already registered with the mover component.

   
Name FLayeredMoveInstanceGroup
Type struct
Header File /Engine/Plugins/Experimental/Mover/Source/Mover/Public/LayeredMoveGroup.h
Include Path #include "LayeredMoveGroup.h"

Syntax

USTRUCT (BlueprintType )  
struct FLayeredMoveInstanceGroup

Constructors

Name Remarks Include Path Unreal Specifiers

FLayeredMoveInstanceGroup()

   LayeredMoveGroup.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bApplyResidualVelocity bool 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 LayeredMoveGroup.h
  • NotReplicated
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category=Mover
  • Meta=(AllowPrivateAccess)
ResidualClamping float Clamps an actors velocity to this value when a layered move ends. LayeredMoveGroup.h
  • NotReplicated
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category=Mover
  • Meta=(AllowPrivateAccess)
ResidualVelocity FVector If bApplyResidualVelocity is true this actors velocity will be set to this. LayeredMoveGroup.h
  • NotReplicated
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category=Mover
  • Meta=(AllowPrivateAccess)
TagCancellationRequests TArray< TPair< FGameplayTag, bool > > Used during simulation to cancel any moves that match a tag LayeredMoveGroup.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddStructReferencedObjects ( FReferenceCollector& Collector
) const

   LayeredMoveGroup.h  

void ApplyResidualVelocity ( FProposedMove& InOutProposedMove
)

   LayeredMoveGroup.h  

void CancelMovesByTag ( FGameplayTag Tag,
bool bRequireExactMatch
)

 Cancel any active or queued moves with a matching tag LayeredMoveGroup.h  

const FLayeredMoveInstance * FindActiveMove ( const UScriptStruct* MoveDataType
) const

 Returns the first active layered move using data of the specified type, if one exists LayeredMoveGroup.h  
Returns the first active layered move associated with logic of the specified type, if one exists LayeredMoveGroup.h  

const FLayeredMoveInstance * FindQueuedMove ( const UScriptStruct* MoveDataType
) const

 Returns the first queued layered move using data of the specified type, if one exists LayeredMoveGroup.h  
Returns the first queued layered move associated with logic of the specified type, if one exists LayeredMoveGroup.h  

void FlushMoveArrays ( const FMoverTimeStep& TimeStep,
UMoverBlackboard* SimBlackboard
)

 Clears out any finished or invalid active moves and adds any queued moves to the active moves. LayeredMoveGroup.h  

bool GenerateMixedMove ( const FMoverTickStartData& StartState,
const FMoverTimeStep& TimeStep,
UMovementMixer& MovementMixer,
UMoverBlackboard* SimBlackboard,
FProposedMove& OutMixedMove
)

   LayeredMoveGroup.h  

bool HasAnyMoves()

   LayeredMoveGroup.h  

bool HasMove()

   LayeredMoveGroup.h  

bool HasSameContents ( const FLayeredMoveInstanceGroup& Other
) const

 Checks only whether there are matching LayeredMoves, but NOT necessarily identical states of each move LayeredMoveGroup.h  

void NetSerialize ( FArchive& Ar,
uint8 MaxNumMovesToSerialize
)

   LayeredMoveGroup.h  

void PopulateMissingActiveMoveLogic ( const TArray< TObjectPtr< ULayeredMoveLogic > >& RegisteredMoves
)

 Loops through all Queued and Active moves and populates any missing MoveLogic using FLayeredMoveInstance::PopulateMissingActiveMoveLogic. LayeredMoveGroup.h  

void QueueLayeredMove ( const TSharedPtr< FLayeredMoveInstance >& Move
)

 Adds the active move to the queued array of the move group LayeredMoveGroup.h  

void Reset()

   LayeredMoveGroup.h  

void ResetResidualVelocity()

   LayeredMoveGroup.h  

FString ToSimpleString()

 Get a simplified string representation of this group. Typically for debugging. LayeredMoveGroup.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ProcessFinishedMove ( const FLayeredMoveInstance& Move,
bool& bResidualVelocityOverriden,
bool& bClampVelocityOverriden
)

 Helper function for gathering any residual velocity settings from layered moves that just ended. LayeredMoveGroup.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FLayeredMoveInstanceGroup& Other
) const

   LayeredMoveGroup.h  
  LayeredMoveGroup.h  

bool operator== ( const FLayeredMoveInstanceGroup& Other
) const

   LayeredMoveGroup.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page