RAGE Multiplayer Wiki - User contributions [en]

User:Caballero

2024-10-07T17:32:15Z

Caballero:

=)

<syntaxhighlight lang="javascript">
_____ _____ _____ _____ _____
/\ \ /\ \ /\ \ /\ \ /\ \
/::\ \ /::\ \ /::\ \ /::\ \ /::\ \
/::::\ \ /::::\ \ /::::\ \ /::::\ \ \:::\ \
/::::::\ \ /::::::\ \ /::::::\ \ /::::::\ \ \:::\ \
/:::/\:::\ \ /:::/\:::\ \ /:::/\:::\ \ /:::/\:::\ \ \:::\ \
/:::/__\:::\ \ /:::/__\:::\ \ /:::/__\:::\ \ /:::/__\:::\ \ \:::\ \
/::::\ \:::\ \ /::::\ \:::\ \ /::::\ \:::\ \ \:::\ \:::\ \ /::::\ \
/::::::\ \:::\ \ /::::::\ \:::\ \ /::::::\ \:::\ \ ___\:::\ \:::\ \ /::::::\ \
/:::/\:::\ \:::\ ___\ /:::/\:::\ \:::\ \ /:::/\:::\ \:::\ \ /\ \:::\ \:::\ \ /:::/\:::\ \
/:::/__\:::\ \:::| |/:::/__\:::\ \:::\____\/:::/ \:::\ \:::\____\/::\ \:::\ \:::\____\ /:::/ \:::\____\
\:::\ \:::\ /:::|____|\:::\ \:::\ \::/ /\::/ \:::\ /:::/ /\:::\ \:::\ \::/ / /:::/ \::/ /
\:::\ \:::\/:::/ / \:::\ \:::\ \/____/ \/____/ \:::\/:::/ / \:::\ \:::\ \/____/ /:::/ / \/____/
\:::\ \::::::/ / \:::\ \:::\ \ \::::::/ / \:::\ \:::\ \ /:::/ /
\:::\ \::::/ / \:::\ \:::\____\ \::::/ / \:::\ \:::\____\ /:::/ /
\:::\ /:::/ / \:::\ \::/ / /:::/ / \:::\ /:::/ / \::/ /
\:::\/:::/ / \:::\ \/____/ /:::/ / \:::\/:::/ / \/____/
\::::::/ / \:::\ \ /:::/ / \::::::/ /
\::::/ / \:::\____\ /:::/ / \::::/ /
\::/____/ \::/ / \::/ / \::/ /
~~ \/____/ \/____/ \/____/

</syntaxhighlight>

<syntaxhighlight lang="javascript">
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@,,,&@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@&,,,@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@@@
@@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@@@@,,,,,,,,,,,,,,,,,,,,,,,,,@@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@@@,,,,,,,,,,,,,,,,,,,,,,,,,,,@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,,,,,,/@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*,,,,,,@@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@@,,,,,,,,,,,,,,,,,,,,,,,,,,,@@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@@,,,,,,,,,,,,,,,,,,,,,,,,,,@@@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@%,,,,,,@@@@,,,,,,,,*@@@@@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@,,,,,,,@@@@@@,,,,,,,,,@@@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,,,,,,,,@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,,,,,,,,,@@@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@
@@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@@
@@@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@,@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@,,,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@&,,,@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

</syntaxhighlight>

