USMConduitInstance

Module: SMSystem

#include <SMConduitInstance.h>

Inherits from USMStateInstance_Base, USMNodeInstance, UObject

Description

class USMConduitInstance;

Conduits connect transitions. The connected transition chain including the conduit must pass to switch states.

Public Functions

	Name
	USMConduitInstance()
bool	CanEnterTransition() const
void	OnConduitEntered()
void	OnConduitInitialized()
void	OnConduitShutdown()
void	SetCanEvaluate(const bool bValue)
bool	GetCanEvaluate() const
bool	GetEvalWithTransitions() const
void	SetEvalWithTransitions(const bool bValue)

Protected Functions

	Name
virtual bool	CanEnterTransition_Implementation() const
virtual void	OnConduitEntered_Implementation()
virtual void	OnConduitInitialized_Implementation()
virtual void	OnConduitShutdown_Implementation()

Public Attributes

	Name
bool	bEvalGraphsOnInitialize
bool	bEvalGraphsOnTransitionEval

Friends

	Name
class	USMGraphNode_ConduitNode

Additional inherited members

Public Functions inherited from USMStateInstance_Base

	Name
	USMStateInstance_Base()
virtual bool	IsInEndState() const override
void	OnStateBegin()
void	OnStateUpdate(float DeltaSeconds)
void	OnStateEnd()
bool	IsEndState() const
void	GetStateInfo(FSMStateInfo & State) const
bool	IsStateMachine() const
bool	IsEntryState() const
void	SetActive(bool bValue, bool bSetAllParents =false, bool bActivateNow =true)
void	EvaluateTransitions()
bool	GetOutgoingTransitions(TArray< USMTransitionInstance * > & Transitions, bool bExcludeAlwaysFalse =true) const
bool	GetIncomingTransitions(TArray< USMTransitionInstance * > & Transitions, bool bExcludeAlwaysFalse =true) const
USMTransitionInstance *	GetTransitionToTake() const
bool	SwitchToLinkedState(USMStateInstance_Base * NextStateInstance, bool bRequireTransitionToPass =true, bool bActivateNow =true)
bool	SwitchToLinkedStateByName(const FString & NextStateName, bool bRequireTransitionToPass =true, bool bActivateNow =true)
bool	SwitchToLinkedStateByTransition(USMTransitionInstance * TransitionInstance, bool bRequireTransitionToPass =true, bool bActivateNow =true)
bool	SwitchToLinkedStateByTransitionName(const FString & TransitionName, bool bRequireTransitionToPass =true, bool bActivateNow =true)
USMTransitionInstance *	GetTransitionByIndex(int32 Index) const
USMTransitionInstance *	GetOutgoingTransitionByName(const FString & Name) const
USMTransitionInstance *	GetIncomingTransitionByName(const FString & Name) const
USMStateInstance_Base *	GetNextStateByTransitionIndex(int32 Index) const
USMStateInstance_Base *	GetNextStateByName(const FString & StateName) const
USMStateInstance_Base *	GetPreviousStateByName(const FString & StateName) const
USMStateInstance_Base *	GetPreviousActiveState() const
USMTransitionInstance *	GetPreviousActiveTransition() const
bool	AreAllOutgoingTransitionsFromAnAnyState() const
bool	AreAllIncomingTransitionsFromAnAnyState() const
const FDateTime &	GetStartTime() const
float	GetServerTimeInState(bool & bOutUsedLocalTime) const
void	GetAllNodesOfType(TArray< USMNodeInstance * > & OutNodes, TSubclassOf< USMNodeInstance > NodeClass, bool bIncludeChildren =true, const TArray< UClass * > & StopIfTypeIsNot =TArray< UClass * >()) const
const FLinearColor &	GetEndStateColor() const
bool	ShouldDisplayNameWidget() const
bool	ShouldUseDisplayNameOnly() const
const FSMStateConnectionValidator &	GetAllowedConnections() const
virtual bool	IsRegisteredWithContextMenu() const
virtual bool	HideFromContextMenuIfRulesFail() const
bool	GetAlwaysUpdate() const
void	SetAlwaysUpdate(const bool bValue)
bool	GetDisableTickTransitionEvaluation() const
void	SetDisableTickTransitionEvaluation(const bool bValue)
bool	GetDefaultToParallel() const
void	SetDefaultToParallel(const bool bValue)
bool	GetAllowParallelReentry() const
void	SetAllowParallelReentry(const bool bValue)
bool	GetStayActiveOnStateChange() const
void	SetStayActiveOnStateChange(const bool bValue)
bool	GetEvalTransitionsOnStart() const
void	SetEvalTransitionsOnStart(const bool bValue)
bool	GetExcludeFromAnyState() const
void	SetExcludeFromAnyState(const bool bValue)
bool	GetCanBeEndState() const
void	SetCanBeEndState(const bool bValue)
FName	GetHideFromContextMenuIfRulesFailPropertyName()
FName	GetRegisteredWithContextMenuPropertyName()

