1. Epic GamesDeveloper
  3. UMoverComponent

UMoverComponent

API > API/Plugins > API/Plugins/Mover

Inheritance Hierarchy

References

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

Syntax

UCLASS (BlueprintType, Meta=(BlueprintSpawnableComponent))  
class UMoverComponent : public UActorComponent

Variables

  Type Name Description
Public variable UProperty Category, EditDefaultsOnly, Meta TSubclassOf< UActorComponent > BackendClass Specifies which supporting back end class should drive this Mover actor.
Protected variable TWeakInterfacePtr< IMoverBackendLiaisonInterface > BackendLiaisonComp  
Protected variable FMoverDynamicBasedMovementTickFunction BasedMovementTickFunction Tick function that may be called anytime after this actor's movement step, useful as a way to support based movement on objects that are not
Protected variable FTransform BaseVisualComponentTransform Cached original offset from the visual component, used for cases where we want to move the visual component away from the root component (for smoothing, corrections, etc.)
Protected variable bool bHasValidCachedState  
Protected variable bool bHasValidCachedUsedInput  
Protected variable bool bHasValidLastProducedInput  
Protected variable FMoverAuxStateContext CachedLastAuxState  
Protected variable FMoverInputCmdContext CachedLastProducedInputCmd  
Protected variable FMoverTimeStep CachedLastSimTickTimeStep  
Protected variable FMoverSyncState CachedLastSyncState  
Protected variable FMoverInputCmdContext CachedLastUsedInputCmd  
Protected variable FMoverTimeStep CachedNewestSimTickTimeStep  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TObjectPtr< UObject > InputProducer Optional object for producing input cmds.
Protected variable TObjectPtr< UPrimitiveComponent > MovementBaseDependency  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< UMovementMixer > MovementMixer Optional object for mixing proposed moves.Typically set at BeginPlay time.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly instanced TMap< FName, TObjectPtr< UBaseMovementMode > > MovementModes  
Public variable UProperty Category BlueprintAssignable FMover_OnMovementModeChanged OnMovementModeChanged Broadcast when a MovementMode has changed. Happens during a simulation tick if the mode changed that tick or when SetModeImmediately is used to change modes.
Public variable UProperty FMover_OnPostMovement OnPostMovement Broadcast at the end of a simulation tick after movement has occurred, but allowing additions/modifications to the state. Not assignable as a BP event due to it having mutable parameters.
Public variable UProperty Category BlueprintAssignable FMover_OnPostSimRollback OnPostSimulationRollback Broadcast when a rollback has occurred, just before the next simulation tick occurs.
Public variable UProperty Category BlueprintAssignable FMover_OnPostSimTick OnPostSimulationTick Broadcast after each simulation tick and the state is finalized.
Public variable UProperty Category BlueprintAssignable FMover_OnPreSimTick OnPreSimulationTick Broadcast before each simulation tick.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FMoverDataPersistence > PersistentSyncStateDataTypes List of types that should always be present in this actor's sync state
Protected variable UProperty Transient TObjectPtr< USceneComponent > PrimaryVisualComponent The main visual component associated with this Mover actor, typically a mesh and typically parented to the UpdatedComponent.
Public variable FMover_ProcessGeneratedMovement ProcessGeneratedMovement Broadcast after proposed movement has been generated.
Public variable FOnWarpLocalspaceRootMotionWithContext ProcessLocalRootMotionDelegate Delegates used when converting local root motion to worldspace, allowing external systems to influence it (such as motion warping)
Public variable FOnWarpWorldspaceRootMotionWithContext ProcessWorldRootMotionDelegate  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EMoverSmoothingMode SmoothingMode If enabled, the movement of the primary visual component will be smoothed via an offset from the root moving component. This is useful in fixed-tick simulations with variable rendering rates.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FName StartingMovementMode Name of the first mode to start in when simulation begins. Must have a mapping in MovementModes. Only used during initialization.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite instanced TArray< TObjectPtr< UBaseMovementModeTransition > > Transitions Transition checks that are always evaluated regardless of mode. Evaluated in order, stopping at the first successful transition check. Mode-owned transitions take precedence. */.
Protected variable UProperty Transient TObjectPtr< UPrimitiveComponent > UpdatedCompAsPrimitive UpdatedComponent, cast as a UPrimitiveComponent.
Protected variable UProperty Transient TObjectPtr< USceneComponent > UpdatedComponent This is the component that's actually being moved.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta UBaseMovementMode * Add a movement mode to available movement modes. Returns true if the movement mode was added successfully. Returns the mode that was made.
Public function UFunction BlueprintCallable, Category bool

