CanHelicopterTarget

OxideCarbonVehicle

Called to determine whether to helicopter target.

Return true to allow the action and false to block it.

object CanHelicopterTarget(PatrolHelicopterAI patrolHelicopterAI, BasePlayer ply)

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

Parameters

patrolHelicopterAI: PatrolHelicopterAI
ply: BasePlayer

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

object — you can affect the game: return a value to change or cancel the action.

private object CanHelicopterTarget(PatrolHelicopterAI patrolHelicopterAI, BasePlayer ply)
{
    Puts("CanHelicopterTarget");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // your value instead of the game result
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)

bool PatrolHelicopterAI.PlayerVisible(BasePlayer)

Passes: PatrolHelicopterAI patrolHelicopterAI, BasePlayer ply

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

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

public bool PlayerVisible(BasePlayer ply)
{
	object returnvar = Interface.CallHook("CanHelicopterTarget", this, ply);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	using (TimeWarning.New("PatrolHelicoperAI.PlayerVisible"))
	{
		Vector3 position = ply.eyes.position;
		if (ply.eyes.position.y < WaterSystem.OceanLevel && Mathf.Abs(WaterSystem.OceanLevel - ply.eyes.position.y) > oceanDepthTargetCutoff)
// …

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.