RustTip

CanHideStash

OxideCarbonPlayer

Called to determine whether to hide stash.

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

object CanHideStash(BasePlayer player, StashContainer stashContainer)
Works — the game method in this build is the one the hook was written for.

Parameters

player
BasePlayer
stashContainer
StashContainer

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 CanHideStash(BasePlayer player, StashContainer stashContainer)
{
    Puts("CanHideStash");

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

Passes: BasePlayer player, StashContainer stashContainer

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

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

[RPC_Server]
[RPC_Server.IsVisible(3f)]
public void RPC_HideStash(RPCMessage rpc)
{
	if (Interface.CallHook("CanHideStash", rpc.player, this) != null)
	{
		return;
	}
	Analytics.Azure.OnStashHidden(rpc.player, this);
	SetHidden(isHidden: 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.