OnElevatorMove

OxideCarbonElevator

Called when an elevator is moved.

object OnElevatorMove(Elevator elevator, int targetFloor)

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

Parameters

elevator: Elevator
targetFloor: int

Return value

objectReturn non-null to stop the game method.

Example

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

private object OnElevatorMove(Elevator elevator, int targetFloor)
{
    Puts("OnElevatorMove");

    // 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)

bool Elevator.RequestMoveLiftTo(int, ref float, Elevator)

Passes: Elevator elevator, int targetFloor

WorksReturnBehavior: ExitWhenNonNullAssembly-CSharp.dll

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

protected bool RequestMoveLiftTo(int targetFloor, out float timeToTravel, Elevator fromElevator)
{
	timeToTravel = 0f;
	if (Interface.CallHook("OnElevatorMove", this, targetFloor) != null)
	{
		return false;
	}
	if (IsBusy())
	{
		return false;
	}
	if (!IsStatic && !IsPowered())
// …

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.