RAGE Multiplayer Wiki - User contributions [en]

Events::callRemoteProc

2020-12-06T09:19:36Z

NoBrain:

This function calls a previously registered event on the server using [[Events::addProc|mp.events.addProc(String eventName [, ...args])]].

Эта функция вызывает ранее зарегистрированное событие на сервере с помощью [[Events::addProc|mp.events.addProc(String eventName [, ...args])]].

==Syntax==
<pre>
mp.events.callRemoteProc(String eventName [, ...args])
</pre>

==Example==
In this example, we will send an RPC request from the client to the server in which we will transmit the number 1. We will wait for the response and process it.
On the server, if number is 1, return true, otherwise false.
P.S. Note that await can only be used in an async function.

В данном примере мы отправим RPC запрос с клиента на сервер в котором передадим число 1. Дождёмся ответа и обработаем его.
На сервере, если number равен 1 вернём true, в остальных случаях false.
P.S. Обратите внимание, что использовать await можно лишь в async функции.

{{ClientsideCode|
<pre>
const number = 1;
const response = await mp.events.callRemoteProc("testEvent", number);
if (response.result === true) mp.console.logInfo("Result is true", true, true);
</pre>
}}

{{ServersideCode|
<pre>
//player object is always the first param and it's the player who requested this RPC
mp.events.addProc("testEvent", (player, number) => {
return {
result: number === 1 ? true : false
};
});
</pre>
}}

==See Also==
{{Event_functions}}

Clientside JS Snippets

2020-12-02T19:43:17Z

NoBrain:

= Client-side Javascript - Helpful Code Snippets/Examples =
=== These should not be limited to one existing function. If they are, simply propose the edit on the function as an example ===

'''Rotate Recentangle'''
The rotate rectangle allows you to get the Vehicle size and rotate it to get the correct X and Y from the Game.

<pre>
rotateRect(angle, ox, oy, x, y, w, h) {
const xAx = Math.cos(angle); // x axis x
const xAy = Math.sin(angle); // x axis y
x -= ox; // move rectangle onto origin
y -= oy;
return [[ // return array holding the resulting points
x * xAx - y * xAy + ox, // Get the top left rotated position
x * xAy + y * xAx + oy, // and move it back to the origin
], [
(x + w) * xAx - y * xAy + ox, // Get the top right rotated position
(x + w) * xAy + y * xAx + oy,
], [
(x + w) * xAx - (y + h) * xAy + ox, // Get the bottom right rotated position
(x + w) * xAy + (y + h) * xAx + oy,
], [
x * xAx - (y + h) * xAy + ox, // Get the bottom left rotated position
x * xAy + (y + h) * xAx + oy,
]
];
}</pre>

'''Get Vehicle Layout (Sizings and Location in Game)'''
This function allows you to get the full layout of the vehicle such as front, rear, roof.
<pre>vehicleLayout(Vehicle) {
const sizeofVehicle = mp.game.gameplay.getModelDimensions(Vehicle.model);
const vehicleRotation = Vehicle.getRotation(2);
const Xwidth = (0 - sizeofVehicle.min.x) + (sizeofVehicle.max.x);
const Ywidth = (0 - sizeofVehicle.min.y) + (sizeofVehicle.max.y);
const degree = (vehicleRotation.z + 180) * Math.PI / 180;
const newDegrees = this.rotateRect(degree, Vehicle.position.x, Vehicle.position.y, Vehicle.position.x - sizeofVehicle.max.x, Vehicle.position.y - sizeofVehicle.max.y, Xwidth, Ywidth);
const frontX = newDegrees[0][0] + ((newDegrees[1][0] - newDegrees[0][0]) / 2);
const frontY = newDegrees[0][1] + ((newDegrees[1][1] - newDegrees[0][1]) / 2);
const bottomX = newDegrees[2][0] + ((newDegrees[3][0] - newDegrees[2][0]) / 2);
const bottomY = newDegrees[2][1] + ((newDegrees[3][1] - newDegrees[2][1]) / 2);
return {
front: {x: frontX, y: frontY},
back: {x: bottomX, y: bottomY},
center: {x: Vehicle.position.x, y: Vehicle.position.y},
size: {
lengthX: Xwidth,
lengthY: Ywidth,
min: {x: sizeofVehicle.min.x, y: sizeofVehicle.min.y},
max: {x: sizeofVehicle.max.x, y: sizeofVehicle.max.y},
z: sizeofVehicle.min.z
}
};
}
</pre>

