FFieldSystemCommand | Unreal Engine 5.1 Documentation

API > API/Runtime > API/Runtime/Chaos > API/Runtime/Chaos/Field

References


Module	Chaos
Header	/Engine/Source/Runtime/Experimental/Chaos/Public/Field/FieldSystem.h
Include	#include "Field/FieldSystem.h"

Syntax

class FFieldSystemCommand

Remarks

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.

Variables

	Type	Name	Description
	FBox	BoundingBox
	FVector	CenterPosition
	FName	CommandName
	float	MaxMagnitude
	TMap< FFieldSystemMetaData::EMetaType, TUniquePtr< FFieldSystemMetaData > >	MetaData
	EFieldPhysicsType	PhysicsType
	TUniquePtr< FFieldNodeBase >	RootNode
	FName	TargetAttribute
	float	TimeCreation

Constructors

	Type	Name	Description
		FFieldSystemCommand ()
		FFieldSystemCommand ( const FFieldSystemCommand& Other )	Commands are copied when moved from the one thread to another.
		FFieldSystemCommand ( const FName& TargetAttributeIn, FFieldNodeBase* RootNodeIn )	Forward declaration of concrete types // Macro version - declares all three variants.
		FFieldSystemCommand ( const EFieldPhysicsType PhsyicsTypeIn, FFieldNodeBase* RootNodeIn )	Forward declaration of concrete types // Macro version - declares all three variants.

Functions

	Type	Name	Description
	const TUniquePtr< FFieldSystemMetaData > &	GetMetaData ( const FFieldSystemMetaData::EMetaType Key )
	const TMetaData *	GetMetaDataAs ( const FFieldSystemMetaData::EMetaType Key )
	bool	HasMetaData ( const FFieldSystemMetaData::EMetaType Key )
	void	InitFieldNodes ( const double TimeSeconds, const FName& Name )
	void	Serialize ( FArchive& Ar )
	void	SetMetaData ( const FFieldSystemMetaData::EMetaType Key, TUniquePtr< FFieldSystemMetaData >&& Value )
	void	SetMetaData ( const FFieldSystemMetaData::EMetaType Key, FFieldSystemMetaData* Value )

Operators

	Type	Name	Description
	bool	operator!= ( const FFieldSystemCommand& Other )
	bool	operator== ( const FFieldSystemCommand& )

Navigation