OnEngineStatsRefresh

OxideCarbonVehicle

Called when engine stats refresh occurs.

object OnEngineStatsRefresh(VehicleModuleEngine vehicleModuleEngine, Rust.Modular.EngineStorage engineStorage)

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

Parameters

vehicleModuleEngine: VehicleModuleEngine
engineStorage: Rust.Modular.EngineStorage

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 OnEngineStatsRefresh(VehicleModuleEngine vehicleModuleEngine, Rust.Modular.EngineStorage engineStorage)
{
    Puts("OnEngineStatsRefresh");

    // 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 VehicleModuleEngine.RefreshPerformanceStats(Rust.Modular.EngineStorage)

Passes: VehicleModuleEngine vehicleModuleEngine, Rust.Modular.EngineStorage engineStorage

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

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

public void RefreshPerformanceStats(EngineStorage engineStorage)
{
	if (Interface.CallHook("OnEngineStatsRefresh", this, engineStorage) != null)
	{
		return;
	}
	if (engineStorage == null)
	{
		IsUsable = false;
		PerformanceFractionAcceleration = 0f;
		PerformanceFractionTopSpeed = 0f;
// …

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.