OnTeamLeave

OxideCarbonTeam

Called when a team leaves.

object OnTeamLeave(RelationshipManager.PlayerTeam local1, BasePlayer local0)

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

Parameters

local1: RelationshipManager.PlayerTeam
local0: BasePlayer

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 OnTeamLeave(RelationshipManager.PlayerTeam local1, BasePlayer local0)
{
    Puts("OnTeamLeave");

    // 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 RelationshipManager.leaveteam(ConsoleSystem.Arg)

Passes: RelationshipManager.PlayerTeam local1, BasePlayer local0

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

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

// …
public static void leaveteam(ConsoleSystem.Arg arg)
{
	BasePlayer basePlayer = arg.Player();
	if (!(basePlayer == null) && basePlayer.currentTeam != 0L)
	{
		PlayerTeam playerTeam = ServerInstance.FindTeam(basePlayer.currentTeam);
		if (playerTeam != null)
		{
			if (Interface.CallHook("OnTeamLeave", playerTeam, basePlayer) != null)
			{
				return;
			}
			playerTeam.RemovePlayer(basePlayer.userID);
			basePlayer.ClearTeam();
		}
	}
}

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.