RAGE Multiplayer Wiki - User contributions [en]

Peds::new

2019-11-10T07:07:19Z

Micaww:

==Syntax==
<syntaxhighlight lang="javascript">mp.peds.new(model, position, heading, dimension);</syntaxhighlight>
=== Required Arguments ===
*'''modelHash:''' Model hash
*'''position:''' Vector3 position
*'''heading:''' float
*'''dimension:''' int
===Return value===
*'''Ped object'''

==Example==
<syntaxhighlight lang="javascript">
let ped = mp.peds.new(
mp.game.joaat('MP_F_Freemode_01'),
new mp.Vector3(100.0, -100.0, 25.0),
270.0,
mp.players.local.dimension
);
</syntaxhighlight>

==Legacy Syntax Variation==

The previous syntax for this function allowed you to specify a "streamedIn" callback. This has been removed in favor of the [[EntityStreamIn]] event, but you can add this polyfill to your client script to enable the previous syntax:

<syntaxhighlight lang="javascript">
mp.peds.newLegacy = (hash, position, heading, streamIn, dimension) => {
let ped = mp.peds.new(hash, position, heading, dimension);
ped.streamInHandler = streamIn;
return ped;
};

mp.events.add("entityStreamIn", entity => {
if (entity.streamInHandler) {
entity.streamInHandler(entity);
}
});
</syntaxhighlight>

===Example===
<syntaxhighlight lang="javascript">
let ped = mp.peds.newLegacy(mp.game.joaat('mp_m_freemode_01'), new mp.Vector3(1000, 100, 10), 0, ped => {
// Called when the ped is streamed in
ped.setAlpha(255);
ped.freezePosition(false);
ped.setInvincible(false);
ped.setProofs(false, false, false, false, false, false, false, false);
}, 0);
</syntaxhighlight>

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

Peds::new

2019-11-10T07:06:36Z

Micaww:

==Syntax==
<syntaxhighlight lang="javascript">mp.peds.new(model, position, heading, dimension);</syntaxhighlight>
=== Required Arguments ===
*'''modelHash:''' Model hash
*'''position:''' Vector3 position
*'''heading:''' float
*'''dimension:''' int
===Return value===
*'''Ped object'''

==Example==
<syntaxhighlight lang="javascript">
let ped = mp.peds.new(
mp.game.joaat('MP_F_Freemode_01'),
new mp.Vector3(100.0, -100.0, 25.0),
270.0,
mp.players.local.dimension
);
</syntaxhighlight>
== ==

==Legacy Syntax Variation==

The previous syntax for this function allowed you to specify a "streamedIn" callback. This has been removed in favor of the [[EntityStreamIn]] event, but you can add this polyfill to your client script to enable the previous syntax:

<syntaxhighlight lang="javascript">
mp.peds.newLegacy = (hash, position, heading, streamIn, dimension) => {
let ped = mp.peds.new(hash, position, heading, dimension);
ped.streamInHandler = streamIn;
return ped;
};

mp.events.add("entityStreamIn", entity => {
if (entity.streamInHandler) {
entity.streamInHandler(entity);
}
});
</syntaxhighlight>

===Example===
<syntaxhighlight lang="javascript">
let ped = mp.peds.newLegacy(mp.game.joaat('mp_m_freemode_01'), new mp.Vector3(1000, 100, 10), 0, ped => {
// Called when the ped is streamed in
ped.setAlpha(255);
ped.freezePosition(false);
ped.setInvincible(false);
ped.setProofs(false, false, false, false, false, false, false, false);
}, 0);
</syntaxhighlight>

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

Controls::isInputDisabled

2019-11-07T20:40:07Z

Micaww: /* Example */

