RustTip

OnInventoryAmmoFind

OxideCarbonItem

Called when an inventory ammo is found.

object OnInventoryAmmoFind(PlayerInventory playerInventory, List<Item> list, Rust.AmmoTypes ammoType)
Works — the game method in this build is the one the hook was written for.

Parameters

playerInventory
PlayerInventory
list
List<Item>
ammoType
Rust.AmmoTypes

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 OnInventoryAmmoFind(PlayerInventory playerInventory, List<Item> list, Rust.AmmoTypes ammoType)
{
    Puts("OnInventoryAmmoFind");

    // 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 PlayerInventory.FindAmmo(List<Item>, Rust.AmmoTypes)

Passes: PlayerInventory playerInventory, List<Item> list, Rust.AmmoTypes ammoType

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

[PoolAnalyzerNonCaching]
public void FindAmmo(List<Item> list, AmmoTypes ammoType)
{
	if (Interface.CallHook("OnInventoryAmmoFind", this, list, ammoType) != null)
	{
		return;
	}
	containerMain?.FindAmmo(list, ammoType);
	containerBelt?.FindAmmo(list, 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.