OnPlayerSpectateEnd

OxideCarbonPlayer

Called when a player spectate ends.

object OnPlayerSpectateEnd(BasePlayer basePlayer, string spectateFilter)

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

Parameters

basePlayer: BasePlayer
spectateFilter: string

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 OnPlayerSpectateEnd(BasePlayer basePlayer, string spectateFilter)
{
    Puts("OnPlayerSpectateEnd");

    // 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 BasePlayer.StopSpectating()

Passes: BasePlayer basePlayer, string spectateFilter

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, this.spectateFilter)Assembly-CSharp.dll

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

public void StopSpectating()
{
	if (!IsSpectating())
	{
		return;
	}
	if (Interface.CallHook("OnPlayerSpectateEnd", this, this.spectateFilter) != null)
	{
		return;
	}
	if ((bool)spectatingTarget)
	{
		SpectatedSubStrategy obj = spectatingTarget.net.SubStrategy as SpectatedSubStrategy;
		if (obj.RemoveSpectator(this))
		{
// …

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.