IOnBasePlayerAttacked

OxidePlayer

object IOnBasePlayerAttacked(BasePlayer basePlayer, HitInfo info)

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

Parameters

basePlayer: BasePlayer
info: HitInfo

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 IOnBasePlayerAttacked(BasePlayer basePlayer, HitInfo info)
{
    Puts("IOnBasePlayerAttacked");

    // 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 BasePlayer.OnAttacked(HitInfo)

Passes: BasePlayer basePlayer, HitInfo info

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public override void OnAttacked(HitInfo info)
{
	if (Interface.CallHook("IOnBasePlayerAttacked", this, info) != null)
	{
		return;
	}
	float oldHealth = health;
	if (isServer)
	{
		if (InSafeCombatZone())
		{
// …

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.