UArticyScriptFragment Class Reference

#include <ArticyScriptFragment.h>

Inheritance diagram for UArticyScriptFragment:

Public Member Functions
const FString &	GetExpression () const
Public Member Functions inherited from UArticyPrimitive
FArticyId	GetId () const
uint32	GetCloneId () const
void	SetCloneID (uint32 cCloneId)
Public Member Functions inherited from UArticyBaseObject
bool	WasLoaded () const
void	Initialize ()
UArticyPrimitive *	GetSubobject (FArticyId Id) const
FArticyType	GetArticyType () 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

Protected Member Functions
int	GetExpressionHash () const
void	InitFromJson (TSharedPtr< FJsonValue > Json) override
Protected Member Functions inherited from UArticyBaseObject
void	AddSubobject (UArticyPrimitive *Obj)
FText	GetPropertyText (const FText Property)

Protected Attributes
FString	Expression = ""
Protected Attributes inherited from UArticyPrimitive
FArticyId	Id
int32	CloneId = 0
Protected Attributes inherited from UArticyBaseObject
TMap< FArticyId, UArticyPrimitive * >	Subobjects

Friends
template<typename Type, typename PropType>
struct	ArticyObjectTypeInfo

Additional Inherited Members
Static Public Member Functions inherited from IArticyReflectable
static bool	HasProperty (const UClass *Class, const FName &Property)
Public Attributes inherited from UArticyBaseObject
FArticyType	ArticyType
Public Attributes inherited from IArticyReflectable
FReportChangedDelegate	ReportChanged

Detailed Description

Base class for the script fragments (ArticyScriptCondition or ArticyScriptInstruction).

This class represents a fragment of a script, which may contain an expression used for conditions or instructions within the Articy runtime environment.

Member Function Documentation

GetExpression()

const FString & UArticyScriptFragment::GetExpression ( ) const

inline

Retrieves the expression associated with this script fragment.

Returns

A constant reference to the expression string.

GetExpressionHash()

int UArticyScriptFragment::GetExpressionHash ( ) const

protected

Returns a cached hash of the expression.

Returns

The cached hash of the expression.

Computes and returns a hash of the expression. The hash is cached for performance optimization.

Returns

The hash value of the expression.

InitFromJson()

void UArticyScriptFragment::InitFromJson ( TSharedPtr< FJsonValue > Json )

overrideprotectedvirtual

Initializes the script fragment from a JSON value.

Parameters

Json	A shared pointer to the JSON value to initialize from.

Initializes the script fragment from a JSON value. This method parses the JSON value and sets the expression if the JSON is valid.

Parameters

Json	A shared pointer to the JSON value to initialize from.

Reimplemented from UArticyPrimitive.

Member Data Documentation

Expression

FString UArticyScriptFragment::Expression = ""

protected

The expression associated with this script fragment.

---

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

• Source/ArticyRuntime/Public/ArticyScriptFragment.h
• Source/ArticyRuntime/Private/ArticyScriptFragment.cpp