Weapon Rig API

This mod provides an API for extending the WeaponRig class

---

To extend the WeaponRig class you need to extend res://mods/WeaponRigAPI/IWeaponRig.gd instead of the default res://Scripts/WeaponRig.gd

IWeaponRig provides the same functions as WeaponRig but:

• All functions receive WeaponRig object instance as the first parameter, example:

  func Reload(_rig: WeaponRig) -> int:
  	...
  

• If you want to skip the base function, return HookResult.SkipBase, example:

  func Reload(_rig: WeaponRig) -> int:
  	print("My Reload Hook")
  	return HookResult.SkipBase
  

• If you want to call the base function, return super with the same arguments, example:

  func Reload(rig: WeaponRig) -> int:
  	print("My Reload Hook")
  	return super(rig)
  

• If a function returns some value such as:

  func Malfunction() -> bool:
  	...
  

  you should:
  • return bool if you want to override the vanilla behavior
  • return HookResult.SkipBase if you don't want to call the base implementation
  • return super() to keep the vanilla behavior while also extending the functionality

Example mods using this API:

• Alternative Mag Check

---

This mod provides only the API for extending the WeaponRig class, you need Weapon Rigger to apply your extensions