OnHelicopterRetire

OxideCarbonVehicle

Called when helicopter retire occurs.

object OnHelicopterRetire(PatrolHelicopterAI patrolHelicopterAI)

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

Parameters

patrolHelicopterAI: PatrolHelicopterAI

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 OnHelicopterRetire(PatrolHelicopterAI patrolHelicopterAI)
{
    Puts("OnHelicopterRetire");

    // 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 PatrolHelicopterAI.Retire()

Passes: PatrolHelicopterAI patrolHelicopterAI

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public void Retire()
{
	if (!isRetiring)
	{
		if (Interface.CallHook("OnHelicopterRetire", this) != null)
		{
			return;
		}
		Invoke(DestroyMe, 240f);
		float x = TerrainMeta.Size.x;
		float y = 200f;
		Vector3 newPos = Vector3Ex.Range(-1f, 1f);
		newPos.y = 0f;
// …

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.