GetCalculatedWeaponDPS

From GECK
Jump to: navigation, search


A function added by the JohnnyGuitar NVSE Plugin.

Description

Returns the total, calculated damage per second of a Weapon, adjusted by any bonuses/penalties from skill, perks and special ammo effects.

If called on an Inventory Reference, the damage will further be adjusted by the weapon's health, and by any weapon mods attached to it.

Syntax

[help]
(weaponDPS:float) reference.GetCalculatedWeaponDPS weaponForm:ref

Example

set fDPS to GetCalculatedWeaponDPS WeapGatlingLaser
set fDPS to inventoryRef.GetCalculatedWeaponDPS 

Notes

  • The function returns the calculated damage per second for the player actor only.
  • Any ammo effects that alter damage per second in the player's currently loaded ammo are used for the calculation, even if the weapon does not actually chamber it. The same happens when looking at the DPS info while hovering over weapons in the pipboy menu.

See Also