Skip to content

Commit c9d17fb

Browse files
committed
Implemented Vector3.setTo() (alias for set()).
Fixed some documentation mistakes. Removed appropriate TODO.
1 parent d816343 commit c9d17fb

1 file changed

Lines changed: 20 additions & 5 deletions

File tree

src/math/Vector3.js

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,6 @@ var Vector3 = new Class({
172172
/**
173173
* Set the `x`, `y`, and `z` components of this Vector to the given `x`, `y`, and `z` values.
174174
*
175-
* TODO: setTo() alias.
176-
*
177175
* @method Phaser.Math.Vector3#set
178176
* @since 3.0.0
179177
*
@@ -201,6 +199,23 @@ var Vector3 = new Class({
201199
return this;
202200
},
203201

202+
/**
203+
* This method is an alias for `Vector3.set`.
204+
*
205+
* @method Phaser.Math.Vector3#setTo
206+
* @since 3.next
207+
*
208+
* @param {number} x - The x value to set for this Vector.
209+
* @param {number} [y] - The y value to set for this Vector.
210+
* @param {number} [z] - The z value to set for this Vector.
211+
*
212+
* @return {Phaser.Math.Vector3} This Vector3.
213+
*/
214+
setTo: function (x, y, z)
215+
{
216+
return this.set(x, y, z);
217+
},
218+
204219
/**
205220
* Add a given Vector to this Vector. Addition is component-wise.
206221
*
@@ -351,7 +366,7 @@ var Vector3 = new Class({
351366
* @method Phaser.Math.Vector3#distanceSq
352367
* @since 3.0.0
353368
*
354-
* @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - [description]
369+
* @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to calculate the distance to.
355370
*
356371
* @return {number} The distance between this Vector, and the given Vector, squared.
357372
*/
@@ -500,7 +515,7 @@ var Vector3 = new Class({
500515
* @method Phaser.Math.Vector3#transformMat3
501516
* @since 3.0.0
502517
*
503-
* @param {Phaser.Math.Matrix3} mat - The Matrix3 to transform this Vector2 with.
518+
* @param {Phaser.Math.Matrix3} mat - The Matrix3 to transform this Vector3 with.
504519
*
505520
* @return {Phaser.Math.Vector3} This Vector3.
506521
*/
@@ -524,7 +539,7 @@ var Vector3 = new Class({
524539
* @method Phaser.Math.Vector3#transformMat4
525540
* @since 3.0.0
526541
*
527-
* @param {Phaser.Math.Matrix4} mat - The Matrix4 to transform this Vector2 with.
542+
* @param {Phaser.Math.Matrix4} mat - The Matrix4 to transform this Vector3 with.
528543
*
529544
* @return {Phaser.Math.Vector3} This Vector3.
530545
*/

0 commit comments

Comments
 (0)