RustTip

OnHelicopterTarget

OxideCarbonVehicle

Called when helicopter target occurs.

object OnHelicopterTarget(HelicopterTurret helicopterTurret, BaseCombatEntity newTarget)
Works — the game method in this build is the one the hook was written for.

Parameters

helicopterTurret
HelicopterTurret
newTarget
BaseCombatEntity

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 OnHelicopterTarget(HelicopterTurret helicopterTurret, BaseCombatEntity newTarget)
{
    Puts("OnHelicopterTarget");

    // 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 HelicopterTurret.SetTarget(BaseCombatEntity)

Passes: HelicopterTurret helicopterTurret, BaseCombatEntity newTarget

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public void SetTarget(BaseCombatEntity newTarget)
{
	if (Interface.CallHook("OnHelicopterTarget", this, newTarget) != null)
	{
		return;
	}
	_target = newTarget;
	UpdateTargetVisibility();
}

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.