ForcePlayerMap: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (add client function oop notice)
(add client syntax)
Line 4: Line 4:


==Syntax==
==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool forcePlayerMap ( player thePlayer, bool forceOn )</syntaxhighlight>
<syntaxhighlight lang="lua">bool forcePlayerMap ( player thePlayer, bool forceOn )</syntaxhighlight>
{{OOP||[[player]]:forceMap|mapForced|isPlayerMapForced|Client side, Player.forceMap(bool forceOn) is used on the class}}
{{OOP||[[player]]:forceMap|mapForced|isPlayerMapForced}}
===Required Arguments===
===Required Arguments===
*'''thePlayer''': A [[player]] object referencing the specified player
*'''thePlayer''': A [[player]] object referencing the specified player
*'''forceOn''': A boolean value representing whether or not the players radar map will be forced on
*'''forceOn''': A boolean value representing whether or not the players radar map will be forced on
 
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool forcePlayerMap ( bool forceOn )</syntaxhighlight>
{{OOP||[[Player]].forceMap||isPlayerMapForced}}
===Required Arguments===
*'''forceOn''': A boolean value representing whether or not the players radar map will be forced on
</section>
===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.

Revision as of 18:01, 28 December 2014

This function is used to forcefully show a player's radar map.

Syntax

Click to collapse [-]
Server
bool forcePlayerMap ( player thePlayer, bool forceOn )

OOP Syntax Help! I don't understand this!

Method: player:forceMap(...)
Variable: .mapForced
Counterpart: isPlayerMapForced


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
Click to collapse [-]
Client
bool forcePlayerMap ( bool forceOn )

OOP Syntax Help! I don't understand this!

Method: Player.forceMap(...)
Counterpart: isPlayerMapForced


Required Arguments

  • 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 to show for 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

Retrieved from "https://wiki.multitheftauto.com/wiki/ForcePlayerMap?oldid=43519"