1. Epic GamesDeveloper
  3. FMovementModifierGroup

FMovementModifierGroup

A collection of movement modifiers affecting a movable actor.

API > API/Plugins > API/Plugins/Mover

A collection of movement modifiers affecting a movable actor.

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

Syntax

USTRUCT (BlueprintType )  
struct FMovementModifierGroup

Constructors

Name Remarks Include Path Unreal Specifiers

FMovementModifierGroup()

   MovementModifier.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddStructReferencedObjects ( FReferenceCollector& Collector
) const

 Exposes references to GC system MovementModifier.h  

void CancelModifierFromHandle ( const FMovementModifierHandle& HandleToCancel
)

   MovementModifier.h  

void CancelModifiersByTag ( FGameplayTag Tag,
bool bRequiresExactMatch
)

   MovementModifier.h  

TArray< TSharedPtr< FMovementModifierBase > > GenerateActiveModifiers ( UMoverComponent* MoverComp,
const FMoverTimeStep& TimeStep,
const FMoverSyncState& SyncState,
const FMoverAuxStateContext& AuxState
)

 Generates active modifier list (by calling FlushModifierArrays) and returns the an array of all currently active modifiers. MovementModifier.h  

TArray< TSharedPtr< FMovementModifierBase > > GenerateActiveModifiers_Async ( const FMovementModifierParams_Async& Params
)

   MovementModifier.h  

TArray< TSharedPtr< FMovementModifierBase > >::TConstIterator GetActiveModifiersIterator()

 Const access to active moves MovementModifier.h  

TArray< TSharedPtr< FMovementModifierBase > >::TConstIterator GetQueuedModifiersIterator()

 Const access to queued moves MovementModifier.h  

bool HasAnyMoves()

   MovementModifier.h  

bool HasSameContents ( const FMovementModifierGroup& Other
) const

 Checks only whether there are matching modifiers, but NOT necessarily identical states of each one MovementModifier.h  

void NetSerialize ( FArchive& Ar,
uint8 MaxNumModifiersToSerialize
)

 Serialize all modifiers and their states for this group MovementModifier.h  

void QueueMovementModifier ( TSharedPtr< FMovementModifierBase > Modifier
)

   MovementModifier.h  

void Reset()

 Clears active and queued modifiers. MovementModifier.h  

bool ShouldReconcile ( const FMovementModifierGroup& Other
) const

 Whether this modifier should reconcile with the authority state. MovementModifier.h  

FString ToSimpleString()

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

Protected

Name Remarks Include Path Unreal Specifiers

void FlushModifierArrays ( UMoverComponent* MoverComp,
const FMoverTimeStep& TimeStep,
const FMoverSyncState& SyncState,
const FMoverAuxStateContext& AuxState
)

 Clears out any finished or invalid modifiers and adds any queued modifiers to the active modifiers. MovementModifier.h  

void FlushModifierArrays_Async ( const FMovementModifierParams_Async& Params
)

   MovementModifier.h  

Static

Name Remarks Include Path Unreal Specifiers

static void NetSerializeMovementModifierArray ( FArchive& Ar,
TArray< TSharedPtr< FMovementModifierBase > >& ModifierArray,
uint8 MaxNumModifiersToSerialize
)

 Helper function for serializing array of movement modifiers MovementModifier.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FMovementModifierGroup& Other
) const

 Comparison operator MovementModifier.h  

FMovementModifierGroup & operator= ( const FMovementModifierGroup& Other
)

 Copy operator - deep copy so it can be used for archiving/saving off moves MovementModifier.h  

bool operator== ( const FMovementModifierGroup& Other
) const

 Comparison operator - needs matching modifier along with identical states in those structs MovementModifier.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page