OnHelicopterStrafeEnter

OxideCarbonVehicle

Called when a helicopter strafe enters.

object OnHelicopterStrafeEnter(PatrolHelicopterAI patrolHelicopterAI, object position, BasePlayer strafeTarget)

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

Parameters

patrolHelicopterAI: PatrolHelicopterAI
position: object
strafeTarget: BasePlayer

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 OnHelicopterStrafeEnter(PatrolHelicopterAI patrolHelicopterAI, object position, BasePlayer strafeTarget)
{
    Puts("OnHelicopterStrafeEnter");

    // 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.StartStrafe(BasePlayer, bool)

Passes: PatrolHelicopterAI patrolHelicopterAI, object position, BasePlayer strafeTarget

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

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

private void StartStrafe(BasePlayer strafeTarget, bool shouldUseNapalm = false)
{
	if (Interface.CallHook("OnHelicopterStrafeEnter", this, strafeTarget.transform.position, strafeTarget) != null)
	{
		return;
	}
	strafe_target = strafeTarget;
	get_out_of_strafe_distance = Random.Range(13f, 17f);
	if (CanUseNapalm() & shouldUseNapalm)
	{
		passNapalm = shouldUseNapalm;
// …

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.