RAGE Multiplayer Wiki - User contributions [en]

Vehicle::getPedInSeat

2018-10-19T22:52:11Z

Menof36go:

-1 (driver) <= index < GET_VEHICLE_MAX_NUMBER_OF_PASSENGERS(vehicle)

'''If a player enters the driver seat from the passenger side, getPedInSeat(-1) will return 0 until the player actually reaches the seat.'''
==Syntax==
<syntaxhighlight lang="javascript">vehicle.getPedInSeat(index);</syntaxhighlight>
=== Required Arguments ===
*'''index:''' int
===Return value===
*'''Ped handle or object'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::getPedInSeat

2018-10-19T22:51:57Z

Menof36go: Added some info

-1 (driver) <= index < GET_VEHICLE_MAX_NUMBER_OF_PASSENGERS(vehicle)
'''If a player enters the driver seat from the passenger side, getPedInSeat(-1) will return 0 until the player actually reaches the seat.'''
==Syntax==
<syntaxhighlight lang="javascript">vehicle.getPedInSeat(index);</syntaxhighlight>
=== Required Arguments ===
*'''index:''' int
===Return value===
*'''Ped handle or object'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Audio::playSoundFromEntity

2018-10-18T22:25:11Z

Menof36go:

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]]

Vehicle::getDisplayNameFromVehicleModel

2018-10-18T22:24:57Z

Menof36go:

Returns model name of vehicle in all caps. Needs to be displayed through localizing text natives to get proper display name. ----------------------------------------------------------------------------------------------------------------------------------------- While often the case, this does not simply return the model name of the vehicle (which could be hashed to return the model hash). Variations of the same vehicle may also use the same display name. ----------------------------------------------------------------------------------------------------------------------------------------- Returns 'CARNOTFOUND' if the hash doesn't match a vehicle hash. Using UI::_GET_LABEL_TEXT, you can get the localized name. For a full list, see here: pastebin.com/wvpyS4kS (pastebin.com/dA3TbkZw) 
==Syntax==
<syntaxhighlight lang="javascript">mp.game.vehicle.getDisplayNameFromVehicleModel(modelHash);</syntaxhighlight>
=== Required Arguments ===
*'''modelHash:''' Model hash or name
===Return value===
*'''String'''
==Example==
<syntaxhighlight lang="javascript">
function playerEnterVehicleHandler(vehicle) {{
var vehicleName = mp.game.ui.getLabelText(mp.game.vehicle.getDisplayNameFromVehicleModel(vehicle.model));
mp.gui.chat.push(`Name of your vehicle: ${vehicleName}`);
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</syntaxhighlight>
==See also==
{{Vehicle_s_function_c}}
[[Category:Clientside API]]

Audio::playSoundFromEntity

2018-10-18T22:24:19Z

Menof36go: Added example

Vehicle::getDisplayNameFromVehicleModel

2018-10-18T22:22:12Z

Menof36go: Added example

Ui::getLabelText

2018-10-18T22:21:33Z

Menof36go:

Gets a string literal from a label name.
==Syntax==
<syntaxhighlight lang="javascript">mp.game.ui.getLabelText(labelName);</syntaxhighlight>
=== Required Arguments ===
*'''labelName:''' String
===Return value===
*'''String'''
==Example==
<syntaxhighlight lang="javascript">
function playerEnterVehicleHandler(vehicle) {{
var vehicleName = mp.game.ui.getLabelText(mp.game.vehicle.getDisplayNameFromVehicleModel(vehicle.model));
mp.gui.chat.push(`Name of your vehicle: ${vehicleName}`);
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</syntaxhighlight>
==See also==
{{Ui_s_function_c}}
[[Category:Clientside API]]
[[Category:UI API]]
[[Category:TODO: Example]]

PlayerEnterVehicle

2018-10-18T22:20:49Z

Menof36go: var

This event is triggered when a player is in the car.
'''As of now PlayerEnterVehicle is actually PlayerStartEnterVehicle and is triggered twice when entering a vehicle!'''

==Parameters==
* '''player''' - player, which sits down (serverside only).
* '''vehicle''' - vehicle in which the player sits.
* '''seat''' - the place where he sits down. (Currently undefined clientside, use Player::getSeatIsTryingToEnter instead)

==Example==
This example outputs chat message, when player is in the car.
{{ServerSide}}
<syntaxhighlight lang="javascript">
function playerEnterVehicleHandler(player, vehicle, seat) {
const playerName = player.name;
const vehicleID = vehicle.id;

mp.players.broadcast(`${playerName} got into the car with ID: ${vehicleID}. Seat: ${seat}`);
}

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

{{ClientSide}}
<syntaxhighlight lang="javascript">
// The player is not emmited client-side assuming it's you
function playerEnterVehicleHandler(vehicle) {
var seat = mp.players.local.getSeatIsTryingToEnter(); //Workaround since seat is currently undefined
mp.gui.chat.push(`You got into the car with ID: ${vehicle.id}. Seat: ${seat}`);
}

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

==See also==
{{Player_events}}

Ui::getLabelText

2018-10-18T22:13:28Z

Menof36go:

Gets a string literal from a label name.
==Syntax==
<syntaxhighlight lang="javascript">mp.game.ui.getLabelText(labelName);</syntaxhighlight>
=== Required Arguments ===
*'''labelName:''' String
===Return value===
*'''String'''
==Example==
<syntaxhighlight lang="javascript">
function playerEnterVehicleHandler(vehicle, seat) {{
var vehicleName = mp.game.ui.getLabelText(mp.game.vehicle.getDisplayNameFromVehicleModel(vehicle.model));
mp.gui.chat.push(`Name of your vehicle: ${vehicleName}`);
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</syntaxhighlight>
==See also==
{{Ui_s_function_c}}
[[Category:Clientside API]]
[[Category:UI API]]
[[Category:TODO: Example]]