1. Epic GamesDeveloper
  3. FMovementModifierBase

FMovementModifierBase

Movement Modifier: Used to apply changes that indirectly influence the movement simulation, without proposing or executing any movement, but still in sync with the sim.

API > API/Plugins > API/Plugins/Mover

Inheritance Hierarchy

References

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

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FMovementModifierBase

Remarks

Movement Modifier: Used to apply changes that indirectly influence the movement simulation, without proposing or executing any movement, but still in sync with the sim. Example usages: changing groups of settings, movement mode re-mappings, etc.

Note: Currently mover expects to only have one type of modifier active at a time. This can be fixed by extending the Matches function to check more than just type, but make sure anything used to compare is synced through the NetSerialize function.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float DurationMs This modifier will expire after a set amount of time if > 0. If 0, it will be ticked only once, regardless of time step. It will need to be manually ended if < 0.
Protected variable UProperty FMovementModifierHandle LocalModifierHandle Modifier handle local to this client or server instance.
Public variable UProperty Category BlueprintReadOnly Transient visibleinstanceonly float StartSimTimeMs The simulation time this move first ticked (< 0 means it hasn't started yet)

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void  
Public function Virtual Const FMovementModifierBase *

Clone ()

  
Public function void

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

 Ends this move, allowing any cleanup to occur.
Public function void  
Public function Const FMovementModifierHandle  
Public function Virtual Const UScriptStruct *  
Public function Virtual Const bool

HasGameplayTag ( FGameplayTag TagToFind,
bool bExactMatch
)

 Check modifier for a gameplay tag.
Public function Virtual Const bool

IsFinished ( float CurrentSimTimeMs
)

 Runtime query whether this modifier is finished and can be destroyed.
Public function Virtual Const bool

Matches ( const FMovementModifierBase* Other
)

 Used to compare modifiers and check if they are the same instance of modifiers.
Public function Virtual void  
Public function Virtual void

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

 Fired when this modifier is deactivated.
Public function Virtual void

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

 Fired after a movement Substep
Public function Virtual void

OnPreMovement ( UMoverComponent* MoverComp,
const FMoverTimeStep& TimeStep
)

 Fired just before a movement Substep
Public function Virtual void

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

 Fired when this modifier is activated.
Public function void

OverwriteHandleIfInvalid ( const FMovementModifierHandle& ValidModifierHandle
)

 Used to write to a valid handle to a invalid handle Currently used to write a local handle to modifiers that were added from a rollback so they don't have a handle yet This is done to avoid queueing a modifier again as a local client applies potential input
Public function void

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

 Kicks off this modifier, allowing any initialization to occur.
Public function Virtual Const FString  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page