UArticyInstruction Class Reference

#include <ArticyScriptFragment.h>

Inheritance diagram for UArticyInstruction:

Public Member Functions
UArticyScriptInstruction *	GetInstruction () const
EArticyPausableType	GetType () override
void	Execute (class UArticyGlobalVariables *GV=nullptr, class UObject *MethodProvider=nullptr) override
void	Explore (UArticyFlowPlayer *Player, TArray< FArticyBranch > &OutBranches, const uint32 &Depth) override
Public Member Functions inherited from UArticyNode
EArticyPausableType	GetType () override
	Gets the type of this node.
void	Explore (UArticyFlowPlayer *Player, TArray< FArticyBranch > &OutBranches, const uint32 &Depth) override
	Explores the node's output pins.
Public Member Functions inherited from UArticyObject
FName	GetTechnicalName () const
UArticyObject *	GetParent () const
TArray< TWeakObjectPtr< UArticyObject > >	GetChildren () const
FArticyId	GetParentID () const
TArray< FArticyId >	GetChildrenIDs () 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
Public Member Functions inherited from IArticyInputPinsProvider
bool	TrySubmerge (class UArticyFlowPlayer *Player, TArray< FArticyBranch > &OutBranches, const uint32 &Depth, const bool bForceShadowed)
	Tries to submerge into InputPins and explore connections.
const TArray< UArticyInputPin * > *	GetInputPinsPtr () const
	Retrieves a pointer to the InputPins array.
TArray< UArticyInputPin * >	GetInputPins () const
	Retrieves the input pins for this object.
TArray< UArticyInputPin * >	GetInputPins_Implementation () const
	Implementation of the GetInputPins function.
Public Member Functions inherited from IArticyOutputPinsProvider
const TArray< UArticyOutputPin * > *	GetOutputPinsPtr () const
	Retrieves the output pins of the provider.
TArray< UArticyOutputPin * >	GetOutputPins () const
	Blueprint callable event to retrieve output pins.
TArray< UArticyOutputPin * >	GetOutputPins_Implementation () const
	Provides the implementation for retrieving output pins.

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
Protected Member Functions inherited from UArticyObject
void	InitFromJson (TSharedPtr< FJsonValue > Json) override
Protected Member Functions inherited from UArticyPrimitive
void	InitFromJson (TSharedPtr< FJsonValue > Json) override
Protected Member Functions inherited from UArticyBaseObject
void	AddSubobject (UArticyPrimitive *Obj)
FText	GetPropertyText (const FText Property)
Protected Attributes inherited from UArticyObject
FArticyId	Parent
TArray< FArticyId >	Children
FString	TechnicalName
Protected Attributes inherited from UArticyPrimitive
FArticyId	Id
int32	CloneId = 0
Protected Attributes inherited from UArticyBaseObject
TMap< FArticyId, UArticyPrimitive * >	Subobjects

Detailed Description

An instruction node, which has a script instruction.

Member Function Documentation

Execute()

void UArticyInstruction::Execute ( class UArticyGlobalVariables * GV = nullptr, class UObject * MethodProvider = nullptr )

overridevirtual

Executes the instruction node.

Parameters

GV	A pointer to the global variables used for execution.
MethodProvider	A pointer to the method provider object.

Executes the instruction node. If a script instruction is associated with the node, it delegates the execution to the script instruction.

Parameters

GV	A pointer to the global variables used for execution.
MethodProvider	A pointer to the method provider object.

Reimplemented from IArticyFlowObject.

Explore()

void UArticyInstruction::Explore ( UArticyFlowPlayer * Player, TArray< FArticyBranch > & OutBranches, const uint32 & Depth )

overridevirtual

Explores the instruction node and appends the resulting branches to the output array.

Parameters

Player	A pointer to the flow player handling the exploration.
OutBranches	An array to which the resulting branches are appended.
Depth	The current depth of exploration.

Explores the instruction node and appends the resulting branches to the output array. The exploration continues on the output pins after executing the instruction.

Parameters

Player	A pointer to the flow player handling the exploration.
OutBranches	An array to which the resulting branches are appended.
Depth	The current depth of exploration.

Implements IArticyFlowObject.

GetInstruction()

UArticyScriptInstruction * UArticyInstruction::GetInstruction

(

)

const

Retrieves the script instruction associated with this instruction node.

Returns

A pointer to the script instruction.

Retrieves the script instruction associated with this instruction node. If the instruction has not been previously loaded, it is retrieved from the property.

Returns

A pointer to the script instruction.

GetType()

EArticyPausableType UArticyInstruction::GetType ( )

inlineoverridevirtual

Retrieves the type of the node as an instruction.

Returns

The type of the node.

Implements IArticyFlowObject.

---

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

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