OnClientCommand

OxideCarbonPlayer

Called when a server console command is executed.

Useful for auditing or overriding server-side console commands.

object OnClientCommand(Network.Connection connection, string local0)

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

Parameters

connection: Network.Connection
local0: string

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 OnClientCommand(Network.Connection connection, string local0)
{
    Puts("OnClientCommand");

    // 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.OnClientCommand(Network.Message)

Passes: Network.Connection connection, string local0

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

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

// …
}
timer.Restart();
string text = packet.read.StringRaw(ConVar.Server.maxpacketsize_command);
if (packet.connection == null || !packet.connection.connected)
{
	Debug.LogWarning("Client without connection tried to run command: " + text);
	return;
}
if (Interface.CallHook("OnClientCommand", packet.connection, text) != null)
{
	return;
}
ConsoleSystem.CommandResult commandResult = ConsoleSystem.RunWithResult(ConsoleSystem.Option.Server.FromConnection(packet.connection).Quiet(), text);
if (commandResult.Result == ConsoleSystem.CommandResultType.Success && (packet.connection.authLevel != 0 || (commandResult.Command.ServerAdmin && !commandResult.Command.ServerUser)))
{
	Analytics.Azure.OnClientRanCommand(packet.connection, text);
}
// …

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.