Navigation
API > API/Plugins > API/Plugins/Mover
Wrapper class that's used to add User-Defined Struct instances to Mover Data Collections (input or state). This allows devs to add custom data to inputs and/or state without requiring native code. Note that these are typically less efficient than natively-defined structs, and the logic of operations like interpolation, merging, and serialization may be simplistic for a project's needs. At present:
- any differences between any struct contents will trigger reconciliation, even small floating point number differences
- only boolean values can be merged
- interpolation will take the entire struct instance from the highest weight frame
| Name | FMoverUserDefinedDataStruct |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/Mover/Source/Mover/Public/UserDefinedStructSupport.h |
| Include Path | #include "UserDefinedStructSupport.h" |
Syntax
USTRUCT ()
struct FMoverUserDefinedDataStruct : public FMoverDataStructBase
Inheritance Hierarchy
- FMoverDataStructBase → FMoverUserDefinedDataStruct
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| StructInstance | FInstancedStruct | UserDefinedStructSupport.h |
Functions
Public
Overridden from FMoverDataStructBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FMoverDataStructBase * Clone () |
Return newly allocated copy of this FMoverDataStructBase. | UserDefinedStructSupport.h | |
virtual const UScriptStruct * GetDataScriptStruct() |
This returns the User-Defined Struct type. | UserDefinedStructSupport.h | |
virtual UScriptStruct * GetScriptStruct() |
Note: this is the FMoverUserDefinedDataStruct type, NOT the User-Defined Struct type. | UserDefinedStructSupport.h | |
virtual void Interpolate
(
const FMoverDataStructBase& From, |
Interpolates contained data between a starting and ending block. | UserDefinedStructSupport.h | |
virtual void Merge
(
const FMoverDataStructBase& From |
Merges contained data from a previous frame with that of the current frame. | UserDefinedStructSupport.h | |
virtual bool NetSerialize
(
FArchive& Ar, |
UserDefinedStructSupport.h | ||
virtual bool ShouldReconcile
(
const FMoverDataStructBase& AuthorityState |
Implementation of FMoverDataStructBase. | UserDefinedStructSupport.h | |
virtual void ToString
(
FAnsiStringBuilderBase& Out |
Get string representation of this struct instance | UserDefinedStructSupport.h |