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

Interface class for providing output pins functionality. More...

#include <ArticyOutputPinsProvider.h>

Inheritance diagram for IArticyOutputPinsProvider:
IArticyFlowObject IArticyReflectable UArticyNode UArticyCondition UArticyDialogue UArticyDialogueFragment UArticyFlowFragment UArticyHub UArticyInstruction UArticyJump

Public Member Functions

void Explore (UArticyFlowPlayer *Player, TArray< FArticyBranch > &OutBranches, const uint32 &Depth) override
 Explores the output pins of the provider.
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.
Public Member Functions inherited from IArticyFlowObject
virtual EArticyPausableType GetType ()=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

Interface class for providing output pins functionality.

This interface class provides the functionality to manage and explore output pins within a flow system.

Member Function Documentation

◆ Explore()

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

Explores the output pins of the provider.

This function explores the provider's output pins, allowing the ArticyFlowPlayer to explore the connected branches. If there are no output pins, it adds a dead-end branch.

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.

Reimplemented in UArticyCondition, UArticyInstruction, UArticyJump, and UArticyNode.

◆ GetOutputPins()

TArray< UArticyOutputPin * > IArticyOutputPinsProvider::GetOutputPins ( ) const

Blueprint callable event to retrieve output pins.

This event provides the blueprint functionality to retrieve output pins.

Returns
An array of UArticyOutputPin objects.

◆ GetOutputPins_Implementation()

TArray< UArticyOutputPin * > IArticyOutputPinsProvider::GetOutputPins_Implementation ( ) const

Provides the implementation for retrieving output pins.

This function returns an array of output pins associated with the provider, or an empty array if none are found.

Returns
An array of UArticyOutputPin objects.

◆ GetOutputPinsPtr()

const TArray< UArticyOutputPin * > * IArticyOutputPinsProvider::GetOutputPinsPtr ( ) const

Retrieves the output pins of the provider.

This function returns a pointer to the array of output pins associated with the provider.

Returns
A pointer to the array of UArticyOutputPin objects.

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