OnEngineLoadoutRefresh

OxideCarbonVehicle

Called when engine loadout refresh occurs.

object OnEngineLoadoutRefresh(Rust.Modular.EngineStorage engineStorage)

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

Parameters

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 OnEngineLoadoutRefresh(Rust.Modular.EngineStorage engineStorage)
{
    Puts("OnEngineLoadoutRefresh");

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

Passes: Rust.Modular.EngineStorage engineStorage

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public void RefreshLoadoutData()
{
	if (Interface.CallHook("OnEngineLoadoutRefresh", this) != null)
	{
		return;
	}
	isUsable = inventory.IsFull() && inventory.itemList.All((Item item) => !item.isBroken);
	accelerationBoostPercent = GetContainerItemsValueFor(EngineItemTypeEx.BoostsAcceleration) / (float)accelerationBoostSlots;
	topSpeedBoostPercent = GetContainerItemsValueFor(EngineItemTypeEx.BoostsTopSpeed) / (float)topSpeedBoostSlots;
	fuelEconomyBoostPercent = GetContainerItemsValueFor(EngineItemTypeEx.BoostsFuelEconomy) / (float)fuelEconomyBoostSlots;
	SendNetworkUpdate();
// …

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.