UApparatusFunctionLibrary Class Reference

The main Apparatus function library. More...

#include <ApparatusFunctionLibrary.h>

Inheritance diagram for UApparatusFunctionLibrary:

Collaboration diagram for UApparatusFunctionLibrary:

Public Member Functions
	DECLARE_FUNCTION (execMakeTraitRecord)
	DECLARE_FUNCTION (execGetChainTrait)
	DECLARE_FUNCTION (execGetChainTraitHinted)
	DECLARE_FUNCTION (execGetSubjectiveTrait)
	DECLARE_FUNCTION (execSetSubjectiveTrait)
	DECLARE_FUNCTION (execObtainSubjectiveTrait)
	DECLARE_FUNCTION (execGetSubjectTrait)
	DECLARE_FUNCTION (execSetSubjectTrait)
	DECLARE_FUNCTION (execObtainSubjectTrait)
	DECLARE_FUNCTION (execPushExtraSubjectTrait)
	DECLARE_FUNCTION (execPushExtraSubjectiveTrait)
	DECLARE_FUNCTION (execPushExtraSubjectTraitThroughBearer)

Static Public Member Functions
static int32	AddToSubjectHandles4 (FSubjectHandles4 &SubjectHandles, FSubjectHandle SubjectHandle)
	Add a subject handle to an array.
static int32	AddUniqueToSubjectHandles4 (FSubjectHandles4 &SubjectHandles, FSubjectHandle SubjectHandle)
	Add a unique subject handle to an array.
static void	RemoveFromSubjectHandles4 (FSubjectHandles4 &SubjectHandles, FSubjectHandle SubjectHandle)
	Remove a subject handle from the array.
static int32	GetSubjectHandles4Length (FSubjectHandles4 &SubjectHandles)
	Get the number of elements in the array.
static FSubjectHandle	GetSubjectHandles4At (const FSubjectHandles4 &SubjectHandles, const int32 Index)
	Get a copy for a subject handle at a specified index.
static void	SetSubjectHandles4At (FSubjectHandles4 &SubjectHandles, const int32 Index, const FSubjectHandle &SubjectHandle)
	Set a subject handle at a specified index of the array.
static void	ClearSubjectHandles4 (FSubjectHandles4 &SubjectHandles)
	Remove all elements from the array.
static int32	AddToSubjectHandles8 (FSubjectHandles8 &SubjectHandles, FSubjectHandle SubjectHandle)
	Add a subject handle to an array.
static int32	AddUniqueToSubjectHandles8 (FSubjectHandles8 &SubjectHandles, FSubjectHandle SubjectHandle)
	Add a unique subject handle to an array.
static void	RemoveFromSubjectHandles8 (FSubjectHandles8 &SubjectHandles, FSubjectHandle SubjectHandle)
	Remove a subject handle from the array.
static int32	GetSubjectHandles8Length (FSubjectHandles8 &SubjectHandles)
	Get the number of elements in the array.
static FSubjectHandle	GetSubjectHandles8At (const FSubjectHandles8 &SubjectHandles, const int32 Index)
	Get a copy for a subject handle at a specified index.
static void	SetSubjectHandles8At (FSubjectHandles8 &SubjectHandles, const int32 Index, const FSubjectHandle &SubjectHandle)
	Set a subject handle at a specified index of the array.
static void	ClearSubjectHandles8 (FSubjectHandles8 &SubjectHandles)
	Remove all elements from the array.
static int32	AddToSubjectHandles16 (FSubjectHandles16 &SubjectHandles, FSubjectHandle SubjectHandle)
	Add a subject handle to an array.
static int32	AddUniqueToSubjectHandles16 (FSubjectHandles16 &SubjectHandles, FSubjectHandle SubjectHandle)
	Add a unique subject handle to an array.
static void	RemoveFromSubjectHandles16 (FSubjectHandles16 &SubjectHandles, FSubjectHandle SubjectHandle)
	Remove a subject handle from the array.
static int32	GetSubjectHandles16Length (FSubjectHandles16 &SubjectHandles)
	Get the number of elements in the array.
static FSubjectHandle	GetSubjectHandles16At (const FSubjectHandles16 &SubjectHandles, const int32 Index)
	Get a copy for a subject handle at a specified index.
static void	SetSubjectHandles16At (FSubjectHandles16 &SubjectHandles, const int32 Index, const FSubjectHandle &SubjectHandle)
	Set a subject handle at a specified index of the array.
static void	ClearSubjectHandles16 (FSubjectHandles16 &SubjectHandles)
	Remove all elements from the array.
static FTraitmark	MakeTraitmark (const TArray< UScriptStruct * > &Traits)
	Make a traitmark from a list of trait types.
static FDetailmark	MakeDetailmark (const TArray< TSubclassOf< UDetail > > &Details)
	Make a detailmark from a list of detail classes.
static FFingerprint	MakeFingerprint (const TArray< UScriptStruct * > &Traits, const TArray< TSubclassOf< UDetail > > &Details, const int32 Flagmark)
	Make a fingerprint.
static void	MakeDefaultTraitRecord (UScriptStruct *TraitType, FTraitRecord &OutTraitRecord)
	Make a default-filled trait record.
static void	MakeTraitRecord (UScriptStruct *TraitType, const FGenericStruct &TraitData, FTraitRecord &OutTraitRecord)
	Make a trait record.
static void	Generic_MakeTraitRecord (UScriptStruct *const TraitType, const void *const TraitData, FTraitRecord &OutTraitRecord)
static int32	GetFingerprintFlagmark (const FFingerprint &Fingerprint)
	Get fingerprint's flagmark.
static FFilter	MakeFilter (const TArray< UScriptStruct * > &Traits, const TArray< TSubclassOf< UDetail > > &Details, const TArray< UScriptStruct * > &ExcludedTraits, const TArray< TSubclassOf< UDetail > > &ExcludedDetails, const int32 Flagmark=0x2, const int32 ExcludingFlagmark=0x1)
	Make a filter from the list of details, exclusion details, and a boot filter.
static FFilter	MakeCachedFilter0 (const FString &Key, const int32 Flagmark)
	Make a cached filter with 0 components;.
static FFilter	MakeCachedFilter1 (const FString &Key, UScriptStruct *Trait_0, TSubclassOf< UDetail > Detail_0, UScriptStruct *ExcludedTrait_0, TSubclassOf< UDetail > ExcludedDetail_0, const int32 Flagmark)
	Make a cached filter with 1 component;.
static FFilter	MakeCachedFilter2 (const FString &Key, UScriptStruct *Trait_0, UScriptStruct *Trait_1, TSubclassOf< UDetail > Detail_0, TSubclassOf< UDetail > Detail_1, UScriptStruct *ExcludedTrait_0, UScriptStruct *ExcludedTrait_1, TSubclassOf< UDetail > ExcludedDetail_0, TSubclassOf< UDetail > ExcludedDetail_1, const int32 Flagmark)
	Make a cached filter with 2 components;.
static FFilter	MakeCachedFilter4 (const FString &Key, UScriptStruct *Trait_0, UScriptStruct *Trait_1, UScriptStruct *Trait_2, UScriptStruct *Trait_3, TSubclassOf< UDetail > Detail_0, TSubclassOf< UDetail > Detail_1, TSubclassOf< UDetail > Detail_2, TSubclassOf< UDetail > Detail_3, UScriptStruct *ExcludedTrait_0, UScriptStruct *ExcludedTrait_1, UScriptStruct *ExcludedTrait_2, UScriptStruct *ExcludedTrait_3, TSubclassOf< UDetail > ExcludedDetail_0, TSubclassOf< UDetail > ExcludedDetail_1, TSubclassOf< UDetail > ExcludedDetail_2, TSubclassOf< UDetail > ExcludedDetail_3, const int32 Flagmark)
	Make a cached filter with 4 components;.
static FFilter	MakeCachedFilter8 (const FString &Key, UScriptStruct *Trait_0, UScriptStruct *Trait_1, UScriptStruct *Trait_2, UScriptStruct *Trait_3, UScriptStruct *Trait_4, UScriptStruct *Trait_5, UScriptStruct *Trait_6, UScriptStruct *Trait_7, TSubclassOf< UDetail > Detail_0, TSubclassOf< UDetail > Detail_1, TSubclassOf< UDetail > Detail_2, TSubclassOf< UDetail > Detail_3, TSubclassOf< UDetail > Detail_4, TSubclassOf< UDetail > Detail_5, TSubclassOf< UDetail > Detail_6, TSubclassOf< UDetail > Detail_7, UScriptStruct *ExcludedTrait_0, UScriptStruct *ExcludedTrait_1, UScriptStruct *ExcludedTrait_2, UScriptStruct *ExcludedTrait_3, UScriptStruct *ExcludedTrait_4, UScriptStruct *ExcludedTrait_5, UScriptStruct *ExcludedTrait_6, UScriptStruct *ExcludedTrait_7, TSubclassOf< UDetail > ExcludedDetail_0, TSubclassOf< UDetail > ExcludedDetail_1, TSubclassOf< UDetail > ExcludedDetail_2, TSubclassOf< UDetail > ExcludedDetail_3, TSubclassOf< UDetail > ExcludedDetail_4, TSubclassOf< UDetail > ExcludedDetail_5, TSubclassOf< UDetail > ExcludedDetail_6, TSubclassOf< UDetail > ExcludedDetail_7, const int32 Flagmark)
	Make a cached filter with 8 components;.
static bool	FingerprintMatches (const FFingerprint &Fingerprint, const FFilter &Filter)
	Check if a fingerprint matches a filter.
static FBitMask	BitMaskOr (const FBitMask &A, const FBitMask &B)
	Disjunct two bitmasks resulting in a bitmask.
static FBitMask	BitMaskAnd (const FBitMask &A, const FBitMask &B)
	Conjunct two bit masks resulting in a bit mask.
static FFingerprint &	AddDetailToFingerprint (FFingerprint &Fingerprint, const TSubclassOf< UDetail > DetailClass)
	Add a detail class to a fingerprint.
static FFingerprint &	RemoveDetailFromFingerprint (FFingerprint &Fingerprint, const TSubclassOf< UDetail > DetailClass)
	Remove a detail class from a fingerprint.