Seems to return true if the input is currently disabled. '_GET_LAST_INPUT_METHOD' didn't seem very accurate, but I've left the original description below. -- index usually 2 returns true if the last input method was made with mouse + keyboard, false if it was made with a gamepad 0, 1 and 2 used in the scripts. 0 is by far the most common of them.
==Syntax==
<syntaxhighlight lang="javascript">mp.game.controls.isInputDisabled(inputGroup);</syntaxhighlight>
=== Required Arguments ===
*'''inputGroup:''' int
===Return value===
*'''Boolean'''
==Example==
<syntaxhighlight lang="javascript">
// test if the player is using a controller vs keyboard/mouse

function isUsingController(){
return !mp.game.controls.isInputDisabled(0);
}
</syntaxhighlight>

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

Vector3::negative

2019-06-18T02:24:57Z

Micaww: /* Returns */

This function returns the opposite of a Vector3 by flipping the sign of each partial.

The same affect can be achieved by multiplying a vector by -1.

==Syntax==
<pre>
vector.negative();
</pre>

== Returns ==
* {{RageType|Vector3Mp}} The opposite vector.

==Example==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(10, 30, 100);
const vec2 = new mp.Vector3(-50, -30, 40);

const opposite1 = vec1.negative(); // { x: -10, y: -30, z: -100 }
const opposite2 = vec2.negative(); // { x: 50, y: 30, z: -40 };
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::dot

2019-05-31T06:53:09Z

Micaww: Created page with "This function is used to calculate the dot product of two vectors. The dot product is a number calculated by multiplying the magnitudes of both vectors together, then multipl..."

This function is used to calculate the dot product of two vectors.

The dot product is a number calculated by multiplying the magnitudes of both vectors together, then multiplying that number by cosine of the angle between them.

For normalized vectors, the dot product will be:
'''-1''' - If the vectors point in the exact opposite direction
'''0''' - If the vectors are perpendicular
'''1''' - If the vectors point the same direction

==Syntax==
<pre>
vector.dot(Vector3 otherVec);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The other vector.

== Returns ==
* {{RageType|number}} The dot product.

==See Also==
{{Vector3_definition}}

Vector3::cross

2019-05-31T06:48:10Z

Micaww: Created page with "This function is used to calculate the cross product of two vectors. The cross product is a vector that is perpendicular to both input vectors. ==Syntax== <pre> vector.add(Ve..."

This function is used to calculate the cross product of two vectors. The cross product is a vector that is perpendicular to both input vectors.

==Syntax==
<pre>
vector.add(Vector3 otherVec);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The other vector.

== Returns ==
* {{RageType|Vector3}} The cross product.

==See Also==
{{Vector3_definition}}

Vector3::toArray

2019-05-31T06:43:16Z

Micaww: Created page with "This function returns an array of the partials of a Vector3. ==Syntax== <pre> vector.toArray(); </pre> == Returns == * {{RageType|number[]}} An array of [x, y, z]. ==Examp..."

This function returns an array of the partials of a Vector3.

==Syntax==
<pre>
vector.toArray();
</pre>

== Returns ==
* {{RageType|number[]}} An array of [x, y, z].

==Example==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(10, 30, 100);

const array = vec1.toArray(); // [10, 30, 100]
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::negative

2019-05-31T06:42:07Z

Micaww: Created page with "This function returns the opposite of a Vector3 by flipping the sign of each partial. The same affect can be achieved by multiplying a vector by -1. ==Syntax== <pre> vector...."

This function returns the opposite of a Vector3 by flipping the sign of each partial.

The same affect can be achieved by multiplying a vector by -1.

==Syntax==
<pre>
vector.negative();
</pre>

== Returns ==
* {{RageType|number}} The opposite vector.

==Example==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(10, 30, 100);
const vec2 = new mp.Vector3(-50, -30, 40);

const opposite1 = vec1.negative(); // { x: -10, y: -30, z: -100 }
const opposite2 = vec2.negative(); // { x: 50, y: 30, z: -40 };
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::max

2019-05-31T06:38:09Z

Micaww:

This function returns the maximum partial of a Vector3.

==Syntax==
<pre>
vector.max();
</pre>

== Returns ==
* {{RageType|number}} The maximum.

