OnSignalBroadcast

OxideCarbonPlayer

Called when signal broadcast occurs.

object OnSignalBroadcast(BaseEntity baseEntity, Network.Connection sourceConnection, BaseEntity.Signal signal, string arg)

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

baseEntity: BaseEntity
sourceConnection: Network.Connection
signal: BaseEntity.Signal
arg: string

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 OnSignalBroadcast(BaseEntity baseEntity, Network.Connection sourceConnection, BaseEntity.Signal signal, string arg)
{
    Puts("OnSignalBroadcast");

    // 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 BaseEntity.SignalBroadcast(BaseEntity.Signal, string, Network.Connection)

Passes: BaseEntity baseEntity, Network.Connection sourceConnection, BaseEntity.Signal signal, string arg

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

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

public void SignalBroadcast(Signal signal, string arg, Connection sourceConnection = null)
{
	if (net != null && net.group != null)
	{
		if (Interface.CallHook("OnSignalBroadcast", this, sourceConnection, signal, arg) != null)
		{
			return;
		}
		ClientRPC(SignalTarget("SignalFromServerEx"), (int)signal, arg, sourceConnection?.userid ?? 0);
	}
}

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.