Protected Functions inherited from USMStateInstance_Base

	Name
virtual void	OnStateBegin_Implementation()
virtual void	OnStateUpdate_Implementation(float DeltaSeconds)
virtual void	OnStateEnd_Implementation()

Public Attributes inherited from USMStateInstance_Base

	Name
uint8	bEvalGraphsOnStart
uint8	bEvalGraphsOnUpdate
uint8	bEvalGraphsOnEnd
uint8	bEvalGraphsOnRootStateMachineStart
uint8	bEvalGraphsOnRootStateMachineStop
FOnStateBeginSignature	OnStateBeginEvent
FOnStateBeginSignature	OnPostStateBeginEvent
FOnStateUpdateSignature	OnStateUpdateEvent
FOnStateEndSignature	OnStateEndEvent

Protected Attributes inherited from USMStateInstance_Base

	Name
FLinearColor	NodeEndStateColor
FSMStateConnectionValidator	ConnectionRules
uint16	bHideFromContextMenuIfRulesFail
uint16	bRegisterWithContextMenu
uint16	bShowDisplayNameOnly
uint16	bDisplayNameWidget

Friends inherited from USMStateInstance_Base

	Name
class	USMGraphNode_StateNodeBase

Public Functions inherited from USMNodeInstance

	Name
	USMNodeInstance()
virtual void	Serialize(FArchive & Ar) override
virtual UWorld *	GetWorld() const override
virtual void	BeginDestroy() override
virtual UObject *	GetContext() const override
virtual void	NativeInitialize()
virtual void	NativeShutdown()
void	OnRootStateMachineStart()
void	OnRootStateMachineStop()
void	RunConstructionScript()
bool	ShouldSkipNativeEditorConstructionScripts() const
USMInstance *	GetStateMachineInstance(bool bTopMostInstance =false) const
void	SetOwningNode(FSMNode_Base * Node, bool bInIsEditorExecution =false)
const FSMNode_Base *	GetOwningNode() const
T *	GetOwningNodeAs() const
virtual const FSMNode_Base *	GetOwningNodeContainer() const
USMStateMachineInstance *	GetOwningStateMachineNodeInstance() const
TScriptInterface< ISMStateMachineNetworkedInterface >	GetNetworkInterface() const
virtual float	GetTimeInState() const
virtual bool	IsInEndState() const
virtual bool	HasUpdated() const
bool	IsActive() const
const FString &	GetNodeName() const
const FGuid &	GetGuid() const
UTexture2D *	GetNodeIcon() const
FVector2D	GetNodeIconSize() const
FLinearColor	GetNodeIconTintColor() const
void	EvaluateGraphProperties(bool bTargetOnly =false)
const FGuid &	GetTemplateGuid() const
const FVector2D &	GetNodePosition() const
bool	IsInitialized() const
bool	IsInitializedAndReadyForInputEvents() const
FSMGraphProperty *	FindExposedPropertyOverrideByName(const FName & VariableName) const
virtual void	PostEditChangeProperty(FPropertyChangedEvent & PropertyChangedEvent) override
bool	WasArrayPropertyModified(const FName & PropertyName) const
bool	IsNodePinChanging() const
void	SetDisplayName(FName NewDisplayName)
void	SetNodeDescriptionText(FText NewDescription)
FText	GetNodeDescriptionText() const
void	SetNodeColor(FLinearColor NewColor)
void	SetUseCustomColor(bool bValue)
void	SetUseCustomIcon(bool bValue)
void	SetVariableReadOnly(FName VariableName, bool bSetIsReadOnly)
void	SetVariableHidden(FName VariableName, bool bSetHidden)
bool	IsEditorExecution() const
void	WithExecutionEnvironment(ESMExecutionEnvironment & ExecutionEnvironment)
TScriptInterface< ISMEditorGraphNodeInterface >	GetOwningEditorGraphNode() const
void	K2_TryGetOwningEditorGraphNode(TScriptInterface< ISMEditorGraphNodeInterface > & EditorNode, ESMValidEditorNode & IsValidNode) const
bool	IsInitializationThreadSafe() const
void	ResetVariables()
bool	GetResetVariablesOnInitialize() const
bool	HasCustomColor() const
const FLinearColor &	GetNodeColor() const
const FSMNodeDescription &	GetNodeDescription() const
bool	HasCustomIcon() const
FString	GetNodeDisplayName() const
void	SetTemplateGuid(const FGuid & NewTemplateGuid)
void	SetIsThreadSafe(bool bNewValue)
void	SetIsEditorThreadSafe(const bool bNewValue)
bool	GetIsEditorThreadSafe() const
TEnumAsByte< ESMNodeInput::Type >	GetInputType() const
int32	GetInputPriority() const
bool	GetBlockInput() const
UInputComponent *	GetInputComponent() const
FName	GetConstructionScriptFunctionName()
FName	GetNodeDescriptionPropertyName()
FName	GetHideFromDropDownIfRulesFailPropertyName()

