ArticyXImporter
ArticyXImporter for Unreal Engine
Loading...
Searching...
No Matches
UArticyNode Class Reference

Base class for all nodes (fragments) in the flow. More...

#include <ArticyNode.h>

Inheritance diagram for UArticyNode:
UArticyObject IArticyInputPinsProvider IArticyOutputPinsProvider UArticyPrimitive IArticyFlowObject IArticyFlowObject UArticyBaseObject IArticyReflectable IArticyReflectable IArticyReflectable UArticyCondition UArticyDialogue UArticyDialogueFragment UArticyFlowFragment UArticyHub UArticyInstruction UArticyJump

Public Member Functions

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
UArticyObjectGetParent () const
TArray< TWeakObjectPtr< UArticyObject > > GetChildren () const
FArticyId GetParentID () const
TArray< FArticyIdGetChildrenIDs () 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 ()
UArticyPrimitiveGetSubobject (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 IArticyFlowObject
virtual void Execute (class UArticyGlobalVariables *GV=nullptr, class UObject *MethodProvider=nullptr)
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< FArticyIdChildren
FString TechnicalName
Protected Attributes inherited from UArticyPrimitive
FArticyId Id
int32 CloneId = 0
Protected Attributes inherited from UArticyBaseObject
TMap< FArticyId, UArticyPrimitive * > Subobjects

Detailed Description

Base class for all nodes (fragments) in the flow.

This class serves as the base for all nodes within the flow system, implementing both input and output pin interfaces to allow for node exploration.

Member Function Documentation

◆ Explore()

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

Explores the node's output pins.

This function explores the node by continuing on its output pins, allowing the ArticyFlowPlayer to explore the connected branches.

Parameters
PlayerA pointer to the ArticyFlowPlayer managing the exploration.
OutBranchesAn array to store the resulting branches from the exploration.
DepthThe current depth of exploration.

Implements IArticyFlowObject.

◆ GetType()

EArticyPausableType UArticyNode::GetType ( )
inlineoverridevirtual

Gets the type of this node.

This function returns the type of the node, which is pausable. It is intended to be overridden in derived classes.

Returns
The type of the node as EArticyPausableType.

Implements IArticyFlowObject.


The documentation for this class was generated from the following files:
  • Source/ArticyRuntime/Public/Interfaces/ArticyNode.h
  • Source/ArticyRuntime/Private/Interfaces/ArticyNode.cpp