static AMechanism *	GeDetailMechanism (const UDetail *Detail)
static void	MechanismEnchain (UObject *WorldContextObject, const FFilter &Filter, int32 &OutChainId, AMechanism *Mechanism=nullptr)
	Enchain multiple iterable sequences (chunks or belts) based on a filter.
static void	MechanismEnchainHalted (UObject *WorldContextObject, FFilter &Filter, int32 &OutChainId, AMechanism *Mechanism=nullptr)
static void	MechanismEnchainBooted (UObject *WorldContextObject, FFilter &Filter, int32 &OutChainId, AMechanism *Mechanism=nullptr)
static int32	ChainIterableNum (UObject *WorldContextObject, const int32 ChainId, AMechanism *Mechanism=nullptr)
	Get the total iterable number of entities (Subjects/Subjectives) in the chain.
static bool	BeginChain (UObject *WorldContextObject, const int32 ChainId, AMechanism *Mechanism=nullptr)
	Begin iterating upon a chain.
static bool	AdvanceChain (UObject *WorldContextObject, const int32 ChainId, AMechanism *Mechanism=nullptr)
	Advance while iterating upon a chain.
static bool	BeginOrAdvanceChain (UObject *WorldContextObject, const int32 ChainId, AMechanism *Mechanism=nullptr)
	Begin iterating or advance while iterating upon a chain.
static FSubjectHandle	GetChainSubject (UObject *WorldContextObject, const int32 ChainId, AMechanism *Mechanism=nullptr)
	Get the current iteration's subject handle.
static TScriptInterface< ISubjective >	GetChainSubjective (UObject *WorldContextObject, const int32 ChainId, AMechanism *Mechanism=nullptr)
	Get the current iteration's subjective (if any).
static void	GetChainTrait (UObject *WorldContextObject, const int32 ChainId, UScriptStruct *TraitType, FGenericStruct &OutTraitData, AMechanism *Mechanism=nullptr)
	Get an existing trait structure from the current chain cursor.
static void	Generic_GetChainTrait (UObject *const WorldContextObject, const int32 &ChainId, UScriptStruct *TraitType, void *const OutTraitData, AMechanism *Mechanism)
static void	GetChainTraitHinted (UObject *WorldContextObject, const int32 ChainId, UScriptStruct *TraitType, const int32 TraitIndex, FGenericStruct &OutTraitData, AMechanism *Mechanism=nullptr)
	Get an existing trait structure from the current chain cursor with a specific index hinted.
static void	Generic_GetChainTraitHinted (UObject *const WorldContextObject, const int32 ChainId, UScriptStruct *TraitType, const int32 TraitIndex, void *const OutTraitData, AMechanism *Mechanism)
static UDetail *	GetChainDetail (UObject *WorldContextObject, const int32 ChainId, TSubclassOf< UDetail > DetailClass, AMechanism *Mechanism=nullptr)
	Get a detail from a current chain iteration.
static UDetail *	GetChainDetailHinted (UObject *WorldContextObject, const int32 ChainId, TSubclassOf< UDetail > DetailClass, const int32 DetailIndexHint, AMechanism *Mechanism=nullptr)
	Get a detail from a chain while hinting its index.
static void	SpawnMachineSubject (UObject *WorldContextObject, const int32 Flagmark, FSubjectHandle &OutSubjectHandle, AMechanism *Mechanism=nullptr)
	Spawn a new subject within a machine.
static FSubjectHandle	SpawnMachineSubjectFromRecord (UObject *WorldContextObject, const FSubjectRecord &Record, AMechanism *Mechanism=nullptr)
	Spawn a new subject based on a record.
static FSubjectHandle	GetInvalidSubjectHandle ()
	Get the invalid subject handle constant.
static bool	IsSubjectHandleValid (FSubjectHandle &SubjectHandle)
	Check if the subject handle is a valid one.
static void	ResetSubjectHandle (FSubjectHandle &SubjectHandle)
	Reset the subject handle, making it invalid.
static AMechanism *	GetSubjectMechanism (const FSubjectHandle &SubjectHandle)
	Get the current mechanism of a subject.
static void	SetSubjectMechanism (FSubjectHandle &SubjectHandle, AMechanism *Mechanism)
	Set the mechanism of a subject.
static bool	AreSubjectHandlesEqual (const FSubjectHandle &SubjectA, const FSubjectHandle &SubjectB)
	Check if two handles point at the same subject.
static bool	AreSubjectHandlesNotEqual (const FSubjectHandle &SubjectA, const FSubjectHandle &SubjectB)
	Check if two handles point at different subjects.
static void	DumpSubjectToRecord (FSubjectHandle &SubjectHandle, FSubjectRecord &OutSubjectRecord, int32 FlagmarkMask=0x7FFFFFE0)
	Create a new subject record dump from a subject.
static void	DumpMaskedSubjectToRecord (FSubjectHandle &SubjectHandle, FSubjectRecord &OutSubjectRecord, const FFilter &Mask)
	Create a new subject record dump from a masked subject.
static FSubjectRecord	Conv_SubjectHandleToSubjectRecord (const FSubjectHandle &SubjectHandle)
	Create a new subject record dump from a subject.
static AMechanism *	GetSubjectiveMechanism (TScriptInterface< ISubjective > Subjective)
	Get the current mechanism of a subject.
static void	SetSubjectiveMechanism (TScriptInterface< ISubjective > Subjective, AMechanism *Mechanism)
	Set the mechanism of a subjective.
static void	GetSubjectiveFingerprint (TScriptInterface< ISubjective > Subjective, FFingerprint &OutFingerprint)
	Get the current fingerprint of a subjective.
static USubjectiveActorComponent *	GetSubjectiveComponent (TScriptInterface< ISubjective > Subjective)
	Cast subjective to an actor component.
static AActor *	GetSubjectiveActor (TScriptInterface< ISubjective > Subjective)
	Get the actor of the subjective in question.
static TScriptInterface< ISubjective >	GetObjectSubjective (UObject *Object)
	Get a subjective from an object.
static UUserWidget *	GetSubjectiveWidget (TScriptInterface< ISubjective > Subjective)
	Get the widget in question, if this subjective is actually an user widget.
static int32	GetSubjectFlagmark (const FSubjectHandle &SubjectHandle)
	Get the flagmark of the subject.
static void	SetSubjectFlagmark (const FSubjectHandle &SubjectHandle, const int32 Flagmark=0x0)
	Set the flagmark of a subject.
static bool	HasSubjectFlag (const FSubjectHandle &SubjectHandle, const EFlagmarkBit Flag=EFlagmarkBit::A)
	Get the state of a flag of the subject.
static void	SetSubjectFlag (const FSubjectHandle &SubjectHandle, const EFlagmarkBit Flag=EFlagmarkBit::A, bool bState=true)
	Set/clear the flag of the subject.
static bool	ToggleSubjectFlag (const FSubjectHandle &SubjectHandle, const EFlagmarkBit Flag=EFlagmarkBit::A)
	Toggle the flag of the subject.
static int32	GetSubjectiveFlagmark (TScriptInterface< ISubjective > Subjective)
	Get the flagmark of the subjective.
static FSubjectHandle	GetSubjectiveHandle (TScriptInterface< ISubjective > Subjective)
	Get the subject handle for a subjective.
static FSubjectHandle	Conv_SubjectiveToSubjectHandle (TScriptInterface< ISubjective > Subjective)
	Convert a subjective to a low-level subject handle.
static void	SetSubjectiveFlagmark (TScriptInterface< ISubjective > Subjective, const int32 Flagmark=0x0)
	Set the flagmark of the subjective.
static bool	HasSubjectiveFlag (TScriptInterface< ISubjective > Subjective, const EFlagmarkBit Flag=EFlagmarkBit::A)
	Get the state of a flag in the subjective.
static void	SetSubjectiveFlag (TScriptInterface< ISubjective > Subjective, const EFlagmarkBit Flag=EFlagmarkBit::A, bool bState=true)
	Set/clear a flag of the subjective.
static void	ToggleSubjectiveFlag (TScriptInterface< ISubjective > Subjective, const EFlagmarkBit Flag=EFlagmarkBit::A)
	Toggle a flag of the subjective.
static void	GetSubjectiveTrait (TScriptInterface< ISubjective > Subjective, UScriptStruct *TraitType, FGenericStruct &TraitData)
	Get a trait from a subjective.
static void	Generic_GetSubjectiveTrait (TScriptInterface< ISubjective > Subjective, UScriptStruct *const TraitType, void *const TraitData)
static void	SetSubjectiveTrait (TScriptInterface< ISubjective > Subjective, UScriptStruct *TraitType, const FGenericStruct &TraitData)
	Set a trait structure for a subjective.
static void	Generic_SetSubjectiveTrait (TScriptInterface< ISubjective > Subjective, UScriptStruct *const TraitType, const void *const TraitData)
static void	ObtainSubjectiveTrait (TScriptInterface< ISubjective > Subjective, UScriptStruct *TraitType, FGenericStruct &TraitData)
	Obtain a trait from a subjective.
static void	Generic_ObtainSubjectiveTrait (TScriptInterface< ISubjective > Subjective, UScriptStruct *const TraitType, void *const TraitData)
static void	GetSubjectTrait (const FSubjectHandle &SubjectHandle, UScriptStruct *TraitType, FGenericStruct &TraitData)
	Get a trait from a subject.
static void	Generic_GetSubjectTrait (const FSubjectHandle &SubjectHandle, UScriptStruct *const TraitType, void *const TraitData)
static void	SetSubjectTrait (const FSubjectHandle &SubjectHandle, UScriptStruct *TraitType, const FGenericStruct &TraitData)
	Set a trait for a subject.
static void	Generic_SetSubjectTrait (const FSubjectHandle &SubjectHandle, UScriptStruct *const TraitType, const void *const TraitData)
static void	ObtainSubjectTrait (const FSubjectHandle &SubjectHandle, UScriptStruct *TraitType, FGenericStruct &TraitData)
	Obtain a trait from a subject.
static void	Generic_ObtainSubjectTrait (const FSubjectHandle &SubjectHandle, UScriptStruct *const TraitType, void *const TraitData)
static void	RemoveSubjectTrait (const FSubjectHandle &SubjectHandle, UScriptStruct *TraitType)
	Remove a trait from the subject.
static void	CopySubjectTraits (const FSubjectHandle &SourceSubjectHandle, const FSubjectHandle &DestinationSubjectHandle)
	Copy all of the traits from one subject to another.
