OnPlayerSpectate

OxideCarbonPlayer

Called when player spectate occurs.

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

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

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 StartSpectating()
{
	if (!IsSpectating())
	{
		if (Interface.CallHook("OnPlayerSpectate", this, this.spectateFilter) != null)
		{
			return;
		}
		SetPlayerFlag(PlayerFlags.Spectating, b: true);
		gameObject.SetLayerRecursive(10);
		CancelInvoke(InventoryUpdate);
		ChatMessage("Becoming Spectator");
		UpdateSpectateTarget(spectateFilter, invalidateIfNone: true, announce: false);
// …

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.