USMEditorInstance

Module: SMSystemEditor

Inherits from USMInstance, UObject

Public Functions

	Name
virtual void	Initialize(UObject * Context) override
virtual void	Shutdown() override

Additional inherited members

Public Functions inherited from USMInstance

	Name
	USMInstance()
void	Tick(float DeltaTime) override
virtual bool	IsTickable() const override
virtual bool	IsTickableInEditor() const override
virtual ETickableTickType	GetTickableTickType() const override
virtual bool	IsTickableWhenPaused() const override
virtual UWorld *	GetTickableGameObjectWorld() const override
virtual TStatId	GetStatId() const override
virtual bool	IsSupportedForNetworking() const override
virtual void	GetLifetimeReplicatedProps(TArray< FLifetimeProperty > & OutLifetimeProps) const override
virtual void	BeginDestroy() override
virtual UWorld *	GetWorld() const override
virtual int32	GetFunctionCallspace(UFunction * Function, FFrame * Stack) override
virtual bool	CallRemoteFunction(UFunction * Function, void * Parms, FOutParmRec * OutParms, FFrame * Stack) override
virtual void	Serialize(FArchive & Ar) override
virtual UObject *	GetContext() const override
USMStateMachineComponent *	GetComponentOwner() const
void	SetComponentOwner(USMStateMachineComponent * InComponent)
virtual void	Start() override
virtual void	Update(float DeltaSeconds =0.f) override
virtual void	Stop() override
virtual void	Restart() override
void	ReplicatedStart()
void	ReplicatedStop()
void	ReplicatedRestart()
void	StartWithNewContext(UObject * Context)
void	EvaluateTransitions()
bool	EvaluateAndTakeTransitionChain(USMTransitionInstance * InFirstTransitionInstance)
bool	EvaluateAndTakeTransitionChain(FSMTransition & InFirstTransition)
bool	EvaluateAndFindTransitionChain(USMTransitionInstance * InFirstTransitionInstance, TArray< USMTransitionInstance * > & OutTransitionChain, USMStateInstance_Base *& OutDestinationState, bool bRequirePreviousStateActive =true)
bool	TakeTransitionChain(const TArray< USMTransitionInstance * > & InTransitionChain)
void	PreloadAllNodeInstances()
void	ActivateStateLocally(const FGuid & StateGuid, bool bActive, bool bSetAllParents, bool bActivateNow =true)
void	SwitchActiveState(USMStateInstance_Base * NewStateInstance, bool bDeactivateOtherStates =true)
void	SwitchActiveStateByQualifiedName(const FString & InFullPath, bool bDeactivateOtherStates =true)
bool	HasPendingActiveStates() const
bool	IsUpdating() const
bool	IsStopping() const
void	LoadFromState(const FGuid & FromGuid, bool bAllParents =true, bool bNotify =true)
void	LoadFromMultipleStates(const TArray< FGuid > & FromGuids, bool bNotify =true)
bool	AreInitialStatesSetFromLoad() const
void	ClearLoadedStates()
void	InitializeAsync(UObject * Context, const FOnStateMachineInstanceInitializedAsync & OnCompletedDelegate =FOnStateMachineInstanceInitializedAsync())
void	K2_InitializeAsync(UObject * Context, FLatentActionInfo LatentInfo)
void	CancelAsyncInitialization()
void	WaitForAsyncInitializationTask(bool bCallFinishInitialize =true)
void	TryGetNestedActiveState(FSMStateInfo & FoundState, bool & bSuccess) const
FSMState_Base *	GetSingleActiveState() const
FSMState_Base *	GetSingleNestedActiveState() const
TArray< FSMState_Base * >	GetAllActiveStates() const
FGuid	GetSingleActiveStateGuid(bool bCheckNested =true) const
void	GetAllActiveStateGuids(TArray< FGuid > & ActiveGuids) const
TArray< FGuid >	GetAllActiveStateGuidsCopy() const
USMStateInstance_Base *	GetSingleActiveStateInstance(bool bCheckNested =true) const
void	GetAllActiveStateInstances(TArray< USMStateInstance_Base * > & ActiveStateInstances) const
TArray< USMInstance * >	GetAllReferencedInstances(bool bIncludeChildren =false) const
TArray< FSMStateMachine * >	GetStateMachinesWithReferences(bool bIncludeChildren =false) const
void	TryGetStateInfo(const FGuid & Guid, FSMStateInfo & StateInfo, bool & bSuccess) const
void	TryGetTransitionInfo(const FGuid & Guid, FSMTransitionInfo & TransitionInfo, bool & bSuccess) const
USMInstance *	GetReferencedInstanceByGuid(const FGuid & Guid) const
USMStateInstance_Base *	GetStateInstanceByGuid(const FGuid & Guid) const
USMTransitionInstance *	GetTransitionInstanceByGuid(const FGuid & Guid) const
USMNodeInstance *	GetNodeInstanceByGuid(const FGuid & Guid) const
USMStateInstance_Base *	GetStateInstanceByQualifiedName(const FString & InFullPath) const
FSMState_Base *	GetStateByGuid(const FGuid & Guid) const
FSMTransition *	GetTransitionByGuid(const FGuid & Guid) const
FSMNode_Base *	GetNodeByGuid(const FGuid & Guid) const
FSMState_Base *	FindStateByGuid(const FGuid & Guid) const
TMap< FGuid, FGuid > &	GetGuidRedirectMap()
void	SetGuidRedirectMap(const TMap< FGuid, FGuid > & InGuidMap)
FGuid	GetRedirectedGuid(const FGuid & InPathGuid) const
FSMStateMachine &	GetRootStateMachine()
USMStateMachineInstance *	GetRootStateMachineNodeInstance() const
bool	IsActive() const
bool	CanEverTick() const
void	SetCanEverTick(bool Value)
bool	IsTickRegistered() const
void	SetRegisterTick(bool Value)
void	SetTickOnManualUpdate(bool Value)
bool	CanTickOnManualUpdate() const
void	SetCanTickWhenPaused(bool Value)
void	SetCanTickInEditor(bool Value)
void	SetTickBeforeBeginPlay(bool Value)
void	SetTickInterval(float Value)
void	SetAutoManageTime(bool Value)
bool	CanAutoManageTime() const
float	GetTickInterval() const
void	SetStopOnEndState(bool Value)
bool	GetStopOnEndState() const
bool	IsInEndState() const
void	SetContext(UObject * Context)
const TMap< FGuid, FSMNode_Base * > &	GetNodeMap() const
const TMap< FGuid, FSMState_Base * > &	GetStateMap() const
const TMap< FGuid, FSMTransition * > &	GetTransitionMap() const
const TArray< FSMStateHistory > &	GetStateHistory() const
void	SetStateHistoryMaxCount(int32 NewSize)
int32	GetStateHistoryMaxCount() const
void	ClearStateHistory()
void	GetAllStateInstances(TArray< USMStateInstance_Base * > & StateInstances) const
void	GetAllTransitionInstances(TArray< USMTransitionInstance * > & TransitionInstances) const
void	SetNetworkInterface(TScriptInterface< ISMStateMachineNetworkedInterface > InNetworkInterface)
TScriptInterface< ISMStateMachineNetworkedInterface >	GetNetworkInterface() const
void	K2_TryGetNetworkInterface(TScriptInterface< ISMStateMachineNetworkedInterface > & Interface, bool & bIsValid)
ISMStateMachineNetworkedInterface *	TryGetNetworkInterface() const
void	UpdateNetworkConditions()
void	CopyNetworkConditionsFrom(USMInstance * OtherInstance, bool bUpdateNodes =false)
void	SetAllowTransitionsLocally(bool bCanEvaluateTransitions, bool bCanTakeTransitions)
void	SetAllowStateLogic(bool bAllow)
bool	HasStarted() const
bool	IsInitialized() const
bool	IsInitializingAsync() const
bool	IsReferenceTemplate() const
void	SetReferenceOwner(USMInstance * Owner)
void	AddReplicatedReference(const FGuid & PathGuid, USMInstance * NewReference)
void	AddReplicatedNodeInstance(const FGuid & PathGuid, uint8 StackIndex, USMNodeInstance * NewNodeInstance)
USMInstance *	FindReplicatedReference(const FGuid & PathGuid) const
USMNodeInstance *	FindReplicatedNodeInstance(const FGuid & PathGuid, uint8 StackIndex)
const TArray< FSMReferenceContainer > &	GetReplicatedReferences() const
const TArray< FSMNodeInstanceContainer > &	GetReplicatedNodeInstances() const
bool	HaveAllSubObjectsReplicated() const
bool	HaveAllReferencesReplicated() const
bool	HaveAllNodeInstancesReplicated() const
bool	CanReplicateAsReference() const
bool	CanReplicateNodeInstances() const
bool	ShouldLookUpReplicatedNodeInstance() const
const USMInstance *	GetReferenceOwnerConst() const
const USMInstance *	GetPrimaryReferenceOwnerConst() const
bool	IsPrimaryReferenceOwner() const
USMInstance *	GetReferenceOwner() const
USMInstance *	GetPrimaryReferenceOwner()
TSubclassOf< USMStateMachineInstance >	GetRootStateMachineNodeClass() const
TSubclassOf< USMStateMachineInstance >	GetStateMachineClass() const
void	SetRootStateMachineNodeClass(TSubclassOf< USMStateMachineInstance > NewStateMachineNodeClass)
void	SetStateMachineClass(TSubclassOf< USMStateMachineInstance > NewStateMachineClass)
void	OnPreStateMachineInitialized()
void	OnStateMachineInitialized()
void	OnStateMachineStart()
void	OnStateMachineUpdate(float DeltaSeconds)
void	OnStateMachineStop()
void	OnStateMachineShutdown()
void	OnStateMachineTransitionTaken(const FSMTransitionInfo & Transition)
void	OnStateMachineStateChanged(const FSMStateInfo & ToState, const FSMStateInfo & FromState)
void	OnStateMachineStateStarted(const FSMStateInfo & State)
void	NotifyTransitionTaken(const FSMTransition & Transition)
void	NotifyStateChange(FSMState_Base * ToState, FSMState_Base * FromState)
void	NotifyStateStarted(const FSMState_Base & State)
FSMDebugStateMachine &	GetDebugStateMachine()
const FSMDebugStateMachine &	GetDebugStateMachineConst() const
bool	IsLoggingEnabled() const
void	RunUpdateAsReference(float DeltaSeconds)
TEnumAsByte< ESMStateMachineInput::Type >	GetInputType() const Input.
int32	GetInputPriority() const
bool	GetBlockInput() const
APlayerController *	GetInputController() const
void	SetAutoReceiveInput(ESMStateMachineInput::Type InInputType)
void	SetInputPriority(int32 InInputPriority)
void	SetBlockInput(bool bNewValue)
UInputComponent *	GetInputComponent() const
void	SetManualInputController(APlayerController * InController =nullptr)
const TMap< FGuid, FSMGuidMap > &	GetRootPathGuidCache() const
void	SetRootPathGuidCache(const TMap< FGuid, FSMGuidMap > & InGuidCache)
TSharedPtr< FSMCachedPropertyData, ESPMode::ThreadSafe >	GetCachedPropertyData()
const TMap< FName, TObjectPtr< UObject > > &	GetGeneratedSubObjectTemplates() const
FSMInstanceProxyPropertyData &	GetOutputProxyPropertyData()
FSMProxyPropertyData *	FindOrAddOutputProxyPropertyData(const FSMProxyPropertyPath & InArgs)
FSMProxyPropertyData *	FindOutputProxyPropertyData(const FSMProxyPropertyPath & InArgs)
TMap< FGuid, FSMExposedNodeFunctions > &	GetNodeExposedFunctions()
void	AddNonThreadSafeNode(FSMNode_Base * InNode)
FString	GetRootNodeNameDefault()
FName	GetStateMachineClassPropertyName()
FName	GetInternalEventUpdateFunctionName()
FName	GetInternalEvaluateAndTakeTransitionChainFunctionName()
FName	GetInternalEventCleanupFunctionName()

