GetPlayerFightingStyle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Changed "DeprecatedWithAlt" template to "Deprecated")
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__
{{Server function}}
{{Deprecated|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.
Line 6: Line 8:
<!-- 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===
<!-- 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 ( thePlayer, commandName )
function getPlayerFightStyle ( player, commandName )
local playerstyle = getPlayerFightingStyle ( thePlayer )   -- store the fighting style in a variable
playerstyle = getPlayerFightingStyle ( player )
outputChatBox ( tostring(playerstyle), thePlayer )         -- output it to the player
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
end
addCommandHandler ( "getfightingstyle", getPlayerFightStyle )
</syntaxhighlight>
</syntaxhighlight>


Latest revision as of 16:30, 13 February 2015

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use getPedFightingStyle instead.

This allows you to retrieve what fighting style a player is currently using.

Syntax

int getPlayerFightingStyle ( player thePlayer )

Required Arguments

  • thePlayer: The player whose current fighting style ID you wish to retrieve

Returns

Returns the player's current fighting style as an integer ID, false if it fails to retrieve a value.

Fighting Styles:

Fighting Style ID
STYLE_STANDARD 4
STYLE_BOXING 5
STYLE_KUNG_FU 6
STYLE_KNEE_HEAD 7
STYLE_GRAB_KICK 15
STYLE_ELBOWS 16

Example

This will allow any player to check what fighting style they are currently using, by typing the 'getfightingstyle' command. 

function getPlayerFightStyle ( thePlayer, commandName )
	local playerstyle = getPlayerFightingStyle ( thePlayer )   -- store the fighting style in a variable
	outputChatBox ( tostring(playerstyle), thePlayer )         -- output it to the player
end
addCommandHandler ( "getfightingstyle", getPlayerFightStyle )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerFightingStyle?oldid=44597"