GetPlayerWantedLevel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 4: Line 4:


==Syntax==  
==Syntax==  
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getPlayerWantedLevel ( player thePlayer )
int getPlayerWantedLevel ( player thePlayer )
Line 10: Line 11:
===Required Arguments===  
===Required Arguments===  
*'''thePlayer:''' The player whose wanted level you wish to get
*'''thePlayer:''' The player whose wanted level you wish to get
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
int getPlayerWantedLevel ( )
</syntaxhighlight>
</section>


===Returns===
===Returns===

Revision as of 11:56, 6 November 2010

This function gets a player's current wanted level. The wanted level is indicated by the amount of stars a player has on the GTA HUD.

Syntax

Click to collapse [-]
Server
int getPlayerWantedLevel ( player thePlayer )

Required Arguments

  • thePlayer: The player whose wanted level you wish to get
Click to collapse [-]
Client
int getPlayerWantedLevel ( )

Returns

Returns an int from 0 to 6 representing the player's wanted level, false if the player does not exist.

Example

This example finds which players in the server have a wanted level:

local players = getElementsByType ( "player" ) -- get a table of all the players in the server
for theKey,thePlayer in ipairs(players) do -- use a generic for loop to step through each player
   local level = getPlayerWantedLevel ( thePlayer ) -- get the wanted level of the player
   if ( level > 0 ) then -- if the player has any stars, announce it in the chat:
      outputChatBox ( getPlayerName ( thePlayer ) .. " has a wanted level of " .. level .. "  stars!" )
   end 
end

See Also