OnPlayerBanned

OxideCarbonPlayer

Called when a player is banned.

void OnPlayerBanned(Network.Connection connection, object ToString())

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

Parameters

connection: Network.Connection
ToString(): object

Return value

voidThe return value is ignored — the hook only notifies.

Example

private void OnPlayerBanned(Network.Connection connection, object ToString())
{
    Puts("OnPlayerBanned");
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Where it is called

Oxide core (Oxide.Rust)

RustCore::OnServerUserSet(ulong steamId, ServerUsers.UserGroup group, string playerName, string reason, long expiry)

Oxide core code — the hook is called from here

private void OnServerUserSet(ulong steamId, ServerUsers.UserGroup group, string playerName, string reason, long expiry)
{
    if (serverInitialized && group == ServerUsers.UserGroup.Banned)
    {
        string playerId = steamId.ToString();
        IPlayer player = Covalence.PlayerManager.FindPlayerById(playerId);
        Interface.CallHook("OnPlayerBanned", playerName, steamId, player?.Address ?? "0", reason, expiry);
        Interface.CallHook("OnUserBanned", playerName, playerId, player?.Address ?? "0", reason, expiry);
    }
}

Where it is called

Oxide core (Oxide.Rust)

RustCore::IOnPlayerBanned(Connection connection, AuthResponse status)

Oxide core code — the hook is called from here

private void IOnPlayerBanned(Connection connection, AuthResponse status)
{
    // TODO: Get BasePlayer and pass instead of Connection
    Interface.CallHook("OnPlayerBanned", connection, status.ToString());
}

Injection point

Rust.opj (Oxide)

void EACServer.OnClientActionRequired(ref Epic.OnlineServices.AntiCheatCommon.OnClientActionRequiredCallbackInfo)

Passes: Network.Connection connection, object ToString()

WorksReturnBehavior: ContinueArgumentBehavior: UseArgumentString (l2, l3.ToString())Assembly-CSharp.dll

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

// …
}
Debug.Log($"[EAC] Kicking {connection.userid} / {connection.username} ({actionReasonDetailsString})");
connection.authStatusEAC = "eac";
Network.Net.sv.Kick(connection, "EAC: " + actionReasonDetailsString);
if (data.ActionReasonCode == AntiCheatCommonClientActionReason.PermanentBanned || data.ActionReasonCode == AntiCheatCommonClientActionReason.TemporaryBanned)
{
	connection.authStatusEAC = "eacbanned";
	ConsoleNetwork.BroadcastToAllClients("chat.add", 2, 0, "<color=#fff>SERVER</color> Kicking " + connection.username + " (banned by anticheat)");
	Interface.CallHook("OnPlayerBanned", connection, actionReasonDetailsString.ToString());
	if (data.ActionReasonCode == AntiCheatCommonClientActionReason.PermanentBanned)
	{
		Entity.DeleteBy(connection.userid);
	}
}
UnregisterClientOptions options = new UnregisterClientOptions
{
	ClientHandle = clientHandle
// …

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.