OnSendModelState

OxideCarbonPlayer

Called when send model state occurs.

object OnSendModelState(BasePlayer basePlayer, object limitNetworking)

Works — the game method in this build is the one the hook was written for.

Parameters

basePlayer: BasePlayer
limitNetworking: object

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 OnSendModelState(BasePlayer basePlayer, object limitNetworking)
{
    Puts("OnSendModelState");

    // 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

Rust.opj (Oxide)

void BasePlayer.SendModelState(bool)

Passes: BasePlayer basePlayer, object limitNetworking

WorksReturnBehavior: ExitWhenNonNullAssembly-CSharp.dll

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

// …
		if (lastModelState == null)
		{
			lastModelState = modelState.Copy();
		}
		else
		{
			modelState.CopyTo(lastModelState);
		}
		if (Interface.CallHook("OnSendModelState", this, BaseNetworkable.limitNetworking) == null)
		{
			return this;
		}
		ClientRPC(RpcTarget.NetworkGroup("OnModelState"), modelState);
	}
}

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.