Skip to main content

ReturnObjectExt settings

ReturnObjectExt inherits the settings of ReturnObject from Object Spawn System and adds root lookup for complex items and event notifications.

FieldTypeDescription
PoolsGameObject[]A VRCObjectPool containing Return targets, or a parent GameObject containing child Pools
ReferenceReturnObjectA reference used to share Pools configured on another ReturnObject or ReturnObjectExt
LayerintLayer number of the GameObject containing the Collider accepted for Return
Default: 13 (Pickup)
Notify Return itemboolSends OnPurabeReturn to every UdonBehaviour directly attached to the returned root
Notify external UdonBehavioursboolSends OnPurabeReturn to External Event Targets
External Event TargetsUdonBehaviour[]External recipients of the Return event
Audio SourceAudioSourceAudio source used after a successful Return
No sound is played when omitted
Audio ClipAudioClipClip played after a successful Return
When omitted, the clip assigned to Audio Source is used; no sound is played when neither is assigned

Pools​

The component searches the registered GameObject itself and its children for VRCObjectPool. Placing multiple VRCObjectPool GameObjects under an empty parent allows them to be registered together.

Reference​

Assigning another ReturnObject or ReturnObjectExt to Reference also searches the Pools configured on that component. If the same GameObject appears in the current and referenced Pools, it is not searched twice.

Configure Reference when the current Pools is empty.

Layer​

Return processing runs only when the layer number of the GameObject containing the Collider that entered the trigger matches this value.

Find the root to Return​

Starting from the GameObject containing the Collider that entered the trigger, the component searches the parent hierarchy.

  1. If HGSpawnHelper is found, Return the GameObject containing that helper
  2. Otherwise, if CompSpawnHelper is found, Return the GameObject containing that helper
  3. If neither is found, Return the GameObject that entered the trigger

A root containing a helper must be registered in a VRCObjectPool reachable from Pools.

Reset during Return​

If the root contains HGSpawnHelper or CompSpawnHelper, the helper's reset logic runs immediately before the Pool hides the root. The same logic runs during a batch Return from ResetSwitch.

See Configure a complex Pickup for setup instructions.