Protected Functions inherited from USMInstance

	Name
void	OnStateMachineInitialStateLoaded(const FGuid & StateGuid)
virtual void	OnStateMachineInitialStateLoaded_Implementation(const FGuid & StateGuid)
virtual void	FinishInitialize()
bool	HandleStopOnEndState()
virtual void	CleanupAsyncObjects()
void	CleanupAsyncInitializationTask()
virtual void	Tick_Implementation(float DeltaTime)
virtual void	OnPreStateMachineInitialized_Implementation()
virtual void	OnStateMachineInitialized_Implementation()
virtual void	OnStateMachineStart_Implementation()
virtual void	OnStateMachineUpdate_Implementation(float DeltaSeconds)
virtual void	OnStateMachineStop_Implementation()
virtual void	OnStateMachineShutdown_Implementation()
virtual void	OnStateMachineTransitionTaken_Implementation(const FSMTransitionInfo & Transition)
virtual void	OnStateMachineStateChanged_Implementation(const FSMStateInfo & ToState, const FSMStateInfo & FromState)
virtual void	OnStateMachineStateStarted_Implementation(const FSMStateInfo & State)
void	Internal_Update(float DeltaSeconds)
bool	Internal_EvaluateAndTakeTransitionChainByGuid(const FGuid & PathGuid)
void	Internal_EventUpdate()
void	Internal_EventCleanup(const FGuid & PathGuid)
void	BuildStateMachineMap(FSMStateMachine * StateMachine)
void	BuildStateMachineMap(FSMStateMachine * StateMachine, TSet< USMInstance * > & InstancesMapped)
bool	CheckIsInitialized() const
void	UpdateTime()
void	RecordPreviousStateHistory(FSMState_Base * PreviousState)
void	TrimStateHistory()