'''Perform async loop in CEF'''
This function will allow you to process large arrays that you have and want to process them inside your html file which using normal ones will block your UI and crash your client
<pre>
/**
* @description perform an async loop in CEF for large arrays to prevent UI block and client crash
* @param array Array you want to do loop on
* @param callback callback containing (item, index, array)
* @param end will be called when the async loop is finished
*/
const asyncLoop = (array, callback, end) => {
// Index which is going to be proccessed
var index = 0;
function doLoop() {

// Check if it's the end of the array
if (index < array.length)
{
callback(array[index], index, array);
++index;
// Do async wait for 1 ms
setTimeout(doLoop, 1);
}
else
{
// calls when the loop is finished
end()
}
}
doLoop();
}
</pre>

'''Disable AFK Cam'''
<pre>
mp.events.add('render', () => {
mp.game.invoke("0xF4F2C0D4EE209E20"); //Invalidate Camera 0xF4F2C0D4EE209E20
})
</pre>

'''Bind and manage player crouch to ctrl button'''
<pre>
var CommonActions_Crouched = false;
mp.keys.bind(0xA2, true, () => {

if(CommonActions_Crouched)
{
ResetPlayerCrouch();
CommonActions_Crouched = false;
}
else
{
SetPlayerCrouch();
CommonActions_Crouched = true;
}

})

function SetPlayerCrouch() {
if (!mp.game.streaming.hasClipSetLoaded('move_ped_crouched'))
{
mp.game.streaming.requestClipSet('move_ped_crouched');
while(!mp.game.streaming.hasClipSetLoaded('move_ped_crouched')) mp.game.wait(0);
}

mp.players.local.setMovementClipset('move_ped_crouched', 0.3);
}

function ResetPlayerCrouch()
{
mp.players.local.resetMovementClipset(0.3);
}
</pre>

'''Custom Wait function'''
useful when you are using shared data and you start using it on player join where the data might not have been synced yet (wait for it to become defined)
usable in async function use with await
<pre>
const GameWait = (variable) => {

return new Promise((resolve, reject) => {
var interval = setInterval(() => {
if(variable != undefined)
{
clearInterval(interval);
resolve(variable)
}
}, 10);
})
}
</pre>

'''Disable street names/car classname etc'''
Must be called inside render
<pre>
mp.game.ui.hideHudComponentThisFrame(6); // car name
mp.game.ui.hideHudComponentThisFrame(8); // car class
mp.game.ui.hideHudComponentThisFrame(7); // area name
mp.game.ui.hideHudComponentThisFrame(9); // street name
</pre>

Clientside JS Snippets

2020-12-02T19:42:56Z

NoBrain:

= Client-side Javascript - Helpful Code Snippets/Examples =
=== These should not be limited to one existing function. If they are, simply propose the edit on the function as an example ===

'''Rotate Recentangle'''
The rotate rectangle allows you to get the Vehicle size and rotate it to get the correct X and Y from the Game.

<pre>
rotateRect(angle, ox, oy, x, y, w, h) {
const xAx = Math.cos(angle); // x axis x
const xAy = Math.sin(angle); // x axis y
x -= ox; // move rectangle onto origin
y -= oy;
return [[ // return array holding the resulting points
x * xAx - y * xAy + ox, // Get the top left rotated position
x * xAy + y * xAx + oy, // and move it back to the origin
], [
(x + w) * xAx - y * xAy + ox, // Get the top right rotated position
(x + w) * xAy + y * xAx + oy,
], [
(x + w) * xAx - (y + h) * xAy + ox, // Get the bottom right rotated position
(x + w) * xAy + (y + h) * xAx + oy,
], [
x * xAx - (y + h) * xAy + ox, // Get the bottom left rotated position
x * xAy + (y + h) * xAx + oy,
]
];
}</pre>

