GetWeaponFiringRate: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added example header and Needs Example)
Line 15: Line 15:
==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--ToDo
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)
</syntaxhighlight>
</syntaxhighlight>



Revision as of 09:35, 15 November 2013

Accessories-text-editor.png Script Example Missing Function GetWeaponFiringRate needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.

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

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 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