OnRackedWeaponUnload

OxideCarbonItem

Called to control taking items from a weapon rack.

object OnRackedWeaponUnload(Item local1, BasePlayer player, WeaponRack weaponRack)

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

Parameters

local1: Item
player: BasePlayer
weaponRack: WeaponRack

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 OnRackedWeaponUnload(Item local1, BasePlayer player, WeaponRack weaponRack)
{
    Puts("OnRackedWeaponUnload");

    // 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 WeaponRack.UnloadWeapon(BasePlayer, int)

Passes: Item local1, BasePlayer player, WeaponRack weaponRack

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

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

// …
{
	return;
}
Item slot = inventory.GetSlot(weaponAtIndex.InventoryIndex);
if (slot == null)
{
	return;
}
if (Interface.CallHook("OnRackedWeaponUnload", slot, player, this) != null)
{
	return;
}
BaseEntity heldEntity = slot.GetHeldEntity();
if (!(heldEntity == null))
{
	BaseProjectile component = heldEntity.GetComponent<BaseProjectile>();
	if (!(component == null))
// …

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.