static void	RemoveAllSubjectTraits (const FSubjectHandle &SubjectHandle)
	Remove all traits from a subject.
static void	RemoveSubjectiveTrait (TScriptInterface< ISubjective > Subjective, UScriptStruct *TraitType)
	Remove a trait from the subjective.
static bool	HasSubjectTrait (const FSubjectHandle &SubjectHandle, UScriptStruct *TraitType)
	Check if the subject contains a trait of a certain type.
static bool	HasSubjectiveTrait (TScriptInterface< ISubjective > Subjective, UScriptStruct *TraitType)
	Check if the subjective contains a trait of a certain type.
static UDetail *	EnableSubjectiveDetail (TScriptInterface< ISubjective > Subjective, TSubclassOf< UDetail > DetailClass)
	Enable a detail of a certain type for a subjective.
static class UBelt *	GetSubjectivePreferredBelt (TScriptInterface< ISubjective > Subjective)
	Get the preferred user-set belt.
static bool	HasSubjectiveDetail (TScriptInterface< ISubjective > Subjective, TSubclassOf< UDetail > DetailClass, const bool bIncludeDisabled=false)
	Check if the subjective contains a detail of a certain type.
static UDetail *	FindSubjectiveDetail (TScriptInterface< ISubjective > Subjective, TSubclassOf< UDetail > DetailClass, const bool bIncludeDisabled=false)
	Find a detail by its type.
static void	GetSubjectiveDetails (TScriptInterface< ISubjective > Subjective, TArray< UDetail * > &OutDetails, const bool bIncludeDisabled=false)
	Get the current list of details in the subject.
static TArray< UDetail * >	FindSubjectiveDetails (TScriptInterface< ISubjective > Subjective, TSubclassOf< UDetail > DetailClass, const bool bIncludeDisabled=false)
	Find the details by their type.
static class UDetail *	AddSubjectiveDetail (TScriptInterface< ISubjective > Subjective, TSubclassOf< UDetail > DetailClass, const bool bReuseDisabled=false)
	Add or reuse a detail of a certain type.
static void	DisableSubjectiveDetail (TScriptInterface< ISubjective > Subjective, TSubclassOf< UDetail > DetailClass, const bool bDisableMultiple=false)
	Disable a first detail matching the passed type.
static void	BringSubjectOnlineOnServer (const FSubjectHandle &SubjectHandle)
	Bring the subject to be available on the network.
static void	BringSubjectOnlineOnServerWithIdRange (const FSubjectHandle &SubjectHandle, const FInt32Range &IdRange)
	Bring the subject to be available on the network while allocated its identifier within a range.
static int64	GetSubjectNetworkId (const FSubjectHandle &SubjectHandle)
	Get the unique network identifier of the subject.
static bool	IsSubjectOnline (const FSubjectHandle &SubjectHandle)
	Check if the subject is online.
static bool	IsSubjectServerSide (const FSubjectHandle &SubjectHandle)
	Check if the subject is server-side.
static bool	IsSubjectClientSide (const FSubjectHandle &SubjectHandle)
	Check if the subject is client-side.
static UObject *	GetSubjectConnectionPermit (const FSubjectHandle &SubjectHandle)
	Get the server-side connection that is allowed to push traits to this subject.
static void	SetSubjectConnectionPermit (const FSubjectHandle &SubjectHandle, UObject *InConnectionPermit)
	Set the server-side connection from which it is allowed to push to this subject.
static FTraitmark	GetSubjectTraitmarkPermit (const FSubjectHandle &SubjectHandle)
	Get the server-side list of traits allowed to be received from clients.
static void	SetSubjectTraitmarkPermit (const FSubjectHandle &SubjectHandle, const FTraitmark &InTraitmarkPass)
	Set the list of traits allowed to be received from clients on the server.
static UObject *	GetSubjectiveConnectionPermit (TScriptInterface< ISubjective > Subjective)
	Get the server-side connection that is allowed to push to this subject.
static void	SetSubjectiveConnectionPermit (TScriptInterface< ISubjective > Subjective, UObject *InConnectionPermit)
	Set the server-side connection that is allowed to push to this subjective.
static FTraitmark	GetSubjectiveTraitmarkPermit (TScriptInterface< ISubjective > Subjective)
	Get the server-side list of traits allowed to be received from clients.
static void	SetSubjectiveTraitmarkPermit (TScriptInterface< ISubjective > Subjective, const FTraitmark &InTraitmarkPass)
	Set the list of traits allowed to be received from clients on the server.
static void	PushSubjectTrait (const FSubjectHandle &SubjectHandle, UScriptStruct *TraitType, const EPeerRole PeerRole=EPeerRole::None, const bool bReliable=true)
	Push an existing trait structure to the clients version of the online subject.
static void	PushExtraSubjectTrait (const FSubjectHandle &SubjectHandle, UScriptStruct *TraitType, const FGenericStruct &TraitData, const bool bSetForLocal=false, const EPeerRole PeerRole=EPeerRole::None, const bool bReliable=true)
	Push an additional trait structure to the clients version of the online subject.
static void	Generic_PushExtraSubjectTrait (const FSubjectHandle &SubjectHandle, UScriptStruct *const TraitType, const void *const TraitData, const bool bSetForLocal=false, const EPeerRole PeerRole=EPeerRole::None, const bool bReliable=true)
static void	PushSubjectiveTrait (TScriptInterface< ISubjective > Subjective, UScriptStruct *TraitType, const EPeerRole PeerRole=EPeerRole::None, const bool bReliable=true)
	Push an existing trait to an online subjective.
static void	PushExtraSubjectiveTrait (TScriptInterface< ISubjective > Subjective, UScriptStruct *TraitType, const FGenericStruct &TraitData, const bool bSetForLocal=false, const EPeerRole PeerRole=EPeerRole::None, const bool bReliable=true)
	Push an additional trait to an online subjective.
static void	Generic_PushExtraSubjectiveTrait (TScriptInterface< ISubjective > Subjective, UScriptStruct *const TraitType, const void *const TraitData, const bool bSetForLocal=false, const EPeerRole PeerRole=EPeerRole::None, const bool bReliable=true)
static void	PushSubjectTraitThroughBearer (UNetworkBearerComponent *NetworkBearer, const FSubjectHandle &SubjectHandle, UScriptStruct *TraitType, const bool bReliable=true)
	Push an existing trait to a remote version of the subject through the bearer.
static void	PushExtraSubjectTraitThroughBearer (UNetworkBearerComponent *NetworkBearer, const FSubjectHandle &SubjectHandle, UScriptStruct *TraitType, const FGenericStruct &TraitData, const bool bReliable=true)
	Push an additional trait to a remote version of the subject through the bearer.
static void	Generic_PushExtraSubjectTraitThroughBearer (UNetworkBearerComponent *NetworkBearer, const FSubjectHandle &SubjectHandle, UScriptStruct *const TraitType, const void *const TraitData, const bool bReliable)
static void	DisableSubjectDetail (FSubjectHandle &SubjectHandle, TSubclassOf< UDetail > DetailClass, const bool bDisableMultiple=false)
	Disable a detail for the subject.
static TScriptInterface< ISubjective >	GetSubjectSubjective (const FSubjectHandle &SubjectHandle)
	Get the subjective of the subject (if any).
static bool	HasSubjectDetail (const FSubjectHandle &SubjectHandle, TSubclassOf< UDetail > DetailClass)
	Check if the subject contains a detail.
static void	DespawnMachineSubject (const FSubjectHandle &SubjectHandle)
	Despawn a subject from the machine.

Detailed Description

The main Apparatus function library.

Member Function Documentation

AddDetailToFingerprint()

FFingerprint & UApparatusFunctionLibrary::AddDetailToFingerprint ( FFingerprint &  Fingerprint, const TSubclassOf< UDetail >  DetailClass  )

inlinestatic

Add a detail class to a fingerprint.

AddSubjectiveDetail()

static class UDetail * UApparatusFunctionLibrary::AddSubjectiveDetail ( TScriptInterface< ISubjective >  Subjective, TSubclassOf< UDetail >  DetailClass, const bool  bReuseDisabled = false  )

inlinestatic

Add or reuse a detail of a certain type.

Parameters

Subjective	The subjective to add a detail to.
DetailClass	The type of a detail to add to a subject.
bReuseDisabled	Should an inactive detail be reused, if possible. If the detail already exists and is active, a new detail is created, activated and returned. If the detail exists but is not currently active, it is activated and returned.

Returns

A new or reused detail. Guaranteed to be active.

AddToSubjectHandles16()

static int32 UApparatusFunctionLibrary::AddToSubjectHandles16 ( FSubjectHandles16 &  SubjectHandles, FSubjectHandle  SubjectHandle  )

inlinestatic

Add a subject handle to an array.

Invalid handles won't be added for the purpose of economy.

AddToSubjectHandles4()

static int32 UApparatusFunctionLibrary::AddToSubjectHandles4 ( FSubjectHandles4 &  SubjectHandles, FSubjectHandle  SubjectHandle  )

inlinestatic

Add a subject handle to an array.

Invalid handles won't be added for the purpose of economy.

AddToSubjectHandles8()

static int32 UApparatusFunctionLibrary::AddToSubjectHandles8 ( FSubjectHandles8 &  SubjectHandles, FSubjectHandle  SubjectHandle  )

inlinestatic

Add a subject handle to an array.

Invalid handles won't be added for the purpose of economy.

AddUniqueToSubjectHandles16()

static int32 UApparatusFunctionLibrary::AddUniqueToSubjectHandles16 ( FSubjectHandles16 &  SubjectHandles, FSubjectHandle  SubjectHandle  )

inlinestatic

Add a unique subject handle to an array.

Invalid handles won't be added for the purpose of economy.

AddUniqueToSubjectHandles4()

static int32 UApparatusFunctionLibrary::AddUniqueToSubjectHandles4 ( FSubjectHandles4 &  SubjectHandles, FSubjectHandle  SubjectHandle  )

inlinestatic

Add a unique subject handle to an array.

Invalid handles won't be added for the purpose of economy.

AddUniqueToSubjectHandles8()

static int32 UApparatusFunctionLibrary::AddUniqueToSubjectHandles8 ( FSubjectHandles8 &  SubjectHandles, FSubjectHandle  SubjectHandle  )

inlinestatic

Add a unique subject handle to an array.

