-
-
Notifications
You must be signed in to change notification settings - Fork 783
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
A interest management base class that allows more advanced interest management by bypassing the built-in HashSet checks via Rebuild overriding
- Loading branch information
Showing
5 changed files
with
98 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| // interest management component for custom solutions like | ||
| // distance based, spatial hashing, raycast based, etc. | ||
| using System.Collections.Generic; | ||
| using UnityEngine; | ||
|
|
||
| namespace Mirror | ||
| { | ||
| [DisallowMultipleComponent] | ||
| [HelpURL("https://mirror-networking.gitbook.io/docs/guides/interest-management")] | ||
| public abstract class InterestManagementBase : MonoBehaviour | ||
| { | ||
| // Awake configures LowLevelInterestManagement in NetworkServer/Client | ||
| // Do NOT check for active server or client here. | ||
| // Awake must always set the static aoi references. | ||
| // make sure to call base.Awake when overwriting! | ||
| protected virtual void Awake() | ||
| { | ||
| if (NetworkServer.aoi == null) | ||
| { | ||
| NetworkServer.aoi = this; | ||
| } | ||
| else Debug.LogError($"Only one InterestManagement component allowed. {NetworkServer.aoi.GetType()} has been set up already."); | ||
|
|
||
| if (NetworkClient.aoi == null) | ||
| { | ||
| NetworkClient.aoi = this; | ||
| } | ||
| else Debug.LogError($"Only one InterestManagement component allowed. {NetworkClient.aoi.GetType()} has been set up already."); | ||
| } | ||
|
|
||
| [ServerCallback] | ||
| public virtual void Reset() {} | ||
|
|
||
| // Callback used by the visibility system to determine if an observer | ||
| // (player) can see the NetworkIdentity. If this function returns true, | ||
| // the network connection will be added as an observer. | ||
| // conn: Network connection of a player. | ||
| // returns True if the player can see this object. | ||
| public abstract bool OnCheckObserver(NetworkIdentity identity, NetworkConnectionToClient newObserver); | ||
|
|
||
|
|
||
| // Callback used by the visibility system for objects on a host. | ||
| // Objects on a host (with a local client) cannot be disabled or | ||
| // destroyed when they are not visible to the local client. So this | ||
| // function is called to allow custom code to hide these objects. A | ||
| // typical implementation will disable renderer components on the | ||
| // object. This is only called on local clients on a host. | ||
| // => need the function in here and virtual so people can overwrite! | ||
| // => not everyone wants to hide renderers! | ||
| [ServerCallback] | ||
| public virtual void SetHostVisibility(NetworkIdentity identity, bool visible) | ||
| { | ||
| foreach (Renderer rend in identity.GetComponentsInChildren<Renderer>()) | ||
| rend.enabled = visible; | ||
| } | ||
|
|
||
| /// <summary>Called on the server when a new networked object is spawned.</summary> | ||
| // (useful for 'only rebuild if changed' interest management algorithms) | ||
| [ServerCallback] | ||
| public virtual void OnSpawned(NetworkIdentity identity) {} | ||
|
|
||
| /// <summary>Called on the server when a networked object is destroyed.</summary> | ||
| // (useful for 'only rebuild if changed' interest management algorithms) | ||
| [ServerCallback] | ||
| public virtual void OnDestroyed(NetworkIdentity identity) {} | ||
|
|
||
| public abstract void Rebuild(NetworkIdentity identity, bool initialize); | ||
|
|
||
| /// <summary> | ||
| /// Adds the specified connection to the observers of identity | ||
| /// </summary> | ||
| /// <param name="identity"></param> | ||
| /// <param name="connection"></param> | ||
| protected void AddObserver(NetworkConnectionToClient connection, NetworkIdentity identity) | ||
| { | ||
| connection.AddToObserving(identity); | ||
| identity.observers.Add(connection.connectionId, connection); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Removes the specified connection from the observers of identity | ||
| /// </summary> | ||
| /// <param name="identity"></param> | ||
| /// <param name="connection"></param> | ||
| protected void RemoveObserver(NetworkConnectionToClient connection, NetworkIdentity identity) | ||
| { | ||
| connection.RemoveFromObserving(identity, false); | ||
| identity.observers.Remove(connection.connectionId); | ||
| } | ||
| } | ||
| } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters