OnMeleeAttack

OxideCarbonPlayer

Called when a melee attacks.

object OnMeleeAttack(BasePlayer local0, HitInfo local3)

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

Parameters

local0: BasePlayer
local3: HitInfo

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 OnMeleeAttack(BasePlayer local0, HitInfo local3)
{
    Puts("OnMeleeAttack");

    // 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 BaseMelee.PlayerAttack(BaseEntity.RPCMessage)

Passes: BasePlayer local0, HitInfo local3

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

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

// …
}
HitInfo obj = Facepunch.Pool.Get<HitInfo>();
obj.LoadFromAttack(playerAttack.attack, serverSide: true);
obj.Initiator = player;
obj.Weapon = this;
obj.WeaponPrefab = this;
obj.Predicted = msg.connection;
obj.damageProperties = damageProperties;
if (Interface.CallHook("OnMeleeAttack", player, obj) != null)
{
	return;
}
if (obj.IsNaNOrInfinity())
{
	string shortPrefabName = ShortPrefabName;
	AntiHack.Log(player, AntiHackType.MeleeHack, "Contains NaN (" + shortPrefabName + ")");
	player.stats.combat.LogInvalid(obj, "melee_nan");
// …

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.