OnLiftUse

OxideCarbonElevator

Called when a lift uses.

object OnLiftUse(Lift lift, BasePlayer player)
object OnLiftUse(ProceduralLift proceduralLift, BasePlayer player)

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

Parameters

lift: Lift
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 OnLiftUse(Lift lift, BasePlayer player)
{
    Puts("OnLiftUse");

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

Rust.opj (Oxide)

void Lift.RPC_UseLift(BaseEntity.RPCMessage)

Passes: Lift lift, 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)]
private void RPC_UseLift(RPCMessage rpc)
{
	if (rpc.player.CanInteract() && PlayerIsAtCabin(rpc.player))
	{
		if (Interface.CallHook("OnLiftUse", this, rpc.player) != null)
		{
			return;
		}
		MoveUp();
	}
}

Injection point 2

Rust.opj (Oxide)

void ProceduralLift.RPC_UseLift(BaseEntity.RPCMessage)

Passes: ProceduralLift proceduralLift, 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)]
private void RPC_UseLift(RPCMessage rpc)
{
	if (rpc.player.CanInteract() && !IsBusy())
	{
		if (Interface.CallHook("OnLiftUse", this, rpc.player) != null)
		{
			return;
		}
		MoveToFloor((floorIndex + 1) % stops.Length);
	}
}

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.