OnThreatLevelUpdate

OxideCarbonPlayer

Called when a threat level is updated.

object OnThreatLevelUpdate(BasePlayer basePlayer)

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

Parameters

basePlayer: BasePlayer

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 OnThreatLevelUpdate(BasePlayer basePlayer)
{
    Puts("OnThreatLevelUpdate");

    // 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 BasePlayer.EnsureUpdated()

Passes: BasePlayer basePlayer

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

// …
	return;
}
lastUpdateTime = Time.realtimeSinceStartup;
cachedThreatLevel = 0f;
if (IsSleeping())
{
	return;
}
if (Interface.CallHook("OnThreatLevelUpdate", this) != null)
{
	return;
}
if (inventory.containerWear.itemList.Count > 2)
{
	cachedThreatLevel++;
}
foreach (Item item in inventory.containerBelt.itemList)
// …

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.