setPlayerWantedLevel | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

setPlayerWantedLevel

Client-side
Server-side
Shared

Pair: getPlayerWantedLevel

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

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

OOP Syntax Help! I don't understand this!

  • Method:player:setWantedLevel(...)
  • Variable: .wantedLevel

Syntax 

bool setPlayerWantedLevel ( player thePlayer, int stars )
Required Arguments
  • thePlayer: The player whose wanted level is to be set
  • stars: An integer from 0 to 6 representing the wanted level

Returns

  • bool: value

Returns true if the wanted level was set successfully, false if any of the arguments were invalid.

Code Examples

shared

This example sets a player's wanted level to six stars if they enter a certain colshape:

-- assume that there exists a collision shape named 'policeStation'
function policeStationHit ( thePlayer )
   setPlayerWantedLevel ( thePlayer, 6 ) -- set the player's wanted level to 6 stars
   outputChatBox ( getPlayerName ( thePlayer ) .. " entered the police station!" )
end
-- call 'policeStationHit' when a player enters the collision shape:
addEventHandler ( "onColShapeHit", policeStation, policeStationHit )

See Also

Player Functions
Player Events
Reference