RealDocs

UBlueprintInstancedStructLibrary::GetInstancedStructValue

function Engine Blueprint Since 5.0
#include "Kismet/BlueprintInstancedStructLibrary.h"
Access: public Specifiers: staticBlueprintCallableCustomThunk

Description

Extracts the value from an FInstancedStruct into the connected output pin, but only if the pin's type matches the type currently stored inside the instanced struct.

Caveats & Gotchas

  • ExecResult expands to two separate exec pins (Valid / Not Valid) via ExpandEnumAsExecs — always branches, so downstream logic must handle both.
  • A type mismatch between InstancedStruct's stored type and the requested output pin routes execution to "Not Valid"; it does not throw or produce a default-constructed value on that pin.
  • The `int32& Value` parameter is a CustomThunk wildcard placeholder, not a literal int — the real output type is whatever struct type is wired to the pin in Blueprint.

Signature

static ENGINE_API void GetInstancedStructValue(EStructUtilsResult& ExecResult, UPARAM(Ref) const FInstancedStruct& InstancedStruct, int32& Value);

Parameters

Name Type Description Default
ExecResult EStructUtilsResult& Drives the ExpandEnumAsExecs Valid/NotValid exec pins in Blueprint.
InstancedStruct const FInstancedStruct& Instanced struct to read from.
Value int32& Wildcard struct pin (CustomStructureParam) — receives the extracted value if the type matches.

Return Type

void

Example

Safely unpack an instanced struct Blueprint
Get Instanced Struct Value node with the Instanced Struct input and a Vector wildcard output pin; on the Valid exec pin the Vector output holds the extracted data, on Not Valid the stored type didn't match Vector.

Version History

Introduced in: 5.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.