FSubjectInfo Struct Reference

The internal information about a registered subject. More...

#include <SubjectInfo.h>

Public Types
enum	{   InvalidId = 0 , FirstId = 1 , InvalidIndex = -1 , InvalidGeneration = 0 ,   FirstGeneration = 1 , GenerationMax = TNumericLimits<int32>::Max() }

Public Member Functions
bool	IsInIteration () const
	Check if the subject is currently in some iteration. More...
bool	IsValid () const
	Check if this an information of a valid spawned subject. More...
const FFingerprint &	GetFingerprint () const
	Get the fingerprint of the subject. More...
struct FSubjectHandle	GetSubject () const
	Get the subject handle corresponding to this information structure. More...
EApparatusStatus	GetSubject (struct FSubjectHandle &Subject) const
	Get a subject handle from the subject information. More...
TScriptInterface< ISubjective >	GetSubjective () const
	Get the subjective associated with a subject (if any). More...

Friends
struct	FSubjectHandle
class	UChunk
struct	FChunkChain
class	UMachine
class	ISubjective

Detailed Description

The internal information about a registered subject.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
InvalidId	Invalid subject identifier.
FirstId	First valid subject identifier.
InvalidIndex	Invalid subject index.
InvalidGeneration	Invalid subject generation.
FirstGeneration	The first valid generation.
GenerationMax	The maximum valid generation.

Member Function Documentation

GetFingerprint()

const FFingerprint& FSubjectInfo::GetFingerprint ( ) const

inline

Get the fingerprint of the subject.

GetSubject() [1/2]

FSubjectHandle FSubjectInfo::GetSubject ( ) const

inline

Get the subject handle corresponding to this information structure.

Returns

The subject handle.

GetSubject() [2/2]

EApparatusStatus FSubjectInfo::GetSubject ( struct FSubjectHandle &  Subject ) const

inline

Get a subject handle from the subject information.

Parameters

Subject

The subject handle to initialize.

Returns

The status of the operation.

GetSubjective()

TScriptInterface<ISubjective> FSubjectInfo::GetSubjective ( ) const

inline

Get the subjective associated with a subject (if any).

IsInIteration()

bool FSubjectInfo::IsInIteration ( ) const

inline

Check if the subject is currently in some iteration.

IsValid()

bool FSubjectInfo::IsValid ( ) const

inline

Check if this an information of a valid spawned subject.

Friends And Related Function Documentation

FChunkChain

friend struct FChunkChain

friend

FSubjectHandle

friend struct FSubjectHandle

friend

ISubjective

friend class ISubjective

friend

UChunk

friend class UChunk

friend

UMachine

friend class UMachine

friend

---

The documentation for this struct was generated from the following files:

• D:/ApparatusMark/Plugins/Apparatus/Source/ApparatusRuntime/Public/SubjectInfo.h
• D:/ApparatusMark/Plugins/Apparatus/Source/ApparatusRuntime/Public/SubjectHandle.h