GetPlayerFightingStyle - Revision history

AlexTMjugador: Changed "DeprecatedWithAlt" template to "Deprecated"

2015-02-13T16:30:46Z

Changed "DeprecatedWithAlt" template to "Deprecated"

← Older revision		Revision as of 16:30, 13 February 2015
Line 1:		Line 1:
			__NOTOC__
	{{Server function}}		{{Server function}}
	~~__NOTOC__~~		{{Deprecated\|getPedFightingStyle\|}}
	{{~~DeprecatedWithAlt~~\|getPedFightingStyle\|}}

	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This allows you to retrieve what fighting style a player is currently using.		This allows you to retrieve what fighting style a player is currently using.

AlexTMjugador: Visual improvement

2014-06-25T14:26:41Z

Visual improvement

← Older revision		Revision as of 14:26, 25 June 2014
Line 1:		Line 1:
	{{Server function}}		{{Server function}}
	__NOTOC__		__NOTOC__
	{{~~Deprecated~~}}		{{DeprecatedWithAlt\|getPedFightingStyle\|}}

	~~Please use [[getPedFightingStyle]]~~

	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->

Arran Fortuna at 20:58, 20 April 2011

2011-04-20T20:58:25Z

← Older revision		Revision as of 20:58, 20 April 2011
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	{{Deprecated}}		{{Deprecated}}

			Please use [[getPedFightingStyle]]

	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This allows you to retrieve what fighting style a player is currently using.		This allows you to retrieve what fighting style a player is currently using.

Ccw at 14:13, 20 January 2009

2009-01-20T14:13:26Z

← Older revision		Revision as of 14:13, 20 January 2009
Line 1:		Line 1:
	{{Server function}}		{{Server function}}
	__NOTOC__		__NOTOC__
			{{Deprecated}}
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This allows you to retrieve what fighting style a player is currently using.		This allows you to retrieve what fighting style a player is currently using.

Arc at 16:08, 19 August 2007

2007-08-19T16:08:53Z

← Older revision		Revision as of 16:08, 19 August 2007
Line 1:		Line 1:
	__NOTOC__		{{Server function}}
			__NOTOC__
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This allows you to retrieve what fighting style a player is currently using.		This allows you to retrieve what fighting style a player is currently using.
Line 6:		Line 7:
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int getPlayerFightingStyle ( player ~~theplayer~~ )		int getPlayerFightingStyle ( player thePlayer )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->		<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
	*'''~~theplayer~~:''' The player whose current fighting style ID you wish to retrieve		*'''thePlayer:''' The player whose current fighting style ID you wish to retrieve

	===Returns===		===Returns===
Line 24:		Line 25:
	<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->		<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function getPlayerFightStyle ( ~~player~~, commandName )		function getPlayerFightStyle ( thePlayer, commandName )
	local playerstyle = getPlayerFightingStyle ( ~~player~~ ) -- store the fighting style in a variable		local playerstyle = getPlayerFightingStyle ( thePlayer ) -- store the fighting style in a variable
	outputChatBox(tostring(playerstyle),~~player~~) -- output it to the player		outputChatBox ( tostring(playerstyle), thePlayer ) -- output it to the player
	end		end
	addCommandHandler ( "getfightingstyle", getPlayerFightStyle )		addCommandHandler ( "getfightingstyle", getPlayerFightStyle )

Driver2 at 22:15, 29 July 2007

2007-07-29T22:15:24Z

← Older revision		Revision as of 22:15, 29 July 2007
Line 15:		Line 15:
	===Returns===		===Returns===
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
	*Returns the player's current fighting style as an integer ID		Returns the player's current fighting style as an integer ID, ''false'' if it fails to retrieve a value.
	*Returns false if it fails to retrieve a value
			{{Fighting Styles}}

	==Example==		==Example==
	<!-- Explain what the example is in a single sentance -->		<!-- Explain what the example is in a single sentance -->
	This will allow any player to check what fighting style they are currently using		This will allow any player to check what fighting style they are currently using, by typing the 'getfightingstyle' command.
	<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->		<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addCommandHandler ( "getfightingstyle", "getPlayerFightStyle" )~~
	function getPlayerFightStyle ( player, commandName )		function getPlayerFightStyle ( player, commandName )
	playerstyle = getPlayerFightingStyle ( player )		local playerstyle = getPlayerFightingStyle ( player ) -- store the fighting style in a variable
	~~if playerstyle == 4 then~~		outputChatBox(tostring(playerstyle),player) -- output it to the player
	outputChatBox ( ~~"Style: standard" )~~
	~~elseif playerstyle == 5 then~~
	~~outputChatBox~~ ( ~~"Style: boxing" )~~
	~~elseif~~ playerstyle ~~== 6 then~~
	~~outputChatBox ( "Style: kungfu"~~ )
	~~elseif playerstyle == 7 then~~
	~~outputChatBox ( "Style: taebo (knees~~)~~" )~~
	~~end~~
	end		end
			addCommandHandler ( "getfightingstyle", getPlayerFightStyle )
	</syntaxhighlight>		</syntaxhighlight>

