RustTip

OnPatrolHelicopterKill

OxideCarbonEntity

Called when a patrol helicopter is killed.

object OnPatrolHelicopterKill(PatrolHelicopter patrolHelicopter, HitInfo info)
Works — the game method in this build is the one the hook was written for.

Parameters

patrolHelicopter
PatrolHelicopter
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 OnPatrolHelicopterKill(PatrolHelicopter patrolHelicopter, HitInfo info)
{
    Puts("OnPatrolHelicopterKill");

    // 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 PatrolHelicopter.Hurt(HitInfo)

Passes: PatrolHelicopter patrolHelicopter, HitInfo info

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

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

public override void Hurt(HitInfo info)
{
	bool flag = false;
	if (info.damageTypes.Total() >= health)
	{
		health = 10000f;
		myAI.CriticalDamage();
		if (Interface.CallHook("OnPatrolHelicopterKill", this, info) != null)
		{
			return;
		}
		flag = true;
		if (info.InitiatorPlayer != null && info.InitiatorPlayer.serverClan != null)
		{
			info.InitiatorPlayer.AddClanScore(ClanScoreEventType.DestroyedPatrolHeli);
		}
// …

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.