==Example==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(10, 30, 100);

const maximum = vec1.max(); // maximum = 100
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::min

2019-05-31T06:38:00Z

Micaww: Created page with "This function returns the minimum partial of a Vector3. ==Syntax== <pre> vector.min(); </pre> == Returns == * {{RageType|number}} The minimum. ==Example== {{ServersideCod..."

This function returns the minimum partial of a Vector3.

==Syntax==
<pre>
vector.min();
</pre>

== Returns ==
* {{RageType|number}} The minimum.

==Example==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(10, 30, 100);

const minimum = vec1.min(); // maximum = 10
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::max

2019-05-31T06:37:34Z

Micaww: Created page with "This function returns the max partial of a Vector3. ==Syntax== <pre> vector.max(); </pre> == Returns == * {{RageType|number}} The maximum. ==Example== {{ServersideCode| <..."

This function returns the max partial of a Vector3.

==Syntax==
<pre>
vector.max();
</pre>

== Returns ==
* {{RageType|number}} The maximum.

==Example==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(10, 30, 100);

const maximum = vec1.max(); // maximum = 100
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::equals

2019-05-31T06:35:16Z

Micaww: Created page with "This function is used to test where two Vector3s equal each other. ==Syntax== <pre> vector.equals(Vector3 otherVec); </pre> ===Required Arguments=== *'''otherVec:''' Vector3..."

This function is used to test where two Vector3s equal each other.

==Syntax==
<pre>
vector.equals(Vector3 otherVec);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The vector to compare to the callee.

== Returns ==
* {{RageType|boolean}} Whether the vectors are equal.

==Example #1==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(5, 5, 5);
const vec2 = new mp.Vector3(5, 5, 5);

vec1.equals(vec2); // true
vec1.equals(new mp.Vector3(0, 0, 0)); // false
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::angleTo

2019-05-31T06:33:16Z

Micaww: Created page with "This function returns the angle (in radians) between two vectors. ==Syntax== <pre> vector.angleTo(Vector3 otherVec); </pre> ===Required Arguments=== *'''otherVec:''' Vector3..."

This function returns the angle (in radians) between two vectors.

==Syntax==
<pre>
vector.angleTo(Vector3 otherVec);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The other vector to calcuate the angle to.

== Returns ==
* {{RageType|number}} The angle in radians.

==See Also==
{{Vector3_definition}}

Vector3::clone

2019-05-31T06:26:49Z

Micaww: Created page with "This function returns a copy of a Vector3. ==Syntax== <pre> vector.clone(); </pre> == Returns == * {{RageType|Vector3}} A new vector with the same values. ==See Also== {{V..."

This function returns a copy of a Vector3.

==Syntax==
<pre>
vector.clone();
</pre>

== Returns ==
* {{RageType|Vector3}} A new vector with the same values.

==See Also==
{{Vector3_definition}}

Template:Vector3 functions

2019-05-31T06:25:06Z

Micaww:

**[[Vector3::Vector3]]
**[[Vector3::add]]
**[[Vector3::angleTo]]
**[[Vector3::clone]]
**[[Vector3::cross]]
**[[Vector3::divide]]
**[[Vector3::dot]]
**[[Vector3::equals]]
**[[Vector3::length]]
**[[Vector3::max]]
**[[Vector3::min]]
**[[Vector3::multiply]]
**[[Vector3::negative]]
**[[Vector3::subtract]]
**[[Vector3::toAngles]]
**[[Vector3::toArray]]
**[[Vector3::unit]]

Vector3::subtract

2019-05-31T06:18:11Z

Micaww:

This function is used to subtract a Vector3 or scalar from another Vector3.

==Syntax==
<pre>
vector.subtract(Vector3 otherVec);
vector.subtract(number scalar);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The vector or scalar to be subtracted from the callee.

== Returns ==
* {{RageType|Vector3}} The difference.

==Example #1==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(50, 40, 30);
const vec2 = new mp.Vector3(10, 20, 15);

