#include <ArticyFlowClasses.h>

Inheritance diagram for UArticyJump:

Public Member Functions
EArticyPausableType	GetType () override
UArticyPrimitive *	GetTarget () const
FArticyId	GetTargetID () const
UArticyFlowPin *	GetTargetPin () const
FArticyId	GetTargetPinID () const
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 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.

Protected Attributes
FArticyId	TargetPin
FArticyId	Target
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

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)

Detailed Description

Represents a jump in the Articy flow system.

Member Function Documentation

◆ Explore()

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

overridevirtual

Explores the flow from this jump to its target pin.

Parameters

Player	The flow player performing the exploration.
OutBranches	The array to store resulting branches.
Depth	The current depth of exploration.

Explores the flow from this jump to its target pin.

This function adds branches to the OutBranches array based on the exploration starting from the target pin.

Parameters

Player	The flow player performing the exploration.
OutBranches	The array to store resulting branches.
Depth	The current depth of exploration.

Implements IArticyFlowObject.

◆ GetTarget()

UArticyPrimitive * UArticyJump::GetTarget ( ) const

Retrieves the target object of the jump.

Returns: Pointer to the target UArticyPrimitive object.

Retrieves the target object of the jump.

This function will return the target object if it has been resolved, otherwise, it will attempt to resolve it from the Articy database.

Returns: Pointer to the target UArticyPrimitive object.

◆ GetTargetID()

FArticyId UArticyJump::GetTargetID ( ) const

inline

Retrieves the ID of the target.

Returns: FArticyId representing the target ID.

◆ GetTargetPin()

UArticyFlowPin * UArticyJump::GetTargetPin ( ) const

Retrieves the target pin of the jump.

Returns: Pointer to the target UArticyFlowPin object.

Retrieves the target pin of the jump.

This function will return the target pin object if it has been resolved, otherwise, it will attempt to resolve it from the target object.

Returns: Pointer to the target UArticyFlowPin object.

◆ GetTargetPinID()

FArticyId UArticyJump::GetTargetPinID ( ) const

inline

Retrieves the ID of the target pin.

Returns: FArticyId representing the target pin ID.

◆ GetType()

EArticyPausableType UArticyJump::GetType ( )

inlineoverridevirtual

Returns the type of the node.

Returns: EArticyPausableType::Jump

Implements IArticyFlowObject.

Member Data Documentation

◆ Target

FArticyId UArticyJump::Target

protected

The ID of the target object.

◆ TargetPin

FArticyId UArticyJump::TargetPin