OnSamSiteModeToggle

OxideCarbonEntity

Called when a sam site mode toggles.

object OnSamSiteModeToggle(SamSite samSite, BasePlayer local0, bool local1)

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

Parameters

samSite: SamSite
local0: BasePlayer
local1: bool

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 OnSamSiteModeToggle(SamSite samSite, BasePlayer local0, bool local1)
{
    Puts("OnSamSiteModeToggle");

    // 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 SamSite.ToggleDefenderMode(BaseEntity.RPCMessage)

Passes: SamSite samSite, BasePlayer local0, bool local1

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

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

// …
	{
		return;
	}
	bool flag = msg.read.Bit();
	if (flag == IsInDefenderMode())
	{
		return;
	}
	if (Interface.CallHook("OnSamSiteModeToggle", this, player, flag) != null)
	{
		return;
	}
	using FlagsUpdateScope flagsUpdateScope = StartSetFlags(FlagsUpdateMode.SendNetworkUpdate);
	flagsUpdateScope.Set(Flag_ManuallySetMode, flag);
	flagsUpdateScope.Set(Flag_TargetMode, flag);
}

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.