RustTip

OnElevatorCall

OxideCarbonElevator

Called when elevator call occurs.

object OnElevatorCall(Elevator elevator, Elevator elevatorEnt)
Works — the game method in this build is the one the hook was written for.

Parameters

elevator
Elevator
elevatorEnt
Elevator

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 OnElevatorCall(Elevator elevator, Elevator elevatorEnt)
{
    Puts("OnElevatorCall");

    // 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 Elevator.<CallElevator>b__26_0(Elevator)

Passes: Elevator elevator, Elevator elevatorEnt

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

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

[CompilerGenerated]
private void <CallElevator>b__26_0(Elevator elevatorEnt)
{
	if (elevatorEnt.IsTop)
	{
		if (Interface.CallHook("OnElevatorCall", this, elevatorEnt) != null)
		{
			return;
		}
		elevatorEnt.RequestMoveLiftTo(Floor, out var _, this);
	}
}

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.