RustTip

CanUpdateSign

OxidePlayer
object CanUpdateSign(BasePlayer player, Signage signage)
object CanUpdateSign(BasePlayer player, PhotoFrame photoFrame)
object CanUpdateSign(BasePlayer player, CarvablePumpkin carvablePumpkin)
Works — the game method in this build is the one the hook was written for.

Parameters

player
BasePlayer
signage
Signage

Return value

objectReturn a value of the method's result type and the game returns it immediately; null continues as usual.

Example

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

private object CanUpdateSign(BasePlayer player, Signage signage)
{
    Puts("CanUpdateSign");

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

    // to affect the game:
    // return null; // null — the game continues as usual
}

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

Injection point 1

Rust.opj (Oxide)
bool Signage.CanUpdateSign(BasePlayer)

Passes: BasePlayer player, Signage signage

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

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

public virtual bool CanUpdateSign(BasePlayer player)
{
	object returnvar = Interface.CallHook("CanUpdateSign", player, this);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (AdminsCanAlwaysUpdateSigns && (player.IsAdmin || player.IsDeveloper))
	{
		return true;
	}
// …

Injection point 2

Rust.opj (Oxide)
bool PhotoFrame.CanUpdateSign(BasePlayer)

Passes: BasePlayer player, PhotoFrame photoFrame

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

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

public bool CanUpdateSign(BasePlayer player)
{
	object returnvar = Interface.CallHook("CanUpdateSign", player, this);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (player.IsAdmin || player.IsDeveloper)
	{
		return true;
	}
// …

Injection point 3

Rust.opj (Oxide)
bool CarvablePumpkin.CanUpdateSign(BasePlayer)

Passes: BasePlayer player, CarvablePumpkin carvablePumpkin

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

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

public virtual bool CanUpdateSign(BasePlayer player)
{
	object returnvar = Interface.CallHook("CanUpdateSign", player, this);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (player.IsAdmin || player.IsDeveloper)
	{
		return true;
	}
// …

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.