Invalid handles won't be added for the purpose of economy.

AdvanceChain()

bool UApparatusFunctionLibrary::AdvanceChain ( UObject *  WorldContextObject, const int32  ChainId, AMechanism *  Mechanism = nullptr  )

inlinestatic

Advance while iterating upon a chain.

Parameters

WorldContextObject	An object to get a world context from.
ChainId	The identifier of a chain to iterate upon.
Mechanism	The explicit mechanism to use.

Returns

Is the current iteration viable?

AreSubjectHandlesEqual()

static bool UApparatusFunctionLibrary::AreSubjectHandlesEqual ( const FSubjectHandle &  SubjectA, const FSubjectHandle &  SubjectB  )

inlinestatic

Check if two handles point at the same subject.

AreSubjectHandlesNotEqual()

static bool UApparatusFunctionLibrary::AreSubjectHandlesNotEqual ( const FSubjectHandle &  SubjectA, const FSubjectHandle &  SubjectB  )

inlinestatic

Check if two handles point at different subjects.

BeginChain()

static bool UApparatusFunctionLibrary::BeginChain ( UObject *  WorldContextObject, const int32  ChainId, AMechanism *  Mechanism = nullptr  )

inlinestatic

Begin iterating upon a chain.

Parameters

WorldContextObject	An object to get a world context from.
ChainId	The identifier of a chain to iterate upon.
Mechanism	The explicit mechanism to use.

Returns

Is the current iteration viable?

BeginOrAdvanceChain()

static bool UApparatusFunctionLibrary::BeginOrAdvanceChain ( UObject *  WorldContextObject, const int32  ChainId, AMechanism *  Mechanism = nullptr  )

inlinestatic

Begin iterating or advance while iterating upon a chain.

Parameters

WorldContextObject	An object to get a world context from.
ChainId	The identifier of a chain to iterate upon.
Mechanism	The explicit mechanism to use.

Returns

Is the current iteration viable or an end has come?

BitMaskAnd()

static FBitMask UApparatusFunctionLibrary::BitMaskAnd ( const FBitMask &  A, const FBitMask &  B  )

inlinestatic

Conjunct two bit masks resulting in a bit mask.

BitMaskOr()

static FBitMask UApparatusFunctionLibrary::BitMaskOr ( const FBitMask &  A, const FBitMask &  B  )

inlinestatic

Disjunct two bitmasks resulting in a bitmask.

BringSubjectOnlineOnServer()

static void UApparatusFunctionLibrary::BringSubjectOnlineOnServer ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Bring the subject to be available on the network.

Assigns a unique network identifier and makes cross-peer procedures possible.

Parameters

SubjectHandle

The subject to bring online. Must be a valid handle.

BringSubjectOnlineOnServerWithIdRange()

static void UApparatusFunctionLibrary::BringSubjectOnlineOnServerWithIdRange ( const FSubjectHandle &  SubjectHandle, const FInt32Range &  IdRange  )

inlinestatic

Bring the subject to be available on the network while allocated its identifier within a range.

Assigns a unique network identifier and makes cross-peer procedures possible.

Parameters

SubjectHandle	The subject to bring online. Must be a valid handle.
IdRange	The range for network identifiers.

ChainIterableNum()

static int32 UApparatusFunctionLibrary::ChainIterableNum ( UObject *  WorldContextObject, const int32  ChainId, AMechanism *  Mechanism = nullptr  )

inlinestatic

Get the total iterable number of entities (Subjects/Subjectives) in the chain.

Parameters

WorldContextObject	An object to get a world context from.
ChainId	The identifier of a chain to examine.
Mechanism	The explicit mechanism to use.

Returns

The number of entities available for iteration.

ClearSubjectHandles16()

static void UApparatusFunctionLibrary::ClearSubjectHandles16 ( FSubjectHandles16 &  SubjectHandles )

inlinestatic

Remove all elements from the array.

ClearSubjectHandles4()

static void UApparatusFunctionLibrary::ClearSubjectHandles4 ( FSubjectHandles4 &  SubjectHandles )

inlinestatic

Remove all elements from the array.

ClearSubjectHandles8()

static void UApparatusFunctionLibrary::ClearSubjectHandles8 ( FSubjectHandles8 &  SubjectHandles )

inlinestatic

Remove all elements from the array.

Conv_SubjectHandleToSubjectRecord()

static FSubjectRecord UApparatusFunctionLibrary::Conv_SubjectHandleToSubjectRecord ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Create a new subject record dump from a subject.

Parameters

SubjectHandle

The subject to convert (dump).

Returns

The converted record dump.

Conv_SubjectiveToSubjectHandle()

static FSubjectHandle UApparatusFunctionLibrary::Conv_SubjectiveToSubjectHandle ( TScriptInterface< ISubjective >  Subjective )

inlinestatic

Convert a subjective to a low-level subject handle.

This acquires the internal handle.

Parameters

Subjective

The subjective to convert.

Returns

The subject handle.

CopySubjectTraits()

static void UApparatusFunctionLibrary::CopySubjectTraits ( const FSubjectHandle &  SourceSubjectHandle, const FSubjectHandle &  DestinationSubjectHandle  )

inlinestatic

Copy all of the traits from one subject to another.

The existing traits of the destination subject are not removed but the new ones are added and/or override the existing matching.

Parameters

SourceSubjectHandle	The source subject to copy from. Must be a valid handle.
DestinationSubjectHandle	The destination subject to copy to. Must be a valid handle.

DECLARE_FUNCTION() [1/12]

UApparatusFunctionLibrary::DECLARE_FUNCTION ( execGetChainTrait  )

inline

DECLARE_FUNCTION() [2/12]

UApparatusFunctionLibrary::DECLARE_FUNCTION ( execGetChainTraitHinted  )

inline

DECLARE_FUNCTION() [3/12]

UApparatusFunctionLibrary::DECLARE_FUNCTION ( execGetSubjectiveTrait  )

inline

DECLARE_FUNCTION() [4/12]

UApparatusFunctionLibrary::DECLARE_FUNCTION ( execGetSubjectTrait  )

inline

DECLARE_FUNCTION() [5/12]

UApparatusFunctionLibrary::DECLARE_FUNCTION ( execMakeTraitRecord  )

inline

DECLARE_FUNCTION() [6/12]

UApparatusFunctionLibrary::DECLARE_FUNCTION ( execObtainSubjectiveTrait  )

inline

DECLARE_FUNCTION() [7/12]

UApparatusFunctionLibrary::DECLARE_FUNCTION ( execObtainSubjectTrait  )

inline

DECLARE_FUNCTION() [8/12]

UApparatusFunctionLibrary::DECLARE_FUNCTION ( execPushExtraSubjectiveTrait  )

inline

DECLARE_FUNCTION() [9/12]

UApparatusFunctionLibrary::DECLARE_FUNCTION ( execPushExtraSubjectTrait  )

inline

DECLARE_FUNCTION() [10/12]

UApparatusFunctionLibrary::DECLARE_FUNCTION ( execPushExtraSubjectTraitThroughBearer  )

inline

DECLARE_FUNCTION() [11/12]

UApparatusFunctionLibrary::DECLARE_FUNCTION ( execSetSubjectiveTrait  )

inline

DECLARE_FUNCTION() [12/12]

UApparatusFunctionLibrary::DECLARE_FUNCTION ( execSetSubjectTrait  )

inline

DespawnMachineSubject()

static void UApparatusFunctionLibrary::DespawnMachineSubject ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Despawn a subject from the machine.

If the subject is already despawned, nothing is performed.

Parameters

SubjectHandle

The subject to despawn.

DisableSubjectDetail()

static void UApparatusFunctionLibrary::DisableSubjectDetail ( FSubjectHandle &  SubjectHandle, TSubclassOf< UDetail >  DetailClass, const bool  bDisableMultiple = false  )

inlinestatic

Disable a detail for the subject.

DisableSubjectiveDetail()

static void UApparatusFunctionLibrary::DisableSubjectiveDetail ( TScriptInterface< ISubjective >  Subjective, TSubclassOf< UDetail >  DetailClass, const bool  bDisableMultiple = false  )

inlinestatic

Disable a first detail matching the passed type.

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

Parameters

Subjective	The subjective to disable a detail for.
DetailClass	The class of detail(s) to disable.
bDisableMultiple	Should multiple matching details be disabled at once, or only the first one?

DumpMaskedSubjectToRecord()

static void UApparatusFunctionLibrary::DumpMaskedSubjectToRecord ( FSubjectHandle &  SubjectHandle, FSubjectRecord &  OutSubjectRecord, const FFilter &  Mask  )

inlinestatic

Create a new subject record dump from a masked subject.

Parameters

SubjectHandle	The subject to dump.
Mask	The filter used as a mask.
OutSubjectRecord	The record to output to.

DumpSubjectToRecord()

static void UApparatusFunctionLibrary::DumpSubjectToRecord ( FSubjectHandle &  SubjectHandle, FSubjectRecord &  OutSubjectRecord, int32  FlagmarkMask = 0x7FFFFFE0  )

inlinestatic

Create a new subject record dump from a subject.

Parameters

SubjectHandle	The subject to dump.
FlagmarkMask	The flagmark mask to filter the flags.
OutSubjectRecord	The record to output to.

EnableSubjectiveDetail()

static UDetail * UApparatusFunctionLibrary::EnableSubjectiveDetail ( TScriptInterface< ISubjective >  Subjective, TSubclassOf< UDetail >  DetailClass  )

inlinestatic

Enable a detail of a certain type for a subjective.

If the detail already exists and is active, nothing is performed, and that exact detail is returned. If the detail does not exist at all, a new detail is added, activated and returned. If the detail exists but is not currently active, it is activated and returned.

Parameters

Subjective	The subjective to modify. Must be a valid one.
DetailClass	The class of the detail to enable.

Returns

The enabled detail instance.

FindSubjectiveDetail()

static UDetail * UApparatusFunctionLibrary::FindSubjectiveDetail ( TScriptInterface< ISubjective >  Subjective, TSubclassOf< UDetail >  DetailClass, const bool  bIncludeDisabled = false  )

inlinestatic

Find a detail by its type.

FindSubjectiveDetails()

TArray< UDetail * > UApparatusFunctionLibrary::FindSubjectiveDetails ( TScriptInterface< ISubjective >  Subjective, TSubclassOf< UDetail >  DetailClass, const bool  bIncludeDisabled = false  )

