CanMountEntity

OxideCarbonPlayer

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

Return true to allow the action and false to block it.

object CanMountEntity(BasePlayer player, BaseMountable baseMountable)

Method changed — check — the game method differs from the one the hook is recorded for in Oxide. The hook is still called, but its place may have shifted — worth checking after an update.

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

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

Passes: BasePlayer player, BaseMountable baseMountable

Method changed — checkReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (a0, this)Assembly-CSharp.dll

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

public void MountPlayer(BasePlayer player)
{
	if (!(_mounted != null) && !(mountAnchor == null))
	{
		if (Interface.CallHook("CanMountEntity", player, this) != null)
		{
			return;
		}
		player.EnsureDismounted();
		_mounted = player;
		Transform transform = mountAnchor;
		player.SetMounted(this);
		if (blockLooting)
// …

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.