Skip to content
2.0Product documentation

Blueprint guide ​

Find core nodes under Auralis | Register System, convenience nodes under Helpers, and spatial nodes under Actors. Most new context-based helpers default to World scope; expand advanced pins to choose another scope or local player.

Register and remove ​

Node/componentUse
Auralis Register ParticipantRegister owner, component, and additional objects on BeginPlay; unregister its handles on EndPlay.
Register Object / Register StructRegister one weak object reference or an owned struct copy; save the returned handle.
Register ObjectsApply one descriptor to an array; output positions match input positions, including invalid failures.
Unregister / Unregister HandlesRemove saved handles, including handles from different scopes.
Unregister ObjectRemove all registrations for this object in one scope.
Unregister MatchingRemove a sorted snapshot of matches; respects the query limit.
Clear RegistryRemove existing slots including stale objects; callback-created entries can survive.
Is Handle ValidTest a live registration.

Batch registration is sequential and is not a rollback transaction. Duplicate policies and synchronous listeners can invalidate an earlier returned handle.

Participant component ​

Register Owner is enabled by default. Register This Component is disabled. Additional Objects share one Additional Object Descriptor. Changing a descriptor or scope at runtime takes effect when Register Now runs again; it first removes the handles currently owned by that component. Unregister All removes those component-owned handles.

Find and count ​

NeedNode
One/all unique objects by a keyFind Object by Key / Find Objects by Key
One/all unique objects by a tagFind Object by Tag / Find Objects by Tag
Combined class, interface, tags, and expressionFind Object / Find Objects with a query
Full object or struct result metadataFind First / Find All
Current snapshot by saved handleTry Get Result
Membership and per-object entriesIs Object Registered / Get Object Registrations
Entry/object countsCount Matches / Count Objects
Existence checksHas Matches / Has Multiple Objects
Integer-based identifiersMake Key from Integer

Set Object Class on a typed object helper to control the output type. Use a full result node for struct values. Always handle null objects, empty arrays, false success outputs, and invalid handles.

Make Key from Integer creates keys such as LegacyId:42. Use the same namespace on both sides. Zero and negative IDs are valid.

Update metadata ​

Update Registration changes key, tags, and priority in place while preserving the handle and registration age. Its descriptor policy handles collisions with other entries. It does not replace the object or struct payload.

Use Set Registration Tags, Add Registration Tags, Remove Registration Tags, or Set Registration Priority for targeted edits. Removing tags removes explicit stored tag identities, not their descendants. Read current metadata with Try Get Result; older results remain snapshots.

React to changes ​

  1. Call Get Registry for the intended scope.
  2. Check that the registry is valid.
  3. Bind its On Registry Changed delegate.
  4. Handle Added, Removed, and Updated explicitly.
  5. Refresh your UI/list from current state as appropriate; disconnect listeners when their owner no longer needs them.

Broadcast Blueprint Events must be enabled in Project settings. The setting gates both Blueprint and native listeners.

SYNCHRONOUS CALLBACKS

The delegate runs on the game thread inside the mutation call. Keep callbacks short and avoid uncontrolled register/unregister loops. A successful call can be followed by a listener removing that same handle.

During scope shutdown, the registry clears its state before broadcasting Removed snapshots and refuses new registrations. A reusable Clear Registry operation has different reentry behavior: new generations created by removal callbacks can remain.

Diagnostics and spatial queries ​

Get Registry Debug Info returns text for a debug widget; the registry also exposes statistics, validation, rebuilding indexes, and stale-object compaction. See Settings and diagnostics. The eight spatial helpers are described in Actor queries.

Multiple products. One knowledge base.