inlinestatic

Find the details by their type.

FingerprintMatches()

static bool UApparatusFunctionLibrary::FingerprintMatches ( const FFingerprint &  Fingerprint, const FFilter &  Filter  )

inlinestatic

Check if a fingerprint matches a filter.

GeDetailMechanism()

static AMechanism * UApparatusFunctionLibrary::GeDetailMechanism ( const UDetail *  Detail )

inlinestatic

Generic_GetChainTrait()

static void UApparatusFunctionLibrary::Generic_GetChainTrait ( UObject *const  WorldContextObject, const int32 &  ChainId, UScriptStruct *  TraitType, void *const  OutTraitData, AMechanism *  Mechanism  )

inlinestatic

Generic_GetChainTraitHinted()

static void UApparatusFunctionLibrary::Generic_GetChainTraitHinted ( UObject *const  WorldContextObject, const int32  ChainId, UScriptStruct *  TraitType, const int32  TraitIndex, void *const  OutTraitData, AMechanism *  Mechanism  )

inlinestatic

Generic_GetSubjectiveTrait()

static void UApparatusFunctionLibrary::Generic_GetSubjectiveTrait ( TScriptInterface< ISubjective >  Subjective, UScriptStruct *const  TraitType, void *const  TraitData  )

inlinestatic

Generic_GetSubjectTrait()

static void UApparatusFunctionLibrary::Generic_GetSubjectTrait ( const FSubjectHandle &  SubjectHandle, UScriptStruct *const  TraitType, void *const  TraitData  )

inlinestatic

Generic_MakeTraitRecord()

static void UApparatusFunctionLibrary::Generic_MakeTraitRecord ( UScriptStruct *const  TraitType, const void *const  TraitData, FTraitRecord &  OutTraitRecord  )

inlinestatic

Generic_ObtainSubjectiveTrait()

static void UApparatusFunctionLibrary::Generic_ObtainSubjectiveTrait ( TScriptInterface< ISubjective >  Subjective, UScriptStruct *const  TraitType, void *const  TraitData  )

inlinestatic

Generic_ObtainSubjectTrait()

static void UApparatusFunctionLibrary::Generic_ObtainSubjectTrait ( const FSubjectHandle &  SubjectHandle, UScriptStruct *const  TraitType, void *const  TraitData  )

inlinestatic

Generic_PushExtraSubjectiveTrait()

static void UApparatusFunctionLibrary::Generic_PushExtraSubjectiveTrait ( TScriptInterface< ISubjective >  Subjective, UScriptStruct *const  TraitType, const void *const  TraitData, const bool  bSetForLocal = false, const EPeerRole  PeerRole = EPeerRole::None, const bool  bReliable = true  )

inlinestatic

Generic_PushExtraSubjectTrait()

static void UApparatusFunctionLibrary::Generic_PushExtraSubjectTrait ( const FSubjectHandle &  SubjectHandle, UScriptStruct *const  TraitType, const void *const  TraitData, const bool  bSetForLocal = false, const EPeerRole  PeerRole = EPeerRole::None, const bool  bReliable = true  )

inlinestatic

Generic_PushExtraSubjectTraitThroughBearer()

static void UApparatusFunctionLibrary::Generic_PushExtraSubjectTraitThroughBearer ( UNetworkBearerComponent *  NetworkBearer, const FSubjectHandle &  SubjectHandle, UScriptStruct *const  TraitType, const void *const  TraitData, const bool  bReliable  )

inlinestatic

Generic_SetSubjectiveTrait()

static void UApparatusFunctionLibrary::Generic_SetSubjectiveTrait ( TScriptInterface< ISubjective >  Subjective, UScriptStruct *const  TraitType, const void *const  TraitData  )

inlinestatic

Generic_SetSubjectTrait()

static void UApparatusFunctionLibrary::Generic_SetSubjectTrait ( const FSubjectHandle &  SubjectHandle, UScriptStruct *const  TraitType, const void *const  TraitData  )

inlinestatic

GetChainDetail()

static UDetail * UApparatusFunctionLibrary::GetChainDetail ( UObject *  WorldContextObject, const int32  ChainId, TSubclassOf< UDetail >  DetailClass, AMechanism *  Mechanism = nullptr  )

inlinestatic

Get a detail from a current chain iteration.

Parameters

WorldContextObject	An object to get a world context from.
ChainId	The identifier of a chain to get from.
DetailClass	The class of the detail to get.
Mechanism	The specific mechanism to use.

Returns

The detail of the specified type.

GetChainDetailHinted()

static UDetail * UApparatusFunctionLibrary::GetChainDetailHinted ( UObject *  WorldContextObject, const int32  ChainId, TSubclassOf< UDetail >  DetailClass, const int32  DetailIndexHint, AMechanism *  Mechanism = nullptr  )

inlinestatic

Get a detail from a chain while hinting its index.

Parameters

WorldContextObject	An object to get a world context from.
ChainId	The identifier of a chain to iterate upon.
DetailClass	A class of the detail to get.
DetailIndexHint	The hinted index of the detail to get.
Mechanism	The explicit mechanism specification.

GetChainSubject()

static FSubjectHandle UApparatusFunctionLibrary::GetChainSubject ( UObject *  WorldContextObject, const int32  ChainId, AMechanism *  Mechanism = nullptr  )

inlinestatic

Get the current iteration's subject handle.

Parameters

WorldContextObject	An object to get a world context from.
ChainId	The identifier of a chain to iterate upon.
Mechanism	The explicit mechanism to use.

Returns

The subject handle of the current iteration.

GetChainSubjective()

static TScriptInterface< ISubjective > UApparatusFunctionLibrary::GetChainSubjective ( UObject *  WorldContextObject, const int32  ChainId, AMechanism *  Mechanism = nullptr  )

inlinestatic

Get the current iteration's subjective (if any).

Parameters

WorldContextObject	An object to get a world context from.
ChainId	The identifier of a chain to iterate upon.
Mechanism	An explicit mechanism specifier.

Returns

The subjective of the current iteration.

GetChainTrait()

static void UApparatusFunctionLibrary::GetChainTrait ( UObject *  WorldContextObject, const int32  ChainId, UScriptStruct *  TraitType, FGenericStruct &  OutTraitData, AMechanism *  Mechanism = nullptr  )

inlinestatic

Get an existing trait structure from the current chain cursor.

GetChainTraitHinted()

static void UApparatusFunctionLibrary::GetChainTraitHinted ( UObject *  WorldContextObject, const int32  ChainId, UScriptStruct *  TraitType, const int32  TraitIndex, FGenericStruct &  OutTraitData, AMechanism *  Mechanism = nullptr  )

inlinestatic

Get an existing trait structure from the current chain cursor with a specific index hinted.

GetFingerprintFlagmark()

static int32 UApparatusFunctionLibrary::GetFingerprintFlagmark ( const FFingerprint &  Fingerprint )

inlinestatic

Get fingerprint's flagmark.

GetInvalidSubjectHandle()

static FSubjectHandle UApparatusFunctionLibrary::GetInvalidSubjectHandle ( )

inlinestatic

Get the invalid subject handle constant.

GetObjectSubjective()

static TScriptInterface< ISubjective > UApparatusFunctionLibrary::GetObjectSubjective ( UObject *  Object )

inlinestatic

Get a subjective from an object.

This method is smart enough to search for subjective within an actor's components (if any).

Parameters

Object

The object to examine. If is an actor, its components are also examined.

Returns

The subjective derived from the object. Returns an invalid one if the search has failed.

GetSubjectConnectionPermit()

static UObject * UApparatusFunctionLibrary::GetSubjectConnectionPermit ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Get the server-side connection that is allowed to push traits to this subject.

Can only be queried on a server-side subject version.

Parameters

SubjectHandle

The subject to examine. Must be a valid handle.

Returns

The current connection permit.

GetSubjectFlagmark()

static int32 UApparatusFunctionLibrary::GetSubjectFlagmark ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Get the flagmark of the subject.

Parameters

SubjectHandle

The subject to examine. Must be a valid one.

Returns

The current flagmark of the subject.

GetSubjectHandles16At()

static FSubjectHandle UApparatusFunctionLibrary::GetSubjectHandles16At ( const FSubjectHandles16 &  SubjectHandles, const int32  Index  )

inlinestatic

Get a copy for a subject handle at a specified index.

GetSubjectHandles16Length()

static int32 UApparatusFunctionLibrary::GetSubjectHandles16Length ( FSubjectHandles16 &  SubjectHandles )

inlinestatic

Get the number of elements in the array.

GetSubjectHandles4At()

static FSubjectHandle UApparatusFunctionLibrary::GetSubjectHandles4At ( const FSubjectHandles4 &  SubjectHandles, const int32  Index  )

inlinestatic

Get a copy for a subject handle at a specified index.

GetSubjectHandles4Length()

static int32 UApparatusFunctionLibrary::GetSubjectHandles4Length ( FSubjectHandles4 &  SubjectHandles )

inlinestatic

Get the number of elements in the array.

GetSubjectHandles8At()

static FSubjectHandle UApparatusFunctionLibrary::GetSubjectHandles8At ( const FSubjectHandles8 &  SubjectHandles, const int32  Index  )

inlinestatic

Get a copy for a subject handle at a specified index.

GetSubjectHandles8Length()

static int32 UApparatusFunctionLibrary::GetSubjectHandles8Length ( FSubjectHandles8 &  SubjectHandles )

inlinestatic

Get the number of elements in the array.

GetSubjectiveActor()

static AActor * UApparatusFunctionLibrary::GetSubjectiveActor ( TScriptInterface< ISubjective >  Subjective )

inlinestatic

Get the actor of the subjective in question.

Parameters

Subjective

The subjective to examine. Must be valid.

GetSubjectiveComponent()

static USubjectiveActorComponent * UApparatusFunctionLibrary::GetSubjectiveComponent ( TScriptInterface< ISubjective >  Subjective )

inlinestatic

Cast subjective to an actor component.

GetSubjectiveConnectionPermit()

static UObject * UApparatusFunctionLibrary::GetSubjectiveConnectionPermit ( TScriptInterface< ISubjective >  Subjective )

inlinestatic

Get the server-side connection that is allowed to push to this subject.

Can only be queried on a server-side subjective version.

Parameters

Subjective

