GetWeaponFiringRate

From Multi Theft Auto: Wiki
Revision as of 16:36, 23 December 2014 by AlexTMjugador (talk | contribs) (Added OOP syntax and improved the example)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

Minimum server version n/a
Minimum client version 1.3.0-9.04555

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.04555" />

See also