OnNpcAttack

OxideNPC

object OnNpcAttack(BaseNpc baseNpc, BaseEntity AttackTarget)

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

Parameters

baseNpc: BaseNpc
AttackTarget: BaseEntity

Return value

objectReturn a value of the method's result type and the game returns it immediately; null continues as usual.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnNpcAttack(BaseNpc baseNpc, BaseEntity AttackTarget)
{
    Puts("OnNpcAttack");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return null; // null — the game continues as usual
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)

void BaseNpc.StartAttack()

Passes: BaseNpc baseNpc, BaseEntity AttackTarget

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

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

public virtual void StartAttack()
{
	if ((bool)AttackTarget && AttackReady() && !((AttackTarget.ServerPosition - ServerPosition).magnitude > AttackRange))
	{
		if (Interface.CallHook("OnNpcAttack", this, this.AttackTarget) != null)
		{
			return;
		}
		nextAttackTime = Time.realtimeSinceStartup + AttackRate;
		BaseCombatEntity combatTarget = CombatTarget;
		if ((bool)combatTarget)
		{
			combatTarget.Hurt(AttackDamage, AttackDamageType, this);
// …

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.