OnBoomboxToggle

OxideCarbonRadio

Called when a boombox toggles.

object OnBoomboxToggle(BoomBox boomBox, BasePlayer player, bool local1)

Method changed — check — the game method differs from the one the hook is recorded for in Oxide. The hook is still called, but its place may have shifted — worth checking after an update.

Parameters

boomBox: BoomBox
player: 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 OnBoomboxToggle(BoomBox boomBox, BasePlayer player, bool local1)
{
    Puts("OnBoomboxToggle");

    // 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 BoomBox.ServerTogglePlay(BaseEntity.RPCMessage, bool)

Passes: BoomBox boomBox, BasePlayer player, bool local1

Method changed — checkReturnBehavior: ExitWhenNonNullArgumentBehavior: UseArgumentString (this, a0.player, l1)Assembly-CSharp.dll

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

public void ServerTogglePlay(BaseEntity.RPCMessage msg, bool bypassPower = false)
{
	if (IsPowered() || bypassPower)
	{
		BasePlayer player = msg.player;
		bool flag = msg.read.ReadByte() == 1;
		if (Interface.CallHook("OnBoomboxToggle", this, msg.player, flag) != null)
		{
			return;
		}
		if (flag && baseEntity is DeployableBoomBox deployableBoomBox && player != null && player.IsConnected && !player.IsNpc && !player.IsBot && player.HasActiveMission())
		{
			BaseMission.MissionEventPayload payload = new BaseMission.MissionEventPayload
			{
				NetworkIdentifier = deployableBoomBox.net.ID,
// …

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.