RustTip

OnSamSiteTarget

OxideCarbonEntity

Called when sam site target occurs.

object OnSamSiteTarget(SamSite samSite, SamSite.ISamSiteTarget iSamSiteTarget)
Works — the game method in this build is the one the hook was written for.

Parameters

samSite
SamSite
iSamSiteTarget
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 OnSamSiteTarget(SamSite samSite, SamSite.ISamSiteTarget iSamSiteTarget)
{
    Puts("OnSamSiteTarget");

    // 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, SamSite.ISamSiteTarget iSamSiteTarget

WorksReturnBehavior: ExitWhenNonNullAssembly-CSharp.dll

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

// …
	AddTargetSet(obj, targetTypeVehicle.scanRadius);
}
AddMLRSRockets(obj, targetTypeMissile.scanRadius);
ISamSiteTarget samSiteTarget = null;
foreach (ISamSiteTarget item in obj)
{
	if (!item.isClient && !(item.CenterPoint().y < eyePoint.transform.position.y) && item.IsVisible(eyePoint.transform.position, item.SAMTargetType.scanRadius * 2f) && item.IsValidSAMTarget(staticRespawn))
	{
		if (Interface.CallHook("OnSamSiteTarget", this, iSamSiteTarget) == null)
		{
			return;
		}
		samSiteTarget = item;
		break;
	}
}
if (!samSiteTarget.IsUnityNull() && currentTarget != samSiteTarget)
// …

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.