OnRackedWeaponSwap

OxideCarbonItem

Called to control taking items from a weapon rack.

object OnRackedWeaponSwap(Item local0, WeaponRackSlot local2, BasePlayer player, WeaponRack weaponRack)

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

Parameters

local0: Item
local2: WeaponRackSlot
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 OnRackedWeaponSwap(Item local0, WeaponRackSlot local2, BasePlayer player, WeaponRack weaponRack)
{
    Puts("OnRackedWeaponSwap");

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

Passes: Item local0, WeaponRackSlot local2, BasePlayer player, WeaponRack weaponRack

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

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

// …
int mountSlotIndex = gridCellIndex;
if (CustomRackType != SpecialRackType.None)
{
	gridCellIndex = 0;
}
int bestPlacementCellIndex = GetBestPlacementCellIndex(GetXYForIndex(gridCellIndex), forItemDef, rotation, weaponAtIndex);
if (bestPlacementCellIndex != -1)
{
	if (Interface.CallHook("OnRackedWeaponSwap", item, weaponAtIndex, player, this) != null)
	{
		return;
	}
	item.RemoveFromContainer();
	GivePlayerWeapon(player, mountSlotIndex, takeFromBeltIndex, tryHold: false);
	MountWeapon(item, player, bestPlacementCellIndex, rotation, sendUpdate: false);
	ItemManager.DoRemoves();
	SendNetworkUpdateImmediate();
// …

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.