#include <ArticyGlobalVariables.h>

Inheritance diagram for UArticyGlobalVariables:

Public Member Functions
virtual FPrimaryAssetId	GetPrimaryAssetId () const override
void	UnloadGlobalVariables ()
UArticyBaseVariableSet *	GetNamespace (const FName Namespace)
const TArray< UArticyBaseVariableSet * >	GetVariableSets () const
void	PrintGlobalVariable (FArticyGvName GvName)
const bool &	GetBoolVariable (FArticyGvName GvName, bool &bSucceeded)
const int32 &	GetIntVariable (FArticyGvName GvName, bool &bSucceeded)
const FString &	GetStringVariable (FArticyGvName GvName, bool &bSucceeded)
void	SetBoolVariable (FArticyGvName GvName, const bool Value)
void	SetIntVariable (FArticyGvName GvName, const int32 Value)
void	SetStringVariable (FArticyGvName GvName, const FString Value)
void	EnableDebugLogging ()
void	DisableDebugLogging ()
void	ResetVisited ()
int	GetSeenCounter (const IArticyFlowObject *Object) const
int	SetSeenCounter (const IArticyFlowObject *Object, int Value)
int	IncrementSeenCounter (const IArticyFlowObject *Object)
bool	Fallback (const IArticyFlowObject *Object)
void	SetFallbackEvaluation (const IArticyFlowObject *Object, bool Value)
void	PushSeen ()
void	PopSeen ()
Public Member Functions inherited from IShadowStateManager
template<typename LambdaType>
FDelegateHandle	RegisterOnPopState (LambdaType Lambda)
void	UnregisterOnPopState (FDelegateHandle Delegate)
uint32	GetShadowLevel () const
Public Member Functions inherited from IArticyReflectable
template<typename TValue>
TValue	SetProp (FName Property, TValue Value, int32 ArrayIndex=0)
template<typename TValue>
TValue &	GetProp (FName Property, int32 ArrayIndex=0)
template<typename TValue>
const TValue &	GetProp (FName Property, int32 ArrayIndex=0) const
template<typename TValue>
TValue *	GetPropPtr (FName Property, int32 ArrayIndex=0) const
FProperty *	GetProperty (FName Property) const
virtual UClass *	GetObjectClass () const

Static Public Member Functions
static UArticyGlobalVariables *	GetDefault (const UObject *WorldContext)
static UArticyGlobalVariables *	GetMutableOriginal ()
static UArticyGlobalVariables *	GetRuntimeClone (const UObject WorldContext, UArticyAlternativeGlobalVariables GVs)
Static Public Member Functions inherited from IArticyReflectable
static bool	HasProperty (const UClass *Class, const FName &Property)

Protected Attributes
TArray< UArticyBaseVariableSet * >	VariableSets
bool	bLogVariableAccess = false

Additional Inherited Members
Public Attributes inherited from IArticyReflectable
FReportChangedDelegate	ReportChanged

Detailed Description

The base class for the (generated) ArticyGlobalVariables class.

Member Function Documentation

◆ DisableDebugLogging()

void UArticyGlobalVariables::DisableDebugLogging ( )

Disables debug logging for global variable access.

◆ EnableDebugLogging()

void UArticyGlobalVariables::EnableDebugLogging ( )

Enables debug logging for global variable access.

◆ Fallback()

bool UArticyGlobalVariables::Fallback ( const IArticyFlowObject * Object )

Checks if a fallback evaluation is active for a specific object.

Parameters

Object The object to query.

Returns: True if fallback evaluation is active, otherwise false.

◆ GetBoolVariable()

const bool & UArticyGlobalVariables::GetBoolVariable	(	FArticyGvName	GvName,
		bool &	bSucceeded )

Retrieves a boolean variable's value by name.

Parameters

GvName	The name of the global variable.
bSucceeded	Indicates whether the retrieval was successful.

Returns: The value of the boolean variable.

◆ GetDefault()

UArticyGlobalVariables * UArticyGlobalVariables::GetDefault ( const UObject * WorldContext )

static

Get a reference to the ArticyGlobalVariables asset. Creates a temporary copy if the

Retrieves the default global variables object, creating a clone if necessary.

Parameters

WorldContext The context within which the object is retrieved.

Returns: A pointer to the default UArticyGlobalVariables object.

◆ GetIntVariable()

const int32 & UArticyGlobalVariables::GetIntVariable	(	FArticyGvName	GvName,
		bool &	bSucceeded )

Retrieves an integer variable's value by name.

Parameters

GvName	The name of the global variable.
bSucceeded	Indicates whether the retrieval was successful.

Returns: The value of the integer variable.

◆ GetMutableOriginal()

UArticyGlobalVariables * UArticyGlobalVariables::GetMutableOriginal ( )

