RustTip

OnPlayerWantsMount

OxideCarbonPlayer

Called when an admin repair action fixes nearby vehicles.

object OnPlayerWantsMount(BasePlayer player, BaseMountable baseMountable)
Works — the game method in this build is the one the hook was written for.

Parameters

player
BasePlayer
baseMountable
BaseMountable

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 OnPlayerWantsMount(BasePlayer player, BaseMountable baseMountable)
{
    Puts("OnPlayerWantsMount");

    // 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 BaseMountable.WantsMount(BasePlayer)

Passes: BasePlayer player, BaseMountable baseMountable

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

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

public void WantsMount(BasePlayer player)
{
	if (!player.IsValid() || !player.CanInteract())
	{
		return;
	}
	if (Interface.CallHook("OnPlayerWantsMount", player, this) != null)
	{
		return;
	}
	if (!DirectlyMountable())
	{
		BaseVehicle baseVehicle = VehicleParent();
		if (baseVehicle != null && baseVehicle.IsVehicleMountPoint(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.