const difference = vec1.subtract(vec2); // difference = {x: 40, y: 20, z: 15}
</pre>
}}

==Example #2==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(50, 40, 30);
const scalar = 30;

const difference = vec1.subtract(scalar); // difference = {x: 20, y: 10, z: 0}
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::divide

2019-05-31T06:16:49Z

Micaww:

This function is used to divide a Vector3 by another Vector3 or scalar.

==Syntax==
<pre>
vector.divide(Vector3 otherVec);
vector.divide(number scalar);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The vector or scalar to divide the callee by.

== Returns ==
* {{RageType|Vector3}} The quotient.

==Example #1==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(50, 10, 30);
const vec2 = new mp.Vector3(10, 20, 15);

const quotient = vec1.divide(vec2); // quotient = {x: 5, y: 2, z: 2}
</pre>
}}

==Example #2==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(50, 40, 30);
const scalar = 10;

const quotient = vec1.divide(scalar); // quotient = {x: 5, y: 4, z: 3}
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::add

2019-05-31T06:15:25Z

Micaww:

This function is used to add a Vector3 to another Vector3 or scalar.

==Syntax==
<pre>
vector.add(Vector3 otherVec);
vector.add(number scalar);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3 or number: The vector or scalar to be added to the callee.

== Returns ==
* {{RageType|Vector3}} The sum.

==Example #1==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(10, 30, 100);
const vec2 = new mp.Vector3(40, 20, 60);

const total = vec1.add(vec2); // total = {x: 50, y: 50, z: 160}
</pre>
}}

==Example #2==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(10, 30, 100);
const scalar = 20;

const total = vec1.add(scalar); // total = {x: 30, y: 50, z: 120}
</pre>
}}

==Example #3==
This will throw all players 500 units into the air.
{{ServersideCode|
<pre>
mp.players.forEach(player => {
player.position = player.position.add(new mp.Vector3(0, 0, 500));
});
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::add

2019-05-31T06:15:05Z

Micaww:

This function is used to add a Vector3 to another Vector3 or scalar.

==Syntax==
<pre>
vector.add(Vector3 otherVec);
vector.add(number scalar);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3 or number: The vector or scalar to be added to the callee.

== Returns ==
* {{RageType|Vector3}} The sum.

==Example #1==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(10, 30, 100);
const vec2 = new mp.Vector3(40, 20, 60);

const total = vec1.add(vec2); // total = {x: 50, y: 50, z: 160}
</pre>
}}

==Example #1==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(10, 30, 100);
const scalar = 20;

const total = vec1.add(scalar); // total = {x: 30, y: 50, z: 120}
</pre>
}}

==Example #2==
This will throw all players 500 units into the air.
{{ServersideCode|
<pre>
mp.players.forEach(player => {
player.position = player.position.add(new mp.Vector3(0, 0, 500));
});
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::multiply

2019-05-31T06:13:32Z

Micaww: Created page with "This function is used to multiply a Vector3 by another Vector3 or scalar. ==Syntax== <pre> vector.add(Vector3 otherVec); vector.add(number scalar); </pre> ===Required Argume..."

This function is used to multiply a Vector3 by another Vector3 or scalar.

==Syntax==
<pre>
vector.add(Vector3 otherVec);
vector.add(number scalar);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3 or number: The vector or scalar to be added to the callee.

== Returns ==
* {{RageType|Vector3}} The product.

==Example #1==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(100, 100, 100);
const vec2 = new mp.Vector3(2, 3, 4);

const product = vec1.multiply(vec2); // total = {x: 200, y: 300, z: 400}
</pre>
}}

==Example #2==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(20, 40, 60);
const scalar = 2;

const product = vec1.multiply(scalar); // total = {x: 40, y: 80, z: 120}
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::add

2019-05-31T06:07:09Z

Micaww:

This function is used to add a Vector3 to another Vector3.

==Syntax==
<pre>
vector.add(Vector3 otherVec);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The vector to be added to the callee.

