CanSeeStash

OxideCarbonEntity

Called to determine whether to see stash.

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

object CanSeeStash(BasePlayer basePlayer, StashContainer entity)

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

Parameters

basePlayer: BasePlayer
entity: 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 CanSeeStash(BasePlayer basePlayer, StashContainer entity)
{
    Puts("CanSeeStash");

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

Passes: BasePlayer basePlayer, StashContainer entity

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

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

// …
{
	nearbyStashes.RemoveAt(i);
}
else if (nearbyStash.Entity.IsHidden() && nearbyStash.Entity.PlayerInRange(this))
{
	nearbyStash.LookingAtTime += StashContainer.PlayerDetectionTickRate;
	if (nearbyStash.LookingAtTime >= nearbyStash.Entity.uncoverTime)
	{
		if (Interface.CallHook("CanSeeStash", this, nearbyStash.Entity) != null)
		{
			return;
		}
		nearbyStash.Entity.SetHidden(isHidden: false);
		Analytics.Azure.OnStashRevealed(this, nearbyStash.Entity);
	}
}
else
// …

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.