FSMInstanceElementIdMap | Unreal Engine 5.2 Documentation

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Elements > API/Runtime/Engine/Elements/SMInstance

Inheritance Hierarchy

FGCObject
FSMInstanceElementIdMap

References


Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/Elements/SMInstance/SMInstanceElementId.h
Include	#include "Elements/SMInstance/SMInstanceElementId.h"

Syntax

class FSMInstanceElementIdMap : public FGCObject

Remarks

Mapping between the instance ID used by typed elements and the corresponding instance index on the ISM components. This mapping will be kept up-to-date via the add/remove operations of the ISM components, as well as undo/redo.

Destructors

	Type	Name	Description
		~FSMInstanceElementIdMap ()

Functions

Type	Name	Description
FSMInstanceElementIdMap &	Get ()
FSMInstanceElementId	GetSMInstanceElementIdFromSMInstanceId ( const FSMInstanceId& InSMInstanceId, const bool bAllowCreate )	Given a FSMInstanceId, attempt to convert it into a FSMInstanceElementId.
TArray< FSMInstanceElementId >	GetSMInstanceElementIdsForComponent ( UInstancedStaticMeshComponent* InComponent )	Given an ISM component, get all FSMInstanceElementId values that are currently mapped for it.
FSMInstanceId	GetSMInstanceIdFromSMInstanceElementId ( const FSMInstanceElementId& InSMInstanceElementId )	Given a FSMInstanceElementId, attempt to convert it into a FSMInstanceId.
void	OnComponentReplaced ( UInstancedStaticMeshComponent* InOldComponent, UInstancedStaticMeshComponent* InNewComponent )	Called when one ISM component is replaced with another, and attempts to copy the ID mapping of the old component to the new.
FOnInstancePreRemoval &	OnInstancePreRemoval ()
FOnInstanceRemapped &	OnInstanceRemapped ()
FOnInstanceRemoved &	OnInstanceRemoved ()
void	SerializeIdMappings ( FSMInstanceElementIdMapEntry* InEntry, FArchive& Ar )

Overridden from FGCObject

	Type	Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	Pure virtual that must be overloaded by the inheriting class.
	FString	GetReferencerName ()	Overload this method to report a name for your referencer

Typedefs

Name	Description
FOnInstancePreRemoval	Delegate called when a static mesh instance is about to be removed from the instances array on its component, and the associated ID for a SMInstance element will be unmapped.
FOnInstanceRemapped	Delegate called when a static mesh instance has been relocated within the instances array on its component (eg, because another instance was removed or added to the array).
FOnInstanceRemoved	Delegate called when a static mesh instance has been removed from the instances array on its component, and the associated ID for a SMInstance element has been unmapped.

Navigation