== Returns ==
* {{RageType|Vector3}} The sum.

==Example #1==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(10, 30, 100);
const vec2 = new mp.Vector3(40, 20, 60);

const total = vec1.add(vec2); // total = {x: 50, y: 50, z: 160}
</pre>
}}

==Example #2==
This will throw all players 500 units into the air.
{{ServersideCode|
<pre>
mp.players.forEach(player => {
player.position = player.position.add(new mp.Vector3(0, 0, 500));
});
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::divide

2019-05-31T06:06:51Z

Micaww:

This function is used to divide a Vector3 by another Vector3.

==Syntax==
<pre>
vector.divide(Vector3 otherVec);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The vector to divide the callee by.

== Returns ==
* {{RageType|Vector3}} The quotient.

==Example==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(50, 10, 30);
const vec2 = new mp.Vector3(10, 20, 15);

const quotient = vec1.divide(vec2); // quotient = {x: 5, y: 2, z: 2}
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::divide

2019-05-31T06:06:44Z

Micaww:

This function is used to divide a Vector3 by another Vector3.

==Syntax==
<pre>
vector.divide(Vector3 otherVec);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The vector to divide the callee by.

== Returns ==
* {{RageType|Vector3}} The quotient vector.

==Example==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(50, 10, 30);
const vec2 = new mp.Vector3(10, 20, 15);

const quotient = vec1.divide(vec2); // quotient = {x: 5, y: 2, z: 2}
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::subtract

2019-05-31T06:06:25Z

Micaww:

This function is used to subtract a Vector3 from another Vector3.

==Syntax==
<pre>
vector.subtract(Vector3 otherVec);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The vector to be subtracted from the callee.

== Returns ==
* {{RageType|Vector3}} The difference.

==Example==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(50, 40, 30);
const vec2 = new mp.Vector3(10, 20, 15);

const difference = vec1.subtract(vec2); // difference = {x: 40, y: 20, z: 15}
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::unit

2019-05-31T06:06:07Z

Micaww: Created page with "This function returns a normalized copy of a Vector3- one that has the same direction but with a magnitude of 1. ==Syntax== <pre> vector.unit(); </pre> == Returns == * {{Ra..."

This function returns a normalized copy of a Vector3- one that has the same direction but with a magnitude of 1.

==Syntax==
<pre>
vector.unit();
</pre>

== Returns ==
* {{RageType|Vector3}} The normalized vector.

==See Also==
{{Vector3_definition}}

Vector3::length

2019-05-31T05:58:32Z

Micaww: Created page with "This function returns the magnitude of a Vector3. It's calculated by square rooting the result of '''x * x + y * y + z * z'''. ==Syntax== <pre> vector.length(); </pre> ==..."

This function returns the magnitude of a Vector3.

It's calculated by square rooting the result of '''x * x + y * y + z * z'''.

==Syntax==
<pre>
vector.length();
</pre>

== Returns ==
* {{RageType|number}} The vector's magnitude.

==Example==
This example calculates the distance between two players.
{{ServersideCode|
<pre>
const vec1 = mp.players.at(0).position;
const vec2 = mp.players.at(1).position;

const distance = vec1.subtract(vec2).length();

// distance is the distance between the two players
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::divide

2019-05-31T05:51:13Z

Micaww: Created page with "This function is used to divide a Vector3 by another Vector3. ==Syntax== <pre> vector.divide(Vector3 otherVec); </pre> ===Required Arguments=== *'''otherVec:''' Vector3: The..."

This function is used to divide a Vector3 by another Vector3.

==Syntax==
<pre>
vector.divide(Vector3 otherVec);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The vector to divide the callee by.

==Example==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(50, 10, 30);
const vec2 = new mp.Vector3(10, 20, 15);

const quotient = vec1.divide(vec2); // quotient = {x: 5, y: 2, z: 2}
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::subtract

2019-05-31T05:47:49Z

Micaww:

This function is used to subtract a Vector3 from another Vector3.

==Syntax==
<pre>
vector.subtract(Vector3 otherVec);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The vector to be subtracted from the callee.

==Example==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(50, 40, 30);
const vec2 = new mp.Vector3(10, 20, 15);

const difference = vec1.subtract(vec2); // difference = {x: 40, y: 20, z: 15}
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::subtract

2019-05-31T05:47:40Z

Micaww: Created page with "This function is used to subtract a Vector3 from another Vector3. ==Syntax== <pre> vector.subtract(Vector3 otherVec); </pre> ===Required Arguments=== *'''otherVec:''' Vector..."

This function is used to subtract a Vector3 from another Vector3.

==Syntax==
<pre>
vector.subtract(Vector3 otherVec);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The vector to be subtracted from the callee.

==Example #1==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(50, 40, 30);
const vec2 = new mp.Vector3(10, 20, 15);

const difference = vec1.subtract(vec2); // difference = {x: 40, y: 20, z: 15}
</pre>
}}

==See Also==
{{Vector3_definition}}

Vector3::add

2019-05-31T05:45:43Z

Micaww: Created page with "This function is used to add a Vector3 to another Vector3. ==Syntax== <pre> vector.add(Vector3 otherVec); </pre> ===Required Arguments=== *'''otherVec:''' Vector3: The vecto..."

This function is used to add a Vector3 to another Vector3.

==Syntax==
<pre>
vector.add(Vector3 otherVec);
</pre>
===Required Arguments===
*'''otherVec:''' Vector3: The vector to be added to the callee.

==Example #1==
{{ServersideCode|
<pre>
const vec1 = new mp.Vector3(10, 30, 100);
const vec2 = new mp.Vector3(40, 20, 60);

const total = vec1.add(vec2); // total = {x: 50, y: 50, z: 160}
</pre>
}}

==Example #2==
This will throw all players 500 units into the air.
{{ServersideCode|
<pre>
mp.players.forEach(player => {
player.position = player.position.add(new mp.Vector3(0, 0, 500));
});
</pre>
}}

==See Also==
{{Vector3_definition}}

Player::ip

2019-05-31T05:28:59Z

Micaww:

This property returns the player's IP address.

'''Note: this property is read-only.'''

== Getter ==
* {{RageType|string}} The player's IP Address

== Example ==
{{ServersideCode|
<pre>
const player = mp.players.at(0);

const playerIP = player.ip;
player.outputChatBox("Your IP is: " + playerIP);
</pre>
}}

==See Also==
{{Player_block}}

[[Category:Player API]]
[[Category:Server-side Property]]

Player::hairHighlightColor

2019-05-31T05:26:39Z

Micaww: Created page with "This property returns the player's secondary hair color. '''Note: This property is read-only.''' == Getter == * {{RageType|number}} The player's hair highlight color == Exa..."

This property returns the player's secondary hair color.

'''Note: This property is read-only.'''

== Getter ==
* {{RageType|number}} The player's hair highlight color

== Example ==
{{ServersideCode|
<pre>
const player = mp.players.at(0);

player.setHairColor(5, 3);

const highlightColor = player.hairHighlightColor; // highlightColor is 3
</pre>
}}

==See Also==
{{Player_block}}

[[Category:Player API]]
[[Category:Server-side Property]]

Player::hairColor

2019-05-31T05:25:17Z

Micaww: Created page with "This property returns the player's primary hair color. '''Note: This property is read-only.''' == Getter == * {{RageType|number}} The player's hair color == Example == {{Se..."

This property returns the player's primary hair color.

'''Note: This property is read-only.'''

== Getter ==
* {{RageType|number}} The player's hair color

== Example ==
{{ServersideCode|
<pre>
const player = mp.players.at(0);

player.setHairColor(5, 0);

const hairColor = player.hairColor; // hairColor is 5
</pre>
}}

==See Also==
{{Player_block}}

[[Category:Player API]]
[[Category:Server-side Property]]