Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2025-02-17 06:28:30 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated method names

Browse source
This commit is contained in:
Richard Davey 2018-05-23 23:09:31 +01:00
parent 182015bdbc
commit 30678b44ff
6 changed files with 78 additions and 79 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
src/curves/CubicBezierCurve.js
View file

@ -47,7 +47,7 @@ var CubicBezierCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.CubicBezierCurve#p0
* @name Phaser.Curves.CubicBezier#p0
* @type {Phaser.Math.Vector2}
* @since 3.0.0
*/
@ -56,7 +56,7 @@ var CubicBezierCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.CubicBezierCurve#p1
* @name Phaser.Curves.CubicBezier#p1
* @type {Phaser.Math.Vector2}
* @since 3.0.0
*/
@ -65,7 +65,7 @@ var CubicBezierCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.CubicBezierCurve#p2
* @name Phaser.Curves.CubicBezier#p2
* @type {Phaser.Math.Vector2}
* @since 3.0.0
*/
@ -74,7 +74,7 @@ var CubicBezierCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.CubicBezierCurve#p3
* @name Phaser.Curves.CubicBezier#p3
* @type {Phaser.Math.Vector2}
* @since 3.0.0
*/
@ -84,7 +84,7 @@ var CubicBezierCurve = new Class({
/**
* Gets the starting point on the curve.
*
* @method Phaser.Curves.CubicBezierCurve#getStartPoint
* @method Phaser.Curves.CubicBezier#getStartPoint
* @since 3.0.0
*
* @generic {Phaser.Math.Vector2} O - [out,$return]
@ -103,7 +103,7 @@ var CubicBezierCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.CubicBezierCurve#getResolution
* @method Phaser.Curves.CubicBezier#getResolution
* @since 3.0.0
*
* @param {number} divisions - The amount of divisions used by this curve.
@ -118,7 +118,7 @@ var CubicBezierCurve = new Class({
/**
* Get point at relative position in curve according to length.
*
* @method Phaser.Curves.CubicBezierCurve#getPoint
* @method Phaser.Curves.CubicBezier#getPoint
* @since 3.0.0
*
* @generic {Phaser.Math.Vector2} O - [out,$return]
@ -143,7 +143,7 @@ var CubicBezierCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.CubicBezierCurve#draw
* @method Phaser.Curves.CubicBezier#draw
* @since 3.0.0
*
* @generic {Phaser.GameObjects.Graphics} G - [graphics,$return]
@ -176,7 +176,7 @@ var CubicBezierCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.CubicBezierCurve#toJSON
* @method Phaser.Curves.CubicBezier#toJSON
* @since 3.0.0
*
* @return {JSONCurve} The JSON object containing this curve data.
@ -199,12 +199,12 @@ var CubicBezierCurve = new Class({
/**
* [description]
*
* @function Phaser.Curves.CubicBezierCurve.fromJSON
* @function Phaser.Curves.CubicBezier.fromJSON
* @since 3.0.0
*
* @param {JSONCurve} data - The JSON object containing this curve data.
*
* @return {Phaser.Curves.CubicBezierCurve} [description]
* @return {Phaser.Curves.CubicBezier} [description]
*/
CubicBezierCurve.fromJSON = function (data)
{

74
src/curves/EllipseCurve.js
View file

@ -96,7 +96,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#p0
* @name Phaser.Curves.Ellipse#p0
* @type {Phaser.Math.Vector2}
* @since 3.0.0
*/
@ -105,7 +105,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#_xRadius
* @name Phaser.Curves.Ellipse#_xRadius
* @type {number}
* @private
* @since 3.0.0
@ -115,7 +115,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#_yRadius
* @name Phaser.Curves.Ellipse#_yRadius
* @type {number}
* @private
* @since 3.0.0
@ -127,7 +127,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#_startAngle
* @name Phaser.Curves.Ellipse#_startAngle
* @type {number}
* @private
* @since 3.0.0
@ -137,7 +137,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#_endAngle
* @name Phaser.Curves.Ellipse#_endAngle
* @type {number}
* @private
* @since 3.0.0
@ -147,7 +147,7 @@ var EllipseCurve = new Class({
/**
* Anti-clockwise direction.
*
* @name Phaser.Curves.EllipseCurve#_clockwise
* @name Phaser.Curves.Ellipse#_clockwise
* @type {boolean}
* @private
* @since 3.0.0
@ -157,7 +157,7 @@ var EllipseCurve = new Class({
/**
* The rotation of the arc.
*
* @name Phaser.Curves.EllipseCurve#_rotation
* @name Phaser.Curves.Ellipse#_rotation
* @type {number}
* @private
* @since 3.0.0
@ -168,7 +168,7 @@ var EllipseCurve = new Class({
/**
* Gets the starting point on the curve.
*
* @method Phaser.Curves.EllipseCurve#getStartPoint
* @method Phaser.Curves.Ellipse#getStartPoint
* @since 3.0.0
*
* @generic {Phaser.Math.Vector2} O - [out,$return]
@ -187,7 +187,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.EllipseCurve#getResolution
* @method Phaser.Curves.Ellipse#getResolution
* @since 3.0.0
*
* @param {number} divisions - [description]
@ -202,7 +202,7 @@ var EllipseCurve = new Class({
/**
* Get point at relative position in curve according to length.
*
* @method Phaser.Curves.EllipseCurve#getPoint
* @method Phaser.Curves.Ellipse#getPoint
* @since 3.0.0
*
* @generic {Phaser.Math.Vector2} O - [out,$return]
@ -278,12 +278,12 @@ var EllipseCurve = new Class({
/**
* Sets the horizontal radius of this curve.
*
* @method Phaser.Curves.EllipseCurve#setXRadius
* @method Phaser.Curves.Ellipse#setXRadius
* @since 3.0.0
*
* @param {number} value - The horizontal radius of this curve.
*
* @return {Phaser.Curves.EllipseCurve} This curve object.
* @return {Phaser.Curves.Ellipse} This curve object.
*/
setXRadius: function (value)
{
@ -295,12 +295,12 @@ var EllipseCurve = new Class({
/**
* Sets the vertical radius of this curve.
*
* @method Phaser.Curves.EllipseCurve#setYRadius
* @method Phaser.Curves.Ellipse#setYRadius
* @since 3.0.0
*
* @param {number} value - The vertical radius of this curve.
*
* @return {Phaser.Curves.EllipseCurve} This curve object.
* @return {Phaser.Curves.Ellipse} This curve object.
*/
setYRadius: function (value)
{
@ -312,12 +312,12 @@ var EllipseCurve = new Class({
/**
* Sets the width of this curve.
*
* @method Phaser.Curves.EllipseCurve#setWidth
* @method Phaser.Curves.Ellipse#setWidth
* @since 3.0.0
*
* @param {number} value - The width of this curve.
*
* @return {Phaser.Curves.EllipseCurve} This curve object.
* @return {Phaser.Curves.Ellipse} This curve object.
*/
setWidth: function (value)
{
@ -329,12 +329,12 @@ var EllipseCurve = new Class({
/**
* Sets the height of this curve.
*
* @method Phaser.Curves.EllipseCurve#setHeight
* @method Phaser.Curves.Ellipse#setHeight
* @since 3.0.0
*
* @param {number} value - The height of this curve.
*
* @return {Phaser.Curves.EllipseCurve} This curve object.
* @return {Phaser.Curves.Ellipse} This curve object.
*/
setHeight: function (value)
{
@ -346,12 +346,12 @@ var EllipseCurve = new Class({
/**
* Sets the start angle of this curve.
*
* @method Phaser.Curves.EllipseCurve#setStartAngle
* @method Phaser.Curves.Ellipse#setStartAngle
* @since 3.0.0
*
* @param {number} value - The start angle of this curve, in radians.
*
* @return {Phaser.Curves.EllipseCurve} This curve object.
* @return {Phaser.Curves.Ellipse} This curve object.
*/
setStartAngle: function (value)
{
@ -363,12 +363,12 @@ var EllipseCurve = new Class({
/**
* Sets the end angle of this curve.
*
* @method Phaser.Curves.EllipseCurve#setEndAngle
* @method Phaser.Curves.Ellipse#setEndAngle
* @since 3.0.0
*
* @param {number} value - The end angle of this curve, in radians.
*
* @return {Phaser.Curves.EllipseCurve} This curve object.
* @return {Phaser.Curves.Ellipse} This curve object.
*/
setEndAngle: function (value)
{
@ -380,12 +380,12 @@ var EllipseCurve = new Class({
/**
* Sets if this curve extends clockwise or anti-clockwise.
*
* @method Phaser.Curves.EllipseCurve#setClockwise
* @method Phaser.Curves.Ellipse#setClockwise
* @since 3.0.0
*
* @param {boolean} value - The clockwise state of this curve.
*
* @return {Phaser.Curves.EllipseCurve} This curve object.
* @return {Phaser.Curves.Ellipse} This curve object.
*/
setClockwise: function (value)
{
@ -397,12 +397,12 @@ var EllipseCurve = new Class({
/**
* Sets the rotation of this curve.
*
* @method Phaser.Curves.EllipseCurve#setRotation
* @method Phaser.Curves.Ellipse#setRotation
* @since 3.0.0
*
* @param {number} value - The rotation of this curve, in radians.
*
* @return {Phaser.Curves.EllipseCurve} This curve object.
* @return {Phaser.Curves.Ellipse} This curve object.
*/
setRotation: function (value)
{
@ -414,7 +414,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#x
* @name Phaser.Curves.Ellipse#x
* @type {number}
* @since 3.0.0
*/
@ -435,7 +435,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#y
* @name Phaser.Curves.Ellipse#y
* @type {number}
* @since 3.0.0
*/
@ -456,7 +456,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#xRadius
* @name Phaser.Curves.Ellipse#xRadius
* @type {number}
* @since 3.0.0
*/
@ -477,7 +477,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#yRadius
* @name Phaser.Curves.Ellipse#yRadius
* @type {number}
* @since 3.0.0
*/
@ -498,7 +498,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#startAngle
* @name Phaser.Curves.Ellipse#startAngle
* @type {number}
* @since 3.0.0
*/
@ -519,7 +519,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#endAngle
* @name Phaser.Curves.Ellipse#endAngle
* @type {number}
* @since 3.0.0
*/
@ -540,7 +540,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#clockwise
* @name Phaser.Curves.Ellipse#clockwise
* @type {boolean}
* @since 3.0.0
*/
@ -561,7 +561,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.EllipseCurve#rotation
* @name Phaser.Curves.Ellipse#rotation
* @type {number}
* @since 3.0.0
*/
@ -582,7 +582,7 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.EllipseCurve#toJSON
* @method Phaser.Curves.Ellipse#toJSON
* @since 3.0.0
*
* @return {JSONEllipseCurve} The JSON object containing this curve data.
@ -607,12 +607,12 @@ var EllipseCurve = new Class({
/**
* [description]
*
* @function Phaser.Curves.EllipseCurve.fromJSON
* @function Phaser.Curves.Ellipse.fromJSON
* @since 3.0.0
*
* @param {JSONEllipseCurve} data - The JSON object containing this curve data.
*
* @return {Phaser.Curves.EllipseCurve} [description]
* @return {Phaser.Curves.Ellipse} [description]
*/
EllipseCurve.fromJSON = function (data)
{

24
src/curves/LineCurve.js
View file

@ -47,7 +47,7 @@ var LineCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.LineCurve#p0
* @name Phaser.Curves.Line#p0
* @type {Phaser.Math.Vector2}
* @since 3.0.0
*/
@ -56,7 +56,7 @@ var LineCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.LineCurve#p1
* @name Phaser.Curves.Line#p1
* @type {Phaser.Math.Vector2}
* @since 3.0.0
*/
@ -66,7 +66,7 @@ var LineCurve = new Class({
/**
* Returns a Rectangle where the position and dimensions match the bounds of this Curve.
*
* @method Phaser.Curves.LineCurve#getBounds
* @method Phaser.Curves.Line#getBounds
* @since 3.0.0
*
* @generic {Phaser.Geom.Rectangle} O - [out,$return]
@ -85,7 +85,7 @@ var LineCurve = new Class({
/**
* Gets the starting point on the curve.
*
* @method Phaser.Curves.LineCurve#getStartPoint
* @method Phaser.Curves.Line#getStartPoint
* @since 3.0.0
*
* @generic {Phaser.Math.Vector2} O - [out,$return]
@ -104,7 +104,7 @@ var LineCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.LineCurve#getResolution
* @method Phaser.Curves.Line#getResolution
* @since 3.0.0
*
* @param {number} [divisions=1] - [description]
@ -121,7 +121,7 @@ var LineCurve = new Class({
/**
* Get point at relative position in curve according to length.
*
* @method Phaser.Curves.LineCurve#getPoint
* @method Phaser.Curves.Line#getPoint
* @since 3.0.0
*
* @generic {Phaser.Math.Vector2} O - [out,$return]
@ -150,7 +150,7 @@ var LineCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.LineCurve#getPointAt
* @method Phaser.Curves.Line#getPointAt
* @since 3.0.0
*
* @generic {Phaser.Math.Vector2} O - [out,$return]
@ -168,7 +168,7 @@ var LineCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.LineCurve#getTangent
* @method Phaser.Curves.Line#getTangent
* @since 3.0.0
*
* @generic {Phaser.Math.Vector2} O - [out,$return]
@ -190,7 +190,7 @@ var LineCurve = new Class({
* The curve is drawn using `Graphics.lineBetween` so will be drawn at whatever the present Graphics line color is.
* The Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.
*
* @method Phaser.Curves.LineCurve#draw
* @method Phaser.Curves.Line#draw
* @since 3.0.0
*
* @generic {Phaser.GameObjects.Graphics} G - [graphics,$return]
@ -210,7 +210,7 @@ var LineCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.LineCurve#toJSON
* @method Phaser.Curves.Line#toJSON
* @since 3.0.0
*
* @return {JSONCurve} The JSON object containing this curve data.
@ -231,12 +231,12 @@ var LineCurve = new Class({
/**
* [description]
*
* @function Phaser.Curves.LineCurve.fromJSON
* @function Phaser.Curves.Line.fromJSON
* @since 3.0.0
*
* @param {JSONCurve} data - The JSON object containing this curve data.
*
* @return {Phaser.Curves.LineCurve} [description]
* @return {Phaser.Curves.Line} [description]
*/
LineCurve.fromJSON = function (data)
{

20
src/curves/SplineCurve.js
View file

@ -38,7 +38,7 @@ var SplineCurve = new Class({
/**
* [description]
*
* @name Phaser.Curves.SplineCurve#points
* @name Phaser.Curves.Spline#points
* @type {Phaser.Math.Vector2[]}
* @default []
* @since 3.0.0
@ -51,12 +51,12 @@ var SplineCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.SplineCurve#addPoints
* @method Phaser.Curves.Spline#addPoints
* @since 3.0.0
*
* @param {(Phaser.Math.Vector2[]|number[]|number[][])} points - [description]
*
* @return {Phaser.Curves.SplineCurve} This curve object.
* @return {Phaser.Curves.Spline} This curve object.
*/
addPoints: function (points)
{
@ -91,7 +91,7 @@ var SplineCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.SplineCurve#addPoint
* @method Phaser.Curves.Spline#addPoint
* @since 3.0.0
*
* @param {number} x - [description]
@ -111,7 +111,7 @@ var SplineCurve = new Class({
/**
* Gets the starting point on the curve.
*
* @method Phaser.Curves.SplineCurve#getStartPoint
* @method Phaser.Curves.Spline#getStartPoint
* @since 3.0.0
*
* @generic {Phaser.Math.Vector2} O - [out,$return]
@ -130,7 +130,7 @@ var SplineCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.SplineCurve#getResolution
* @method Phaser.Curves.Spline#getResolution
* @since 3.0.0
*
* @param {number} divisions - [description]
@ -145,7 +145,7 @@ var SplineCurve = new Class({
/**
* Get point at relative position in curve according to length.
*
* @method Phaser.Curves.SplineCurve#getPoint
* @method Phaser.Curves.Spline#getPoint
* @since 3.0.0
*
* @generic {Phaser.Math.Vector2} O - [out,$return]
@ -178,7 +178,7 @@ var SplineCurve = new Class({
/**
* [description]
*
* @method Phaser.Curves.SplineCurve#toJSON
* @method Phaser.Curves.Spline#toJSON
* @since 3.0.0
*
* @return {JSONCurve} The JSON object containing this curve data.
@ -204,12 +204,12 @@ var SplineCurve = new Class({
/**
* [description]
*
* @function Phaser.Curves.SplineCurve.fromJSON
* @function Phaser.Curves.Spline.fromJSON
* @since 3.0.0
*
* @param {JSONCurve} data - The JSON object containing this curve data.
*
* @return {Phaser.Curves.SplineCurve} [description]
* @return {Phaser.Curves.Spline} [description]
*/
SplineCurve.fromJSON = function (data)
{

16
src/curves/path/Path.js
View file

@ -186,20 +186,18 @@ var Path = new Class({
return this;
},
// Creates a cubic bezier curve starting at the previous end point and ending at p3, using p1 and p2 as control points
/**
* [description]
* Creates a cubic bezier curve starting at the previous end point and ending at p3, using p1 and p2 as control points.
*
* @method Phaser.Curves.Path#cubicBezierTo
* @since 3.0.0
*
* @param {number} x - [description]
* @param {number} y - [description]
* @param {Phaser.Math.Vector2} control1X - [description]
* @param {Phaser.Math.Vector2} control1Y - [description]
* @param {Phaser.Math.Vector2} control2X - [description]
* @param {Phaser.Math.Vector2} control2Y - [description]
* @param {(number|Phaser.Math.Vector2)} x - The x coordinate of the end point. Or, if a Vec2, the p1 value.
* @param {(number|Phaser.Math.Vector2)} y - The y coordinate of the end point. Or, if a Vec2, the p2 value.
* @param {(number|Phaser.Math.Vector2)} control1X - The x coordinate of the first control point. Or, if a Vec2, the p3 value.
* @param {number} [control1Y] - The y coordinate of the first control point. Not used if vec2s are provided as the first 3 arguments.
* @param {number} [control2X] - The x coordinate of the second control point. Not used if vec2s are provided as the first 3 arguments.
* @param {number} [control2Y] - The y coordinate of the second control point. Not used if vec2s are provided as the first 3 arguments.
*
* @return {Phaser.Curves.Path} [description]
*/

1
src/gameobjects/container/Container.js
View file

@ -60,6 +60,7 @@ var Vector2 = require('../../math/Vector2');
* @extends Phaser.GameObjects.Components.BlendMode
* @extends Phaser.GameObjects.Components.ComputedSize
* @extends Phaser.GameObjects.Components.Depth
* @extends Phaser.GameObjects.Components.Mask
* @extends Phaser.GameObjects.Components.ScrollFactor
* @extends Phaser.GameObjects.Components.Transform
* @extends Phaser.GameObjects.Components.Visible