ForcePlayerMap: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 15: Line 15:
==Example==
==Example==
<section name="Server" class="server" show="true">
<section name="Server" class="server" show="true">
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 "Pedro" on for 10 seconds, if it hasn't been already
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Get the player named "Pedro"
-- Get the player named "Pedro"
dave = getPlayerFromName ( "Pedro" )
Pedro = getPlayerFromName ( "Pedro" )
-- Make sure we found him
-- Pedro sure we found him
if ( dave ) then
if ( Pedro ) then
     if not isPlayerMapForced ( dave ) then                  -- if his radar map isn't already forced on
     if not isPlayerMapForced ( Pedro ) then                  -- if his radar map isn't already forced on
         forcePlayerMap ( dave, true )                      -- force it on
         forcePlayerMap ( Pedro, true )                      -- force it on
         setTimer ( forcePlayerMap, 10000, 1, dave, false )  -- stop forcing in 10 seconds
         setTimer ( forcePlayerMap, 10000, 1, Pedro, false )  -- stop forcing in 10 seconds
     end
     end
end
end

Revision as of 11:19, 23 July 2010

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

Click to collapse [-]
Server

This example forces the radar map of the player named "Pedro" on for 10 seconds, if it hasn't been already

-- Get the player named "Pedro"
Pedro = getPlayerFromName ( "Pedro" )
-- Pedro sure we found him
if ( Pedro ) then
    if not isPlayerMapForced ( Pedro ) then                  -- if his radar map isn't already forced on
        forcePlayerMap ( Pedro, true )                       -- force it on
        setTimer ( forcePlayerMap, 10000, 1, Pedro, false )  -- stop forcing in 10 seconds
    end
end

See Also