An interface for all sorts of subjects. More...

#include <Subjective.h>

Inheritance diagram for ISubjective:

[legend]

Collaboration diagram for ISubjective:

Public Types
enum	{ InvalidSlotIndex = FBeltSlot::InvalidIndex }

Public Member Functions
const FFingerprint &	GetFingerprint () const
	Get the active fingerprint of the subjective. More...

bool	Matches (const FFilter &InFilter) const
	Check if the subjective matches a supplied filter. More...

bool	Matches (const FTraitmark &InTraitmark) const
	Check if the subjective matches a supplied traitmark as a filter. More...

bool	Matches (const FDetailmark &InDetailmark) const
	Check if the subjective matches a supplied detailmark as a filter. More...

void	GetDetails (const bool bIncludeDisabled, TArray< UDetail * > &OutDetails) const
	Get the details of the subjective. More...

UDetail *	FindDetail (TSubclassOf< UDetail > DetailClass, const bool bIncludeDisabled=false) const
	Find the detail by a type. More...

void	FindDetails (TSubclassOf< UDetail > DetailClass, TArray< UDetail * > &OutDetails, const bool bIncludeDisabled=false) const
	Find the details by their type. More...

bool	HasDetail (TSubclassOf< UDetail > DetailClass, const bool bIncludeDisabled=false) const
	Check if there is a detail of a specific class in the subjective. More...

template<typename T >
bool	HasDetail (const bool bIncludeDisabled=false) const
	Check if there is a detail of a specific class in the subjective. More...

bool	HasTrait (UScriptStruct *const TraitType) const
	Check if the subjective has a certain trait. More...

template<typename T >
bool	HasTrait () const
	Check if there is a trait of a specific type in the subjective. More...

EApparatusStatus	SetTrait (UScriptStruct TraitType, const void const TraitData)
	Set a trait of the subjective by its type. More...

template<typename T >
EApparatusStatus	SetTrait (const T &Trait)
	Set a trait of the subjective. More...

EApparatusStatus	GetTrait (UScriptStruct TraitType, void const TraitData, const bool bTraitDataInitialized=true) const
	Get a trait from a subjective by its type. More...

template<typename T >
EApparatusStatus	GetTrait (T &OutTrait, const bool bTraitDataInitialized=true) const
	Get a trait from a subjective by its type. More...

EApparatusStatus	ObtainTrait (UScriptStruct TraitType, void const OutTraitData, const bool bTraitDataInitialized=true)
	Obtain a trait from a subjective by its type. More...

template<typename T >
EApparatusStatus	ObtainTrait (T &OutTrait, const bool bTraitDataInitialized=true)
	Obtain a trait from a subjective. More...

EApparatusStatus	RemoveTrait (UScriptStruct *TraitType)
	Remove a trait from the subjective. More...

template<typename T >
EApparatusStatus	RemoveTrait ()
	Remove a trait from the subjective. More...

virtual class UBelt *	GetPreferredBelt () const
	Get the preferred belt of the subjective (if any). More...

class UDetail *	EnableDetail (TSubclassOf< UDetail > DetailClass)
	Enable a detail of a certain type. More...

class UDetail *	AddDetail (TSubclassOf< UDetail > DetailClass, const bool bReuseDisabled=false)
	Add a new active detail or reuse an inactive one. More...

EApparatusStatus	DisableDetail (TSubclassOf< UDetail > DetailClass, const bool bDisableMultiple=false)
	Disable a certain detail(s) by type. More...

const struct FBeltSlot *	GetSlot () const
	Get the current belt slot of the subjective (if any). More...

bool	IsRegistered () const
	Check if the subjective is registered within the machine. More...

int32	GetSlotIndex () const
	Get the current slot index of the subjective. More...

bool	IsBooted () const
	Check if the subject is booted. More...

FSubjectHandle &	GetHandle ()
	Get the subject handle of this subjective. More...

const FSubjectHandle &	GetHandle () const
	Get the subject handle of this subjective. More...

virtual uint32	GetHash () const
	Get the hash of the subjective. More...

Protected Member Functions
void	MarkBooted ()
	Set the subjective as booted. More...

void	TakeBeltSlot (class UBelt *InBelt, int32 InSlotIndex)
	Set the current belt slot of the subjective (if any). More...

UBelt *	GetBelt () const
	Get the active belt of the subjective (if any). More...

virtual TArray< UDetail * > &	GetDetailsRef ()
	Direct access for the internal details array. More...