<syntaxhighlight lang="javascript">
__ __
/ /_ ___ ____ ______/ /_
/ __ \/ _ \/ __ `/ ___/ __/
/ /_/ / __/ /_/ (__ ) /_
/_.___/\___/\__,_/____/\__/

</syntaxhighlight>

beast

User:Caballero

2024-10-07T17:30:49Z

Caballero:

=)

<syntaxhighlight lang="javascript">
_____ _____ _____ _____ _____
/\ \ /\ \ /\ \ /\ \ /\ \
/::\ \ /::\ \ /::\ \ /::\ \ /::\ \
/::::\ \ /::::\ \ /::::\ \ /::::\ \ \:::\ \
/::::::\ \ /::::::\ \ /::::::\ \ /::::::\ \ \:::\ \
/:::/\:::\ \ /:::/\:::\ \ /:::/\:::\ \ /:::/\:::\ \ \:::\ \
/:::/__\:::\ \ /:::/__\:::\ \ /:::/__\:::\ \ /:::/__\:::\ \ \:::\ \
/::::\ \:::\ \ /::::\ \:::\ \ /::::\ \:::\ \ \:::\ \:::\ \ /::::\ \
/::::::\ \:::\ \ /::::::\ \:::\ \ /::::::\ \:::\ \ ___\:::\ \:::\ \ /::::::\ \
/:::/\:::\ \:::\ ___\ /:::/\:::\ \:::\ \ /:::/\:::\ \:::\ \ /\ \:::\ \:::\ \ /:::/\:::\ \
/:::/__\:::\ \:::| |/:::/__\:::\ \:::\____\/:::/ \:::\ \:::\____\/::\ \:::\ \:::\____\ /:::/ \:::\____\
\:::\ \:::\ /:::|____|\:::\ \:::\ \::/ /\::/ \:::\ /:::/ /\:::\ \:::\ \::/ / /:::/ \::/ /
\:::\ \:::\/:::/ / \:::\ \:::\ \/____/ \/____/ \:::\/:::/ / \:::\ \:::\ \/____/ /:::/ / \/____/
\:::\ \::::::/ / \:::\ \:::\ \ \::::::/ / \:::\ \:::\ \ /:::/ /
\:::\ \::::/ / \:::\ \:::\____\ \::::/ / \:::\ \:::\____\ /:::/ /
\:::\ /:::/ / \:::\ \::/ / /:::/ / \:::\ /:::/ / \::/ /
\:::\/:::/ / \:::\ \/____/ /:::/ / \:::\/:::/ / \/____/
\::::::/ / \:::\ \ /:::/ / \::::::/ /
\::::/ / \:::\____\ /:::/ / \::::/ /
\::/____/ \::/ / \::/ / \::/ /
~~ \/____/ \/____/ \/____/

</syntaxhighlight>

<syntaxhighlight lang="javascript">

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@***@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@&***@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@@@
@@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@@@@*************************@@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@@@***************************@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@******(@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@/******@@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@@***************************@@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@@**************************@@@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@%******@@@@********/@@@@@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@*******@@@@@@*********@@@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@********@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*********@@@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@
@@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@@
@@@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@***@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@&***@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

</syntaxhighlight>

<syntaxhighlight lang="javascript">
__ __
/ /_ ___ ____ ______/ /_
/ __ \/ _ \/ __ `/ ___/ __/
/ /_/ / __/ /_/ (__ ) /_
/_.___/\___/\__,_/____/\__/

</syntaxhighlight>

beast

User:Caballero

2024-10-07T17:29:22Z

Caballero:

User:Caballero

2024-10-07T17:28:04Z

Caballero:

User:Caballero

2024-10-07T17:25:53Z

Caballero:

=)

beast

User:Caballero

2024-10-07T17:25:40Z

Caballero:

=)

beast

User:Caballero

2024-10-07T17:25:13Z

Caballero:

=)

beast

Entity::freezePosition

2024-10-06T22:18:39Z

Caballero:

{{ClientsideJsFunction}}
{{JSContainer|

===Required Params===
*'''toggle:''' {{RageType|boolean}} — A boolean value indicating whether to freeze (true) or unfreeze (false) the entity's position.

===Return value===
*'''void''' — This function does not return a value.

==Syntax==
<syntaxhighlight lang="javascript">
// Function to freeze the player's position
function freezePlayerPosition(toggle) {
let player = mp.players.local; // Reference to the local player
player.freezePosition(toggle); // Freeze or unfreeze the player's position
mp.gui.chat.push("Your position " + (toggle ? "frozen" : "unfrozen") + ".");
}

// Function to freeze the player's position by ID
function freezePlayerPositionById(playerId, toggle) {
let player = mp.players.at(playerId); // Get the player by ID
if (player) { // Check if the player exists
player.freezePosition(toggle); // Freeze or unfreeze the player's position
mp.gui.chat.push("Player ID " + playerId + " position " + (toggle ? "frozen" : "unfrozen") + ".");
} else {
mp.gui.chat.push("Player with ID " + playerId + " not found.");
}
}

// Bind the function to the "E" key (freeze/unfreeze self)
mp.keys.bind(69, false, function() { // 69 is the key code for "E"
let player = mp.players.local; // Reference to the local player
let isFrozen = player.isPositionFrozen; // Check if the player's position is currently frozen
freezePlayerPosition(!isFrozen); // Toggle freeze state
});

// Bind the function to the "X" key (freeze/unfreeze player by ID)
mp.keys.bind(88, false, function() { // 88 is the key code for "X"
let playerId = 0; // Set the player ID to 0 (you can change this to any ID)
let player = mp.players.at(playerId); // Get the player by ID
if (player) { // Check if the player exists
let isFrozen = player.isPositionFrozen; // Check if the player's position is currently frozen
freezePlayerPositionById(playerId, !isFrozen); // Toggle freeze state
} else {
mp.gui.chat.push("Player with ID " + playerId + " not found.");
}
});
</syntaxhighlight>
}}

