RustTip

OnNoGoZoneAdded

OxideCarbonEntity

Called when a no go zone is added.

object OnNoGoZoneAdded(PatrolHelicopterAI patrolHelicopterAI, PatrolHelicopterAI.DangerZone zone)
Works — the game method in this build is the one the hook was written for.

Parameters

patrolHelicopterAI
PatrolHelicopterAI
zone
PatrolHelicopterAI.DangerZone

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 OnNoGoZoneAdded(PatrolHelicopterAI patrolHelicopterAI, PatrolHelicopterAI.DangerZone zone)
{
    Puts("OnNoGoZoneAdded");

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

Passes: PatrolHelicopterAI patrolHelicopterAI, PatrolHelicopterAI.DangerZone zone

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: AllAssembly-CSharp.dll

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

private void NoGoZoneAdded(DangerZone zone)
{
	if (use_danger_zones && !zone.IsInMonument)
	{
		if (Interface.CallHook("OnNoGoZoneAdded", this, zone) != null)
		{
			return;
		}
		ClearTargets();
		ExitCurrentState();
		State_Flee_Enter();
	}
}

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.