Difference between revisions of "GetWeaponFiringRate"

From Multi Theft Auto: Wiki
Jump to: navigation, search
(Example)
m
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{Client function}}
 
{{Client function}}
{{Needs_Example}}
 
 
Gets the firing rate to be used when you set the custom weapon to the firing state.
 
Gets the firing rate to be used when you set the custom weapon to the firing state.
  
Line 15: Line 14:
 
==Example==
 
==Example==
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
wep = createWeapon("minigun", 0, 0, 0)
+
local wep = createWeapon("minigun", 0, 0, 0)
  
 
function getWepRate()
 
function getWepRate()

Revision as of 05:46, 17 November 2013

Gets the firing rate to be used when you set the custom weapon to the firing state.

Syntax

int getWeaponFiringRate ( weapon theWeapon )

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

local wep = createWeapon("minigun", 0, 0, 0)

function getWepRate()
	if (not wep) then return end
	local rate = getWeaponFiringRate(wep)
	outputChatBox("Fire rate: "..rate)
end
addCommandHandler("firerate", getWepRate)

Requirements

Minimum supported server n/a
Minimum supported client 1.3.0-9.04555
Note: Using this function 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