OnRfBroadcasterRemove

OxideCarbonRadio

Called when an RF broadcaster is removed.

object OnRfBroadcasterRemove(IRFObject obj, int frequency)

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

Parameters

obj: IRFObject
frequency: int

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 OnRfBroadcasterRemove(IRFObject obj, int frequency)
{
    Puts("OnRfBroadcasterRemove");

    // 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 RFManager.RemoveBroadcaster(int, IRFObject)

Passes: IRFObject obj, int frequency

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

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

public static void RemoveBroadcaster(int frequency, IRFObject obj)
{
	frequency = ClampFrequency(frequency);
	if (Interface.CallHook("OnRfBroadcasterRemove", obj, frequency) != null)
	{
		return;
	}
	HashSet<IRFObject> broadcasterSet = GetBroadcasterSet(frequency);
	if (broadcasterSet.RemoveWhere((IRFObject b) => b == null || !b.IsValidEntityReference()) > 0)
	{
		Debug.LogWarning($"Found null entries in the RF broadcaster set for frequency {frequency}... cleaning up.");
	}
// …

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.