static

Retrieves the mutable original global variables object.

Returns: A pointer to the original UArticyGlobalVariables object.

◆ GetNamespace()

UArticyBaseVariableSet * UArticyGlobalVariables::GetNamespace ( const FName Namespace )

Retrieves a namespace variable set by name.

Parameters

Namespace The name of the namespace.

Returns: A pointer to the UArticyBaseVariableSet object.

◆ GetRuntimeClone()

UArticyGlobalVariables * UArticyGlobalVariables::GetRuntimeClone	(	const UObject *	WorldContext,
		UArticyAlternativeGlobalVariables *	GVs )

static

Returns a runtime clone of a non-default global variable set. Used by ArticyFlowPlayer if OverrideGV is set (this way we're not modifying the asset itself)

Retrieves a runtime clone of non-default global variables.

Parameters

WorldContext	The context within which the object is retrieved.
GVs	Alternative global variables to clone.

Returns: A pointer to the cloned UArticyGlobalVariables object.

◆ GetSeenCounter()

int UArticyGlobalVariables::GetSeenCounter ( const IArticyFlowObject * Object ) const

Gets the seen counter for a specific object.

Parameters

Object The object to query.

Returns: The seen counter value.

◆ GetStringVariable()

const FString & UArticyGlobalVariables::GetStringVariable	(	FArticyGvName	GvName,
		bool &	bSucceeded )

Retrieves a string variable's value by name.

Parameters

GvName	The name of the global variable.
bSucceeded	Indicates whether the retrieval was successful.

Returns: The value of the string variable.

◆ IncrementSeenCounter()

int UArticyGlobalVariables::IncrementSeenCounter ( const IArticyFlowObject * Object )

Increments the seen counter for a specific object.

Parameters

Object The object to modify.

Returns: The updated seen counter value.

◆ PopSeen()

void UArticyGlobalVariables::PopSeen ( )

Pops the current seen state from the stack.

◆ PrintGlobalVariable()

void UArticyGlobalVariables::PrintGlobalVariable ( FArticyGvName GvName )

Prints the value of a global variable.

Parameters

GvName The name of the global variable.

◆ PushSeen()

void UArticyGlobalVariables::PushSeen ( )

Pushes the current seen state onto the stack.

◆ ResetVisited()

void UArticyGlobalVariables::ResetVisited ( )

Resets the visited state for all nodes.

◆ SetBoolVariable()

void UArticyGlobalVariables::SetBoolVariable	(	FArticyGvName	GvName,
		const bool	Value )

Sets a boolean variable's value by name.

Parameters

GvName	The name of the global variable.
Value	The new value to set.

◆ SetFallbackEvaluation()

void UArticyGlobalVariables::SetFallbackEvaluation	(	const IArticyFlowObject *	Object,
		bool	Value )

Sets the fallback evaluation state for a specific object.

Parameters

Object	The object to modify.
Value	The new fallback evaluation state.

◆ SetIntVariable()

void UArticyGlobalVariables::SetIntVariable	(	FArticyGvName	GvName,
		const int32	Value )

Sets an integer variable's value by name.

Parameters

GvName	The name of the global variable.
Value	The new value to set.

◆ SetSeenCounter()

int UArticyGlobalVariables::SetSeenCounter	(	const IArticyFlowObject *	Object,
		int	Value )

Sets the seen counter for a specific object.

Parameters

Object	The object to modify.
Value	The new seen counter value.

Returns: The updated seen counter value.

◆ SetStringVariable()

void UArticyGlobalVariables::SetStringVariable	(	FArticyGvName	GvName,
		const FString	Value )

Sets a string variable's value by name.

Parameters

GvName	The name of the global variable.
Value	The new value to set.

◆ UnloadGlobalVariables()

void UArticyGlobalVariables::UnloadGlobalVariables ( )

Unloads the global variables, removing all changes.

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

Source/ArticyRuntime/Public/ArticyGlobalVariables.h
Source/ArticyRuntime/Private/ArticyGlobalVariables.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DisableDebugLogging()

◆ EnableDebugLogging()

◆ Fallback()

◆ GetBoolVariable()

◆ GetDefault()

◆ GetIntVariable()

◆ GetMutableOriginal()

◆ GetNamespace()

◆ GetRuntimeClone()

◆ GetSeenCounter()

◆ GetStringVariable()

◆ IncrementSeenCounter()

◆ PopSeen()

◆ PrintGlobalVariable()

◆ PushSeen()

◆ ResetVisited()

◆ SetBoolVariable()

◆ SetFallbackEvaluation()

◆ SetIntVariable()

◆ SetSeenCounter()

◆ SetStringVariable()

◆ UnloadGlobalVariables()