The subjective to examine. Must be a valid server-side subjective.

Returns

The current connection permit.

GetSubjectiveDetails()

void UApparatusFunctionLibrary::GetSubjectiveDetails ( TScriptInterface< ISubjective >  Subjective, TArray< UDetail * > &  OutDetails, const bool  bIncludeDisabled = false  )

inlinestatic

Get the current list of details in the subject.

GetSubjectiveFingerprint()

static void UApparatusFunctionLibrary::GetSubjectiveFingerprint ( TScriptInterface< ISubjective >  Subjective, FFingerprint &  OutFingerprint  )

inlinestatic

Get the current fingerprint of a subjective.

GetSubjectiveFlagmark()

static int32 UApparatusFunctionLibrary::GetSubjectiveFlagmark ( TScriptInterface< ISubjective >  Subjective )

inlinestatic

Get the flagmark of the subjective.

Unlike the subject version this is safe to be called during the construction script.

Parameters

Subjective

The subjective to examine. Must be a valid one.

Returns

The current flagmark of the subjective.

GetSubjectiveHandle()

static FSubjectHandle UApparatusFunctionLibrary::GetSubjectiveHandle ( TScriptInterface< ISubjective >  Subjective )

inlinestatic

Get the subject handle for a subjective.

If the subjective is not valid, returns an invalid subject handle.

Parameters

Subjective

The subjective to get a handle from.

Returns

A handle to a subjective's subject.

GetSubjectiveMechanism()

static AMechanism * UApparatusFunctionLibrary::GetSubjectiveMechanism ( TScriptInterface< ISubjective >  Subjective )

inlinestatic

Get the current mechanism of a subject.

Will return an invalid mechanism if the passed subject handle is invalid.

Parameters

Subjective

The subjective to examine. Must be a valid one.

Returns

The current mechanism of the subject.

GetSubjectivePreferredBelt()

static class UBelt * UApparatusFunctionLibrary::GetSubjectivePreferredBelt ( TScriptInterface< ISubjective >  Subjective )

inlinestatic

Get the preferred user-set belt.

Returns

The preferred belt of the subjective or null, if was not set.

GetSubjectiveTrait()

static void UApparatusFunctionLibrary::GetSubjectiveTrait ( TScriptInterface< ISubjective >  Subjective, UScriptStruct *  TraitType, FGenericStruct &  TraitData  )

inlinestatic

Get a trait from a subjective.

Parameters

Subjective	The subjective to get the trait from.
TraitType	The type of the trait to get.
TraitData	The trait got.

GetSubjectiveTraitmarkPermit()

static FTraitmark UApparatusFunctionLibrary::GetSubjectiveTraitmarkPermit ( TScriptInterface< ISubjective >  Subjective )

inlinestatic

Get the server-side list of traits allowed to be received from clients.

Can only be queried on a server-side subjective version.

Parameters

Subjective

The subjective to set for. Must be a valid server-side subjective.

Returns

The current traitmark permit whitelist.

GetSubjectiveWidget()

static UUserWidget * UApparatusFunctionLibrary::GetSubjectiveWidget ( TScriptInterface< ISubjective >  Subjective )

inlinestatic

Get the widget in question, if this subjective is actually an user widget.

GetSubjectMechanism()

static AMechanism * UApparatusFunctionLibrary::GetSubjectMechanism ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Get the current mechanism of a subject.

Will return an invalid mechanism if the passed subject handle is invalid.

Parameters

SubjectHandle

The subject to examine.

Returns

The current mechanism of the subject.

GetSubjectNetworkId()

static int64 UApparatusFunctionLibrary::GetSubjectNetworkId ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Get the unique network identifier of the subject.

Parameters

SubjectHandle

The subject to examine. Must be a valid handle.

GetSubjectSubjective()

static TScriptInterface< ISubjective > UApparatusFunctionLibrary::GetSubjectSubjective ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Get the subjective of the subject (if any).

GetSubjectTrait()

static void UApparatusFunctionLibrary::GetSubjectTrait ( const FSubjectHandle &  SubjectHandle, UScriptStruct *  TraitType, FGenericStruct &  TraitData  )

inlinestatic

Get a trait from a subject.

Parameters

SubjectHandle	The subject to get from.
TraitType	The type of the trait to get.
TraitData	The trait got.

GetSubjectTraitmarkPermit()

static FTraitmark UApparatusFunctionLibrary::GetSubjectTraitmarkPermit ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Get the server-side list of traits allowed to be received from clients.

Can only be queried on a server-side subject version.

Parameters

SubjectHandle

The subject to examine. Must be a valid handle.

Returns

The current traitmark permit whitelist.

HasSubjectDetail()

static bool UApparatusFunctionLibrary::HasSubjectDetail ( const FSubjectHandle &  SubjectHandle, TSubclassOf< UDetail >  DetailClass  )

inlinestatic

Check if the subject contains a detail.

HasSubjectFlag()

static bool UApparatusFunctionLibrary::HasSubjectFlag ( const FSubjectHandle &  SubjectHandle, const EFlagmarkBit  Flag = EFlagmarkBit::A  )

inlinestatic

Get the state of a flag of the subject.

Parameters

SubjectHandle	The subject to examine. Must be a valid one.
Flag	The flagmark bit to examine.

Returns

The state of the flag.

HasSubjectiveDetail()

static bool UApparatusFunctionLibrary::HasSubjectiveDetail ( TScriptInterface< ISubjective >  Subjective, TSubclassOf< UDetail >  DetailClass, const bool  bIncludeDisabled = false  )

inlinestatic

Check if the subjective contains a detail of a certain type.

HasSubjectiveFlag()

static bool UApparatusFunctionLibrary::HasSubjectiveFlag ( TScriptInterface< ISubjective >  Subjective, const EFlagmarkBit  Flag = EFlagmarkBit::A  )

inlinestatic

Get the state of a flag in the subjective.

Parameters

Subjective	The subjective to examine. Must be a valid one.
Flag	The flagmark bit to examine.

Returns

The state of the flag.

HasSubjectiveTrait()

static bool UApparatusFunctionLibrary::HasSubjectiveTrait ( TScriptInterface< ISubjective >  Subjective, UScriptStruct *  TraitType  )

inlinestatic

Check if the subjective contains a trait of a certain type.

Parameters

Subjective	The subjective to examine. Must be a valid one.
TraitType	The type of the trait to check for.

Returns

The state of examination.

HasSubjectTrait()

static bool UApparatusFunctionLibrary::HasSubjectTrait ( const FSubjectHandle &  SubjectHandle, UScriptStruct *  TraitType  )

inlinestatic

Check if the subject contains a trait of a certain type.

Parameters

SubjectHandle	The subject to examine. Must be a valid handle.
TraitType	The trait type to check for.

Returns

The result of examination.

IsSubjectClientSide()

static bool UApparatusFunctionLibrary::IsSubjectClientSide ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Check if the subject is client-side.

A subject must be both online and be part of a client world in order to be considered client-side.

Parameters

SubjectHandle

The subject to examine. Must be a valid handle.

IsSubjectHandleValid()

static bool UApparatusFunctionLibrary::IsSubjectHandleValid ( FSubjectHandle &  SubjectHandle )

inlinestatic

Check if the subject handle is a valid one.

IsSubjectOnline()

static bool UApparatusFunctionLibrary::IsSubjectOnline ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Check if the subject is online.

Examines if a subject was brought online and is currently networked.

Parameters

SubjectHandle

The subject to examine. Must be a valid handle.

IsSubjectServerSide()

static bool UApparatusFunctionLibrary::IsSubjectServerSide ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Check if the subject is server-side.

A subject must be both online and be part of a server world in order to be considered server-side.

Parameters

SubjectHandle

The subject to examine. Must be a valid handle.

MakeCachedFilter0()

static FFilter UApparatusFunctionLibrary::MakeCachedFilter0 ( const FString &  Key, const int32  Flagmark  )

inlinestatic

Make a cached filter with 0 components;.

MakeCachedFilter1()

static FFilter UApparatusFunctionLibrary::MakeCachedFilter1 ( const FString &  Key, UScriptStruct *  Trait_0, TSubclassOf< UDetail >  Detail_0, UScriptStruct *  ExcludedTrait_0, TSubclassOf< UDetail >  ExcludedDetail_0, const int32  Flagmark  )

inlinestatic

Make a cached filter with 1 component;.

MakeCachedFilter2()

static FFilter UApparatusFunctionLibrary::MakeCachedFilter2 ( const FString &  Key, UScriptStruct *  Trait_0, UScriptStruct *  Trait_1, TSubclassOf< UDetail >  Detail_0, TSubclassOf< UDetail >  Detail_1, UScriptStruct *  ExcludedTrait_0, UScriptStruct *  ExcludedTrait_1, TSubclassOf< UDetail >  ExcludedDetail_0, TSubclassOf< UDetail >  ExcludedDetail_1, const int32  Flagmark  )

inlinestatic

Make a cached filter with 2 components;.

MakeCachedFilter4()

static FFilter UApparatusFunctionLibrary::MakeCachedFilter4 ( const FString &  Key, UScriptStruct *  Trait_0, UScriptStruct *  Trait_1, UScriptStruct *  Trait_2, UScriptStruct *  Trait_3, TSubclassOf< UDetail >  Detail_0, TSubclassOf< UDetail >  Detail_1, TSubclassOf< UDetail >  Detail_2, TSubclassOf< UDetail >  Detail_3, UScriptStruct *  ExcludedTrait_0, UScriptStruct *  ExcludedTrait_1, UScriptStruct *  ExcludedTrait_2, UScriptStruct *  ExcludedTrait_3, TSubclassOf< UDetail >  ExcludedDetail_0, TSubclassOf< UDetail >  ExcludedDetail_1, TSubclassOf< UDetail >  ExcludedDetail_2, TSubclassOf< UDetail >  ExcludedDetail_3, const int32  Flagmark  )

inlinestatic

Make a cached filter with 4 components;.

MakeCachedFilter8()

