Navigation
API > API/Runtime > API/Runtime/Chaos
FieldCommand
Field commands are issued on the game thread and trigger field evaluation during game play. The Commands will store the root node in the evaluation graph, and will trigger a full evaluation of all the nodes in the graph. The MetaData within the command will be passed to the evaluation of the field.
| Name | FFieldSystemCommand |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Field/FieldSystem.h |
| Include Path | #include "Field/FieldSystem.h" |
Syntax
class FFieldSystemCommand
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Field/FieldSystem.h | |||
FFieldSystemCommand
(
const FFieldSystemCommand& Other |
Commands are copied when moved from the one thread to another. | Field/FieldSystem.h | |
FFieldSystemCommand
(
const FName& TargetAttributeIn, |
Field/FieldSystem.h | ||
FFieldSystemCommand
(
const EFieldPhysicsType PhsyicsTypeIn, |
Field/FieldSystem.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BoundingBox | FBox | Field/FieldSystem.h | ||
| CenterPosition | FVector | Field/FieldSystem.h | ||
| CommandName | FName | Field/FieldSystem.h | ||
| MaxMagnitude | float | Field/FieldSystem.h | ||
| MetaData | TMap< FFieldSystemMetaData::EMetaType, TUniquePtr< FFieldSystemMetaData > > | Field/FieldSystem.h | ||
| PhysicsType | EFieldPhysicsType | Field/FieldSystem.h | ||
| RootNode | TUniquePtr< FFieldNodeBase > | Field/FieldSystem.h | ||
| TargetAttribute | FName | Field/FieldSystem.h | ||
| TimeCreation | float | Field/FieldSystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const TUniquePtr< FFieldSystemMetaData > & GetMetaData
(
const FFieldSystemMetaData::EMetaType Key |
Field/FieldSystem.h | ||
const TMetaData * GetMetaDataAs
(
const FFieldSystemMetaData::EMetaType Key |
Field/FieldSystem.h | ||
bool HasMetaData
(
const FFieldSystemMetaData::EMetaType Key |
Field/FieldSystem.h | ||
void InitFieldNodes
(
const double TimeSeconds, |
Field/FieldSystem.h | ||
void Serialize
(
FArchive& Ar |
Field/FieldSystem.h | ||
void SetMetaData
(
const FFieldSystemMetaData::EMetaType Key, |
Field/FieldSystem.h | ||
void SetMetaData
(
const FFieldSystemMetaData::EMetaType Key, |
Field/FieldSystem.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FFieldSystemCommand& Other |
Field/FieldSystem.h | ||
bool operator==
(
const FFieldSystemCommand& |
Field/FieldSystem.h |