Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-27 07:01:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

Implemented Vector3.setTo() (alias for set()).

Browse source 
Fixed some documentation mistakes. Removed appropriate TODO.
This commit is contained in:
Chris Andrew 2018-05-23 12:19:31 +01:00
parent d8163439a1
commit c9d17fb9c7
1 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
src/math/Vector3.js
View file

@ -172,8 +172,6 @@ var Vector3 = new Class({
/** /**
* Set the `x`, `y`, and `z` components of this Vector to the given `x`, `y`, and `z` values. * Set the `x`, `y`, and `z` components of this Vector to the given `x`, `y`, and `z` values.
* *
* TODO: setTo() alias.
*
* @method Phaser.Math.Vector3#set * @method Phaser.Math.Vector3#set
* @since 3.0.0 * @since 3.0.0
* *
@ -201,6 +199,23 @@ var Vector3 = new Class({
return this; return this;
}, },
/**
* This method is an alias for `Vector3.set`.
*
* @method Phaser.Math.Vector3#setTo
* @since 3.next
*
* @param {number} x - The x value to set for this Vector.
* @param {number} [y] - The y value to set for this Vector.
* @param {number} [z] - The z value to set for this Vector.
*
* @return {Phaser.Math.Vector3} This Vector3.
*/
setTo: function (x, y, z)
{
return this.set(x, y, z);
},
/** /**
* Add a given Vector to this Vector. Addition is component-wise. * Add a given Vector to this Vector. Addition is component-wise.
* *
@ -351,7 +366,7 @@ var Vector3 = new Class({
* @method Phaser.Math.Vector3#distanceSq * @method Phaser.Math.Vector3#distanceSq
* @since 3.0.0 * @since 3.0.0
* *
* @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - [description] * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to calculate the distance to.
* *
* @return {number} The distance between this Vector, and the given Vector, squared. * @return {number} The distance between this Vector, and the given Vector, squared.
*/ */
@ -500,7 +515,7 @@ var Vector3 = new Class({
* @method Phaser.Math.Vector3#transformMat3 * @method Phaser.Math.Vector3#transformMat3
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.Math.Matrix3} mat - The Matrix3 to transform this Vector2 with. * @param {Phaser.Math.Matrix3} mat - The Matrix3 to transform this Vector3 with.
* *
* @return {Phaser.Math.Vector3} This Vector3. * @return {Phaser.Math.Vector3} This Vector3.
*/ */
@ -524,7 +539,7 @@ var Vector3 = new Class({
* @method Phaser.Math.Vector3#transformMat4 * @method Phaser.Math.Vector3#transformMat4
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.Math.Matrix4} mat - The Matrix4 to transform this Vector2 with. * @param {Phaser.Math.Matrix4} mat - The Matrix4 to transform this Vector3 with.
* *
* @return {Phaser.Math.Vector3} This Vector3. * @return {Phaser.Math.Vector3} This Vector3.
*/ */