OnConsoleCommand

CarbonGlobal

Called when a console command is executed on the server.

object OnConsoleCommand()

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

Parameters

No parameters.

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 OnConsoleCommand()
{
    Puts("OnConsoleCommand");

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

Carbon

ConsoleSystem.CommandResult ConsoleSystem.RunWithResult(ConsoleSystem.Option options, string strCommand, object[] args)

WorksFacepunch.Console

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

public static CommandResult RunWithResult(Option options, string strCommand, params object[] args)
{
	if (Interface.CallHook("OnConsoleCommand") is ConsoleSystem.CommandResult result)
	{
		return result;
	}
	LastError = null;
	string text = BuildCommand(strCommand, args);
	Arg arg = new Arg(options, text);
	bool flag = arg.HasPermission();
	if (!arg.Invalid & flag)
// …

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.