OnPlayerWantsDismount

OxideCarbonPlayer

Called to validate a player's dismount position before exiting a mount or vehicle.

object OnPlayerWantsDismount(BasePlayer local0, BaseMountable baseMountable)

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

Parameters

local0: 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 OnPlayerWantsDismount(BasePlayer local0, BaseMountable baseMountable)
{
    Puts("OnPlayerWantsDismount");

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

Passes: BasePlayer local0, BaseMountable baseMountable

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

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

[RPC_Server]
public void RPC_WantsDismount(RPCMessage msg)
{
	BasePlayer player = msg.player;
	if (HasValidDismountPosition(player) && (!(player != null) || !player.IsRestrained))
	{
		if (Interface.CallHook("OnPlayerWantsDismount", player, this) != null)
		{
			return;
		}
		AttemptDismount(player);
	}
}

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.