Public Attributes inherited from USMInstance

	Name
FGuid	RootStateMachineGuid
FOnStateMachineInitializedSignature	OnPreStateMachineInitializedEvent
FOnStateMachineInitializedSignature	OnStateMachineInitializedEvent
FOnStateMachineStartedSignature	OnStateMachineStartedEvent
FOnStateMachineUpdatedSignature	OnStateMachineUpdatedEvent
FOnStateMachineStoppedSignature	OnStateMachineStoppedEvent
FOnStateMachineShutdownSignature	OnStateMachineShutdownEvent
FOnStateMachineTransitionTakenSignature	OnStateMachineTransitionTakenEvent
FOnStateMachineStateChangedSignature	OnStateMachineStateChangedEvent
FOnStateMachineStateStartedSignature	OnStateMachineStateStartedEvent
TArray< TObjectPtr< UObject > >	ReferenceTemplates

Protected Attributes inherited from USMInstance

	Name
TObjectPtr< USMStateMachineComponent >	ComponentOwner
TScriptInterface< ISMStateMachineNetworkedInterface >	NetworkInterface
TMap< FGuid, FSMNode_Base * >	GuidNodeMap
TMap< FGuid, FSMState_Base * >	GuidStateMap
TMap< FGuid, FSMTransition * >	GuidTransitionMap
TSet< FGuid >	StateMachineGuids
FSMStateMachine	RootStateMachine
TObjectPtr< UObject >	R_StateMachineContext
TObjectPtr< USMInstance >	ReferenceOwner
TSubclassOf< USMStateMachineInstance >	StateMachineClass
uint8	bAutoManageTime
uint8	bStopOnEndState
uint8	bCanEverTick
uint8	bCanTickInEditor
uint8	bCanTickWhenPaused
uint8	bTickRegistered
uint8	bTickBeforeInitialize
uint8	bTickBeforeBeginPlay
float	TickInterval
float	TimeSinceAllowedTick
float	WorldSeconds
float	WorldTimeDelta
TObjectPtr< UInputComponent >	InputComponent
TEnumAsByte< ESMStateMachineInput::Type >	AutoReceiveInput
int32	InputPriority
uint8	bBlockInput
TArray< FSMStateHistory >	StateHistory End Input.
int32	StateHistoryMaxCount
uint32	bEnableLogging
uint32	bLogStateChange
uint32	bLogTransitionTaken
uint32	bCanReplicateAsReference
uint32	bCanReplicateNodeInstances
uint32	bCallTickOnManualUpdate
uint32	bIsTicking
uint32	bIsUpdating
uint32	bCanEvaluateTransitionsLocally
uint32	bCanTakeTransitionsLocally
uint32	bCanExecuteStateLogic
uint32	bHasStarted
uint32	bLoadFromStatesCalled
uint32	bInitialized
uint32	bWaitingForStop
uint32	bIsStopping

Friends inherited from USMInstance

	Name
class	USMStateMachineComponent

Public Functions Documentation

function Initialize

virtual void Initialize(
    UObject * Context
) override

---

function Shutdown

virtual void Shutdown() override

---