OnInventoryAmmoItemFind

OxideItem

object OnInventoryAmmoItemFind(PlayerInventory inventory, ItemDefinition fuelType)
object OnInventoryAmmoItemFind(PlayerInventory playerInventory, Rust.AmmoTypes ammoType)

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

Parameters

inventory: PlayerInventory
fuelType: ItemDefinition

Return value

objectReturn a value of the method's result type and the game returns it immediately; null continues as usual.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnInventoryAmmoItemFind(PlayerInventory inventory, ItemDefinition fuelType)
{
    Puts("OnInventoryAmmoItemFind");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return null; // null — the game continues as usual
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point 1

Rust.opj (Oxide)

Item Chainsaw.GetAmmo()

Passes: PlayerInventory inventory, ItemDefinition fuelType

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (l0.inventory, this.fuelType)Assembly-CSharp.dll

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

public Item GetAmmo()
{
	BasePlayer ownerPlayer = GetOwnerPlayer();
	if (!ownerPlayer)
	{
		return null;
	}
	object returnvar = Interface.CallHook("OnInventoryAmmoItemFind", ownerPlayer.inventory, this.fuelType);
	if (returnvar is Item)
	{
		return (Item)returnvar;
	}
	return ownerPlayer.inventory.FindItemByItemName(fuelType.shortname);
}

Injection point 2

Rust.opj (Oxide)

Item FlameThrower.GetAmmo()

Passes: PlayerInventory inventory, ItemDefinition fuelType

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (l0.inventory, this.fuelType)Assembly-CSharp.dll

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

public Item GetAmmo()
{
	BasePlayer ownerPlayer = GetOwnerPlayer();
	if (!ownerPlayer)
	{
		return null;
	}
	object returnvar = Interface.CallHook("OnInventoryAmmoItemFind", ownerPlayer.inventory, this.fuelType);
	if (returnvar is Item)
	{
		return (Item)returnvar;
	}
	return ownerPlayer.inventory.FindItemByItemName(fuelType.shortname);
}

Injection point 3

Rust.opj (Oxide)

Item PlayerInventory.FindAmmo(Rust.AmmoTypes)

Passes: PlayerInventory playerInventory, Rust.AmmoTypes ammoType

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public Item FindAmmo(AmmoTypes ammoType)
{
	object returnvar = Interface.CallHook("OnInventoryAmmoItemFind", this, ammoType);
	if (returnvar is Item)
	{
		return (Item)returnvar;
	}
	Item item = containerMain?.FindAmmo(ammoType);
	if (item == null)
	{
		item = containerBelt?.FindAmmo(ammoType);
// …

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.