UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SMInstanceElementDataUtil Namespace Reference

Functions

FSimpleMulticastDelegateOnSMInstanceElementsEnabledChanged ()
 
bool SMInstanceElementsEnabled ()
 
ISMInstanceManagerGetSMInstanceManager (const FSMInstanceId &InstanceId)
 
FSMInstanceManager GetSMInstanceFromHandle (const FTypedElementHandle &InHandle, const bool bSilent)
 
FSMInstanceManager GetSMInstanceFromHandleChecked (const FTypedElementHandle &InHandle)
 
template<typename ElementHandleType >
TArray< FSMInstanceManagerGetSMInstancesFromHandles (TArrayView< const ElementHandleType > InHandles, const bool bSilent=false)
 
template<typename ElementHandleType >
TArray< FSMInstanceManagerGetSMInstancesFromHandlesChecked (TArrayView< const ElementHandleType > InHandles)
 

Function Documentation

◆ GetSMInstanceFromHandle()

ENGINE_API FSMInstanceManager SMInstanceElementDataUtil::GetSMInstanceFromHandle ( const FTypedElementHandle InHandle,
const bool  bSilent = false 
)

Attempt to get the static mesh instance ID from the given element handle.

Note
This is not typically something you'd want to use outside of data access within an interface implementation.
Returns
The static mesh instance ID if the element handle contains FSMInstanceElementData which resolved to a valid FSMInstanceManager, otherwise an invalid ID.

◆ GetSMInstanceFromHandleChecked()

ENGINE_API FSMInstanceManager SMInstanceElementDataUtil::GetSMInstanceFromHandleChecked ( const FTypedElementHandle InHandle)

Attempt to get the static mesh instance ID from the given element handle, asserting if the element handle doesn't contain FSMInstanceElementData.

Note
This is not typically something you'd want to use outside of data access within an interface implementation.
Returns
The static mesh instance ID, or an invalid ID if the FSMInstanceElementData didn't resolve to a valid FSMInstanceManager.

◆ GetSMInstanceManager()

ENGINE_API ISMInstanceManager * SMInstanceElementDataUtil::GetSMInstanceManager ( const FSMInstanceId InstanceId)

Get the static mesh instance manager for the given instance.

Returns
The static mesh instance manager, or null if this instance cannot be managed.

◆ GetSMInstancesFromHandles()

TArray< FSMInstanceManager > SMInstanceElementDataUtil::GetSMInstancesFromHandles ( TArrayView< const ElementHandleType InHandles,
const bool  bSilent = false 
)

Attempt to get the static mesh instance IDs from the given element handles.

Note
This is not typically something you'd want to use outside of data access within an interface implementation.
Returns
The static mesh instance IDs of any element handles that contain FSMInstanceElementData which resolves to a valid FSMInstanceManager, skipping any that don't.

◆ GetSMInstancesFromHandlesChecked()

TArray< FSMInstanceManager > SMInstanceElementDataUtil::GetSMInstancesFromHandlesChecked ( TArrayView< const ElementHandleType InHandles)

Attempt to get the static mesh instance IDs from the given element handles, asserting if any element handle doesn't contain FSMInstanceElementData, and skipping any that don't resolve to a valid FSMInstanceManager.

Note
This is not typically something you'd want to use outside of data access within an interface implementation.
Returns
The static mesh instance IDs.

◆ OnSMInstanceElementsEnabledChanged()

ENGINE_API FSimpleMulticastDelegate & SMInstanceElementDataUtil::OnSMInstanceElementsEnabledChanged ( )

◆ SMInstanceElementsEnabled()

ENGINE_API bool SMInstanceElementDataUtil::SMInstanceElementsEnabled ( )

Test whether static mesh instance elements are currently enabled?

Note
Controlled by the CVar: "TypedElements.EnableSMInstanceElements".