'''Get Vehicle Layout (Sizings and Location in Game)'''
This function allows you to get the full layout of the vehicle such as front, rear, roof.
<pre>vehicleLayout(Vehicle) {
const sizeofVehicle = mp.game.gameplay.getModelDimensions(Vehicle.model);
const vehicleRotation = Vehicle.getRotation(2);
const Xwidth = (0 - sizeofVehicle.min.x) + (sizeofVehicle.max.x);
const Ywidth = (0 - sizeofVehicle.min.y) + (sizeofVehicle.max.y);
const degree = (vehicleRotation.z + 180) * Math.PI / 180;
const newDegrees = this.rotateRect(degree, Vehicle.position.x, Vehicle.position.y, Vehicle.position.x - sizeofVehicle.max.x, Vehicle.position.y - sizeofVehicle.max.y, Xwidth, Ywidth);
const frontX = newDegrees[0][0] + ((newDegrees[1][0] - newDegrees[0][0]) / 2);
const frontY = newDegrees[0][1] + ((newDegrees[1][1] - newDegrees[0][1]) / 2);
const bottomX = newDegrees[2][0] + ((newDegrees[3][0] - newDegrees[2][0]) / 2);
const bottomY = newDegrees[2][1] + ((newDegrees[3][1] - newDegrees[2][1]) / 2);
return {
front: {x: frontX, y: frontY},
back: {x: bottomX, y: bottomY},
center: {x: Vehicle.position.x, y: Vehicle.position.y},
size: {
lengthX: Xwidth,
lengthY: Ywidth,
min: {x: sizeofVehicle.min.x, y: sizeofVehicle.min.y},
max: {x: sizeofVehicle.max.x, y: sizeofVehicle.max.y},
z: sizeofVehicle.min.z
}
};
}
</pre>

'''Perform async loop in CEF'''
This function will allow you to process large arrays that you have and want to process them inside your html file which using normal ones will block your UI and crash your client
<pre>
/**
* @description perform an async loop in CEF for large arrays to prevent UI block and client crash
* @param array Array you want to do loop on
* @param callback callback containing (item, index, array)
* @param end will be called when the async loop is finished
*/
const asyncLoop = (array, callback, end) => {
// Index which is going to be proccessed
var index = 0;
function doLoop() {

// Check if it's the end of the array
if (index < array.length)
{
callback(array[index], index, array);
++index;
// Do async wait for 1 ms
setTimeout(doLoop, 1);
}
else
{
// calls when the loop is finished
end()
}
}
doLoop();
}
</pre>

'''Disable AFK Cam'''
<pre>
mp.events.add('render', () => {
mp.game.invoke("0xF4F2C0D4EE209E20"); //Invalidate Camera 0xF4F2C0D4EE209E20
})
</pre>

'''Bind and manage player crouch to ctrl button'''
<pre>
var CommonActions_Crouched = false;
mp.keys.bind(0xA2, true, () => {

if(CommonActions_Crouched)
{
ResetPlayerCrouch();
CommonActions_Crouched = false;
}
else
{
SetPlayerCrouch();
CommonActions_Crouched = true;
}

})

function SetPlayerCrouch() {
if (!mp.game.streaming.hasClipSetLoaded('move_ped_crouched'))
{
mp.game.streaming.requestClipSet('move_ped_crouched');
while(!mp.game.streaming.hasClipSetLoaded('move_ped_crouched')) mp.game.wait(0);
}

mp.players.local.setMovementClipset('move_ped_crouched', 0.3);
}

function ResetPlayerCrouch()
{
mp.players.local.resetMovementClipset(0.3);
}
</pre>

'''Custom Wait function'''
useful when you are using shared data and you start using it on player join where the data might not have been synced yet (wait for it to become defined)
usable in async function use with await
<pre>
const GameWait = (variable) => {

return new Promise((resolve, reject) => {
var interval = setInterval(() => {
if(variable != undefined)
{
clearInterval(interval);
resolve(variable)
}
}, 10);
})
}
</pre>

'''Disable street names/car classname etc'''
Must be called inside render
usable in async function use with await
<pre>
mp.game.ui.hideHudComponentThisFrame(6); // car name
mp.game.ui.hideHudComponentThisFrame(8); // car class
mp.game.ui.hideHudComponentThisFrame(7); // area name
mp.game.ui.hideHudComponentThisFrame(9); // street name
</pre>

Clientside JS Snippets

2020-12-01T10:45:42Z

NoBrain:

Clientside JS Snippets

2020-12-01T10:43:15Z

NoBrain:

Player::setStealthMovement

2020-12-01T10:40:32Z

NoBrain:

This function will disable stealth movement ability (ustually ctrl button)