==See also==
{{Entity_functions_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Entity::freezePosition

2024-10-06T22:14:25Z

Caballero:

Entity::freezePosition

2024-10-06T22:12:22Z

Caballero:

Player::setModel

2024-10-06T22:04:05Z

Caballero:

{{ClientsideJsFunction}}
{{JSContainer|

===Required Params===
*'''modelName:''' {{RageType|string}} — The name of the model to be set for the player.

===Return value===
*'''void''' — This function does not return a value.

==Syntax==
<syntaxhighlight lang="javascript">
// Function to change the player's model
function changePlayerModel(modelName) {
let player = mp.players.local; // Reference to the local player
let modelHash = mp.game.joaat(modelName); // Get the model hash from the model name

// Set the player's model
player.model = modelHash; // Change the player's model

// Notify the player
mp.gui.chat.push("Your model has been changed to " + modelName + ".");
}

// Bind the function to a key (for example, the "E" key)
mp.keys.bind(69, false, function() { // 69 is the key code for "E"
changePlayerModel('a_m_m_acult_01'); // Call the function to change the model
});
</syntaxhighlight>
}}

==Available Models==
See the list of available models: [https://wiki.rage.mp/index.php?title=Peds Peds]

==See also==
{{Ped_functions_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

VoiceChat.defaultVolume

2024-10-06T20:47:15Z

Caballero:

{{ClientsideJsFunction}}
{{JSContainer|

===Required Params===
*'''volume:''' {{RageType|number}} — The desired volume level for the voice chat (0 to 1).

===Return value===
*'''void''' — This function does not return a value.

==Syntax==
<syntaxhighlight lang="javascript">
// Function to set the voice chat volume
function setVoiceChatVolume() {
let volume = 0.5; // Set the desired volume level (0 = muted, 1 = maximum)

// Set the default voice chat volume
mp.voiceChat.defaultVolume = volume;

// Notify the player that the voice chat volume has been set
mp.gui.chat.push("Voice chat volume set to: " + volume);
}

// Bind the function to a key (the "E" key)
mp.keys.bind(69, false, function() { // 69 is the key code for "E"
setVoiceChatVolume(); // Call the function to change the voice chat volume
});
</syntaxhighlight>
}}

==See also==
{{VoiceChat_functions_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Audio::isMobilePhoneCallOngoing

2024-10-06T20:43:28Z

Caballero:

{{ClientsideJsFunction}}
{{JSContainer|

===Return value===
*'''boolean''' — Returns `true` if a mobile phone call is currently ongoing, otherwise returns `false`.

==Syntax==
<syntaxhighlight lang="javascript">
// Function to check if a mobile phone call is ongoing
function checkMobilePhoneCall() {
// Check if a mobile phone call is ongoing
let isCallOngoing = mp.game.audio.isMobilePhoneCallOngoing();

// Notify the player about the call status
if (isCallOngoing) {
mp.gui.chat.push("You are currently on a phone call.");
} else {
mp.gui.chat.push("You are not on a phone call.");
}
}

// Bind the function to a key (the "E" key)
mp.keys.bind(69, false, function() { // 69 is the key code for "E"
checkMobilePhoneCall(); // Call the function to check the phone call status
});
</syntaxhighlight>
}}

==See also==
{{Audio_functions_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

User:Caballero

2024-10-06T20:42:25Z

Caballero:

User:Caballero

2024-10-06T20:42:12Z

Caballero: Created page with ":)"

Audio::stopPedRingtone

2024-10-06T20:40:59Z

Caballero:

{{ClientsideJsFunction}}
{{JSContainer|

===Required Params===
*'''ped:''' {{RageType|number}} — The ID of the pedestrian (player character) whose ringtone will be stopped.

===Return value===
*'''void''' — This function does not return a value.

==Syntax==
<syntaxhighlight lang="javascript">
// Function to stop the ringtone for the player
function stopRingtoneForPlayer() {
let player = mp.players.local; // Reference to the local player

// Stop the ringtone for the player
mp.game.audio.stopPedRingtone(player.handle);

// Notify the player that the ringtone has been stopped
mp.gui.chat.push("Stopped ringtone.");
}

// Bind the function to a key (the "E" key)
mp.keys.bind(69, false, function() { // 69 is the key code for "E"
stopRingtoneForPlayer(); // Call the function to stop the ringtone
});
</syntaxhighlight>
}}

==See also==
{{Audio_functions_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Audio::isPedRingtonePlaying

2024-10-06T20:38:56Z

Caballero:

{{ClientsideJsFunction}}
{{JSContainer|

===Required Params===
*'''ped:''' {{RageType|number}} — The ID of the pedestrian (player character) to check if the ringtone is playing.

===Return value===
*'''boolean''' — Returns true if the ringtone is currently playing for the specified pedestrian, otherwise returns false.

==Syntax==
<syntaxhighlight lang="javascript">
// Function to check if a ringtone is playing for the player
function checkRingtoneStatus() {
let player = mp.players.local; // Reference to the local player

// Check if a ringtone is playing for the player
let isPlaying = mp.game.audio.isPedRingtonePlaying(player.handle);

// Notify the player about the ringtone status
if (isPlaying) {
mp.gui.chat.push("A ringtone is currently playing.");
} else {
mp.gui.chat.push("No ringtone is currently playing.");
}
}

// Bind the function to a key (for example, the "E" key)
mp.keys.bind(69, false, function() { // 69 is the key code for "E"
checkRingtoneStatus(); // Call the function to check ringtone status
});
</syntaxhighlight>
}}

==See also==
{{Audio_functions_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Audio::isPedRingtonePlaying

2024-10-06T20:38:33Z

Caballero:

{{ClientsideJsFunction}}
{{JSContainer|

===Required Params===
*'''ped:''' {{RageType|number}} — The ID of the pedestrian (player character) to check if the ringtone is playing.

===Return value===
*'''boolean''' — Returns true if the ringtone is currently playing for the specified pedestrian, otherwise returns false.

==Syntax==
<syntaxhighlight lang="javascript">
// Function to check if a ringtone is playing for the player
function checkRingtoneStatus() {
let player = mp.players.local; // Reference to the local player

// Check if a ringtone is playing for the player
let isPlaying = mp.game.audio.isPedRingtonePlaying(player.handle);

// Notify the player about the ringtone status
if (isPlaying) {
mp.gui.chat.push("A ringtone is currently playing.");
} else {
mp.gui.chat.push("No ringtone is currently playing.");
}
}

// Bind the function to a key (for example, the "L" key)
mp.keys.bind(76, false, function() { // 76 is the key code for "L"
checkRingtoneStatus(); // Call the function to check ringtone status
});
</syntaxhighlight>
}}

==See also==
{{Audio_functions_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Audio::playPedRingtone

2024-10-06T20:35:52Z

Caballero:

{{ClientsideJsFunction}}
{{JSContainer|

===Required Params===
*'''ringtoneName:''' {{RageType|string}} — The name of the ringtone to be played.
*'''ped:''' {{RageType|number}} — The ID of the pedestrian (player character) who will hear the ringtone.
*'''p2:''' {{RageType|boolean}} — A boolean value indicating whether to repeat the ringtone.

===Return value===
*'''void''' — This function does not return a value.

==Syntax==
<syntaxhighlight lang="javascript">
// Function to play a ringtone for the player
function playRingtoneForPlayer() {
let ringtoneName = 'Remote_Ring'; // Ringtone name to be played
let player = mp.players.local; // Reference to the local player

// Play the ringtone for the player
mp.game.audio.playPedRingtone(ringtoneName, player.handle, true);

// Notify the player that the ringtone is playing
mp.gui.chat.push("Playing ringtone: " + ringtoneName);
}

// Bind the function to a key (for example, the "E" key)
mp.keys.bind(69, false, function() { // 69 is the key code for "E"
playRingtoneForPlayer(); // Call the function to play the ringtone
});
</syntaxhighlight>
}}

===Available Ringtones===
* '''Remote_Ring'''
* '''Dial_and_Remote_Ring'''
* '''Dial_Up_Ring'''
* '''Dial_Tone_Ring'''
* '''Remote_Ring_Low'''
* '''Remote_Ring_High'''
* '''Dial_Music_Ring'''
* '''Remote_Alarm_Ring'''
* '''Remote_Alarm_Alert'''
* '''Remote_Notification_Ring'''

==See also==
{{Audio_functions_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Audio::setRadioToStationName

2024-10-06T20:34:28Z

Caballero:

{{ClientsideJsFunction}}
{{JSContainer|

===Required Params===
*'''stationName:''' {{RageType|string}} — The name of the radio station to set.

===Return value===
*'''void''' — This function does not return a value.

==Syntax==
<syntaxhighlight lang="javascript">
// Function to set the radio station
function setRadioStation(stationName) {
// Check if the player is in a vehicle
let player = mp.players.local; // Reference to the local player
if (player.vehicle) { // Check if the player is in a vehicle
// Set the radio to the specified station
mp.game.audio.setRadioToStationName(stationName);

// Notify the player that the radio station has been changed
mp.gui.chat.push("Radio station set to: " + stationName);
} else {
// Notify the player that they need to be in a vehicle to change the radio
mp.gui.chat.push("You must be in a vehicle to change the radio station.");
}
}

// Bind the function to a key (for example, the "E" key)
mp.keys.bind(69, false, function() { // 69 is the key code for "E"
let stationName = "RADIO_01_CLASS_ROCK"; // Replace with the desired radio station name
setRadioStation(stationName); // Call the function to change the radio station
});
</syntaxhighlight>
}}

== List of GTA 5 Radio Stations ==
* '''RADIO_01_LOS_SANTOS'''
* '''RADIO_02_LODOWN'''
* '''RADIO_03_ROCK'''
* '''RADIO_04_PUNK'''
* '''RADIO_05_TALK_01'''
* '''RADIO_06_CLASSIC'''
* '''RADIO_07_REBEL'''
* '''RADIO_08_SOULWAX'''
* '''RADIO_09_EAST_LA'''
* '''RADIO_10_WORLDWIDE'''
* '''RADIO_11_FLYLO'''
* '''RADIO_12_THELAB'''
* '''RADIO_13_SELF'''
* '''RADIO_14_IFRUIT'''
* '''RADIO_15_MIRRORPARK'''
* '''RADIO_16_NOSTALGIA'''
* '''RADIO_17_SPORTS'''
* '''RADIO_18_CLASSICS'''
* '''RADIO_19_WINNERS'''
* '''RADIO_20_RNB'''

==See also==
{{Audio_functions_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Audio::setRadioToStationName

2024-10-06T20:28:52Z

Caballero:

{{ClientsideJsFunction}}
{{JSContainer|

===Required Params===
*'''stationName:''' {{RageType|string}} — The name of the radio station to set.

===Return value===
*'''void''' — This function does not return a value.

==Syntax==
<syntaxhighlight lang="javascript">
// Function to set the radio station
function setRadioStation(stationName) {
// Check if the player is in a vehicle
let player = mp.players.local; // Reference to the local player
if (player.vehicle) { // Check if the player is in a vehicle
// Set the radio to the specified station
mp.game.audio.setRadioToStationName(stationName);

// Notify the player that the radio station has been changed
mp.gui.chat.push("Radio station set to: " + stationName);
} else {
// Notify the player that they need to be in a vehicle to change the radio
mp.gui.chat.push("You must be in a vehicle to change the radio station.");
}
}

// Bind the function to a key (for example, the "R" key)
mp.keys.bind(82, false, function() { // 82 is the key code for "R"
let stationName = "RADIO_01_CLASS_ROCK"; // Replace with the desired radio station name
setRadioStation(stationName); // Call the function to change the radio station
});
</syntaxhighlight>
}}

== List of GTA 5 Radio Stations ==
* '''RADIO_01_LOS_SANTOS'''
* '''RADIO_02_LODOWN'''
* '''RADIO_03_ROCK'''
* '''RADIO_04_PUNK'''
* '''RADIO_05_TALK_01'''
* '''RADIO_06_CLASSIC'''
* '''RADIO_07_REBEL'''
* '''RADIO_08_SOULWAX'''
* '''RADIO_09_EAST_LA'''
* '''RADIO_10_WORLDWIDE'''
* '''RADIO_11_FLYLO'''
* '''RADIO_12_THELAB'''
* '''RADIO_13_SELF'''
* '''RADIO_14_IFRUIT'''
* '''RADIO_15_MIRRORPARK'''
* '''RADIO_16_NOSTALGIA'''
* '''RADIO_17_SPORTS'''
* '''RADIO_18_CLASSICS'''
* '''RADIO_19_WINNERS'''
* '''RADIO_20_RNB'''

==See also==
{{Audio_functions_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]