OnRackedWeaponMount

OxideCarbonItem

Called when a racked weapon is mounted.

object OnRackedWeaponMount(Item item, BasePlayer player, WeaponRack weaponRack)

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

Parameters

item: Item
player: BasePlayer
weaponRack: WeaponRack

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

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

private object OnRackedWeaponMount(Item item, BasePlayer player, WeaponRack weaponRack)
{
    Puts("OnRackedWeaponMount");

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

    // to affect the game:
    // return false; // your value instead of the game result
}

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

Injection point

Rust.opj (Oxide)

bool WeaponRack.MountWeapon(Item, BasePlayer, int, int, bool)

Passes: Item item, BasePlayer player, WeaponRack weaponRack

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: UseArgumentString (a0, a1, this)Assembly-CSharp.dll

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

// …
if (item == null)
{
	return false;
}
if (player == null)
{
	return false;
}
object returnvar = Interface.CallHook("OnRackedWeaponMount", item, player, this);
if (returnvar != null)
{
	return returnvar is bool && (bool)returnvar;
}
int itemid = item.info.itemid;
WorldModelRackMountConfig forItemDef = WorldModelRackMountConfig.GetForItemDef(item.info);
if (forItemDef == 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.