RustTip

OnBradleyApcPatrol

OxideCarbonVehicle

Called when bradley apc patrol occurs.

object OnBradleyApcPatrol(BradleyAPC bradleyAPC)
Works — the game method in this build is the one the hook was written for.

Parameters

bradleyAPC
BradleyAPC

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 OnBradleyApcPatrol(BradleyAPC bradleyAPC)
{
    Puts("OnBradleyApcPatrol");

    // 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 BradleyAPC.UpdateMovement_Patrol()

Passes: BradleyAPC bradleyAPC

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

// …
{
	return;
}
nextPatrolTime = Time.time + 20f;
if (HasPath() && !IsAtFinalDestination())
{
	return;
}
if (Interface.CallHook("OnBradleyApcPatrol", this) != null)
{
	return;
}
IAIPathInterestNode randomInterestNodeAwayFrom = patrolPath.GetRandomInterestNodeAwayFrom(transform.position);
IAIPathNode closestToPoint = patrolPath.GetClosestToPoint(randomInterestNodeAwayFrom.Position);
bool flag = false;
List<IAIPathNode> nodes = Pool.Get<List<IAIPathNode>>();
IAIPathNode iAIPathNode;
// …

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.