static FFilter UApparatusFunctionLibrary::MakeCachedFilter8 ( const FString &  Key, UScriptStruct *  Trait_0, UScriptStruct *  Trait_1, UScriptStruct *  Trait_2, UScriptStruct *  Trait_3, UScriptStruct *  Trait_4, UScriptStruct *  Trait_5, UScriptStruct *  Trait_6, UScriptStruct *  Trait_7, TSubclassOf< UDetail >  Detail_0, TSubclassOf< UDetail >  Detail_1, TSubclassOf< UDetail >  Detail_2, TSubclassOf< UDetail >  Detail_3, TSubclassOf< UDetail >  Detail_4, TSubclassOf< UDetail >  Detail_5, TSubclassOf< UDetail >  Detail_6, TSubclassOf< UDetail >  Detail_7, UScriptStruct *  ExcludedTrait_0, UScriptStruct *  ExcludedTrait_1, UScriptStruct *  ExcludedTrait_2, UScriptStruct *  ExcludedTrait_3, UScriptStruct *  ExcludedTrait_4, UScriptStruct *  ExcludedTrait_5, UScriptStruct *  ExcludedTrait_6, UScriptStruct *  ExcludedTrait_7, TSubclassOf< UDetail >  ExcludedDetail_0, TSubclassOf< UDetail >  ExcludedDetail_1, TSubclassOf< UDetail >  ExcludedDetail_2, TSubclassOf< UDetail >  ExcludedDetail_3, TSubclassOf< UDetail >  ExcludedDetail_4, TSubclassOf< UDetail >  ExcludedDetail_5, TSubclassOf< UDetail >  ExcludedDetail_6, TSubclassOf< UDetail >  ExcludedDetail_7, const int32  Flagmark  )

inlinestatic

Make a cached filter with 8 components;.

MakeDefaultTraitRecord()

static void UApparatusFunctionLibrary::MakeDefaultTraitRecord ( UScriptStruct *  TraitType, FTraitRecord &  OutTraitRecord  )

inlinestatic

Make a default-filled trait record.

Parameters

TraitType	The type of trait to create.
OutTraitRecord	The trait record to output to.

MakeDetailmark()

FDetailmark UApparatusFunctionLibrary::MakeDetailmark ( const TArray< TSubclassOf< UDetail > > &  Details )

inlinestatic

Make a detailmark from a list of detail classes.

MakeFilter()

FFilter UApparatusFunctionLibrary::MakeFilter ( const TArray< UScriptStruct * > &  Traits, const TArray< TSubclassOf< UDetail > > &  Details, const TArray< UScriptStruct * > &  ExcludedTraits, const TArray< TSubclassOf< UDetail > > &  ExcludedDetails, const int32  Flagmark = 0x2, const int32  ExcludingFlagmark = 0x1  )

inlinestatic

Make a filter from the list of details, exclusion details, and a boot filter.

MakeFingerprint()

FFingerprint UApparatusFunctionLibrary::MakeFingerprint ( const TArray< UScriptStruct * > &  Traits, const TArray< TSubclassOf< UDetail > > &  Details, const int32  Flagmark  )

inlinestatic

Make a fingerprint.

MakeTraitmark()

FTraitmark UApparatusFunctionLibrary::MakeTraitmark ( const TArray< UScriptStruct * > &  Traits )

inlinestatic

Make a traitmark from a list of trait types.

MakeTraitRecord()

static void UApparatusFunctionLibrary::MakeTraitRecord ( UScriptStruct *  TraitType, const FGenericStruct &  TraitData, FTraitRecord &  OutTraitRecord  )

inlinestatic

Make a trait record.

Parameters

TraitType	The type of trait to create.
TraitData	The trait data to fill with.
OutTraitRecord	The trait record to output to.

MechanismEnchain()

void UApparatusFunctionLibrary::MechanismEnchain ( UObject *  WorldContextObject, const FFilter &  Filter, int32 &  OutChainId, AMechanism *  Mechanism = nullptr  )

inlinestatic

Enchain multiple iterable sequences (chunks or belts) based on a filter.

Parameters

WorldContextObject	An object to get a world context from.
Filter	A filter to enchain under.
OutChainId	The output chain identifier.
Mechanism	The explicit mechanism to use.

MechanismEnchainBooted()

void UApparatusFunctionLibrary::MechanismEnchainBooted ( UObject *  WorldContextObject, FFilter &  Filter, int32 &  OutChainId, AMechanism *  Mechanism = nullptr  )

inlinestatic

MechanismEnchainHalted()

void UApparatusFunctionLibrary::MechanismEnchainHalted ( UObject *  WorldContextObject, FFilter &  Filter, int32 &  OutChainId, AMechanism *  Mechanism = nullptr  )

inlinestatic

ObtainSubjectiveTrait()

static void UApparatusFunctionLibrary::ObtainSubjectiveTrait ( TScriptInterface< ISubjective >  Subjective, UScriptStruct *  TraitType, FGenericStruct &  TraitData  )

inlinestatic

Obtain a trait from a subjective.

Parameters

Subjective	The subjective to obtain a trait from.
TraitType	The type of the trait to obtain.
TraitData	The obtained trait.

ObtainSubjectTrait()

static void UApparatusFunctionLibrary::ObtainSubjectTrait ( const FSubjectHandle &  SubjectHandle, UScriptStruct *  TraitType, FGenericStruct &  TraitData  )

inlinestatic

Obtain a trait from a subject.

Parameters

SubjectHandle	The subject to obtain the trait from.
TraitType	The type of trait to obtain.
TraitData	The obtained trait.

PushExtraSubjectiveTrait()

static void UApparatusFunctionLibrary::PushExtraSubjectiveTrait ( TScriptInterface< ISubjective >  Subjective, UScriptStruct *  TraitType, const FGenericStruct &  TraitData, const bool  bSetForLocal = false, const EPeerRole  PeerRole = EPeerRole::None, const bool  bReliable = true  )

inlinestatic

Push an additional trait to an online subjective.

The client must own the subjective.

Parameters

Subjective	The subjective to push the trait to.
TraitType	The type of the trait to push.
TraitData	The trait to push.
bSetForLocal	Also set the trait for the local version.
PeerRole	The explicit peer role specification. This may needed to be specified when on a listen server mode and you want to push traits to the clients that are also in the traitmark permit.
bReliable	Should reliable channel be used for the transaction.

PushExtraSubjectTrait()

static void UApparatusFunctionLibrary::PushExtraSubjectTrait ( const FSubjectHandle &  SubjectHandle, UScriptStruct *  TraitType, const FGenericStruct &  TraitData, const bool  bSetForLocal = false, const EPeerRole  PeerRole = EPeerRole::None, const bool  bReliable = true  )

inlinestatic

Push an additional trait structure to the clients version of the online subject.

Parameters

SubjectHandle	A handle for the subject to push to.
TraitType	The type of the trait to push.
TraitData	The data of the trait to push.
bSetForLocal	Also set the trait for the local version.
PeerRole	The explicit peer role specification. This may needed to be specified when on a listen server mode and you want to push traits to the clients that are also in the traitmark permit.
bReliable	Should reliable channel be used for a transaction.

PushExtraSubjectTraitThroughBearer()

static void UApparatusFunctionLibrary::PushExtraSubjectTraitThroughBearer ( UNetworkBearerComponent *  NetworkBearer, const FSubjectHandle &  SubjectHandle, UScriptStruct *  TraitType, const FGenericStruct &  TraitData, const bool  bReliable = true  )

static

Push an additional trait to a remote version of the subject through the bearer.

This function may be used to send a trait to a single specific client only. The subject will be brought online automatically if needed.

Parameters

NetworkBearer	The network bearer to push through.
SubjectHandle	The subject to push the trait for.
TraitType	The type of the trait to push. Must not be a null.
TraitData	The data of the trait to push. Must not e a null.
bReliable	Should reliable channel be used.

PushSubjectiveTrait()

static void UApparatusFunctionLibrary::PushSubjectiveTrait ( TScriptInterface< ISubjective >  Subjective, UScriptStruct *  TraitType, const EPeerRole  PeerRole = EPeerRole::None, const bool  bReliable = true  )

inlinestatic

Push an existing trait to an online subjective.

The client must own the subjective.

Parameters

Subjective	The subjective to push the trait to.
TraitType	The type of the trait to push.
PeerRole	The explicit peer role specification. This may needed to be specified when on a listen server mode and you want to push traits to the clients that are also in the traitmark permit.
bReliable	Should reliable channel be used for the transaction.

PushSubjectTrait()

static void UApparatusFunctionLibrary::PushSubjectTrait ( const FSubjectHandle &  SubjectHandle, UScriptStruct *  TraitType, const EPeerRole  PeerRole = EPeerRole::None, const bool  bReliable = true  )

inlinestatic

Push an existing trait structure to the clients version of the online subject.

Parameters

SubjectHandle	A handle for the subject to push to.
TraitType	The type of the trait to push.
PeerRole	The explicit peer role specification. This may needed to be specified when on a listen server mode and you want to push traits to the clients that are also in the traitmark permit.
bReliable	Should reliable channel be used for a transaction.

PushSubjectTraitThroughBearer()

static void UApparatusFunctionLibrary::PushSubjectTraitThroughBearer ( UNetworkBearerComponent *  NetworkBearer, const FSubjectHandle &  SubjectHandle, UScriptStruct *  TraitType, const bool  bReliable = true  )

inlinestatic

Push an existing trait to a remote version of the subject through the bearer.

This function may be used to send a trait to a single specific client only. The subject will be brought online automatically if needed.

Parameters

NetworkBearer	The network bearer to push through.
SubjectHandle	The subject to push the trait for.
TraitType	The type of the trait to push. Must not be a null.
bReliable	Should reliable channel be used.

RemoveAllSubjectTraits()

static void UApparatusFunctionLibrary::RemoveAllSubjectTraits ( const FSubjectHandle &  SubjectHandle )

inlinestatic

Remove all traits from a subject.

Parameters

SubjectHandle

The subject to remove the traits from. Must be a valid handle.

RemoveDetailFromFingerprint()

FFingerprint & UApparatusFunctionLibrary::RemoveDetailFromFingerprint ( FFingerprint &  Fingerprint, const TSubclassOf< UDetail >  DetailClass  )

inlinestatic

Remove a detail class from a fingerprint.

RemoveFromSubjectHandles16()

void UApparatusFunctionLibrary::RemoveFromSubjectHandles16 ( FSubjectHandles16 &  SubjectHandles, FSubjectHandle  SubjectHandle  )

inlinestatic

Remove a subject handle from the array.

RemoveFromSubjectHandles4()