p1 is usually 0 in the scripts. action is either 0 or a pointer to 'DEFAULT_ACTION'.

==Syntax==
<syntaxhighlight lang="javascript">player.setStealthMovement(p1, action);</syntaxhighlight>
=== Required Arguments ===
*'''p1:''' Boolean
*'''action:''' String
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// Disable Stealth Movement
mp.players.local.setStealthMovement(false, '0');
</syntaxhighlight>
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Clientside JS Snippets

2020-12-01T10:31:03Z

NoBrain:

Clientside JS Snippets

2020-12-01T10:27:44Z

NoBrain:

Player::setMovementClipset

2020-10-09T20:16:59Z

NoBrain:

p2 is usually 1.0f EDIT 12/24/16: p2 does absolutely nothing no matter what the value is. - sollaholla
 Edit: p2 is transition to the clipSet, 1.0 means 1 second (tested with crouch clipSet) - '''noBrain'''
==Syntax==
<syntaxhighlight lang="javascript">player.setMovementClipset(clipSet, p2);</syntaxhighlight>
=== Required Arguments ===
*'''clipSet:''' String
*'''p2:''' float
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Player::voiceVolume

2020-10-09T17:36:03Z

NoBrain: Created page with " After voice is unmuted, this function '''sets''' other player's voice volume for the local player * Volume is between ''' 0.0 - 1.0 ''' ==Example== * Using this example we..."

After voice is unmuted, this function '''sets''' other player's voice volume for the local player

* Volume is between ''' 0.0 - 1.0 '''

==Example==
* Using this example we set player volume based on their distant from the local player
<pre>
const local = mp.players.local;
mp.players.forEach(player => {
var PlayerDist = mp.game.gameplay.getDistanceBetweenCoords(local.position.x, local.position.y, local.position.z, player.position.x, player.position.y, player.position.z, true);
if(PlayerDist < 0.5)
{
player.voiceVolume = 1.0;
}
else
{
player.voiceVolume = 0.5;
}
})
</pre>

Player::taskPlayAnim

2020-10-09T17:27:33Z

NoBrain:

__TOC__

Plays an animation on the targetted ped.

