RustTip

OnWeaponModChange

OxideCarbonWeapon

Called when a weapon mod is changed.

object OnWeaponModChange(BaseProjectile baseProjectile, object GetOwnerPlayer())
Works — the game method in this build is the one the hook was written for.

Parameters

baseProjectile
BaseProjectile
GetOwnerPlayer()
object

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

    // 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.DelayedModsChanged()

Passes: BaseProjectile baseProjectile, object GetOwnerPlayer()

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

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

public void DelayedModsChanged()
{
	if (Interface.CallHook("OnWeaponModChange", this, this.GetOwnerPlayer()) != null)
	{
		return;
	}
	int num = Mathf.CeilToInt(ProjectileWeaponMod.Mult(this, ProjectileWeaponMod.SelectMagCap, ProjectileWeaponMod.SelectScalar) * (float)primaryMagazine.definition.builtInSize);
	if (num == primaryMagazine.capacity)
	{
		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.