Ui::displayRadar: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
If Minimap / Radar should be displayed.
Function to set whether Minimap / Radar should be displayed.
==Syntax==
 
{{ClientsideCsJsFunction}}
{{JSContainer|
<syntaxhighlight lang="javascript">mp.game.ui.displayRadar(Toggle);</syntaxhighlight>
<syntaxhighlight lang="javascript">mp.game.ui.displayRadar(Toggle);</syntaxhighlight>
=== Required Arguments ===
 
*'''Toggle:''' Boolean
{{Parameters}}
* '''Toggle:''' {{RageType|Boolean}} - <code>true</code> to display radar, otherwise <code>false</code>.
 
===Return value===
===Return value===
*'''int'''
* {{RageType|Number}}


==Example==
{{Example}}
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
// todo
mp.game.ui.displayRadar(true); // Display the Radar
mp.game.ui.displayRadar(false); // Hide the Radar
</syntaxhighlight>
}}
 
{{CSharpContainer|
<syntaxhighlight lang="csharp">RAGE.Game.Ui.DisplayRadar(Toggle);</syntaxhighlight>
 
{{Parameters}}
* '''Toggle:''' {{RageType|bool}} - <code>true</code> to display radar, otherwise <code>false</code>.
 
{{Example}}
<syntaxhighlight lang="csharp">
RAGE.Game.Ui.DisplayRadar(true); // Display the Radar
RAGE.Game.Ui.DisplayRadar(false); // Hide the Radar
</syntaxhighlight>
</syntaxhighlight>
}}
==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]]

Latest revision as of 16:26, 14 May 2019

Function to set whether Minimap / Radar should be displayed.

Client-Side Function

 C#  JavaScript


JavaScript Syntax

mp.game.ui.displayRadar(Toggle);

Parameters

  • Toggle: Boolean - true to display radar, otherwise false.

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);

Parameters

  • Toggle: bool - true to display radar, otherwise false.

Example

RAGE.Game.Ui.DisplayRadar(true); // Display the Radar
RAGE.Game.Ui.DisplayRadar(false); // Hide the Radar



See also