RAGE Multiplayer Wiki - User contributions [en]

Keys::isDown

2025-01-15T12:56:18Z

Sander:

Function to check if specific key is pressed down.

==Syntax==
<pre>mp.keys.isDown(keyCode);</pre>

===Required Argument===
* '''keycode''' - hexadecimal code of [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 key].

===Return Value===
* {{RageType|Boolean}} - <code>true</code> if the key specified is pressed, Otherwise <code>false</code>.

==Example==
An interval that runs every 100ms and outputs the state of the key bound. (F2)
{{ClientsideCode|
<syntaxhighlight lang="javascript">
setInterval(() => {
mp.keys.isUp(0x71)
? mp.gui.chat.push("true")
: mp.gui.chat.push("false");
}, 100);

</syntaxhighlight>
}}

==See also==
{{Keys_functions_c}}

[[Category:Control]]
[[Category:Client-side Function]]

Keys::isUp

2025-01-15T12:55:05Z

Sander:

Function to check if specific key is released.

==Syntax==
<pre>mp.keys.isUp(keyCode);</pre>

===Required Argument===
* '''keycode''' - hexadecimal code of [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 key].

===Return Value===
* {{RageType|Boolean}} - <code>true</code> if the key specified is released, otherwise <code>false</code>.

==Example==
An interval that runs every 100ms and outputs the state of the key bound. (F2)
{{ClientsideCode|
<syntaxhighlight lang="javascript">
setInterval(() => {
mp.keys.isUp(0x71)
? mp.gui.chat.push("false")
: mp.gui.chat.push("true");
}, 100);
</syntaxhighlight>
}}

==See also==
{{Keys_functions_c}}

[[Category:Control]]
[[Category:Client-side Function]]

Key::bind

2025-01-15T12:48:22Z

Sander:

{{ClientsideJsFunction}}

== Description ==
This function binds the key.

==Parameters==
* '''keycode''' - hexadecimal code of [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 key].
* '''keydown/keyup''' - true trigges on keydown, false triggers on keyup (bool)
* '''handler''' - function-handler.

==Example==
This example calling server event.

<syntaxhighlight lang="javascript">
/** binds F2 to this inline arrow function */
mp.keys.bind(0x71, true, () => {
mp.gui.chat.push("F2 was pressed")
});
</syntaxhighlight>

==See also==
{{Keys_functions_c}}

Keys::unbind

2025-01-15T12:46:03Z

Sander:

This function unbinds the key.

===Required Arguments===
* '''keycode''' - Code of key (Hexadecimal).
* '''keyhold''' - Unbind the binds with keyhold-value.

===Optional Arguments===
* '''handler''' - Only unbind this handler.

[https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 Keycodes can be found here]

==Example==
{{ClientSide}}
<syntaxhighlight lang="javascript">
function handler() {
mp.gui.chat.push("F2 was pressed");
}

function toggle_keybind(state) {
state
? mp.keys.bind(0x71, true, handler); /** binds F2 to the handler fn */
: mp.keys.unbind(0x71, true, handler); /** unbinds the handler from F2 key */
}
</syntaxhighlight>

==See also==
{{Keys_functions_c}}

RAGE.Ui.HtmlWindow

2025-01-04T02:10:54Z

Sander: Add link to package protocol

Creates a new browser.

==Syntax==
<pre>class RAGE.Ui.HtmlWindow;</pre>

==Example==
{{CSharpContainer|
{{Example}}
<syntaxhighlight lang="C#">
RAGE.Ui.HtmlWindow CEF;

public void createBrowser(bool toggle, string way)
{
CEF = new RAGE.Ui.HtmlWindow(way); // Creating of browser ( way = "package://cs_packages/test.html" )
}

public void activateBrowser(bool toggle)
{
CEF.Active = toggle; // Activating of browser
}

public void urlBrowser(string url)
{
CEF.Url = url; // Changing url of browser
}
</syntaxhighlight>
}}

See [[Package Protocol]] for more info on the <code>package://</code> url.

[[Category:Clientside API]]

RAGE.Ui.HtmlWindow.Active

2025-01-04T02:10:04Z

Sander: Add link to package protocol

==Syntax==
<pre>bool HtmlWindow.Active { get; set; }</pre>

{{CSharpContainer|
<syntaxhighlight lang="C#">
HtmlWindow CEF = new HtmlWindow("http://package/index.html");

private void openUI() {
CEF.Active = true;
Rage.Ui.Cursor.Visible = true;
}

private void closeUI() {
CEF.Active = false;
Rage.Ui.Cursor.Visible = false;
}
</syntaxhighlight>
}}

See [[Package Protocol]] for more info on the <code>package://</code> url.

Browser::Browser

2025-01-04T02:06:44Z

Sander: Update broken package path

'''Function''': Creates a browser

==Parameters==
* '''URL''': {{RageType|String}}

==Syntax==
{{ClientsideCode|
<pre>
mp.browsers.new(url);
</pre>
}}

==Example==
{{ClientsideCode|
<pre>
mp.events.add('playerReady', () => {
let browser = mp.browsers.new("http://package/index.html");
});

</pre>
}}

See [[Package Protocol]] for more info on the <code>package://</code> url.

U can use browser events: [[BrowserCreated]], [[BrowserLoadingFailed]], [[BrowserDomReady]]

==See Also==
{{Browser_definition_c}}
[[Category:Clientside API]]

SendMouseMoveEvent

2024-09-16T20:33:29Z

Sander: /* browser.sendMouseMoveEvent(x, y) (Client-Side) */

{{ClientsideJsFunction}}
{{JSContainer|
Simulates mouse movement at the specified coordinates within the browser.

=== Required Params ===
*'''x:''' {{RageType|Number}} - X-coordinate of the mouse movement.
*'''y:''' {{RageType|Number}} - Y-coordinate of the mouse movement.

=== Return Value ===
*'''void''' {{RageType|void}}

==Syntax==
<pre>
browser.sendMouseMoveEvent(x, y);
</pre>

==Example==
{{ClientsideCode|
<syntaxhighlight lang="javascript">
// Example: Simulating mouse movement to (500, 400).
browser.sendMouseMoveEvent(500, 400);
</syntaxhighlight>
}}
}}

==See also==
[[Browser Definition]]
[[Category:Browser API]]
[[Category:Clientside API]]
[[Category:Client-side Function]]
[[Category:Shared Function]]

SendMouseMoveEvent

2024-09-16T20:32:37Z

Sander: Created page with "== browser.sendMouseMoveEvent(x, y) (Client-Side) == '''Client-side function to simulate mouse movement within a browser.''' === Usage: === <syntaxhighlight lang="javascript"> // Example: Simulating mouse movement to (500, 400). browser.sendMouseMoveEvent(500, 400); </syntaxhighlight> === Description: === Simulates mouse movement at the specified coordinates within the browser. === Parameters: === * <code>x</code>: X-coordinate of the mouse movement. * <code>y</c..."

== browser.sendMouseMoveEvent(x, y) (Client-Side) ==

'''Client-side function to simulate mouse movement within a browser.'''

=== Usage: ===
<syntaxhighlight lang="javascript">
// Example: Simulating mouse movement to (500, 400).
browser.sendMouseMoveEvent(500, 400);
</syntaxhighlight>

=== Description: ===
Simulates mouse movement at the specified coordinates within the browser.

=== Parameters: ===
* <code>x</code>: X-coordinate of the mouse movement.
* <code>y</code>: Y-coordinate of the mouse movement.