AddMovementModeFromObject ( FName ModeName,
UBaseMovementMode* MovementMode
)

 Add a movement mode to available movement modes. Returns true if the movement mode was added successfully.
Public function UFunction BlueprintCallable, Category void Binds event for processing movement after it has been generated. Allows for final modifications to proposed movement before it's executed.
Public function UFunction BlueprintCallable, Category void Cancel any active or queued Modifiers with the handle passed in.
Public function Virtual Const FTransform

ConvertLocalRootMotionToWorld ( const FTransform& LocalRootMotionTransform,
float DeltaSeconds,
const FTransform* AlternateActorToWorld,
const FMotionWarpingUpdateContext* OptionalWarpingContext
)

 Converts a local root motion transform to worldspace.
Public function void

FinalizeFrame ( const FMoverSyncState* SyncState,
const FMoverAuxStateContext* AuxState
)

 Take output for simulation. Called by backend system.
Public function void

FinalizeSmoothingFrame ( const FMoverSyncState* SyncState,
const FMoverAuxStateContext* AuxState
)

 Take smoothed simulation state. Called by backend system, if supported.
Public function Const const FLayeredMoveBase *

FindActiveLayeredMoveByType ( const UScriptStruct* DataStructType
)

 Find an active layered move by type. Returns null if one wasn't found.
Public function Const const T * Find a layered move of a specific type in this components active layered moves.
Protected function void  
Public function Const UBaseMovementMode *

FindMode_Mutable ( const UClass* ByType,
bool bRequireExactClass
)

 Find movement mode by type. Returns null if there is none of that type
Public function Const T *

FindMode_Mutable ( bool bRequireExactClass
)

  
Public function Const UFunction BlueprintPure, Category, Meta UBaseMovementMode *  
Public function Const const FMovementModifierBase *

FindMovementModifier ( const FMovementModifierHandle& ModifierHandle
)

 Find movement modifier by it's handle. Returns nullptr if the modifier couldn't be found.
Public function Const const FMovementModifierBase *

FindMovementModifierByType ( const UScriptStruct* DataStructType
)

 Find movement modifier by type (returns the first modifier it finds). Returns nullptr if the modifier couldn't be found.
Public function Const const T * Find a movement modifier of a specific type in this components movement modifiers.
Public function Const const IMovementSettingsInterface *

FindSharedSettings ( const UClass* ByType
)

 Find settings object by type. Returns null if there is none of that type
Public function Const const T *  
Public function Const UFunction BlueprintPure, Category, Meta const UObject * Find settings object by type. Returns null if there is none of that type
Public function Const T *  
Public function Const IMovementSettingsInterface * Find mutable settings object by type. Returns null if there is none of that type
Public function Const UFunction BlueprintPure, Category, Meta UObject * Find mutable settings object by type. Returns null if there is none of that type
Public function UFunction BlueprintCallable, BlueprintPure, Category TArray< FTrajectorySampleInfo >

GetFutureTrajectory ( float FutureSeconds,
float SamplesPerSecond
)

 Get a sampling of where the actor is projected to be in the future, based on a current state.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category FVector Get the current acceleration due to gravity (cm/s^2) in worldspace.
Public function Const UFunction BlueprintPure, Category const FMoverInputCmdContext & Access the most recently-used inputs. Check @HasValidCachedInputCmd first.
Public function Const UFunction BlueprintPure, Category const FMoverTimeStep & Get the most recent TimeStep.
Public function Const UFunction BlueprintPure, Category UPrimitiveComponent * Get the current movement base. Null if there isn't one.
Public function Const UFunction BlueprintPure, Category FName Get the current movement base bone, NAME_None if there isn't one.
Public function Const UFunction BlueprintPure, Category FVector Get the intended movement direction in worldspace with magnitude (range 0-1)
Public function Const UFunction BlueprintPure, Category const UBaseMovementMode * Get the current movement mode.
Public function Const UFunction BlueprintPure, Category FName Get the current movement mode name.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category const FPlanarConstraint & Access the planar constraint that may be limiting movement direction.
Public function UFunction BlueprintCallable, BlueprintPure, Category TArray< FTrajectorySampleInfo > Get a sampling of where the actor is projected to be in the future, based on a current state.
Public function Const T * Typed accessor to primary visual component.
Public function Const USceneComponent * Access the primary visual component of the actor.
Public function Const UFunction BlueprintPure, Category const UMoverBlackboard * Access the read-only version of the Mover's Blackboard.
Public function Const UMoverBlackboard *  
Protected function UFunction TArray< FString >  
Public function Const UFunction BlueprintPure, Category const FMoverSyncState & Access the most recent captured sync state. Check @HasValidCachedState first.
Public function Const UFunction BlueprintPure, Category FRotator Get the orientation that the actor is moving towards.
Public function Const USceneComponent * Access the root component of the actor that our Mover simulation is moving.
Public function Const T * Typed accessor to root moving component.
Public function Const FTransform Get the transform of the root component that our Mover simulation is moving.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category FVector Get the normalized direction considered "up" in worldspace. Typically aligned with gravity, and typically determines the plane an actor tries to move along.
Public function Const UFunction BlueprintPure, Category FVector Get the current velocity (units per second, worldspace)
Public function UFunction BlueprintCallable, Category void Handle a blocking impact.
Public function Const UFunction BlueprintPure, Category, Meta bool

HasGameplayTag ( FGameplayTag TagToFind,
bool bExactMatch
)

 Check Mover systems for a gameplay tag.
Public function Const UFunction BlueprintPure, Category bool Signals whether we have input data saved yet. If not, input queries will not be meaningful.
Public function Const UFunction BlueprintPure, Category bool Signals whether we have a sync state saved yet. If not, most queries will not be meaningful.
Public function void Seed initial values based on component's state. Called by backend system.
Public function bool  
Public function Const UFunction BlueprintPure, Category bool Checks if the modifier handle passed in is active or queued on this mover component.
Public function Const UFunction BlueprintCallable, Category, Meta customthunk void

K2_FindActiveLayeredMove ( bool& DidSucceed,
int32& TargetAsRawBytes
)

 Retrieves an active layered move, by writing to a target instance if it is the matching type.
Public function Const UFunction BlueprintCallable, Category, Meta customthunk void

K2_FindMovementModifier ( FMovementModifierHandle ModifierHandle,
bool& bFoundModifier,
int32& TargetAsRawBytes
)

 Retrieves Movement modifier by writing to a target instance if it is the matching type.
Public function UFunction BlueprintCallable, Category, Meta customthunk void

K2_QueueInstantMovementEffect ( const int32& EffectAsRawData
)

 Queue a Instant Movement Effect to start at the end of this frame or start of the next subtick - whichever happens first.
Public function UFunction BlueprintCallable, Category, Meta customthunk void

K2_QueueLayeredMove ( const int32& MoveAsRawData
)

 Queue a layered move to start during the next simulation frame.
Public function UFunction BlueprintCallable, Category, Meta customthunk FMovementModifierHandle

K2_QueueMovementModifier ( const int32& MoveAsRawData
)

 Queue a Movement Modifier to start during the next simulation frame.
Public function Virtual UFunction void

OnBeginOverlap ( UPrimitiveComponent* OverlappedComp,
AActor* Other,
UPrimitiveComponent* OtherComp,
int32 OtherBodyIndex,
bool bFromSweep,
const FHitResult& SweepResult
)

 Callbacks.
Protected function Virtual void

OnHandleImpact ( const FMoverOnImpactParams& ImpactParams
)

  
Protected function void

OnSimulationPreRollback ( const FMoverSyncState* InvalidSyncState,
const FMoverSyncState* SyncState,
const FMoverAuxStateContext* InvalidAuxState,
const FMoverAuxStateContext* AuxState
)

 Called when a rollback occurs, before the simulation state has been restored
