RustTip

CanSpectateTarget

OxideCarbonPlayer

Called to determine whether to spectate target.

Return true to allow the action and false to block it.

object CanSpectateTarget(BasePlayer basePlayer, string strName)
Works — the game method in this build is the one the hook was written for.

Parameters

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

    // 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.UpdateSpectateTarget(string, bool, bool)

Passes: BasePlayer basePlayer, string strName

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

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

public void UpdateSpectateTarget(string strName, bool invalidateIfNone = false, bool announce = true)
if (Interface.CallHook("CanSpectateTarget", this, strName) != null)
{
	return;
}
{
	bool checkName;
	using (TimeWarning.New("BasePlayer.UpdateSpectateTarget"))
	{
		spectateFilter = strName;
// …

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.