OnBroadcastCommand

OxideCarbonServer

Called when a server console command is executed.

Useful for auditing or overriding server-side console commands.

object OnBroadcastCommand(string strCommand, object[] args)

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

Parameters

strCommand: string
args: object[]

Return value

objectReturn non-null to cancel the game action.

Example

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

private object OnBroadcastCommand(string strCommand, object[] args)
{
    Puts("OnBroadcastCommand");

    // 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 ConsoleNetwork.BroadcastToAllClients(string, object[])

Passes: string strCommand, object[] args

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (a0, a1)Assembly-CSharp.dll

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

public static void BroadcastToAllClients(string strCommand, params object[] args)
{
	if (!Net.sv.IsConnected())
	{
		return;
	}
	if (Interface.CallHook("OnBroadcastCommand", strCommand, args) != null)
	{
		return;
	}
	List<Connection> obj = Pool.Get<List<Connection>>();
	foreach (Connection connection in Net.sv.connections)
	{
		if (connection.connected)
		{
// …

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.