RustTip

OnMlrsTarget

OxideCarbonVehicle

Called when mlrs target occurs.

object OnMlrsTarget(MLRS mLRS, Vector3 worldPos, object _mounted)
Works — the game method in this build is the one the hook was written for.

Parameters

mLRS
MLRS
worldPos
Vector3
_mounted
object

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 OnMlrsTarget(MLRS mLRS, Vector3 worldPos, object _mounted)
{
    Puts("OnMlrsTarget");

    // 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 MLRS.SetUserTargetHitPos(Vector3)

Passes: MLRS mLRS, Vector3 worldPos, object _mounted

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, a0, this._mounted)Assembly-CSharp.dll

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

// …
if (isServer)
{
	Vector3 position = TerrainMeta.Position;
	Vector3 vector = position + TerrainMeta.Size;
	worldPos.x = Mathf.Clamp(worldPos.x, position.x, vector.x);
	worldPos.z = Mathf.Clamp(worldPos.z, position.z, vector.z);
	worldPos.y = GetSurfaceHeight(worldPos);
}
if (Interface.CallHook("OnMlrsTarget", this, worldPos, this._mounted) != null)
{
	return;
}
UserTargetHitPos = worldPos;
if (!isServer)
{
	return;
}
// …

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.