RustTip

OnNetworkSubscriptionsUpdate

OxideCarbonNetwork

Called when a network subscriptions is updated.

object OnNetworkSubscriptionsUpdate(Network.Networkable networkable, List<Network.Visibility.Group> list, List<Network.Visibility.Group> list)
object OnNetworkSubscriptionsUpdate(Network.Networkable networkable, List<Network.Visibility.Group> list, object null)
Works — the game method in this build is the one the hook was written for.

Parameters

networkable
Network.Networkable
list
List<Network.Visibility.Group>
list
List<Network.Visibility.Group>

Return value

objectReturn non-null to stop the game method.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnNetworkSubscriptionsUpdate(Network.Networkable networkable, List<Network.Visibility.Group> list, List<Network.Visibility.Group> list)
{
    Puts("OnNetworkSubscriptionsUpdate");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // non-null cancels the game action
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point 1

Rust.opj (Oxide)
bool Network.Networkable.UpdateSubscriptions(int, int)

Passes: Network.Networkable networkable, List<Network.Visibility.Group> list, List<Network.Visibility.Group> list

WorksReturnBehavior: ExitWhenNonNullFacepunch.Network.dll

Where it is called (this branch's game code)

// …
using (TimeWarning.New("UpdateSubscriptions"))
{
	updateSubscriptions = false;
	List<Group> obj = Pool.Get<List<Group>>();
	List<Group> obj2 = Pool.Get<List<Group>>();
	ListHashSet<Group> obj3 = Pool.Get<ListHashSet<Group>>();
	SubStrategy.GatherSubscriptions(this, obj3);
	ListHashSet<Group>.Compare(subscriber.subscribed, obj3, obj, obj2, null);
	if (Interface.CallHook("OnNetworkSubscriptionsUpdate", this, obj, obj2) == null)
	{
		return;
	}
	for (int i = 0; i < obj2.Count; i++)
	{
		Group obj4 = obj2[i];
		if (removeLimit > 0)
		{
// …

Injection point 2

Rust.opj (Oxide)
bool Network.Networkable.UpdateHighPrioritySubscriptions()

Passes: Network.Networkable networkable, List<Network.Visibility.Group> list, object null

WorksReturnBehavior: ExitWhenNonNullFacepunch.Network.dll

Where it is called (this branch's game code)

// …
	return false;
}
using (TimeWarning.New("UpdateHighPrioritySubscriptions"))
{
	List<Group> obj = Pool.Get<List<Group>>();
	ListHashSet<Group> obj2 = Pool.Get<ListHashSet<Group>>();
	SubStrategy.GatherHighPrioSubscriptions(this, obj2);
	ListHashSet<Group>.Compare(subscriber.subscribed, obj2, obj, null, null);
	if (Interface.CallHook("OnNetworkSubscriptionsUpdate", this, obj, null) == null)
	{
		return;
	}
	for (int i = 0; i < obj.Count; i++)
	{
		Group obj3 = obj[i];
		subscriber.Subscribe(obj3);
		if (handler != null && obj3.HasSubscribers())
// …

Sources: Rust.opj from OxideMod/Oxide.Rust (MIT) and hook metadata of the Carbon documentation (MIT). Method code is decompiled from this branch's server.