1. Epic GamesDeveloper
  3. UFallingMode

UFallingMode

FallingMode: a default movement mode for moving through the air and jumping, typically influenced by gravity and air control

API > API/Plugins > API/Plugins/Mover

FallingMode: a default movement mode for moving through the air and jumping, typically influenced by gravity and air control

   
Name UFallingMode
Type class
Header File /Engine/Plugins/Experimental/Mover/Source/Mover/Public/DefaultMovementSet/Modes/FallingMode.h
Include Path #include "DefaultMovementSet/Modes/FallingMode.h"

Syntax

UCLASS (MinimalAPI, Blueprintable, BlueprintType)  
class UFallingMode : public UBaseMovementMode

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UFallingMode ( const FObjectInitializer& ObjectInitializer
)

   DefaultMovementSet/Modes/FallingMode.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AirControlPercentage float When falling, amount of movement control available to the actor. 0 = no control, 1 = full control DefaultMovementSet/Modes/FallingMode.h
  • Category=Mover
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(ClampMin="0", ClampMax="1.0")
bCancelVerticalSpeedOnLanding bool If true, actor will land and lose all speed in the vertical direction upon landing. DefaultMovementSet/Modes/FallingMode.h
  • Category=Mover
  • EditAnywhere
  • BlueprintReadWrite
bShouldClampTerminalVerticalSpeed bool When exceeding maximum vertical speed, should it be enforced via a hard clamp? If false, VerticalFallingDeceleration will be used for a smoother transition to the terminal speed limit. DefaultMovementSet/Modes/FallingMode.h
  • Category=Mover
  • EditAnywhere
  • BlueprintReadWrite
FallingDeceleration float Deceleration to apply to air movement when falling slower than terminal velocity. DefaultMovementSet/Modes/FallingMode.h
  • Category=Mover
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(ClampMin="0", ForceUnits="cm/s^2")
FallingLateralFriction float Friction to apply to air movement. DefaultMovementSet/Modes/FallingMode.h
  • Category=Mover
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(ClampMin="0")
OnLanded FMover_OnLanded Broadcast when this actor lands on a valid surface. DefaultMovementSet/Modes/FallingMode.h
  • BlueprintAssignable
  • Category=Mover
OverTerminalSpeedFallingDeceleration float Deceleration to apply to air movement when falling faster than terminal velocity Note: This is NOT applied to vertical velocity, only movement plane velocity DefaultMovementSet/Modes/FallingMode.h
  • Category=Mover
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(ClampMin="0", ForceUnits="cm/s^2")
TerminalMovementPlaneSpeed float If the actor's movement plane velocity is greater than this speed falling will start applying OverTerminalSpeedFallingDeceleration instead of FallingDeceleration The expected behavior is to set OverTerminalSpeedFallingDeceleration higher than FallingDeceleration so the actor will slow down faster when going over TerminalMovementPlaneSpeed. DefaultMovementSet/Modes/FallingMode.h
  • Category=Mover
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(ClampMin="0", ForceUnits="cm/s")
TerminalVerticalSpeed float If the actors vertical velocity is greater than this speed VerticalFallingDeceleration will be applied to vertical velocity DefaultMovementSet/Modes/FallingMode.h
  • Category=Mover
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(ClampMin="0", ForceUnits="cm/s")
VerticalFallingDeceleration float Deceleration to apply to vertical velocity when it's greater than TerminalVerticalSpeed. DefaultMovementSet/Modes/FallingMode.h
  • Category=Mover
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(EditCondition="!bShouldClampTerminalVerticalSpeed", ClampMin="0", ForceUnits="cm/s^2")

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   DefaultMovementSet/Modes/FallingMode.h  

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

   DefaultMovementSet/Modes/FallingMode.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CaptureFinalState ( USceneComponent* UpdatedComponent,
const FMoverDefaultSyncState& StartSyncState,
const FFloorCheckResult& FloorResult,
float DeltaSeconds,
float DeltaSecondsUsed,
const FVector& AngularVelocityDegrees,
FMoverDefaultSyncState& OutputSyncState,
FMoverTickEndData& TickEndData,
FMovementRecord& Record
) const

   DefaultMovementSet/Modes/FallingMode.h  

virtual void ProcessLanded ( const FFloorCheckResult& FloorResult,
FVector& Velocity,
FRelativeBaseInfo& BaseInfo,
FMoverTickEndData& TickEndData
) const

 Is called at the end of the tick in falling mode. DefaultMovementSet/Modes/FallingMode.h
  • BlueprintCallable
  • Category=Mover

Overridden from UBaseMovementMode

Name Remarks Include Path Unreal Specifiers

virtual void OnRegistered ( const FName ModeName
)

   DefaultMovementSet/Modes/FallingMode.h  

virtual void OnUnregistered()

   DefaultMovementSet/Modes/FallingMode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page