RustTip

OnStashOcclude

OxideCarbonEntity

Called when stash occlude occurs.

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

Parameters

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 OnStashOcclude(StashContainer stashContainer)
{
    Puts("OnStashOcclude");

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

Passes: StashContainer stashContainer

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public void DoOccludedCheck()
{
	if (Physics.SphereCast(new Ray(transform.position + Vector3.up * 5f, Vector3.down), 0.25f, 5f, 2097152))
	{
		if (Interface.CallHook("OnStashOcclude", this) != null)
		{
			return;
		}
		DropItems();
		Kill();
	}
}

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.