OnDieselEngineToggle

OxideCarbonEntity

Called when a diesel engine toggles.

object OnDieselEngineToggle(DieselEngine dieselEngine, BasePlayer player)

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

Parameters

dieselEngine: DieselEngine
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 OnDieselEngineToggle(DieselEngine dieselEngine, BasePlayer player)
{
    Puts("OnDieselEngineToggle");

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

Passes: DieselEngine dieselEngine, BasePlayer player

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

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

[RPC_Server]
[RPC_Server.IsVisible(6f)]
public void EngineSwitch(RPCMessage msg)
{
	if (Interface.CallHook("OnDieselEngineToggle", this, msg.player) != null)
	{
		return;
	}
	if (msg.read.Bit())
	{
		if (GetFuelAmount() > 0)
		{
			EngineOn();
// …

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.