Ransom at 03:38, 12 April 2007

2007-04-12T03:38:25Z

← Older revision		Revision as of 03:38, 12 April 2007
Line 41:		Line 41:
	<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->		<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
	{{Player_functions}}		{{Player_functions}}
	~~[[Category:Incomplete]] -- leave this unless you complete the function~~

Ransom at 03:38, 12 April 2007

2007-04-12T03:38:15Z

← Older revision		Revision as of 03:38, 12 April 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This ~~fake function~~ is ~~for use with blah & blah and does blahblahblabhalbhl~~		This allows you to retrieve what fighting style a player is currently using.

	==Syntax==		==Syntax==
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int getPlayerFightingStyle ( player )		int getPlayerFightingStyle ( player theplayer )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->		<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
	*'''~~argumentName~~:''' ~~description~~		*'''theplayer:''' The player whose current fighting style ID you wish to retrieve

	~~<!-- Only include this section below if there are optional arguments -->~~
	~~===Optional Arguments===~~
	~~{{OptionalArg}}~~
	*'''argumentName2:''' description
	*'''argumentName3:''' description

	===Returns===		===Returns===
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
	Returns '~~'true'' if blah, ''false'' otherwise. <br \>~~		*Returns the player's current fighting style as an integer ID
	false ~~on fail~~		*Returns false if it fails to retrieve a value

	==Example==		==Example==
	<!-- Explain what the example is in a single sentance -->		<!-- Explain what the example is in a single sentance -->
	This ~~example does...~~		This will allow any player to check what fighting style they are currently using
	<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->		<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~--This line does...~~		addCommandHandler ( "getfightingstyle", "getPlayerFightStyle" )
	~~blabhalbalhb --abababa~~		function getPlayerFightStyle ( player, commandName )
	~~--This line does this...~~		playerstyle = getPlayerFightingStyle ( player )
	~~mooo~~		if playerstyle == 4 then
			outputChatBox ( "Style: standard" )
			elseif playerstyle == 5 then
			outputChatBox ( "Style: boxing" )
			elseif playerstyle == 6 then
			outputChatBox ( "Style: kungfu" )
			elseif playerstyle == 7 then
			outputChatBox ( "Style: taebo (knees)" )
			end
			end
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->		<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
	{{~~FunctionArea_functions~~}}		{{Player_functions}}
	[[Category:Incomplete]] -- leave this unless you complete the function		[[Category:Incomplete]] -- leave this unless you complete the function

Ransom at 23:09, 11 April 2007

2007-04-11T23:09:20Z

← Older revision		Revision as of 23:09, 11 April 2007
Line 38:		Line 38:
	<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->		<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
	{{FunctionArea_functions}}		{{FunctionArea_functions}}
	~~[[Category:Need_Syntax]] -- leave this until syntax is available. Cannot document the function or event without syntax.~~
	[[Category:Incomplete]] -- leave this unless you complete the function		[[Category:Incomplete]] -- leave this unless you complete the function

Ransom at 23:08, 11 April 2007

2007-04-11T23:08:43Z

← Older revision		Revision as of 23:08, 11 April 2007
Line 6:		Line 6:
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~returnType functionName~~ ( ~~arguments~~ )		int getPlayerFightingStyle ( player )
	</syntaxhighlight>		</syntaxhighlight>

Line 21:		Line 21:
	===Returns===		===Returns===
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
	Returns ''true'' if blah, ''false'' otherwise.		Returns ''true'' if blah, ''false'' otherwise. <br \>
			false on fail

	==Example==		==Example==