RustTip

OnItemRefill

OxideCarbonItem

Called when an item refills.

object OnItemRefill(Item item, BasePlayer player)
Works — the game method in this build is the one the hook was written for.

Parameters

item
Item
player
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 OnItemRefill(Item item, BasePlayer player)
{
    Puts("OnItemRefill");

    // 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 ItemModRepair.ServerCommand(Item, string, BasePlayer)

Passes: Item item, BasePlayer player

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

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

public override void ServerCommand(Item item, string command, BasePlayer player)
{
	if (command == "refill" && !player.IsSwimming() && HasCraftLevel(player) && !(item.conditionNormalized >= 1f))
	{
		if (Interface.CallHook("OnItemRefill", item, player) != null)
		{
			return;
		}
		float conditionNormalized = item.conditionNormalized;
		float maxConditionNormalized = item.maxConditionNormalized;
		item.DoRepair(conditionLost);
		if (successEffect.isValid)
		{
// …

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.