#include <ArticyFunctionLibrary.h>

Inheritance diagram for UArticyFunctionLibrary:

Public Member Functions
	UFUNCTION (BlueprintPure, meta=(DisplayName="Equal (ArticyId)", CompactNodeTitle="==", Keywords="== equal"), Category="ArticyId") static bool ArticyId_Equal(const FArticyId &A
	UFUNCTION (BlueprintPure, meta=(DisplayName="Not Equal (ArticyId)", CompactNodeTitle="!=", Keywords="!= not equal"), Category="ArticyId") static bool ArticyId_NotEqual(const FArticyId &A

Static Public Member Functions
static UArticyObject *	ArticyRef_GetObject (FArticyRef Ref, TSubclassOf< class UArticyObject > CastTo, const UObject *WorldContext)
static void	ArticyRef_SetObject (UPARAM(Ref) FArticyRef &Ref, UPARAM(Ref) UArticyObject *Object)
static FArticyId	ArticyRef_GetObjectId (FArticyRef Ref)
static void	ArticyRef_SetObjectId (UPARAM(Ref) FArticyRef &Ref, UPARAM(Ref) FArticyId Id)
static bool	MatchesRaw (const FArticyRef &A, const FArticyRef &B)
static bool	MatchesEffective (const FArticyRef &A, const FArticyRef &B)
static UArticyObject *	ArticyId_GetObject (FArticyId Id, TSubclassOf< class UArticyObject > CastTo, const UObject *WorldContext)
static FArticyId	ArticyId_FromString (UPARAM(Ref) const FString &hex)
static FString	ArticyId_ToString (UPARAM(Ref) const FArticyId &Id)
static bool	ArticyId_IsValid (const FArticyId &Id)
static FArticyGvName	ArticyGvName_MakeFromFullName (const FName &FullName)
static FArticyGvName	ArticyGvName_MakeFromVariableAndNamespace (const FName &Variable, const FName &Namespace)
static TScriptInterface< class IArticyFlowObject >	GetBranchTarget (UPARAM(ref) const struct FArticyBranch &Branch)
static int	GetNodeSeenCounter (TScriptInterface< class IArticyFlowObject > Node, const UObject *WorldContext)
static int	SetNodeSeenCounter (TScriptInterface< class IArticyFlowObject > Node, int Value, const UObject *WorldContext)

Public Attributes
const FArticyId &	B

Detailed Description

Function library for handling Articy objects and IDs in Unreal Engine.

Member Function Documentation

◆ ArticyGvName_MakeFromFullName()

FArticyGvName UArticyFunctionLibrary::ArticyGvName_MakeFromFullName ( const FName & FullName )

static

Creates an ArticyGvName from a full name.

Parameters

FullName The full name to use.

Returns: The corresponding ArticyGvName.

◆ ArticyGvName_MakeFromVariableAndNamespace()

FArticyGvName UArticyFunctionLibrary::ArticyGvName_MakeFromVariableAndNamespace	(	const FName &	Variable,
		const FName &	Namespace )

static

Creates an ArticyGvName from a variable and namespace.

Parameters

Variable	The variable name.
Namespace	The namespace name.

Returns: The corresponding ArticyGvName.

◆ ArticyId_FromString()

FArticyId UArticyFunctionLibrary::ArticyId_FromString ( UPARAM(Ref) const FString & hex )

static

Creates an ArticyId from a hex string.

Parameters

hex	The hex string to convert.

Returns: The ArticyId corresponding to the hex string.

Creates an ArticyId from a hex string.

Parameters

hex	The hex string to convert.

Returns: The corresponding ArticyId.

◆ ArticyId_GetObject()

UArticyObject * UArticyFunctionLibrary::ArticyId_GetObject	(	FArticyId	Id,
		TSubclassOf< class UArticyObject >	CastTo,
		const UObject *	WorldContext )

static

Converts an ArticyId to an object.

Parameters

Id	The ArticyId to convert.
CastTo	The subclass type to cast the object to.
WorldContext	The context within which the object is retrieved.

Returns: The UArticyObject referenced by the ArticyId.

Retrieves the object referenced by an ArticyId.

Parameters

Id	The ArticyId to get the object from.
CastTo	The subclass type to cast the object to.
WorldContext	The context within which the object is retrieved.

Returns: The referenced UArticyObject.

◆ ArticyId_IsValid()

bool UArticyFunctionLibrary::ArticyId_IsValid ( const FArticyId & Id )

static

Checks if an ArticyId is valid.

Parameters

Id	The ArticyId to check.

Returns: True if the ID is valid.

◆ ArticyId_ToString()

FString UArticyFunctionLibrary::ArticyId_ToString ( UPARAM(Ref) const FArticyId & Id )

static

Gets the HEX string from an ID.

Parameters

Id	The ArticyId to convert.

Returns: The hex string representation of the ID.

Converts an ArticyId to a hex string.

Parameters

Id	The ArticyId to convert.

Returns: The hex string representation of the ID.

◆ ArticyRef_GetObject()

UArticyObject * UArticyFunctionLibrary::ArticyRef_GetObject	(	FArticyRef	Ref,
		TSubclassOf< class UArticyObject >	CastTo,
		const UObject *	WorldContext )

static

Converts an ArticyRef to an object.

Parameters

Ref	The ArticyRef to convert.
CastTo	The subclass type to cast the object to.
WorldContext	The context within which the object is retrieved.

Returns: The UArticyObject referenced by the ArticyRef.

Retrieves the object referenced by an ArticyRef.

Parameters

Ref	The ArticyRef to get the object from.
CastTo	The subclass type to cast the object to.
WorldContext	The context within which the object is retrieved.

Returns: The referenced UArticyObject.

◆ ArticyRef_GetObjectId()

FArticyId UArticyFunctionLibrary::ArticyRef_GetObjectId ( FArticyRef Ref )

static

Converts an ArticyRef to an FArticyId.

Parameters

Ref	The ArticyRef to convert.

Returns: The FArticyId of the referenced object.

Gets the ID of the object referenced by an ArticyRef.

Parameters

Ref	The ArticyRef to get the object ID from.

Returns: The ID of the referenced object.

◆ ArticyRef_SetObject()

void UArticyFunctionLibrary::ArticyRef_SetObject	(	UPARAM(Ref) FArticyRef &	Ref,
		UPARAM(Ref) UArticyObject *	Object )

static

Sets the referenced object of an ArticyRef.

Parameters

Ref	The ArticyRef to modify.
Object	The UArticyObject to set as the reference.

Sets the object reference of an ArticyRef.

Parameters

Ref	The ArticyRef to set the object for.
Object	The UArticyObject to set as reference.

◆ ArticyRef_SetObjectId()

void UArticyFunctionLibrary::ArticyRef_SetObjectId	(	UPARAM(Ref) FArticyRef &	Ref,
		UPARAM(Ref) FArticyId	Id )

static

Sets the referenced object ID of an ArticyRef.

Parameters

Ref	The ArticyRef to modify.
Id	The FArticyId to set.

Sets the ID of the object referenced by an ArticyRef.

Parameters

Ref	The ArticyRef to set the object ID for.
Id	The ID to set for the reference.

◆ GetBranchTarget()

TScriptInterface< IArticyFlowObject > UArticyFunctionLibrary::GetBranchTarget ( UPARAM(ref) const struct FArticyBranch & Branch )

static

Gets the last object in a branch.

Parameters

Branch The branch to analyze.

Returns: The target of the branch.

Retrieves the target of a given ArticyBranch.

Parameters

Branch The branch to get the target from.

Returns: The target flow object.

◆ GetNodeSeenCounter()

int UArticyFunctionLibrary::GetNodeSeenCounter	(	TScriptInterface< class IArticyFlowObject >	Node,
		const UObject *	WorldContext )

static

Gets the seen counter for a specific node.

Parameters

Node	The node to query.
WorldContext	The context within which the counter is retrieved.

Returns: The seen counter value.

Gets the seen counter for a specific node.

Parameters

Node	The node to get the seen counter for.
WorldContext	The context within which the counter is retrieved.

Returns: The seen counter value.

◆ MatchesEffective()

bool UArticyFunctionLibrary::MatchesEffective	(	const FArticyRef &	A,
		const FArticyRef &	B )

static

Compares two ArticyRefs for effective equality.

Parameters

A	The first ArticyRef.
B	The second ArticyRef.

Returns: True if they are effectively equal.

◆ MatchesRaw()

bool UArticyFunctionLibrary::MatchesRaw	(	const FArticyRef &	A,
		const FArticyRef &	B )

static

Compares two ArticyRefs for raw equality.

Parameters

A	The first ArticyRef.
B	The second ArticyRef.

Returns: True if they are raw-equal.

Compares two ArticyRefs for raw equality.

Parameters

A	The first ArticyRef.
B	The second ArticyRef.

Returns: True if they are equal in raw terms.

◆ SetNodeSeenCounter()

int UArticyFunctionLibrary::SetNodeSeenCounter	(	TScriptInterface< class IArticyFlowObject >	Node,
		int	Value,
		const UObject *	WorldContext )

static

Sets the seen counter for a specific node.

Parameters

Node	The node to modify.
Value	The new seen counter value.
WorldContext	The context within which the counter is set.

Returns: The updated seen counter value.

Sets the seen counter for a specific node.

Parameters

Node	The node to set the seen counter for.
Value	The value to set for the seen counter.
WorldContext	The context within which the counter is set.

Returns: The updated seen counter value.

◆ UFUNCTION() [1/2]

UArticyFunctionLibrary::UFUNCTION	(	BlueprintPure	,
		meta	= (DisplayName = "Equal (ArticyId)", CompactNodeTitle = "==", Keywords = "== equal"),
		Category	= "ArticyId" ) const &

Checks if two ArticyIds are equal.

Parameters

A	The first ArticyId.
B	The second ArticyId.

Returns: True if the IDs are equal.

◆ UFUNCTION() [2/2]

UArticyFunctionLibrary::UFUNCTION	(	BlueprintPure	,
		meta	= (DisplayName = "Not Equal (ArticyId)", CompactNodeTitle = "!=", Keywords = "!= not equal"),
		Category	= "ArticyId" ) const &

Checks if two ArticyIds are not equal.

Parameters

A	The first ArticyId.
B	The second ArticyId.

Returns: True if the IDs are not equal.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ ArticyGvName_MakeFromFullName()

◆ ArticyGvName_MakeFromVariableAndNamespace()

◆ ArticyId_FromString()

◆ ArticyId_GetObject()

◆ ArticyId_IsValid()

◆ ArticyId_ToString()

◆ ArticyRef_GetObject()

◆ ArticyRef_GetObjectId()

◆ ArticyRef_SetObject()

◆ ArticyRef_SetObjectId()

◆ GetBranchTarget()

◆ GetNodeSeenCounter()

◆ MatchesEffective()

◆ MatchesRaw()

◆ SetNodeSeenCounter()

◆ UFUNCTION() [1/2]

◆ UFUNCTION() [2/2]