Interface class for objects providing input pins. More...

#include <ArticyInputPinsProvider.h>

Inheritance diagram for IArticyInputPinsProvider:

Public Member Functions
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 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

Interface class for objects providing input pins.

This interface class defines methods for interacting with input pins, allowing for exploration and manipulation of flow nodes in Articy.

Member Function Documentation

◆ GetInputPins()

TArray< UArticyInputPin * > IArticyInputPinsProvider::GetInputPins ( ) const

Retrieves the input pins for this object.

This function provides a BlueprintCallable and BlueprintNativeEvent version of the GetInputPins functionality, allowing for easy access to input pins.

Returns: An array of UArticyInputPin objects.

◆ GetInputPins_Implementation()

TArray< UArticyInputPin * > IArticyInputPinsProvider::GetInputPins_Implementation ( ) const

Implementation of the GetInputPins function.

This function provides the actual implementation for retrieving the array of input pins.

Returns: An array of UArticyInputPin objects.

◆ GetInputPinsPtr()

const TArray< UArticyInputPin * > * IArticyInputPinsProvider::GetInputPinsPtr ( ) const

Retrieves a pointer to the InputPins array.

This function returns a pointer to the array of input pins, if available, for this object.

Returns: A pointer to an array of UArticyInputPin objects, or nullptr if not found.

◆ TrySubmerge()

bool IArticyInputPinsProvider::TrySubmerge	(	class UArticyFlowPlayer *	Player,
		TArray< FArticyBranch > &	OutBranches,
		const uint32 &	Depth,
		const bool	bForceShadowed )

Tries to submerge into InputPins and explore connections.

This method attempts to explore input pins of a flow node by checking for any connected pins and exploring them using the provided player. It is used primarily when starting an exploration at a flow node.

Parameters

Player	A pointer to the ArticyFlowPlayer instance managing the exploration.
OutBranches	An array to store the resulting branches from the exploration.
Depth	The current depth of exploration.
bForceShadowed	A boolean flag indicating whether to force shadowed exploration.

Returns: Returns true if successful in submerging into InputPins; otherwise, false.

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

Source/ArticyRuntime/Public/Interfaces/ArticyInputPinsProvider.h
Source/ArticyRuntime/Private/Interfaces/ArticyInputPinsProvider.cpp