OnEntityStabilityCheck

OxideCarbonEntity

Called when entity stability check occurs.

object OnEntityStabilityCheck(StabilityEntity stabilityEntity)

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

Parameters

stabilityEntity: StabilityEntity

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 OnEntityStabilityCheck(StabilityEntity stabilityEntity)
{
    Puts("OnEntityStabilityCheck");

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

Passes: StabilityEntity stabilityEntity

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public virtual void StabilityCheck()
{
	if (IsDestroyed)
	{
		return;
	}
	if (Interface.CallHook("OnEntityStabilityCheck", this) != null)
	{
		return;
	}
	if (supports == null)
	{
		InitializeSupports();
	}
	bool flag = false;
// …

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.