GetWeaponFiringRate - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T17:06:16Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:06, 7 November 2024
Line 23:		Line 23:
	addCommandHandler("firerate", outputMinigunFireRate)		addCommandHandler("firerate", outputMinigunFireRate)
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.3.0-9.04555\|}}~~

	==See also==		==See also==
	{{Client weapon creation functions}}		{{Client weapon creation functions}}

AlexTMjugador: Added OOP syntax and improved the example

2014-12-23T16:36:25Z

Added OOP syntax and improved the example

← Older revision		Revision as of 16:36, 23 December 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	~~Gets~~ the firing rate to be used when ~~you set the~~ custom weapon ~~to the firing state~~.		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, 0)		local weapon = createWeapon("minigun", 0, 0, 3)

	function ~~Command_GetWepRate~~()		function outputMinigunFireRate()
	~~if weapon then~~		outputChatBox("Fire rate: " .. getWeaponFiringRate(weapon))
	~~local rate = getWeaponFiringRate(weapon)~~
	outputChatBox("Fire rate: " .. ~~rate~~)
	~~end~~
	end		end
	addCommandHandler("firerate", ~~Command_GetWepRate~~)		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 ~~Also~~==		==See also==
	{{Client weapon creation functions}}		{{Client weapon creation functions}}

Ixjf: /* Example */

2013-11-17T11:50:49Z

Example

← Older revision		Revision as of 11:50, 17 November 2013
Line 14:		Line 14:
	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local ~~wep~~ = createWeapon("minigun", 0, 0, 0)		local weapon = createWeapon("minigun", 0, 0, 0)

	function ~~getWepRate~~()		function Command_GetWepRate()
	if ~~(not wep)~~ then ~~return end~~		if weapon then
	local rate = getWeaponFiringRate(~~wep~~)		local rate = getWeaponFiringRate(weapon)
	outputChatBox("Fire rate: "..rate)		outputChatBox("Fire rate: " .. rate)
			end
	end		end
	addCommandHandler("firerate", ~~getWepRate~~)		addCommandHandler("firerate", Command_GetWepRate)
	</syntaxhighlight>		</syntaxhighlight>

Jaysds1 at 05:46, 17 November 2013

2013-11-17T05:46:27Z

← Older revision		Revision as of 05:46, 17 November 2013
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()

Sebbe: /* Example */

2013-11-15T09:35:37Z

Example

← Older revision		Revision as of 09:35, 15 November 2013
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>

Jaysds1: Added example header and Needs Example

2013-07-19T16:16:03Z

Added example header and Needs Example

← Older revision		Revision as of 16:16, 19 July 2013
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 11:		Line 12:
	===Returns===		===Returns===
	Returns an ''integer'' with the firing rate of the custom weapon, ''false'' otherwise.		Returns an ''integer'' with the firing rate of the custom weapon, ''false'' otherwise.

			==Example==
			<syntaxhighlight lang="lua">
			--ToDo
			</syntaxhighlight>

	==Requirements==		==Requirements==

Ccw at 22:45, 10 September 2012

2012-09-10T22:45:54Z

← Older revision		Revision as of 22:45, 10 September 2012
Line 13:		Line 13:

	==Requirements==		==Requirements==
	{{Requirements\|1.3.0-~~4555\|1~~.~~3.0-4555~~\|}}		{{Requirements\|n/a\|1.3.0-9.04555\|}}

	==See Also==		==See Also==
	{{Client weapon creation functions}}		{{Client weapon creation functions}}

Cazomino05 at 10:46, 26 August 2012

2012-08-26T10:46:33Z

← Older revision		Revision as of 10:46, 26 August 2012
Line 16:		Line 16:

	==See Also==		==See Also==
	{{Client weapon functions}}		{{Client weapon creation functions}}

Arran Fortuna: Created page with "NOTOC {{Client function}} Gets the firing rate to be used when you set the custom weapon to the firing state. ==Syntax== int getWeaponFiringRate ( weapon theWeapo..."

2012-08-25T23:24:19Z

Created page with "__NOTOC__ {{Client function}} Gets the firing rate to be used when you set the custom weapon to the firing state. ==Syntax== <syntaxhighlight lang="lua">int getWeaponFiringRate ( weapon theWeapo..."

New page

__NOTOC__
{{Client function}}
Gets the firing rate to be used when you set the custom weapon to the firing state.

==Syntax==
<syntaxhighlight lang="lua">int getWeaponFiringRate ( weapon theWeapon )</syntaxhighlight>

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

==Requirements==
{{Requirements|1.3.0-4555|1.3.0-4555|}}

==See Also==
{{Client weapon functions}}