Protected Functions inherited from USMNodeInstance

	Name
virtual void	OnRootStateMachineStart_Implementation()
virtual void	OnRootStateMachineStop_Implementation()
void	ConstructionScript()
FSMGraphProperty *	FindOrAddExposedPropertyOverrideByName(const FName & VariableName)
void	OnPreCompileValidate(USMCompilerLog * CompilerLog) const
virtual void	OnPreCompileValidate_Implementation(USMCompilerLog * CompilerLog) const
virtual void	ConstructionScript_Implementation()
virtual UTexture2D *	GetNodeIcon_Implementation() const
virtual FVector2D	GetNodeIconSize_Implementation() const
virtual FLinearColor	GetNodeIconTintColor_Implementation() const
void	EnableInput() Input.
void	DisableInput()
void	OnContextPawnControllerChanged(APawn * Pawn, AController * NewController)

Public Attributes inherited from USMNodeInstance

	Name
TArray< FSMGraphProperty >	ExposedPropertyOverrides
uint8	bEvalDefaultProperties
uint8	bAutoEvalExposedProperties

Protected Attributes inherited from USMNodeInstance

	Name
bool	bSkipNativeEditorConstructionScripts
TObjectPtr< UTexture2D >	NodeIcon
FVector2D	NodeIconSize
FLinearColor	NodeIconTintColor
bool	bResetVariablesOnInitialize
FSMNodeDescription	NodeDescription
FLinearColor	NodeColor
uint8	bDisplayCustomIcon
uint8	bUseCustomColors
uint8	bHideFromDropDownIfRulesFail
TObjectPtr< UInputComponent >	InputComponent
TEnumAsByte< ESMNodeInput::Type >	AutoReceiveInput
int32	InputPriority
uint8	bBlockInput

Friends inherited from USMNodeInstance

	Name
class	USMGraphNode_StateNode
class	USMGraphNode_TransitionEdge
struct	FSMNode_Base(FSMNode_Base )
class	USMGraphNode_Base
class	USMGraphK2Node_PropertyNode_Base

Public Functions Documentation

function USMConduitInstance

USMConduitInstance()

---

function CanEnterTransition

bool CanEnterTransition() const

Is this conduit allowed to switch states.

---

function OnConduitEntered

void OnConduitEntered()

Called once this conduit has evaluated to true and has been taken.

---

function OnConduitInitialized

void OnConduitInitialized()

Called after the state leading to this node is initialized but before OnStateBegin.

---

function OnConduitShutdown

void OnConduitShutdown()

Called after the state leading to this node has run OnStateEnd but before it has called its shutdown sequence.

---

function SetCanEvaluate

void SetCanEvaluate(
    const bool bValue
)

Sets whether this node is allowed to evaluate or not.

---

function GetCanEvaluate

bool GetCanEvaluate() const

Check whether this node is allowed to evaluate.

---

function GetEvalWithTransitions

bool GetEvalWithTransitions() const

Public getter for bEvalWithTransitions.

---

function SetEvalWithTransitions

void SetEvalWithTransitions(
    const bool bValue
)

Public setter for bEvalWithTransitions.

---

Protected Functions Documentation

function CanEnterTransition_Implementation

inline virtual bool CanEnterTransition_Implementation() const

---

function OnConduitEntered_Implementation

inline virtual void OnConduitEntered_Implementation()

---

function OnConduitInitialized_Implementation

inline virtual void OnConduitInitialized_Implementation()

---

function OnConduitShutdown_Implementation

inline virtual void OnConduitShutdown_Implementation()

---

Public Attributes Documentation

variable bEvalGraphsOnInitialize

bool bEvalGraphsOnInitialize;

Should graph properties evaluate during the conduit's initialize sequence.

---

variable bEvalGraphsOnTransitionEval

bool bEvalGraphsOnTransitionEval;

Should graph properties evaluate when the conduit is being evaluated as a transition.

---

Private Attributes Documentation

variable bEvalWithTransitions

uint8 bEvalWithTransitions;

This conduit will be evaluated with inbound and outbound transitions. If any transition fails the entire transition fails. In that case the state leading to this conduit will not take this transition.

This makes the behavior similar to AnimGraph conduits.

---

variable bCanEvaluate

uint8 bCanEvaluate;

If this conduit is allowed to evaluate.

---

Friends

friend USMGraphNode_ConduitNode

friend class USMGraphNode_ConduitNode(
    USMGraphNode_ConduitNode 
);

---