ForcePlayerMap: Difference between revisions
Jump to navigation
Jump to search
m (Syntax section using) |
|||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool forcePlayerMap ( player thePlayer, bool forceOn )</syntaxhighlight> | <syntaxhighlight lang="lua">bool forcePlayerMap ( player thePlayer, bool forceOn )</syntaxhighlight> | ||
| Line 13: | Line 12: | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the player's radar map was forced on, ''false'' otherwise. | Returns ''true'' if the player's radar map was forced on, ''false'' otherwise. | ||
==Example== | ==Example== | ||
This example forces the radar map of the player named "dave" on for 10 seconds, if it hasn't been already | This example forces the radar map of the player named "dave" on for 10 seconds, if it hasn't been already | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| Line 29: | Line 26: | ||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Player functions}} | {{Player functions}} | ||
Revision as of 10:53, 15 November 2011
This function is used to forcefully show a player's radar map.
Syntax
bool forcePlayerMap ( player thePlayer, bool forceOn )
Required Arguments
- thePlayer: A player object referencing the specified player
- forceOn: A boolean value representing whether or not the players radar map will be forced on
Returns
Returns true if the player's radar map was forced on, false otherwise.
Example
This example forces the radar map of the player named "dave" on for 10 seconds, if it hasn't been already
-- Get the player named "dave"
dave = getPlayerFromName ( "dave" )
-- Make sure we found him
if ( dave ) then
if not isPlayerMapForced ( dave ) then -- if his radar map isn't already forced on
forcePlayerMap ( dave, true ) -- force it on
setTimer ( forcePlayerMap, 10000, 1, dave, false ) -- stop forcing in 10 seconds
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