Navigation
API > API/Plugins > API/Plugins/Mover
Character Mover Component: this is a specialization of the core Mover Component that is set up with a classic character in mind. Defaults and extended functionality, such as jumping and simple montage replication, are intended to support features similar to UE's ACharacter actor type.
| Name | UCharacterMoverComponent |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Mover/Source/Mover/Public/DefaultMovementSet/CharacterMoverComponent.h |
| Include Path | #include "DefaultMovementSet/CharacterMoverComponent.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Blueprintable, Meta=(BlueprintSpawnableComponent))
class UCharacterMoverComponent : public UMoverComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UMoverComponent → UCharacterMoverComponent
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCharacterMoverComponent() |
DefaultMovementSet/CharacterMoverComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnStanceChanged | FMover_OnStanceChanged | Broadcast when this actor changes stances. | DefaultMovementSet/CharacterMoverComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanActorJump() |
Can this Actor jump? | DefaultMovementSet/CharacterMoverComponent.h |
|
virtual bool CanCrouch() |
Whether this actor can currently crouch or not. | DefaultMovementSet/CharacterMoverComponent.h |
|
virtual void Crouch() |
Perform crouch on actor. | DefaultMovementSet/CharacterMoverComponent.h |
|
bool GetHandleJump() |
Returns whether this component is tasked with handling jump input or not. | DefaultMovementSet/CharacterMoverComponent.h |
|
bool GetHandleStanceChanges() |
Returns whether this component is tasked with handling character stance changes, including crouching. | DefaultMovementSet/CharacterMoverComponent.h |
|
virtual bool IsAirborne() |
Is this actor in a airborne state? (e.g. Flying, Falling) | DefaultMovementSet/CharacterMoverComponent.h |
|
virtual bool IsCrouching() |
Returns true if currently crouching | DefaultMovementSet/CharacterMoverComponent.h |
|
virtual bool IsFalling() |
Is this actor in a falling state? Note that this includes upwards motion induced by jumping. | DefaultMovementSet/CharacterMoverComponent.h |
|
virtual bool IsFlying() |
Returns true if currently flying (moving through a non-fluid volume without resting on the ground) | DefaultMovementSet/CharacterMoverComponent.h |
|
virtual bool IsOnGround() |
Is this actor in a grounded state? (e.g. Walking) | DefaultMovementSet/CharacterMoverComponent.h |
|
virtual bool IsSlopeSliding() |
Is this actor sliding on an unwalkable slope. | DefaultMovementSet/CharacterMoverComponent.h |
|
virtual bool IsSwimming() |
Is this actor in a Swimming state? (e.g. Swimming) | DefaultMovementSet/CharacterMoverComponent.h |
|
virtual bool Jump() |
Perform jump on actor. | DefaultMovementSet/CharacterMoverComponent.h |
|
void SetHandleJump
(
bool bInHandleJump |
If true, this component will handle default character inputs for jumping. | DefaultMovementSet/CharacterMoverComponent.h |
|
void SetHandleStanceChanges
(
bool bInHandleStanceChanges |
If true, this component will process stancing changes and crouching inputs. | DefaultMovementSet/CharacterMoverComponent.h |
|
virtual void UnCrouch() |
Perform uncrouch on actor. | DefaultMovementSet/CharacterMoverComponent.h |
|
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginPlay() |
DefaultMovementSet/CharacterMoverComponent.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnHandlerSettingChanged() |
DefaultMovementSet/CharacterMoverComponent.h | ||
virtual void OnMoverPostFinalize
(
const FMoverSyncState& SyncState, |
DefaultMovementSet/CharacterMoverComponent.h | ||
virtual void OnMoverPreSimulationTick
(
const FMoverTimeStep& TimeStep, |
DefaultMovementSet/CharacterMoverComponent.h | ||
virtual void UpdateSyncedMontageState
(
const FMoverTimeStep& TimeStep, |
DefaultMovementSet/CharacterMoverComponent.h |