|
| 1 | +--- |
| 2 | +id: deferred-despawning |
| 3 | +title: Deferred despawning |
| 4 | +--- |
| 5 | + |
| 6 | +:::info Distributed authority only |
| 7 | + |
| 8 | +Deferred despawning is only available for games using a [distributed authority topology](../terms-concepts/distributed-authority.md). |
| 9 | + |
| 10 | +::: |
| 11 | + |
| 12 | +In addition to the visual latency issues described on the [spawning synchronization page](spawning-synchronization.md), networked games also experience latency issues when despawning objects. In [client-server](../terms-concepts/client-server.md) contexts, these problems are typically addressed using client prediction models, but in a distributed authority context there is a simpler alternative solution: deferred despawning. |
| 13 | + |
| 14 | +## Why deferred despawning |
| 15 | + |
| 16 | +Issues with despawning occur when objects are despawned too early. The client that owns the projectile detects a collision, triggers any local animations, and despawns the projectile locally. For the player being hit, they see the projectile despawn before it reaches them and animations can appear to trigger at the wrong point in time. This can be seen in the diagram below. |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | +Deferred despawning allows you to add a tick-based delay to a NetworkObject prior to despawning it locally. The deferred despawn tick value is then added to the `DestroyObjectMessage` so that other clients, upon receiving the message, defer processing the destroy message until the specified tick value has been reached. The results of this deferred despawn adjustment can be seen in the diagram below. |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | +Deferred despawning allows non-owner instances of an object to complete their interpolation towards the last transform state update before despawning the object. Even though non-owner clients can be visually latent by several network ticks behind the authority, all clients end up with the same visual experience since NetworkTransform deltas are tick synchronized. |
| 25 | + |
| 26 | +## Implementing deferred despawning |
| 27 | + |
| 28 | +Implementing deferred despawning is a three-step process, as described in the diagram below. |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | +The process above is broken down into two steps that are performed on the authority instance, and one step performed on the non-authority instance(s). |
| 33 | + |
| 34 | +|Authority instance|Non-authority instance(s)| |
| 35 | +|---|---| |
| 36 | +|1. Invoke the `NetworkObject.DeferDespawn` method while providing the number of ticks to offset despawning by on non-authority instance(s), relative to the local client's current known network tick.<br/> 2. If overridden, handle any changes to state (i.e. NetworkVariables) when `NetworkBehaviour.OnDeferringDespawn` is invoked.|1. Use any updated states to synchronize the visual portion of a deferred despawn (for example, starting a particle system to represent the point of impact).| |
| 37 | + |
| 38 | +### Deferred despawning example |
| 39 | + |
| 40 | +Below is a basic example demonstrating how deferred despawning can be used to visually synchronize a projectile's impact with explosion effects: |
| 41 | + |
| 42 | +``` |
| 43 | +public class ExplodingProjectile : NetworkBehaviour |
| 44 | +{ |
| 45 | + // The explosion network prefab |
| 46 | + public GameObject ExplosionPrefab; |
| 47 | + public int DespawnTickOffset = 4; |
| 48 | + private ExplosionFx m_SpawnedExplosion; |
| 49 | +
|
| 50 | +
|
| 51 | + // Permission are always owner write and everyone read in distributed authority |
| 52 | + // Authority assigns this value after spawning the ExplosionFx within the overridden |
| 53 | + // OnDeferringDespawn method prior to the local ExplodingPrrojectile is despawned |
| 54 | + // locally. |
| 55 | + private NetworkVariable<NetworkBehaviourReference> m_ExplosionFx = new NetworkVariable<NetworkBehaviourReference>(); |
| 56 | +
|
| 57 | +
|
| 58 | + public override void OnNetworkSpawn() |
| 59 | + { |
| 60 | + if (!HasAuthority) |
| 61 | + { |
| 62 | + m_ExplosionFx.OnValueChanged += OnExplosionFxChanged; |
| 63 | + } |
| 64 | +
|
| 65 | +
|
| 66 | + base.OnNetworkSpawn(); |
| 67 | + } |
| 68 | +
|
| 69 | +
|
| 70 | + private void OnCollisionEnter(Collision collision) |
| 71 | + { |
| 72 | + if (!IsSpawned || !HasAuthority) |
| 73 | + { |
| 74 | + return; |
| 75 | + } |
| 76 | + // Typically you would want to check what you hit |
| 77 | + // to make sure you want to "explode" the projectile |
| 78 | + // first. This example assumes that a check was performed. |
| 79 | +
|
| 80 | +
|
| 81 | + // Start with the projectile's position |
| 82 | + var explodePoint = transform.position; |
| 83 | + if (collision.contacts.Length > 0 ) |
| 84 | + { |
| 85 | + // Example purposes, just use the first contact |
| 86 | + explodePoint = collision.contacts[0].point; |
| 87 | + } |
| 88 | + HandleExplosion(explodePoint); |
| 89 | + } |
| 90 | +
|
| 91 | +
|
| 92 | + private void HandleExplosion(Vector3 explodePoint) |
| 93 | + { |
| 94 | + // Example purposes only, we recommend using object pools |
| 95 | + // using an INetworkPrefabInstanceHandler implementation |
| 96 | + // and registering that with the NetworkManager.PrefabHandler. |
| 97 | + var instance = Instantiate(ExplosionPrefab); |
| 98 | +
|
| 99 | + // position the explosion |
| 100 | + instance.transform.position = explodePoint; |
| 101 | +
|
| 102 | +
|
| 103 | + // Assign this for later use (example purposes) |
| 104 | + m_SpawnedExplosion = instance.GetComponent<ExplosionFx>(); |
| 105 | +
|
| 106 | + // Spawn the explosion |
| 107 | + var instanceObj = instance.GetComponent<NetworkObject>(); |
| 108 | + instanceObj.Spawn(); |
| 109 | +
|
| 110 | +
|
| 111 | + // Defer the despawning of the projectile instance |
| 112 | + NetworkObject.DeferDespawn(DespawnTickOffset); |
| 113 | +
|
| 114 | + // The local instance should be despawned at this point |
| 115 | + } |
| 116 | +
|
| 117 | +
|
| 118 | + /// <summary> |
| 119 | + /// Invoked on the authority side when it is deferring the |
| 120 | + /// despawning of the NetworkObject. |
| 121 | + /// </summary> |
| 122 | + /// <remarks> |
| 123 | + /// This is a good time to set any NetworkVariable states as |
| 124 | + /// they will be sent to clients prior to the defer despawn message. |
| 125 | + /// </remarks> |
| 126 | + /// <param name="despawnTick">the final future network tick |
| 127 | + /// non-authority instances will despawn the clone instance.</param> |
| 128 | + public override void OnDeferringDespawn(int despawnTick) |
| 129 | + { |
| 130 | + // This lets the non-authority instances know what ExplosionFx instance is |
| 131 | + // associated with this NetworkObject. |
| 132 | + m_ExplosionFx = new NetworkVariable<NetworkBehaviourReference>(m_SpawnedExplosion); |
| 133 | +
|
| 134 | +
|
| 135 | + // Apply any other state updates here |
| 136 | +
|
| 137 | +
|
| 138 | + base.OnDeferringDespawn(despawnTick); |
| 139 | + } |
| 140 | +
|
| 141 | +
|
| 142 | + /// <summary> |
| 143 | + /// Non-authority registers for this and acquires the ExplosionFX |
| 144 | + /// of the network prefab spawned. |
| 145 | + /// </summary> |
| 146 | + private void OnExplosionFxChanged(NetworkBehaviourReference previous, NetworkBehaviourReference current) |
| 147 | + { |
| 148 | + // If possible, get the ExplosionFx component |
| 149 | + current.TryGet(out m_SpawnedExplosion); |
| 150 | + } |
| 151 | +
|
| 152 | +
|
| 153 | + public override void OnNetworkDespawn() |
| 154 | + { |
| 155 | + // When non-authority instances finally despawn, |
| 156 | + // the explosion FX will begin playing. |
| 157 | + if (!HasAuthority) |
| 158 | + { |
| 159 | + if (m_SpawnedExplosion) |
| 160 | + { |
| 161 | + m_SpawnedExplosion.SetParticlePlayingState(true); |
| 162 | + } |
| 163 | + m_ExplosionFx.OnValueChanged -= OnExplosionFxChanged; |
| 164 | + } |
| 165 | + base.OnNetworkDespawn(); |
| 166 | + } |
| 167 | +} |
| 168 | +``` |
| 169 | + |
| 170 | +The pseudo script above excludes the motion of the projectile, but makes the assumption that authority is moving the projectile and that when the projectile impacts a valid object, the `OnCollisionEnter` method will be invoked. |
| 171 | + |
| 172 | +Authority instance|Non-authority instance(s)| |
| 173 | +|---|---| |
| 174 | +|1. Move until collision (excluded from the above example)<br/> 2. Upon collision: instantiate ExplosionFX, position ExplosionFX, acquire the ExplosionFX component, spawn the ExplosionFX, defer despawning the projectile<br/> 3. When deferring despawning the projectile, assign the NetworkBehaviourReference to the ExplosionFX<br/> 4. Despawn locally (happens automatically at end of the DeferDespawn)|1. When spawned, register changes to the m_ExplosionFX NetworkVariable<br/> 2. Continue to interpolate towards last updated position (handled by NetworkTransform)<br/> 3. When m_ExplosionFX NetworkVariable changes, assign the local m_SpawnExplosion ExplosionFX component of the explosion associated with the current projectile instance (to be used when despawned)<br/> 4.When despawned, start the ExplosionFX particle system via m_SpawnExplosion| |
| 175 | + |
| 176 | +The non-authority instance still spawns the ExplosionFX NetworkObject at the same relative time frame as the authority, however it doesn't start its particle system until the local non-authority projectile instance is despawned. Since the projectile has had its despawn deferred until a future network tick, the non-authority instance interpolates up to its last updated position from the authority side and then shortly (in milliseconds) after is despawned and the explosion particle system started. |
| 177 | + |
| 178 | +:::info Example purposes only |
| 179 | + |
| 180 | +The spawning explosion FX example above is only for example purposes and would be less bandwidth and processor intensive if you used a local particle FX pool that you pull from and began playing on both the authority and non-authority sides when the object in question is despawned. The same deferred despawn principles would be used without the need to spawn an additional object. However, providing the spawned explosion example also covers other scenarios where spawning is required. |
| 181 | + |
| 182 | +::: |
| 183 | + |
| 184 | +For example purposes, the below script is all that you would need to control starting and stopping the explosion particle system: |
| 185 | + |
| 186 | +``` |
| 187 | +public class ExplosionFx : NetworkBehaviour |
| 188 | +{ |
| 189 | + public ParticleSystem ParticleSystem; |
| 190 | +
|
| 191 | +
|
| 192 | + private void OnEnable() |
| 193 | + { |
| 194 | + // In the event a pool is used, it is always good to |
| 195 | + // make sure the particle system is not playing |
| 196 | + SetParticlePlayingState(); |
| 197 | + } |
| 198 | +
|
| 199 | +
|
| 200 | + public override void OnNetworkSpawn() |
| 201 | + { |
| 202 | + // Authority starts the particle system (locally) when spawned |
| 203 | + if (HasAuthority) |
| 204 | + { |
| 205 | + SetParticlePlayingState(true); |
| 206 | + } |
| 207 | + base.OnNetworkSpawn(); |
| 208 | + } |
| 209 | +
|
| 210 | +
|
| 211 | + /// <summary> |
| 212 | + /// Used to start/stop the particle system |
| 213 | + /// Non-Authority starts this when its associated projectile |
| 214 | + /// is finally despawned |
| 215 | + /// </summary> |
| 216 | + public void SetParticlePlayingState(bool isPlaying = false) |
| 217 | + { |
| 218 | + if (ParticleSystem) |
| 219 | + { |
| 220 | + if(isPlaying) |
| 221 | + { |
| 222 | + ParticleSystem.Play(); |
| 223 | + } |
| 224 | + else |
| 225 | + { |
| 226 | + ParticleSystem.Stop(); |
| 227 | + } |
| 228 | + } |
| 229 | + } |
| 230 | +} |
| 231 | +``` |
| 232 | + |
| 233 | +Note that the authority automatically starts the particle system upon being spawned. Non-authority instances are started by their paired projectile when despawned at the end of the deferred despawn defined network tick. |
0 commit comments