1. Epic GamesDeveloper
  3. UBaseMovementMode

UBaseMovementMode

Base class for all movement modes, exposing simulation update methods for both C++ and blueprint extension

API > API/Plugins > API/Plugins/Mover

Base class for all movement modes, exposing simulation update methods for both C++ and blueprint extension

   
Name UBaseMovementMode
Type class
Header File /Engine/Plugins/Experimental/Mover/Source/Mover/Public/MovementMode.h
Include Path #include "MovementMode.h"

Syntax

UCLASS (MinimalAPI, Abstract, Within=MoverComponent, Blueprintable, BlueprintType, EditInlineNew,  
       DefaultToInstanced)  
class UBaseMovementMode : public UObject

Inheritance Hierarchy

Derived Classes

UBaseMovementMode derived class hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bSupportsAsync bool Whether this movement mode supports being part of an asynchronous movement simulation (running concurrently with the gameplay thread) Specifically for the GenerateMove and SimulationTick functions MovementMode.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category=Mover
GameplayTags FGameplayTagContainer A list of gameplay tags associated with this movement mode MovementMode.h
  • EditDefaultsOnly
  • Category=Mover
SharedSettingsClasses TArray< TSubclassOf< UObject > > Settings object type that this mode depends on. MovementMode.h
  • EditDefaultsOnly
  • Category=Mover
  • Meta=(MustImplement="/Script/Mover.MovementSettingsInterface")
Transitions TArray< TObjectPtr< UBaseMovementModeTransition > > Transition checks for the current mode. MovementMode.h
  • EditAnywhere
  • BlueprintReadOnly
  • Instanced
  • Category=Mover
  • Meta=(FullyExpand=true)

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void Activate()

 These functions are called immediately when the state machine switches modes. MovementMode.h  

virtual void Activate_External()

 These functions are called when the sync state is changed on the game thread and a new mode is activated/deactivated MovementMode.h  

virtual void Deactivate()

   MovementMode.h  

virtual void Deactivate_External()

   MovementMode.h  

void GenerateMove ( const FMoverTickStartData& StartState,
const FMoverTimeStep& TimeStep,
FProposedMove& OutProposedMove
) const

   MovementMode.h
  • BlueprintNativeEvent
  • Meta=(DisplayName="Generate Move", ForceAsFunction)

MoverT * GetMoverComponent ()

 Gets the outer mover component of the indicated type. MovementMode.h  
Gets the outer mover component of the indicated type, checked for validity. MovementMode.h  

virtual UWorld * GetWorld()

   MovementMode.h  

virtual bool HasGameplayTag ( FGameplayTag TagToFind,
bool bExactMatch
) const

 Check Movement Mode for a gameplay tag. MovementMode.h  

UMoverComponent * K2_GetMoverComponent()

 Gets the MoverComponent that owns this movement mode MovementMode.h
  • BlueprintCallable
  • Category=Mover
  • Meta=(DisplayName="Get Mover Component", ScriptName=GetMoverComponent)

virtual void OnRegistered ( const FName ModeName
)

   MovementMode.h  

virtual void OnUnregistered()

   MovementMode.h  

void SimulationTick ( const FSimulationTickParams& Params,
FMoverTickEndData& OutputState
)

   MovementMode.h
  • BlueprintNativeEvent
  • Meta=(DisplayName="Simulation Tick", ForceAsFunction)

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual EDataValidationResult IsDataValid ( FDataValidationContext& Context
) const

   MovementMode.h  

Protected

Name Remarks Include Path Unreal Specifiers

void K2_OnActivated()

   MovementMode.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="On Activated", ScriptName="OnActivated")

void K2_OnDeactivated()

   MovementMode.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="On Deactivated", ScriptName="OnDeactivated")

void K2_OnRegistered ( const FName ModeName
)

   MovementMode.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="On Registered", ScriptName="OnRegistered")

void K2_OnUnregistered()

   MovementMode.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="On Unregistered", ScriptName="OnUnregistered")

virtual void OnActivate()

   MovementMode.h  

virtual void OnDeactivate()

   MovementMode.h  

virtual void OnGenerateMove ( const FMoverTickStartData& StartState,
const FMoverTimeStep& TimeStep,
FProposedMove& OutProposedMove
) const

   MovementMode.h  

virtual void OnSimulationTick ( const FSimulationTickParams& Params,
FMoverTickEndData& OutputState
)

   MovementMode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page