OnServerMessage

OxideCarbonServer

Called when a server is received.

object OnServerMessage(string message, string username, string color, ulong userid)

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

Parameters

message: string
username: string
color: string
userid: ulong

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 OnServerMessage(string message, string username, string color, ulong userid)
{
    Puts("OnServerMessage");

    // 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 ConVar.Chat.Broadcast(string, string, string, ulong)

Passes: string message, string username, string color, ulong userid

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustParamsAssembly-CSharp.dll

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

public static void Broadcast(string message, string username = "SERVER", string color = "#eee", ulong userid = 0uL)
{
	if (Interface.CallHook("OnServerMessage", message, username, color, userid) != null)
	{
		return;
	}
	string text = username.EscapeRichText();
	ConsoleNetwork.BroadcastToAllClients("chat.add", 2, 0, "<color=" + color + ">" + text + "</color> " + message);
	Record(new ChatEntry
	{
		Channel = ChatChannel.Server,
// …

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.