OnBoomboxStationUpdate

OxideCarbonRadio

Called when a boombox station is updated.

object OnBoomboxStationUpdate(BoomBox boomBox, string local0, BasePlayer player)

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

Parameters

boomBox: BoomBox
local0: string
player: BasePlayer

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 OnBoomboxStationUpdate(BoomBox boomBox, string local0, BasePlayer player)
{
    Puts("OnBoomboxStationUpdate");

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

Passes: BoomBox boomBox, string local0, BasePlayer player

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: UseArgumentString (this, l0, a0.player)Assembly-CSharp.dll

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

public void Server_UpdateRadioIP(BaseEntity.RPCMessage msg)
{
	string text = msg.read.String();
	if (Interface.CallHook("OnBoomboxStationUpdate", this, text, msg.player) != null)
	{
		return;
	}
	if (IsStationValid(text))
	{
		if (msg.player != null)
		{
			ulong assignedRadioBy = msg.player.userID.Get();
// …

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.