OnPlayerKicked

OxideCarbonPlayer

Called when a player is kicked.

void OnPlayerKicked(BasePlayer basePlayer, string reason, bool reserveSlot)
void OnPlayerKicked(Network.Connection connection, object ToString())

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

Parameters

basePlayer: BasePlayer
reason: string
reserveSlot: bool

Return value

voidThe return value is ignored — the hook only notifies.

Example

private void OnPlayerKicked(BasePlayer basePlayer, string reason, bool reserveSlot)
{
    Puts("OnPlayerKicked");
}

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

Injection point 1

Rust.opj (Oxide)

void BasePlayer.Kick(string, bool)

Passes: BasePlayer basePlayer, string reason, bool reserveSlot

WorksReturnBehavior: ContinueArgumentBehavior: AllAssembly-CSharp.dll

Injection point 2

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)

// …
if (connection.IsDevelopmentBuild())
{
	Debug.LogWarning("[EAC] Remove player action skipped for unprotected client: " + connection.ToString());
	return;
}
Debug.Log($"[EAC] Kicking {connection.userid} / {connection.username} ({actionReasonDetailsString})");
connection.authStatusEAC = "eac";
Network.Net.sv.Kick(connection, "EAC: " + actionReasonDetailsString);
Interface.CallHook("OnPlayerKicked", connection, actionReasonDetailsString.ToString());
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)");
	if (data.ActionReasonCode == AntiCheatCommonClientActionReason.PermanentBanned)
	{
		Entity.DeleteBy(connection.userid);
	}
// …

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.