GetPlayerFightingStyle: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| 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 | 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 --> | ||
*''' | *'''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 ' | *Returns the player's current fighting style as an integer ID | ||
false | *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 | 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"> | ||
addCommandHandler ( "getfightingstyle", "getPlayerFightStyle" ) | |||
function getPlayerFightStyle ( player, commandName ) | |||
playerstyle = getPlayerFightingStyle ( 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 | |||
</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 --> | ||
{{ | {{Player_functions}} | ||
[[Category:Incomplete]] -- leave this unless you complete the function | [[Category:Incomplete]] -- leave this unless you complete the function | ||
Revision as of 03:38, 12 April 2007
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
- Returns false if it fails to retrieve a value
Example
This will allow any player to check what fighting style they are currently using
addCommandHandler ( "getfightingstyle", "getPlayerFightStyle" ) function getPlayerFightStyle ( player, commandName ) playerstyle = getPlayerFightingStyle ( 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
See Also
- getPlayerTeam
- getPlayerBlurLevel
- setPlayerBlurLevel
- getPlayerSerial
- forcePlayerMap
- getPlayerScriptDebugLevel
- getPlayerFromName
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerWantedLevel
- givePlayerMoney
- isPlayerMapForced
- isPlayerNametagShowing
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- takePlayerMoney
- countPlayersInTeam
- getPlayersInTeam
- isVoiceEnabled
- setControlState
- getControlState
-- leave this unless you complete the function