virtual const TArray< UDetail * > &	GetDetailsRef () const
	Direct access for the internal details array. More...

FFingerprint &	GetFingerprintRef ()
	Get the internal fingerprint of the subjective. More...

struct FBeltSlot *	GetSlotPtr ()
	Get the current belt slot of the subjective (if any). More...

Protected Attributes
TWeakObjectPtr< UBelt >	Belt = nullptr
	A weak reference to a current subjective's belt (if any). More...

int32	SlotIndex = FBeltSlot::InvalidIndex
	The index of the belt slot, this subject currently resides in. More...

FSubjectHandle	Handle
	The subject handle which points to a global subjects registry. More...

Friends
struct	FFingerprint

struct	FBeltSlot

struct	FBeltSlotCache

class	UDetail

class	UBelt

class	UMachine

class	UApparatusFunctionLibrary

Detailed Description

An interface for all sorts of subjects.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
InvalidSlotIndex	Invalid belt slot index.

Member Function Documentation

◆ AddDetail()

UDetail * ISubjective::AddDetail	(	TSubclassOf< UDetail >	DetailClass,
		const bool	bReuseDisabled = `false`
	)

inline

Add a new active detail or reuse an inactive one.

◆ DisableDetail()

EApparatusStatus ISubjective::DisableDetail	(	TSubclassOf< UDetail >	DetailClass,
		const bool	bDisableMultiple = `false`
	)

inline

Disable a certain detail(s) by type.

You can't remove details, but only disable them.

◆ EnableDetail()

UDetail * ISubjective::EnableDetail ( TSubclassOf< UDetail > DetailClass )

inline

Enable a detail of a certain type.

Add it if there is none already, or reuse an inactive one.

◆ FindDetail()

UDetail * ISubjective::FindDetail	(	TSubclassOf< UDetail >	DetailClass,
		const bool	bIncludeDisabled = `false`
	)		const

inline

Find the detail by a type.

◆ FindDetails()

void ISubjective::FindDetails	(	TSubclassOf< UDetail >	DetailClass,
		TArray< UDetail * > &	OutDetails,
		const bool	bIncludeDisabled = `false`
	)		const

inline

Find the details by their type.

Supports searching by a base type.

◆ GetBelt()

UBelt* ISubjective::GetBelt ( ) const

inlineprotected

Get the active belt of the subjective (if any).

◆ GetDetails()

void ISubjective::GetDetails	(	const bool	bIncludeDisabled,
		TArray< UDetail * > &	OutDetails
	)		const

inline

Get the details of the subjective.

◆ GetDetailsRef() [1/2]

virtual TArray<UDetail*>& ISubjective::GetDetailsRef ( )

inlineprotectedvirtual

Direct access for the internal details array.

Reimplemented in USubjectiveUserWidget, USubjectiveActorComponent, and ASubjectiveActor.

◆ GetDetailsRef() [2/2]

virtual const TArray<UDetail*>& ISubjective::GetDetailsRef ( ) const

inlineprotectedvirtual

Direct access for the internal details array.

Constant version.

Reimplemented in USubjectiveUserWidget, USubjectiveActorComponent, and ASubjectiveActor.

◆ GetFingerprint()

const FFingerprint& ISubjective::GetFingerprint ( ) const

inline

Get the active fingerprint of the subjective.

Constant version.

◆ GetFingerprintRef()

FFingerprint& ISubjective::GetFingerprintRef ( )

inlineprotected

Get the internal fingerprint of the subjective.

◆ GetHandle() [1/2]

FSubjectHandle& ISubjective::GetHandle ( )

inline

Get the subject handle of this subjective.

◆ GetHandle() [2/2]

const FSubjectHandle& ISubjective::GetHandle ( ) const

inline

Get the subject handle of this subjective.

Constant version.

◆ GetHash()

virtual uint32 ISubjective::GetHash ( ) const

inlinevirtual

Get the hash of the subjective.

◆ GetPreferredBelt()

virtual class UBelt* ISubjective::GetPreferredBelt ( ) const

inlinevirtual

Get the preferred belt of the subjective (if any).

Reimplemented in USubjectiveUserWidget, USubjectiveActorComponent, and ASubjectiveActor.

◆ GetSlot()

const struct FBeltSlot * ISubjective::GetSlot ( ) const

inline

Get the current belt slot of the subjective (if any).

Constant version.

Returns: The active belt slot of the subject or nullptr, if the subject is not (yet) part of any belt.

