OnMagazineReload

OxideCarbonWeapon

Called when a magazine reloads.

object OnMagazineReload(BaseProjectile baseProjectile, IAmmoContainer ammoSource, object GetOwnerPlayer())

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

Parameters

baseProjectile: BaseProjectile
ammoSource: IAmmoContainer
GetOwnerPlayer(): object

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 OnMagazineReload(BaseProjectile baseProjectile, IAmmoContainer ammoSource, object GetOwnerPlayer())
{
    Puts("OnMagazineReload");

    // 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 BaseProjectile.TryReloadMagazine(IAmmoContainer, int, bool)

Passes: BaseProjectile baseProjectile, IAmmoContainer ammoSource, object GetOwnerPlayer()

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

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

public virtual bool TryReloadMagazine(IAmmoContainer ammoSource, int desiredAmount = -1, bool shouldUpdateShieldState = true)
{
	object returnvar = Interface.CallHook("OnMagazineReload", this, ammoSource, this.GetOwnerPlayer());
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (!TryReload(ammoSource, desiredAmount))
	{
		return false;
	}
// …

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.