FFieldSystemCommand

FieldCommand

Windows
MacOS
Linux

References

Module

FieldSystemCore

Header

/Engine/Source/Runtime/Experimental/FieldSystem/Source/FieldSystemCore/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

Name Description

Public variable

TMap< FFieldSys...

 

MetaData

Public variable

TUniquePtr< FFi...

 

RootNode

Public variable

FName

 

TargetAttribute

Constructors

Name Description

Public function

FFieldSystemCommand()

Public function

FFieldSystemCommand

(
    const FFieldSystemCommand& Other
)

Commands are copied when moved from the one thread to another.

Public function

FFieldSystemCommand

(
    FName TargetAttributeIn,
    FFieldNodeBase* RootNodeIn
)

Functions

Name Description

Public function Const

const TUniqu...

 

GetMetaData

(
    const FFieldSystemMetaData::EMetaTy...
)

Public function Const

const TMetaD...

 

GetMetaDataAs

(
    const FFieldSystemMetaData::EMetaTy...
)

Public function Const

bool

 

HasMetaData

(
    const FFieldSystemMetaData::EMetaTy...
)

Public function

void

 

Serialize

(
    FArchive& Ar
)

Public function

void

 

SetMetaData

Public function

void

 

SetMetaData

(
    const FFieldSystemMetaData::EMetaTy...,
    FFieldSystemMetaData* Value
)

Operators

Name Description

Public function

bool

 

operator!=

(
    const FFieldSystemCommand& Other
)

Public function

bool

 

operator==

(
    const FFieldSystemCommand&
)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss