RustTip

OnSamSiteTargetScan

OxideCarbonEntity

Called when sam site target scan occurs.

object OnSamSiteTargetScan(SamSite samSite, List<SamSite.ISamSiteTarget> list)
Works — the game method in this build is the one the hook was written for.

Parameters

samSite
SamSite
list
List<SamSite.ISamSiteTarget>

Return value

objectReturn non-null to stop the game method.

Example

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

private object OnSamSiteTargetScan(SamSite samSite, List<SamSite.ISamSiteTarget> list)
{
    Puts("OnSamSiteTargetScan");

    // 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 SamSite.TargetScan()

Passes: SamSite samSite, List<SamSite.ISamSiteTarget> list

WorksReturnBehavior: ExitWhenNonNullAssembly-CSharp.dll

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

// …
	}
	lastAmmoCount = num;
}
if (HasValidTarget() || IsDead())
{
	return;
}
List<ISamSiteTarget> obj = Pool.Get<List<ISamSiteTarget>>();
if (Interface.CallHook("OnSamSiteTargetScan", this, obj) == null)
{
	return;
}
if (!IsInDefenderMode())
{
	AddTargetSet(obj, targetTypeVehicle.scanRadius);
}
AddMLRSRockets(obj, targetTypeMissile.scanRadius);
// …

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.