Appearance
Migration from v1
Version 1 used the plugin name RegisterSystem. Version 2 uses AuralisRegisterSystem and a different module/API structure. It is not a drop-in replacement, and automatic node/class redirects are not supplied.
Before replacing the plugin
Back up your project and record the old registration/lookup graphs and C++ dependencies. Use the release package for your engine minor version. Keep one active plugin version while migrating.
Update integration points
| Previous intent | Version 2 approach |
|---|---|
| Track actors through old maps/subsystem APIs | Register entries and retain handles. |
| Several names or IDs for one actor | Separate entries and handles. |
| Integer IDs | Make Key from Integer with a consistent namespace. |
| Single shared lookup space | Choose World, GameInstance, LocalPlayer, or Engine explicitly. |
| Priority-sensitive first result | Choose a Sort Mode; do not depend on map order. |
| Combined tag checks | Put all required tags on one logical entry; choose exact or hierarchical matching. |
| Lifecycle cleanup | Participant BeginPlay/EndPlay or manual Unregister calls. |
Update C++ module references to AuralisRegisterSystemRuntime and use the v2 public headers. Rebuild and revisit Blueprint graphs that reference old plugin types or nodes.
Behavior to review
- Participant descriptors default to Replace. Shared group keys need Allow Many.
- Find Actors Around Actor excludes its reference by default; disable Ignore Reference when needed.
- Tags match hierarchically by default. Enable exact matching to preserve explicit-tag semantics.
- Actor helpers return unique matching registered actors.
- Object entries are weak references; struct entries own copies.
- Handle Added, Removed, and Updated explicitly. Treating every non-Added event as removal is incorrect.
- The registry does not provide replication or save-game persistence.
Validate the migration
Complete the quick start in a test map, then validate registration, lookup, metadata changes, cleanup, and any travel/multiplayer scenarios your project uses. The recorded plugin release checks do not replace testing your migrated project.
Version 1 availability and migration assistance are handled through Support.