◆ GetSlotIndex()

int32 ISubjective::GetSlotIndex ( ) const

inline

Get the current slot index of the subjective.

◆ GetSlotPtr()

struct FBeltSlot * ISubjective::GetSlotPtr ( )

inlineprotected

Get the current belt slot of the subjective (if any).

Returns: The active belt slot of the subject or nullptr, if the subject is not (yet) part of any belt.

◆ GetTrait() [1/2]

template<typename T >

EApparatusStatus ISubjective::GetTrait	(	T &	OutTrait,
		const bool	bTraitDataInitialized = `true`
	)		const

inline

Get a trait from a subjective by its type.

Templated version.

Template Parameters

T	The type of the trait to get.

Parameters

OutTrait	The trait receiver.
bTraitDataInitialized	Is the `OutTrait` actually initialized?

Returns: The status of the operation.

◆ GetTrait() [2/2]

EApparatusStatus ISubjective::GetTrait	(	UScriptStruct *	TraitType,
		void *const	TraitData,
		const bool	bTraitDataInitialized = `true`
	)		const

inline

Get a trait from a subjective by its type.

Parameters

TraitType	The type of the trait to get.
TraitData	The trait data receiver.
bTraitDataInitialized	Is the `TraitData` buffer actually initialized?

Returns: The status of the operation.

◆ HasDetail() [1/2]

template<typename T >

bool ISubjective::HasDetail ( const bool bIncludeDisabled = false ) const

inline

Check if there is a detail of a specific class in the subjective.

Templated version.

Supports examining by a base type.

◆ HasDetail() [2/2]

bool ISubjective::HasDetail	(	TSubclassOf< UDetail >	DetailClass,
		const bool	bIncludeDisabled = `false`
	)		const

inline

Check if there is a detail of a specific class in the subjective.

Supports examining by a base type.

◆ HasTrait() [1/2]

template<typename T >

bool ISubjective::HasTrait ( ) const

inline

Check if there is a trait of a specific type in the subjective.

Templated version.

◆ HasTrait() [2/2]

bool ISubjective::HasTrait ( UScriptStruct *const TraitType ) const

inline

Check if the subjective has a certain trait.

◆ IsBooted()

bool ISubjective::IsBooted ( ) const

inline

Check if the subject is booted.

The subject must be booted (initialized) by the booting mechanics prior to being processed by the ticking mechanics.

◆ IsRegistered()

bool ISubjective::IsRegistered ( ) const

inline

Check if the subjective is registered within the machine.

◆ MarkBooted()

void ISubjective::MarkBooted ( )

inlineprotected

Set the subjective as booted.

◆ Matches() [1/3]

bool ISubjective::Matches ( const FDetailmark & InDetailmark ) const

inline

Check if the subjective matches a supplied detailmark as a filter.

◆ Matches() [2/3]

bool ISubjective::Matches ( const FFilter & InFilter ) const

inline

Check if the subjective matches a supplied filter.

◆ Matches() [3/3]

bool ISubjective::Matches ( const FTraitmark & InTraitmark ) const

inline

Check if the subjective matches a supplied traitmark as a filter.

◆ ObtainTrait() [1/2]

template<typename T >

EApparatusStatus ISubjective::ObtainTrait	(	T &	OutTrait,
		const bool	bTraitDataInitialized = `true`
	)

inline

Obtain a trait from a subjective.

Templated version.

If the trait is not currently within the subjective, it gets created anew and the default value gets copied to the receiver.

Template Parameters

T	The type of the trait to obtain.

Parameters

OutTrait	The trait receiver.
bTraitDataInitialized	Is the `OutTrait` actually initialized?

Returns: The status of the operation.

◆ ObtainTrait() [2/2]

EApparatusStatus ISubjective::ObtainTrait	(	UScriptStruct *	TraitType,
		void *const	OutTraitData,
		const bool	bTraitDataInitialized = `true`
	)

inline

Obtain a trait from a subjective by its type.

If the trait is not currently within the subjective, it gets created anewand the default value gets copied to the receiver.

Parameters

TraitType	The type of the trait to obtain.
OutTraitData	The trait data receiver.
bTraitDataInitialized	Is the `TraitData` buffer actually initialized?

Returns: The status of the operation.

◆ RemoveTrait() [1/2]

template<typename T >

EApparatusStatus ISubjective::RemoveTrait ( )

inline

Remove a trait from the subjective.

Templated version.