CLIENTSIDE: You must always preload the dictionary (use [https://wiki.rage.mp/index.php?title=Streaming::requestAnimDict Streaming::requestAnimDict] to preload an animation), serverside will have some loaded but not all.

==Arguments==

*'''[[Animations|Animations Dictionary]]'''

'''Speed''':
*Normal speed is
<pre>8.0f</pre>

'''Speed Multiplier''': Multiply the playback speed

'''Duration''':
*-1 (Default)
* 0 (No Animation at all)
* Small value (Slows the animation)
* Other values (Freezes the player till ms was passed) (No effect if flag is set to be controllable.)

'''Animation Flags ''':
*NORMAL = 0,
*REPEAT = 1,
*STOP_LAST_FRAME = 2,
*UPPERBODY = 16,
*ENABLE_PLAYER_CONTROL = 32,
*CANCELABLE = 128,

*Odd number : loop infinitely
*Even number : Freeze at last frame
*Multiple of 4: Freeze at last frame but controllable
*01 to 15 : Full body
*10 to 31 : Upper body
*32 to 47 : Full body > Controllable
*48 to 63 : Upper body > Controllable
*001 to 255 : Normal
*256 to 511 : Garbled

'''Note:'''
* You can sum flags together to works for example if you want an upper body controllable animation with last frame you just do 48+2 which is flag 50 (Correct me if i'm wrong)

'''PlaybackRate''':

*values are between 0.0 and 1.0

==Syntax==
<pre>player.taskPlayAnim(animDictionary, animationName, blendInSpeed, blendOutSpeed, duration, flag, playbackRate, lockX, lockY, lockZ);</pre>
=== Required Arguments ===
*'''animDictionary:''' String
*'''animationName:''' String
*'''blendInSpeed:''' float
*'''blendOutSpeed:''' float
*'''duration:''' int
*'''flag:''' int
*'''playbackRate:''' float
*'''lockX:''' Boolean
*'''lockY:''' Boolean
*'''lockZ:''' Boolean
===Return value===
*'''Undefined'''

==Example==
The example below preloads an animation and applies it into the local player.
<pre>
mp.game.streaming.requestAnimDict("random@shop_robbery");//preload the animation
mp.players.local.taskPlayAnim("random@shop_robbery", "robbery_action_f", 8.0, 1.0, -1, 1, 1.0, false, false, false);
</pre>

==See also==
*'''[[Animations|Animations Dictionary]]'''
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Gui.takeScreenshot

2020-10-09T08:23:49Z

NoBrain: /* Screenshot to Base64 To Save */

Takes screenshot of game screen and puts at /screenshots/ip_port folder. Accessible in CEF via screenshots:// scheme. (Will be available in 0.4)

Edit: You can also use '''http://screenshots/name.png''' as a fetcher for your screen shot in CEF

==Syntax==
<syntaxhighlight lang="javascript">gui.takeScreenshot(name, type, quality, compQuality);</syntaxhighlight>
=== Required Arguments ===
*'''name:''' String
*'''type:''' Type of screenshot (0 - JPG, 1 - PNG, 2 - BMP)
*'''quality:''' Quality (0 - 100)
*'''compressionQuality:''' Compression quality (0 - 100)
==Example==
<syntaxhighlight lang="javascript">
mp.gui.takeScreenshot("random.png", 1, 100, 0);
</syntaxhighlight>

==Screenshot to Base64==
Use this code in CEF to get your image as base64 code and transfer it to server-side to save for future usage
*'''URL must be http based format as i mentioned above'''
<syntaxhighlight lang="javascript">
function toDataUrl(url, callback) {

var xhr = new XMLHttpRequest();
xhr.onload = function() {
var reader = new FileReader();
reader.onloadend = function() {
callback(reader.result);
}
reader.readAsDataURL(xhr.response);
};

xhr.open('GET', url);
xhr.responseType = 'blob';
xhr.send();
}

</syntaxhighlight>

*Usage:
<syntaxhighlight lang="javascript">
toDataUrl(url, (dataURL) => {
alert(`DataURL IS: ${dataURL}`)
})
</syntaxhighlight>

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

Gui.takeScreenshot

2020-10-09T08:20:01Z

NoBrain:

Takes screenshot of game screen and puts at /screenshots/ip_port folder. Accessible in CEF via screenshots:// scheme. (Will be available in 0.4)

Edit: You can also use '''http://screenshots/name.png''' as a fetcher for your screen shot in CEF

==Syntax==
<syntaxhighlight lang="javascript">gui.takeScreenshot(name, type, quality, compQuality);</syntaxhighlight>
=== Required Arguments ===
*'''name:''' String
*'''type:''' Type of screenshot (0 - JPG, 1 - PNG, 2 - BMP)
*'''quality:''' Quality (0 - 100)
*'''compressionQuality:''' Compression quality (0 - 100)
==Example==
<syntaxhighlight lang="javascript">
mp.gui.takeScreenshot("random.png", 1, 100, 0);
</syntaxhighlight>

==Screenshot to Base64 To Save==
Use this code in CEF to get your image as base64 code and transfer it to server-side to save for future usage
*'''URL must be http based format as i mentioned above'''
<syntaxhighlight lang="javascript">
function toDataUrl(url, callback) {

var xhr = new XMLHttpRequest();
xhr.onload = function() {
var reader = new FileReader();
reader.onloadend = function() {
callback(reader.result);
}
reader.readAsDataURL(xhr.response);
};

xhr.open('GET', url);
xhr.responseType = 'blob';
xhr.send();
}

</syntaxhighlight>

*Usage:
<syntaxhighlight lang="javascript">
toDataUrl(url, (dataURL) => {
alert(`DataURL IS: ${dataURL}`)
})
</syntaxhighlight>

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

Vehicle::getModSlotName

2020-05-30T11:29:36Z

NoBrain:

Returns the name for the type of vehicle mod(Armour, engine etc) 
Seems like it returns undefined for upgrades (noBrain)
==Syntax==
<syntaxhighlight lang="javascript">vehicle.getModSlotName(modType);</syntaxhighlight>
=== Required Arguments ===
*'''modType:''' int
===Return value===
*'''String'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::setGravity

2020-05-17T14:27:11Z

NoBrain:

if you set this to false the vehicle will no longer move and will not have any gravity (vehicles with parachute will no longer go up when the parachute is open)
==Syntax==
<syntaxhighlight lang="javascript">vehicle.setGravity(toggle);</syntaxhighlight>
=== Required Arguments ===
*'''toggle:''' Boolean
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::setGravity

2020-05-17T14:26:56Z

NoBrain:

if you set this to false the vehicle will no longer move and will be not have any gravity (vehicles with parachute will no longer go up when the parachute is open)
==Syntax==
<syntaxhighlight lang="javascript">vehicle.setGravity(toggle);</syntaxhighlight>
=== Required Arguments ===
*'''toggle:''' Boolean
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::setFixed

2020-05-17T14:24:51Z

NoBrain:

Repairs the vehicle as it says (synced)
==Syntax==
<syntaxhighlight lang="javascript">vehicle.setFixed();</syntaxhighlight>
=== Required Arguments ===
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::setDoorBroken

2020-05-17T14:23:17Z

NoBrain:

doorIndex: 0 = Front Right Door 1 = Front Left Door 2 = Back Right Door 3 = Back Left Door 4 = Hood 5 = Trunk Changed last paramater from CreateDoorObject To NoDoorOnTheFloor because when on false, the door object is created,and not created when on true...the former parameter name was counter intuitive...(by Calderon) Calderon is a moron. On 1.1 DP#1 the object will not be created for your self, it will be created for others though
==Syntax==
<syntaxhighlight lang="javascript">vehicle.setDoorBroken(doorIndex, createDoorObject);</syntaxhighlight>
=== Required Arguments ===
*'''doorIndex:''' int
*'''createDoorObject:''' Boolean
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::setDeformationFixed

2020-05-17T14:21:38Z

NoBrain:

If the vehicle has been hit and it has some deformations this function does some smoothing on vehicle's body
==Syntax==
<syntaxhighlight lang="javascript">vehicle.setDeformationFixed();</syntaxhighlight>
=== Required Arguments ===
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::removeWindow

2020-05-17T14:17:45Z

NoBrain:

windowIndex: 0 = Front Right Window 1 = Front Left Window 2 = Back Right Window 3 = Back Left Window -1 = Front Glass 7 = Behind Glass the missing ones might be sun roof glass or other types of glassess, tried in a regular 4 door vehicle
==Syntax==
<syntaxhighlight lang="javascript">vehicle.removeWindow(windowIndex);</syntaxhighlight>
=== Required Arguments ===
*'''windowIndex:''' int
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Entity::setCoords

2020-05-17T14:13:50Z

NoBrain:

p7 is always 1 in the scripts. Set to 1, an area around the destination coords for the moved entity is cleared from other entities. Often ends with 1, 0, 0, 1); in the scripts. It works. Axis - Invert Axis Flags
==Syntax==
<syntaxhighlight lang="javascript">entity.setCoords(xPos, yPos, zPos, xAxis, yAxis, zAxis, clearArea);</syntaxhighlight>
=== Required Arguments ===
*'''xPos:''' float
*'''yPos:''' float
*'''zPos:''' float
*'''xAxis:''' Boolean
*'''yAxis:''' Boolean
*'''zAxis:''' Boolean
*'''clearArea:''' Boolean
===Return value===
*'''Undefined'''
==Example==
{{ClientsideCode|
<pre>
//Set your ped off in to the sky
mp.players.local.setCoords(mp.players.local.getCoords(true).x, mp.players.local.getCoords(true).y, mp.players.local.getCoords(true).z + 500.0, true, false, false, false);
</pre>
}}
==See also==
{{Entity_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Entity::setHeading

2020-05-17T14:10:56Z

NoBrain:

Set heading of your entity in degrees
min 0.0 - max 360.0
==Syntax==
<syntaxhighlight lang="javascript">entity.setHeading(heading);</syntaxhighlight>
=== Required Arguments ===
*'''heading:''' float
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Entity_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Blip::setRoute

2020-05-17T14:06:55Z

NoBrain:

Enable / disable showing route for the Blip-object.
==Syntax==
<syntaxhighlight lang="javascript">blip.setRoute(enabled);</syntaxhighlight>
=== Required Arguments ===
*'''enabled:''' Boolean
===Return value===
*'''Undefined'''
==Example==
{{ClientsideCode|
<pre>
var policeStation = mp.blips.new(526, new mp.Vector3(433.25567626953125,-981.8964233398438, 30.710012435913086),
{
color: 5,
shortRange: false,
dimension: mp.players.local.dimension
});

policeStation.setRoute(true) // SetRoute for police station
</pre>
}}
==See also==
{{Blip_s_function_c}}
[[Category:Clientside API]]
[[Category:Blip API]]
[[Category:TODO: Example]]

Entity::getModel

2020-05-17T11:03:00Z

NoBrain:

Returns the model hash from the entity
==Syntax==
<syntaxhighlight lang="javascript">entity.getModel();</syntaxhighlight>
=== Required Arguments ===
===Return value===
*'''Model hash or name'''
==Example==
{{ClientsideCode|
<pre>
mp.events.add('render', () => {

//Get first spawned vehicle
var vehicleObject = mp.vehicles.atRemoteId(0);
//Check if the object is valid
if(vehicleObject)
{
//Get vehicle distant and if under 4 show the model name
var vehicleDistant = LastVehicleDistant = mp.game.gameplay.getDistanceBetweenCoords(mp.players.local.position.x, mp.players.local.position.y, mp.players.local.position.z, vehicleObject.position.x, vehicleObject.position.y, vehicleObject.position.z, false);
if(vehicleDistant < 4.0)
{
//Display it's name
var vehicleModel = vehicleObject.getModel(); // this is same as vehicle.model
mp.game.graphics.drawText(`Interact With ~b~[${mp.game.vehicle.getDisplayNameFromVehicleModel(vehicleModel)}]`, [vehicleObject.position.x, vehicleObject.position.y, vehicleObject.position.z], {
font: 0,
scale: [0.4, 0.4],
color: [255, 255, 255, 185],
outline: false
});
}
}

})
</pre>
}}
==See also==
{{Entity_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Player::taskPlaneLand

2020-05-17T10:54:18Z

NoBrain:

Function.Call(Hash.TASK_PLANE_LAND, pilot, selectedAirplane, runwayStartPoint.X, runwayStartPoint.Y, runwayStartPoint.Z, runwayEndPoint.X, runwayEndPoint.Y, runwayEndPoint.Z);

Using this you can task the ped to land (This will only task the ped to land the plane if already in air)
You need to turn the engines on manually because the ped will not
==Syntax==
<syntaxhighlight lang="javascript">player.taskPlaneLand(plane, runwayStartX, runwayStartY, runwayStartZ, runwayEndX, runwayEndY, runwayEndZ);</syntaxhighlight>
=== Required Arguments ===
*'''plane:''' Vehicle handle or object
*'''runwayStartX:''' float
*'''runwayStartY:''' float
*'''runwayStartZ:''' float
*'''runwayEndX:''' float
*'''runwayEndY:''' float
*'''runwayEndZ:''' float
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// This will task the ped to land in Sandy Shore airport
Ped.taskPlaneLand(VehicleOfPed.handle, 1060.688232421875, 3077.2314453125, 40.273826599121094, 1667.779541015625, 3240.7724609375, 39.652400970458984);
</syntaxhighlight>
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Entity::getModel

2020-05-17T10:49:44Z

NoBrain:

Returns the model hash from the entity
==Syntax==
<syntaxhighlight lang="javascript">entity.getModel();</syntaxhighlight>
=== Required Arguments ===
===Return value===
*'''Model hash or name'''
==Example==
<syntaxhighlight lang="javascript">
mp.events.add('render', () => {

//Get first spawned vehicle
var vehicleObject = mp.vehicles.atRemoteId(0);
//Check if the object is valid
if(vehicleObject)
{
//Get vehicle distant and if under 4 show the model name
var vehicleDistant = LastVehicleDistant = mp.game.gameplay.getDistanceBetweenCoords(mp.players.local.position.x, mp.players.local.position.y, mp.players.local.position.z, vehicleObject.position.x, vehicleObject.position.y, vehicleObject.position.z, false);
if(vehicleDistant < 4.0)
{
//Display it's name
var vehicleModel = vehicleObject.getModel(); // this is same as vehicle.model
mp.game.graphics.drawText(`Interact With ~b~[${mp.game.vehicle.getDisplayNameFromVehicleModel(vehicleModel)}]`, [vehicleObject.position.x, vehicleObject.position.y, vehicleObject.position.z], {
font: 0,
scale: [0.4, 0.4],
color: [255, 255, 255, 185],
outline: false
});
}
}

})
</syntaxhighlight>
==See also==
{{Entity_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]