OnPlayerLand

OxideCarbonPlayer

Called when player land occurs.

object OnPlayerLand(BasePlayer basePlayer, float local0)

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

Parameters

basePlayer: BasePlayer
local0: float

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 OnPlayerLand(BasePlayer basePlayer, float local0)
{
    Puts("OnPlayerLand");

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

Passes: BasePlayer basePlayer, float local0

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

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

// …
{
	if (IsGod())
	{
		return;
	}
	float num = Mathf.InverseLerp(-15f, -100f, velocity);
	if (num != 0f)
	{
		if (Interface.CallHook("OnPlayerLand", this, num) != null)
		{
			return;
		}
		float num2 = ((modifiers != null) ? Mathf.Clamp01(1f - modifiers.GetValue(Modifier.ModifierType.Clotting)) : 1f);
		metabolism.bleeding.Add(num * 0.5f * num2);
		float num3 = num * 500f;
		Analytics.Azure.OnFallDamage(this, velocity, num3);
		Hurt(num3, DamageType.Fall);
// …

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.