Vector3::subtract: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
No edit summary
 
Line 1: Line 1:
This function is used to subtract a Vector3 from another Vector3.
This function is used to subtract a Vector3 or scalar from another Vector3.


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


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


==Example==  
==Example #1==  
{{ServersideCode|
{{ServersideCode|
<pre>
<pre>
Line 18: Line 19:


const difference = vec1.subtract(vec2); // difference = {x: 40, y: 20, z: 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>
</pre>
}}
}}

Latest revision as of 06:18, 31 May 2019

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

Syntax

vector.subtract(Vector3 otherVec);
vector.subtract(number scalar);

Required Arguments

  • otherVec: Vector3: The vector or scalar to be subtracted from the callee.

Returns

  • Vector3 The difference.

Example #1

Server-Side
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}

Example #2

Server-Side
const vec1 = new mp.Vector3(50, 40, 30);
const scalar = 30;

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

See Also