If there is no such trait in the subjective, nothing is performed and EApparatusStatus::Noop is returned.

Template Parameters

T	The type of the trait to remove.

Returns: The status of the operation.

◆ RemoveTrait() [2/2]

EApparatusStatus ISubjective::RemoveTrait ( UScriptStruct * TraitType )

inline

Remove a trait from the subjective.

If there is no such trait in the subjective, nothing is performed and EApparatusStatus::Noop is returned.

Parameters

TraitType The type of the trait to remove.

Returns: The status of the operation.

◆ SetTrait() [1/2]

template<typename T >

EApparatusStatus ISubjective::SetTrait ( const T & Trait )

inline

Set a trait of the subjective.

Templated version.

If the trait is not currently within the subjective, it gets created anew and set accordingly.

Template Parameters

T	A type of the trait to add.

Parameters

Trait A trait to initialize with.

Returns: The status of the operation.

◆ SetTrait() [2/2]

EApparatusStatus ISubjective::SetTrait	(	UScriptStruct *	TraitType,
		const void *const	TraitData
	)

inline

Set a trait of the subjective by its type.

If the trait is not currently within the subjective, it gets created anew and set accordingly

Parameters

TraitType	The type of the trait to add.
TraitData	The trait data to initialize with.

Returns: The status of the operation.

◆ TakeBeltSlot()

void ISubjective::TakeBeltSlot	(	class UBelt *	InBelt,
		int32	InSlotIndex
	)

inlineprotected

Set the current belt slot of the subjective (if any).

Parameters

InBelt	The belt must be stored in a GC-managed UPROPERTY.
InSlotIndex	The slot must be referenced and stored by its index in a `SlotIndex` field.

Friends And Related Function Documentation

◆ FBeltSlot

friend struct FBeltSlot

friend

◆ FBeltSlotCache

friend struct FBeltSlotCache

friend

◆ FFingerprint

friend struct FFingerprint

friend

◆ UApparatusFunctionLibrary

friend class UApparatusFunctionLibrary

friend

◆ UBelt

friend class UBelt

friend

◆ UDetail

friend class UDetail

friend

◆ UMachine

friend class UMachine

friend

Member Data Documentation

◆ Belt

TWeakObjectPtr<UBelt> ISubjective::Belt = nullptr

protected

A weak reference to a current subjective's belt (if any).

◆ Handle

FSubjectHandle ISubjective::Handle

protected

The subject handle which points to a global subjects registry.

◆ SlotIndex

int32 ISubjective::SlotIndex = FBeltSlot::InvalidIndex

protected

The index of the belt slot, this subject currently resides in.

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

D:/ApparatusMark/Plugins/Apparatus/Source/ApparatusRuntime/Public/Subjective.h
D:/ApparatusMark/Plugins/Apparatus/Source/ApparatusRuntime/Public/Belt.h
D:/ApparatusMark/Plugins/Apparatus/Source/ApparatusRuntime/Public/Machine.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ AddDetail()

◆ DisableDetail()

◆ EnableDetail()

◆ FindDetail()

◆ FindDetails()

◆ GetBelt()

◆ GetDetails()

◆ GetDetailsRef() [1/2]

◆ GetDetailsRef() [2/2]

◆ GetFingerprint()

◆ GetFingerprintRef()

◆ GetHandle() [1/2]

◆ GetHandle() [2/2]

◆ GetHash()

◆ GetPreferredBelt()

◆ GetSlot()

◆ GetSlotIndex()

◆ GetSlotPtr()

◆ GetTrait() [1/2]

◆ GetTrait() [2/2]

◆ HasDetail() [1/2]

◆ HasDetail() [2/2]

◆ HasTrait() [1/2]

◆ HasTrait() [2/2]

◆ IsBooted()

◆ IsRegistered()

◆ MarkBooted()

◆ Matches() [1/3]

◆ Matches() [2/3]

◆ Matches() [3/3]

◆ ObtainTrait() [1/2]

◆ ObtainTrait() [2/2]

◆ RemoveTrait() [1/2]

◆ RemoveTrait() [2/2]

◆ SetTrait() [1/2]

◆ SetTrait() [2/2]

◆ TakeBeltSlot()

Friends And Related Function Documentation

◆ FBeltSlot

◆ FBeltSlotCache

◆ FFingerprint

◆ UApparatusFunctionLibrary

◆ UBelt

◆ UDetail

◆ UMachine

Member Data Documentation

◆ Belt

◆ Handle

◆ SlotIndex