GetWeaponFiringRate: Difference between revisions
Jump to navigation
Jump to search
(Added OOP syntax and improved the example) |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This gets the firing rate to be used when a [[Element/Weapon|custom weapon]] opens fire. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">int getWeaponFiringRate ( weapon theWeapon )</syntaxhighlight> | <syntaxhighlight lang="lua">int getWeaponFiringRate ( weapon theWeapon )</syntaxhighlight> | ||
{{OOP||[[Element/Weapon|weapon]]:getFiringRate|firingRate|setWeaponFiringRate}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 13: | Line 14: | ||
==Example== | ==Example== | ||
This example creates a minigun at the center of the map and creates a ''/firerate'' command that outputs its firerate to the player who types it. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local weapon = createWeapon("minigun", 0, 0, | local weapon = createWeapon("minigun", 0, 0, 3) | ||
function | function outputMinigunFireRate() | ||
outputChatBox("Fire rate: " .. getWeaponFiringRate(weapon)) | |||
end | end | ||
addCommandHandler("firerate", | addCommandHandler("firerate", outputMinigunFireRate) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 28: | Line 27: | ||
{{Requirements|n/a|1.3.0-9.04555|}} | {{Requirements|n/a|1.3.0-9.04555|}} | ||
==See | ==See also== | ||
{{Client weapon creation functions}} | {{Client weapon creation functions}} | ||
Revision as of 16:36, 23 December 2014
This gets the firing rate to be used when a custom weapon opens fire.
Syntax
int getWeaponFiringRate ( weapon theWeapon )
OOP Syntax Help! I don't understand this!
- Method: weapon:getFiringRate(...)
- Variable: .firingRate
- Counterpart: setWeaponFiringRate
Required Arguments
- theWeapon: The weapon to modify the firing rate of.
Returns
Returns an integer with the firing rate of the custom weapon, false otherwise.
Example
This example creates a minigun at the center of the map and creates a /firerate command that outputs its firerate to the player who types it.
local weapon = createWeapon("minigun", 0, 0, 3)
function outputMinigunFireRate()
outputChatBox("Fire rate: " .. getWeaponFiringRate(weapon))
end
addCommandHandler("firerate", outputMinigunFireRate)
Requirements
This template will be deleted.
See also
- createWeapon
- fireWeapon
- getWeaponAmmo
- getWeaponClipAmmo
- getWeaponFiringRate
- getWeaponFlags
- getWeaponOwner
- getWeaponProperty
- getWeaponState
- getWeaponTarget
- resetWeaponFiringRate
- setWeaponAmmo
- setWeaponClipAmmo
- setWeaponFiringRate
- setWeaponFlags
- setWeaponProperty
- setWeaponState
- setWeaponTarget