Appearance
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/component | Use |
|---|---|
| Auralis Register Participant | Register owner, component, and additional objects on BeginPlay; unregister its handles on EndPlay. |
| Register Object / Register Struct | Register one weak object reference or an owned struct copy; save the returned handle. |
| Register Objects | Apply one descriptor to an array; output positions match input positions, including invalid failures. |
| Unregister / Unregister Handles | Remove saved handles, including handles from different scopes. |
| Unregister Object | Remove all registrations for this object in one scope. |
| Unregister Matching | Remove a sorted snapshot of matches; respects the query limit. |
| Clear Registry | Remove existing slots including stale objects; callback-created entries can survive. |
| Is Handle Valid | Test 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
| Need | Node |
|---|---|
| One/all unique objects by a key | Find Object by Key / Find Objects by Key |
| One/all unique objects by a tag | Find Object by Tag / Find Objects by Tag |
| Combined class, interface, tags, and expression | Find Object / Find Objects with a query |
| Full object or struct result metadata | Find First / Find All |
| Current snapshot by saved handle | Try Get Result |
| Membership and per-object entries | Is Object Registered / Get Object Registrations |
| Entry/object counts | Count Matches / Count Objects |
| Existence checks | Has Matches / Has Multiple Objects |
| Integer-based identifiers | Make 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
- Call Get Registry for the intended scope.
- Check that the registry is valid.
- Bind its On Registry Changed delegate.
- Handle Added, Removed, and Updated explicitly.
- 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.