ArticyXImporter
ArticyXImporter for Unreal Engine
Loading...
Searching...
No Matches
IArticyFlowObject Class Referenceabstract

#include <ArticyFlowObject.h>

Inheritance diagram for IArticyFlowObject:
IArticyReflectable IArticyInputPinsProvider IArticyOutputPinsProvider UArticyFlowPin UArticyNode UArticyNode UArticyInputPin UArticyOutputPin UArticyCondition UArticyDialogue UArticyDialogueFragment UArticyFlowFragment UArticyHub UArticyInstruction UArticyJump UArticyCondition UArticyDialogue UArticyDialogueFragment UArticyFlowFragment UArticyHub UArticyInstruction UArticyJump

Public Member Functions

virtual EArticyPausableType GetType ()=0
virtual void Explore (UArticyFlowPlayer *Player, TArray< FArticyBranch > &OutBranches, const uint32 &Depth)=0
virtual void Execute (class UArticyGlobalVariables *GV=nullptr, class UObject *MethodProvider=nullptr)
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

Additional Inherited Members

Static Public Member Functions inherited from IArticyReflectable
static bool HasProperty (const UClass *Class, const FName &Property)
Public Attributes inherited from IArticyReflectable
FReportChangedDelegate ReportChanged

Detailed Description

All objects that are part of a flow (i.e. can be traversed by the Flow Player) need to implement this interface.

Member Function Documentation

◆ Execute()

virtual void IArticyFlowObject::Execute ( class UArticyGlobalVariables * GV = nullptr,
class UObject * MethodProvider = nullptr )
inlinevirtual

Executes any script fragments found on this node.

Reimplemented in UArticyInstruction, and UArticyOutputPin.

◆ Explore()

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

Gather all branches that start at this node.

Implemented in IArticyOutputPinsProvider, UArticyCondition, UArticyFlowPin, UArticyInputPin, UArticyInstruction, UArticyJump, UArticyNode, and UArticyOutputPin.

◆ GetType()

virtual EArticyPausableType IArticyFlowObject::GetType ( )
pure virtual

Implemented in UArticyCondition, UArticyDialogue, UArticyDialogueFragment, UArticyFlowFragment, UArticyHub, UArticyInstruction, UArticyJump, and UArticyNode.

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