OnSensorDetect

OxideCarbonElectronic

Called when a sensor is detected.

object OnSensorDetect(HBHFSensor hBHFSensor, BasePlayer basePlayer)

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

Parameters

hBHFSensor: HBHFSensor
basePlayer: BasePlayer

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 OnSensorDetect(HBHFSensor hBHFSensor, BasePlayer basePlayer)
{
    Puts("OnSensorDetect");

    // 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)

int HBHFSensor.CountDetectedPlayers()

Passes: HBHFSensor hBHFSensor, BasePlayer basePlayer

WorksReturnBehavior: ExitWhenNonNullAssembly-CSharp.dll

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

// …
int num = 0;
Vector3 vector = transform.position + transform.forward * 0.1f;
if (DebugDraw)
{
	DebugDrawSensor(vector);
}
foreach (BaseEntity entityContent in myTrigger.entityContents)
{
	if (Interface.CallHook("OnSensorDetect", this, basePlayer) == null)
	{
		return;
	}
	if (!(entityContent is BasePlayer basePlayer) || basePlayer == null || basePlayer.IsDead() || basePlayer.IsSleeping() || !basePlayer.isServer)
	{
		continue;
	}
	if (!flag)
// …

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.