1. Epic GamesDeveloper
  3. FLayeredMoveBase

FLayeredMoveBase

Base class for all layered moves.

API > API/Plugins > API/Plugins/Mover

Inheritance Hierarchy

References

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

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FLayeredMoveBase

Remarks

Layered Moves are methods of affecting motion on a Mover-based actor, typically for a limited time. Common uses would be for jumping, dashing, blast forces, etc. They are ticked as part of the Mover simulation, and produce a proposed move. These proposed moves are aggregated and applied to the overall attempted move. Multiple layered moves can be active at any time, and may produce additive motion or motion that overrides what the current Movement Mode may intend. Layered moves can also set a preferred movement mode that only changes the movement mode at the start of the move. Any movement mode changes that need to happen as part of the layered move after the start of the move need to be queued through an Instant Effect or the QueueNextMode function

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float DurationMs This move 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.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FLayeredMoveFinishVelocitySettings FinishVelocitySettings Settings related to velocity applied to the actor after a layered move has finished.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EMoveMixMode MixMode Determines how this object's movement contribution should be mixed with others.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8 Priority Determines if this layered move should take priority over other layered moves when different moves have conflicting overrides - higher numbers taking precedent.
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 FLayeredMoveBase *

Clone ()

  
Public function void

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

 Ends this move, allowing any cleanup to occur.
Public function Virtual bool

GenerateMove ( const FMoverTickStartData& StartState,
const FMoverTimeStep& TimeStep,
const UMoverComponent* MoverComp,
UMoverBlackboard* SimBlackboard,
FProposedMove& OutProposedMove
)

 TODO: consider whether MoverComp should just be part of FMoverTickStartData Generate a movement that will be combined with other sources
Public function Virtual Const UScriptStruct *  
Public function Virtual Const bool

HasGameplayTag ( FGameplayTag TagToFind,
bool bExactMatch
)

 Check Layered Move for a gameplay tag.
Public function Virtual Const bool

IsFinished ( float CurrentSimTimeMs
)

 Runtime query whether this move is finished and can be destroyed. The default implementation is based on DurationMs.
Public function Virtual void  
Public function Virtual void

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

 Called when this layered move ends.
Public function Virtual void

OnStart ( const UMoverComponent* MoverComp,
UMoverBlackboard* SimBlackboard
)

 Called when this layered move starts.
Public function void

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

 Kicks off this move, 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