RustTip

OnEntityGroundMissing

OxideCarbonEntity

Called when an entity ground is missing.

object OnEntityGroundMissing(BaseEntity local0)
Works — the game method in this build is the one the hook was written for.

Parameters

local0
BaseEntity

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 OnEntityGroundMissing(BaseEntity local0)
{
    Puts("OnEntityGroundMissing");

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

Passes: BaseEntity local0

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (l0)Assembly-CSharp.dll

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

private void OnGroundMissing()
{
	BaseEntity baseEntity = gameObject.ToBaseEntity();
	if (baseEntity != null)
	{
		if (Interface.CallHook("OnEntityGroundMissing", baseEntity) != null)
		{
			return;
		}
		BaseCombatEntity baseCombatEntity = baseEntity as BaseCombatEntity;
		if (Stability.log_ground_missing_death)
		{
			Debug.Log($"Killing '{baseEntity.ToString()}' at position {transform.position} due to ground missing");
		}
// …

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.