Protected function void

OnSimulationRollback ( const FMoverSyncState* SyncState,
const FMoverAuxStateContext* AuxState
)

 Called when a rollback occurs, after the simulation state has been restored
Protected function Virtual UFunction void  
Protected function void  
Public function void

ProduceInput ( const int32 DeltaTimeMS,
FMoverInputCmdContext* Cmd
)

 Get latest local input prior to simulation step. Called by backend system on owner's instance (autonomous or authority).
Public function void Queue a Instant Movement Effect to take place at the end of this frame or start of the next subtick - whichever happens first.
Public function void Queue a layered move to start during the next simulation frame.
Public function FMovementModifierHandle Queue a Movement Modifier to start during the next simulation frame.
Public function UFunction BlueprintCallable, Category displayname void

QueueNextMode ( FName DesiredModeName,
bool bShouldReenter
)

 Queue a movement mode change to occur during the next simulation frame. If bShouldReenter is true, then a mode change will occur even if already in that mode.
Protected function void Internal function to ensure SharedSettings array matches what's needed by the list of Movement Modes
Public function UFunction BlueprintCallable, Category bool

RemoveMovementMode ( FName ModeName
)

 Removes a movement mode from available movement modes. Returns number of modes removed from the available movement modes.
Public function void

RestoreFrame ( const FMoverSyncState* SyncState,
const FMoverAuxStateContext* AuxState
)

 Restore a previous frame prior to resimulating. Called by backend system.
Protected function void

SetFrameStateFromContext ( const FMoverSyncState* SyncState,
const FMoverAuxStateContext* AuxState,
bool bRebaseBasedState
)

 Makes this component and owner actor reflect the state of a particular frame snapshot.
Public function UFunction BlueprintCallable, Category void

SetGravityOverride ( bool bOverrideGravity,
FVector GravityAcceleration
)

 Set gravity override, as a directional acceleration in worldspace. Gravity on Earth would be {x=0,y=0,z=-980}.
Public function UFunction BlueprintCallable, Category void

SetPlanarConstraint ( const FPlanarConstraint& InConstraint
)

 Sets planar constraint that can limit movement direction.
Public function UFunction BlueprintCallable, Category void Sets this Mover actor's primary visual component. Must be a descendant of the updated component that acts as our movement root.
Protected function void

SetUpdatedComponent ( USceneComponent* NewUpdatedComponent
)

 Basic "Update Component/Ticking".
Public function void

SimulationTick ( const FMoverTimeStep& InTimeStep,
const FMoverTickStartData& SimInput,
OUTFMoverTickEndData& SimOutput
)

 Primary movement simulation update. Given an starting state and timestep, produce a new state. Called by backend system.
Public function void

TickInterpolatedSimProxy ( const FMoverTimeStep& TimeStep,
const FMoverInputCmdContext& InputCmd,
UMoverComponent* MoverComp,
const FMoverSyncState& CachedSyncState,
const FMoverSyncState& SyncState,
const FMoverAuxStateContext& AuxState
)

 This is an opportunity to run code on the code on the simproxy in interpolated mode - currently used to help activate and deactivate modifiers on the simproxy in interpolated mode.
Public function Const UFunction BlueprintPure, Category bool Access the most recent floor check hit result.
Public function UFunction BlueprintCallable, Category void Clears current bound event for processing movement after it has been generated.
Protected function void Internal function to perform post-sim scheduling to optionally support simple based movement
Protected function void  
Protected function Const bool

ValidateSetup ( FDataValidationContext& ValidationErrors
)

  

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Begins Play for the component.
Public function Virtual void Initializes the component.
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void

RegisterComponentTickFunctions ( bool bRegister
)

 Virtual call chain to register all tick functions
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.
Public function Virtual void Handle this component being Uninitialized.

Overridden from UObject

  Type Name Description
Protected function Virtual Const EDataValidationResult Generic function to validate objects during changelist validations, etc.
Protected function Virtual void Called after the Blueprint compiler has finished generating the Class Default Object (CDO) for a class.
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Protected function Virtual void

PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

 Called after the object has been transacted in some way.
Protected function Virtual void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

 Presave function.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page