OnHammerHit

OxideCarbonStructure

Called when a hammer hits.

object OnHammerHit(BasePlayer local0, HitInfo info)

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

Parameters

local0: BasePlayer
info: 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 OnHammerHit(BasePlayer local0, HitInfo info)
{
    Puts("OnHammerHit");

    // 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 Hammer.DoAttackShared(HitInfo)

Passes: BasePlayer local0, HitInfo info

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

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

// …
	BaseCombatEntity repairableParent = baseCombatEntity.GetRepairableParent();
	if (repairableParent != null)
	{
		baseCombatEntity = repairableParent;
	}
}
if (baseCombatEntity != null && ownerPlayer != null && isServer)
{
	if (Interface.CallHook("OnHammerHit", ownerPlayer, info) != null)
	{
		return;
	}
	using (TimeWarning.New("DoRepair", 50))
	{
		baseCombatEntity.DoRepair(ownerPlayer);
	}
}
// …

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.