Ui::displayRadar: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
Line 1: Line 1:
If Minimap / Radar should be displayed.
Function to set whether Minimap / Radar should be displayed.
==Syntax==
 
{{ClientSide}}
{{ClientsideCsJsFunction}}
{{JSContainer|
<syntaxhighlight lang="javascript">mp.game.ui.displayRadar(Toggle);</syntaxhighlight>
<syntaxhighlight lang="javascript">mp.game.ui.displayRadar(Toggle);</syntaxhighlight>
=== Required Arguments ===
 
*'''Toggle:''' Boolean
===Required Argument===
* '''Toggle:''' {{RageType|Boolean}}
 
===Return value===
===Return value===
*'''int'''
* {{RageType|Number}}


==Example==
===Example===
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
mp.game.ui.displayRadar(true) // Display the Radar
mp.game.ui.displayRadar(true); // Display the Radar
mp.game.ui.displayRadar(false) // Hide the Radar
mp.game.ui.displayRadar(false); // Hide the Radar
</syntaxhighlight>
</syntaxhighlight>
}}
{{CSharpContainer|
<syntaxhighlight lang="csharp">RAGE.Game.Ui.DisplayRadar(Toggle);</syntaxhighlight>
===Required Argument===
* '''Toggle:''' {{RageType|bool}}
}}


==See also==
==See also==
{{Ui_s_function_c}}
{{Ui_s_function_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:UI API]]
[[Category:UI API]]
[[Category:TODO: Example]]
[[Category:Client-side Function]]

Revision as of 16:17, 14 May 2019

Function to set whether Minimap / Radar should be displayed.

Client-Side Function

 C#  JavaScript


JavaScript Syntax

mp.game.ui.displayRadar(Toggle);

Required Argument

  • Toggle: Boolean

Return value

  • Number

Example

mp.game.ui.displayRadar(true); // Display the Radar
mp.game.ui.displayRadar(false); // Hide the Radar



C# Syntax

RAGE.Game.Ui.DisplayRadar(Toggle);

Required Argument

  • Toggle: bool



See also