void UApparatusFunctionLibrary::RemoveFromSubjectHandles4 ( FSubjectHandles4 &  SubjectHandles, FSubjectHandle  SubjectHandle  )

inlinestatic

Remove a subject handle from the array.

RemoveFromSubjectHandles8()

void UApparatusFunctionLibrary::RemoveFromSubjectHandles8 ( FSubjectHandles8 &  SubjectHandles, FSubjectHandle  SubjectHandle  )

inlinestatic

Remove a subject handle from the array.

RemoveSubjectiveTrait()

static void UApparatusFunctionLibrary::RemoveSubjectiveTrait ( TScriptInterface< ISubjective >  Subjective, UScriptStruct *  TraitType  )

inlinestatic

Remove a trait from the subjective.

Parameters

Subjective	The subjective to remove a trait from. Must be a valid one.
TraitType	The type of the trait to remove.

RemoveSubjectTrait()

static void UApparatusFunctionLibrary::RemoveSubjectTrait ( const FSubjectHandle &  SubjectHandle, UScriptStruct *  TraitType  )

inlinestatic

Remove a trait from the subject.

Parameters

SubjectHandle	The subject to remove a trait from.
TraitType	The type of trait to remove.

ResetSubjectHandle()

static void UApparatusFunctionLibrary::ResetSubjectHandle ( FSubjectHandle &  SubjectHandle )

inlinestatic

Reset the subject handle, making it invalid.

The subject itself won't be despawned though.

SetSubjectConnectionPermit()

static void UApparatusFunctionLibrary::SetSubjectConnectionPermit ( const FSubjectHandle &  SubjectHandle, UObject *  InConnectionPermit  )

inlinestatic

Set the server-side connection from which it is allowed to push to this subject.

Can only be set for a server-side subject version.

Parameters

SubjectHandle	The subject to set for. Must be a valid handle.
InConnectionPermit	The object to derive the connection from. May be an actor.

SetSubjectFlag()

static void UApparatusFunctionLibrary::SetSubjectFlag ( const FSubjectHandle &  SubjectHandle, const EFlagmarkBit  Flag = EFlagmarkBit::A, bool  bState = true  )

inlinestatic

Set/clear the flag of the subject.

Parameters

SubjectHandle	The subject handle to set for. Must be a valid one.
Flag	The flagmark bit to set. You are not allowed to use system flags like Booted and Online here.
bState	The flag state to set to.

SetSubjectFlagmark()

static void UApparatusFunctionLibrary::SetSubjectFlagmark ( const FSubjectHandle &  SubjectHandle, const int32  Flagmark = 0x0  )

inlinestatic

Set the flagmark of a subject.

Parameters

SubjectHandle	The subject to change. Must be a valid one.
Flagmark	The flagmark to set. You are not allowed to use system flags like Booted and Online here.

SetSubjectHandles16At()

static void UApparatusFunctionLibrary::SetSubjectHandles16At ( FSubjectHandles16 &  SubjectHandles, const int32  Index, const FSubjectHandle &  SubjectHandle  )

inlinestatic

Set a subject handle at a specified index of the array.

SetSubjectHandles4At()

static void UApparatusFunctionLibrary::SetSubjectHandles4At ( FSubjectHandles4 &  SubjectHandles, const int32  Index, const FSubjectHandle &  SubjectHandle  )

inlinestatic

Set a subject handle at a specified index of the array.

SetSubjectHandles8At()

static void UApparatusFunctionLibrary::SetSubjectHandles8At ( FSubjectHandles8 &  SubjectHandles, const int32  Index, const FSubjectHandle &  SubjectHandle  )

inlinestatic

Set a subject handle at a specified index of the array.

SetSubjectiveConnectionPermit()

static void UApparatusFunctionLibrary::SetSubjectiveConnectionPermit ( TScriptInterface< ISubjective >  Subjective, UObject *  InConnectionPermit  )

inlinestatic

Set the server-side connection that is allowed to push to this subjective.

Can only be set for a server-side subjective version.

Parameters

Subjective	The subjective to set for. Must be a valid server-side subjective.
InConnectionPermit	The object to derive the connection from. May be an actor.

SetSubjectiveFlag()

static void UApparatusFunctionLibrary::SetSubjectiveFlag ( TScriptInterface< ISubjective >  Subjective, const EFlagmarkBit  Flag = EFlagmarkBit::A, bool  bState = true  )

inlinestatic

Set/clear a flag of the subjective.

You are not allowed to set any of the system-level flags.

Unlike subject-based version this is safe to be used during the construction script.

Parameters

Subjective	The subjective to change. Must be a valid one.
Flag	The flagmark bit to set. You are not allowed to use system flags like Booted and Online here.
bState	The flag state to set to.

SetSubjectiveFlagmark()

static void UApparatusFunctionLibrary::SetSubjectiveFlagmark ( TScriptInterface< ISubjective >  Subjective, const int32  Flagmark = 0x0  )

inlinestatic

Set the flagmark of the subjective.

Unlike the subject version this is safe to be called during the construction script.

Parameters

Subjective	The subjective to change. Must be a valid one.
Flagmark	The flagmark to set. You are not allowed to use system-level flags here.

SetSubjectiveMechanism()

static void UApparatusFunctionLibrary::SetSubjectiveMechanism ( TScriptInterface< ISubjective >  Subjective, AMechanism *  Mechanism  )

inlinestatic

Set the mechanism of a subjective.

Move the subjective to a (new) mechanism. The subject part (if any) gets moved to a new mechanism's belt as well. This method can be called during construction phase in order to override the spawning mechanism.

Parameters

Subjective	The subjective to transition. Must be valid.
Mechanism	The mechanism to move the subjective to. Must be valid.

SetSubjectiveTrait()

static void UApparatusFunctionLibrary::SetSubjectiveTrait ( TScriptInterface< ISubjective >  Subjective, UScriptStruct *  TraitType, const FGenericStruct &  TraitData  )

inlinestatic

Set a trait structure for a subjective.

Parameters

Subjective	The subjective to set the trait for.
TraitType	The type of trait to set.
TraitData	The trait to set.

SetSubjectiveTraitmarkPermit()

static void UApparatusFunctionLibrary::SetSubjectiveTraitmarkPermit ( TScriptInterface< ISubjective >  Subjective, const FTraitmark &  InTraitmarkPass  )

inlinestatic

Set the list of traits allowed to be received from clients on the server.

Can only be set for a server-side subject.

Note

The traitmark permit is also used to auto-detect the peer role during the trait pushing on a listen-server, i.e. if a trait is included within the permit the role is considered to be a client. This, of course, can be overriden by an explicit peer role specification during the push.

Parameters

Subjective	The subjective to set for. Must be a valid server-side subjective.
InTraitmarkPass	The new traitmark to be used as a whitelist.

SetSubjectMechanism()

static void UApparatusFunctionLibrary::SetSubjectMechanism ( FSubjectHandle &  SubjectHandle, AMechanism *  Mechanism  )

inlinestatic

Set the mechanism of a subject.

Move the subject to a (new) mechanism. The subjective part (if any) gets moved to a new mechanism's belt as well.

Parameters

SubjectHandle	The subject to transition. Must be valid.
Mechanism	The mechanism to move the subject to. Must be valid.

SetSubjectTrait()

static void UApparatusFunctionLibrary::SetSubjectTrait ( const FSubjectHandle &  SubjectHandle, UScriptStruct *  TraitType, const FGenericStruct &  TraitData  )

inlinestatic

Set a trait for a subject.

Parameters

SubjectHandle	The subject to set a trait for.
TraitType	The type of the trait to set.
TraitData	The trait to set.

SetSubjectTraitmarkPermit()

static void UApparatusFunctionLibrary::SetSubjectTraitmarkPermit ( const FSubjectHandle &  SubjectHandle, const FTraitmark &  InTraitmarkPass  )

inlinestatic

Set the list of traits allowed to be received from clients on the server.

Can only be set for a server-side subject.

Note

The traitmark permit is also used to auto-detect the peer role during the trait pushing on a listen-server, i.e. if a trait is included within the permit the role is considered to be a client. This, of course, can be overriden by an explicit peer role specification during the push.

Parameters

SubjectHandle	The subject to set for. Must be a valid handle.
InTraitmarkPass	The traitmark to be used as a whitelist.

SpawnMachineSubject()

static void UApparatusFunctionLibrary::SpawnMachineSubject ( UObject *  WorldContextObject, const int32  Flagmark, FSubjectHandle &  OutSubjectHandle, AMechanism *  Mechanism = nullptr  )

inlinestatic

Spawn a new subject within a machine.

This function may not be used in the construction scripts.

Parameters

WorldContextObject	An object for the world context.
Flagmark	The initial flagmark to spawn with. You are not allowed to use system flags like Booted and Online here.
OutSubjectHandle	The resulting subject handle.
Mechanism	The explicit mechanism specification.

SpawnMachineSubjectFromRecord()

static FSubjectHandle UApparatusFunctionLibrary::SpawnMachineSubjectFromRecord ( UObject *  WorldContextObject, const FSubjectRecord &  Record, AMechanism *  Mechanism = nullptr  )

inlinestatic

Spawn a new subject based on a record.

This function may not be used in the construction scripts.

Parameters

WorldContextObject	An object for the world context.
Record	The subject record to clone.
Mechanism	The explicit mechanism to use.

Returns

The resulting handle.

ToggleSubjectFlag()

static bool UApparatusFunctionLibrary::ToggleSubjectFlag ( const FSubjectHandle &  SubjectHandle, const EFlagmarkBit  Flag = EFlagmarkBit::A  )

inlinestatic

Toggle the flag of the subject.

Parameters

SubjectHandle	The subject handle to change for. Must be a valid one.
Flag	The flagmark bit to toggle. You are not allowed to use system flags like Booted and Online here.

Returns

The new state of the flag.

ToggleSubjectiveFlag()

static void UApparatusFunctionLibrary::ToggleSubjectiveFlag ( TScriptInterface< ISubjective >  Subjective, const EFlagmarkBit  Flag = EFlagmarkBit::A  )

inlinestatic

Toggle a flag of the subjective.

You are not allowed to change any of the system-level flags.

Unlike subject-based version this is safe to be used during the construction script.

Parameters

Subjective	The subjective to change. Must be a valid one.
Flag	The flag bit to change. You are not allowed to use system flags like Booted and Online here.

---

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

• ApparatusFunctionLibrary.h