RustTip

OnOvenToggle

OxideCarbonEntity

Called when an oven toggles.

object OnOvenToggle(BaseOven baseOven, BasePlayer player)
Works — the game method in this build is the one the hook was written for.

Parameters

baseOven
BaseOven
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 OnOvenToggle(BaseOven baseOven, BasePlayer player)
{
    Puts("OnOvenToggle");

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

Passes: BaseOven baseOven, BasePlayer player

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
protected virtual void SVSwitch(RPCMessage msg)
{
	bool flag = msg.read.Bit();
	if (Interface.CallHook("OnOvenToggle", this, msg.player) != null)
	{
		return;
	}
	if (flag == IsOn())
	{
		return;
	}
	BaseLock baseLock = GetLock();
// …

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.