OnBoomboxStationValidate

OxideCarbonRadio

Called when a boombox station is validated.

object OnBoomboxStationValidate(string url)

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

Parameters

url: string

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnBoomboxStationValidate(string url)
{
    Puts("OnBoomboxStationValidate");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // your value instead of the game result
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)

bool BoomBox.IsStationValid(string)

Passes: string url

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

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

private static bool IsStationValid(string url)
{
	ParseServerUrlList();
	object returnvar = Interface.CallHook("OnBoomboxStationValidate", url);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	ShoutcastStreamer.CheckBuiltInRadios();
	if (ValidStations == null || !ValidStations.ContainsValue(url))
	{
		if (ServerValidStations == null || !ServerValidStations.ContainsValue(url))
// …

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.