Navigation
API > API/Plugins > API/Plugins/Mover
References
| Module | Mover |
| Header | /Engine/Plugins/Experimental/Mover/Source/Mover/Public/MovementModifier.h |
| Include | #include "MovementModifier.h" |
Syntax
USTRUCT (BlueprintType )
struct FMovementModifierGroup
Remarks
A collection of movement modifiers affecting a movable actor.
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< TSharedPtr< FMovementModifierBase > > | ActiveModifiers | Movement modifiers that are currently active in this group | |
| TArray< TSharedPtr< FMovementModifierBase > > | QueuedModifiers | Movement modifiers that are queued to become active next sim frame |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddStructReferencedObjects
(
FReferenceCollector& Collector |
Exposes references to GC system | |
| void | CancelModifierFromHandle
(
const FMovementModifierHandle& HandleToCancel |
||
| void | FlushModifierArrays
(
UMoverComponent* MoverComp, |
Clears out any finished or invalid modifiers and adds any queued modifiers to the active modifiers. | |
| TArray< TSharedPtr< FMovementModifierBase > > | GenerateActiveModifiers
(
UMoverComponent* MoverComp, |
Generates active modifier list (by calling FlushModifierArrays) and returns the an array of all currently active modifiers. | |
| TArray< TSharedPtr< FMovementModifierBase > >::TConstIterator | Const access to active moves | ||
| TArray< TSharedPtr< FMovementModifierBase > >::TConstIterator | Const access to queued moves | ||
| bool | HasAnyMoves () |
||
| void | NetSerialize
(
FArchive& Ar, |
Serialize all modifiers and their states for this group | |
| void | NetSerializeMovementModifierArray
(
FArchive& Ar, |
Helper function for serializing array of movement modifiers | |
| void | QueueMovementModifier
(
TSharedPtr< FMovementModifierBase > Modifier |
||
| FString | Get a simplified string representation of this group. Typically for debugging. |
Operators
| Type | Name | Description | |
|---|---|---|---|
| bool | operator!=
(
const FMovementModifierGroup& Other |
Comparison operator | |
| FMovementModifierGroup & | operator=
(
const FMovementModifierGroup& Other |
Copy operator - deep copy so it can be used for archiving/saving off moves | |
| bool | operator==
(
const FMovementModifierGroup& Other |
Comparison operator - needs matching modifier along with identical states in those structs |