OnAmmoUnload

OxideCarbonWeapon

Called when ammo unload occurs.

object OnAmmoUnload(BaseProjectile local0, Item item, BasePlayer player)

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

Parameters

local0: BaseProjectile
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 OnAmmoUnload(BaseProjectile local0, Item item, BasePlayer player)
{
    Puts("OnAmmoUnload");

    // 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 BaseProjectile.UnloadAmmo(Item, BasePlayer)

Passes: BaseProjectile local0, Item item, BasePlayer player

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

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

public void UnloadAmmo(Item item, BasePlayer player)
{
	BaseProjectile component = item.GetHeldEntity().GetComponent<BaseProjectile>();
	if (!component.canUnloadAmmo || !component)
	{
		return;
	}
	if (Interface.CallHook("OnAmmoUnload", component, item, player) != null)
	{
		return;
	}
	int num = component.primaryMagazine.contents;
	if (num <= 0)
	{
		return;
	}
// …

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.