RAGE Multiplayer Wiki - User contributions [en]

Vehicle::setSirenSound

2020-03-16T10:58:23Z

Katalam: Created page with "Activate siren sound on vehicle (Only works if the vehicle has a siren). ==Syntax== <syntaxhighlight lang="javascript">vehicle.setSirenSound(toggle);</syntaxhighlight> === Re..."

Activate siren sound on vehicle (Only works if the vehicle has a siren).

==Syntax==
<syntaxhighlight lang="javascript">vehicle.setSirenSound(toggle);</syntaxhighlight>
=== Required Arguments ===
*'''toggle:''' Boolean
===Return value===
*'''Undefined'''

==Example==
<syntaxhighlight lang="javascript">
mp.players.local.vehicle.setSirenSound(true)
</syntaxhighlight>
Make sure you use true for silence.

PlayerJoin

2020-02-29T16:30:38Z

Katalam: Fixed server side chat error and changed example to console.log

This event is triggered when a player '''joins''' the server.

{{ServersideJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerConnected on GTA Network Wiki].
}}

{{Parameters}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - The player who joined.

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add('playerJoin', (player) => {
console.log(`[SERVER]: ${player.name} has joined the server!`);
});
</syntaxhighlight>
}}

{{ClientsideCsJsEvent}}
This event is '''not''' called for the '''local player''' who joined the server.

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerJoinDelegate(Player player);
</syntaxhighlight>

{{Parameters}}
* '''player''': The player joining the server, expects '''RAGE.Elements.Player''' type.

{{Example}}
The example below shows up a message to the client when another player joins the server.

<syntaxhighlight lang="csharp">
Events.OnPlayerJoin += OnPlayerJoin;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerJoin(RAGE.Elements.Player player)
{
RAGE.Chat.Output($"Player {player.Name} has joined");
}
</syntaxhighlight>
}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - Another player who joined the server.

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("playerJoin", (player) => {
mp.gui.chat.push(`${player.name} has joined the server!`);
});
</syntaxhighlight>
}}

==See also==
{{Player_events}}

[[Category:Player]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

Vehicle::locked

2020-01-27T13:26:38Z

Katalam: Doubled negation

This property used for lock/unlock vehicle. Players can't seat to locked vehicles, bikes too.

<syntaxhighlight lang="javascript">
Boolean vehicle.lock;
</syntaxhighlight>

==Example==
That's example will lock your vehicle, when you use command.

<syntaxhighlight lang="javascript">
mp.events.addCommand(`doors`,
(player) => {
let vehicle = player.vehicle;
if (vehicle) {
let newState = !vehicle.locked;
vehicle.locked = newState;
player.outputChatBox(`Your vehicle doors now ${newState ? `closed` : `opened`}`);
};
}
);
</syntaxhighlight>

==See Also==
{{Vehicle_block}}

Audio::playSoundFromEntity

2020-01-27T12:33:03Z

Katalam: Fixed bracket error

All found occurrences in b617d, sorted alphabetically and identical lines removed: pastebin.com/f2A7vTj0 No changes made in b678d. gtaforums.com/topic/795622-audio-for-mods 
==Syntax==
<syntaxhighlight lang="javascript">mp.game.audio.playSoundFromEntity(soundId, audioName, entity, audioRef, p4, p5);</syntaxhighlight>
=== Required Arguments ===
*'''soundId:''' int
*'''audioName:''' String
*'''entity:''' Entity handle or object
*'''audioRef:''' String
*'''p4:''' Boolean
*'''p5:''' unknown (to be checked)
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
function playerEnterVehicleHandler(vehicle) {
mp.game.audio.playSoundFromEntity(1, "CONFIRM_BEEP", vehicle.handle, "HUD_MINI_GAME_SOUNDSET", true, 0);
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</syntaxhighlight>

==See also==
{{Audio_s_function_c}}
[[Category:Clientside API]]