CanUseMailbox

OxideCarbonPlayer

Called to determine whether to use mailbox.

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

object CanUseMailbox(BasePlayer player, Mailbox mailbox)

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

Parameters

player: BasePlayer
mailbox: Mailbox

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

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

private object CanUseMailbox(BasePlayer player, Mailbox mailbox)
{
    Puts("CanUseMailbox");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // your value instead of the game result
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)

bool Mailbox.PlayerIsOwner(BasePlayer)

Passes: BasePlayer player, Mailbox mailbox

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

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

public virtual bool PlayerIsOwner(BasePlayer player)
{
	object returnvar = Interface.CallHook("CanUseMailbox", player, this);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	return player.CanBuild();
}

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.