Linear interpolation between 2 numbers, the ratio sets how much it is biased to each end
@param a number A
@param b number B
@param r ratio between 0 and 1
@example
```js
----
lerp
cc.lerp(2,10,0.5)//returns 6
cc.lerp(2,10,0.2)//returns 3.6
```
*/
export function lerp(a: number, b: number, r: number): void;
/**
get a random number from 0 to 0xffffff
*/
export function rand(): number;
/**
returns a random float between -1 and 1
*/
export function randomMinus1To1(): number;
/**
returns a random float between 0 and 1, use Math.random directly
*/
export function random0To1(): number;
/**
converts degrees to radians
@param angle angle
*/
export function degreesToRadians(angle: number): number;
/**
converts radians to degrees
@param angle angle
*/
export function radiansToDegrees(angle: number): number;
/**
Helpful macro that setups the GL server state, the correct GL program and sets the Model View Projection matrix
@param node setup node
*/
export function nodeDrawSetup(node: Node): void;
/**
Increments the GL Draws counts by one.
The number of calls per frame are displayed on the screen when the CCDirector's stats are enabled.
@param addNumber addNumber
*/
export function incrementGLDraws(addNumber: number): void;
/**
Check webgl error.Error will be shown in console if exists.
*/
export function checkGLErrorDebug(): void;
/**
!#en Checks whether the object is non-nil and not yet destroyed.
!#zh 检查该对象是否不为 null 并且尚未销毁。
@param value value
@example
```js
cc.log(cc.isValid(target));
```
*/
export function isValid(value: any): boolean;
/** Specify that the input value must be integer in Inspector.
Also used to indicates that the elements in array should be type integer. */
export var Integer: string;
/** Indicates that the elements in array should be type double. */
export var Float: string;
/** Indicates that the elements in array should be type boolean. */
export var Boolean: string;
/** Indicates that the elements in array should be type string. */
export var String: string;
/**
!#en Deserialize json to cc.Asset
!#zh 将 JSON 反序列化为对象实例。
当指定了 target 选项时，如果 target 引用的其它 asset 的 uuid 不变，则不会改变 target 对 asset 的引用，
也不会将 uuid 保存到 result 对象中。
@param data the serialized cc.Asset json string or json object.
@param details additional loading result
@param options options
*/
export function deserialize(data: string|any, details?: Details, options?: any): any;
/**
!#en Clones the object `original` and returns the clone, or instantiate a node from the Prefab.
!#zh 克隆指定的任意类型的对象，或者从 Prefab 实例化出新节点。
（Instantiate 时，function 和 dom 等非可序列化对象会直接保留原有引用，Asset 会直接进行浅拷贝，可序列化类型会进行深拷贝。）
@param original An existing object that you want to make a copy of.
@example
```js
// instantiate node from prefab
var scene = cc.director.getScene();
var node = cc.instantiate(prefabAsset);
node.parent = scene;
// clone node
var scene = cc.director.getScene();
var node = cc.instantiate(targetNode);
node.parent = scene;
```
*/
export function instantiate(original: Prefab): Node;
export function instantiate(original: T): T;
/**
Finds a node by hierarchy path, the path is case-sensitive.
It will traverse the hierarchy by splitting the path using '/' character.
This function will still returns the node even if it is inactive.
It is recommended to not use this function every frame instead cache the result at startup.
@param path path
@param referenceNode referenceNode
*/
export function find(path: string, referenceNode?: Node): Node;
/**
!#en
The convenience method to create a new {{#crossLink "Color/Color:method"}}cc.Color{{/crossLink}}
Alpha channel is optional. Default value is 255.
!#zh
通过该方法来创建一个新的 {{#crossLink "Color/Color:method"}}cc.Color{{/crossLink}} 对象。
Alpha 通道是可选的。默认值是 255。
@param r r
@param g g
@param b b
@param a a
@example
```js
-----------------------
// 1. All channels seperately as parameters
var color1 = new cc.Color(255, 255, 255, 255);
// 2. Convert a hex string to a color
var color2 = new cc.Color("#000000");
// 3. An color object as parameter
var color3 = new cc.Color({r: 255, g: 255, b: 255, a: 255});
```
*/
export function color(r?: number, g?: number, b?: number, a?: number): Color;
/**
!#en returns true if both ccColor3B are equal. Otherwise it returns false.
!#zh 判断两个颜色对象的 RGB 部分是否相等，不比较透明度。
@param color1 color1
@param color2 color2
@example
```js
cc.log(cc.colorEqual(cc.Color.RED, new cc.Color(255, 0, 0))); // true
```
*/
export function colorEqual(color1: Color, color2: Color): boolean;
/**
!#en
convert a string of color for style to Color.
e.g. "#ff06ff" to : cc.color(255,6,255)。
!#zh 16 进制转换为 Color
@param hex hex
@example
```js
cc.hexToColor("#FFFF33"); // Color {r: 255, g: 255, b: 51, a: 255};
```
*/
export function hexToColor(hex: string): Color;
/**
!#en
convert Color to a string of color for style.
e.g. cc.color(255,6,255) to : "#ff06ff"
!#zh Color 转换为 16进制。
@param color color
@example
```js
var color = new cc.Color(255, 6, 255)
cc.colorToHex(color); // #ff06ff;
```
*/
export function colorToHex(color: Color): string;
/**
!#en Returns opposite of Vec2.
!#zh 返回相反的向量。
@param point point
@example
```js
cc.pNeg(cc.v2(10, 10));// Vec2 {x: -10, y: -10};
```
*/
export function pNeg(point: Vec2): Vec2;
/**
!#en Calculates sum of two points.
!#zh 返回两个向量的和。
@param v1 v1
@param v2 v2
@example
```js
cc.pAdd(cc.v2(1, 1), cc.v2(2, 2));// Vec2 {x: 3, y: 3};
```
*/
export function pAdd(v1: Vec2, v2: Vec2): Vec2;
/**
!#en Calculates difference of two points.
!#zh 返回两个向量的差。
@param v1 v1
@param v2 v2
@example
```js
cc.pSub(cc.v2(20, 20), cc.v2(5, 5)); // Vec2 {x: 15, y: 15};
```
*/
export function pSub(v1: Vec2, v2: Vec2): Vec2;
/**
!#en Returns point multiplied by given factor.
!#zh 向量缩放。
@param point point
@param floatVar floatVar
@example
```js
cc.pMult(cc.v2(5, 5), 4); // Vec2 {x: 20, y: 20};
```
*/
export function pMult(point: Vec2, floatVar: number): Vec2;
/**
!#en Calculates midpoint between two points.
!#zh 两个向量之间的中心点。
@param v1 v1
@param v2 v2
@example
```js
cc.pMidpoint(cc.v2(10, 10), cc.v2(5, 5)); // Vec2 {x: 7.5, y: 7.5};
```
*/
export function pMidpoint(v1: Vec2, v2: Vec2): Vec2;
/**
!#en Calculates dot product of two points.
!#zh 两个向量之间进行点乘。
@param v1 v1
@param v2 v2
@example
```js
cc.pDot(cc.v2(20, 20), cc.v2(5, 5)); // 200;
```
*/
export function pDot(v1: Vec2, v2: Vec2): number;
/**
!#en Calculates cross product of two points.
!#zh 两个向量之间进行叉乘。
@param v1 v1
@param v2 v2
@example
```js
cc.pCross(cc.v2(20, 20), cc.v2(5, 5)); // 0;
```
*/
export function pCross(v1: Vec2, v2: Vec2): number;
/**
!#en Calculates perpendicular of v, rotated 90 degrees counter-clockwise -- cross(v, perp(v)) greater than 0.
!#zh 返回逆时针旋转 90 度后的新向量。
@param point point
@example
```js
cc.pPerp(cc.v2(20, 20)); // Vec2 {x: -20, y: 20};
```
*/
export function pPerp(point: Vec2): Vec2;
/**
!#en Calculates perpendicular of v, rotated 90 degrees clockwise -- cross(v, rperp(v)) smaller than 0.
!#zh 将指定向量顺时针旋转 90 度并返回。
@param point point
@example
```js
cc.pRPerp(cc.v2(20, 20)); // Vec2 {x: 20, y: -20};
```
*/
export function pRPerp(point: Vec2): Vec2;
/**
!#en Calculates the projection of v1 over v2.
!#zh 返回 v1 在 v2 上的投影向量。
@param v1 v1
@param v2 v2
@example
```js
var v1 = cc.v2(20, 20);
var v2 = cc.v2(5, 5);
cc.pProject(v1, v2); // Vec2 {x: 20, y: 20};
```
*/
export function pProject(v1: Vec2, v2: Vec2): Vec2;
/**
!#en Calculates the square length of a cc.Vec2 (not calling sqrt() ).
!#zh 返回指定向量长度的平方。
@param v v
@example
```js
cc.pLengthSQ(cc.v2(20, 20)); // 800;
```
*/
export function pLengthSQ(v: Vec2): number;
/**
!#en Calculates the square distance between two points (not calling sqrt() ).
!#zh 返回两个点之间距离的平方。
@param point1 point1
@param point2 point2
@example
```js
var point1 = cc.v2(20, 20);
var point2 = cc.v2(5, 5);
cc.pDistanceSQ(point1, point2); // 450;
```
*/
export function pDistanceSQ(point1: Vec2, point2: Vec2): number;
/**
!#en Calculates distance between point an origin.
!#zh 返回指定向量的长度.
@param v v
@example
```js
cc.pLength(cc.v2(20, 20)); // 28.284271247461902;
```
*/
export function pLength(v: Vec2): number;
/**
!#en Calculates the distance between two points.
!#zh 返回指定 2 个向量之间的距离。
@param v1 v1
@param v2 v2
@example
```js
var v1 = cc.v2(20, 20);
var v2 = cc.v2(5, 5);
cc.pDistance(v1, v2); // 21.213203435596427;
```
*/
export function pDistance(v1: Vec2, v2: Vec2): number;
/**
!#en Returns this vector with a magnitude of 1.
!#zh 返回一个长度为 1 的标准化过后的向量。
@param v v
@example
```js
cc.pNormalize(cc.v2(20, 20)); // Vec2 {x: 0.7071067811865475, y: 0.7071067811865475};
```
*/
export function pNormalize(v: Vec2): Vec2;
/**
!#en Converts radians to a normalized vector.
!#zh 将弧度转换为一个标准化后的向量，返回坐标 x = cos(a) , y = sin(a)。
@param a a
@example
```js
cc.pForAngle(20); // Vec2 {x: 0.40808206181339196, y: 0.9129452507276277};
```
*/
export function pForAngle(a: number): Vec2;
/**
!#en Converts a vector to radians.
!#zh 返回指定向量的弧度。
@param v v
@example
```js
cc.pToAngle(cc.v2(20, 20)); // 0.7853981633974483;
```
*/
export function pToAngle(v: Vec2): number;
/**
!#en Clamp a value between from and to.
!#zh
限定浮点数的最大最小值。
数值大于 max_inclusive 则返回 max_inclusive。
数值小于 min_inclusive 则返回 min_inclusive。
否则返回自身。
@param value value
@param min_inclusive min_inclusive
@param max_inclusive max_inclusive
@example
```js
var v1 = cc.clampf(20, 0, 20); // 20;
var v2 = cc.clampf(-1, 0, 20); // 0;
var v3 = cc.clampf(10, 0, 20); // 10;
```
*/
export function clampf(value: number, min_inclusive: number, max_inclusive: number): number;
/**
!#en Clamp a value between 0 and 1.
!#zh 限定浮点数的取值范围为 0 ~ 1 之间。
@param value value
@example
```js
var v1 = cc.clampf(20); // 1;
var v2 = cc.clampf(-1); // 0;
var v3 = cc.clampf(0.5); // 0.5;
```
*/
export function clamp01(value: number): number;
/**
!#en Clamp a point between from and to.
!#zh
返回指定限制区域后的向量。
向量大于 max_inclusive 则返回 max_inclusive。
向量小于 min_inclusive 则返回 min_inclusive。
否则返回自身。
@param p p
@param min_inclusive min_inclusive
@param max_inclusive max_inclusive
@example
```js
var min_inclusive = cc.v2(0, 0);
var max_inclusive = cc.v2(20, 20);
var v1 = cc.pClamp(cc.v2(20, 20), min_inclusive, max_inclusive); // Vec2 {x: 20, y: 20};
var v2 = cc.pClamp(cc.v2(0, 0), min_inclusive, max_inclusive); // Vec2 {x: 0, y: 0};
var v3 = cc.pClamp(cc.v2(10, 10), min_inclusive, max_inclusive); // Vec2 {x: 10, y: 10};
```
*/
export function pClamp(p: Vec2, min_inclusive: Vec2, max_inclusive: Vec2): Vec2;
/**
!#en Quickly convert cc.Size to a cc.Vec2.
!#zh 快速转换 cc.Size 为 cc.Vec2。
@param s s
@example
```js
cc.pFromSize(new cc.size(20, 20)); // Vec2 {x: 20, y: 20};
```
*/
export function pFromSize(s: Size): Vec2;
/**
!#en
Run a math operation function on each point component
Math.abs, Math.fllor, Math.ceil, Math.round.
!#zh 通过运行指定的数学运算函数来计算指定的向量。
@param p p
@param opFunc opFunc
@example
```js
cc.pCompOp(cc.p(-10, -10), Math.abs); // Vec2 {x: 10, y: 10};
```
*/
export function pCompOp(p: Vec2, opFunc: Function): Vec2;
/**
!#en
Linear Interpolation between two points a and b.
alpha == 0 ? a
alpha == 1 ? b
otherwise a value between a..b.
!#zh
两个点 A 和 B 之间的线性插值。
alpha == 0 ? a
alpha == 1 ? b
否则这个数值在 a ~ b 之间。
@param a a
@param b b
@param alpha alpha
@example
```js
cc.pLerp(cc.v2(20, 20), cc.v2(5, 5), 0.5); // Vec2 {x: 12.5, y: 12.5};
```
*/
export function pLerp(a: Vec2, b: Vec2, alpha: number): Vec2;
/**
!#en TODO
!#zh
近似判断两个点是否相等。
判断 2 个向量是否在指定数值的范围之内，如果在则返回 true，反之则返回 false。
@param a a
@param b b
@param variance variance
@example
```js
var a = cc.v2(20, 20);
var b = cc.v2(5, 5);
var b1 = cc.pFuzzyEqual(a, b, 10); // false;
var b2 = cc.pFuzzyEqual(a, b, 18); // true;
```
*/
export function pFuzzyEqual(a: Vec2, b: Vec2, variance: number): boolean;
/**
!#en Multiplies a nd b components, a.x*b.x, a.y*b.y.
!#zh 计算两个向量的每个分量的乘积， a.x * b.x, a.y * b.y。
@param a a
@param b b
@example
```js
cc.pCompMult(acc.v2(20, 20), cc.v2(5, 5)); // Vec2 {x: 100, y: 100};
```
*/
export function pCompMult(a: Vec2, b: Vec2): Vec2;
/**
!#en TODO
!#zh 返回两个向量之间带正负号的弧度。
@param a a
@param b b
*/
export function pAngleSigned(a: Vec2, b: Vec2): number;
/**
!#en TODO
!#zh 获取当前向量与指定向量之间的弧度角。
@param a a
@param b b
*/
export function pAngle(a: Vec2, b: Vec2): number;
/**
!#en Rotates a point counter clockwise by the angle around a pivot.
!#zh 返回给定向量围绕指定轴心顺时针旋转一定弧度后的结果。
@param v v is the point to rotate
@param pivot pivot is the pivot, naturally
@param angle angle is the angle of rotation cw in radians
*/
export function pRotateByAngle(v: Vec2, pivot: Vec2, angle: number): Vec2;
/**
!#en
A general line-line intersection test
indicating successful intersection of a line
note that to truly test intersection for segments we have to make
sure that s & t lie within [0..1] and for rays, make sure s & t > 0
the hit point is p3 + t * (p4 - p3);
the hit point also is p1 + s * (p2 - p1);
!#zh
返回 A 为起点 B 为终点线段 1 所在直线和 C 为起点 D 为终点线段 2 所在的直线是否相交，
如果相交返回 true，反之则为 false，参数 retP 是返回交点在线段 1、线段 2 上的比例。
@param A A is the startpoint for the first line P1 = (p1 - p2).
@param B B is the endpoint for the first line P1 = (p1 - p2).
@param C C is the startpoint for the second line P2 = (p3 - p4).
@param D D is the endpoint for the second line P2 = (p3 - p4).
@param retP retP.x is the range for a hitpoint in P1 (pa = p1 + s*(p2 - p1)),
retP.y is the range for a hitpoint in P3 (pa = p2 + t*(p4 - p3)).
*/
export function pLineIntersect(A: Vec2, B: Vec2, C: Vec2, D: Vec2, retP: Vec2): boolean;
/**
!#en ccpSegmentIntersect return YES if Segment A-B intersects with segment C-D.
!#zh 返回线段 A - B 和线段 C - D 是否相交。
@param A A
@param B B
@param C C
@param D D
*/
export function pSegmentIntersect(A: Vec2, B: Vec2, C: Vec2, D: Vec2): boolean;
/**
!#en ccpIntersectPoint return the intersection point of line A-B, C-D.
!#zh 返回线段 A - B 和线段 C - D 的交点。
@param A A
@param B B
@param C C
@param D D
*/
export function pIntersectPoint(A: Vec2, B: Vec2, C: Vec2, D: Vec2): Vec2;
/**
!#en check to see if both points are equal.
!#zh 检查指定的 2 个向量是否相等。
@param A A ccp a
@param B B ccp b to be compared
*/
export function pSameAs(A: Vec2, B: Vec2): boolean;
/**
!#en sets the position of the point to 0.
!#zh 设置指定向量归 0。
@param v v
*/
export function pZeroIn(v: Vec2): void;
/**
!#en copies the position of one point to another.
!#zh 令 v1 向量等同于 v2。
@param v1 v1
@param v2 v2
*/
export function pIn(v1: Vec2, v2: Vec2): void;
/**
!#en multiplies the point with the given factor (inplace).
!#zh 向量缩放，结果保存到第一个向量。
@param point point
@param floatVar floatVar
*/
export function pMultIn(point: Vec2, floatVar: number): void;
/**
!#en subtracts one point from another (inplace).
!#zh 向量减法，结果保存到第一个向量。
@param v1 v1
@param v2 v2
*/
export function pSubIn(v1: Vec2, v2: Vec2): void;
/**
!#en adds one point to another (inplace).
!#zh 向量加法，结果保存到第一个向量。
@param v1 v1
@param v2 v2
*/
export function pAddIn(v1: Vec2, v2: Vec2): void;
/**
!#en normalizes the point (inplace).
!#zh 规范化 v 向量，设置 v 向量长度为 1。
@param v v
*/
export function pNormalizeIn(v: Vec2): void;
/**
!#en
The convenience method to create a new Rect.
see {{#crossLink "Rect/Rect:method"}}cc.Rect{{/crossLink}}
!#zh
该方法用来快速创建一个新的矩形。{{#crossLink "Rect/Rect:method"}}cc.Rect{{/crossLink}}
@param x x
@param y y
@param w w
@param h h
@example
```js
var a = new cc.Rect(0 , 0, 10, 0);
```
*/
export function rect(x?: number, y?: number, w?: number, h?: number): Rect;
/**
!#en Check whether a rect's value equals to another.
!#zh 判断两个矩形是否相等。
@param rect1 rect1
@param rect2 rect2
@example
```js
var a = new cc.Rect(0, 0, 10, 10);
var b = new cc.Rect(0, 0, 5, 5);
cc.rectEqualToRect(a, b); // false;
var c = new cc.Rect(0, 0, 5, 5);
cc.rectEqualToRect(b, c); // true;
```
*/
export function rectEqualToRect(rect1: Rect, rect2: Rect): boolean;
/**
!#en Check whether the rect1 contains rect2.
!#zh
检查 rect1 矩形是否包含 rect2 矩形。
注意：如果要允许 rect1 和 rect2 的边界重合，应该用 cc.rectOverlapsRect
@param rect1 rect1
@param rect2 rect2
@example
```js
var a = new cc.Rect(0, 0, 20, 20);
var b = new cc.Rect(10, 10, 20, 20);
cc.rectContainsRect(a, b); // true;
```
*/
export function rectContainsRect(rect1: Rect, rect2: Rect): boolean;
/**
!#en Returns the rightmost x-value of a rect.
!#zh 返回矩形在 x 轴上的最大值
@param rect rect
@example
```js
var a = new cc.Rect(10, 0, 20, 20);
cc.rectGetMaxX(a); // 30;
```
*/
export function rectGetMaxX(rect: Rect): number;
/**
!#en Return the midpoint x-value of a rect.
!#zh 返回矩形在 x 轴上的中点。
@param rect rect
@example
```js
var a = new cc.Rect(10, 0, 20, 20);
cc.rectGetMidX(a); // 20;
```
*/
export function rectGetMidX(rect: Rect): number;
/**
!#en Returns the leftmost x-value of a rect.
!#zh 返回矩形在 x 轴上的最小值。
@param rect rect
@example
```js
var a = new cc.Rect(10, 0, 20, 20);
cc.rectGetMinX(a); // 10;
```
*/
export function rectGetMinX(rect: Rect): number;
/**
!#en Return the topmost y-value of a rect.
!#zh 返回矩形在 y 轴上的最大值。
@param rect rect
@example
```js
var a = new cc.Rect(0, 10, 20, 20);
cc.rectGetMaxY(a); // 30;
```
*/
export function rectGetMaxY(rect: Rect): number;
/**
!#en Return the midpoint y-value of `rect'.
!#zh 返回矩形在 y 轴上的中点。
@param rect rect
@example
```js
var a = new cc.Rect(0, 10, 20, 20);
cc.rectGetMidY(a); // 20;
```
*/
export function rectGetMidY(rect: Rect): number;
/**
!#en Return the bottommost y-value of a rect.
!#zh 返回矩形在 y 轴上的最小值。
@param rect rect
@example
```js
var a = new cc.Rect(0, 10, 20, 20);
cc.rectGetMinY(a); // 10;
```
*/
export function rectGetMinY(rect: Rect): number;
/**
!#en Check whether a rect contains a point.
!#zh 检查一个矩形是否包含某个坐标点。
@param rect rect
@param point point
@example
```js
var a = new cc.Rect(0, 10, 20, 20);
var b = new cc.Vec2(0, 10, 10, 10);
cc.rectContainsPoint(a, b); // true;
```
*/
export function rectContainsPoint(rect: Rect, point: Vec2): boolean;
/**
!#en Check whether a rect intersect with another.
!#zh 检查一个矩形是否与另一个相交。
@param rectA rectA
@param rectB rectB
@example
```js
var a = new cc.Rect(0, 10, 20, 20);
var b = new cc.Rect(0, 10, 10, 10);
cc.rectIntersectsRect(a, b); // true;
```
*/
export function rectIntersectsRect(rectA: Rect, rectB: Rect): boolean;
/**
!#en Check whether a rect overlaps another.
!#zh 检查一个矩形是否重叠另一个。
@param rectA rectA
@param rectB rectB
@example
```js
var a = new cc.Rect(0, 10, 20, 20);
var b = new cc.Rect(0, 10, 10, 10);
cc.rectOverlapsRect(a, b); // true;
```
*/
export function rectOverlapsRect(rectA: Rect, rectB: Rect): boolean;
/**
!#en Returns the smallest rectangle that contains the two source rectangles.
!#zh 返回一个包含两个指定矩形的最小矩形。
@param rectA rectA
@param rectB rectB
@example
```js
var a = new cc.Rect(0, 10, 20, 20);
var b = new cc.Rect(0, 10, 10, 10);
cc.rectUnion(a, b); // Rect {x: 0, y: 10, width: 20, height: 20};
```
*/
export function rectUnion(rectA: Rect, rectB: Rect): Rect;
/**
!#en Returns the overlapping portion of 2 rectangles.
!#zh 返回 2 个矩形重叠的部分。
@param rectA rectA
@param rectB rectB
@example
```js
var a = new cc.Rect(0, 10, 20, 20);
var b = new cc.Rect(0, 10, 10, 10);
cc.rectIntersection(a, b); // Rect {x: 0, y: 10, width: 10, height: 10};
```
*/
export function rectIntersection(rectA: Rect, rectB: Rect): Rect;
/**
!#en
Helper function that creates a cc.Size.
Please use cc.p or cc.v2 instead, it will soon replace cc.Size.
!#zh
创建一个 cc.Size 对象的帮助函数。
注意：可以使用 cc.p 或者是 cc.v2 代替，它们将很快取代 cc.Size。
@param w width or a size object
@param h height
@example
```js
var size1 = cc.size();
var size2 = cc.size(100,100);
var size3 = cc.size(size2);
var size4 = cc.size({width: 100, height: 100});
```
*/
export function size(w: number|Size, h?: number): Size;
/**
!#en Check whether a point's value equals to another.
!#zh 检查 Size 对象是否等于另一个。
@param size1 size1
@param size2 size2
@example
```js
var a = new cc.size(10, 10);
var b = new cc.size(10, 10);
cc.sizeEqualToSize(a, b);// return true;
var b = new cc.size(5, 10);
cc.sizeEqualToSize(a, b);// return false;
```
*/
export function sizeEqualToSize(size1: Size, size2: Size): boolean;
export function V3F_C4B_T2F_QuadZero(): V3F_C4B_T2F_Quad;
/**
@param sourceQuad sourceQuad
*/
export function V3F_C4B_T2F_QuadCopy(sourceQuad: V3F_C4B_T2F_Quad): V3F_C4B_T2F_Quad;
/**
@param sourceQuads sourceQuads
*/
export function V3F_C4B_T2F_QuadsCopy(sourceQuads: any[]): any[];
/**
!#en The convenience method to create a new {{#crossLink "Vec2"}}cc.Vec2{{/crossLink}}.
!#zh 通过该简便的函数进行创建 {{#crossLink "Vec2"}}cc.Vec2{{/crossLink}} 对象。
@param x x
@param y y
@example
```js
var v1 = cc.v2();
var v2 = cc.v2(0, 0);
var v3 = cc.v2(v2);
var v4 = cc.v2({x: 100, y: 100});
```
*/
export function v2(x?: number|any, y?: number): Vec2;
/**
!#en The convenience method to creates a new {{#crossLink "Vec2"}}cc.Vec2{{/crossLink}}.
!#zh 通过该简便的函数进行创建 {{#crossLink "Vec2"}}cc.Vec2{{/crossLink}} 对象。
@param x a Number or a size object
@param y y
@example
```js
var point1 = cc.p();
var point2 = cc.p(100, 100);
var point3 = cc.p(point2);
var point4 = cc.p({x: 100, y: 100});
```
*/
export function p(x?: number|any, y?: number): Vec2;
/**
!#en Check whether a point's value equals to another.
!#zh 判断两个向量是否相等。
@param point1 point1
@param point2 point2
*/
export function pointEqualToPoint(point1: Vec2, point2: Vec2): boolean;
/** !#en Enum for debug modes.
!#zh 调试模式 */
export enum DebugMode {
NONE = 0,
INFO = 0,
WARN = 0,
ERROR = 0,
INFO_FOR_WEB_PAGE = 0,
WARN_FOR_WEB_PAGE = 0,
ERROR_FOR_WEB_PAGE = 0,
}
/** !#en Base class cc.Action for action classes.
!#zh Action 类是所有动作类型的基类。 */
export class Action {
/**
!#en
to copy object with deep copy.
returns a clone of action.
!#zh 返回一个克隆的动作。
*/
clone(): Action;
/**
!#en
return true if the action has finished.
!#zh 如果动作已完成就返回 true。
*/
isDone(): boolean;
/**
!#en get the target.
!#zh 获取当前目标节点。
*/
getTarget(): Node;
/**
!#en The action will modify the target properties.
!#zh 设置目标节点。
@param target target
*/
setTarget(target: Node): void;
/**
!#en get the original target.
!#zh 获取原始目标节点。
*/
getOriginalTarget(): Node;
/**
!#en get tag number.
!#zh 获取用于识别动作的标签。
*/
getTag(): number;
/**
!#en set tag number.
!#zh 设置标签，用于识别动作。
@param tag tag
*/
setTag(tag: number): void;
/** !#en Default Action tag.
!#zh 默认动作标签。 */
static TAG_INVALID: number;
}
/** !#en
Base class actions that do have a finite time duration.
Possible actions:
- An action with a duration of 0 seconds.
- An action with a duration of 35.5 seconds.
Infinite time actions are valid
!#zh 有限时间动作，这种动作拥有时长 duration 属性。 */
export class FiniteTimeAction extends Action {
/**
!#en get duration of the action. (seconds).
!#zh 获取动作以秒为单位的持续时间。
*/
getDuration(): number;
/**
!#en set duration of the action. (seconds).
!#zh 设置动作以秒为单位的持续时间。
@param duration duration
*/
setDuration(duration: number): void;
/**
!#en
Returns a reversed action.
For example:
- The action will be x coordinates of 0 move to 100.
- The reversed action will be x of 100 move to 0.
- Will be rewritten
!#zh 返回一个新的动作，执行与原动作完全相反的动作。
*/
reverse(): void;
/**
!#en
to copy object with deep copy.
returns a clone of action.
!#zh 返回一个克隆的动作。
*/
clone(): FiniteTimeAction;
}
/** !#en Base class for Easing actions.
!#zh 所有缓动动作基类，用于修饰 ActionInterval。 */
export class ActionEase extends ActionInterval {
}
/** !#en Base class for Easing actions with rate parameters
!#zh 拥有速率属性的缓动动作基类。 */
export class EaseRateAction extends ActionEase {
}
/** !#en Ease Elastic abstract class.
!#zh 弹性缓动动作基类。 */
export class EaseElastic extends ActionEase {
}
/** !#en cc.EaseBounce abstract class.
!#zh 反弹缓动动作基类。 */
export class EaseBounce extends ActionEase {
}
/** !#en Instant actions are immediate actions. They don't have a duration like the ActionInterval actions.
!#zh 即时动作，这种动作立即就会执行，继承自 FiniteTimeAction。 */
export class ActionInstant extends FiniteTimeAction {
}
/** !#en
An interval action is an action that takes place within a certain period of time.
It has an start time, and a finish time. The finish time is the parameter
duration plus the start time.
These CCActionInterval actions have some interesting properties, like:
- They can run normally (default)
- They can run reversed with the reverse method
- They can run with the time altered with the Accelerate, AccelDeccel and Speed actions.
For example, you can simulate a Ping Pong effect running the action normally and
then running it again in Reverse mode.
!#zh 时间间隔动作，这种动作在已定时间内完成，继承 FiniteTimeAction。 */
export class ActionInterval extends FiniteTimeAction {
/**
!#en Implementation of ease motion.
!#zh 缓动运动。
@param easeObj easeObj
@example
```js
action.easing(cc.easeIn(3.0));
```
*/
easing(easeObj: any): ActionInterval;
/**
!#en
Repeats an action a number of times.
To repeat an action forever use the CCRepeatForever action.
!#zh 重复动作可以按一定次数重复一个动作，使用 RepeatForever 动作来永远重复一个动作。
@param times times
*/
repeat(times: number): ActionInterval;
/**
!#en
Repeats an action for ever.
To repeat the an action for a limited number of times use the Repeat action.
!#zh 永远地重复一个动作，有限次数内重复一个动作请使用 Repeat 动作。
*/
repeatForever(): ActionInterval;
}
/** !#en
cc.ActionManager is a class that can manage actions.
Normally you won't need to use this class directly. 99% of the cases you will use the CCNode interface,
which uses this class's singleton object.
But there are some cases where you might need to use this class.
Examples:
- When you want to run an action where the target is different from a CCNode.
- When you want to pause / resume the actions
!#zh
cc.ActionManager 是可以管理动作的单例类。
通常你并不需要直接使用这个类，99%的情况您将使用 CCNode 的接口。
但也有一些情况下，您可能需要使用这个类。
例如：
- 当你想要运行一个动作，但目标不是 CCNode 类型时。
- 当你想要暂停/恢复动作时。
*/
export class ActionManager {
/**
!#en
Adds an action with a target.
If the target is already present, then the action will be added to the existing target.
If the target is not present, a new instance of this target will be created either paused or not, and the action will be added to the newly created target.
When the target is paused, the queued actions won't be 'ticked'.
!#zh
增加一个动作，同时还需要提供动作的目标对象，目标对象是否暂停作为参数。
如果目标已存在，动作将会被直接添加到现有的节点中。
如果目标不存在，将为这一目标创建一个新的实例，并将动作添加进去。
当目标状态的 paused 为 true，动作将不会被执行
@param action action
@param target target
@param paused paused
*/
addAction(action: Action, target: Node, paused: boolean): void;
/**
!#en Removes all actions from all the targets.
!#zh 移除所有对象的所有动作。
*/
removeAllActions(): void;
/**
!#en
Removes all actions from a certain target.
All the actions that belongs to the target will be removed.
!#zh
移除指定对象上的所有动作。
属于该目标的所有的动作将被删除。
@param target target
@param forceDelete forceDelete
*/
removeAllActionsFromTarget(target: Node, forceDelete: boolean): void;
/**
!#en Removes an action given an action reference.
!#zh 移除指定的动作。
@param action action
*/
removeAction(action: Action): void;
/**
!#en Removes an action given its tag and the target.
!#zh 删除指定对象下特定标签的一个动作，将删除首个匹配到的动作。
@param tag tag
@param target target
*/
removeActionByTag(tag: number, target: Node): void;
/**
!#en Gets an action given its tag an a target.
!#zh 通过目标对象和标签获取一个动作。
@param tag tag
@param target target
*/
getActionByTag(tag: number, target: Node): Action;
/**
!#en
Returns the numbers of actions that are running in a certain target.
Composable actions are counted as 1 action.
Example:
- If you are running 1 Sequence of 7 actions, it will return 1.
- If you are running 7 Sequences of 2 actions, it will return 7.
!#zh
返回指定对象下所有正在运行的动作数量。
组合动作被算作一个动作。
例如：
- 如果您正在运行 7 个动作组成的序列动作（Sequence），这个函数将返回 1。
- 如果你正在运行 2 个序列动作（Sequence）和 5 个普通动作，这个函数将返回 7。
@param target target
*/
getNumberOfRunningActionsInTarget(target: Node): number;
/**
!#en Pauses the target: all running actions and newly added actions will be paused.
!#zh 暂停指定对象：所有正在运行的动作和新添加的动作都将会暂停。
@param target target
*/
pauseTarget(target: Node): void;
/**
!#en Resumes the target. All queued actions will be resumed.
!#zh 让指定目标恢复运行。在执行序列中所有被暂停的动作将重新恢复运行。
@param target target
*/
resumeTarget(target: Node): void;
/**
!#en Pauses all running actions, returning a list of targets whose actions were paused.
!#zh 暂停所有正在运行的动作，返回一个包含了那些动作被暂停了的目标对象的列表。
*/
pauseAllRunningActions(): any[];
/**
!#en Resume a set of targets (convenience function to reverse a pauseAllRunningActions or pauseTargets call).
!#zh 让一组指定对象恢复运行（用来逆转 pauseAllRunningActions 效果的便捷函数）。
@param targetsToResume targetsToResume
*/
resumeTargets(targetsToResume: any[]): void;
/**
!#en Pause a set of targets.
!#zh 暂停一组指定对象。
@param targetsToPause targetsToPause
*/
pauseTargets(targetsToPause: any[]): void;
/**
!#en
purges the shared action manager. It releases the retained instance.
because it uses this, so it can not be static.
!#zh
清除共用的动作管理器。它释放了持有的实例。
因为它使用 this，因此它不能是静态的。
*/
purgeSharedManager(): void;
/**
!#en The ActionManager update。
!#zh ActionManager 主循环。
@param dt delta time in seconds
*/
update(dt: number): void;
}
/** !#en Class for animation data handling.
!#zh 动画剪辑，用于存储动画数据。 */
export class AnimationClip extends Asset {
/** !#en Duration of this animation.
!#zh 动画的持续时间。 */
duration: number;
/** !#en FrameRate of this animation.
!#zh 动画的帧速率。 */
sample: number;
/** !#en Speed of this animation.
!#zh 动画的播放速度。 */
speed: number;
/** !#en WrapMode of this animation.
!#zh 动画的循环模式。 */
wrapMode: WrapMode;
/** !#en Curve data.
!#zh 曲线数据。 */
curveData: any;
/** !#en Event data.
!#zh 事件数据。 */
events: {frame: number, func: string, params: string[]}[];
/**
!#en Crate clip with a set of sprite frames
!#zh 使用一组序列帧图片来创建动画剪辑
@param spriteFrames spriteFrames
@param sample sample
@example
```js
var clip = cc.AnimationClip.createWithSpriteFrames(spriteFrames, 10);
```
*/
static createWithSpriteFrames(spriteFrames: [SpriteFrame], sample: number): AnimationClip;
}
/** undefined */
export class Playable {
/** !#en Is playing or paused in play mode?
!#zh 当前是否正在播放。 */
isPlaying: boolean;
/** !#en Is currently paused? This can be true even if in edit mode(isPlaying == false).
!#zh 当前是否正在暂停 */
isPaused: boolean;
/**
!#en Play this animation.
!#zh 播放动画。
*/
play(): void;
/**
!#en Stop this animation.
!#zh 停止动画播放。
*/
stop(): void;
/**
!#en Pause this animation.
!#zh 暂停动画。
*/
pause(): void;
/**
!#en Resume this animation.
!#zh 重新播放动画。
*/
resume(): void;
/**
!#en Perform a single frame step.
!#zh 执行一帧动画。
*/
step(): void;
}
/** !#en
The AnimationState gives full control over animation playback process.
In most cases the Animation Component is sufficient and easier to use. Use the AnimationState if you need full control.
!#zh
AnimationState 完全控制动画播放过程。
大多数情况下 动画组件 是足够和易于使用的。如果您需要更多的动画控制接口，请使用 AnimationState。 */
export class AnimationState extends Playable {
/**
@param clip clip
@param name name
*/
constructor(clip: AnimationClip, name?: string);
animator: AnimationAnimator;
/** !#en The curves list.
!#zh 曲线列表。 */
curves: any[];
/** !#en The start delay which represents the number of seconds from an animation's start time to the start of
the active interval.
!#zh 延迟多少秒播放。 */
delay: number;
/** !#en The animation's iteration count property.
A real number greater than or equal to zero (including positive infinity) representing the number of times
to repeat the animation node.
Values less than zero and NaN values are treated as the value 1.0 for the purpose of timing model
calculations.
!#zh 迭代次数，指动画播放多少次后结束, normalize time。 如 2.5（2次半） */
repeatCount: number;
/** !#en The iteration duration of this animation in seconds. (length)
!#zh 单次动画的持续时间，秒。 */
duration: number;
/** !#en The animation's playback speed. 1 is normal playback speed.
!#zh 播放速率。 */
speed: number;
/** !#en
Wrapping mode of the playing animation.
Notice : dynamic change wrapMode will reset time and repeatCount property
!#zh
动画循环方式。
需要注意的是，动态修改 wrapMode 时，会重置 time 以及 repeatCount */
wrapMode: WrapMode;
/** !#en The current time of this animation in seconds.
!#zh 动画当前的时间，秒。 */
time: number;
/** !#en The clip that is being played by this animation state.
!#zh 此动画状态正在播放的剪辑。 */
clip: AnimationClip;
/** !#en The name of the playing animation.
!#zh 动画的名字 */
name: string;
}
/** !#en Specifies how time is treated when it is outside of the keyframe range of an Animation.
!#zh 动画使用的循环模式。 */
export enum WrapMode {
Default = 0,
Normal = 0,
Reverse = 0,
Loop = 0,
LoopReverse = 0,
PingPong = 0,
PingPongReverse = 0,
}
/** !#en
cc.MotionStreak manages a Ribbon based on it's motion in absolute space.
You construct it with a fadeTime, minimum segment size, texture path, texture
length and color. The fadeTime controls how long it takes each vertex in
the streak to fade out, the minimum segment size it how many pixels the
streak will move before adding a new ribbon segment, and the texture
length is the how many pixels the texture is stretched across. The texture
is vertically aligned along the streak segment.
!#zh 运动轨迹，用于游戏对象的运动轨迹上实现拖尾渐隐效果。 */
export class MotionStreak extends Component {
/** !#en
!#zh 在编辑器模式下预览拖尾效果。 */
preview: boolean;
/** !#en The fade time to fade.
!#zh 拖尾的渐隐时间，以秒为单位。 */
fadeTime: number;
/** !#en The minimum segment size.
!#zh 拖尾之间最小距离。 */
minSeg: number;
/** !#en The stroke's width.
!#zh 拖尾的宽度。 */
stroke: number;
/** !#en The texture of the MotionStreak.
!#zh 拖尾的贴图。 */
texture: Texture2D;
/** !#en The color of the MotionStreak.
!#zh 拖尾的颜色 */
color: Color;
/** !#en The fast Mode.
!#zh 是否启用了快速模式。当启用快速模式，新的点会被更快地添加，但精度较低。 */
fastMode: boolean;
/**
!#en Remove all living segments of the ribbon.
!#zh 删除当前所有的拖尾片段。
@example
```js
// stop particle system.
myParticleSystem.stopSystem();
```
*/
reset(): void;
}
/** !#en cc.audioEngine is the singleton object, it provide simple audio APIs.
!#zh
cc.audioengine是单例对象。
主要用来播放音频，播放的时候会返回一个 audioID，之后都可以通过这个 audioID 来操作这个音频对象。
不使用的时候，请使用 cc.audioEngine.uncache(filePath); 进行资源释放
注意：
在 Android 系统浏览器上，不同浏览器，不同版本的效果不尽相同。
比如说：大多数浏览器都需要用户物理交互才可以开始播放音效，有一些不支持 WebAudio，
有一些不支持多音轨播放。总之如果对音乐依赖比较强，请做尽可能多的测试。 */
export class audioEngine {
/**
!#en Play audio.
!#zh 播放音频
@param filePath The path of the audio file without filename extension.
@param loop Whether the music loop or not.
@param volume Volume size.
@example
```js
var audioID = cc.audioEngine.play(path, false, 0.5);
```
*/
static play(filePath: string, loop: boolean, volume: number): number;
/**
!#en Set audio loop.
!#zh 设置音频是否循环。
@param audioID audio id.
@param loop Whether cycle.
@example
```js
cc.audioEngine.setLoop(id, true);
```
*/
static setLoop(audioID: number, loop: boolean): void;
/**
!#en Get audio cycle state.
!#zh 获取音频的循环状态。
@param audioID audio id.
@example
```js
cc.audioEngine.isLoop(id);
```
*/
static isLoop(audioID: number): boolean;
/**
!#en Set the volume of audio.
!#zh 设置音量（0.0 ~ 1.0）。
@param audioID audio id.
@param volume Volume must be in 0.0~1.0 .
@example
```js
cc.audioEngine.setVolume(id, 0.5);
```
*/
static setVolume(audioID: number, volume: number): void;
/**
!#en The volume of the music max value is 1.0,the min value is 0.0 .
!#zh 获取音量（0.0 ~ 1.0）。
@param audioID audio id.
@example
```js
var volume = cc.audioEngine.getVolume(id);
```
*/
static getVolume(audioID: number): number;
/**
!#en Set current time
!#zh 设置当前的音频时间。
@param audioID audio id.
@param sec current time.
@example
```js
cc.audioEngine.setCurrentTime(id, 2);
```
*/
static setCurrentTime(audioID: number, sec: number): boolean;
/**
!#en Get current time
!#zh 获取当前的音频播放时间。
@param audioID audio id.
@example
```js
var time = cc.audioEngine.getCurrentTime(id);
```
*/
static getCurrentTime(audioID: number): number;
/**
!#en Get audio duration
!#zh 获取音频总时长。
@param audioID audio id.
@example
```js
var time = cc.audioEngine.getDuration(id);
```
*/
static getDuration(audioID: number): number;
/**
!#en Get audio state
!#zh 获取音频状态。
@param audioID audio id.
@example
```js
var state = cc.audioEngine.getState(id);
```
*/
static getState(audioID: number): audioEngine.AudioState;
/**
!#en Set Audio finish callback
!#zh 设置一个音频结束后的回调
@param audioID audio id.
@param callback loaded callback.
@example
```js
cc.audioEngine.setFinishCallback(id, function () {});
```
*/
static setFinishCallback(audioID: number, callback: Function): void;
/**
!#en Pause playing audio.
!#zh 暂停正在播放音频。
@param audioID The return value of function play.
@example
```js
cc.audioEngine.pause(audioID);
```
*/
static pause(audioID: number): void;
/**
!#en Pause all playing audio
!#zh 暂停现在正在播放的所有音频。
@example
```js
cc.audioEngine.pauseAll();
```
*/
static pauseAll(): void;
/**
!#en Resume playing audio.
!#zh 恢复播放指定的音频。
@param audioID The return value of function play.
@example
```js
cc.audioEngine.resume(audioID);
```
*/
static resume(audioID: number): void;
/**
!#en Resume all playing audio.
!#zh 恢复播放所有之前暂停的所有音频。
@example
```js
cc.audioEngine.resumeAll();
```
*/
static resumeAll(): void;
/**
!#en Stop playing audio.
!#zh 停止播放指定音频。
@param audioID The return value of function play.
@example
```js
cc.audioEngine.stop(audioID);
```
*/
static stop(audioID: number): void;
/**
!#en Stop all playing audio.
!#zh 停止正在播放的所有音频。
@example
```js
cc.audioEngine.stopAll();
```
*/
static stopAll(): void;
/**
!#en Set up an audio can generate a few examples.
!#zh 设置一个音频可以设置几个实例
@param num a number of instances to be created from within an audio
@example
```js
cc.audioEngine.setMaxAudioInstance(20);
```
*/
static setMaxAudioInstance(num: number): void;
/**
!#en Getting audio can produce several examples.
!#zh 获取一个音频可以设置几个实例
@example
```js
cc.audioEngine.getMaxAudioInstance();
```
*/
static getMaxAudioInstance(): number;
/**
!#en Unload the preloaded audio from internal buffer.
!#zh 卸载预加载的音频。
@param filePath filePath
@example
```js
cc.audioEngine.uncache(filePath);
```
*/
static uncache(filePath: string): void;
/**
!#en Unload all audio from internal buffer.
!#zh 卸载所有音频。
@example
```js
cc.audioEngine.uncacheAll();
```
*/
static uncacheAll(): void;
/**
!#en Preload audio file.
!#zh 预加载一个音频
@param filePath The file path of an audio.
@param callback The callback of an audio.
@example
```js
cc.audioEngine.preload(path);
```
*/
static preload(filePath: string, callback?: Function): void;
/**
!#en Set a size, the unit is KB. Over this size is directly resolved into DOM nodes.
!#zh 设置一个以 KB 为单位的尺寸，大于这个尺寸的音频在加载的时候会强制使用 dom 方式加载
@param kb The file path of an audio.
@example
```js
cc.audioEngine.setMaxWebAudioSize(300);
```
*/
static setMaxWebAudioSize(kb: number): void;
}
/** Particle System base class.
Attributes of a Particle System:
- emmision rate of the particles
- Gravity Mode (Mode A):
- gravity
- direction
- speed +- variance
- tangential acceleration +- variance
- radial acceleration +- variance
- Radius Mode (Mode B):
- startRadius +- variance
- endRadius +- variance
- rotate +- variance
- Properties common to all modes:
- life +- life variance
- start spin +- variance
- end spin +- variance
- start size +- variance
- end size +- variance
- start color +- variance
- end color +- variance
- life +- variance
- blending function
- texture
cocos2d also supports particles generated by Particle Designer (http://particledesigner.71squared.com/).
'Radius Mode' in Particle Designer uses a fixed emit rate of 30 hz. Since that can't be guarateed in cocos2d,
cocos2d uses a another approach, but the results are almost identical.
cocos2d supports all the variables used by Particle Designer plus a bit more:
- spinning particles (supported when using ParticleSystem)
- tangential acceleration (Gravity mode)
- radial acceleration (Gravity mode)
- radius direction (Radius mode) (Particle Designer supports outwards to inwards direction only)
It is possible to customize any of the above mentioned properties in runtime. Example:
*/
export class ParticleSystem extends _RendererUnderSG {
/** !#en Play particle in edit mode.
!#zh 在编辑器模式下预览粒子，启用后选中粒子时，粒子将自动播放。 */
preview: boolean;
/** !#en
If set custom to true, then use custom properties insteadof read particle file.
!#zh 是否自定义粒子属性。 */
custom: boolean;
/** !#en The plist file.
!#zh plist 格式的粒子配置文件。 */
file: string;
/** . */
texture: Texture2D;
/** !#en Current quantity of particles that are being simulated.
!#zh 当前播放的粒子数量。 */
particleCount: number;
/** !#en Specify the source Blend Factor.
!#zh 指定原图混合模式。 */
srcBlendFactor: BlendFactor;
/** !#en Specify the destination Blend Factor.
!#zh 指定目标的混合模式。 */
dstBlendFactor: BlendFactor;
/** !#en If set to true, the particle system will automatically start playing on onLoad.
!#zh 如果设置为 true 运行时会自动发射粒子。 */
playOnLoad: boolean;
/** !#en Indicate whether the owner node will be auto-removed when it has no particles left.
!#zh 粒子播放完毕后自动销毁所在的节点。 */
autoRemoveOnFinish: boolean;
/** !#en Indicate whether the particle system is activated.
!#zh 是否激活粒子。 */
active: boolean;
/** !#en Maximum particles of the system.
!#zh 粒子最大数量。 */
totalParticles: number;
/** !#en How many seconds the emitter wil run. -1 means 'forever'.
!#zh 发射器生存时间，单位秒，-1表示持续发射。 */
duration: number;
/** !#en Emission rate of the particles.
!#zh 每秒发射的粒子数目。 */
emissionRate: number;
/** !#en Life of each particle setter.
!#zh 粒子的运行时间。 */
life: number;
/** !#en Variation of life.
!#zh 粒子的运行时间变化范围。 */
lifeVar: number;
/** !#en Start color of each particle.
!#zh 粒子初始颜色。 */
startColor: Color;
/** !#en Variation of the start color.
!#zh 粒子初始颜色变化范围。 */
startColorVar: Color;
/** !#en Ending color of each particle.
!#zh 粒子结束颜色。 */
endColor: Color;
/** !#en Variation of the end color.
!#zh 粒子结束颜色变化范围。 */
endColorVar: Color;
/** !#en Angle of each particle setter.
!#zh 粒子角度。 */
angle: number;
/** !#en Variation of angle of each particle setter.
!#zh 粒子角度变化范围。 */
angleVar: number;
/** !#en Start size in pixels of each particle.
!#zh 粒子的初始大小。 */
startSize: number;
/** !#en Variation of start size in pixels.
!#zh 粒子初始大小的变化范围。 */
startSizeVar: number;
/** !#en End size in pixels of each particle.
!#zh 粒子结束时的大小。 */
endSize: number;
/** !#en Variation of end size in pixels.
!#zh 粒子结束大小的变化范围。 */
endSizeVar: number;
/** !#en Start angle of each particle.
!#zh 粒子开始自旋角度。 */
startSpin: number;
/** !#en Variation of start angle.
!#zh 粒子开始自旋角度变化范围。 */
startSpinVar: number;
/** !#en End angle of each particle.
!#zh 粒子结束自旋角度。 */
endSpin: number;
/** !#en Variation of end angle.
!#zh 粒子结束自旋角度变化范围。 */
endSpinVar: number;
/** !#en Source position of the emitter.
!#zh 发射器位置。 */
sourcePos: Vec2;
/** !#en Variation of source position.
!#zh 发射器位置的变化范围。（横向和纵向） */
posVar: Vec2;
/** !#en Particles movement type.
!#zh 粒子位置类型。 */
positionType: ParticleSystem.PositionType;
/** !#en Particles emitter modes.
!#zh 发射器类型。 */
emitterMode: ParticleSystem.EmitterMode;
/** !#en Gravity of the emitter.
!#zh 重力。 */
gravity: Vec2;
/** !#en Speed of the emitter.
!#zh 速度。 */
speed: number;
/** !#en Variation of the speed.
!#zh 速度变化范围。 */
speedVar: number;
/** !#en Tangential acceleration of each particle. Only available in 'Gravity' mode.
!#zh 每个粒子的切向加速度，即垂直于重力方向的加速度，只有在重力模式下可用。 */
tangentialAccel: number;
/** !#en Variation of the tangential acceleration.
!#zh 每个粒子的切向加速度变化范围。 */
tangentialAccelVar: number;
/** !#en Acceleration of each particle. Only available in 'Gravity' mode.
!#zh 粒子径向加速度，即平行于重力方向的加速度，只有在重力模式下可用。 */
radialAccel: number;
/** !#en Variation of the radial acceleration.
!#zh 粒子径向加速度变化范围。 */
radialAccelVar: number;
/** !#en Indicate whether the rotation of each particle equals to its direction. Only available in 'Gravity' mode.
!#zh 每个粒子的旋转是否等于其方向，只有在重力模式下可用。 */
rotationIsDir: boolean;
/** !#en Starting radius of the particles. Only available in 'Radius' mode.
!#zh 初始半径，表示粒子出生时相对发射器的距离，只有在半径模式下可用。 */
startRadius: number;
/** !#en Variation of the starting radius.
!#zh 初始半径变化范围。 */
startRadiusVar: number;
/** !#en Ending radius of the particles. Only available in 'Radius' mode.
!#zh 结束半径，只有在半径模式下可用。 */
endRadius: number;
/** !#en Variation of the ending radius.
!#zh 结束半径变化范围。 */
endRadiusVar: number;
/** !#en Number of degress to rotate a particle around the source pos per second. Only available in 'Radius' mode.
!#zh 粒子每秒围绕起始点的旋转角度，只有在半径模式下可用。 */
rotatePerS: number;
/** !#en Variation of the degress to rotate a particle around the source pos per second.
!#zh 粒子每秒围绕起始点的旋转角度变化范围。 */
rotatePerSVar: number;
/** !#en The Particle emitter lives forever.
!#zh 表示发射器永久存在 */
static DURATION_INFINITY: number;
/** !#en The starting size of the particle is equal to the ending size.
!#zh 表示粒子的起始大小等于结束大小。 */
static START_SIZE_EQUAL_TO_END_SIZE: number;
/** !#en The starting radius of the particle is equal to the ending radius.
!#zh 表示粒子的起始半径等于结束半径。 */
static START_RADIUS_EQUAL_TO_END_RADIUS: number;
/**
!#en Add a particle to the emitter.
!#zh 添加一个粒子到发射器中。
*/
addParticle(): boolean;
/**
!#en Stop emitting particles. Running particles will continue to run until they die.
!#zh 停止发射器发射粒子，发射出去的粒子将继续运行，直至粒子生命结束。
@example
```js
// stop particle system.
myParticleSystem.stopSystem();
```
*/
stopSystem(): void;
/**
!#en Kill all living particles.
!#zh 杀死所有存在的粒子，然后重新启动粒子发射器。
@example
```js
// play particle system.
myParticleSystem.resetSystem();
```
*/
resetSystem(): void;
/**
!#en Whether or not the system is full.
!#zh 发射器中粒子是否大于等于设置的总粒子数量。
*/
isFull(): boolean;
/**
!#en
Sets a new CCSpriteFrame as particle.
WARNING: this method is experimental. Use setTextureWithRect instead.
!#zh
设置一个新的精灵帧为粒子。
警告：这个函数只是试验，请使用 setTextureWithRect 实现。
@param spriteFrame spriteFrame
*/
setDisplayFrame(spriteFrame: SpriteFrame): void;
/**
!#en Sets a new texture with a rect. The rect is in texture position and size.
!#zh 设置一张新贴图和关联的矩形。
@param texture texture
@param rect rect
*/
setTextureWithRect(texture: Texture2D, rect: Rect): void;
}
/** !#en
ATTENTION: USE cc.director INSTEAD OF cc.Director.
cc.director is a singleton object which manage your game's logic flow.
Since the cc.director is a singleton, you don't need to call any constructor or create functions,
the standard way to use it is by calling:
- cc.director.methodName();
It creates and handle the main Window and manages how and when to execute the Scenes.
The cc.director is also responsible for:
- initializing the OpenGL context
- setting the OpenGL pixel format (default on is RGB565)
- setting the OpenGL buffer depth (default on is 0-bit)
- setting the color for clear screen (default one is BLACK)
- setting the projection (default one is 3D)
- setting the orientation (default one is Portrait)
The cc.director also sets the default OpenGL context:
- GL_TEXTURE_2D is enabled
- GL_VERTEX_ARRAY is enabled
- GL_COLOR_ARRAY is enabled
- GL_TEXTURE_COORD_ARRAY is enabled
cc.director also synchronizes timers with the refresh rate of the display.
Features and Limitations:
- Scheduled timers & drawing are synchronizes with the refresh rate of the display
- Only supports animation intervals of 1/60 1/30 & 1/15
!#zh
注意：用 cc.director 代替 cc.Director。
cc.director 一个管理你的游戏的逻辑流程的单例对象。
由于 cc.director 是一个单例，你不需要调用任何构造函数或创建函数，
使用它的标准方法是通过调用：
- cc.director.methodName();
它创建和处理主窗口并且管理什么时候执行场景。
cc.director 还负责：
- 初始化 OpenGL 环境。
- 设置OpenGL像素格式。(默认是 RGB565)
- 设置OpenGL缓冲区深度 (默认是 0-bit)
- 设置空白场景的颜色 (默认是 黑色)
- 设置投影 (默认是 3D)
- 设置方向 (默认是 Portrait)
cc.director 设置了 OpenGL 默认环境
- GL_TEXTURE_2D 启用。
- GL_VERTEX_ARRAY 启用。
- GL_COLOR_ARRAY 启用。
- GL_TEXTURE_COORD_ARRAY 启用。
cc.director 也同步定时器与显示器的刷新速率。
特点和局限性:
- 将计时器 & 渲染与显示器的刷新频率同步。
- 只支持动画的间隔 1/60 1/30 & 1/15。
*/
export class Director extends EventTarget {
/**
!#en
Converts an OpenGL coordinate to a view coordinate
Useful to convert node points to window points for calls such as glScissor
Implementation can be found in CCDirectorWebGL.
!#zh 将触摸点的 WebGL View 坐标转换为屏幕坐标。
@param glPoint glPoint
*/
convertToUI(glPoint: Vec2): Vec2;
/**
!#en
Returns the size of the WebGL view in points.
It takes into account any possible rotation (device orientation) of the window.
!#zh 获取视图的大小，以点为单位。
*/
getWinSize(): Size;
/**
!#en
Returns the size of the OpenGL view in pixels.
It takes into account any possible rotation (device orientation) of the window.
On Mac winSize and winSizeInPixels return the same value.
(The pixel here refers to the resource resolution. If you want to get the physics resolution of device, you need to use cc.view.getFrameSize())
!#zh
获取视图大小，以像素为单位（这里的像素指的是资源分辨率。
如果要获取屏幕物理分辨率，需要用 cc.view.getFrameSize()）
*/
getWinSizeInPixels(): Size;
/**
!#en Returns the visible size of the running scene.
!#zh 获取运行场景的可见大小。
*/
getVisibleSize(): Size;
/**
!#en Returns the visible origin of the running scene.
!#zh 获取视图在游戏内容中的坐标原点。
*/
getVisibleOrigin(): Vec2;
/**
!#en Pause the director's ticker, only involve the game logic execution.
It won't pause the rendering process nor the event manager.
If you want to pause the entier game including rendering, audio and event,
please use {{#crossLink "Game.pause"}}cc.game.pause{{/crossLink}}
!#zh 暂停正在运行的场景，该暂停只会停止游戏逻辑执行，但是不会停止渲染和 UI 响应。
如果想要更彻底得暂停游戏，包含渲染，音频和事件，请使用 {{#crossLink "Game.pause"}}cc.game.pause{{/crossLink}}。
*/
pause(): void;
/**
!#en
Run a scene. Replaces the running scene with a new one or enter the first scene.
The new scene will be launched immediately.
!#zh 立刻切换指定场景。
@param scene The need run scene.
@param onBeforeLoadScene The function invoked at the scene before loading.
@param onLaunched The function invoked at the scene after launch.
*/
runSceneImmediate(scene: Scene, onBeforeLoadScene?: Function, onLaunched?: Function): void;
/**
!#en Loads the scene by its name.
!#zh 通过场景名称进行加载场景。
@param sceneName The name of the scene to load.
@param onLaunched callback, will be called after scene launched.
*/
loadScene(sceneName: string, onLaunched?: Function): boolean;
/**
!#en
Preloads the scene to reduces loading time. You can call this method at any time you want.
After calling this method, you still need to launch the scene by `cc.director.loadScene`.
It will be totally fine to call `cc.director.loadScene` at any time even if the preloading is not
yet finished, the scene will be launched after loaded automatically.
!#zh 预加载场景，你可以在任何时候调用这个方法。
调用完后，你仍然需要通过 `cc.director.loadScene` 来启动场景，因为这个方法不会执行场景加载操作。
就算预加载还没完成，你也可以直接调用 `cc.director.loadScene`，加载完成后场景就会启动。
@param sceneName The name of the scene to preload.
@param onLoaded callback, will be called after scene loaded.
*/
preloadScene(sceneName: string, onLoaded?: (error: Error) => void): void;
/**
!#en Resume game logic execution after pause, if the current scene is not paused, nothing will happen.
!#zh 恢复暂停场景的游戏逻辑，如果当前场景没有暂停将没任何事情发生。
*/
resume(): void;
/**
!#en
Enables or disables WebGL depth test.
Implementation can be found in CCDirectorCanvas.js/CCDirectorWebGL.js
!#zh 启用/禁用深度测试（在 Canvas 渲染模式下不会生效）。
@param on on
*/
setDepthTest(on: boolean): void;
/**
!#en
Set color for clear screen.
(Implementation can be found in CCDirectorCanvas.js/CCDirectorWebGL.js)
!#zh
设置场景的默认擦除颜色。
支持全透明，但不支持透明度为中间值。要支持全透明需手工开启 cc.macro.ENABLE_TRANSPARENT_CANVAS。
@param clearColor clearColor
*/
setClearColor(clearColor: Color): void;
/**
!#en
Sets an OpenGL projection.
Implementation can be found in CCDirectorCanvas.js/CCDirectorWebGL.js.
!#zh 设置 OpenGL 投影。
@param projection projection
*/
setProjection(projection: number): void;
/**
!#en
Update the view port.
Implementation can be found in CCDirectorCanvas.js/CCDirectorWebGL.js.
!#zh 设置视窗（请不要主动调用这个接口，除非你知道你在做什么）。
*/
setViewport(): void;
/**
!#en
Sets an OpenGL projection.
Implementation can be found in CCDirectorCanvas.js/CCDirectorWebGL.js.
!#zh 获取 OpenGL 投影。
*/
getProjection(): number;
/**
!#en
Enables/disables OpenGL alpha blending.
Implementation can be found in CCDirectorCanvas.js/CCDirectorWebGL.js.
!#zh 启用/禁用 透明度融合。
@param on on
*/
setAlphaBlending(on: boolean): void;
/**
!#en
Returns whether or not the replaced scene will receive the cleanup message.
If the new scene is pushed, then the old scene won't receive the "cleanup" message.
If the new scene replaces the old one, the it will receive the "cleanup" message.
!#zh
更换场景时是否接收清理消息。
如果新场景是采用 push 方式进入的，那么旧的场景将不会接收到 “cleanup” 消息。
如果新场景取代旧的场景，它将会接收到 “cleanup” 消息。
*/
isSendCleanupToScene(): boolean;
/**
!#en Returns current logic Scene.
!#zh 获取当前逻辑场景。
@example
```js
// This will help you to get the Canvas node in scene
cc.director.getScene().getChildByName('Canvas');
```
*/
getScene(): Scene;
/**
!#en Returns the FPS value.
!#zh 获取单位帧执行时间。
*/
getAnimationInterval(): number;
/**
!#en Returns whether or not to display the FPS informations.
!#zh 获取是否显示 FPS 信息。
*/
isDisplayStats(): boolean;
/**
!#en Sets whether display the FPS on the bottom-left corner.
!#zh 设置是否在左下角显示 FPS。
@param displayStats displayStats
*/
setDisplayStats(displayStats: boolean): void;
/**
!#en Returns whether next delta time equals to zero.
!#zh 返回下一个 “delta time” 是否等于零。
*/
isNextDeltaTimeZero(): boolean;
/**
!#en Returns whether or not the Director is paused.
!#zh 是否处于暂停状态。
*/
isPaused(): boolean;
/**
!#en Returns how many frames were called since the director started.
!#zh 获取 director 启动以来游戏运行的总帧数。
*/
getTotalFrames(): number;
/**
!#en Returns the cc.Scheduler associated with this director.
!#zh 获取和 director 相关联的 cc.Scheduler。
*/
getScheduler(): Scheduler;
/**
!#en Sets the cc.Scheduler associated with this director.
!#zh 设置和 director 相关联的 cc.Scheduler。
@param scheduler scheduler
*/
setScheduler(scheduler: Scheduler): void;
/**
!#en Returns the cc.ActionManager associated with this director.
!#zh 获取和 director 相关联的 cc.ActionManager（动作管理器）。
*/
getActionManager(): ActionManager;
/**
!#en Sets the cc.ActionManager associated with this director.
!#zh 设置和 director 相关联的 cc.ActionManager（动作管理器）。
@param actionManager actionManager
*/
setActionManager(actionManager: ActionManager): void;
/**
Returns the cc.CollisionManager associated with this director.
*/
getCollisionManager(): CollisionManager;
/**
Returns the cc.PhysicsManager associated with this director.
*/
getPhysicsManager(): PhysicsManager;
/**
!#en Returns the delta time since last frame.
!#zh 获取上一帧的 “delta time”。
*/
getDeltaTime(): number;
/** !#en The event projection changed of cc.Director.
!#zh cc.Director 投影变化的事件。 */
static EVENT_PROJECTION_CHANGED: string;
/** !#en The event which will be triggered before loading a new scene.
!#zh 加载新场景之前所触发的事件。 */
static EVENT_BEFORE_SCENE_LOADING: string;
/** !#en The event which will be triggered before launching a new scene.
!#zh 运行新场景之前所触发的事件。 */
static EVENT_BEFORE_SCENE_LAUNCH: string;
/** !#en The event which will be triggered after launching a new scene.
!#zh 运行新场景之后所触发的事件。 */
static EVENT_AFTER_SCENE_LAUNCH: string;
/** !#en The event which will be triggered at the beginning of every frame.
!#zh 每个帧的开始时所触发的事件。 */
static EVENT_BEFORE_UPDATE: string;
/** !#en The event which will be triggered after engine and components update logic.
!#zh 将在引擎和组件 “update” 逻辑之后所触发的事件。 */
static EVENT_AFTER_UPDATE: string;
/** !#en The event which will be triggered before visiting the rendering scene graph.
!#zh 访问渲染场景树之前所触发的事件。 */
static EVENT_BEFORE_VISIT: string;
/** !#en
The event which will be triggered after visiting the rendering scene graph,
the render queue is ready but not rendered at this point.
!#zh
访问渲染场景图之后所触发的事件，渲染队列已准备就绪，但在这一时刻还没有呈现在画布上。 */
static EVENT_AFTER_VISIT: string;
/** !#en The event which will be triggered after the rendering process.
!#zh 渲染过程之后所触发的事件。 */
static EVENT_AFTER_DRAW: string;
/** Constant for 2D projection (orthogonal projection) */
static PROJECTION_2D: number;
/** Constant for 3D projection with a fovy=60, znear=0.5f and zfar=1500. */
static PROJECTION_3D: number;
/** Constant for custom projection, if cc.Director's projection set to it, it calls "updateProjection" on the projection delegate. */
static PROJECTION_CUSTOM: number;
/** Constant for default projection of cc.Director, default projection is 2D projection */
static PROJECTION_DEFAULT: number;
}
/** !#en cc.game is the singleton object for game related functions.
!#zh cc.game 是 Game 的实例，用来驱动整个游戏。 */
export class Game extends EventTarget {
/** !#en Event triggered when game hide to background.
Please note that this event is not 100% guaranteed to be fired on Web platform,
on native platforms, it corresponds to enter background event, os status bar or notification center may not trigger this event.
!#zh 游戏进入后台时触发的事件。
请注意，在 WEB 平台，这个事件不一定会 100% 触发，这完全取决于浏览器的回调行为。
在原生平台，它对应的是应用被切换到后台事件，下拉菜单和上拉状态栏等不一定会触发这个事件，这取决于系统行为。 */
EVENT_HIDE: string;
/** Event triggered when game back to foreground
Please note that this event is not 100% guaranteed to be fired on Web platform,
on native platforms, it corresponds to enter foreground event.
!#zh 游戏进入前台运行时触发的事件。
请注意，在 WEB 平台，这个事件不一定会 100% 触发，这完全取决于浏览器的回调行为。
在原生平台，它对应的是应用被切换到前台事件。 */
EVENT_SHOW: string;
/** Event triggered after game inited, at this point all engine objects and game scripts are loaded */
EVENT_GAME_INITED: string;
/** Event triggered after renderer inited, at this point you will be able to use the render context */
EVENT_RENDERER_INITED: string;
/** Key of config */
CONFIG_KEY: any;
/** !#en The outer frame of the game canvas, parent of cc.container.
!#zh 游戏画布的外框，cc.container 的父类。 */
frame: any;
/** !#en The container of game canvas, equals to cc.container.
!#zh 游戏画布的容器。 */
container: HTMLDivElement;
/** !#en The canvas of the game, equals to cc._canvas.
!#zh 游戏的画布。 */
canvas: HTMLCanvasElement;
/** !#en
The current game configuration, including:
1. debugMode
"debugMode" possible values :
0 - No message will be printed.
1 - cc.error, cc.assert, cc.warn, cc.log will print in console.
2 - cc.error, cc.assert, cc.warn will print in console.
3 - cc.error, cc.assert will print in console.
4 - cc.error, cc.assert, cc.warn, cc.log will print on canvas, available only on web.
5 - cc.error, cc.assert, cc.warn will print on canvas, available only on web.
6 - cc.error, cc.assert will print on canvas, available only on web.
2. showFPS
Left bottom corner fps information will show when "showFPS" equals true, otherwise it will be hide.
3. exposeClassName
Expose class name to chrome debug tools, the class intantiate performance is a little bit slower when exposed.
4. frameRate
"frameRate" set the wanted frame rate for your game, but the real fps depends on your game implementation and the running environment.
5. id
"gameCanvas" sets the id of your canvas element on the web page, it's useful only on web.
6. renderMode
"renderMode" sets the renderer type, only useful on web :
0 - Automatically chosen by engine
1 - Forced to use canvas renderer
2 - Forced to use WebGL renderer, but this will be ignored on mobile browsers
7. scenes
"scenes" include available scenes in the current bundle.
Please DO NOT modify this object directly, it won't have any effect.
!#zh
当前的游戏配置，包括：
1. debugMode（debug 模式，但是在浏览器中这个选项会被忽略）
"debugMode" 各种设置选项的意义。
0 - 没有消息被打印出来。
1 - cc.error，cc.assert，cc.warn，cc.log 将打印在 console 中。
2 - cc.error，cc.assert，cc.warn 将打印在 console 中。
3 - cc.error，cc.assert 将打印在 console 中。
4 - cc.error，cc.assert，cc.warn，cc.log 将打印在 canvas 中（仅适用于 web 端）。
5 - cc.error，cc.assert，cc.warn 将打印在 canvas 中（仅适用于 web 端）。
6 - cc.error，cc.assert 将打印在 canvas 中（仅适用于 web 端）。
2. showFPS（显示 FPS）
当 showFPS 为 true 的时候界面的左下角将显示 fps 的信息，否则被隐藏。
3. exposeClassName
暴露类名让 Chrome DevTools 可以识别，如果开启会稍稍降低类的创建过程的性能，但对对象构造没有影响。
4. frameRate (帧率)
“frameRate” 设置想要的帧率你的游戏，但真正的FPS取决于你的游戏实现和运行环境。
5. id
"gameCanvas" Web 页面上的 Canvas Element ID，仅适用于 web 端。
6. renderMode（渲染模式）
“renderMode” 设置渲染器类型，仅适用于 web 端：
0 - 通过引擎自动选择。
1 - 强制使用 canvas 渲染。
2 - 强制使用 WebGL 渲染，但是在部分 Android 浏览器中这个选项会被忽略。
7. scenes
“scenes” 当前包中可用场景。
注意：请不要直接修改这个对象，它不会有任何效果。 */
config: any;
/**
!#en Callback when the scripts of engine have been load.
!#zh 当引擎完成启动后的回调函数。
*/
onStart(): void;
/**
!#en Set frameRate of game.
!#zh 设置游戏帧率。
@param frameRate frameRate
*/
setFrameRate(frameRate: number): void;
/**
!#en Run the game frame by frame.
!#zh 执行一帧游戏循环。
*/
step(): void;
/**
!#en Pause the game main loop. This will pause:
game logic execution, rendering process, event manager, background music and all audio effects.
This is different with cc.director.pause which only pause the game logic execution.
!#zh 暂停游戏主循环。包含：游戏逻辑，渲染，事件处理，背景音乐和所有音效。这点和只暂停游戏逻辑的 cc.director.pause 不同。
*/
pause(): void;
/**
!#en Resume the game from pause. This will resume:
game logic execution, rendering process, event manager, background music and all audio effects.
!#zh 恢复游戏主循环。包含：游戏逻辑，渲染，事件处理，背景音乐和所有音效。
*/
resume(): void;
/**
!#en Check whether the game is paused.
!#zh 判断游戏是否暂停。
*/
isPaused(): boolean;
/**
!#en Restart game.
!#zh 重新开始游戏
*/
restart(): void;
/**
!#en End game, it will close the game window
!#zh 退出游戏
*/
end(): void;
/**
!#en Prepare game.
!#zh 准备引擎，请不要直接调用这个函数。
@param cb cb
*/
prepare(cb: Function): void;
/**
!#en Run game with configuration object and onStart function.
!#zh 运行游戏，并且指定引擎配置和 onStart 的回调。
@param config Pass configuration object or onStart function
@param onStart function to be executed after game initialized
*/
run(config?: any|Function, onStart?: Function): void;
/**
!#en
Add a persistent root node to the game, the persistent node won't be destroyed during scene transition.
The target node must be placed in the root level of hierarchy, otherwise this API won't have any effect.
!#zh
声明常驻根节点，该节点不会被在场景切换中被销毁。
目标节点必须位于为层级的根节点，否则无效。
@param node The node to be made persistent
*/
addPersistRootNode(node: Node): void;
/**
!#en Remove a persistent root node.
!#zh 取消常驻根节点。
@param node The node to be removed from persistent node list
*/
removePersistRootNode(node: Node): void;
/**
!#en Check whether the node is a persistent root node.
!#zh 检查节点是否是常驻根节点。
@param node The node to be checked
*/
isPersistRootNode(node: Node): boolean;
}
/** !#en
Class of all entities in Cocos Creator scenes.
Node also inherits from {{#crossLink "EventTarget"}}Event Target{{/crossLink}}, it permits Node to dispatch events.
For events supported by Node, please refer to {{#crossLink "Node.EventType"}}{{/crossLink}}
!#zh
Cocos Creator 场景中的所有节点类。节点也继承了 {{#crossLink "EventTarget"}}EventTarget{{/crossLink}}，它允许节点发送事件。
支持的节点事件，请参阅 {{#crossLink "Node.EventType"}}{{/crossLink}}。 */
export class Node extends _BaseNode {
/** !#en
Group index of node.
Which Group this node belongs to will resolve that this node's collision components can collide with which other collision componentns.
!#zh
节点的分组索引。
节点的分组将关系到节点的碰撞组件可以与哪些碰撞组件相碰撞。
*/
groupIndex: number;
/** !#en
Group of node.
Which Group this node belongs to will resolve that this node's collision components can collide with which other collision componentns.
!#zh
节点的分组。
节点的分组将关系到节点的碰撞组件可以与哪些碰撞组件相碰撞。
*/
group: string;
/** !#en The position (x, y) of the node in its parent's coordinates.
!#zh 节点在父节点坐标系中的位置（x, y）。 */
position: Vec2;
/** !#en x axis position of node.
!#zh 节点 X 轴坐标。 */
x: number;
/** !#en y axis position of node.
!#zh 节点 Y 轴坐标。 */
y: number;
/** !#en Rotation of node.
!#zh 该节点旋转角度。 */
rotation: number;
/** !#en Rotation on x axis.
!#zh 该节点 X 轴旋转角度。 */
rotationX: number;
/** !#en Rotation on y axis.
!#zh 该节点 Y 轴旋转角度。 */
rotationY: number;
/** !#en Scale on x axis.
!#zh 节点 X 轴缩放。 */
scaleX: number;
/** !#en Scale on y axis.
!#zh 节点 Y 轴缩放。 */
scaleY: number;
/** !#en Skew x
!#zh 该节点 Y 轴倾斜角度。 */
skewX: number;
/** !#en Skew y
!#zh 该节点 X 轴倾斜角度。 */
skewY: number;
/** !#en Opacity of node, default value is 255.
!#zh 节点透明度，默认值为 255。 */
opacity: number;
/** !#en Indicate whether node's opacity value affect its child nodes, default value is true.
!#zh 节点的不透明度值是否影响其子节点，默认值为 true。 */
cascadeOpacity: boolean;
/** !#en Color of node, default value is white: (255, 255, 255).
!#zh 节点颜色。默认为白色，数值为：（255，255，255）。 */
color: Color;
/** !#en Anchor point's position on x axis.
!#zh 节点 X 轴锚点位置。 */
anchorX: number;
/** !#en Anchor point's position on y axis.
!#zh 节点 Y 轴锚点位置。 */
anchorY: number;
/** !#en Width of node.
!#zh 节点宽度。 */
width: number;
/** !#en Height of node.
!#zh 节点高度。 */
height: number;
/** !#en Z order in depth which stands for the drawing order.
!#zh 该节点渲染排序的 Z 轴深度。 */
zIndex: number;
/**
@param name name
*/
constructor(name?: string);
/**
!#en
Register a callback of a specific event type on Node.
Use this method to register touch or mouse event permit propagation based on scene graph,
you can propagate the event to the parents or swallow it by calling stopPropagation on the event.
It's the recommended way to register touch/mouse event for Node,
please do not use cc.eventManager directly for Node.
!#zh
在节点上注册指定类型的回调函数，也可以设置 target 用于绑定响应函数的 this 对象。
同时您可以将事件派发到父节点或者通过调用 stopPropagation 拦截它。
推荐使用这种方式来监听节点上的触摸或鼠标事件，请不要在节点上直接使用 cc.eventManager。
@param type A string representing the event type to listen for.
See {{#crossLink "Node/position-changed:event"}}Node Events{{/crossLink}} for all builtin events.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
this.node.on(cc.Node.EventType.TOUCH_START, this.memberFunction, this); // if "this" is component and the "memberFunction" declared in CCClass.
node.on(cc.Node.EventType.TOUCH_START, callback, this.node);
node.on(cc.Node.EventType.TOUCH_MOVE, callback, this.node);
node.on(cc.Node.EventType.TOUCH_END, callback, this.node);
node.on(cc.Node.EventType.TOUCH_CANCEL, callback, this.node);
node.on("anchor-changed", callback, this);
```
*/
on(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
on(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Removes the callback previously registered with the same type, callback, target and or useCapture.
This method is merely an alias to removeEventListener.
!#zh 删除之前与同类型，回调，目标或 useCapture 注册的回调。
@param type A string representing the event type being removed.
@param callback The callback to remove.
@param target The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
@param useCapture Specifies whether the callback being removed was registered as a capturing callback or not.
If not specified, useCapture defaults to false. If a callback was registered twice,
one with capture and one without, each must be removed separately. Removal of a capturing callback
does not affect a non-capturing version of the same listener, and vice versa.
@example
```js
this.node.off(cc.Node.EventType.TOUCH_START, this.memberFunction, this);
node.off(cc.Node.EventType.TOUCH_START, callback, this.node);
node.off("anchor-changed", callback, this);
```
*/
off(type: string, callback: Function, target?: any, useCapture?: boolean): void;
/**
!#en Removes all callbacks previously registered with the same target.
!#zh 移除目标上的所有注册事件。
@param target The target to be searched for all related callbacks
@example
```js
node.targetOff(target);
```
*/
targetOff(target: any): void;
/**
!#en Pause node related system events registered with the current Node. Node system events includes touch and mouse events.
If recursive is set to true, then this API will pause the node system events for the node and all nodes in its sub node tree.
Reference: http://cocos2d-x.org/docs/editors_and_tools/creator-chapters/scripting/internal-events/
!#zh 暂停当前节点上注册的所有节点系统事件，节点系统事件包含触摸和鼠标事件。
如果传递 recursive 为 true，那么这个 API 将暂停本节点和它的子树上所有节点的节点系统事件。
参考：http://cocos.com/docs/creator/scripting/internal-events.html
@param recursive Whether to pause node system events on the sub node tree.
@example
```js
node.pauseSystemEvents(true);
```
*/
pauseSystemEvents(recursive: boolean): void;
/**
!#en Resume node related system events registered with the current Node. Node system events includes touch and mouse events.
If recursive is set to true, then this API will resume the node system events for the node and all nodes in its sub node tree.
Reference: http://cocos2d-x.org/docs/editors_and_tools/creator-chapters/scripting/internal-events/
!#zh 恢复当前节点上注册的所有节点系统事件，节点系统事件包含触摸和鼠标事件。
如果传递 recursive 为 true，那么这个 API 将恢复本节点和它的子树上所有节点的节点系统事件。
参考：http://cocos.com/docs/creator/scripting/internal-events.html
@param recursive Whether to resume node system events on the sub node tree.
@example
```js
node.resumeSystemEvents(true);
```
*/
resumeSystemEvents(recursive: boolean): void;
/**
!#en
Executes an action, and returns the action that is executed.
The node becomes the action's target. Refer to cc.Action's getTarget()
Calling runAction while the node is not active won't have any effect.
Note：You shouldn't modify the action after runAction, that won't take any effect.
if you want to modify, when you define action plus.
!#zh
执行并返回该执行的动作。该节点将会变成动作的目标。
调用 runAction 时，节点自身处于不激活状态将不会有任何效果。
注意：你不应该修改 runAction 后的动作，将无法发挥作用，如果想进行修改，请在定义 action 时加入。
@param action action
@example
```js
var action = cc.scaleTo(0.2, 1, 0.6);
node.runAction(action);
node.runAction(action).repeatForever(); // fail
node.runAction(action.repeatForever()); // right
```
*/
runAction(action: Action): Action;
/**
!#en Pause all actions running on the current node. Equals to `cc.director.getActionManager().pauseTarget(node)`.
!#zh 暂停本节点上所有正在运行的动作。和 `cc.director.getActionManager().pauseTarget(node);` 等价。
@example
```js
node.pauseAllActions();
```
*/
pauseAllActions(): void;
/**
!#en Resume all paused actions on the current node. Equals to `cc.director.getActionManager().resumeTarget(node)`.
!#zh 恢复运行本节点上所有暂停的动作。和 `cc.director.getActionManager().resumeTarget(node);` 等价。
@example
```js
node.resumeAllActions();
```
*/
resumeAllActions(): void;
/**
!#en Stops and removes all actions from the running action list .
!#zh 停止并且移除所有正在运行的动作列表。
@example
```js
node.stopAllActions();
```
*/
stopAllActions(): void;
/**
!#en Stops and removes an action from the running action list.
!#zh 停止并移除指定的动作。
@param action An action object to be removed.
@example
```js
var action = cc.scaleTo(0.2, 1, 0.6);
node.stopAction(action);
```
*/
stopAction(action: Action): void;
/**
!#en Removes an action from the running action list by its tag.
!#zh 停止并且移除指定标签的动作。
@param tag A tag that indicates the action to be removed.
@example
```js
node.stopAction(1);
```
*/
stopActionByTag(tag: number): void;
/**
!#en Returns an action from the running action list by its tag.
!#zh 通过标签获取指定动作。
@param tag tag
@example
```js
var action = node.getActionByTag(1);
```
*/
getActionByTag(tag: number): Action;
/**
!#en
Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays).
Composable actions are counted as 1 action. Example:
If you are running 1 Sequence of 7 actions, it will return 1.
If you are running 7 Sequences of 2 actions, it will return 7.
!#zh
获取运行着的动作加上正在调度运行的动作的总数。
例如：
- 如果你正在运行 7 个动作中的 1 个 Sequence，它将返回 1。
- 如果你正在运行 2 个动作中的 7 个 Sequence，它将返回 7。
@example
```js
var count = node.getNumberOfRunningActions();
cc.log("Running Action Count: " + count);
```
*/
getNumberOfRunningActions(): number;
/**
!#en Returns a copy of the position (x, y) of the node in its parent's coordinates.
!#zh 获取节点在父节点坐标系中的位置（x, y）。
@example
```js
cc.log("Node Position: " + node.getPosition());
```
*/
getPosition(): Vec2;
/**
!#en
Sets the position (x, y) of the node in its parent's coordinates.
Usually we use cc.v2(x, y) to compose cc.Vec2 object.
and Passing two numbers (x, y) is more efficient than passing cc.Vec2 object.
!#zh
设置节点在父节点坐标系中的位置。
可以通过两种方式设置坐标点：
1. 传入 2 个数值 x 和 y。
2. 传入 cc.v2(x, y) 类型为 cc.Vec2 的对象。
@param newPosOrX X coordinate for position or the position (x, y) of the node in coordinates
@param y Y coordinate for position
@example
```js
node.setPosition(cc.v2(0, 0));
node.setPosition(0, 0);
```
*/
setPosition(newPosOrX: Vec2|number, y?: number): void;
/**
!#en
Returns the scale factor of the node.
Assertion will fail when _scaleX != _scaleY.
!#zh 获取节点的缩放。当 X 轴和 Y 轴有相同的缩放数值时。
@example
```js
cc.log("Node Scale: " + node.getScale());
```
*/
getScale(): number;
/**
!#en Sets the scale factor of the node. 1.0 is the default scale factor. This function can modify the X and Y scale at the same time.
!#zh 设置节点的缩放比例，默认值为 1.0。这个函数可以在同一时间修改 X 和 Y 缩放。
@param scaleX scaleX or scale
@param scaleY scaleY
@example
```js
node.setScale(cc.v2(1, 1));
node.setScale(1, 1);
```
*/
setScale(scaleX: number|Vec2, scaleY?: number): void;
/**
!#en
Returns a copy the untransformed size of the node.
The contentSize remains the same no matter the node is scaled or rotated.
All nodes has a size. Layer and Scene has the same size of the screen by default.
!#zh 获取节点自身大小，不受该节点是否被缩放或者旋转的影响。
@param ignoreSizeProvider true if you need to get the original size of the node
@example
```js
cc.log("Content Size: " + node.getContentSize());
```
*/
getContentSize(ignoreSizeProvider?: boolean): Size;
/**
!#en
Sets the untransformed size of the node.
The contentSize remains the same no matter the node is scaled or rotated.
All nodes has a size. Layer and Scene has the same size of the screen.
!#zh 设置节点原始大小，不受该节点是否被缩放或者旋转的影响。
@param size The untransformed size of the node or The untransformed size's width of the node.
@param height The untransformed size's height of the node.
@example
```js
node.setContentSize(cc.size(100, 100));
node.setContentSize(100, 100);
```
*/
setContentSize(size: Size|number, height?: number): void;
/**
!#en
Set whether color should be changed with the opacity value,
useless in ccsg.Node, but this function is override in some class to have such behavior.
!#zh 设置更改透明度时是否修改RGB值，
@param opacityValue opacityValue
@example
```js
node.setOpacityModifyRGB(true);
```
*/
setOpacityModifyRGB(opacityValue: boolean): void;
/**
!#en Get whether color should be changed with the opacity value.
!#zh 更改透明度时是否修改RGB值。
@example
```js
var hasChange = node.isOpacityModifyRGB();
```
*/
isOpacityModifyRGB(): boolean;
/**
!#en
Returns a copy of the anchor point.
Anchor point is the point around which all transformations and positioning manipulations take place.
It's like a pin in the node where it is "attached" to its parent.
The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner.
But you can use values higher than (1,1) and lower than (0,0) too.
The default anchor point is (0.5,0.5), so it starts at the center of the node.
!#zh
获取节点锚点，用百分比表示。
锚点应用于所有变换和坐标点的操作，它就像在节点上连接其父节点的大头针。
锚点是标准化的，就像百分比一样。(0，0) 表示左下角，(1，1) 表示右上角。
但是你可以使用比（1，1）更高的值或者比（0，0）更低的值。
默认的锚点是（0.5，0.5），因此它开始于节点的中心位置。
注意：Creator 中的锚点仅用于定位所在的节点，子节点的定位不受影响。
@example
```js
cc.log("Node AnchorPoint: " + node.getAnchorPoint());
```
*/
getAnchorPoint(): Vec2;
/**
!#en
Sets the anchor point in percent.
anchor point is the point around which all transformations and positioning manipulations take place.
It's like a pin in the node where it is "attached" to its parent.
The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner.
But you can use values higher than (1,1) and lower than (0,0) too.
The default anchor point is (0.5,0.5), so it starts at the center of the node.
!#zh
设置锚点的百分比。
锚点应用于所有变换和坐标点的操作，它就像在节点上连接其父节点的大头针。
锚点是标准化的，就像百分比一样。(0，0) 表示左下角，(1，1) 表示右上角。
但是你可以使用比（1，1）更高的值或者比（0，0）更低的值。
默认的锚点是（0.5，0.5），因此它开始于节点的中心位置。
注意：Creator 中的锚点仅用于定位所在的节点，子节点的定位不受影响。
@param point The anchor point of node or The x axis anchor of node.
@param y The y axis anchor of node.
@example
```js
node.setAnchorPoint(cc.v2(1, 1));
node.setAnchorPoint(1, 1);
```
*/
setAnchorPoint(point: Vec2|number, y?: number): void;
/**
!#en
Returns a copy of the anchor point in absolute pixels.
you can only read it. If you wish to modify it, use setAnchorPoint.
!#zh
返回锚点的绝对像素位置。
你只能读它。如果您要修改它，使用 setAnchorPoint。
@example
```js
cc.log("AnchorPointInPoints: " + node.getAnchorPointInPoints());
```
*/
getAnchorPointInPoints(): Vec2;
/**
!#en
Returns the displayed opacity of Node,
the difference between displayed opacity and opacity is that displayed opacity is calculated based on opacity and parent node's opacity when cascade opacity enabled.
!#zh
获取节点显示透明度，
显示透明度和透明度之间的不同之处在于当启用级连透明度时，
显示透明度是基于自身透明度和父节点透明度计算的。
@example
```js
var displayOpacity = node.getDisplayedOpacity();
```
*/
getDisplayedOpacity(): number;
/**
!#en
Returns the displayed color of Node,
the difference between displayed color and color is that displayed color is calculated based on color and parent node's color when cascade color enabled.
!#zh
获取节点的显示颜色，
显示颜色和颜色之间的不同之处在于当启用级连颜色时，
显示颜色是基于自身颜色和父节点颜色计算的。
@example
```js
var displayColor = node.getDisplayedColor();
```
*/
getDisplayedColor(): Color;
/**
!#en
Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.
The matrix is in Pixels.
This method is AR (Anchor Relative).
!#zh
返回这个将节点（局部）的空间坐标系转换成父节点的空间坐标系的矩阵。
这个矩阵以像素为单位。
该方法基于节点坐标。
@example
```js
var affineTransform = node.getNodeToParentTransformAR();
```
*/
getNodeToParentTransformAR(): AffineTransform;
/**
!#en
Returns a "local" axis aligned bounding box of the node.
The returned box is relative only to its parent.
!#zh 返回父节坐标系下的轴向对齐的包围盒。
@example
```js
var boundingBox = node.getBoundingBox();
```
*/
getBoundingBox(): Rect;
/**
!#en
Returns a "world" axis aligned bounding box of the node.
The bounding box contains self and active children's world bounding box.
!#zh
返回节点在世界坐标系下的对齐轴向的包围盒（AABB）。
该边框包含自身和已激活的子节点的世界边框。
@example
```js
var newRect = node.getBoundingBoxToWorld();
```
*/
getBoundingBoxToWorld(): Rect;
/**
!#en
Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.
The matrix is in Pixels.
!#zh 返回这个将节点（局部）的空间坐标系转换成父节点的空间坐标系的矩阵。这个矩阵以像素为单位。
@example
```js
var affineTransform = node.getNodeToParentTransform();
```
*/
getNodeToParentTransform(): AffineTransform;
/**
!#en Returns the world affine transform matrix. The matrix is in Pixels.
!#zh 返回节点到世界坐标系的仿射变换矩阵。矩阵单位是像素。
@example
```js
var affineTransform = node.getNodeToWorldTransform();
```
*/
getNodeToWorldTransform(): AffineTransform;
/**
!#en
Returns the world affine transform matrix. The matrix is in Pixels.
This method is AR (Anchor Relative).
!#zh
返回节点到世界坐标仿射变换矩阵。矩阵单位是像素。
该方法基于节点坐标。
@example
```js
var mat = node.getNodeToWorldTransformAR();
```
*/
getNodeToWorldTransformAR(): AffineTransform;
/**
!#en
Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates.
The matrix is in Pixels. The returned transform is readonly and cannot be changed.
!#zh
返回将父节点的坐标系转换成节点（局部）的空间坐标系的矩阵。
该矩阵以像素为单位。返回的矩阵是只读的，不能更改。
@example
```js
var affineTransform = node.getParentToNodeTransform();
```
*/
getParentToNodeTransform(): AffineTransform;
/**
!#en Returns the inverse world affine transform matrix. The matrix is in Pixels.
!#en 返回世界坐标系到节点坐标系的逆矩阵。
@example
```js
var affineTransform = node.getWorldToNodeTransform();
```
*/
getWorldToNodeTransform(): AffineTransform;
/**
!#en Converts a Point to node (local) space coordinates. The result is in Vec2.
!#zh 将一个点转换到节点 (局部) 坐标系。结果以 Vec2 为单位。
@param worldPoint worldPoint
@example
```js
var newVec2 = node.convertToNodeSpace(cc.v2(100, 100));
```
*/
convertToNodeSpace(worldPoint: Vec2): Vec2;
/**
!#en Converts a Point to world space coordinates. The result is in Points.
!#zh 将一个点转换到世界空间坐标系。结果以 Vec2 为单位。
@param nodePoint nodePoint
@example
```js
var newVec2 = node.convertToWorldSpace(cc.v2(100, 100));
```
*/
convertToWorldSpace(nodePoint: Vec2): Vec2;
/**
!#en
Converts a Point to node (local) space coordinates. The result is in Points.
treating the returned/received node point as anchor relative.
!#zh
将一个点转换到节点 (局部) 空间坐标系。结果以 Vec2 为单位。
返回值将基于节点坐标。
@param worldPoint worldPoint
@example
```js
var newVec2 = node.convertToNodeSpaceAR(cc.v2(100, 100));
```
*/
convertToNodeSpaceAR(worldPoint: Vec2): Vec2;
/**
!#en
Converts a local Point to world space coordinates.The result is in Points.
treating the returned/received node point as anchor relative.
!#zh
将一个点转换到世界空间坐标系。结果以 Vec2 为单位。
返回值将基于世界坐标。
@param nodePoint nodePoint
@example
```js
var newVec2 = node.convertToWorldSpaceAR(cc.v2(100, 100));
```
*/
convertToWorldSpaceAR(nodePoint: Vec2): Vec2;
/**
!#en convenience methods which take a cc.Touch instead of cc.Vec2.
!#zh 将触摸点转换成本地坐标系中位置。
@param touch The touch object
@example
```js
var newVec2 = node.convertTouchToNodeSpace(touch);
```
*/
convertTouchToNodeSpace(touch: Touch): Vec2;
/**
!#en converts a cc.Touch (world coordinates) into a local coordinate. This method is AR (Anchor Relative).
!#zh 转换一个 cc.Touch（世界坐标）到一个局部坐标，该方法基于节点坐标。
@param touch The touch object
@example
```js
var newVec2 = node.convertTouchToNodeSpaceAR(touch);
```
*/
convertTouchToNodeSpaceAR(touch: Touch): Vec2;
/**
!#en
Adds a child to the node with z order and tag.
!#zh
添加子节点，并且可以修改该节点的 局部 Z 顺序和标签。
@param child A child node
@param localZOrder Z order for drawing priority. Please refer to setZOrder(int)
@param tag An integer or a name to identify the node easily. Please refer to setTag(int) and setName(string)
@example
```js
node.addChild(newNode, 1, 1001);
```
*/
addChild(child: Node, localZOrder?: number, tag?: number|string): void;
/**
!#en Stops all running actions and schedulers.
!#zh 停止所有正在播放的动作和计时器。
@example
```js
node.cleanup();
```
*/
cleanup(): void;
/**
!#en Sorts the children array depends on children's zIndex and arrivalOrder,
normally you won't need to invoke this function.
!#zh 根据子节点的 zIndex 和 arrivalOrder 进行排序，正常情况下开发者不需要手动调用这个函数。
*/
sortAllChildren(): void;
/** !#en The local scale relative to the parent.
!#zh 节点相对父节点的缩放。 */
scale: number;
/**
!#en Returns the x axis position of the node in cocos2d coordinates.
!#zh 获取节点 X 轴坐标。
@example
```js
var posX = node.getPositionX();
```
*/
getPositionX(): number;
/**
!#en Sets the x axis position of the node in cocos2d coordinates.
!#zh 设置节点 X 轴坐标。
@param x x
@example
```js
node.setPositionX(1);
```
*/
setPositionX(x: number): void;
/**
!#en Returns the y axis position of the node in cocos2d coordinates.
!#zh 获取节点 Y 轴坐标。
@example
```js
var posY = node.getPositionY();
```
*/
getPositionY(): number;
/**
!#en Sets the y axis position of the node in cocos2d coordinates.
!#zh 设置节点 Y 轴坐标。
@param y The new position in y axis
@example
```js
node.setPositionY(100);
```
*/
setPositionY(y: number): void;
/**
!#en Returns the local Z order of this node.
!#zh 获取节点局部 Z 轴顺序。
@example
```js
var localZorder = node.getLocalZOrder();
```
*/
getLocalZOrder(): number;
/**
!#en
LocalZOrder is the 'key' used to sort the node relative to its siblings.
The Node's parent will sort all its children based ont the LocalZOrder value.
If two nodes have the same LocalZOrder, then the node that was added first to the children's array
will be in front of the other node in the array.
Also, the Scene Graph is traversed using the "In-Order" tree traversal algorithm ( http://en.wikipedia.org/wiki/Tree_traversal#In-order )
And Nodes that have LocalZOder values smaller than 0 are the "left" subtree
While Nodes with LocalZOder greater than 0 are the "right" subtree.
!#zh
LocalZOrder 是 “key” (关键)来分辨节点和它兄弟节点的相关性。
父节点将会通过 LocalZOrder 的值来分辨所有的子节点。
如果两个节点有同样的 LocalZOrder，那么先加入子节点数组的节点将会显示在后加入的节点的前面。
同样的，场景图使用 “In-Order（按顺序）” 遍历数算法来遍历
( http://en.wikipedia.org/wiki/Tree_traversal#In-order ) 并且拥有小于 0 的 LocalZOrder 的值的节点是 “ left ” 子树（左子树）
所以拥有大于 0 的 LocalZOrder 的值得节点是 “ right ”子树（右子树）。
@param localZOrder localZOrder
@example
```js
node.setLocalZOrder(1);
```
*/
setLocalZOrder(localZOrder: number): void;
/**
!#en Returns whether node's opacity value affect its child nodes.
!#zh 返回节点的不透明度值是否影响其子节点。
@example
```js
cc.log(node.isCascadeOpacityEnabled());
```
*/
isCascadeOpacityEnabled(): boolean;
/**
!#en Enable or disable cascade opacity, if cascade enabled, child nodes' opacity will be the multiplication of parent opacity and its own opacity.
!#zh 启用或禁用级连不透明度，如果级连启用，子节点的不透明度将是父不透明度乘上它自己的不透明度。
@param cascadeOpacityEnabled cascadeOpacityEnabled
@example
```js
node.setCascadeOpacityEnabled(true);
```
*/
setCascadeOpacityEnabled(cascadeOpacityEnabled: boolean): void;
}
/** !#en
cc.Scene is a subclass of cc.Node that is used only as an abstract concept.
cc.Scene and cc.Node are almost identical with the difference that users can not modify cc.Scene manually.
!#zh
cc.Scene 是 cc.Node 的子类，仅作为一个抽象的概念。
cc.Scene 和 cc.Node 有点不同，用户不应直接修改 cc.Scene。 */
export class Scene extends Node {
/** !#en Indicates whether all (directly or indirectly) static referenced assets of this scene are releasable by default after scene unloading.
!#zh 指示该场景中直接或间接静态引用到的所有资源是否默认在场景切换后自动释放。 */
autoReleaseAssets: boolean;
}
/** !#en
Scheduler is responsible of triggering the scheduled callbacks.
You should not use NSTimer. Instead use this class.
There are 2 different types of callbacks (selectors):
- update callback: the 'update' callback will be called every frame. You can customize the priority.
- custom callback: A custom callback will be called every frame, or with a custom interval of time
The 'custom selectors' should be avoided when possible. It is faster,
and consumes less memory to use the 'update callback'. *
!#zh
Scheduler 是负责触发回调函数的类。
通常情况下，建议使用 cc.director.getScheduler() 来获取系统定时器。
有两种不同类型的定时器：
- update 定时器：每一帧都会触发。您可以自定义优先级。
- 自定义定时器：自定义定时器可以每一帧或者自定义的时间间隔触发。
如果希望每帧都触发，应该使用 update 定时器，使用 update 定时器更快，而且消耗更少的内存。 */
export class Scheduler {
/**
!#en
Modifies the time of all scheduled callbacks.
You can use this property to create a 'slow motion' or 'fast forward' effect.
Default is 1.0. To create a 'slow motion' effect, use values below 1.0.
To create a 'fast forward' effect, use values higher than 1.0.
Note：It will affect EVERY scheduled selector / action.
!#zh
设置时间间隔的缩放比例。
您可以使用这个方法来创建一个 “slow motion（慢动作）” 或 “fast forward（快进）” 的效果。
默认是 1.0。要创建一个 “slow motion（慢动作）” 效果,使用值低于 1.0。
要使用 “fast forward（快进）” 效果，使用值大于 1.0。
注意：它影响该 Scheduler 下管理的所有定时器。
@param timeScale timeScale
*/
setTimeScale(timeScale: number): void;
/**
!#en Returns time scale of scheduler.
!#zh 获取时间间隔的缩放比例。
*/
getTimeScale(): number;
/**
!#en 'update' the scheduler. (You should NEVER call this method, unless you know what you are doing.)
!#zh update 调度函数。(不应该直接调用这个方法，除非完全了解这么做的结果)
@param dt delta time
*/
update(dt: number): void;
/**
!#en
The scheduled method will be called every 'interval' seconds.
If paused is YES, then it won't be called until it is resumed.
If 'interval' is 0, it will be called every frame, but if so, it recommended to use 'scheduleUpdateForTarget:' instead.
If the callback function is already scheduled, then only the interval parameter will be updated without re-scheduling it again.
repeat let the action be repeated repeat + 1 times, use cc.macro.REPEAT_FOREVER to let the action run continuously
delay is the amount of time the action will wait before it'll start
!#zh
指定回调函数，调用对象等信息来添加一个新的定时器。
当时间间隔达到指定值时，设置的回调函数将会被调用。
如果 paused 值为 true，那么直到 resume 被调用才开始计时。
如果 interval 值为 0，那么回调函数每一帧都会被调用，但如果是这样，
建议使用 scheduleUpdateForTarget 代替。
如果回调函数已经被定时器使用，那么只会更新之前定时器的时间间隔参数，不会设置新的定时器。
repeat 值可以让定时器触发 repeat + 1 次，使用 cc.macro.REPEAT_FOREVER
可以让定时器一直循环触发。
delay 值指定延迟时间，定时器会在延迟指定的时间之后开始计时。
@param target target
@param callback_fn callback_fn
@param interval interval
@param repeat repeat
@param delay delay
@param paused paused
@example
```js
//register a schedule to scheduler
var scheduler = cc.director.getScheduler();
scheduler.scheduleCallbackForTarget(this, function, interval, repeat, delay, !this._isRunning);
```
*/
scheduleCallbackForTarget(target: any, callback: Function, interval: number, repeat: number, delay: number, paused?: boolean): void;
scheduleCallbackForTarget(target: any, callback: Function, interval: number, paused?: boolean): void;
/**
!#en The schedule
!#zh 定时器
@param callback callback
@param target target
@param interval interval
@param repeat repeat
@param delay delay
@param paused paused
@example
```js
//register a schedule to scheduler
cc.director.getScheduler().schedule(callback, this, interval, !this._isRunning);
```
*/
schedule(callback: Function, target: any, interval: number, repeat: number, delay: number, paused?: boolean): void;
schedule(callback: Function, target: any, interval: number, paused?: boolean): void;
/**
!#en
Schedules the update callback for a given target,
the callback will be invoked every frame after schedule started.
!#zh
使用指定的优先级为指定的对象设置 update 定时器。
update 定时器每一帧都会被触发。优先级的值越低，定时器被触发的越早。
@param target target
@param priority priority
@param paused paused
@param updateFunc updateFunc
*/
scheduleUpdate(target: any, priority: number, paused: boolean, updateFunc: Function): void;
/**
!#en
Unschedules a callback for a callback and a given target.
If you want to unschedule the "update", use `unscheduleUpdate()`
!#zh
根据指定的回调函数和调用对象。
如果需要取消 update 定时器，请使用 unscheduleUpdate()。
@param callback The callback to be unscheduled
@param target The target bound to the callback.
*/
unschedule(callback: Function, target: any): void;
/**
!#en Unschedules the update callback for a given target.
!#zh 取消指定对象的 update 定时器。
@param target The target to be unscheduled.
*/
unscheduleUpdate(target: any): void;
/**
!#en
Unschedules all scheduled callbacks for a given target.
This also includes the "update" callback.
!#zh 取消指定对象的所有定时器，包括 update 定时器。
@param target The target to be unscheduled.
*/
unscheduleAllForTarget(target: any): void;
/**
!#en
Unschedules all scheduled callbacks from all targets including the system callbacks.
You should NEVER call this method, unless you know what you are doing.
!#zh
取消所有对象的所有定时器，包括系统定时器。
不用调用此函数，除非你确定你在做什么。
*/
unscheduleAll(): void;
/**
!#en
Unschedules all callbacks from all targets with a minimum priority.
You should only call this with `PRIORITY_NON_SYSTEM_MIN` or higher.
!#zh
取消所有优先级的值大于指定优先级的定时器。
你应该只取消优先级的值大于 PRIORITY_NON_SYSTEM_MIN 的定时器。
@param minPriority The minimum priority of selector to be unscheduled. Which means, all selectors which
priority is higher than minPriority will be unscheduled.
*/
unscheduleAllWithMinPriority(minPriority: number): void;
/**
!#en Checks whether a callback for a given target is scheduled.
!#zh 检查指定的回调函数和回调对象组合是否存在定时器。
@param callback The callback to check.
@param target The target of the callback.
*/
isScheduled(callback: Function, target: any): boolean;
/**
!#en
Pause all selectors from all targets.
You should NEVER call this method, unless you know what you are doing.
!#zh
暂停所有对象的所有定时器。
不要调用这个方法，除非你知道你正在做什么。
*/
pauseAllTargets(): void;
/**
!#en
Pause all selectors from all targets with a minimum priority.
You should only call this with kCCPriorityNonSystemMin or higher.
!#zh
暂停所有优先级的值大于指定优先级的定时器。
你应该只暂停优先级的值大于 PRIORITY_NON_SYSTEM_MIN 的定时器。
@param minPriority minPriority
*/
pauseAllTargetsWithMinPriority(minPriority: number): void;
/**
!#en
Resume selectors on a set of targets.
This can be useful for undoing a call to pauseAllCallbacks.
!#zh
恢复指定数组中所有对象的定时器。
这个函数是 pauseAllCallbacks 的逆操作。
@param targetsToResume targetsToResume
*/
resumeTargets(targetsToResume: any[]): void;
/**
!#en
Pauses the target.
All scheduled selectors/update for a given target won't be 'ticked' until the target is resumed.
If the target is not present, nothing happens.
!#zh
暂停指定对象的定时器。
指定对象的所有定时器都会被暂停。
如果指定的对象没有定时器，什么也不会发生。
@param target target
*/
pauseTarget(target: any): void;
/**
!#en
Resumes the target.
The 'target' will be unpaused, so all schedule selectors/update will be 'ticked' again.
If the target is not present, nothing happens.
!#zh
恢复指定对象的所有定时器。
指定对象的所有定时器将继续工作。
如果指定的对象没有定时器，什么也不会发生。
@param target target
*/
resumeTarget(target: any): void;
/**
!#en Returns whether or not the target is paused.
!#zh 返回指定对象的定时器是否暂停了。
@param target target
*/
isTargetPaused(target: any): boolean;
/**
!#en
Schedules the 'update' callback_fn for a given target with a given priority.
The 'update' callback_fn will be called every frame.
The lower the priority, the earlier it is called.
!#zh
为指定对象设置 update 定时器。
update 定时器每一帧都会被调用。
优先级的值越低，越早被调用。
@param target target
@param priority priority
@param paused paused
@example
```js
//register this object to scheduler
var scheduler = cc.director.getScheduler();
scheduler.scheduleUpdateForTarget(this, priority, !this._isRunning );
```
*/
scheduleUpdateForTarget(target: any, priority: number, paused: boolean): void;
/**
!#en
Unschedule a callback function for a given target.
If you want to unschedule the "update", use unscheduleUpdateForTarget.
!#zh
根据指定的回调函数和调用对象对象取消相应的定时器。
如果需要取消 update 定时器，请使用 unscheduleUpdateForTarget()。
@param target target
@param callback callback[Function] or key[String]
@example
```js
//unschedule a callback of target
var scheduler = cc.director.getScheduler();
scheduler.unscheduleCallbackForTarget(this, callback);
```
*/
unscheduleCallbackForTarget(target: any, callback: Function): void;
/**
!#en Unschedules the update callback function for a given target.
!#zh 取消指定对象的所有定时器。
@param target target
@example
```js
//unschedules the "update" method.
var scheduler = cc.director.getScheduler();
scheduler.unscheduleUpdateForTarget(this);
```
*/
unscheduleUpdateForTarget(target: any): void;
/**
!#en
Unschedules all function callbacks for a given target.
This also includes the "update" callback function.
!#zh 取消指定对象的所有定时器，包括 update 定时器。
@param target target
*/
unscheduleAllCallbacksForTarget(target: any): void;
/**
!#en
Unschedules all function callbacks from all targets.
You should NEVER call this method, unless you know what you are doing.
!#zh
取消所有对象的所有定时器。
不要调用这个方法，除非你知道你正在做什么。
*/
unscheduleAllCallbacks(): void;
/**
!#en
Unschedules all function callbacks from all targets with a minimum priority.
You should only call this with kCCPriorityNonSystemMin or higher.
!#zh
取消所有优先级的值大于指定优先级的所有对象的所有定时器。
你应该只暂停优先级的值大于 PRIORITY_NON_SYSTEM_MIN 的定时器。
@param minPriority minPriority
*/
unscheduleAllCallbacksWithMinPriority(minPriority: number): void;
/** !#en Priority level reserved for system services.
!#zh 系统服务的优先级。 */
static PRIORITY_SYSTEM: number;
/** !#en Minimum priority level for user scheduling.
!#zh 用户调度最低优先级。 */
static PRIORITY_NON_SYSTEM: number;
}
/** !#en Renders the TMX object.
!#zh 渲染 tmx object。 */
export class TMXObject {
/**
!#en Get the name of object
!#zh 获取对象的名称
*/
getObjectName(): string;
/**
!#en Get the property of object
!#zh 获取对象的属性
@param propertyName propertyName
*/
getProperty(propertyName: string): any;
/**
!#en Get the properties of object
!#zh 获取对象的属性
*/
getProperties(): any;
/**
!#en Set the object name
!#zh 设置对象名称
@param name name
*/
setObjectName(name: string): void;
/**
!#en Set the properties of the object
!#zh 设置对象的属性
@param props props
*/
setProperties(props: any): void;
}
/** !#en Renders a TMX Tile Map in the scene.
!#zh 在场景中渲染一个 tmx 格式的 Tile Map。 */
export class TiledMap extends Component {
/** !#en The TiledMap Asset.
!#zh TiledMap 资源。 */
tmxAsset: TiledMapAsset;
/**
!#en Gets the map size.
!#zh 获取地图大小。
@example
```js
var mapSize = tiledMap.getMapSize();
cc.log("Map Size: " + mapSize);
```
*/
getMapSize(): Size;
/**
!#en Set the map size.
!#zh 设置地图大小。
@param mapSize mapSize
@example
```js
tiledMap.setMapSize(new cc.size(960, 640));
```
*/
setMapSize(mapSize: Size): void;
/**
!#en Gets the tile size.
!#zh 获取地图背景中 tile 元素的大小。
@example
```js
var tileSize = tiledMap.getTileSize();
cc.log("Tile Size: " + tileSize);
```
*/
getTileSize(): Size;
/**
!#en Set the tile size.
!#zh 设置地图背景中 tile 元素的大小。
@param tileSize tileSize
@example
```js
tiledMap.setTileSize(new cc.size(10, 10));
```
*/
setTileSize(tileSize: Size): void;
/**
!#en map orientation.
!#zh 获取地图方向。
@example
```js
var mapOrientation = tiledMap.getMapOrientation();
cc.log("Map Orientation: " + mapOrientation);
```
*/
getMapOrientation(): number;
/**
!#en map orientation.
!#zh 设置地图方向。
@param orientation orientation
@example
```js
tiledMap.setMapOrientation(TiledMap.Orientation.ORTHO);
```
*/
setMapOrientation(orientation: TiledMap.Orientation): void;
/**
!#en object groups.
!#zh 获取所有的对象层。
@example
```js
var objGroups = titledMap.getObjectGroups();
for (var i = 0; i < objGroups.length; ++i) {
cc.log("obj: " + objGroups[i]);
}
```
*/
getObjectGroups(): TiledObjectGroup[];
/**
!#en Gets the map properties.
!#zh 获取地图的属性。
@example
```js
var properties = titledMap.getProperties();
for (var i = 0; i < properties.length; ++i) {
cc.log("Properties: " + properties[i]);
}
```
*/
getProperties(): any[];
/**
!#en Set the map properties.
!#zh 设置地图的属性。
@param properties properties
@example
```js
titledMap.setProperties(properties);
```
*/
setProperties(properties: any[]): void;
/**
!#en Return All layers array.
!#zh 返回包含所有 layer 的数组。
@example
```js
var layers = titledMap.allLayers();
for (var i = 0; i < layers.length; ++i) {
cc.log("Layers: " + layers[i]);
}
```
*/
allLayers(): TiledLayer[];
/**
!#en return the cc.TiledLayer for the specific layer.
!#zh 获取指定名称的 layer。
@param layerName layerName
@example
```js
var layer = titledMap.getLayer("Player");
cc.log(layer);
```
*/
getLayer(layerName: string): TiledLayer;
/**
!#en Return the TMXObjectGroup for the specific group.
!#zh 获取指定的 TMXObjectGroup。
@param groupName groupName
@example
```js
var group = titledMap.getObjectGroup("Players");
cc.log("ObjectGroup: " + group);
```
*/
getObjectGroup(groupName: string): TiledObjectGroup;
/**
!#en Return the value for the specific property name.
!#zh 通过属性名称，获取指定的属性。
@param propertyName propertyName
@example
```js
var property = titledMap.getProperty("info");
cc.log("Property: " + property);
```
*/
getProperty(propertyName: string): string;
/**
!#en Return properties dictionary for tile GID.
!#zh 通过 GID ，获取指定的属性。
@param GID GID
@example
```js
var properties = titledMap.getPropertiesForGID(GID);
cc.log("Properties: " + properties);
```
*/
getPropertiesForGID(GID: number): any;
}
/** !#en Render the TMX layer.
!#zh 渲染 TMX layer。 */
export class TiledLayer extends _SGComponent {
/**
!#en Gets the layer name.
!#zh 获取层的名称。
@example
```js
var layerName = tiledLayer.getLayerName();
cc.log(layerName);
```
*/
getLayerName(): string;
/**
!#en Set the layer name.
!#zh 设置层的名称
@param layerName layerName
@example
```js
tiledLayer.setLayerName("New Layer");
```
*/
SetLayerName(layerName: string): void;
/**
!#en Return the value for the specific property name.
!#zh 获取指定属性名的值。
@param propertyName propertyName
@example
```js
var property = tiledLayer.getProperty("info");
cc.log(property);
```
*/
getProperty(propertyName: string): any;
/**
!#en Returns the position in pixels of a given tile coordinate.
!#zh 获取指定 tile 的像素坐标。
@param pos position or x
@param y y
@example
```js
var pos = tiledLayer.getPositionAt(cc.v2(0, 0));
cc.log("Pos: " + pos);
var pos = tiledLayer.getPositionAt(0, 0);
cc.log("Pos: " + pos);
```
*/
getPositionAt(pos: Vec2|number, y?: number): Vec2;
/**
!#en Removes a tile at given tile coordinate.
!#zh 删除指定坐标上的 tile。
@param pos position or x
@param y y
@example
```js
tiledLayer.removeTileAt(cc.v2(0, 0));
tiledLayer.removeTileAt(0, 0);
```
*/
removeTileAt(pos: Vec2|number, y?: number): void;
/**
!#en
Sets the tile gid (gid = tile global id) at a given tile coordinate.
The Tile GID can be obtained by using the method "tileGIDAt" or by using the TMX editor . Tileset Mgr +1.
If a tile is already placed at that position, then it will be removed.
!#zh
设置给定坐标的 tile 的 gid (gid = tile 全局 id)，
tile 的 GID 可以使用方法 “tileGIDAt” 来获得。
如果一个 tile 已经放在那个位置，那么它将被删除。
@param gid gid
@param posOrX position or x
@param flagsOrY flags or y
@param flags flags
@example
```js
tiledLayer.setTileGID(1001, 10, 10, 1)
```
*/
setTileGID(gid: number, posOrX: Vec2|number, flagsOrY: number, flags?: number): void;
/**
!#en
Returns the tile gid at a given tile coordinate.
if it returns 0, it means that the tile is empty.
This method requires the the tile map has not been previously released (eg. don't call layer.releaseMap())
!#zh
通过给定的 tile 坐标、flags（可选）返回 tile 的 GID.
如果它返回 0，则表示该 tile 为空。
该方法要求 tile 地图之前没有被释放过(如：没有调用过layer.releaseMap()).
@param pos or x
@param y y
@example
```js
var tileGid = tiledLayer.getTileGIDAt(0, 0);
```
*/
getTileGIDAt(pos: Vec2|number, y?: number): number;
/**
!#en
Returns the tile (_ccsg.Sprite) at a given a tile coordinate.
The returned _ccsg.Sprite will be already added to the _ccsg.TMXLayer. Don't add it again.
The _ccsg.Sprite can be treated like any other _ccsg.Sprite: rotated, scaled, translated, opacity, color, etc.
You can remove either by calling:
- layer.removeChild(sprite, cleanup);
- or layer.removeTileAt(ccp(x,y));
!#zh
通过指定的 tile 坐标获取对应的 tile(Sprite)。 返回的 tile(Sprite) 应是已经添加到 TMXLayer，请不要重复添加。
这个 tile(Sprite) 如同其他的 Sprite 一样，可以旋转、缩放、翻转、透明化、设置颜色等。
你可以通过调用以下方法来对它进行删除:
1. layer.removeChild(sprite, cleanup);
2. 或 layer.removeTileAt(cc.v2(x,y));
@param pos or x
@param y y
@example
```js
var title = tiledLayer.getTileAt(100, 100);
cc.log(title);
```
*/
getTileAt(pos: Vec2|number, y?: number): _ccsg.Sprite;
/**
!#en
Dealloc the map that contains the tile position from memory.
Unless you want to know at runtime the tiles positions, you can safely call this method.
If you are going to call layer.getTileGIDAt() then, don't release the map.
!#zh
从内存中释放包含 tile 位置信息的地图。
除了在运行时想要知道 tiles 的位置信息外，你都可安全的调用此方法。
如果你之后还要调用 layer.tileGIDAt(), 请不要释放地图.
@example
```js
tiledLayer.releaseMap();
```
*/
releaseMap(): void;
/**
!#en Sets the untransformed size of the _ccsg.TMXLayer.
!#zh 设置未转换的 layer 大小。
@param size The untransformed size of the _ccsg.TMXLayer or The untransformed size's width of the TMXLayer.
@param height The untransformed size's height of the _ccsg.TMXLayer.
@example
```js
tiledLayer.setContentSize(100, 100);
```
*/
setContentSize(size: Size|number, height?: number): void;
/**
!#en Return texture of cc.SpriteBatchNode.
!#zh 获取纹理。
@example
```js
var texture = tiledLayer.getTexture();
cc.log("Texture: " + texture);
```
*/
getTexture(): Texture2D;
/**
!#en Set the texture of cc.SpriteBatchNode.
!#zh 设置纹理。
@param texture texture
@example
```js
tiledLayer.setTexture(texture);
```
*/
setTexture(texture: Texture2D): void;
/**
!#en Set the opacity of all tiles
!#zh 设置所有 Tile 的透明度
@param opacity opacity
@example
```js
tiledLayer.setTileOpacity(128);
```
*/
setTileOpacity(opacity: number): void;
/**
!#en Gets layer size.
!#zh 获得层大小。
@example
```js
var size = tiledLayer.getLayerSize();
cc.log("layer size: " + size);
```
*/
getLayerSize(): Size;
/**
!#en Set layer size.
!#zh 设置层大小。
@param layerSize layerSize
@example
```js
tiledLayer.setLayerSize(new cc.size(5, 5));
```
*/
setLayerSize(layerSize: Size): void;
/**
!#en Size of the map's tile (could be different from the tile's size).
!#zh 获取 tile 的大小( tile 的大小可能会有所不同)。
@example
```js
var mapTileSize = tiledLayer.getMapTileSize();
cc.log("MapTile size: " + mapTileSize);
```
*/
getMapTileSize(): Size;
/**
!#en Set the map tile size.
!#zh 设置 tile 的大小。
@param tileSize tileSize
@example
```js
tiledLayer.setMapTileSize(new cc.size(10, 10));
```
*/
setMapTileSize(tileSize: Size): void;
/**
!#en Pointer to the map of tiles.
!#zh 获取地图 tiles。
@example
```js
var tiles = tiledLayer.getTiles();
```
*/
getTiles(): any[];
/**
!#en Pointer to the map of tiles.
!#zh 设置地图 tiles
@param tiles tiles
@example
```js
tiledLayer.setTiles(tiles);
```
*/
setTiles(tiles: any[]): void;
/**
!#en Tile set information for the layer.
!#zh 获取 layer 的 Tileset 信息。
@example
```js
var tileset = tiledLayer.getTileSet();
```
*/
getTileSet(): TMXTilesetInfo;
/**
!#en Tile set information for the layer.
!#zh 设置 layer 的 Tileset 信息。
@param tileset tileset
@example
```js
tiledLayer.setTileSet(tileset);
```
*/
setTileSet(tileset: TMXTilesetInfo): void;
/**
!#en Layer orientation, which is the same as the map orientation.
!#zh 获取 Layer 方向(同地图方向)。
@example
```js
var orientation = tiledLayer.getLayerOrientation();
cc.log("Layer Orientation: " + orientation);
```
*/
getLayerOrientation(): number;
/**
!#en Layer orientation, which is the same as the map orientation.
!#zh 设置 Layer 方向(同地图方向)。
@param orientation orientation
@example
```js
tiledLayer.setLayerOrientation(TiledMap.Orientation.ORTHO);
```
*/
setLayerOrientation(orientation: TiledMap.Orientation): void;
/**
!#en properties from the layer. They can be added using Tiled.
!#zh 获取 layer 的属性，可以使用 Tiled 编辑器添加属性。
@example
```js
var properties = tiledLayer.getProperties();
cc.log("Properties: " + properties);
```
*/
getProperties(): any[];
/**
!#en properties from the layer. They can be added using Tiled.
!#zh 设置层属性。
@param properties properties
@example
```js
tiledLayer.setLayerOrientation(properties);
```
*/
setProperties(properties: any[]): void;
}
/** Class for tiled map asset handling. */
export class TiledMapAsset extends Asset {
}
/** !#en Renders the TMX object group.
!#zh 渲染 tmx object group。 */
export class TiledObjectGroup extends _SGComponent {
/**
!#en Offset position of child objects.
!#zh 获取子对象的偏移位置。
@example
```js
var offset = tMXObjectGroup.getPositionOffset();
```
*/
getPositionOffset(): Vec2;
/**
!#en Offset position of child objects.
!#zh 设置子对象的偏移位置。
@param offset offset
@example
```js
tMXObjectGroup.setPositionOffset(cc.v2(5, 5));
```
*/
setPositionOffset(offset: Vec2): void;
/**
!#en List of properties stored in a dictionary.
!#zh 以映射的形式获取属性列表。
@example
```js
var offset = tMXObjectGroup.getProperties();
```
*/
getProperties(): any;
/**
!#en Set the properties of the object group.
!#zh 设置属性列表。
@param Var Var
@example
```js
tMXObjectGroup.setProperties(obj);
```
*/
setProperties(Var: any): void;
/**
!#en Gets the Group name.
!#zh 获取组名称。
@example
```js
var groupName = tMXObjectGroup.getGroupName;
```
*/
getGroupName(): string;
/**
!#en Set the Group name.
!#zh 设置组名称。
@param groupName groupName
@example
```js
tMXObjectGroup.setGroupName("New Group");
```
*/
setGroupName(groupName: string): void;
/**
!#en
Return the object for the specific object name.
It will return the 1st object found on the array for the given name.
!#zh 获取指定的对象。
@param objectName objectName
@example
```js
var object = tMXObjectGroup.getObject("Group");
```
*/
getObject(objectName: string): any;
/**
!#en Gets the objects.
!#zh 获取对象数组。
@example
```js
var objects = tMXObjectGroup.getObjects();
```
*/
getObjects(): any[];
}
/** !#en
Attention: In creator, it's strongly not recommended to use cc.pool to manager cc.Node.
We provided {{#crossLink "NodePool"}}cc.NodePool{{/crossLink}} instead.
cc.pool is a singleton object serves as an object cache pool.
It can helps you to improve your game performance for objects which need frequent release and recreate operations
!#zh
首先请注意，在 Creator 中我们强烈不建议使用 cc.pool 来管理 cc.Node 节点对象，请使用 {{#crossLink "NodePool"}}cc.NodePool{{/crossLink}} 代替
因为 cc.pool 是面向类来设计的，而 cc.Node 中使用 Component 来进行组合，它的类永远都一样，实际却千差万别。
cc.pool 是一个单例对象，用作为对象缓存池。
它可以帮助您提高游戏性能，适用于优化对象的反复创建和销毁
*/
export class pool {
/**
!#en Put the obj in pool.
!#zh 加入对象到对象池中。
@param obj The need put in pool object.
@example
```js
---------------------------------
var sp = new _ccsg.Sprite("a.png");
this.addChild(sp);
cc.pool.putInPool(sp);
cc.pool.getFromPool(_ccsg.Sprite, "a.png");
```
*/
putInPool(obj: any): void;
/**
!#en Check if this kind of obj has already in pool.
!#zh 检查对象池中是否有指定对象的存在。
@param objClass The check object class.
*/
hasObject(objClass: any): boolean;
/**
!#en Remove the obj if you want to delete it.
!#zh 移除在对象池中指定的对象。
*/
removeObject(): void;
/**
!#en Get the obj from pool.
!#zh 获取对象池中的指定对象。
*/
getFromPool(): any;
/**
!#en Remove all objs in pool and reset the pool.
!#zh 移除对象池中的所有对象，并且重置对象池。
*/
drainAllPools(): void;
}
/** !#en
cc.NodePool is the cache pool designed for node type.
It can helps you to improve your game performance for objects which need frequent release and recreate operations
It's recommended to create cc.NodePool instances by node type, the type corresponds to node type in game design, not the class,
for example, a prefab is a specific node type.
When you create a node pool, you can pass a Component which contains `unuse`, `reuse` functions to control the content of node.
Some common use case is :
1. Bullets in game (die very soon, massive creation and recreation, no side effect on other objects)
2. Blocks in candy crash (massive creation and recreation)
etc...
!#zh
cc.NodePool 是用于管理节点对象的对象缓存池。
它可以帮助您提高游戏性能，适用于优化对象的反复创建和销毁
以前 cocos2d-x 中的 cc.pool 和新的节点事件注册系统不兼容，因此请使用 cc.NodePool 来代替。
新的 NodePool 需要实例化之后才能使用，每种不同的节点对象池需要一个不同的对象池实例，这里的种类对应于游戏中的节点设计，一个 prefab 相当于一个种类的节点。
在创建缓冲池时，可以传入一个包含 unuse, reuse 函数的组件类型用于节点的回收和复用逻辑。
一些常见的用例是：
1.在游戏中的子弹（死亡很快，频繁创建，对其他对象无副作用）
2.糖果粉碎传奇中的木块（频繁创建）。
等等.... */
export class NodePool {
/**
!#en
Constructor for creating a pool for a specific node template (usually a prefab). You can pass a component (type or name) argument for handling event for reusing and recycling node.
!#zh
使用构造函数来创建一个节点专用的对象池，您可以传递一个组件类型或名称，用于处理节点回收和复用时的事件逻辑。
@param poolHandlerComp !#en The constructor or the class name of the component to control the unuse/reuse logic. !#zh 处理节点回收和复用事件逻辑的组件类型或名称。
@example
```js
properties: {
template: cc.Prefab
},
onLoad () {
// MyTemplateHandler is a component with 'unuse' and 'reuse' to handle events when node is reused or recycled.
this.myPool = new cc.NodePool('MyTemplateHandler');
}
```
*/
constructor(poolHandlerComp?: {prototype: Component}|string);
/** !#en The pool handler component, it could be the class name or the constructor.
!#zh 缓冲池处理组件，用于节点的回收和复用逻辑，这个属性可以是组件类名或组件的构造函数。 */
poolHandlerComp: Function|string;
/**
!#en The current available size in the pool
!#zh 获取当前缓冲池的可用对象数量
*/
size(): number;
/**
!#en Destroy all cached nodes in the pool
!#zh 销毁对象池中缓存的所有节点
*/
clear(): void;
/**
!#en Put a new Node into the pool.
It will automatically remove the node from its parent without cleanup.
It will also invoke unuse method of the poolHandlerComp if exist.
!#zh 向缓冲池中存入一个不再需要的节点对象。
这个函数会自动将目标节点从父节点上移除，但是不会进行 cleanup 操作。
这个函数会调用 poolHandlerComp 的 unuse 函数，如果组件和函数都存在的话。
@param obj obj
@example
```js
let myNode = cc.instantiate(this.template);
this.myPool.put(myNode);
```
*/
put(obj: Node): void;
/**
!#en Get a obj from pool, if no available object in pool, null will be returned.
This function will invoke the reuse function of poolHandlerComp if exist.
!#zh 获取对象池中的对象，如果对象池没有可用对象，则返回空。
这个函数会调用 poolHandlerComp 的 reuse 函数，如果组件和函数都存在的话。
@param params !#en Params to pass to 'reuse' method in poolHandlerComp !#zh 向 poolHandlerComp 中的 'reuse' 函数传递的参数
@example
```js
let newNode = this.myPool.get();
```
*/
get(...params: any[]): Node;
}
/** !#en
Camera is usefull when making reel game or other games which need scroll screen.
Using camera will be more efficient than moving node to scroll screen.
Camera
!#zh
摄像机在制作卷轴或是其他需要移动屏幕的游戏时比较有用，使用摄像机将会比移动节点来移动屏幕更加高效。 */
export class Camera extends _RendererUnderSG {
/** !#en
The camera zoom ratio.
!#zh
摄像机缩放比率 */
zoomRatio: number;
/** !#en
Current active camera, the scene should only have one active camera at the same time.
!#zh
当前激活的摄像机，场景中在同一时间内只能有一个激活的摄像机。 */
static main: Camera;
/**
!#en
Add the specified target to camera.
!#zh
将指定的节点添加到摄像机中。
@param target target
*/
addTarget(target: Node): void;
/**
!#en
Remove the specified target from camera.
!#zh
将指定的节点从摄像机中移除。
@param target target
*/
removeTarget(target: Node): void;
/**
!#en
Get all camera targets.
!#zh
获取所有摄像机目标节点。
*/
getTargets(): [Node];
/**
!#en
Returns the matrix that transform the node's (local) space coordinates into the camera's space coordinates.
!#zh
返回一个将节点坐标系转换到摄像机坐标系下的矩阵
@param node the node which should transform
*/
getNodeToCameraTransform(node: Node): AffineTransform;
/**
!#en
Conver a camera coordinates point to world coordinates.
!#zh
将一个摄像机坐标系下的点转换到世界坐标系下。
@param point the point which should transform
*/
getCameraToWorldPoint(point: Node): Vec2;
/**
!#en
Check whether the node is in the camera.
!#zh
检测节点是否被此摄像机影响
@param node the node which need to check
*/
containsNode(node: Node): boolean;
}
/** !#en Box Collider.
!#zh 包围盒碰撞组件 */
export class BoxCollider extends Collider implements Collider.Box {
/** !#en Position offset
!#zh 位置偏移量 */
offset: Vec2;
/** !#en Box size
!#zh 包围盒大小 */
size: Size;
}
/** !#en Circle Collider.
!#zh 圆形碰撞组件 */
export class CircleCollider extends Collider implements Collider.Circle {
/** !#en Position offset
!#zh 位置偏移量 */
offset: Vec2;
/** !#en Circle radius
!#zh 圆形半径 */
radius: number;
}
/** !#en Collider component base class.
!#zh 碰撞组件基类 */
export class Collider extends Component {
/** !#en Tag. If a node has several collider components, you can judge which type of collider is collided according to the tag.
!#zh 标签。当一个节点上有多个碰撞组件时，在发生碰撞后，可以使用此标签来判断是节点上的哪个碰撞组件被碰撞了。 */
tag: number;
}
/** !#en
A simple collision manager class.
It will calculate whether the collider collides other colliders, if collides then call the callbacks.
!#zh
一个简单的碰撞组件管理类，用于处理节点之间的碰撞组件是否产生了碰撞，并调用相应回调函数。 */
export class CollisionManager implements EventTarget {
/** !#en
!#zh
是否开启碰撞管理，默认为不开启 */
enabled: boolean;
/** !#en
!#zh
是否绘制碰撞组件的包围盒，默认为不绘制 */
enabledDrawBoundingBox: boolean;
/** !#en
!#zh
是否绘制碰撞组件的形状，默认为不绘制 */
enabledDebugDraw: boolean;
/**
!#en
Register an callback of a specific event type on the EventTarget.
!#zh
注册事件目标的特定事件类型回调。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.on(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
on(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
on(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Removes the listeners previously registered with the same type, callback, target and or useCapture,
if only type is passed as parameter, all listeners registered with that type will be removed.
!#zh
删除之前用同类型，回调，目标或 useCapture 注册的事件监听器，如果只传递 type，将会删除 type 类型的所有事件监听器。
@param type A string representing the event type being removed.
@param callback The callback to remove.
@param target The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
@param useCapture Specifies whether the callback being removed was registered as a capturing callback or not.
If not specified, useCapture defaults to false. If a callback was registered twice,
one with capture and one without, each must be removed separately. Removal of a capturing callback
does not affect a non-capturing version of the same listener, and vice versa.
@example
```js
// register touchEnd eventListener
var touchEnd = node.on(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
// remove touch end event listener
node.off(cc.Node.EventType.TOUCH_END, touchEnd, node);
// remove all touch end event listeners
node.off(cc.Node.EventType.TOUCH_END);
```
*/
off(type: string, callback?: Function, target?: any, useCapture?: boolean): void;
/**
!#en Removes all callbacks previously registered with the same target (passed as parameter).
This is not for removing all listeners in the current event target,
and this is not for removing all listeners the target parameter have registered.
It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.
!#zh 在当前 EventTarget 上删除指定目标（target 参数）注册的所有事件监听器。
这个函数无法删除当前 EventTarget 的所有事件监听器，也无法删除 target 参数所注册的所有事件监听器。
这个函数只能删除 target 参数在当前 EventTarget 上注册的所有事件监听器。
@param target The target to be searched for all related listeners
*/
targetOff(target: any): void;
/**
!#en
Register an callback of a specific event type on the EventTarget,
the callback will remove itself after the first time it is triggered.
!#zh
注册事件目标的特定事件类型回调，回调会在第一时间被触发后删除自身。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.once(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
once(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
once(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Dispatches an event into the event flow.
The event target is the EventTarget object upon which the dispatchEvent() method is called.
!#zh 分发事件到事件流中。
@param event The Event object that is dispatched into the event flow
*/
dispatchEvent(event: Event): void;
/**
!#en
Send an event to this object directly, this method will not propagate the event to any other objects.
The event will be created from the supplied message, you can get the "detail" argument from event.detail.
!#zh
该对象直接发送事件， 这种方法不会对事件传播到任何其他对象。
@param message the message to send
@param detail whatever argument the message needs
*/
emit(message: string, detail?: any): void;
}
/** !#en Intersection helper class
!#zh 辅助类，用于测试形状与形状是否相交 */
export class Intersection {
/**
!#en Test line and line
!#zh 测试线段与线段是否相交
@param a1 The start point of the first line
@param a2 The end point of the first line
@param b1 The start point of the second line
@param b2 The end point of the second line
*/
static lineLine(a1: Vec2, a2: Vec2, b1: Vec2, b2: Vec2): boolean;
/**
!#en Test line and rect
!#zh 测试线段与矩形是否相交
@param a1 The start point of the line
@param a2 The end point of the line
@param b The rect
*/
static lineRect(a1: Vec2, a2: Vec2, b: Rect): boolean;
/**
!#en Test line and polygon
!#zh 测试线段与多边形是否相交
@param a1 The start point of the line
@param a2 The end point of the line
@param b The polygon, a set of points
*/
static linePolygon(a1: Vec2, a2: Vec2, b: Vec2[]): boolean;
/**
!#en Test rect and rect
!#zh 测试矩形与矩形是否相交
@param a The first rect
@param b The second rect
*/
static rectRect(a: Rect, b: Rect): boolean;
/**
!#en Test rect and polygon
!#zh 测试矩形与多边形是否相交
@param a The rect
@param b The polygon, a set of points
*/
static rectPolygon(a: Rect, b: Vec2[]): boolean;
/**
!#en Test polygon and polygon
!#zh 测试多边形与多边形是否相交
@param a The first polygon, a set of points
@param b The second polygon, a set of points
*/
static polygonPolygon(a: Vec2[], b: Vec2[]): boolean;
/**
!#en Test circle and circle
!#zh 测试圆形与圆形是否相交
@param a Object contains position and radius
@param b Object contains position and radius
*/
static circleCircle(a: {position: Vec2, radius: number}, b: {position: Vec2, radius: number}): boolean;
/**
!#en Test polygon and circle
!#zh 测试矩形与圆形是否相交
@param polygon The Polygon, a set of points
@param circle Object contains position and radius
*/
static polygonCircle(polygon: Vec2[], circle: {position: Vec2, radius: number}): boolean;
/**
!#en Test whether the point is in the polygon
!#zh 测试一个点是否在一个多边形中
@param point The point
@param polygon The polygon, a set of points
*/
static pointInPolygon(point: Vec2, polygon: Vec2[]): boolean;
/**
!#en Calculate the distance of point to line.
!#zh 计算点到直线的距离。如果这是一条线段并且垂足不在线段内，则会计算点到线段端点的距离。
@param point The point
@param start The start point of line
@param end The end point of line
@param isSegment whether this line is a segment
*/
static pointLineDistance(point: Vec2, start: Vec2, end: Vec2, isSegment: boolean): boolean;
}
/** !#en Polygon Collider.
!#zh 多边形碰撞组件 */
export class PolygonCollider extends Collider implements Collider.Polygon {
/** !#en Position offset
!#zh 位置偏移量 */
offset: Vec2;
/** !#en Polygon points
!#zh 多边形顶点数组 */
points: [Vec2];
}
/** !#en
Base class for handling assets used in Fireball. This class can be instantiate.
You may want to override:
- createNode
- cc.Object._serialize
- cc.Object._deserialize
!#zh
资源基类，该类可以被实例化。
您可能需要重写：
- createNode
- cc.Object._serialize
- cc.Object._deserialize
*/
export class Asset extends RawAsset {
/** !#en
Returns the url of this asset's first raw file, if none of rawFile exists,
it will returns an empty string.
!#zh 返回该资源的原始文件的 URL，如果不支持 RAW 文件，它将返回一个空字符串。 */
rawUrl: string;
/** !#en
Returns the url of this asset's raw files, if none of rawFile exists,
it will returns an empty array.
!#zh 返回该资源的原文件的 URL 数组，如果不支持 RAW 文件，它将返回一个空数组。 */
rawUrls: string[];
/** !#en Indicates whether its dependent raw assets can support deferred load if the owner scene (or prefab) is marked as `asyncLoadAssets`.
!#zh 当场景或 Prefab 被标记为 `asyncLoadAssets`，禁止延迟加载该资源所依赖的其它 RawAsset。 */
static preventDeferredLoadDependents: boolean;
/**
!#en
Create a new node using this asset in the scene.
If this type of asset dont have its corresponding node type, this method should be null.
!#zh
使用该资源在场景中创建一个新节点。
如果这类资源没有相应的节点类型，该方法应该是空的。
@param callback callback
*/
createNode(callback: (error: string, node: any) => void): void;
}
/** !#en Class for audio data handling.
!#zh 音频资源类。 */
export class AudioClip extends RawAsset {
}
/** !#en Class for BitmapFont handling.
!#zh 位图字体资源类。 */
export class BitmapFont extends RawAsset {
}
/** !#en Class for Font handling.
!#zh 字体资源类。 */
export class Font extends RawAsset {
}
/** !#en Class for LabelAtlas handling.
!#zh 艺术数字字体资源类。 */
export class LabelAtlas extends BitmapFont {
}
/** !#en Class for prefab handling.
!#zh 预制资源类。 */
export class Prefab extends Asset {
/** the main cc.Node in the prefab */
data: Node;
/** !#en Indicates the raw assets of this prefab can be load after prefab loaded.
!#zh 指示该 Prefab 依赖的资源可否在 Prefab 加载后再延迟加载。 */
asyncLoadAssets: boolean;
/**
Dynamically translation prefab data into minimized code.
This method will be called automatically before the first time the prefab being instantiated,
but you can re-call to refresh the create function once you modified the original prefab data in script.
*/
compileCreateFunction(): void;
}
/** !#en Class for scene handling.
!#zh 场景资源类。 */
export class SceneAsset extends Asset {
scene: Scene;
/** !#en Indicates the raw assets of this scene can be load after scene launched.
!#zh 指示该场景依赖的资源可否在场景切换后再延迟加载。 */
asyncLoadAssets: boolean;
}
/** !#en
The base class for registering asset types.
You may want to override:
- createNode (static)
!#zh
注册用的资源基类。
你可能要重写：
- createNode (static) */
export class RawAsset extends Object {
/**
!#en
Create a new node in the scene.
If this type of asset dont have its corresponding node type, this method should be null.
!#zh
在场景中创建一个新节点。
如果这类资源没有相应的节点类型，该方法应该是空的。
@param Info Info
@param callback callback
*/
static createNodeByInfo(Info: any, callback: (error: string, node: any) => void): void;
}
/** !#en Class for script handling.
!#zh Script 资源类。 */
export class _Script extends Asset {
}
/** !#en Class for JavaScript handling.
!#zh JavaScript 资源类。 */
export class _JavaScript extends Asset {
}
/** !#en Class for coffeescript handling.
!#zh CoffeeScript 资源类。 */
export class CoffeeScript extends Asset {
}
/** !#en Class for TypeScript handling.
!#zh TypeScript 资源类。 */
export class TypeScript extends Asset {
}
/** !#en Class for sprite atlas handling.
!#zh 精灵图集资源类。 */
export class SpriteAtlas extends RawAsset {
/**
Returns the texture of the sprite atlas
*/
getTexture(): Texture2D;
/**
Returns the sprite frame correspond to the given key in sprite atlas.
@param key key
*/
getSpriteFrame(key: string): SpriteFrame;
/**
Returns the sprite frames in sprite atlas.
*/
getSpriteFrames(): [SpriteFrame];
}
/** !#en Class for TTFFont handling.
!#zh TTF 字体资源类。 */
export class TTFFont extends Asset {
}
/** !#en Class for text file.
!#zh 文本资源类。 */
export class TextAsset extends Asset {
}
/** !#en The animation component is used to play back animations.
Animation provide several events to register：
- play : Emit when begin playing animation
- stop : Emit when stop playing animation
- pause : Emit when pause animation
- resume : Emit when resume animation
- lastframe : If animation repeat count is larger than 1, emit when animation play to the last frame
- finished : Emit when finish playing animation
!#zh Animation 组件用于播放动画。
Animation 提供了一系列可注册的事件：
- play : 开始播放时
- stop : 停止播放时
- pause : 暂停播放时
- resume : 恢复播放时
- lastframe : 假如动画循环次数大于 1，当动画播放到最后一帧时
- finished : 动画播放完成时 */
export class Animation extends Component implements EventTarget {
/** !#en Animation will play the default clip when start game.
!#zh 在勾选自动播放或调用 play() 时默认播放的动画剪辑。 */
defaultClip: AnimationClip;
/** !#en Current played clip.
!#zh 当前播放的动画剪辑。 */
currentClip: AnimationClip;
/** !#en Whether the animation should auto play the default clip when start game.
!#zh 是否在运行游戏后自动播放默认动画剪辑。 */
playOnLoad: boolean;
/**
!#en Get all the clips used in this animation.
!#zh 获取动画组件上的所有动画剪辑。
*/
getClips(): AnimationClip[];
/**
!#en Plays an animation and stop other animations.
!#zh 播放指定的动画，并且停止当前正在播放动画。如果没有指定动画，则播放默认动画。
@param name The name of animation to play. If no name is supplied then the default animation will be played.
@param startTime play an animation from startTime
@example
```js
var animCtrl = this.node.getComponent(cc.Animation);
animCtrl.play("linear");
```
*/
play(name?: string, startTime?: number): AnimationState;
/**
!#en
Plays an additive animation, it will not stop other animations.
If there are other animations playing, then will play several animations at the same time.
!#zh 播放指定的动画（将不会停止当前播放的动画）。如果没有指定动画，则播放默认动画。
@param name The name of animation to play. If no name is supplied then the default animation will be played.
@param startTime play an animation from startTime
@example
```js
// linear_1 and linear_2 at the same time playing.
var animCtrl = this.node.getComponent(cc.Animation);
animCtrl.playAdditive("linear_1");
animCtrl.playAdditive("linear_2");
```
*/
playAdditive(name?: string, startTime?: number): AnimationState;
/**
!#en Stops an animation named name. If no name is supplied then stops all playing animations that were started with this Animation.
Stopping an animation also Rewinds it to the Start.
!#zh 停止指定的动画。如果没有指定名字，则停止当前正在播放的动画。
@param name The animation to stop, if not supplied then stops all playing animations.
*/
stop(name?: string): void;
/**
!#en Pauses an animation named name. If no name is supplied then pauses all playing animations that were started with this Animation.
!#zh 暂停当前或者指定的动画。如果没有指定名字，则暂停当前正在播放的动画。
@param name The animation to pauses, if not supplied then pauses all playing animations.
*/
pause(name?: string): void;
/**
!#en Resumes an animation named name. If no name is supplied then resumes all paused animations that were started with this Animation.
!#zh 重新播放指定的动画，如果没有指定名字，则重新播放当前正在播放的动画。
@param name The animation to resumes, if not supplied then resumes all paused animations.
*/
resume(name?: string): void;
/**
!#en Make an animation named name go to the specified time. If no name is supplied then make all animations go to the specified time.
!#zh 设置指定动画的播放时间。如果没有指定名字，则设置当前播放动画的播放时间。
@param time The time to go to
@param name Specified animation name, if not supplied then make all animations go to the time.
*/
setCurrentTime(time?: number, name?: string): void;
/**
!#en Returns the animation state named name. If no animation with the specified name, the function will return null.
!#zh 获取当前或者指定的动画状态，如果未找到指定动画剪辑则返回 null。
@param name name
*/
getAnimationState(name: string): AnimationState;
/**
!#en Adds a clip to the animation with name newName. If a clip with that name already exists it will be replaced with the new clip.
!#zh 添加动画剪辑，并且可以重新设置该动画剪辑的名称。
@param clip the clip to add
@param newName newName
*/
addClip(clip: AnimationClip, newName?: string): AnimationState;
/**
!#en
Remove clip from the animation list. This will remove the clip and any animation states based on it.
If there are animation states depand on the clip are playing or clip is defaultClip, it will not delete the clip.
But if force is true, then will always remove the clip and any animation states based on it. If clip is defaultClip, defaultClip will be reset to null
!#zh
从动画列表中移除指定的动画剪辑，
如果依赖于 clip 的 AnimationState 正在播放或者 clip 是 defaultClip 的话，默认是不会删除 clip 的。
但是如果 force 参数为 true，则会强制停止该动画，然后移除该动画剪辑和相关的动画。这时候如果 clip 是 defaultClip，defaultClip 将会被重置为 null。
@param clip clip
@param force If force is true, then will always remove the clip and any animation states based on it.
*/
removeClip(clip: AnimationClip, force?: boolean): void;
/**
!#en
Samples animations at the current state.
This is useful when you explicitly want to set up some animation state, and sample it once.
!#zh 对指定或当前动画进行采样。你可以手动将动画设置到某一个状态，然后采样一次。
@param name name
*/
sample(name: string): void;
/**
!#en
Register animation event callback.
The event arguments will provide the AnimationState which emit the event.
When play an animation, will auto register the event callback to the AnimationState, and unregister the event callback from the AnimationState when animation stopped.
!#zh
注册动画事件回调。
回调的事件里将会附上发送事件的 AnimationState。
当播放一个动画时，会自动将事件注册到对应的 AnimationState 上，停止播放时会将事件从这个 AnimationState 上取消注册。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
onPlay: function (event) {
var state = event.detail; // state instanceof cc.AnimationState
var type = event.type; // type === 'play';
}
// register event to all animation
animation.on('play', this.onPlay, this);
```
*/
on(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
on(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Unregister animation event callback.
!#zh
取消注册动画事件回调。
@param type A string representing the event type being removed.
@param callback The callback to remove.
@param target The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
@param useCapture Specifies whether the callback being removed was registered as a capturing callback or not.
If not specified, useCapture defaults to false. If a callback was registered twice,
one with capture and one without, each must be removed separately. Removal of a capturing callback
does not affect a non-capturing version of the same listener, and vice versa.
@example
```js
// unregister event to all animation
animation.off('play', this.onPlay, this);
```
*/
off(type: string, callback: Function, target?: any, useCapture?: boolean): void;
/**
!#en Removes all callbacks previously registered with the same target (passed as parameter).
This is not for removing all listeners in the current event target,
and this is not for removing all listeners the target parameter have registered.
It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.
!#zh 在当前 EventTarget 上删除指定目标（target 参数）注册的所有事件监听器。
这个函数无法删除当前 EventTarget 的所有事件监听器，也无法删除 target 参数所注册的所有事件监听器。
这个函数只能删除 target 参数在当前 EventTarget 上注册的所有事件监听器。
@param target The target to be searched for all related listeners
*/
targetOff(target: any): void;
/**
!#en
Register an callback of a specific event type on the EventTarget,
the callback will remove itself after the first time it is triggered.
!#zh
注册事件目标的特定事件类型回调，回调会在第一时间被触发后删除自身。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.once(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
once(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
once(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Dispatches an event into the event flow.
The event target is the EventTarget object upon which the dispatchEvent() method is called.
!#zh 分发事件到事件流中。
@param event The Event object that is dispatched into the event flow
*/
dispatchEvent(event: Event): void;
/**
!#en
Send an event to this object directly, this method will not propagate the event to any other objects.
The event will be created from the supplied message, you can get the "detail" argument from event.detail.
!#zh
该对象直接发送事件， 这种方法不会对事件传播到任何其他对象。
@param message the message to send
@param detail whatever argument the message needs
*/
emit(message: string, detail?: any): void;
}
/** !#en Audio Source.
!#zh 音频源组件，能对音频剪辑。 */
export class AudioSource extends Component {
/** !#en
Is the audio source playing (Read Only).
Note: isPlaying is not supported for Native platforms.
!#zh
该音频剪辑是否正播放（只读）。
注意：Native 平台暂时不支持 isPlaying。 */
isPlaying: boolean;
/** !#en The clip of the audio source.
!#zh 默认要播放的音频剪辑。 */
clip: AudioClip;
/** !#en The volume of the audio source.
!#zh 音频源的音量（0.0 ~ 1.0）。 */
volume: number;
/** !#en Is the audio source mute?
!#zh 是否静音音频源。Mute 是设置音量为 0，取消静音是恢复原来的音量。 */
mute: boolean;
/** !#en Is the audio source looping?
!#zh 音频源是否循环播放？ */
loop: boolean;
/** !#en If set to true, the audio source will automatically start playing on onLoad.
!#zh 如果设置为true，音频源将在 onLoad 时自动播放。 */
playOnLoad: boolean;
/**
!#en Plays the clip.
!#zh 播放音频剪辑。
*/
play(): void;
/**
!#en Stops the clip.
!#zh 停止当前音频剪辑。
*/
stop(): void;
/**
!#en Pause the clip.
!#zh 暂停当前音频剪辑。
*/
pause(): void;
/**
!#en Resume the clip.
!#zh 恢复播放。
*/
resume(): void;
/**
!#en Rewind playing music.
!#zh 从头开始播放。
*/
rewind(): void;
/**
!#en Get current time
!#zh 获取当前的播放时间
*/
getCurrentTime(): void;
/**
!#en Set current time
!#zh 设置当前的播放时间
@param time time
*/
setCurrentTime(time: number): void;
/**
!#en Get audio duration
!#zh 获取当前音频的长度
*/
getDuration(): void;
}
/** !#en
This component will block all input events (mouse and touch) within the bounding box of the node, preventing the input from penetrating into the underlying node, typically for the background of the top UI.
This component does not have any API interface and can be added directly to the scene to take effect.
!#zh
该组件将拦截所属节点 bounding box 内的所有输入事件（鼠标和触摸），防止输入穿透到下层节点，一般用于上层 UI 的背景。
该组件没有任何 API 接口，直接添加到场景即可生效。 */
export class BlockInputEvents extends Component {
}
/** !#en
Button has 4 Transition types
When Button state changed:
If Transition type is Button.Transition.NONE, Button will do nothing
If Transition type is Button.Transition.COLOR, Button will change target's color
If Transition type is Button.Transition.SPRITE, Button will change target Sprite's sprite
If Transition type is Button.Transition.SCALE, Button will change target node's scale
Button will trigger 5 events:
Button.EVENT_TOUCH_DOWN
Button.EVENT_TOUCH_UP
Button.EVENT_HOVER_IN
Button.EVENT_HOVER_MOVE
Button.EVENT_HOVER_OUT
!#zh
按钮组件。可以被按下,或者点击。
按钮可以通过修改 Transition 来设置按钮状态过渡的方式：
-Button.Transition.NONE // 不做任何过渡
-Button.Transition.COLOR // 进行颜色之间过渡
-Button.Transition.SPRITE // 进行精灵之间过渡
-Button.Transition.SCALE // 进行缩放过渡
按钮可以绑定事件（但是必须要在按钮的 Node 上才能绑定事件）：
// 以下事件可以在全平台上都触发
-cc.Node.EventType.TOUCH_START // 按下时事件
-cc.Node.EventType.TOUCH_Move // 按住移动后事件
-cc.Node.EventType.TOUCH_END // 按下后松开后事件
-cc.Node.EventType.TOUCH_CANCEL // 按下取消事件
// 以下事件只在 PC 平台上触发
-cc.Node.EventType.MOUSE_DOWN // 鼠标按下时事件
-cc.Node.EventType.MOUSE_MOVE // 鼠标按住移动后事件
-cc.Node.EventType.MOUSE_ENTER // 鼠标进入目标事件
-cc.Node.EventType.MOUSE_LEAVE // 鼠标离开目标事件
-cc.Node.EventType.MOUSE_UP // 鼠标松开事件
-cc.Node.EventType.MOUSE_WHEEL // 鼠标滚轮事件 */
export class Button extends Component {
/** !#en
Whether the Button is disabled.
If true, the Button will trigger event and do transition.
!#zh
按钮事件是否被响应，如果为 false，则按钮将被禁用。 */
interactable: boolean;
/** !#en When this flag is true, Button target sprite will turn gray when interactable is false.
!#zh 如果这个标记为 true，当 button 的 interactable 属性为 false 的时候，会使用内置 shader 让 button 的 target 节点的 sprite 组件变灰 */
enableAutoGrayEffect: boolean;
/** !#en Transition type
!#zh 按钮状态改变时过渡方式。 */
transition: Button.Transition;
/** !#en Normal state color.
!#zh 普通状态下按钮所显示的颜色。 */
normalColor: Color;
/** !#en Pressed state color
!#zh 按下状态时按钮所显示的颜色。 */
pressedColor: Color;
/** !#en Hover state color
!#zh 悬停状态下按钮所显示的颜色。 */
hoverColor: Color;
/** !#en Disabled state color
!#zh 禁用状态下按钮所显示的颜色。 */
disabledColor: Color;
/** !#en Color and Scale transition duration
!#zh 颜色过渡和缩放过渡时所需时间 */
duration: number;
/** !#en When user press the button, the button will zoom to a scale.
The final scale of the button equals (button original scale * zoomScale)
!#zh 当用户点击按钮后，按钮会缩放到一个值，这个值等于 Button 原始 scale * zoomScale */
zoomScale: number;
/** !#en Normal state sprite
!#zh 普通状态下按钮所显示的 Sprite 。 */
normalSprite: SpriteFrame;
/** !#en Pressed state sprite
!#zh 按下状态时按钮所显示的 Sprite 。 */
pressedSprite: SpriteFrame;
/** !#en Hover state sprite
!#zh 悬停状态下按钮所显示的 Sprite 。 */
hoverSprite: SpriteFrame;
/** !#en Disabled state sprite
!#zh 禁用状态下按钮所显示的 Sprite 。 */
disabledSprite: SpriteFrame;
/** !#en
Transition target.
When Button state changed:
If Transition type is Button.Transition.NONE, Button will do nothing
If Transition type is Button.Transition.COLOR, Button will change target's color
If Transition type is Button.Transition.SPRITE, Button will change target Sprite's sprite
!#zh
需要过渡的目标。
当前按钮状态改变规则：
-如果 Transition type 选择 Button.Transition.NONE，按钮不做任何过渡。
-如果 Transition type 选择 Button.Transition.COLOR，按钮会对目标颜色进行颜色之间的过渡。
-如果 Transition type 选择 Button.Transition.Sprite，按钮会对目标 Sprite 进行 Sprite 之间的过渡。 */
target: Node;
/** !#en If Button is clicked, it will trigger event's handler
!#zh 按钮的点击事件列表。 */
clickEvents: Component.EventHandler[];
}
/** !#zh: 作为 UI 根节点，为所有子节点提供视窗四边的位置信息以供对齐，另外提供屏幕适配策略接口，方便从编辑器设置。
注：由于本节点的尺寸会跟随屏幕拉伸，所以 anchorPoint 只支持 (0.5, 0.5)，否则适配不同屏幕时坐标会有偏差。 */
export class Canvas extends Component {
/** !#en Current active canvas, the scene should only have one active canvas at the same time.
!#zh 当前激活的画布组件，场景同一时间只能有一个激活的画布。 */
static instance: Canvas;
/** !#en The desigin resolution for current scene.
!#zh 当前场景设计分辨率。 */
designResolution: Size;
/** !#en TODO
!#zh: 是否优先将设计分辨率高度撑满视图高度。 */
fitHeight: boolean;
/** !#en TODO
!#zh: 是否优先将设计分辨率宽度撑满视图宽度。 */
fitWidth: boolean;
}
/** !#en
Base class for everything attached to Node(Entity).
NOTE: Not allowed to use construction parameters for Component's subclasses,
because Component is created by the engine.
!#zh
所有附加到节点的基类。
注意：不允许使用组件的子类构造参数，因为组件是由引擎创建的。 */
export class Component extends Object {
/** !#en The node this component is attached to. A component is always attached to a node.
!#zh 该组件被附加到的节点。组件总会附加到一个节点。 */
node: Node;
/** !#en The uuid for editor.
!#zh 组件的 uuid，用于编辑器。 */
uuid: string;
/** !#en indicates whether this component is enabled or not.
!#zh 表示该组件自身是否启用。 */
enabled: boolean;
/** !#en indicates whether this component is enabled and its node is also active in the hierarchy.
!#zh 表示该组件是否被启用并且所在的节点也处于激活状态。 */
enabledInHierarchy: boolean;
/** !#en Returns a value which used to indicate the onLoad get called or not.
!#zh 返回一个值用来判断 onLoad 是否被调用过，不等于 0 时调用过，等于 0 时未调用。 */
_isOnLoadCalled: number;
/**
!#en Update is called every frame, if the Component is enabled.
!#zh 如果该组件启用，则每帧调用 update。
@param dt the delta time in seconds it took to complete the last frame
*/
protected update(dt: number): void;
/**
!#en LateUpdate is called every frame, if the Component is enabled.
!#zh 如果该组件启用，则每帧调用 LateUpdate。
*/
protected lateUpdate(): void;
/**
!#en
When attaching to an active node or its node first activated.
onLoad is always called before any start functions, this allows you to order initialization of scripts.
!#zh
当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行，这能用于安排脚本的初始化顺序。
*/
protected onLoad(): void;
/**
!#en
Called before all scripts' update if the Component is enabled the first time.
Usually used to initialize some logic which need to be called after all components' `onload` methods called.
!#zh
如果该组件第一次启用，则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
*/
protected start(): void;
/**
!#en Called when this component becomes enabled and its node is active.
!#zh 当该组件被启用，并且它的节点也激活时。
*/
protected onEnable(): void;
/**
!#en Called when this component becomes disabled or its node becomes inactive.
!#zh 当该组件被禁用或节点变为无效时调用。
*/
protected onDisable(): void;
/**
!#en Called when this component will be destroyed.
!#zh 当该组件被销毁时调用
*/
protected onDestroy(): void;
protected onFocusInEditor(): void;
protected onLostFocusInEditor(): void;
/**
!#en Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used. This function is only called in editor.
!#zh 用来初始化组件或节点的一些属性，当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。
*/
protected resetInEditor(): void;
/**
!#en Adds a component class to the node. You can also add component to node by passing in the name of the script.
!#zh 向节点添加一个组件类，你还可以通过传入脚本的名称来添加组件。
@param typeOrClassName the constructor or the class name of the component to add
@example
```js
var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");
```
*/
addComponent(type: {new(): T}): T;
addComponent(className: string): any;
/**
!#en
Returns the component of supplied type if the node has one attached, null if it doesn't.
You can also get component in the node by passing in the name of the script.
!#zh
获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
传入参数也可以是脚本的名称。
@param typeOrClassName typeOrClassName
@example
```js
// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");
```
*/
getComponent(type: {prototype: T}): T;
getComponent(className: string): any;
/**
!#en Returns all components of supplied Type in the node.
!#zh 返回节点上指定类型的所有组件。
@param typeOrClassName typeOrClassName
@example
```js
var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");
```
*/
getComponents(type: {prototype: T}): T[];
getComponents(className: string): any[];
/**
!#en Returns the component of supplied type in any of its children using depth first search.
!#zh 递归查找所有子节点中第一个匹配指定类型的组件。
@param typeOrClassName typeOrClassName
@example
```js
var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");
```
*/
getComponentInChildren(type: {prototype: T}): T;
getComponentInChildren(className: string): any;
/**
!#en Returns the components of supplied type in self or any of its children using depth first search.
!#zh 递归查找自身或所有子节点中指定类型的组件
@param typeOrClassName typeOrClassName
@example
```js
var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");
```
*/
getComponentsInChildren(type: {prototype: T}): T[];
getComponentsInChildren(className: string): any[];
/**
!#en
If the component's bounding box is different from the node's, you can implement this method to supply
a custom axis aligned bounding box (AABB), so the editor's scene view can perform hit test properly.
!#zh
如果组件的包围盒与节点不同，您可以实现该方法以提供自定义的轴向对齐的包围盒（AABB），
以便编辑器的场景视图可以正确地执行点选测试。
@param out_rect the Rect to receive the bounding box
*/
_getLocalBounds(out_rect: Rect): void;
/**
!#en
onRestore is called after the user clicks the Reset item in the Inspector's context menu or performs
an undo operation on this component.
If the component contains the "internal state", short for "temporary member variables which not included
in its CCClass properties", then you may need to implement this function.
The editor will call the getset accessors of your component to record/restore the component's state
for undo/redo operation. However, in extreme cases, it may not works well. Then you should implement
this function to manually synchronize your component's "internal states" with its public properties.
Once you implement this function, all the getset accessors of your component will not be called when
the user performs an undo/redo operation. Which means that only the properties with default value
will be recorded or restored by editor.
Similarly, the editor may failed to reset your component correctly in extreme cases. Then if you need
to support the reset menu, you should manually synchronize your component's "internal states" with its
properties in this function. Once you implement this function, all the getset accessors of your component
will not be called during reset operation. Which means that only the properties with default value
will be reset by editor.
This function is only called in editor mode.
!#zh
onRestore 是用户在检查器菜单点击 Reset 时，对此组件执行撤消操作后调用的。
如果组件包含了“内部状态”（不在 CCClass 属性中定义的临时成员变量），那么你可能需要实现该方法。
编辑器执行撤销/重做操作时，将调用组件的 get set 来录制和还原组件的状态。
然而，在极端的情况下，它可能无法良好运作。
那么你就应该实现这个方法，手动根据组件的属性同步“内部状态”。
一旦你实现这个方法，当用户撤销或重做时，组件的所有 get set 都不会再被调用。
这意味着仅仅指定了默认值的属性将被编辑器记录和还原。
同样的，编辑可能无法在极端情况下正确地重置您的组件。
于是如果你需要支持组件重置菜单，你需要在该方法中手工同步组件属性到“内部状态”。
一旦你实现这个方法，组件的所有 get set 都不会在重置操作时被调用。
这意味着仅仅指定了默认值的属性将被编辑器重置。
此方法仅在编辑器下会被调用。
*/
onRestore(): void;
/**
!#en
Schedules a custom selector.
If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.
!#zh
调度一个自定义的回调函数。
如果回调函数已调度，那么将不会重复调度它，只会更新时间间隔参数。
@param callback The callback function
@param interval Tick interval in seconds. 0 means tick every frame.
@param repeat The selector will be executed (repeat + 1) times, you can use cc.macro.REPEAT_FOREVER for tick infinitely.
@param delay The amount of time that the first tick will wait before execution.
@example
```js
var timeCallback = function (dt) {
cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);
```
*/
schedule(callback: Function, interval?: number, repeat?: number, delay?: number): void;
/**
!#en Schedules a callback function that runs only once, with a delay of 0 or larger.
!#zh 调度一个只运行一次的回调函数，可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。
@param callback A function wrapped as a selector
@param delay The amount of time that the first tick will wait before execution.
@example
```js
var timeCallback = function (dt) {
cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);
```
*/
scheduleOnce(callback: Function, delay?: number): void;
/**
!#en Unschedules a custom callback function.
!#zh 取消调度一个自定义的回调函数。
@param callback_fn A function wrapped as a selector
@example
```js
this.unschedule(_callback);
```
*/
unschedule(callback_fn: Function): void;
/**
!#en
unschedule all scheduled callback functions: custom callback functions, and the 'update' callback function.
Actions are not affected by this method.
!#zh 取消调度所有已调度的回调函数：定制的回调函数以及 'update' 回调函数。动作不受此方法影响。
@example
```js
this.unscheduleAllCallbacks();
```
*/
unscheduleAllCallbacks(): void;
}
/** !#en cc.EditBox is a component for inputing text, you can use it to gather small amounts of text from users.
!#zh EditBox 组件，用于获取用户的输入文本。 */
export class EditBox extends _RendererUnderSG {
/** !#en Input string of EditBox.
!#zh 输入框的初始输入内容，如果为空则会显示占位符的文本。 */
string: string;
/** !#en The background image of EditBox.
!#zh 输入框的背景图片 */
backgroundImage: SpriteFrame;
/** !#en
The return key type of EditBox.
Note: it is meaningless for web platforms and desktop platforms.
!#zh
指定移动设备上面回车按钮的样式。
注意：这个选项对 web 平台与 desktop 平台无效。 */
returnType: EditBox.KeyboardReturnType;
/** !#en Set the input flags that are to be applied to the EditBox.
!#zh 指定输入标志位，可以指定输入方式为密码或者单词首字母大写。 */
inputFlag: EditBox.InputFlag;
/** !#en
Set the input mode of the edit box.
If you pass ANY, it will create a multiline EditBox.
!#zh
指定输入模式: ANY表示多行输入，其它都是单行输入，移动平台上还可以指定键盘样式。 */
inputMode: EditBox.InputMode;
/** !#en Font size of the input text.
!#zh 输入框文本的字体大小 */
fontSize: number;
/** !#en Change the lineHeight of displayed text.
!#zh 输入框文本的行高。 */
lineHeight: number;
/** !#en Font color of the input text.
!#zh 输入框文本的颜色。 */
fontColor: Color;
/** !#en The display text of placeholder.
!#zh 输入框占位符的文本内容。 */
placeholder: string;
/** !#en The font size of placeholder.
!#zh 输入框占位符的字体大小。 */
placeholderFontSize: number;
/** !#en The font color of placeholder.
!#zh 输入框最大允许输入的字符个数。 */
placeholderFontColor: Color;
/** !#en The maximize input length of EditBox.
- If pass a value less than 0, it won't limit the input number of characters.
- If pass 0, it doesn't allow input any characters.
!#zh 输入框最大允许输入的字符个数。
- 如果值为小于 0 的值，则不会限制输入字符个数。
- 如果值为 0，则不允许用户进行任何输入。 */
maxLength: number;
/** !#en The input is always visible and be on top of the game view.
!zh 输入框总是可见，并且永远在游戏视图的上面
Note: only available on Web at the moment. */
stayOnTop: boolean;
/** !#en Set the tabIndex of the DOM input element, only useful on Web.
!#zh 修改 DOM 输入元素的 tabIndex，这个属性只有在 Web 上面修改有意义。 */
tabIndex: number;
/** !#en The event handler to be called when EditBox began to edit text.
!#zh 开始编辑文本输入框触发的事件回调。 */
editingDidBegan: Component.EventHandler[];
/** !#en The event handler to be called when EditBox text changes.
!#zh 编辑文本输入框时触发的事件回调。 */
textChanged: Component.EventHandler[];
/** !#en The event handler to be called when EditBox edit ends.
!#zh 结束编辑文本输入框时触发的事件回调。 */
editingDidEnded: Component.EventHandler[];
/** !#en The event handler to be called when return key is pressed. Windows is not supported.
!#zh 当用户按下回车按键时的事件回调，目前不支持 windows 平台 */
editingReturn: Component.EventHandler[];
/**
!#en Let the EditBox get focus, only valid when stayOnTop is true.
!#zh 让当前 EditBox 获得焦点，只有在 stayOnTop 为 true 的时候设置有效
Note: only available on Web at the moment.
*/
setFocus(): void;
/**
!#en Determine whether EditBox is getting focus or not.
!#zh 判断 EditBox 是否获得了焦点
Note: only available on Web at the moment.
*/
isFocused(): void;
/**
!#en if you don't need the EditBox and it isn't in any running Scene, you should
call the destroy method on this component or the associated node explicitly.
Otherwise, the created DOM element won't be removed from web page.
!#zh
如果你不再使用 EditBox，并且组件未添加到场景中，那么你必须手动对组件或所在节点调用 destroy。
这样才能移除网页上的 DOM 节点，避免 Web 平台内存泄露。
@example
```js
editbox.node.parent = null; // or editbox.node.removeFromParent(false);
// when you don't need editbox anymore
editbox.node.destroy();
```
*/
destroy(): boolean;
}
/** !#en The Label Component.
!#zh 文字标签组件 */
export class Label extends _RendererUnderSG {
/** !#en Content string of label.
!#zh 标签显示的文本内容。 */
string: string;
/** !#en Horizontal Alignment of label.
!#zh 文本内容的水平对齐方式。 */
horizontalAlign: Label.HorizontalAlign;
/** !#en Vertical Alignment of label.
!#zh 文本内容的垂直对齐方式。 */
verticalAlign: Label.VerticalAlign;
/** !#en The actual rendering font size in shrink mode
!#zh SHRINK 模式下面文本实际渲染的字体大小 */
actualFontSize: number;
/** !#en Font size of label.
!#zh 文本字体大小。 */
fontSize: number;
/** !#en Font family of label, only take effect when useSystemFont property is true.
!#zh 文本字体名称, 只在 useSystemFont 属性为 true 的时候生效。 */
fontFamily: string;
/** !#en Line Height of label.
!#zh 文本行高。 */
lineHeight: number;
/** !#en Overflow of label.
!#zh 文字显示超出范围时的处理方式。 */
overflow: Label.Overflow;
/** !#en Whether auto wrap label when string width is large than label width.
!#zh 是否自动换行。 */
enableWrapText: boolean;
/** !#en The font of label.
!#zh 文本字体。 */
font: Font;
/** !#en Whether use system font name or not.
!#zh 是否使用系统字体。 */
isSystemFontUsed: boolean;
}
/** !#en Outline effect used to change the display, only used for TTF font
!#zh 描边效果组件,用于字体描边,只能用于系统字体 */
export class LabelOutline extends Component {
/** !#en Change the outline color
!#zh 改变描边的颜色 */
color: Color;
/** !#en Change the outline width
!#zh 改变描边的宽度 */
width: number;
}
/** !#en
The Layout is a container component, use it to arrange child elements easily.
Note：
1.Scaling and rotation of child nodes are not considered.
2.After setting the Layout, the results need to be updated until the next frame,
unless you manually call {{#crossLink "Layout/updateLayout:method"}}{{/crossLink}}。
!#zh
Layout 组件相当于一个容器，能自动对它的所有子节点进行统一排版。
注意：
1.不会考虑子节点的缩放和旋转。
2.对 Layout 设置后结果需要到下一帧才会更新，除非你设置完以后手动调用 {{#crossLink "Layout/updateLayout:method"}}{{/crossLink}}。 */
export class Layout extends Component {
/** !#en The layout type.
!#zh 布局类型 */
type: Layout.Type;
/** !#en
The are three resize modes for Layout.
None, resize Container and resize children.
!#zh 缩放模式 */
resizeMode: Layout.ResizeMode;
/** !#en The cell size for grid layout.
!#zh 每个格子的大小，只有布局类型为 GRID 的时候才有效。 */
cellSize: Size;
/** !#en
The start axis for grid layout. If you choose horizontal, then children will layout horizontally at first,
and then break line on demand. Choose vertical if you want to layout vertically at first .
!#zh 起始轴方向类型，可进行水平和垂直布局排列，只有布局类型为 GRID 的时候才有效。 */
startAxis: Layout.AxisDirection;
/** !#en The left padding of layout, it only effect the layout in one direction.
!#zh 容器内左边距，只会在一个布局方向上生效。 */
paddingLeft: number;
/** !#en The right padding of layout, it only effect the layout in one direction.
!#zh 容器内右边距，只会在一个布局方向上生效。 */
paddingRight: number;
/** !#en The top padding of layout, it only effect the layout in one direction.
!#zh 容器内上边距，只会在一个布局方向上生效。 */
paddingTop: number;
/** !#en The bottom padding of layout, it only effect the layout in one direction.
!#zh 容器内下边距，只会在一个布局方向上生效。 */
paddingBottom: number;
/** !#en The distance in x-axis between each element in layout.
!#zh 子节点之间的水平间距。 */
spacingX: number;
/** !#en The distance in y-axis between each element in layout.
!#zh 子节点之间的垂直间距。 */
spacingY: number;
/** !#en
Only take effect in Vertical layout mode.
This option changes the start element's positioning.
!#zh 垂直排列子节点的方向。 */
verticalDirection: Layout.VerticalDirection;
/** !#en
Only take effect in Horizontal layout mode.
This option changes the start element's positioning.
!#zh 水平排列子节点的方向。 */
horizontalDirection: Layout.HorizontalDirection;
/**
!#en Perform the layout update
!#zh 立即执行更新布局
@example
```js
layout.type = cc.Layout.HORIZONTAL;
layout.node.addChild(childNode);
cc.log(childNode.x); // not yet changed
layout.updateLayout();
cc.log(childNode.x); // changed
```
*/
updateLayout(): void;
/** !#en The padding of layout, it effects the layout in four direction.
!#zh 容器内边距，该属性会在四个布局方向上生效。 */
padding: number;
}
/** !#en The Mask Component
!#zh 遮罩组件 */
export class Mask extends _RendererInSG {
/** !#en The mask type.
!#zh 遮罩类型 */
type: Mask.Type;
/** !#en The mask image
!#zh 遮罩所需要的贴图 */
spriteFrame: SpriteFrame;
/** !#en
The alpha threshold.(Not supported Canvas Mode)
The content is drawn only where the stencil have pixel with alpha greater than the alphaThreshold.
Should be a float between 0 and 1.
This default to 1 (so alpha test is disabled).
!#zh
Alpha 阈值（不支持 Canvas 模式）
只有当模板的像素的 alpha 大于 alphaThreshold 时，才会绘制内容。
该数值 0 ~ 1 之间的浮点数，默认值为 1（因此禁用 alpha） */
alphaThreshold: number;
/** !#en Reverse mask (Not supported Canvas Mode)
!#zh 反向遮罩（不支持 Canvas 模式） */
inverted: boolean;
/** !#en The segements for ellipse mask.
!#zh 椭圆遮罩的曲线细分数 */
segements: number;
}
/** !#en The PageView control
!#zh 页面视图组件 */
export class PageView extends ScrollView {
/** !#en Specify the size type of each page in PageView.
!#zh 页面视图中每个页面大小类型 */
sizeMode: PageView.SizeMode;
/** !#en The page view direction
!#zh 页面视图滚动类型 */
direction: PageView.Direction;
/** !#en
The scroll threshold value, when drag exceeds this value,
release the next page will automatically scroll, less than the restore
!#zh 滚动临界值，默认单位百分比，当拖拽超出该数值时，松开会自动滚动下一页，小于时则还原。 */
scrollThreshold: number;
/** !#en
Auto page turning velocity threshold. When users swipe the PageView quickly,
it will calculate a velocity based on the scroll distance and time,
if the calculated velocity is larger than the threshold, then it will trigger page turning.
!#zh
快速滑动翻页临界值。
当用户快速滑动时，会根据滑动开始和结束的距离与时间计算出一个速度值，
该值与此临界值相比较，如果大于临界值，则进行自动翻页。 */
autoPageTurningThreshold: number;
/** !#en Change the PageTurning event timing of PageView.
!#zh 设置 PageView PageTurning 事件的发送时机。 */
pageTurningEventTiming: number;
/** !#en The Page View Indicator
!#zh 页面视图指示器组件 */
indicator: PageViewIndicator;
/** !#en The time required to turn over a page. unit: second
!#zh 每个页面翻页时所需时间。单位：秒 */
pageTurningSpeed: number;
/** !#en PageView events callback
!#zh 滚动视图的事件回调函数 */
pageEvents: Component.EventHandler[];
/**
!#en Returns current page index
!#zh 返回当前页面索引
*/
getCurrentPageIndex(): number;
/**
!#en Set current page index
!#zh 设置当前页面索引
@param index index
*/
setCurrentPageIndex(index: number): void;
/**
!#en Returns all pages of pageview
!#zh 返回视图中的所有页面
*/
getPages(): Node[];
/**
!#en At the end of the current page view to insert a new view
!#zh 在当前页面视图的尾部插入一个新视图
@param page page
*/
addPage(page: Node): void;
/**
!#en Inserts a page in the specified location
!#zh 将页面插入指定位置中
@param page page
@param index index
*/
insertPage(page: Node, index: number): void;
/**
!#en Removes a page from PageView.
!#zh 移除指定页面
@param page page
*/
removePage(page: Node): void;
/**
!#en Removes a page at index of PageView.
!#zh 移除指定下标的页面
@param index index
*/
removePageAtIndex(index: number): void;
/**
!#en Removes all pages from PageView
!#zh 移除所有页面
*/
removeAllPages(): void;
/**
!#en Scroll PageView to index.
!#zh 滚动到指定页面
@param idx index of page.
@param timeInSecond scrolling time
*/
scrollToPage(idx: number, timeInSecond: number): void;
}
/** !#en The Page View Indicator Component
!#zh 页面视图每页标记组件 */
export class PageViewIndicator extends Component {
/** !#en The spriteFrame for each element.
!#zh 每个页面标记显示的图片 */
spriteFrame: SpriteFrame;
/** !#en The location direction of PageViewIndicator.
!#zh 页面标记摆放方向 */
direction: PageViewIndicator.Direction;
/** !#en The cellSize for each element.
!#zh 每个页面标记的大小 */
cellSize: Size;
/** !#en The distance between each element.
!#zh 每个页面标记之间的边距 */
spacing: number;
/**
!#en Set Page View
!#zh 设置页面视图
@param target target
*/
setPageView(target: PageView): void;
}
/** !#en
Visual indicator of progress in some operation.
Displays a bar to the user representing how far the operation has progressed.
!#zh
进度条组件，可用于显示加载资源时的进度。 */
export class ProgressBar extends Component {
/** !#en The targeted Sprite which will be changed progressively.
!#zh 用来显示进度条比例的 Sprite 对象。 */
barSprite: Sprite;
/** !#en The progress mode, there are two modes supported now: horizontal and vertical.
!#zh 进度条的模式 */
mode: ProgressBar.Mode;
/** !#en The total width or height of the bar sprite.
!#zh 进度条实际的总长度 */
totalLength: number;
/** !#en The current progress of the bar sprite. The valid value is between 0-1.
!#zh 当前进度值，该数值的区间是 0-1 之间。 */
progress: number;
/** !#en Whether reverse the progress direction of the bar sprite.
!#zh 进度条是否进行反方向变化。 */
reverse: boolean;
}
/** Rendering component in scene graph.
Maintains a node which will be the scene graph of component's Node. */
export class _RendererInSG extends _SGComponent {
}
/** The base rendering component which will attach a leaf node to the cocos2d scene graph. */
export class _RendererUnderSG extends _SGComponent {
}
/** !#en The RichText Component.
!#zh 富文本组件 */
export class RichText extends Component {
/** !#en Content string of RichText.
!#zh 富文本显示的文本内容。 */
string: string;
/** !#en Horizontal Alignment of each line in RichText.
!#zh 文本内容的水平对齐方式。 */
horizontalAlign: TextAlignment;
/** !#en Font size of RichText.
!#zh 富文本字体大小。 */
fontSize: number;
/** !#en Custom TTF font of RichText
!#zh 富文本定制字体 */
font: cc.TTFFont;
/** !#en The maximize width of the RichText
!#zh 富文本的最大宽度 */
maxWidth: number;
/** !#en Line Height of RichText.
!#zh 富文本行高。 */
lineHeight: number;
/** !#en The image atlas for the img tag. For each src value in the img tag, there should be a valid spriteFrame in the image atlas.
!#zh 对于 img 标签里面的 src 属性名称，都需要在 imageAtlas 里面找到一个有效的 spriteFrame，否则 img tag 会判定为无效。 */
imageAtlas: SpriteAtlas;
/** !#en
Once checked, the RichText will block all input events (mouse and touch) within
the bounding box of the node, preventing the input from penetrating into the underlying node.
!#zh
选中此选项后，RichText 将阻止节点边界框中的所有输入事件（鼠标和触摸），从而防止输入事件穿透到底层节点。 */
handleTouchEvent: boolean;
}
/** The base class for all rendering component in scene graph.
You should override:
- _createSgNode
- _initSgNode */
export class _SGComponent extends Component {
}
/** !#en
The Scrollbar control allows the user to scroll an image or other view that is too large to see completely
!#zh 滚动条组件 */
export class Scrollbar extends Component {
/** !#en The "handle" part of the scrollbar.
!#zh 作为当前滚动区域位置显示的滑块 Sprite。 */
handle: Sprite;
/** !#en The direction of scrollbar.
!#zh ScrollBar 的滚动方向。 */
direction: Scrollbar.Direction;
/** !#en Whether enable auto hide or not.
!#zh 是否在没有滚动动作时自动隐藏 ScrollBar。 */
enableAutoHide: boolean;
/** !#en
The time to hide scrollbar when scroll finished.
Note: This value is only useful when enableAutoHide is true.
!#zh
没有滚动动作后经过多久会自动隐藏。
注意：只要当 “enableAutoHide” 为 true 时，才有效。 */
autoHideTime: number;
}
/** !#en
Layout container for a view hierarchy that can be scrolled by the user,
allowing it to be larger than the physical display.
!#zh
滚动视图组件 */
export class ScrollView extends Component {
/** !#en This is a reference to the UI element to be scrolled.
!#zh 可滚动展示内容的节点。 */
content: Node;
/** !#en Enable horizontal scroll.
!#zh 是否开启水平滚动。 */
horizontal: boolean;
/** !#en Enable vertical scroll.
!#zh 是否开启垂直滚动。 */
vertical: boolean;
/** !#en When inertia is set, the content will continue to move when touch ended.
!#zh 是否开启滚动惯性。 */
inertia: boolean;
/** !#en
It determines how quickly the content stop moving. A value of 1 will stop the movement immediately.
A value of 0 will never stop the movement until it reaches to the boundary of scrollview.
!#zh
开启惯性后，在用户停止触摸后滚动多快停止，0表示永不停止，1表示立刻停止。 */
brake: number;
/** !#en When elastic is set, the content will be bounce back when move out of boundary.
!#zh 是否允许滚动内容超过边界，并在停止触摸后回弹。 */
elastic: boolean;
/** !#en The elapse time of bouncing back. A value of 0 will bounce back immediately.
!#zh 回弹持续的时间，0 表示将立即反弹。 */
bounceDuration: number;
/** !#en The horizontal scrollbar reference.
!#zh 水平滚动的 ScrollBar。 */
horizontalScrollBar: Scrollbar;
/** !#en The vertical scrollbar reference.
!#zh 垂直滚动的 ScrollBar。 */
verticalScrollBar: Scrollbar;
/** !#en Scrollview events callback
!#zh 滚动视图的事件回调函数 */
scrollEvents: Component.EventHandler[];
/** !#en If cancelInnerEvents is set to true, the scroll behavior will cancel touch events on inner content nodes
It's set to true by default.
!#zh 如果这个属性被设置为 true，那么滚动行为会取消子节点上注册的触摸事件，默认被设置为 true。
注意，子节点上的 touchstart 事件仍然会触发，触点移动距离非常短的情况下 touchmove 和 touchend 也不会受影响。 */
cancelInnerEvents: boolean;
/**
!#en Scroll the content to the bottom boundary of ScrollView.
!#zh 视图内容将在规定时间内滚动到视图底部。
@param timeInSecond Scroll time in second, if you don't pass timeInSecond,
the content will jump to the bottom boundary immediately.
@param attenuated Whether the scroll acceleration attenuated, default is true.
@example
```js
// Scroll to the bottom of the view.
scrollView.scrollToBottom(0.1);
```
*/
scrollToBottom(timeInSecond?: number, attenuated?: boolean): void;
/**
!#en Scroll the content to the top boundary of ScrollView.
!#zh 视图内容将在规定时间内滚动到视图顶部。
@param timeInSecond Scroll time in second, if you don't pass timeInSecond,
the content will jump to the top boundary immediately.
@param attenuated Whether the scroll acceleration attenuated, default is true.
@example
```js
// Scroll to the top of the view.
scrollView.scrollToTop(0.1);
```
*/
scrollToTop(timeInSecond?: number, attenuated?: boolean): void;
/**
!#en Scroll the content to the left boundary of ScrollView.
!#zh 视图内容将在规定时间内滚动到视图左边。
@param timeInSecond Scroll time in second, if you don't pass timeInSecond,
the content will jump to the left boundary immediately.
@param attenuated Whether the scroll acceleration attenuated, default is true.
@example
```js
// Scroll to the left of the view.
scrollView.scrollToLeft(0.1);
```
*/
scrollToLeft(timeInSecond?: number, attenuated?: boolean): void;
/**
!#en Scroll the content to the right boundary of ScrollView.
!#zh 视图内容将在规定时间内滚动到视图右边。
@param timeInSecond Scroll time in second, if you don't pass timeInSecond,
the content will jump to the right boundary immediately.
@param attenuated Whether the scroll acceleration attenuated, default is true.
@example
```js
// Scroll to the right of the view.
scrollView.scrollToRight(0.1);
```
*/
scrollToRight(timeInSecond?: number, attenuated?: boolean): void;
/**
!#en Scroll the content to the top left boundary of ScrollView.
!#zh 视图内容将在规定时间内滚动到视图左上角。
@param timeInSecond Scroll time in second, if you don't pass timeInSecond,
the content will jump to the top left boundary immediately.
@param attenuated Whether the scroll acceleration attenuated, default is true.
@example
```js
// Scroll to the upper left corner of the view.
scrollView.scrollToTopLeft(0.1);
```
*/
scrollToTopLeft(timeInSecond?: number, attenuated?: boolean): void;
/**
!#en Scroll the content to the top right boundary of ScrollView.
!#zh 视图内容将在规定时间内滚动到视图右上角。
@param timeInSecond Scroll time in second, if you don't pass timeInSecond,
the content will jump to the top right boundary immediately.
@param attenuated Whether the scroll acceleration attenuated, default is true.
@example
```js
// Scroll to the top right corner of the view.
scrollView.scrollToTopRight(0.1);
```
*/
scrollToTopRight(timeInSecond?: number, attenuated?: boolean): void;
/**
!#en Scroll the content to the bottom left boundary of ScrollView.
!#zh 视图内容将在规定时间内滚动到视图左下角。
@param timeInSecond Scroll time in second, if you don't pass timeInSecond,
the content will jump to the bottom left boundary immediately.
@param attenuated Whether the scroll acceleration attenuated, default is true.
@example
```js
// Scroll to the lower left corner of the view.
scrollView.scrollToBottomLeft(0.1);
```
*/
scrollToBottomLeft(timeInSecond?: number, attenuated?: boolean): void;
/**
!#en Scroll the content to the bottom right boundary of ScrollView.
!#zh 视图内容将在规定时间内滚动到视图右下角。
@param timeInSecond Scroll time in second, if you don't pass timeInSecond,
the content will jump to the bottom right boundary immediately.
@param attenuated Whether the scroll acceleration attenuated, default is true.
@example
```js
// Scroll to the lower right corner of the view.
scrollView.scrollToBottomRight(0.1);
```
*/
scrollToBottomRight(timeInSecond?: number, attenuated?: boolean): void;
/**
!#en Scroll with an offset related to the ScrollView's top left origin, if timeInSecond is omitted, then it will jump to the
specific offset immediately.
!#zh 视图内容在规定时间内将滚动到 ScrollView 相对左上角原点的偏移位置, 如果 timeInSecond参数不传，则立即滚动到指定偏移位置。
@param offset A Vec2, the value of which each axis between 0 and maxScrollOffset
@param timeInSecond Scroll time in second, if you don't pass timeInSecond,
the content will jump to the specific offset of ScrollView immediately.
@param attenuated Whether the scroll acceleration attenuated, default is true.
@example
```js
// Scroll to middle position in 0.1 second in x-axis
var maxScrollOffset = this.getMaxScrollOffset();
scrollView.scrollToOffset(cc.p(maxScrollOffset.x / 2, 0), 0.1);
```
*/
scrollToOffset(offset: Vec2, timeInSecond?: number, attenuated?: boolean): void;
/**
!#en Get the positive offset value corresponds to the content's top left boundary.
!#zh 获取滚动视图相对于左上角原点的当前滚动偏移
*/
getScrollOffset(): Vec2;
/**
!#en Get the maximize available scroll offset
!#zh 获取滚动视图最大可以滚动的偏移量
*/
getMaxScrollOffset(): Vec2;
/**
!#en Scroll the content to the horizontal percent position of ScrollView.
!#zh 视图内容在规定时间内将滚动到 ScrollView 水平方向的百分比位置上。
@param percent A value between 0 and 1.
@param timeInSecond Scroll time in second, if you don't pass timeInSecond,
the content will jump to the horizontal percent position of ScrollView immediately.
@param attenuated Whether the scroll acceleration attenuated, default is true.
@example
```js
// Scroll to middle position.
scrollView.scrollToBottomRight(0.5, 0.1);
```
*/
scrollToPercentHorizontal(percent: number, timeInSecond?: number, attenuated?: boolean): void;
/**
!#en Scroll the content to the percent position of ScrollView in any direction.
!#zh 视图内容在规定时间内进行垂直方向和水平方向的滚动，并且滚动到指定百分比位置上。
@param anchor A point which will be clamp between cc.p(0,0) and cc.p(1,1).
@param timeInSecond Scroll time in second, if you don't pass timeInSecond,
the content will jump to the percent position of ScrollView immediately.
@param attenuated Whether the scroll acceleration attenuated, default is true.
@example
```js
// Vertical scroll to the bottom of the view.
scrollView.scrollTo(cc.p(0, 1), 0.1);
// Horizontal scroll to view right.
scrollView.scrollTo(cc.p(1, 0), 0.1);
```
*/
scrollTo(anchor: Vec2, timeInSecond?: number, attenuated?: boolean): void;
/**
!#en Scroll the content to the vertical percent position of ScrollView.
!#zh 视图内容在规定时间内滚动到 ScrollView 垂直方向的百分比位置上。
@param percent A value between 0 and 1.
@param timeInSecond Scroll time in second, if you don't pass timeInSecond,
the content will jump to the vertical percent position of ScrollView immediately.
@param attenuated Whether the scroll acceleration attenuated, default is true.
// Scroll to middle position.
scrollView.scrollToPercentVertical(0.5, 0.1);
*/
scrollToPercentVertical(percent: number, timeInSecond?: number, attenuated?: boolean): void;
/**
!#en Stop auto scroll immediately
!#zh 停止自动滚动, 调用此 API 可以让 Scrollview 立即停止滚动
*/
stopAutoScroll(): void;
/**
!#en Modify the content position.
!#zh 设置当前视图内容的坐标点。
@param position The position in content's parent space.
*/
setContentPosition(position: Vec2): void;
/**
!#en Query the content's position in its parent space.
!#zh 获取当前视图内容的坐标点。
*/
getContentPosition(): Position;
/**
!#en Query whether the user is currently dragging the ScrollView to scroll it
!#zh 用户是否在拖拽当前滚动视图
*/
isScrolling(): boolean;
/**
!#en Query whether the ScrollView is currently scrolling because of a bounceback or inertia slowdown.
!#zh 当前滚动视图是否在惯性滚动
*/
isAutoScrolling(): boolean;
}
/** !#en The Slider Control
!#zh 滑动器组件 */
export class Slider extends Component {
/** !#en The "handle" part of the slider
!#zh 滑动器滑块按钮部件 */
handle: Button;
/** !#en The slider direction
!#zh 滑动器方向 */
direction: Slider.Direction;
/** !#en The current progress of the slider. The valid value is between 0-1
!#zh 当前进度值，该数值的区间是 0-1 之间 */
progress: number;
/** !#en The slider events callback
!#zh 滑动器组件事件回调函数 */
slideEvents: Component.EventHandler[];
}
/** !#en Renders a sprite in the scene.
!#zh 该组件用于在场景中渲染精灵。 */
export class Sprite extends _RendererUnderSG {
/** !#en The sprite frame of the sprite.
!#zh 精灵的精灵帧 */
spriteFrame: SpriteFrame;
/** !#en The sprite render type.
!#zh 精灵渲染类型 */
type: Sprite.SpriteType;
/** !#en
The fill type, This will only have any effect if the "type" is set to “cc.Sprite.Type.FILLED”.
!#zh
精灵填充类型，仅渲染类型设置为 cc.Sprite.SpriteType.FILLED 时有效。 */
fillType: Sprite.FillType;
/** !#en
The fill Center, This will only have any effect if the "type" is set to “cc.Sprite.Type.FILLED”.
!#zh
填充中心点，仅渲染类型设置为 cc.Sprite.SpriteType.FILLED 时有效。 */
fillCenter: Vec2;
/** !#en
The fill Start, This will only have any effect if the "type" is set to “cc.Sprite.Type.FILLED”.
!#zh
填充起始点，仅渲染类型设置为 cc.Sprite.SpriteType.FILLED 时有效。 */
fillStart: number;
/** !#en
The fill Range, This will only have any effect if the "type" is set to “cc.Sprite.Type.FILLED”.
!#zh
填充范围，仅渲染类型设置为 cc.Sprite.SpriteType.FILLED 时有效。 */
fillRange: number;
/** !#en specify the frame is trimmed or not.
!#zh 是否使用裁剪模式 */
trim: boolean;
/** !#en specify the source Blend Factor.
!#zh 指定原图的混合模式 */
srcBlendFactor: BlendFactor;
/** !#en specify the destination Blend Factor.
!#zh 指定目标的混合模式 */
dstBlendFactor: BlendFactor;
/** !#en specify the size tracing mode.
!#zh 精灵尺寸调整模式 */
sizeMode: Sprite.SizeMode;
/**
!#en Change the left sprite's cap inset.
!#zh 设置精灵左边框-用于九宫格。
@param insetLeft The values to use for the cap inset.
@example
```js
sprite.setInsetLeft(5);
```
*/
setInsetLeft(insetLeft: number): void;
/**
!#en Query the left sprite's cap inset.
!#zh 获取精灵左边框
@example
```js
var insetLeft = sprite.getInsetLeft();
cc.log("Inset Left:" + insetLeft);
```
*/
getInsetLeft(): number;
/**
!#en Change the top sprite's cap inset.
!#zh 设置精灵上边框-用于九宫格。
@param insetTop The values to use for the cap inset.
@example
```js
sprite.setInsetTop(5);
```
*/
setInsetTop(insetTop: number): void;
/**
!#en Query the top sprite's cap inset.
!#zh 获取精灵上边框。
@example
```js
var insetTop = sprite.getInsetTop();
cc.log("Inset Top:" + insetTop);
```
*/
getInsetTop(): number;
/**
!#en Change the right sprite's cap inset.
!#zh 设置精灵右边框-用于九宫格。
@param insetRight The values to use for the cap inset.
@example
```js
sprite.setInsetRight(5);
```
*/
setInsetRight(insetRight: number): void;
/**
!#en Query the right sprite's cap inset.
!#zh 获取精灵右边框。
@example
```js
var insetRight = sprite.getInsetRight();
cc.log("Inset Right:" + insetRight);
```
*/
getInsetRight(): number;
/**
!#en Change the bottom sprite's cap inset.
!#zh 设置精灵下边框-用于九宫格。
@param bottomInset The values to use for the cap inset.
@example
```js
sprite.setInsetBottom(5);
```
*/
setInsetBottom(bottomInset: number): void;
/**
!#en Query the bottom sprite's cap inset.
!#zh 获取精灵下边框。
@example
```js
var insetBottom = sprite.getInsetBottom();
cc.log("Inset Bottom:" + insetBottom);
```
*/
getInsetBottom(): number;
}
/** !#en A distortion used to change the rendering of simple sprite.If will take effect after sprite component is added.
!#zh 扭曲效果组件,用于改变SIMPLE类型sprite的渲染,只有当sprite组件已经添加后,才能起作用. */
export class SpriteDistortion extends Component {
/** !#en Change the UV offset for distortion rendering.
!#zh 在渲染时改变UV的整体偏移. */
offset: Vec2;
/** !#en Change the UV scale for distortion rendering.
!#zh 在渲染时改变UV的寻址系数 */
tiling: Vec2;
}
/** !#en The toggle component is a CheckBox, when it used together with a ToggleGroup, it
could be treated as a RadioButton.
!#zh Toggle 是一个 CheckBox，当它和 ToggleGroup 一起使用的时候，可以变成 RadioButton。 */
export class Toggle extends Button {
/** !#en When this value is true, the check mark component will be enabled, otherwise
the check mark component will be disabled.
!#zh 如果这个设置为 true，则 check mark 组件会处于 enabled 状态，否则处于 disabled 状态。 */
isChecked: boolean;
/** !#en The toggle group which the toggle belongs to, when it is null, the toggle is a CheckBox.
Otherwise, the toggle is a RadioButton.
!#zh Toggle 所属的 ToggleGroup，这个属性是可选的。如果这个属性为 null，则 Toggle 是一个 CheckBox，
否则，Toggle 是一个 RadioButton。 */
toggleGroup: ToggleGroup;
/** !#en The image used for the checkmark.
!#zh Toggle 处于选中状态时显示的图片 */
checkMark: Sprite;
/** !#en If Toggle is clicked, it will trigger event's handler
!#zh Toggle 按钮的点击事件列表。 */
checkEvents: Component.EventHandler[];
/**
!#en Make the toggle button checked.
!#zh 使 toggle 按钮处于选中状态
*/
check(): void;
/**
!#en Make the toggle button unchecked.
!#zh 使 toggle 按钮处于未选中状态
*/
uncheck(): void;
}
/** !#en ToggleContainer is not a visiable UI component but a way to modify the behavior of a set of Toggles.
Toggles that belong to the same group could only have one of them to be switched on at a time.
Note: All the first layer child node containing the toggle component will auto be added to the container
!#zh ToggleContainer 不是一个可见的 UI 组件，它可以用来修改一组 Toggle 组件的行为。
当一组 Toggle 属于同一个 ToggleContainer 的时候，任何时候只能有一个 Toggle 处于选中状态。
注意：所有包含 Toggle 组件的一级子节点都会自动被添加到该容器中 */
export class ToggleContainer extends Component {
/** !#en If this setting is true, a toggle could be switched off and on when pressed.
If it is false, it will make sure there is always only one toggle could be switched on
and the already switched on toggle can't be switched off.
!#zh 如果这个设置为 true， 那么 toggle 按钮在被点击的时候可以反复地被选中和未选中。 */
allowSwitchOff: boolean;
/** !#en Read only property, return the toggle items array reference managed by ToggleContainer.
!#zh 只读属性，返回 ToggleContainer 管理的 toggle 数组引用 */
toggleItems: Toggle[];
}
/** !#en cc.VideoPlayer is a component for playing videos, you can use it for showing videos in your game.
!#zh Video 组件，用于在游戏中播放视频 */
export class VideoPlayer extends _RendererUnderSG {
/** !#en The resource type of videoplayer, REMOTE for remote url and LOCAL for local file path.
!#zh 视频来源：REMOTE 表示远程视频 URL，LOCAL 表示本地视频地址。 */
resourceType: VideoPlayer.ResourceType;
/** !#en The remote URL of video.
!#zh 远程视频的 URL */
remoteURL: string;
/** !#en The local video full path.
!#zh 本地视频的 URL */
clip: string;
/** !#en The current playback time of the now playing item in seconds, you could also change the start playback time.
!#zh 指定视频从什么时间点开始播放，单位是秒，也可以用来获取当前视频播放的时间进度。 */
currentTime: number;
/** !#en Whether keep the aspect ration of the original video.
!#zh 是否保持视频原来的宽高比 */
keepAspectRatio: boolean;
/** !#en Whether play video in fullscreen mode.
!#zh 是否全屏播放视频 */
isFullscreen: boolean;
/** !#en the video player's callback, it will be triggered when certain event occurs, like: playing, paused, stopped and completed.
!#zh 视频播放回调函数，该回调函数会在特定情况被触发，比如播放中，暂时，停止和完成播放。 */
videoPlayerEvent: Component.EventHandler[];
/**
!#en If a video is paused, call this method could resume playing. If a video is stopped, call this method to play from scratch.
!#zh 如果视频被暂停播放了，调用这个接口可以继续播放。如果视频被停止播放了，调用这个接口可以从头开始播放。
*/
play(): void;
/**
!#en If a video is paused, call this method to resume playing.
!#zh 如果一个视频播放被暂停播放了，调用这个接口可以继续播放。
*/
resume(): void;
/**
!#en If a video is playing, call this method to pause playing.
!#zh 如果一个视频正在播放，调用这个接口可以暂停播放。
*/
pause(): void;
/**
!#en If a video is playing, call this method to stop playing immediately.
!#zh 如果一个视频正在播放，调用这个接口可以立马停止播放。
*/
stop(): void;
/**
!#en Gets the duration of the video
!#zh 获取视频文件的播放总时长
*/
getDuration(): number;
/**
!#en Determine whether video is playing or not.
!#zh 判断当前视频是否处于播放状态
*/
isPlaying(): boolean;
/**
!#en if you don't need the VideoPlayer and it isn't in any running Scene, you should
call the destroy method on this component or the associated node explicitly.
Otherwise, the created DOM element won't be removed from web page.
!#zh
如果你不再使用 VideoPlayer，并且组件未添加到场景中，那么你必须手动对组件或所在节点调用 destroy。
这样才能移除网页上的 DOM 节点，避免 Web 平台内存泄露。
@example
```js
videoplayer.node.parent = null; // or videoplayer.node.removeFromParent(false);
// when you don't need videoplayer anymore
videoplayer.node.destroy();
```
*/
destroy(): boolean;
}
/** !#en ToggleGroup is not a visiable UI component but a way to modify the behavior of a set of Toggles.
Toggles that belong to the same group could only have one of them to be switched on at a time.
!#zh ToggleGroup 不是一个可见的 UI 组件，它可以用来修改一组 Toggle 组件的行为。当一组 Toggle 属于同一个 ToggleGroup 的时候，
任何时候只能有一个 Toggle 处于选中状态。 */
export class ToggleGroup extends Component {
/** !#en If this setting is true, a toggle could be switched off and on when pressed.
If it is false, it will make sure there is always only one toggle could be switched on
and the already switched on toggle can't be switched off.
!#zh 如果这个设置为 true， 那么 toggle 按钮在被点击的时候可以反复地被选中和未选中。 */
allowSwitchOff: boolean;
/** !#en Read only property, return the toggle items array reference managed by toggleGroup.
!#zh 只读属性，返回 toggleGroup 管理的 toggle 数组引用 */
toggleItems: any[];
}
/** !#en
Handling touch events in a ViewGroup takes special care,
because it's common for a ViewGroup to have children that are targets for different touch events than the ViewGroup itself.
To make sure that each view correctly receives the touch events intended for it,
ViewGroup should register capture phase event and handle the event propagation properly.
Please refer to Scrollview for more information.
!#zh
ViewGroup的事件处理比较特殊，因为 ViewGroup 里面的子节点关心的事件跟 ViewGroup 本身可能不一样。
为了让子节点能够正确地处理事件，ViewGroup 需要注册 capture 阶段的事件，并且合理地处理 ViewGroup 之间的事件传递。
请参考 ScrollView 的实现来获取更多信息。 */
export class ViewGroup extends Component {
}
/** !#en cc.WebView is a component for display web pages in the game
!#zh WebView 组件，用于在游戏中显示网页 */
export class WebView extends _RendererUnderSG {
/** !#en A given URL to be loaded by the WebView, it should have a http or https prefix.
!#zh 指定 WebView 加载的网址，它应该是一个 http 或者 https 开头的字符串 */
url: string;
/** !#en The webview's event callback , it will be triggered when certain webview event occurs.
!#zh WebView 的回调事件，当网页加载过程中，加载完成后或者加载出错时都会回调此函数 */
webviewLoadedEvents: Component.EventHandler[];
/**
!#en
Set javascript interface scheme (see also setOnJSCallback).
Note: Supports only on the Android and iOS. For HTML5, please refer to the official documentation.
Please refer to the official documentation for more details.
!#zh
设置 JavaScript 接口方案（与 'setOnJSCallback' 配套使用）。
注意：只支持 Android 和 iOS ，Web 端用法请前往官方文档查看。
详情请参阅官方文档
@param scheme scheme
*/
setJavascriptInterfaceScheme(scheme: string): void;
/**
!#en
This callback called when load URL that start with javascript
interface scheme (see also setJavascriptInterfaceScheme).
Note: Supports only on the Android and iOS. For HTML5, please refer to the official documentation.
Please refer to the official documentation for more details.
!#zh
当加载 URL 以 JavaScript 接口方案开始时调用这个回调函数。
注意：只支持 Android 和 iOS，Web 端用法请前往官方文档查看。
详情请参阅官方文档
@param callback callback
*/
setOnJSCallback(callback: Function): void;
/**
!#en
Evaluates JavaScript in the context of the currently displayed page.
Please refer to the official document for more details
Note: Cross domain issues need to be resolved by yourself
!#zh
执行 WebView 内部页面脚本（详情请参阅官方文档）
注意：需要自行解决跨域问题
@param str str
*/
evaluateJS(str: string): void;
/**
!#en if you don't need the WebView and it isn't in any running Scene, you should
call the destroy method on this component or the associated node explicitly.
Otherwise, the created DOM element won't be removed from web page.
!#zh
如果你不再使用 WebView，并且组件未添加到场景中，那么你必须手动对组件或所在节点调用 destroy。
这样才能移除网页上的 DOM 节点，避免 Web 平台内存泄露。
@example
```js
webview.node.parent = null; // or webview.node.removeFromParent(false);
// when you don't need webview anymore
webview.node.destroy();
```
*/
destroy(): void;
}
/** !#en
Stores and manipulate the anchoring based on its parent.
Widget are used for GUI but can also be used for other things.
Widget will adjust current node's position and size automatically, but the results after adjustment can not be obtained until the next frame unless you call {{#crossLink "Widget/updateAlignment:method"}}{{/crossLink}} manually.
!#zh
Widget 组件，用于设置和适配其相对于父节点的边距，Widget 通常被用于 UI 界面，也可以用于其他地方。
Widget 会自动调整当前节点的坐标和宽高，不过目前调整后的结果要到下一帧才能在脚本里获取到，除非你先手动调用 {{#crossLink "Widget/updateAlignment:method"}}{{/crossLink}}。 */
export class Widget extends Component {
/** !#en Specifies an alignment target that can only be one of the parent nodes of the current node.
The default value is null, and when null, indicates the current parent.
!#zh 指定一个对齐目标，只能是当前节点的其中一个父节点，默认为空，为空时表示当前父节点。 */
target: Node;
/** !#en Whether to align the top.
!#zh 是否对齐上边。 */
isAlignTop: boolean;
/** !#en
Vertically aligns the midpoint, This will open the other vertical alignment options cancel.
!#zh
是否垂直方向对齐中点，开启此项会将垂直方向其他对齐选项取消。 */
isAlignVerticalCenter: boolean;
/** !#en Whether to align the bottom.
!#zh 是否对齐下边。 */
isAlignBottom: boolean;
/** !#en Whether to align the left.
!#zh 是否对齐左边 */
isAlignLeft: boolean;
/** !#en
Horizontal aligns the midpoint. This will open the other horizontal alignment options canceled.
!#zh
是否水平方向对齐中点，开启此选项会将水平方向其他对齐选项取消。 */
isAlignHorizontalCenter: boolean;
/** !#en Whether to align the right.
!#zh 是否对齐右边。 */
isAlignRight: boolean;
/** !#en
Whether the stretched horizontally, when enable the left and right alignment will be stretched horizontally,
the width setting is invalid (read only).
!#zh
当前是否水平拉伸。当同时启用左右对齐时，节点将会被水平拉伸，此时节点的宽度只读。 */
isStretchWidth: boolean;
/** !#en
Whether the stretched vertically, when enable the left and right alignment will be stretched vertically,
then height setting is invalid (read only)
!#zh
当前是否垂直拉伸。当同时启用上下对齐时，节点将会被垂直拉伸，此时节点的高度只读。 */
isStretchHeight: boolean;
/** !#en
The margins between the top of this node and the top of parent node,
the value can be negative, Only available in 'isAlignTop' open.
!#zh
本节点顶边和父节点顶边的距离，可填写负值，只有在 isAlignTop 开启时才有作用。 */
top: number;
/** !#en
The margins between the bottom of this node and the bottom of parent node,
the value can be negative, Only available in 'isAlignBottom' open.
!#zh
本节点底边和父节点底边的距离，可填写负值，只有在 isAlignBottom 开启时才有作用。 */
bottom: number;
/** !#en
The margins between the left of this node and the left of parent node,
the value can be negative, Only available in 'isAlignLeft' open.
!#zh
本节点左边和父节点左边的距离，可填写负值，只有在 isAlignLeft 开启时才有作用。 */
left: number;
/** !#en
The margins between the right of this node and the right of parent node,
the value can be negative, Only available in 'isAlignRight' open.
!#zh
本节点右边和父节点右边的距离，可填写负值，只有在 isAlignRight 开启时才有作用。 */
right: number;
/** !#en
Horizontal aligns the midpoint offset value,
the value can be negative, Only available in 'isAlignHorizontalCenter' open.
!#zh 水平居中的偏移值，可填写负值，只有在 isAlignHorizontalCenter 开启时才有作用。 */
horizontalCenter: number;
/** !#en
Vertical aligns the midpoint offset value,
the value can be negative, Only available in 'isAlignVerticalCenter' open.
!#zh 垂直居中的偏移值，可填写负值，只有在 isAlignVerticalCenter 开启时才有作用。 */
verticalCenter: number;
/** !#en If true, horizontalCenter is pixel margin, otherwise is percentage (0 - 1) margin.
!#zh 如果为 true，"horizontalCenter" 将会以像素作为偏移值，反之为百分比（0 到 1）。 */
isAbsoluteHorizontalCenter: boolean;
/** !#en If true, verticalCenter is pixel margin, otherwise is percentage (0 - 1) margin.
!#zh 如果为 true，"verticalCenter" 将会以像素作为偏移值，反之为百分比（0 到 1）。 */
isAbsoluteVerticalCenter: boolean;
/** !#en
If true, top is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.
!#zh
如果为 true，"top" 将会以像素作为边距，否则将会以相对父物体高度的百分比（0 到 1）作为边距。 */
isAbsoluteTop: boolean;
/** !#en
If true, bottom is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.
!#zh
如果为 true，"bottom" 将会以像素作为边距，否则将会以相对父物体高度的百分比（0 到 1）作为边距。 */
isAbsoluteBottom: boolean;
/** !#en
If true, left is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.
!#zh
如果为 true，"left" 将会以像素作为边距，否则将会以相对父物体宽度的百分比（0 到 1）作为边距。 */
isAbsoluteLeft: boolean;
/** !#en
If true, right is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.
!#zh
如果为 true，"right" 将会以像素作为边距，否则将会以相对父物体宽度的百分比（0 到 1）作为边距。 */
isAbsoluteRight: boolean;
/** !#en TODO
!#zh
开启后仅会在 onEnable 的当帧结束时对齐一次，然后立刻禁用当前组件。
这样便于脚本或动画继续控制当前节点。
注意：onEnable 时所在的那一帧仍然会进行对齐。 */
isAlignOnce: boolean;
/**
!#en
Immediately perform the widget alignment. You need to manually call this method only if
you need to get the latest results after the alignment before the end of current frame.
!#zh
立刻执行 widget 对齐操作。这个接口一般不需要手工调用。
只有当你需要在当前帧结束前获得 widget 对齐后的最新结果时才需要手动调用这个方法。
@example
```js
widget.top = 10; // change top margin
cc.log(widget.node.y); // not yet changed
widget.updateAlignment();
cc.log(widget.node.y); // changed
```
*/
updateAlignment(): void;
}
/** !#en
EventTarget is an object to which an event is dispatched when something has occurred.
Entity are the most common event targets, but other objects can be event targets too.
Event targets are an important part of the Fireball event model.
The event target serves as the focal point for how events flow through the scene graph.
When an event such as a mouse click or a keypress occurs, Fireball dispatches an event object
into the event flow from the root of the hierarchy. The event object then makes its way through
the scene graph until it reaches the event target, at which point it begins its return trip through
the scene graph. This round-trip journey to the event target is conceptually divided into three phases:
- The capture phase comprises the journey from the root to the last node before the event target's node
- The target phase comprises only the event target node
- The bubbling phase comprises any subsequent nodes encountered on the return trip to the root of the tree
See also: http://www.w3.org/TR/DOM-Level-3-Events/#event-flow
Event targets can implement the following methods:
- _getCapturingTargets
- _getBubblingTargets
!#zh
事件目标是事件触发时，分派的事件对象，Node 是最常见的事件目标，
但是其他对象也可以是事件目标。
*/
export class EventTarget {
/**
!#en
Register an callback of a specific event type on the EventTarget.
!#zh
注册事件目标的特定事件类型回调。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.on(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
on(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
on(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Removes the listeners previously registered with the same type, callback, target and or useCapture,
if only type is passed as parameter, all listeners registered with that type will be removed.
!#zh
删除之前用同类型，回调，目标或 useCapture 注册的事件监听器，如果只传递 type，将会删除 type 类型的所有事件监听器。
@param type A string representing the event type being removed.
@param callback The callback to remove.
@param target The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
@param useCapture Specifies whether the callback being removed was registered as a capturing callback or not.
If not specified, useCapture defaults to false. If a callback was registered twice,
one with capture and one without, each must be removed separately. Removal of a capturing callback
does not affect a non-capturing version of the same listener, and vice versa.
@example
```js
// register touchEnd eventListener
var touchEnd = node.on(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
// remove touch end event listener
node.off(cc.Node.EventType.TOUCH_END, touchEnd, node);
// remove all touch end event listeners
node.off(cc.Node.EventType.TOUCH_END);
```
*/
off(type: string, callback?: Function, target?: any, useCapture?: boolean): void;
/**
!#en Removes all callbacks previously registered with the same target (passed as parameter).
This is not for removing all listeners in the current event target,
and this is not for removing all listeners the target parameter have registered.
It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.
!#zh 在当前 EventTarget 上删除指定目标（target 参数）注册的所有事件监听器。
这个函数无法删除当前 EventTarget 的所有事件监听器，也无法删除 target 参数所注册的所有事件监听器。
这个函数只能删除 target 参数在当前 EventTarget 上注册的所有事件监听器。
@param target The target to be searched for all related listeners
*/
targetOff(target: any): void;
/**
!#en
Register an callback of a specific event type on the EventTarget,
the callback will remove itself after the first time it is triggered.
!#zh
注册事件目标的特定事件类型回调，回调会在第一时间被触发后删除自身。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.once(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
once(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
once(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Dispatches an event into the event flow.
The event target is the EventTarget object upon which the dispatchEvent() method is called.
!#zh 分发事件到事件流中。
@param event The Event object that is dispatched into the event flow
*/
dispatchEvent(event: Event): void;
/**
!#en
Send an event to this object directly, this method will not propagate the event to any other objects.
The event will be created from the supplied message, you can get the "detail" argument from event.detail.
!#zh
该对象直接发送事件， 这种方法不会对事件传播到任何其他对象。
@param message the message to send
@param detail whatever argument the message needs
*/
emit(message: string, detail?: any): void;
}
/** !#en Base class of all kinds of events.
!#zh 包含事件相关信息的对象。 */
export class Event {
/**
@param type The name of the event (case-sensitive), e.g. "click", "fire", or "submit"
@param bubbles A boolean indicating whether the event bubbles up through the tree or not
*/
constructor(type: string, bubbles: boolean);
/** !#en The name of the event (case-sensitive), e.g. "click", "fire", or "submit".
!#zh 事件类型。 */
type: string;
/** !#en Indicate whether the event bubbles up through the tree or not.
!#zh 表示该事件是否进行冒泡。 */
bubbles: boolean;
/** !#en A reference to the target to which the event was originally dispatched.
!#zh 最初事件触发的目标 */
target: any;
/** !#en A reference to the currently registered target for the event.
!#zh 当前目标 */
currentTarget: any;
/** !#en
Indicates which phase of the event flow is currently being evaluated.
Returns an integer value represented by 4 constants:
- Event.NONE = 0
- Event.CAPTURING_PHASE = 1
- Event.AT_TARGET = 2
- Event.BUBBLING_PHASE = 3
The phases are explained in the [section 3.1, Event dispatch and DOM event flow]
(http://www.w3.org/TR/DOM-Level-3-Events/#event-flow), of the DOM Level 3 Events specification.
!#zh 事件阶段 */
eventPhase: number;
/**
!#en Reset the event for being stored in the object pool.
!#zh 重置对象池中存储的事件。
*/
unuse(): string;
/**
!#en Reuse the event for being used again by the object pool.
!#zh 用于对象池再次使用的事件。
*/
reuse(): string;
/**
!#en Stops propagation for current event.
!#zh 停止传递当前事件。
*/
stopPropagation(): void;
/**
!#en Stops propagation for current event immediately,
the event won't even be dispatched to the listeners attached in the current target.
!#zh 立即停止当前事件的传递，事件甚至不会被分派到所连接的当前目标。
*/
stopPropagationImmediate(): void;
/**
!#en Checks whether the event has been stopped.
!#zh 检查该事件是否已经停止传递.
*/
isStopped(): boolean;
/**
!#en
Gets current target of the event
note: It only be available when the event listener is associated with node.
It returns 0 when the listener is associated with fixed priority.
!#zh 获取当前目标节点
*/
getCurrentTarget(): Node;
/**
!#en Gets the event type.
!#zh 获取事件类型
*/
getType(): string;
/** !#en Code for event without type.
!#zh 没有类型的事件 */
static NO_TYPE: string;
/** !#en The type code of Touch event.
!#zh 触摸事件类型 */
static TOUCH: string;
/** !#en The type code of Mouse event.
!#zh 鼠标事件类型 */
static MOUSE: string;
/** !#en The type code of Keyboard event.
!#zh 键盘事件类型 */
static KEYBOARD: string;
/** !#en The type code of Acceleration event.
!#zh 加速器事件类型 */
static ACCELERATION: string;
/** !#en Events not currently dispatched are in this phase
!#zh 尚未派发事件阶段 */
static NONE: number;
/** !#en
The capturing phase comprises the journey from the root to the last node before the event target's node
see http://www.w3.org/TR/DOM-Level-3-Events/#event-flow
!#zh 捕获阶段，包括事件目标节点之前从根节点到最后一个节点的过程。 */
static CAPTURING_PHASE: number;
/** !#en
The target phase comprises only the event target node
see http://www.w3.org/TR/DOM-Level-3-Events/#event-flow
!#zh 目标阶段仅包括事件目标节点。 */
static AT_TARGET: number;
/** !#en
The bubbling phase comprises any subsequent nodes encountered on the return trip to the root of the hierarchy
see http://www.w3.org/TR/DOM-Level-3-Events/#event-flow
!#zh 冒泡阶段， 包括回程遇到到层次根节点的任何后续节点。 */
static BUBBLING_PHASE: number;
}
/** !#en The System event, it currently supports the key events and accelerometer events
!#zh 系统事件，它目前支持按键事件和重力感应事件 */
export class SystemEvent extends EventTarget {
/**
!#en whether enable accelerometer event
!#zh 是否启用加速度计事件
@param isEnable isEnable
*/
setAccelerometerEnabled(isEnable: boolean): void;
/**
!#en set accelerometer interval value
!#zh 设置加速度计间隔值
@param interval interval
*/
setAccelerometerInterval(interval: number): void;
}
/** undefined */
export class Graphics extends _RendererUnderSG {
/** !#en
Current line width.
!#zh
当前线条宽度 */
lineWidth: number;
/** !#en
lineJoin determines how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together.
!#zh
lineJoin 用来设置2个长度不为0的相连部分（线段，圆弧，曲线）如何连接在一起的属性。 */
lineJoin: Graphics.LineJoin;
/** !#en
lineCap determines how the end points of every line are drawn.
!#zh
lineCap 指定如何绘制每一条线段末端。 */
lineCap: Graphics.LineCap;
/** !#en
stroke color
!#zh
线段颜色 */
strokeColor: Color;
/** !#en
fill color
!#zh
填充颜色 */
fillColor: Color;
/** !#en
Sets the miter limit ratio
!#zh
设置斜接面限制比例 */
miterLimit: number;
/**
!#en Move path start point to (x,y).
!#zh 移动路径起点到坐标(x, y)
@param x The x axis of the coordinate for the end point.
@param y The y axis of the coordinate for the end point.
*/
moveTo(x?: number, y?: number): void;
/**
!#en Adds a straight line to the path
!#zh 绘制直线路径
@param x The x axis of the coordinate for the end point.
@param y The y axis of the coordinate for the end point.
*/
lineTo(x?: number, y?: number): void;
/**
!#en Adds a cubic Bézier curve to the path
!#zh 绘制三次贝赛尔曲线路径
@param c1x The x axis of the coordinate for the first control point.
@param c1y The y axis of the coordinate for first control point.
@param c2x The x axis of the coordinate for the second control point.
@param c2y The y axis of the coordinate for the second control point.
@param x The x axis of the coordinate for the end point.
@param y The y axis of the coordinate for the end point.
*/
bezierCurveTo(c1x?: number, c1y?: number, c2x?: number, c2y?: number, x?: number, y?: number): void;
/**
!#en Adds a quadratic Bézier curve to the path
!#zh 绘制二次贝赛尔曲线路径
@param cx The x axis of the coordinate for the control point.
@param cy The y axis of the coordinate for the control point.
@param x The x axis of the coordinate for the end point.
@param y The y axis of the coordinate for the end point.
*/
quadraticCurveTo(cx?: number, cy?: number, x?: number, y?: number): void;
/**
!#en Adds an arc to the path which is centered at (cx, cy) position with radius r starting at startAngle and ending at endAngle going in the given direction by counterclockwise (defaulting to false).
!#zh 绘制圆弧路径。圆弧路径的圆心在 (cx, cy) 位置，半径为 r ，根据 counterclockwise （默认为false）指定的方向从 startAngle 开始绘制，到 endAngle 结束。
@param cx The x axis of the coordinate for the center point.
@param cy The y axis of the coordinate for the center point.
@param r The arc's radius.
@param startAngle The angle at which the arc starts, measured clockwise from the positive x axis and expressed in radians.
@param endAngle The angle at which the arc ends, measured clockwise from the positive x axis and expressed in radians.
@param counterclockwise An optional Boolean which, if true, causes the arc to be drawn counter-clockwise between the two angles. By default it is drawn clockwise.
*/
arc(cx?: number, cy?: number, r?: number, startAngle?: number, endAngle?: number, counterclockwise?: number): void;
/**
!#en Adds an ellipse to the path.
!#zh 绘制椭圆路径。
@param cx The x axis of the coordinate for the center point.
@param cy The y axis of the coordinate for the center point.
@param rx The ellipse's x-axis radius.
@param ry The ellipse's y-axis radius.
*/
ellipse(cx?: number, cy?: number, rx?: number, ry?: number): void;
/**
!#en Adds an circle to the path.
!#zh 绘制圆形路径。
@param cx The x axis of the coordinate for the center point.
@param cy The y axis of the coordinate for the center point.
@param r The circle's radius.
*/
circle(cx?: number, cy?: number, r?: number): void;
/**
!#en Adds an rectangle to the path.
!#zh 绘制矩形路径。
@param x The x axis of the coordinate for the rectangle starting point.
@param y The y axis of the coordinate for the rectangle starting point.
@param w The rectangle's width.
@param h The rectangle's height.
*/
rect(x?: number, y?: number, w?: number, h?: number): void;
/**
!#en Adds an round corner rectangle to the path.
!#zh 绘制圆角矩形路径。
@param x The x axis of the coordinate for the rectangle starting point.
@param y The y axis of the coordinate for the rectangle starting point.
@param w The rectangles width.
@param h The rectangle's height.
@param r The radius of the rectangle.
*/
roundRect(x?: number, y?: number, w?: number, h?: number, r?: number): void;
/**
!#en Draws a filled rectangle.
!#zh 绘制填充矩形。
@param x The x axis of the coordinate for the rectangle starting point.
@param y The y axis of the coordinate for the rectangle starting point.
@param w The rectangle's width.
@param h The rectangle's height.
*/
fillRect(x?: number, y?: number, w?: number, h?: number): void;
/**
!#en Erasing any previously drawn content.
!#zh 擦除之前绘制的所有内容的方法。
@param clean Whether to clean the graphics inner cache.
*/
clear(clean?: boolean): void;
/**
!#en Causes the point of the pen to move back to the start of the current path. It tries to add a straight line from the current point to the start.
!#zh 将笔点返回到当前路径起始点的。它尝试从当前点到起始点绘制一条直线。
*/
close(): void;
/**
!#en Strokes the current or given path with the current stroke style.
!#zh 根据当前的画线样式，绘制当前或已经存在的路径。
*/
stroke(): void;
/**
!#en Fills the current or given path with the current fill style.
!#zh 根据当前的画线样式，填充当前或已经存在的路径。
*/
fill(): void;
}
/** !#en
The base class of event listener.
If you need custom listener which with different callback, you need to inherit this class.
For instance, you could refer to EventListenerAcceleration, EventListenerKeyboard,
EventListenerTouchOneByOne, EventListenerCustom.
!#zh
封装用户的事件处理逻辑。
注意：这是一个抽象类，开发者不应该直接实例化这个类，请参考 {{#crossLink "EventListener/create:method"}}cc.EventListener.create{{/crossLink}}。 */
export class EventListener {
/**
Constructor
@param type type
@param listenerID listenerID
@param callback callback
*/
constructor(type: number, listenerID: number, callback: number);
/**
!#en Checks whether the listener is available.
!#zh 检测监听器是否有效
*/
checkAvailable(): boolean;
/**
!#en Clones the listener, its subclasses have to override this method.
!#zh 克隆监听器,它的子类必须重写此方法。
*/
clone(): EventListener;
/**
!#en Enables or disables the listener
!#zh 启用或禁用监听器。
@param enabled enabled
*/
setEnabled(enabled: boolean): void;
/**
!#en Checks whether the listener is enabled
!#zh 检查监听器是否可用。
*/
isEnabled(): boolean;
/** !#en The type code of unknown event listener.
!#zh 未知的事件监听器类型 */
static UNKNOWN: number;
/** !#en The type code of keyboard event listener.
!#zh 键盘事件监听器类型 */
static KEYBOARD: number;
/** !#en The type code of acceleration event listener.
!#zh 加速器事件监听器类型 */
static ACCELERATION: number;
/**
!#en
Create a EventListener object with configuration including the event type, handlers and other parameters.
In handlers, this refer to the event listener object itself.
You can also pass custom parameters in the configuration object,
all custom parameters will be polyfilled into the event listener object and can be accessed in handlers.
!#zh 通过指定不同的 Event 对象来设置想要创建的事件监听器。
@param argObj a json object
@example
```js
// Create KEYBOARD EventListener.
cc.EventListener.create({
event: cc.EventListener.KEYBOARD,
onKeyPressed: function (keyCode, event) {
cc.log('pressed key: ' + keyCode);
},
onKeyReleased: function (keyCode, event) {
cc.log('released key: ' + keyCode);
}
});
// Create ACCELERATION EventListener.
cc.EventListener.create({
event: cc.EventListener.ACCELERATION,
callback: function (acc, event) {
cc.log('acc: ' + keyCode);
}
});
```
*/
static create(argObj: any): EventListener;
}
/** !#en
This class has been deprecated, please use cc.systemEvent or cc.EventTarget instead. See [Listen to and launch events](../../../manual/en/scripting/events.md) for details.
cc.eventManager is a singleton object which manages event listener subscriptions and event dispatching.
The EventListener list is managed in such way so that event listeners can be added and removed
while events are being dispatched.
!#zh
该类已废弃，请使用 cc.systemEvent 或 cc.EventTarget 代替，详见 [监听和发射事件](../../../manual/zh/scripting/events.md)。
事件管理器，它主要管理事件监听器注册和派发系统事件。 */
export class eventManager {
/**
!#en Pauses all listeners which are associated the specified target.
!#zh 暂停传入的 node 相关的所有监听器的事件响应。
@param node node
@param recursive recursive
*/
static pauseTarget(node: Node, recursive?: boolean): void;
/**
!#en Resumes all listeners which are associated the specified target.
!#zh 恢复传入的 node 相关的所有监听器的事件响应。
@param node node
@param recursive recursive
*/
static resumeTarget(node: Node, recursive?: boolean): void;
/**
!#en Query whether the specified event listener id has been added.
!#zh 查询指定的事件 ID 是否存在
@param listenerID The listener id.
*/
static hasEventListener(listenerID: string|number): boolean;
/**
!#en
Adds a event listener for a specified event.
if the parameter "nodeOrPriority" is a node,
it means to add a event listener for a specified event with the priority of scene graph.
if the parameter "nodeOrPriority" is a Number,
it means to add a event listener for a specified event with the fixed priority.
!#zh
将事件监听器添加到事件管理器中。
如果参数 “nodeOrPriority” 是节点，优先级由 node 的渲染顺序决定，显示在上层的节点将优先收到事件。
如果参数 “nodeOrPriority” 是数字，优先级则固定为该参数的数值，数字越小，优先级越高。
@param listener The listener of a specified event or a object of some event parameters.
@param nodeOrPriority The priority of the listener is based on the draw order of this node or fixedPriority The fixed priority of the listener.
*/
static addListener(listener: EventListener|any, nodeOrPriority: Node|number): EventListener;
/**
!#en Remove a listener.
!#zh 移除一个已添加的监听器。
@param listener an event listener or a registered node target
@example
```js
// 1. remove eventManager add Listener;
var mouseListener1 = cc.eventManager.addListener({
event: cc.EventListener.MOUSE,
onMouseDown: function(keyCode, event){ },
onMouseUp: function(keyCode, event){ },
onMouseMove: function () { },
onMouseScroll: function () { }
}, node);
cc.eventManager.removeListener(mouseListener1);
// 2. remove eventListener create Listener;
var mouseListener2 = cc.EventListener.create({
event: cc.EventListener.MOUSE,
onMouseDown: function(keyCode, event){ },
onMouseUp: function(keyCode, event){ },
onMouseMove: function () { },
onMouseScroll: function () { }
});
cc.eventManager.removeListener(mouseListener2);
```
*/
static removeListener(listener: EventListener): void;
/**
!#en Removes all listeners with the same event listener type or removes all listeners of a node.
!#zh
移除注册到 eventManager 中指定类型的所有事件监听器。
1. 如果传入的第一个参数类型是 Node，那么事件管理器将移除与该对象相关的所有事件监听器。
（如果第二参数 recursive 是 true 的话，就会连同该对象的子控件上所有的事件监听器也一并移除）
2. 如果传入的第一个参数类型是 Number（该类型 EventListener 中定义的事件类型），
那么事件管理器将移除该类型的所有事件监听器。
下列是目前存在监听器类型：
cc.EventListener.UNKNOWN
cc.EventListener.KEYBOARD
cc.EventListener.ACCELERATION，
@param listenerType listenerType or a node
@param recursive recursive
*/
static removeListeners(listenerType: number|Node, recursive?: boolean): void;
/**
!#en Removes all listeners
!#zh 移除所有事件监听器。
*/
static removeAllListeners(): void;
/**
!#en Sets listener's priority with fixed value.
!#zh 设置 FixedPriority 类型监听器的优先级。
@param listener listener
@param fixedPriority fixedPriority
*/
static setPriority(listener: EventListener, fixedPriority: number): void;
/**
!#en Whether to enable dispatching events
!#zh 启用或禁用事件管理器，禁用后不会分发任何事件。
@param enabled enabled
*/
static setEnabled(enabled: boolean): void;
/**
!#en Checks whether dispatching events is enabled
!#zh 检测事件管理器是否启用。
*/
static isEnabled(): boolean;
}
/** !#en The touch event class
!#zh 封装了触摸相关的信息。 */
export class Touch {
/**
!#en Returns the current touch location in OpenGL coordinates.、
!#zh 获取当前触点位置。
*/
getLocation(): Vec2;
/**
!#en Returns X axis location value.
!#zh 获取当前触点 X 轴位置。
*/
getLocationX(): number;
/**
!#en Returns Y axis location value.
!#zh 获取当前触点 Y 轴位置。
*/
getLocationY(): number;
/**
!#en Returns the previous touch location in OpenGL coordinates.
!#zh 获取触点在上一次事件时的位置对象，对象包含 x 和 y 属性。
*/
getPreviousLocation(): Vec2;
/**
!#en Returns the start touch location in OpenGL coordinates.
!#zh 获获取触点落下时的位置对象，对象包含 x 和 y 属性。
*/
getStartLocation(): Vec2;
/**
!#en Returns the delta distance from the previous touche to the current one in screen coordinates.
!#zh 获取触点距离上一次事件移动的距离对象，对象包含 x 和 y 属性。
*/
getDelta(): Vec2;
/**
!#en Returns the current touch location in screen coordinates.
!#zh 获取当前事件在游戏窗口内的坐标位置对象，对象包含 x 和 y 属性。
*/
getLocationInView(): Vec2;
/**
!#en Returns the previous touch location in screen coordinates.
!#zh 获取触点在上一次事件时在游戏窗口中的位置对象，对象包含 x 和 y 属性。
*/
getPreviousLocationInView(): Vec2;
/**
!#en Returns the start touch location in screen coordinates.
!#zh 获取触点落下时在游戏窗口中的位置对象，对象包含 x 和 y 属性。
*/
getStartLocationInView(): Vec2;
/**
!#en Returns the id of cc.Touch.
!#zh 触点的标识 ID，可以用来在多点触摸中跟踪触点。
*/
getID(): number;
/**
!#en Sets information to touch.
!#zh 设置触摸相关的信息。用于监控触摸事件。
@param id id
@param x x
@param y y
*/
setTouchInfo(id: number, x: number, y: number): void;
}
/** Loader for resource loading process. It's a singleton object. */
export class loader extends Pipeline {
/** The asset loader in cc.loader's pipeline, it's by default the first pipe.
It's used to identify an asset's type, and determine how to download it. */
static assetLoader: any;
/** The downloader in cc.loader's pipeline, it's by default the second pipe.
It's used to download files with several handlers: pure text, image, script, audio, font, uuid.
You can add your own download function with addDownloadHandlers */
static downloader: any;
/** The downloader in cc.loader's pipeline, it's by default the third pipe.
It's used to parse downloaded content with several handlers: JSON, image, plist, fnt, uuid.
You can add your own download function with addLoadHandlers */
static loader: any;
/**
Gets a new XMLHttpRequest instance.
*/
static getXMLHttpRequest(): XMLHttpRequest;
/**
Add custom supported types handler or modify existing type handler for download process.
@param extMap Custom supported types with corresponded handler
@example
```js
cc.loader.addDownloadHandlers({
// This will match all url with `.scene` extension or all url with `scene` type
'scene' : function (url, callback) {}
});
```
*/
static addDownloadHandlers(extMap: any): void;
/**
Add custom supported types handler or modify existing type handler for load process.
@param extMap Custom supported types with corresponded handler
@example
```js
cc.loader.addLoadHandlers({
// This will match all url with `.scene` extension or all url with `scene` type
'scene' : function (url, callback) {}
});
```
*/
static addLoadHandlers(extMap: any): void;
/**
Load resources with a progression callback and a complete callback.
The progression callback is the same as Pipeline's {{#crossLink "LoadingItems/onProgress:method"}}onProgress{{/crossLink}}
The complete callback is almost the same as Pipeline's {{#crossLink "LoadingItems/onComplete:method"}}onComplete{{/crossLink}}
The only difference is when user pass a single url as resources, the complete callback will set its result directly as the second parameter.
@param resources Url list in an array
@param progressCallback Callback invoked when progression change
@param completeCallback Callback invoked when all resources loaded
@example
```js
cc.loader.load('a.png', function (err, tex) {
cc.log('Result should be a texture: ' + (tex instanceof cc.Texture2D));
});
cc.loader.load('http://example.com/a.png', function (err, tex) {
cc.log('Should load a texture from external url: ' + (tex instanceof cc.Texture2D));
});
cc.loader.load({url: 'http://example.com/getImageREST?file=a.png', type: 'png'}, function (err, tex) {
cc.log('Should load a texture from RESTful API by specify the type: ' + (tex instanceof cc.Texture2D));
});
cc.loader.load(['a.png', 'b.json'], function (errors, results) {
if (errors) {
for (var i = 0; i < errors.length; i++) {
cc.log('Error url [' + errors[i] + ']: ' + results.getError(errors[i]));
}
}
var aTex = results.getContent('a.png');
var bJsonObj = results.getContent('b.json');
});
```
*/
static load(resources: string|string[]|{uuid?: string, url?: string, type?: string}, completeCallback?: Function): void;
static load(resources: string|string[]|{uuid?: string, url?: string, type?: string}, progressCallback: (completedCount: number, totalCount: number, item: any) => void, completeCallback: Function|null): void;
/**
Load resources from the "resources" folder inside the "assets" folder of your project.
Note: All asset URLs in Creator use forward slashes, URLs using backslashes will not work.
@param url Url of the target resource.
The url is relative to the "resources" folder, extensions must be omitted.
@param type Only asset of type will be loaded if this argument is supplied.
@param progressCallback Callback invoked when progression change.
@param completeCallback Callback invoked when the resource loaded.
@example
```js
// load the prefab (project/assets/resources/misc/character/cocos) from resources folder
cc.loader.loadRes('misc/character/cocos', function (err, prefab) {
if (err) {
cc.error(err.message || err);
return;
}
cc.log('Result should be a prefab: ' + (prefab instanceof cc.Prefab));
});
// load the sprite frame of (project/assets/resources/imgs/cocos.png) from resources folder
cc.loader.loadRes('imgs/cocos', cc.SpriteFrame, function (err, spriteFrame) {
if (err) {
cc.error(err.message || err);
return;
}
cc.log('Result should be a sprite frame: ' + (spriteFrame instanceof cc.SpriteFrame));
});
```
*/
static loadRes(url: string, type: typeof cc.Asset, progressCallback: (completedCount: number, totalCount: number, item: any) => void, completeCallback: ((error: Error, resource: any) => void)|null): void;
static loadRes(url: string, type: typeof cc.Asset, completeCallback: (error: Error, resource: any) => void): void;
static loadRes(url: string, type: typeof cc.Asset): void;
static loadRes(url: string, progressCallback: (completedCount: number, totalCount: number, item: any) => void, completeCallback: ((error: Error, resource: any) => void)|null): void;
static loadRes(url: string, completeCallback: (error: Error, resource: any) => void): void;
static loadRes(url: string): void;
/**
This method is like {{#crossLink "loader/loadRes:method"}}{{/crossLink}} except that it accepts array of url.
@param urls Array of URLs of the target resource.
The url is relative to the "resources" folder, extensions must be omitted.
@param type Only asset of type will be loaded if this argument is supplied.
@param progressCallback Callback invoked when progression change.
@param completeCallback A callback which is called when all assets have been loaded, or an error occurs.
@example
```js
// load the SpriteFrames from resources folder
var spriteFrames;
var urls = ['misc/characters/character_01', 'misc/weapons/weapons_01'];
cc.loader.loadResArray(urls, cc.SpriteFrame, function (err, assets) {
if (err) {
cc.error(err);
return;
}
spriteFrames = assets;
// ...
});
```
*/
static loadResArray(url: string[], type: typeof cc.Asset, progressCallback: (completedCount: number, totalCount: number, item: any) => void, completeCallback: ((error: Error, resource: any[]) => void)|null): void;
static loadResArray(url: string[], type: typeof cc.Asset, completeCallback: (error: Error, resource: any[]) => void): void;
static loadResArray(url: string[], type: typeof cc.Asset): void;
static loadResArray(url: string[], progressCallback: (completedCount: number, totalCount: number, item: any) => void, completeCallback: ((error: Error, resource: any[]) => void)|null): void;
static loadResArray(url: string[], completeCallback: (error: Error, resource: any[]) => void): void;
static loadResArray(url: string[]): void;
/**
Load all assets in a folder inside the "assets/resources" folder of your project.
Note: All asset URLs in Creator use forward slashes, URLs using backslashes will not work.
@param url Url of the target folder.
The url is relative to the "resources" folder, extensions must be omitted.
@param type Only asset of type will be loaded if this argument is supplied.
@param progressCallback Callback invoked when progression change.
@param completeCallback A callback which is called when all assets have been loaded, or an error occurs.
@example
```js
// load the texture (resources/imgs/cocos.png) and the corresponding sprite frame
cc.loader.loadResDir('imgs/cocos', function (err, assets) {
if (err) {
cc.error(err);
return;
}
var texture = assets[0];
var spriteFrame = assets[1];
});
// load all textures in "resources/imgs/"
cc.loader.loadResDir('imgs', cc.Texture2D, function (err, textures) {
var texture1 = textures[0];
var texture2 = textures[1];
});
// load all JSONs in "resources/data/"
cc.loader.loadResDir('data', function (err, objects, urls) {
var data = objects[0];
var url = urls[0];
});
```
*/
static loadResDir(url: string, type: typeof cc.Asset, progressCallback: (completedCount: number, totalCount: number, item: any) => void, completeCallback: ((error: Error, resource: any[], urls: string[]) => void)|null): void;
static loadResDir(url: string, type: typeof cc.Asset, completeCallback: (error: Error, resource: any[], urls: string[]) => void): void;
static loadResDir(url: string, type: typeof cc.Asset): void;
static loadResDir(url: string, progressCallback: (completedCount: number, totalCount: number, item: any) => void, completeCallback: ((error: Error, resource: any[], urls: string[]) => void)|null): void;
static loadResDir(url: string, completeCallback: (error: Error, resource: any[], urls: string[]) => void): void;
static loadResDir(url: string): void;
/**
Get resource data by id.
When you load resources with {{#crossLink "loader/load:method"}}{{/crossLink}} or {{#crossLink "loader/loadRes:method"}}{{/crossLink}},
the url will be the unique identity of the resource.
After loaded, you can acquire them by passing the url to this API.
@param url url
@param type Only asset of type will be returned if this argument is supplied.
*/
static getRes(url: string, type?: Function): any;
/**
!#en Get all resource dependencies of the requested asset in an array, including itself.
The owner parameter accept the following types: 1. The asset itself; 2. The resource url; 3. The asset's uuid.
The returned array stores the dependencies with their uuids, after retrieve dependencies,
you can release them, access dependent assets by passing the uuid to {{#crossLink "loader/getRes:method"}}{{/crossLink}}, or other stuffs you want.
For release all dependencies of an asset, please refer to {{#crossLink "loader/release:method"}}{{/crossLink}}
Here is some examples:
!#zh 获取一个指定资源的所有依赖资源，包含它自身，并保存在数组中返回。owner 参数接收以下几种类型：1. 资源 asset 对象；2. 资源目录下的 url；3. 资源的 uuid。
返回的数组将仅保存依赖资源的 uuid，获取这些 uuid 后，你可以从 loader 释放这些资源；通过 {{#crossLink "loader/getRes:method"}}{{/crossLink}} 获取某个资源或者进行其他你需要的操作。
想要释放一个资源及其依赖资源，可以参考 {{#crossLink "loader/release:method"}}{{/crossLink}}。下面是一些示例代码：
@param owner The owner asset or the resource url or the asset's uuid
@example
```js
// Release all dependencies of a loaded prefab
var deps = cc.loader.getDependsRecursively(prefab);
cc.loader.release(deps);
// Retrieve all dependent textures
var deps = cc.loader.getDependsRecursively('prefabs/sample');
var textures = [];
for (var i = 0; i < deps.length; ++i) {
var item = cc.loader.getRes(deps[i]);
if (item instanceof cc.Texture2D) {
textures.push(item);
}
}
```
*/
static getDependsRecursively(owner: Asset|RawAsset|string): any[];
/**
!#en
Release the content of an asset or an array of assets by uuid.
Start from v1.3, this method will not only remove the cache of the asset in loader, but also clean up its content.
For example, if you release a texture, the texture asset and its gl texture data will be freed up.
In complexe project, you can use this function with {{#crossLink "loader/getDependsRecursively:method"}}{{/crossLink}} to free up memory in critical circumstances.
Notice, this method may cause the texture to be unusable, if there are still other nodes use the same texture, they may turn to black and report gl errors.
If you only want to remove the cache of an asset, please use {{#crossLink "pipeline/removeItem:method"}}{{/crossLink}}
!#zh
通过 id（通常是资源 url）来释放一个资源或者一个资源数组。
从 v1.3 开始，这个方法不仅会从 loader 中删除资源的缓存引用，还会清理它的资源内容。
比如说，当你释放一个 texture 资源，这个 texture 和它的 gl 贴图数据都会被释放。
在复杂项目中，我们建议你结合 {{#crossLink "loader/getDependsRecursively:method"}}{{/crossLink}} 来使用，便于在设备内存告急的情况下更快地释放不再需要的资源的内存。
注意，这个函数可能会导致资源贴图或资源所依赖的贴图不可用，如果场景中存在节点仍然依赖同样的贴图，它们可能会变黑并报 GL 错误。
如果你只想删除一个资源的缓存引用，请使用 {{#crossLink "pipeline/removeItem:method"}}{{/crossLink}}
@param asset asset
@example
```js
// Release a texture which is no longer need
cc.loader.release(texture);
// Release all dependencies of a loaded prefab
var deps = cc.loader.getDependsRecursively('prefabs/sample');
cc.loader.release(deps);
// If there is no instance of this prefab in the scene, the prefab and its dependencies like textures, sprite frames, etc, will be freed up.
// If you have some other nodes share a texture in this prefab, you can skip it in two ways:
// 1. Forbid auto release a texture before release
cc.loader.setAutoRelease(texture2d, false);
// 2. Remove it from the dependencies array
var deps = cc.loader.getDependsRecursively('prefabs/sample');
var index = deps.indexOf(texture2d._uuid);
if (index !== -1)
deps.splice(index, 1);
cc.loader.release(deps);
```
*/
static release(asset: Asset|RawAsset|string|any[]): void;
/**
!#en Release the asset by its object. Refer to {{#crossLink "loader/release:method"}}{{/crossLink}} for detailed informations.
!#zh 通过资源对象自身来释放资源。详细信息请参考 {{#crossLink "loader/release:method"}}{{/crossLink}}
@param asset asset
*/
static releaseAsset(asset: Asset): void;
/**
!#en Release the asset loaded by {{#crossLink "loader/loadRes:method"}}{{/crossLink}}. Refer to {{#crossLink "loader/release:method"}}{{/crossLink}} for detailed informations.
!#zh 释放通过 {{#crossLink "loader/loadRes:method"}}{{/crossLink}} 加载的资源。详细信息请参考 {{#crossLink "loader/release:method"}}{{/crossLink}}
@param url url
@param type Only asset of type will be released if this argument is supplied.
*/
static releaseRes(url: string, type?: Function): void;
/**
!#en Release the all assets loaded by {{#crossLink "loader/loadResDir:method"}}{{/crossLink}}. Refer to {{#crossLink "loader/release:method"}}{{/crossLink}} for detailed informations.
!#zh 释放通过 {{#crossLink "loader/loadResDir:method"}}{{/crossLink}} 加载的资源。详细信息请参考 {{#crossLink "loader/release:method"}}{{/crossLink}}
@param url url
@param type Only asset of type will be released if this argument is supplied.
*/
static releaseResDir(url: string, type?: Function): void;
/**
!#en Resource all assets. Refer to {{#crossLink "loader/release:method"}}{{/crossLink}} for detailed informations.
!#zh 释放所有资源。详细信息请参考 {{#crossLink "loader/release:method"}}{{/crossLink}}
*/
static releaseAll(): void;
/**
!#en
Indicates whether to release the asset when loading a new scene.
By default, when loading a new scene, all assets in the previous scene will be released or preserved
according to whether the previous scene checked the "Auto Release Assets" option.
On the other hand, assets dynamically loaded by using `cc.loader.loadRes` or `cc.loader.loadResDir`
will not be affected by that option, remain not released by default.
Use this API to change the default behavior on a single asset, to force preserve or release specified asset when scene switching.
See: {{#crossLink "loader/setAutoReleaseRecursively:method"}}cc.loader.setAutoReleaseRecursively{{/crossLink}}, {{#crossLink "loader/isAutoRelease:method"}}cc.loader.isAutoRelease{{/crossLink}}
!#zh
设置当场景切换时是否自动释放资源。
默认情况下，当加载新场景时，旧场景的资源根据旧场景是否勾选“Auto Release Assets”，将会被释放或者保留。
而使用 `cc.loader.loadRes` 或 `cc.loader.loadResDir` 动态加载的资源，则不受场景设置的影响，默认不自动释放。
使用这个 API 可以在单个资源上改变这个默认行为，强制在切换场景时保留或者释放指定资源。
参考：{{#crossLink "loader/setAutoReleaseRecursively:method"}}cc.loader.setAutoReleaseRecursively{{/crossLink}}，{{#crossLink "loader/isAutoRelease:method"}}cc.loader.isAutoRelease{{/crossLink}}
@param assetOrUrlOrUuid asset object or the raw asset's url or uuid
@param autoRelease indicates whether should release automatically
@example
```js
// auto release the texture event if "Auto Release Assets" disabled in current scene
cc.loader.setAutoRelease(texture2d, true);
// don't release the texture even if "Auto Release Assets" enabled in current scene
cc.loader.setAutoRelease(texture2d, false);
// first parameter can be url
cc.loader.setAutoRelease(audioUrl, false);
```
*/
static setAutoRelease(assetOrUrlOrUuid: Asset|string, autoRelease: boolean): void;
/**
!#en
Indicates whether to release the asset and its referenced other assets when loading a new scene.
By default, when loading a new scene, all assets in the previous scene will be released or preserved
according to whether the previous scene checked the "Auto Release Assets" option.
On the other hand, assets dynamically loaded by using `cc.loader.loadRes` or `cc.loader.loadResDir`
will not be affected by that option, remain not released by default.
Use this API to change the default behavior on the specified asset and its recursively referenced assets, to force preserve or release specified asset when scene switching.
See: {{#crossLink "loader/setAutoRelease:method"}}cc.loader.setAutoRelease{{/crossLink}}, {{#crossLink "loader/isAutoRelease:method"}}cc.loader.isAutoRelease{{/crossLink}}
!#zh
设置当场景切换时是否自动释放资源及资源引用的其它资源。
默认情况下，当加载新场景时，旧场景的资源根据旧场景是否勾选“Auto Release Assets”，将会被释放或者保留。
而使用 `cc.loader.loadRes` 或 `cc.loader.loadResDir` 动态加载的资源，则不受场景设置的影响，默认不自动释放。
使用这个 API 可以在指定资源及资源递归引用到的所有资源上改变这个默认行为，强制在切换场景时保留或者释放指定资源。
参考：{{#crossLink "loader/setAutoRelease:method"}}cc.loader.setAutoRelease{{/crossLink}}，{{#crossLink "loader/isAutoRelease:method"}}cc.loader.isAutoRelease{{/crossLink}}
@param assetOrUrlOrUuid asset object or the raw asset's url or uuid
@param autoRelease indicates whether should release automatically
@example
```js
// auto release the SpriteFrame and its Texture event if "Auto Release Assets" disabled in current scene
cc.loader.setAutoReleaseRecursively(spriteFrame, true);
// don't release the SpriteFrame and its Texture even if "Auto Release Assets" enabled in current scene
cc.loader.setAutoReleaseRecursively(spriteFrame, false);
// don't release the Prefab and all the referenced assets
cc.loader.setAutoReleaseRecursively(prefab, false);
```
*/
static setAutoReleaseRecursively(assetOrUrlOrUuid: Asset|string, autoRelease: boolean): void;
/**
!#en
Returns whether the asset is configured as auto released, despite how "Auto Release Assets" property is set on scene asset.
See: {{#crossLink "loader/setAutoRelease:method"}}cc.loader.setAutoRelease{{/crossLink}}, {{#crossLink "loader/setAutoReleaseRecursively:method"}}cc.loader.setAutoReleaseRecursively{{/crossLink}}
!#zh
返回指定的资源是否有被设置为自动释放，不论场景的“Auto Release Assets”如何设置。
参考：{{#crossLink "loader/setAutoRelease:method"}}cc.loader.setAutoRelease{{/crossLink}}，{{#crossLink "loader/setAutoReleaseRecursively:method"}}cc.loader.setAutoReleaseRecursively{{/crossLink}}
@param assetOrUrl asset object or the raw asset's url
*/
static isAutoRelease(assetOrUrl: Asset|string): boolean;
}
/** !#en
LoadingItems is the queue of items which can flow them into the loading pipeline.
Please don't construct it directly, use {{#crossLink "LoadingItems.create"}}LoadingItems.create{{/crossLink}} instead, because we use an internal pool to recycle the queues.
It hold a map of items, each entry in the map is a url to object key value pair.
Each item always contains the following property:
- id: The identification of the item, usually it's identical to url
- url: The url
- type: The type, it's the extension name of the url by default, could be specified manually too.
- error: The error happened in pipeline will be stored in this property.
- content: The content processed by the pipeline, the final result will also be stored in this property.
- complete: The flag indicate whether the item is completed by the pipeline.
- states: An object stores the states of each pipe the item go through, the state can be: Pipeline.ItemState.WORKING | Pipeline.ItemState.ERROR | Pipeline.ItemState.COMPLETE
Item can hold other custom properties.
Each LoadingItems object will be destroyed for recycle after onComplete callback
So please don't hold its reference for later usage, you can copy properties in it though.
!#zh
LoadingItems 是一个加载对象队列，可以用来输送加载对象到加载管线中。
请不要直接使用 new 构造这个类的对象，你可以使用 {{#crossLink "LoadingItems.create"}}LoadingItems.create{{/crossLink}} 来创建一个新的加载队列，这样可以允许我们的内部对象池回收并重利用加载队列。
它有一个 map 属性用来存放加载项，在 map 对象中已 url 为 key 值。
每个对象都会包含下列属性：
- id：该对象的标识，通常与 url 相同。
- url：路径
- type: 类型，它这是默认的 URL 的扩展名，可以手动指定赋值。
- error：pipeline 中发生的错误将被保存在这个属性中。
- content: pipeline 中处理的临时结果，最终的结果也将被存储在这个属性中。
- complete：该标志表明该对象是否通过 pipeline 完成。
- states：该对象存储每个管道中对象经历的状态，状态可以是 Pipeline.ItemState.WORKING | Pipeline.ItemState.ERROR | Pipeline.ItemState.COMPLETE
对象可容纳其他自定义属性。
每个 LoadingItems 对象都会在 onComplete 回调之后被销毁，所以请不要持有它的引用并在结束回调之后依赖它的内容执行任何逻辑，有这种需求的话你可以提前复制它的内容。 */
export class LoadingItems extends CallbacksInvoker {
/**
!#en This is a callback which will be invoked while an item flow out the pipeline.
You can pass the callback function in LoadingItems.create or set it later.
!#zh 这个回调函数将在 item 加载结束后被调用。你可以在构造时传递这个回调函数或者是在构造之后直接设置。
@param completedCount The number of the items that are already completed.
@param totalCount The total number of the items.
@param item The latest item which flow out the pipeline.
@example
```js
loadingItems.onProgress = function (completedCount, totalCount, item) {
var progress = (100 * completedCount / totalCount).toFixed(2);
cc.log(progress + '%');
}
```
*/
onProgress(completedCount: number, totalCount: number, item: any): void;
/**
!#en This is a callback which will be invoked while all items is completed,
You can pass the callback function in LoadingItems.create or set it later.
!#zh 该函数将在加载队列全部完成时被调用。你可以在构造时传递这个回调函数或者是在构造之后直接设置。
@param errors All errored urls will be stored in this array, if no error happened, then it will be null
@param items All items.
@example
```js
loadingItems.onComplete = function (errors, items) {
if (error)
cc.log('Completed with ' + errors.length + ' errors');
else
cc.log('Completed ' + items.totalCount + ' items');
}
```
*/
onComplete(errors: any[], items: LoadingItems): void;
/** !#en The map of all items.
!#zh 存储所有加载项的对象。 */
map: any;
/** !#en The map of completed items.
!#zh 存储已经完成的加载项。 */
completed: any;
/** !#en Total count of all items.
!#zh 所有加载项的总数。 */
totalCount: number;
/** !#en Total count of completed items.
!#zh 所有完成加载项的总数。 */
completedCount: number;
/** !#en Activated or not.
!#zh 是否启用。 */
active: boolean;
/**
!#en The constructor function of LoadingItems, this will use recycled LoadingItems in the internal pool if possible.
You can pass onProgress and onComplete callbacks to visualize the loading process.
!#zh LoadingItems 的构造函数，这种构造方式会重用内部对象缓冲池中的 LoadingItems 队列，以尽量避免对象创建。
你可以传递 onProgress 和 onComplete 回调函数来获知加载进度信息。
@param pipeline The pipeline to process the queue.
@param urlList The items array.
@param onProgress The progression callback, refer to {{#crossLink "LoadingItems.onProgress"}}{{/crossLink}}
@param onComplete The completion callback, refer to {{#crossLink "LoadingItems.onComplete"}}{{/crossLink}}
@example
```js
LoadingItems.create(cc.loader, ['a.png', 'b.plist'], function (completedCount, totalCount, item) {
var progress = (100 * completedCount / totalCount).toFixed(2);
cc.log(progress + '%');
}, function (errors, items) {
if (errors) {
for (var i = 0; i < errors.length; ++i) {
cc.log('Error url: ' + errors[i] + ', error: ' + items.getError(errors[i]));
}
}
else {
var result_a = items.getContent('a.png');
// ...
}
})
```
*/
static create(pipeline: Pipeline, urlList: any[], onProgress: Function, onComplete: Function): LoadingItems;
/**
!#en Retrieve the LoadingItems queue object for an item.
!#zh 通过 item 对象获取它的 LoadingItems 队列。
@param item The item to query
*/
static getQueue(item: any): LoadingItems;
/**
!#en Complete an item in the LoadingItems queue, please do not call this method unless you know what's happening.
!#zh 通知 LoadingItems 队列一个 item 对象已完成，请不要调用这个函数，除非你知道自己在做什么。
@param item The item which has completed
*/
static itemComplete(item: any): void;
/**
!#en Add urls to the LoadingItems queue.
!#zh 向一个 LoadingItems 队列添加加载项。
@param urlList The url list to be appended, the url can be object or string
*/
append(urlList: any[]): any[];
/**
!#en Complete a LoadingItems queue, please do not call this method unless you know what's happening.
!#zh 完成一个 LoadingItems 队列，请不要调用这个函数，除非你知道自己在做什么。
*/
allComplete(): void;
/**
!#en Check whether all items are completed.
!#zh 检查是否所有加载项都已经完成。
*/
isCompleted(): boolean;
/**
!#en Check whether an item is completed.
!#zh 通过 id 检查指定加载项是否已经加载完成。
@param id The item's id.
*/
isItemCompleted(id: string): boolean;
/**
!#en Check whether an item exists.
!#zh 通过 id 检查加载项是否存在。
@param id The item's id.
*/
exists(id: string): boolean;
/**
!#en Returns the content of an internal item.
!#zh 通过 id 获取指定对象的内容。
@param id The item's id.
*/
getContent(id: string): any;
/**
!#en Returns the error of an internal item.
!#zh 通过 id 获取指定对象的错误信息。
@param id The item's id.
*/
getError(id: string): any;
/**
!#en Add a listener for an item, the callback will be invoked when the item is completed.
!#zh 监听加载项（通过 key 指定）的完成事件。
@param key key
@param callback can be null
@param target can be null
*/
addListener(key: string, callback: Function, target: any): boolean;
/**
!#en
Check if the specified key has any registered callback.
If a callback is also specified, it will only return true if the callback is registered.
!#zh
检查指定的加载项是否有完成事件监听器。
如果同时还指定了一个回调方法，并且回调有注册，它只会返回 true。
@param key key
@param callback callback
@param target target
*/
hasListener(key: string, callback?: Function, target?: any): boolean;
/**
!#en
Removes a listener.
It will only remove when key, callback, target all match correctly.
!#zh
移除指定加载项已经注册的完成事件监听器。
只会删除 key, callback, target 均匹配的监听器。
@param key key
@param callback callback
@param target target
*/
remove(key: string, callback: Function, target: any): boolean;
/**
!#en
Removes all callbacks registered in a certain event
type or all callbacks registered with a certain target.
!#zh 删除指定目标的所有完成事件监听器。
@param key The event key to be removed or the target to be removed
*/
removeAllListeners(key: string|any): void;
/**
!#en Complete an item in the LoadingItems queue, please do not call this method unless you know what's happening.
!#zh 通知 LoadingItems 队列一个 item 对象已完成，请不要调用这个函数，除非你知道自己在做什么。
@param id The item url
*/
itemComplete(id: string): void;
/**
!#en Destroy the LoadingItems queue, the queue object won't be garbage collected, it will be recycled, so every after destroy is not reliable.
!#zh 销毁一个 LoadingItems 队列，这个队列对象会被内部缓冲池回收，所以销毁后的所有内部信息都是不可依赖的。
*/
destroy(): void;
}
/** !#en
A pipeline describes a sequence of manipulations, each manipulation is called a pipe.
It's designed for loading process. so items should be urls, and the url will be the identity of each item during the process.
A list of items can flow in the pipeline and it will output the results of all pipes.
They flow in the pipeline like water in tubes, they go through pipe by pipe separately.
Finally all items will flow out the pipeline and the process is finished.
!#zh
pipeline 描述了一系列的操作，每个操作都被称为 pipe。
它被设计来做加载过程的流程管理。所以 item 应该是 url，并且该 url 将是在处理中的每个 item 的身份标识。
一个 item 列表可以在 pipeline 中流动，它将输出加载项经过所有 pipe 之后的结果。
它们穿过 pipeline 就像水在管子里流动，将会按顺序流过每个 pipe。
最后当所有加载项都流出 pipeline 时，整个加载流程就结束了。 */
export class Pipeline {
/**
!#en
Constructor, pass an array of pipes to construct a new Pipeline,
the pipes will be chained in the given order.
A pipe is an object which must contain an `id` in string and a `handle` function,
the id must be unique in the pipeline.
It can also include `async` property to identify whether it's an asynchronous process.
!#zh
构造函数，通过一系列的 pipe 来构造一个新的 pipeline，pipes 将会在给定的顺序中被锁定。
一个 pipe 就是一个对象，它包含了字符串类型的 ‘id’ 和 ‘handle’ 函数，在 pipeline 中 id 必须是唯一的。
它还可以包括 ‘async’ 属性以确定它是否是一个异步过程。
@param pipes pipes
@example
```js
var pipeline = new Pipeline([
{
id: 'Downloader',
handle: function (item, callback) {},
async: true
},
{id: 'Parser', handle: function (item) {}, async: false}
]);
```
*/
constructor(pipes: any[]);
/**
!#en
Insert a new pipe at the given index of the pipeline.
A pipe must contain an `id` in string and a `handle` function, the id must be unique in the pipeline.
!#zh
在给定的索引位置插入一个新的 pipe。
一个 pipe 必须包含一个字符串类型的 ‘id’ 和 ‘handle’ 函数，该 id 在 pipeline 必须是唯一标识。
@param pipe The pipe to be inserted
@param index The index to insert
*/
insertPipe(pipe: any, index: number): void;
/**
!en
Insert a pipe to the end of an existing pipe. The existing pipe must be a valid pipe in the pipeline.
!zh
在当前 pipeline 的一个已知 pipe 后面插入一个新的 pipe。
@param refPipe An existing pipe in the pipeline.
@param newPipe The pipe to be inserted.
*/
insertPipeAfter(refPipe: any, newPipe: any): void;
/**
!#en
Add a new pipe at the end of the pipeline.
A pipe must contain an `id` in string and a `handle` function, the id must be unique in the pipeline.
!#zh
添加一个新的 pipe 到 pipeline 尾部。
该 pipe 必须包含一个字符串类型 ‘id’ 和 ‘handle’ 函数，该 id 在 pipeline 必须是唯一标识。
@param pipe The pipe to be appended
*/
appendPipe(pipe: any): void;
/**
!#en
Let new items flow into the pipeline.
Each item can be a simple url string or an object,
if it's an object, it must contain `id` property.
You can specify its type by `type` property, by default, the type is the extension name in url.
By adding a `skips` property including pipe ids, you can skip these pipe.
The object can contain any supplementary property as you want.
!#zh
让新的 item 流入 pipeline 中。
这里的每个 item 可以是一个简单字符串类型的 url 或者是一个对象,
如果它是一个对象的话，他必须要包含 ‘id’ 属性。
你也可以指定它的 ‘type’ 属性类型，默认情况下，该类型是 ‘url’ 的后缀名。
也通过添加一个 包含 ‘skips’ 属性的 item 对象，你就可以跳过 skips 中包含的 pipe。
该对象可以包含任何附加属性。
@param items items
@example
```js
pipeline.flowIn([
'res/Background.png',
{
id: 'res/scene.json',
type: 'scene',
name: 'scene',
skips: ['Downloader']
}
]);
```
*/
flowIn(items: any[]): void;
/**
!#en
Let new items flow into the pipeline and give a callback when the list of items are all completed.
This is for loading dependencies for an existing item in flow, usually used in a pipe logic.
For example, we have a loader for scene configuration file in JSON, the scene will only be fully loaded
after all its dependencies are loaded, then you will need to use function to flow in all dependencies
found in the configuration file, and finish the loader pipe only after all dependencies are loaded (in the callback).
!#zh
让新 items 流入 pipeline 并且当 item 列表完成时进行回调函数。
这个 API 的使用通常是为了加载依赖项。
例如：
我们需要加载一个场景配置的 JSON 文件，该场景会将所有的依赖项全部都加载完毕以后，进行回调表示加载完毕。
@param urlList urlList
@param callback callback
*/
flowInDeps(urlList: any[], callback: Function): any[];
/**
!#en
Copy the item states from one source item to all destination items.
It's quite useful when a pipe generate new items from one source item,
then you should flowIn these generated items into pipeline,
but you probably want them to skip all pipes the source item already go through,
you can achieve it with this API.
For example, an unzip pipe will generate more items, but you won't want them to pass unzip or download pipe again.
!#zh
从一个源 item 向所有目标 item 复制它的 pipe 状态，用于避免重复通过部分 pipe。
当一个源 item 生成了一系列新的 items 时很有用，
你希望让这些新的依赖项进入 pipeline，但是又不希望它们通过源 item 已经经过的 pipe，
但是你可能希望他们源 item 已经通过并跳过所有 pipes，
这个时候就可以使用这个 API。
@param srcItem The source item
@param dstItems A single destination item or an array of destination items
*/
copyItemStates(srcItem: any, dstItems: any[]|any): void;
/**
!#en Returns whether the pipeline is flowing (contains item) currently.
!#zh 获取 pipeline 当前是否正在处理中。
*/
isFlowing(): boolean;
/**
!#en Returns all items in pipeline. Returns null, please use API of Loader or LoadingItems.
!#zh 获取 pipeline 中的所有 items。返回 null，请使用 Loader / LoadingItems API。
*/
getItems(): LoadingItems;
/**
!#en Returns an item in pipeline.
!#zh 根据 id 获取一个 item
@param id The id of the item
*/
getItem(id: any): any;
/**
!#en Removes an completed item in pipeline.
It will only remove the cache in the pipeline or loader, its dependencies won't be released.
cc.loader provided another method to completely cleanup the resource and its dependencies,
please refer to {{#crossLink "loader/release:method"}}cc.loader.release{{/crossLink}}
!#zh 移除指定的已完成 item。
这将仅仅从 pipeline 或者 loader 中删除其缓存，并不会释放它所依赖的资源。
cc.loader 中提供了另一种删除资源及其依赖的清理方法，请参考 {{#crossLink "loader/release:method"}}cc.loader.release{{/crossLink}}
@param id The id of the item
*/
removeItem(id: any): boolean;
/**
!#en Clear the current pipeline, this function will clean up the items.
!#zh 清空当前 pipeline，该函数将清理 items。
*/
clear(): void;
}
/** !#en
A cc.SpriteFrame has:
- texture: A cc.Texture2D that will be used by the _ccsg.Sprite
- rectangle: A rectangle of the texture
!#zh
一个 SpriteFrame 包含：
- 纹理：会被 Sprite 使用的 Texture2D 对象。
- 矩形：在纹理中的矩形区域。 */
export class SpriteFrame extends Asset implements EventTarget {
/**
!#en
Constructor of SpriteFrame class.
!#zh
SpriteFrame 类的构造函数。
@param filename filename
@param rect rect
@param rotated Whether the frame is rotated in the texture
@param offset The offset of the frame in the texture
@param originalSize The size of the frame in the texture
*/
constructor(filename?: string|Texture2D, rect?: Rect, rotated?: boolean, offset?: Vec2, originalSize?: Size);
/** !#en Top border of the sprite
!#zh sprite 的顶部边框 */
insetTop: number;
/** !#en Bottom border of the sprite
!#zh sprite 的底部边框 */
insetBottom: number;
/** !#en Left border of the sprite
!#zh sprite 的左边边框 */
insetLeft: number;
/** !#en Right border of the sprite
!#zh sprite 的左边边框 */
insetRight: number;
/**
!#en Returns whether the texture have been loaded
!#zh 返回是否已加载纹理
*/
textureLoaded(): boolean;
/**
Add a event listener for texture loaded event.
@param callback callback
@param target target
*/
addLoadedEventListener(callback: Function, target: any): void;
/**
!#en Returns whether the sprite frame is rotated in the texture.
!#zh 获取 SpriteFrame 是否旋转
*/
isRotated(): boolean;
/**
!#en Set whether the sprite frame is rotated in the texture.
!#zh 设置 SpriteFrame 是否旋转
@param bRotated bRotated
*/
setRotated(bRotated: boolean): void;
/**
!#en Returns the rect of the sprite frame in the texture.
!#zh 获取 SpriteFrame 的纹理矩形区域
*/
getRect(): Rect;
/**
!#en Sets the rect of the sprite frame in the texture.
!#zh 设置 SpriteFrame 的纹理矩形区域
@param rect rect
*/
setRect(rect: Rect): void;
/**
!#en Returns the original size of the trimmed image.
!#zh 获取修剪前的原始大小
*/
getOriginalSize(): Size;
/**
!#en Sets the original size of the trimmed image.
!#zh 设置修剪前的原始大小
@param size size
*/
setOriginalSize(size: Size): void;
/**
!#en Returns the texture of the frame.
!#zh 获取使用的纹理实例
*/
getTexture(): Texture2D;
/**
!#en Returns the offset of the frame in the texture.
!#zh 获取偏移量
*/
getOffset(): Vec2;
/**
!#en Sets the offset of the frame in the texture.
!#zh 设置偏移量
@param offsets offsets
*/
setOffset(offsets: Vec2): void;
/**
!#en Clone the sprite frame.
!#zh 克隆 SpriteFrame
*/
clone(): SpriteFrame;
/**
!#en Set SpriteFrame with Texture, rect, rotated, offset and originalSize.
!#zh 通过 Texture，rect，rotated，offset 和 originalSize 设置 SpriteFrame
@param textureOrTextureFile textureOrTextureFile
@param rect rect
@param rotated rotated
@param offset offset
@param originalSize originalSize
*/
setTexture(textureOrTextureFile: string|Texture2D, rect?: Rect, rotated?: boolean, offset?: Vec2, originalSize?: Size): boolean;
/**
!#en If a loading scene (or prefab) is marked as `asyncLoadAssets`, all the textures of the SpriteFrame which
associated by user's custom Components in the scene, will not preload automatically.
These textures will be load when Sprite component is going to render the SpriteFrames.
You can call this method if you want to load the texture early.
!#zh 当加载中的场景或 Prefab 被标记为 `asyncLoadAssets` 时，用户在场景中由自定义组件关联到的所有 SpriteFrame 的贴图都不会被提前加载。
只有当 Sprite 组件要渲染这些 SpriteFrame 时，才会检查贴图是否加载。如果你希望加载过程提前，你可以手工调用这个方法。
@example
```js
if (spriteFrame.textureLoaded()) {
this._onSpriteFrameLoaded();
}
else {
spriteFrame.once('load', this._onSpriteFrameLoaded, this);
spriteFrame.ensureLoadTexture();
}
```
*/
ensureLoadTexture(): void;
/**
!#en
If you do not need to use the SpriteFrame temporarily, you can call this method so that its texture could be garbage collected. Then when you need to render the SpriteFrame, you should call `ensureLoadTexture` manually to reload texture.
!#zh
当你暂时不再使用这个 SpriteFrame 时，可以调用这个方法来保证引用的贴图对象能被 GC。然后当你要渲染 SpriteFrame 时，你需要手动调用 `ensureLoadTexture` 来重新加载贴图。
@example
```js
spriteFrame.clearTexture();
// when you need the SpriteFrame again...
spriteFrame.once('load', onSpriteFrameLoaded);
spriteFrame.ensureLoadTexture();
```
*/
clearTexture(): void;
/**
!#en
Register an callback of a specific event type on the EventTarget.
!#zh
注册事件目标的特定事件类型回调。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.on(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
on(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
on(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Removes the listeners previously registered with the same type, callback, target and or useCapture,
if only type is passed as parameter, all listeners registered with that type will be removed.
!#zh
删除之前用同类型，回调，目标或 useCapture 注册的事件监听器，如果只传递 type，将会删除 type 类型的所有事件监听器。
@param type A string representing the event type being removed.
@param callback The callback to remove.
@param target The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
@param useCapture Specifies whether the callback being removed was registered as a capturing callback or not.
If not specified, useCapture defaults to false. If a callback was registered twice,
one with capture and one without, each must be removed separately. Removal of a capturing callback
does not affect a non-capturing version of the same listener, and vice versa.
@example
```js
// register touchEnd eventListener
var touchEnd = node.on(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
// remove touch end event listener
node.off(cc.Node.EventType.TOUCH_END, touchEnd, node);
// remove all touch end event listeners
node.off(cc.Node.EventType.TOUCH_END);
```
*/
off(type: string, callback?: Function, target?: any, useCapture?: boolean): void;
/**
!#en Removes all callbacks previously registered with the same target (passed as parameter).
This is not for removing all listeners in the current event target,
and this is not for removing all listeners the target parameter have registered.
It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.
!#zh 在当前 EventTarget 上删除指定目标（target 参数）注册的所有事件监听器。
这个函数无法删除当前 EventTarget 的所有事件监听器，也无法删除 target 参数所注册的所有事件监听器。
这个函数只能删除 target 参数在当前 EventTarget 上注册的所有事件监听器。
@param target The target to be searched for all related listeners
*/
targetOff(target: any): void;
/**
!#en
Register an callback of a specific event type on the EventTarget,
the callback will remove itself after the first time it is triggered.
!#zh
注册事件目标的特定事件类型回调，回调会在第一时间被触发后删除自身。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.once(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
once(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
once(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Dispatches an event into the event flow.
The event target is the EventTarget object upon which the dispatchEvent() method is called.
!#zh 分发事件到事件流中。
@param event The Event object that is dispatched into the event flow
*/
dispatchEvent(event: Event): void;
/**
!#en
Send an event to this object directly, this method will not propagate the event to any other objects.
The event will be created from the supplied message, you can get the "detail" argument from event.detail.
!#zh
该对象直接发送事件， 这种方法不会对事件传播到任何其他对象。
@param message the message to send
@param detail whatever argument the message needs
*/
emit(message: string, detail?: any): void;
}
/** undefined */
export class WorldManifold {
/** !#en
world contact point (point of intersection)
!#zh
碰撞点集合 */
points: [Vec2];
/** !#en
world vector pointing from A to B
!#zh
世界坐标系下由 A 指向 B 的向量 */
normal: Vec2;
}
/** !#en
A manifold point is a contact point belonging to a contact manifold.
It holds details related to the geometry and dynamics of the contact points.
Note: the impulses are used for internal caching and may not
provide reliable contact forces, especially for high speed collisions.
!#zh
ManifoldPoint 是接触信息中的接触点信息。它拥有关于几何和接触点的详细信息。
注意：信息中的冲量用于系统内部缓存，提供的接触力可能不是很准确，特别是高速移动中的碰撞信息。 */
export class ManifoldPoint {
/** !#en
The local point usage depends on the manifold type:
-e_circles: the local center of circleB
-e_faceA: the local center of circleB or the clip point of polygonB
-e_faceB: the clip point of polygonA
!#zh
本地坐标点的用途取决于 manifold 的类型
- e_circles: circleB 的本地中心点
- e_faceA: circleB 的本地中心点 或者是 polygonB 的截取点
- e_faceB: polygonB 的截取点 */
localPoint: Vec2;
/** !#en
Normal impulse.
!#zh
法线冲量。 */
normalImpulse: number;
/** !#en
Tangent impulse.
!#zh
切线冲量。 */
tangentImpulse: number;
}
/** undefined */
export class Manifold {
/** !#en
Manifold type : 0: e_circles, 1: e_faceA, 2: e_faceB
!#zh
Manifold 类型 : 0: e_circles, 1: e_faceA, 2: e_faceB */
type: number;
/** !#en
The local point usage depends on the manifold type:
-e_circles: the local center of circleA
-e_faceA: the center of faceA
-e_faceB: the center of faceB
!#zh
用途取决于 manifold 类型
-e_circles: circleA 的本地中心点
-e_faceA: faceA 的本地中心点
-e_faceB: faceB 的本地中心点 */
localPoint: Vec2;
/** !#en
-e_circles: not used
-e_faceA: the normal on polygonA
-e_faceB: the normal on polygonB
!#zh
-e_circles: 没被使用到
-e_faceA: polygonA 的法向量
-e_faceB: polygonB 的法向量 */
localNormal: Vec2;
/** !#en
the points of contact.
!#zh
接触点信息。 */
points: [ManifoldPoint];
}
/** !#en
Contact impulses for reporting.
!#zh
用于返回给回调的接触冲量。 */
export class PhysicsImpulse {
/** !#en
Normal impulses.
!#zh
法线方向的冲量 */
normalImpulses: void;
/** !#en
Tangent impulses
!#zh
切线方向的冲量 */
tangentImpulses: void;
}
/** !#en
PhysicsContact will be generated during begin and end collision as a parameter of the collision callback.
Note that contacts will be reused for speed up cpu time, so do not cache anything in the contact.
!#zh
物理接触会在开始和结束碰撞之间生成，并作为参数传入到碰撞回调函数中。
注意：传入的物理接触会被系统进行重用，所以不要在使用中缓存里面的任何信息。 */
export class PhysicsContact {
/**
!#en
Get the world manifold.
!#zh
获取世界坐标系下的碰撞信息。
*/
getWorldManifold(): WorldManifold;
/**
!#en
Get the manifold.
!#zh
获取世界坐标系下的碰撞信息。
*/
getManifold(): Manifold;
/**
!#en
Get the impulses.
Note: PhysicsImpulse can only used in onPostSolve callback.
!#zh
获取冲量信息
注意：这个信息只有在 onPostSolve 回调中才能获取到
*/
getImpulse(): PhysicsImpulse;
colliderA: Collider;
colliderB: Collider;
/** !#en
If set disabled to true, the contact will be ignored until contact end.
If you just want to disabled contact for current time step or sub-step, please use disabledOnce.
!#zh
如果 disabled 被设置为 true，那么直到接触结束此接触都将被忽略。
如果只是希望在当前时间步或子步中忽略此接触，请使用 disabledOnce 。 */
disabled: boolean;
/** !#en
Disabled contact for current time step or sub-step.
!#zh
在当前时间步或子步中忽略此接触。 */
disabledOnce: boolean;
/**
!#en
Is this contact touching?
!#zh
返回碰撞体是否已经接触到。
*/
isTouching(): boolean;
/**
!#en
Set the desired tangent speed for a conveyor belt behavior.
!#zh
为传送带设置期望的切线速度
@param tangentSpeed tangentSpeed
*/
setTangentSpeed(tangentSpeed: number): void;
/**
!#en
Get the desired tangent speed.
!#zh
获取切线速度
*/
getTangentSpeed(): number;
/**
!#en
Override the default friction mixture. You can call this in onPreSolve callback.
!#zh
覆盖默认的摩擦力系数。你可以在 onPreSolve 回调中调用此函数。
@param friction friction
*/
setFriction(friction: number): void;
/**
!#en
Get the friction.
!#zh
获取当前摩擦力系数
*/
getFriction(): number;
/**
!#en
Reset the friction mixture to the default value.
!#zh
重置摩擦力系数到默认值
*/
resetFriction(): void;
/**
!#en
Override the default restitution mixture. You can call this in onPreSolve callback.
!#zh
覆盖默认的恢复系数。你可以在 onPreSolve 回调中调用此函数。
@param restitution restitution
*/
setRestitution(restitution: number): void;
/**
!#en
Get the restitution.
!#zh
获取当前恢复系数
*/
getRestitution(): number;
/**
!#en
Reset the restitution mixture to the default value.
!#zh
重置恢复系数到默认值
*/
resetRestitution(): void;
}
/** !#en
Physics manager uses box2d as the inner physics system, and hide most box2d implement details(creating rigidbody, synchronize rigidbody info to node).
You can visit some common box2d function through physics manager(hit testing, raycast, debug info).
Physics manager distributes the collision information to each collision callback when collision is produced.
Note: You need first enable the collision listener in the rigidbody.
!#zh
物理系统将 box2d 作为内部物理系统，并且隐藏了大部分 box2d 实现细节（比如创建刚体，同步刚体信息到节点中等）。
你可以通过物理系统访问一些 box2d 常用的功能，比如点击测试，射线测试，设置测试信息等。
物理系统还管理碰撞信息的分发，她会在产生碰撞时，将碰撞信息分发到各个碰撞回调中。
注意：你需要先在刚体中开启碰撞接听才会产生相应的碰撞回调。 */
export class PhysicsManager implements EventTarget {
/** !#en
The draw bits for drawing physics debug information.
!#zh
指定物理系统需要绘制哪些调试信息。 */
static DrawBits: DrawBits;
/** !#en
The ratio transform between physics unit and pixel unit, generally is 32.
!#zh
物理单位与像素单位互相转换的比率，一般是 32。 */
static PTM_RATIO: number;
/** !#en
The velocity iterations for the velocity constraint solver.
!#zh
速度更新迭代数 */
static VELOCITY_ITERATIONS: number;
/** !#en
The position Iterations for the position constraint solver.
!#zh
位置迭代更新数 */
static POSITION_ITERATIONS: number;
/** !#en
Specify the fixed time step.
Need enabledAccumulator to make it work.
!#zh
指定固定的物理更新间隔时间，需要开启 enabledAccumulator 才有效。 */
static FIXED_TIME_STEP: number;
/** !#en
Specify the max accumulator time.
Need enabledAccumulator to make it work.
!#zh
每次可用于更新物理系统的最大时间，需要开启 enabledAccumulator 才有效。 */
static MAX_ACCUMULATOR: number;
/** !#en
If enabled accumulator, then will call step function with the fixed time step FIXED_TIME_STEP.
And if the update dt is bigger than the time step, then will call step function several times.
If disabled accumulator, then will call step function with a time step calculated with the frame rate.
!#zh
如果开启此选项，那么将会以固定的间隔时间 FIXED_TIME_STEP 来更新物理引擎，如果一个 update 的间隔时间大于 FIXED_TIME_STEP，则会对物理引擎进行多次更新。
如果关闭此选项，那么将会根据设定的 frame rate 计算出一个间隔时间来更新物理引擎。 */
enabledAccumulator: boolean;
/**
!#en
Test which collider contains the given world point
!#zh
获取包含给定世界坐标系点的碰撞体
@param point the world point
*/
testPoint(point: Vec2): PhysicsCollider;
/**
!#en
Test which colliders intersect the given world rect
!#zh
获取与给定世界坐标系矩形相交的碰撞体
@param rect the world rect
*/
testAABB(rect: Rect): [PhysicsCollider];
/**
!#en
Raycast the world for all colliders in the path of the ray.
The raycast ignores colliders that contain the starting point.
!#zh
检测哪些碰撞体在给定射线的路径上，射线检测将忽略包含起始点的碰撞体。
@param p1 start point of the raycast
@param p2 end point of the raycast
@param type optional, default is RayCastType.Closest
*/
rayCast(p1: Vec2, p2: Vec2, type: RayCastType): [PhysicsRayCastResult];
/**
!#en
Attach physics debug draw to camera
!#zh
将物理的调试绘制信息附加到指定摄像机上
@param camera camera
*/
attachDebugDrawToCamera(camera: Camera): void;
/**
!#en
Detach physics debug draw to camera
!#zh
将物理的调试绘制信息从指定摄像机上移除
@param camera camera
*/
detachDebugDrawFromCamera(camera: Camera): void;
/** !#en
Enabled the physics manager?
!#zh
指定是否启用物理系统？ */
enabled: boolean;
/** !#en
Debug draw flags.
!#zh
设置调试绘制标志 */
debugDrawFlags: number;
/** !#en
The physics world gravity.
!#zh
物理世界重力值 */
gravity: Vec2;
/**
!#en
Register an callback of a specific event type on the EventTarget.
!#zh
注册事件目标的特定事件类型回调。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.on(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
on(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
on(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Removes the listeners previously registered with the same type, callback, target and or useCapture,
if only type is passed as parameter, all listeners registered with that type will be removed.
!#zh
删除之前用同类型，回调，目标或 useCapture 注册的事件监听器，如果只传递 type，将会删除 type 类型的所有事件监听器。
@param type A string representing the event type being removed.
@param callback The callback to remove.
@param target The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
@param useCapture Specifies whether the callback being removed was registered as a capturing callback or not.
If not specified, useCapture defaults to false. If a callback was registered twice,
one with capture and one without, each must be removed separately. Removal of a capturing callback
does not affect a non-capturing version of the same listener, and vice versa.
@example
```js
// register touchEnd eventListener
var touchEnd = node.on(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
// remove touch end event listener
node.off(cc.Node.EventType.TOUCH_END, touchEnd, node);
// remove all touch end event listeners
node.off(cc.Node.EventType.TOUCH_END);
```
*/
off(type: string, callback?: Function, target?: any, useCapture?: boolean): void;
/**
!#en Removes all callbacks previously registered with the same target (passed as parameter).
This is not for removing all listeners in the current event target,
and this is not for removing all listeners the target parameter have registered.
It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.
!#zh 在当前 EventTarget 上删除指定目标（target 参数）注册的所有事件监听器。
这个函数无法删除当前 EventTarget 的所有事件监听器，也无法删除 target 参数所注册的所有事件监听器。
这个函数只能删除 target 参数在当前 EventTarget 上注册的所有事件监听器。
@param target The target to be searched for all related listeners
*/
targetOff(target: any): void;
/**
!#en
Register an callback of a specific event type on the EventTarget,
the callback will remove itself after the first time it is triggered.
!#zh
注册事件目标的特定事件类型回调，回调会在第一时间被触发后删除自身。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.once(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
once(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
once(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Dispatches an event into the event flow.
The event target is the EventTarget object upon which the dispatchEvent() method is called.
!#zh 分发事件到事件流中。
@param event The Event object that is dispatched into the event flow
*/
dispatchEvent(event: Event): void;
/**
!#en
Send an event to this object directly, this method will not propagate the event to any other objects.
The event will be created from the supplied message, you can get the "detail" argument from event.detail.
!#zh
该对象直接发送事件， 这种方法不会对事件传播到任何其他对象。
@param message the message to send
@param detail whatever argument the message needs
*/
emit(message: string, detail?: any): void;
}
/** undefined */
export enum DrawBits {
e_aabbBit = 0,
e_pairBit = 0,
e_centerOfMassBit = 0,
e_jointBit = 0,
e_shapeBit = 0,
}
/** undefined */
export class PhysicsRayCastResult {
/** !#en
The PhysicsCollider which intersects with the raycast
!#zh
与射线相交的碰撞体 */
collider: PhysicsCollider;
/** !#en
The intersection point
!#zh
射线与碰撞体相交的点 */
point: Vec2;
/** !#en
The normal vector at the point of intersection
!#zh
射线与碰撞体相交的点的法向量 */
normal: Vec2;
/** !#en
The fraction of the raycast path at the point of intersection
!#zh
射线与碰撞体相交的点占射线长度的分数 */
fraction: number;
}
/** !#en Enum for RigidBodyType.
!#zh 刚体类型 */
export enum RigidBodyType {
Static = 0,
Kinematic = 0,
Dynamic = 0,
Animated = 0,
}
/** !#en Enum for RayCastType.
!#zh 射线检测类型 */
export enum RayCastType {
Closest = 0,
Any = 0,
AllClosest = 0,
All = 0,
}
/** undefined */
export class RigidBody extends Component {
/** !#en
Should enabled contact listener?
When a collision is trigger, the collision callback will only be called when enabled contact listener.
!#zh
是否启用接触接听器。
当 collider 产生碰撞时，只有开启了接触接听器才会调用相应的回调函数 */
enabledContactListener: boolean;
/**
!#en
Collision callback.
Called when two collider begin to touch.
!#zh
碰撞回调。
如果你的脚本中实现了这个函数，那么它将会在两个碰撞体开始接触时被调用。
@param contact contact information
@param selfCollider the collider belong to this rigidbody
@param otherCollider the collider belong to another rigidbody
*/
onBeginContact(contact: PhysicsContact, selfCollider: PhysicsCollider, otherCollider: PhysicsCollider): void;
/**
!#en
Collision callback.
Called when two collider cease to touch.
!#zh
碰撞回调。
如果你的脚本中实现了这个函数，那么它将会在两个碰撞体停止接触时被调用。
@param contact contact information
@param selfCollider the collider belong to this rigidbody
@param otherCollider the collider belong to another rigidbody
*/
onEndContact(contact: PhysicsContact, selfCollider: PhysicsCollider, otherCollider: PhysicsCollider): void;
/**
!#en
Collision callback.
This is called when a contact is updated.
This allows you to inspect a contact before it goes to the solver(e.g. disable contact).
Note: this is called only for awake bodies.
Note: this is called even when the number of contact points is zero.
Note: this is not called for sensors.
!#zh
碰撞回调。
如果你的脚本中实现了这个函数，那么它将会在接触更新时被调用。
你可以在接触被处理前根据他包含的信息作出相应的处理，比如将这个接触禁用掉。
注意：回调只会为醒着的刚体调用。
注意：接触点为零的时候也有可能被调用。
注意：感知体(sensor)的回调不会被调用。
@param contact contact information
@param selfCollider the collider belong to this rigidbody
@param otherCollider the collider belong to another rigidbody
*/
onPreSolve(contact: PhysicsContact, selfCollider: PhysicsCollider, otherCollider: PhysicsCollider): void;
/**
!#en
Collision callback.
This is called after a contact is updated.
You can get the impulses from the contact in this callback.
!#zh
碰撞回调。
如果你的脚本中实现了这个函数，那么它将会在接触更新完后被调用。
你可以在这个回调中从接触信息中获取到冲量信息。
@param contact contact information
@param selfCollider the collider belong to this rigidbody
@param otherCollider the collider belong to another rigidbody
*/
onPostSolve(contact: PhysicsContact, selfCollider: PhysicsCollider, otherCollider: PhysicsCollider): void;
/** !#en
Is this a fast moving body that should be prevented from tunneling through
other moving bodies?
Note :
- All bodies are prevented from tunneling through kinematic and static bodies. This setting is only considered on dynamic bodies.
- You should use this flag sparingly since it increases processing time.
!#zh
这个刚体是否是一个快速移动的刚体，并且需要禁止穿过其他快速移动的刚体？
需要注意的是 :
- 所有刚体都被禁止从 运动刚体 和 静态刚体 中穿过。此选项只关注于 动态刚体。
- 应该尽量少的使用此选项，因为它会增加程序处理时间。 */
bullet: boolean;
/** !#en
Rigidbody type : Static, Kinematic, Dynamic or Animated.
!#zh
刚体类型： Static, Kinematic, Dynamic or Animated. */
type: RigidBodyType;
/** !#en
Set this flag to false if this body should never fall asleep.
Note that this increases CPU usage.
!#zh
如果此刚体永远都不应该进入睡眠，那么设置这个属性为 false。
需要注意这将使 CPU 占用率提高。 */
allowSleep: boolean;
/** !#en
Scale the gravity applied to this body.
!#zh
缩放应用在此刚体上的重力值 */
gravityScale: number;
/** !#en
Linear damping is use to reduce the linear velocity.
The damping parameter can be larger than 1, but the damping effect becomes sensitive to the
time step when the damping parameter is large.
!#zh
Linear damping 用于衰减刚体的线性速度。衰减系数可以大于 1，但是当衰减系数比较大的时候，衰减的效果会变得比较敏感。 */
linearDamping: number;
/** !#en
Angular damping is use to reduce the angular velocity. The damping parameter
can be larger than 1 but the damping effect becomes sensitive to the
time step when the damping parameter is large.
!#zh
Angular damping 用于衰减刚体的角速度。衰减系数可以大于 1，但是当衰减系数比较大的时候，衰减的效果会变得比较敏感。 */
angularDamping: number;
/** !#en
The linear velocity of the body's origin in world co-ordinates.
!#zh
刚体在世界坐标下的线性速度 */
linearVelocity: Vec2;
/** !#en
The angular velocity of the body.
!#zh
刚体的角速度 */
angularVelocity: number;
/** !#en
Should this body be prevented from rotating?
!#zh
是否禁止此刚体进行旋转 */
fixedRotation: boolean;
/** !#en
Is this body initially awake or sleeping?
!#zh
是否立刻唤醒此刚体 */
awake: boolean;
/** !#en
Set the active state of the body. An inactive body is not
simulated and cannot be collided with or woken up.
If body is active, all fixtures will be added to the
broad-phase.
If body is inactive, all fixtures will be removed from
the broad-phase and all contacts will be destroyed.
Fixtures on an inactive body are implicitly inactive and will
not participate in collisions, ray-casts, or queries.
Joints connected to an inactive body are implicitly inactive.
!#zh
设置刚体的激活状态。一个非激活状态下的刚体是不会被模拟和碰撞的，不管它是否处于睡眠状态下。
如果刚体处于激活状态下，所有夹具会被添加到 粗测阶段（broad-phase）。
如果刚体处于非激活状态下，所有夹具会被从 粗测阶段（broad-phase）中移除。
在非激活状态下的夹具不会参与到碰撞，射线，或者查找中
链接到非激活状态下刚体的关节也是非激活的。 */
active: boolean;
/**
!#en
Gets a local point relative to the body's origin given a world point.
!#zh
将一个给定的世界坐标系下的点转换为刚体本地坐标系下的点
@param worldPoint a point in world coordinates.
@param out optional, the receiving point
*/
getLocalPoint(worldPoint: Vec2, out: Vec2): Vec2;
/**
!#en
Get the world coordinates of a point given the local coordinates.
!#zh
将一个给定的刚体本地坐标系下的点转换为世界坐标系下的点
@param localPoint a point in local coordinates.
@param out optional, the receiving point
*/
getWorldPoint(localPoint: Vec2, out: Vec2): Vec2;
/**
!#en
Get the world coordinates of a vector given the local coordinates.
!#zh
将一个给定的世界坐标系下的向量转换为刚体本地坐标系下的向量
@param localVector a vector in world coordinates.
@param out optional, the receiving vector
*/
getWorldVector(localVector: Vec2, out: Vec2): Vec2;
/**
!#en
Gets a local vector relative to the body's origin given a world vector.
!#zh
将一个给定的世界坐标系下的点转换为刚体本地坐标系下的点
@param worldVector a vector in world coordinates.
@param out optional, the receiving vector
*/
getLocalVector(worldVector: Vec2, out: Vec2): Vec2;
/**
!#en
Get the world body origin position.
!#zh
获取刚体世界坐标系下的原点值
@param out optional, the receiving point
*/
getWorldPosition(out: Vec2): Vec2;
/**
!#en
Get the world body rotation angle.
!#zh
获取刚体世界坐标系下的旋转值。
*/
getWorldRotation(): number;
/**
!#en
Get the local position of the center of mass.
!#zh
获取刚体本地坐标系下的质心
*/
getLocalCenter(): Vec2;
/**
!#en
Get the world position of the center of mass.
!#zh
获取刚体世界坐标系下的质心
*/
getWorldCenter(): Vec2;
/**
!#en
Get the world linear velocity of a world point attached to this body.
!#zh
获取刚体上指定点的线性速度
@param worldPoint a point in world coordinates.
@param out optional, the receiving point
*/
getLinearVelocityFromWorldPoint(worldPoint: Vec2, out: Vec2): Vec2;
/**
!#en
Get total mass of the body.
!#zh
获取刚体的质量。
*/
getMass(): number;
/**
!#en
Get the rotational inertia of the body about the local origin.
!#zh
获取刚体本地坐标系下原点的旋转惯性
*/
getInertia(): number;
/**
!#en
Get all the joints connect to the rigidbody.
!#zh
获取链接到此刚体的所有关节
*/
getJointList(): [Joint];
/**
!#en
Apply a force at a world point. If the force is not
applied at the center of mass, it will generate a torque and
affect the angular velocity.
!#zh
施加一个力到刚体上的一个点。如果力没有施加到刚体的质心上，还会产生一个扭矩并且影响到角速度。
@param force the world force vector.
@param point the world position.
@param wake also wake up the body.
*/
applyForce(force: Vec2, point: Vec2, wake: boolean): void;
/**
!#en
Apply a force to the center of mass.
!#zh
施加一个力到刚体上的质心上。
@param force the world force vector.
@param wake also wake up the body.
*/
applyForceToCenter(force: Vec2, wake: boolean): void;
/**
!#en
Apply a torque. This affects the angular velocity.
!#zh
施加一个扭矩力，将影响刚体的角速度
@param torque about the z-axis (out of the screen), usually in N-m.
@param wake also wake up the body
*/
applyTorque(torque: number, wake: boolean): void;
/**
!#en
Apply a impulse at a world point, This immediately modifies the velocity.
If the impulse is not applied at the center of mass, it will generate a torque and
affect the angular velocity.
!#zh
施加冲量到刚体上的一个点，将立即改变刚体的线性速度。
如果冲量施加到的点不是刚体的质心，那么将产生一个扭矩并影响刚体的角速度。
@param impulse the world impulse vector, usually in N-seconds or kg-m/s.
@param point the world position
@param wake alse wake up the body
*/
applyLinearImpulse(impulse: Vec2, point: Vec2, wake: boolean): void;
/**
!#en
Apply an angular impulse.
!#zh
施加一个角速度冲量。
@param impulse the angular impulse in units of kg*m*m/s
@param wake also wake up the body
*/
applyAngularImpulse(impulse: number, wake: boolean): void;
/**
!#en
Synchronize node's world position to box2d rigidbody's position.
If enableAnimated is true and rigidbody's type is Animated type,
will set linear velocity instead of directly set rigidbody's position.
!#zh
同步节点的世界坐标到 box2d 刚体的坐标上。
如果 enableAnimated 是 true，并且刚体的类型是 Animated ，那么将设置刚体的线性速度来代替直接设置刚体的位置。
@param enableAnimated enableAnimated
*/
syncPosition(enableAnimated: boolean): void;
/**
!#en
Synchronize node's world angle to box2d rigidbody's angle.
If enableAnimated is true and rigidbody's type is Animated type,
will set angular velocity instead of directly set rigidbody's angle.
!#zh
同步节点的世界旋转角度值到 box2d 刚体的旋转值上。
如果 enableAnimated 是 true，并且刚体的类型是 Animated ，那么将设置刚体的角速度来代替直接设置刚体的角度。
@param enableAnimated enableAnimated
*/
syncRotation(enableAnimated: boolean): void;
}
/** !#en Key map for keyboard event
!#zh 键盘事件的按键值 */
export enum KEY {
none = 0,
back = 0,
menu = 0,
backspace = 0,
tab = 0,
enter = 0,
shift = 0,
ctrl = 0,
alt = 0,
pause = 0,
capslock = 0,
escape = 0,
space = 0,
pageup = 0,
pagedown = 0,
end = 0,
home = 0,
left = 0,
up = 0,
right = 0,
down = 0,
select = 0,
insert = 0,
Delete = 0,
a = 0,
b = 0,
c = 0,
d = 0,
e = 0,
f = 0,
g = 0,
h = 0,
i = 0,
j = 0,
k = 0,
l = 0,
m = 0,
n = 0,
o = 0,
p = 0,
q = 0,
r = 0,
s = 0,
t = 0,
u = 0,
v = 0,
w = 0,
x = 0,
y = 0,
z = 0,
num0 = 0,
num1 = 0,
num2 = 0,
num3 = 0,
num4 = 0,
num5 = 0,
num6 = 0,
num7 = 0,
num8 = 0,
num9 = 0,
'*' = 0,
'+' = 0,
'-' = 0,
numdel = 0,
'/' = 0,
f1 = 0,
f2 = 0,
f3 = 0,
f4 = 0,
f5 = 0,
f6 = 0,
f7 = 0,
f8 = 0,
f9 = 0,
f10 = 0,
f11 = 0,
f12 = 0,
numlock = 0,
scrolllock = 0,
';' = 0,
semicolon = 0,
equal = 0,
'=' = 0,
',' = 0,
comma = 0,
dash = 0,
'.' = 0,
period = 0,
forwardslash = 0,
grave = 0,
'[' = 0,
openbracket = 0,
backslash = 0,
']' = 0,
closebracket = 0,
quote = 0,
dpadLeft = 0,
dpadRight = 0,
dpadUp = 0,
dpadDown = 0,
dpadCenter = 0,
}
/** Image formats */
export enum ImageFormat {
JPG = 0,
PNG = 0,
TIFF = 0,
WEBP = 0,
PVR = 0,
ETC = 0,
S3TC = 0,
ATITC = 0,
TGA = 0,
RAWDATA = 0,
UNKNOWN = 0,
getImageFormatByData = 0,
}
/** Predefined constants */
export enum macro {
INVALID_INDEX = 0,
NODE_TAG_INVALID = 0,
PI = 0,
PI2 = 0,
FLT_MAX = 0,
FLT_MIN = 0,
RAD = 0,
DEG = 0,
UINT_MAX = 0,
REPEAT_FOREVER = 0,
FLT_EPSILON = 0,
ONE = 0,
ZERO = 0,
SRC_ALPHA = 0,
SRC_ALPHA_SATURATE = 0,
SRC_COLOR = 0,
DST_ALPHA = 0,
DST_COLOR = 0,
ONE_MINUS_SRC_ALPHA = 0,
ONE_MINUS_SRC_COLOR = 0,
ONE_MINUS_DST_ALPHA = 0,
ONE_MINUS_DST_COLOR = 0,
ONE_MINUS_CONSTANT_ALPHA = 0,
ONE_MINUS_CONSTANT_COLOR = 0,
LINEAR = 0,
BLEND_DST = 0,
WEB_ORIENTATION_PORTRAIT = 0,
WEB_ORIENTATION_LANDSCAPE_LEFT = 0,
WEB_ORIENTATION_PORTRAIT_UPSIDE_DOWN = 0,
WEB_ORIENTATION_LANDSCAPE_RIGHT = 0,
ORIENTATION_PORTRAIT = 0,
ORIENTATION_LANDSCAPE = 0,
ORIENTATION_AUTO = 0,
VERTEX_ATTRIB_FLAG_NONE = 0,
VERTEX_ATTRIB_FLAG_POSITION = 0,
VERTEX_ATTRIB_FLAG_COLOR = 0,
VERTEX_ATTRIB_FLAG_TEX_COORDS = 0,
VERTEX_ATTRIB_FLAG_POS_COLOR_TEX = 0,
GL_ALL = 0,
VERTEX_ATTRIB_POSITION = 0,
VERTEX_ATTRIB_COLOR = 0,
VERTEX_ATTRIB_TEX_COORDS = 0,
VERTEX_ATTRIB_MAX = 0,
UNIFORM_PMATRIX = 0,
UNIFORM_MVMATRIX = 0,
UNIFORM_MVPMATRIX = 0,
UNIFORM_TIME = 0,
UNIFORM_SINTIME = 0,
UNIFORM_COSTIME = 0,
UNIFORM_RANDOM01 = 0,
UNIFORM_SAMPLER = 0,
UNIFORM_MAX = 0,
SHADER_POSITION_TEXTURECOLOR = 0,
SHADER_SPRITE_POSITION_TEXTURECOLOR = 0,
SHADER_POSITION_TEXTURECOLORALPHATEST = 0,
SHADER_SPRITE_POSITION_TEXTURECOLORALPHATEST = 0,
SHADER_POSITION_COLOR = 0,
SHADER_SPRITE_POSITION_COLOR = 0,
SHADER_POSITION_TEXTURE = 0,
SHADER_POSITION_TEXTURE_UCOLOR = 0,
SHADER_POSITION_TEXTUREA8COLOR = 0,
SHADER_POSITION_UCOLOR = 0,
SHADER_POSITION_LENGTHTEXTURECOLOR = 0,
UNIFORM_PMATRIX_S = 0,
UNIFORM_MVMATRIX_S = 0,
UNIFORM_MVPMATRIX_S = 0,
UNIFORM_TIME_S = 0,
UNIFORM_SINTIME_S = 0,
UNIFORM_COSTIME_S = 0,
UNIFORM_RANDOM01_S = 0,
UNIFORM_SAMPLER_S = 0,
UNIFORM_ALPHA_TEST_VALUE_S = 0,
ATTRIBUTE_NAME_COLOR = 0,
ATTRIBUTE_NAME_POSITION = 0,
ATTRIBUTE_NAME_TEX_COORD = 0,
ITEM_SIZE = 0,
CURRENT_ITEM = 0,
ZOOM_ACTION_TAG = 0,
NORMAL_TAG = 0,
SELECTED_TAG = 0,
DISABLE_TAG = 0,
FIX_ARTIFACTS_BY_STRECHING_TEXEL = 0,
FIX_ARTIFACTS_BY_STRECHING_TEXEL_TMX = 0,
DIRECTOR_STATS_POSITION = 0,
DIRECTOR_FPS_INTERVAL = 0,
COCOSNODE_RENDER_SUBPIXEL = 0,
SPRITEBATCHNODE_RENDER_SUBPIXEL = 0,
AUTO_PREMULTIPLIED_ALPHA_FOR_PNG = 0,
OPTIMIZE_BLEND_FUNC_FOR_PREMULTIPLIED_ALPHA = 0,
TEXTURE_NPOT_SUPPORT = 0,
USE_LA88_LABELS = 0,
SPRITE_DEBUG_DRAW = 0,
LABELBMFONT_DEBUG_DRAW = 0,
LABELATLAS_DEBUG_DRAW = 0,
ENABLE_STACKABLE_ACTIONS = 0,
ENABLE_GL_STATE_CACHE = 0,
TOUCH_TIMEOUT = 0,
BATCH_VERTEX_COUNT = 0,
ENABLE_GC_FOR_NATIVE_OBJECTS = 0,
ENABLE_TILEDMAP_CULLING = 0,
DOWNLOAD_MAX_CONCURRENT = 0,
ENABLE_TRANSPARENT_CANVAS = 0,
ENABLE_CULLING = 0,
BLEND_SRC = 0,
}
/** The base class of most of all the objects in Fireball. */
export class Object {
/** !#en The name of the object.
!#zh 该对象的名称。 */
name: string;
/** !#en Indicates whether the object is not yet destroyed.
!#zh 表示该对象是否可用（被销毁后将不可用）。 */
isValid: boolean;
/**
!#en
Destroy this Object, and release all its own references to other objects.
Actual object destruction will delayed until before rendering.
After destroy, this CCObject is not usable any more.
You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.
!#zh
销毁该对象，并释放所有它对其它对象的引用。
销毁后，CCObject 不再可用。您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。
实际销毁操作会延迟到当前帧渲染前执行。
@example
```js
obj.destroy();
```
*/
destroy(): boolean;
}
/** Bit mask that controls object states. */
export enum Flags {
DontSave = 0,
EditorOnly = 0,
}
/** The fullscreen API provides an easy way for web content to be presented using the user's entire screen.
It's invalid on safari, QQbrowser and android browser */
export class screen {
/**
initialize
*/
init(): void;
/**
return true if it's full now.
*/
fullScreen(): boolean;
/**
change the screen to full mode.
@param element element
@param onFullScreenChange onFullScreenChange
*/
requestFullScreen(element: Element, onFullScreenChange: Function): void;
/**
exit the full mode.
*/
exitFullScreen(): boolean;
/**
Automatically request full screen with a touch/click event
@param element element
@param onFullScreenChange onFullScreenChange
*/
autoFullScreen(element: Element, onFullScreenChange: Function): void;
}
/** System variables */
export class sys {
/** English language code */
static LANGUAGE_ENGLISH: string;
/** Chinese language code */
static LANGUAGE_CHINESE: string;
/** French language code */
static LANGUAGE_FRENCH: string;
/** Italian language code */
static LANGUAGE_ITALIAN: string;
/** German language code */
static LANGUAGE_GERMAN: string;
/** Spanish language code */
static LANGUAGE_SPANISH: string;
/** Spanish language code */
static LANGUAGE_DUTCH: string;
/** Russian language code */
static LANGUAGE_RUSSIAN: string;
/** Korean language code */
static LANGUAGE_KOREAN: string;
/** Japanese language code */
static LANGUAGE_JAPANESE: string;
/** Hungarian language code */
static LANGUAGE_HUNGARIAN: string;
/** Portuguese language code */
static LANGUAGE_PORTUGUESE: string;
/** Arabic language code */
static LANGUAGE_ARABIC: string;
/** Norwegian language code */
static LANGUAGE_NORWEGIAN: string;
/** Polish language code */
static LANGUAGE_POLISH: string;
/** Turkish language code */
static LANGUAGE_TURKISH: string;
/** Ukrainian language code */
static LANGUAGE_UKRAINIAN: string;
/** Romanian language code */
static LANGUAGE_ROMANIAN: string;
/** Bulgarian language code */
static LANGUAGE_BULGARIAN: string;
/** Unknown language code */
static LANGUAGE_UNKNOWN: string;
static OS_IOS: string;
static OS_ANDROID: string;
static OS_WINDOWS: string;
static OS_MARMALADE: string;
static OS_LINUX: string;
static OS_BADA: string;
static OS_BLACKBERRY: string;
static OS_OSX: string;
static OS_WP8: string;
static OS_WINRT: string;
static OS_UNKNOWN: string;
static UNKNOWN: number;
static WIN32: number;
static LINUX: number;
static MACOS: number;
static ANDROID: number;
static IPHONE: number;
static IPAD: number;
static BLACKBERRY: number;
static NACL: number;
static EMSCRIPTEN: number;
static TIZEN: number;
static WINRT: number;
static WP8: number;
static MOBILE_BROWSER: number;
static DESKTOP_BROWSER: number;
/** Indicates whether executes in editor's window process (Electron's renderer context) */
static EDITOR_PAGE: number;
/** Indicates whether executes in editor's main process (Electron's browser context) */
static EDITOR_CORE: number;
static WECHAT_GAME: number;
static QQ_PLAY: number;
/** BROWSER_TYPE_WECHAT */
static BROWSER_TYPE_WECHAT: string;
/** BROWSER_TYPE_WECHAT_GAME */
static BROWSER_TYPE_WECHAT_GAME: string;
/** BROWSER_TYPE_QQ_PLAY */
static BROWSER_TYPE_QQ_PLAY: string;
static BROWSER_TYPE_ANDROID: string;
static BROWSER_TYPE_IE: string;
static BROWSER_TYPE_QQ: string;
static BROWSER_TYPE_MOBILE_QQ: string;
static BROWSER_TYPE_UC: string;
static BROWSER_TYPE_360: string;
static BROWSER_TYPE_BAIDU_APP: string;
static BROWSER_TYPE_BAIDU: string;
static BROWSER_TYPE_MAXTHON: string;
static BROWSER_TYPE_OPERA: string;
static BROWSER_TYPE_OUPENG: string;
static BROWSER_TYPE_MIUI: string;
static BROWSER_TYPE_FIREFOX: string;
static BROWSER_TYPE_SAFARI: string;
static BROWSER_TYPE_CHROME: string;
static BROWSER_TYPE_LIEBAO: string;
static BROWSER_TYPE_QZONE: string;
static BROWSER_TYPE_SOUGOU: string;
static BROWSER_TYPE_UNKNOWN: string;
/** Is native ? This is set to be true in jsb auto. */
static isNative: boolean;
/** Is web browser ? */
static isBrowser: boolean;
/** Indicate whether system is mobile system */
static isMobile: boolean;
/** Indicate the running platform */
static platform: number;
/** Indicate the current language of the running system */
static language: string;
/** Indicate the running os name */
static os: string;
/** Indicate the running os version */
static osVersion: string;
/** Indicate the running os main version */
static osMainVersion: number;
/** Indicate the running browser type */
static browserType: string;
/** Indicate the running browser version */
static browserVersion: string;
/** Indicate the real pixel resolution of the whole game window */
static windowPixelResolution: Size;
/** cc.sys.localStorage is a local storage component. */
static localStorage: any;
/** The capabilities of the current platform */
static capabilities: any;
/**
Forces the garbage collection, only available in JSB
*/
static garbageCollect(): void;
/**
Dumps rooted objects, only available in JSB
*/
static dumpRoot(): void;
/**
Restart the JS VM, only available in JSB
*/
static restartVM(): void;
/**
Clean a script in the JS VM, only available in JSB
@param jsfile jsfile
*/
static cleanScript(jsfile: string): void;
/**
Check whether an object is valid,
In web engine, it will return true if the object exist
In native engine, it will return true if the JS object and the correspond native object are both valid
@param obj obj
*/
static isObjectValid(obj: any): boolean;
/**
Dump system informations
*/
static dump(): void;
/**
Open a url in browser
@param url url
*/
static openURL(url: string): void;
/**
Get the number of milliseconds elapsed since 1 January 1970 00:00:00 UTC.
*/
static now(): number;
}
/** cc.view is the singleton object which represents the game window.
It's main task include:
- Apply the design resolution policy
- Provide interaction with the window, like resize event on web, retina display support, etc...
- Manage the game view port which can be different with the window
- Manage the content scale and translation
Since the cc.view is a singleton, you don't need to call any constructor or create functions,
the standard way to use it is by calling:
- cc.view.methodName();
*/
export class View {
/**
Sets view's target-densitydpi for android mobile browser. it can be set to:
1. cc.macro.DENSITYDPI_DEVICE, value is "device-dpi"
2. cc.macro.DENSITYDPI_HIGH, value is "high-dpi" (default value)
3. cc.macro.DENSITYDPI_MEDIUM, value is "medium-dpi" (browser's default value)
4. cc.macro.DENSITYDPI_LOW, value is "low-dpi"
5. Custom value, e.g: "480"
@param densityDPI densityDPI
*/
setTargetDensityDPI(densityDPI: string): void;
/**
Returns the current target-densitydpi value of cc.view.
*/
getTargetDensityDPI(): string;
/**
Sets whether resize canvas automatically when browser's size changed.
Useful only on web.
@param enabled Whether enable automatic resize with browser's resize event
*/
resizeWithBrowserSize(enabled: boolean): void;
/**
Sets the callback function for cc.view's resize action,
this callback will be invoked before applying resolution policy,
so you can do any additional modifications within the callback.
Useful only on web.
@param callback The callback function
*/
setResizeCallback(callback: Function|void): void;
/**
Sets the orientation of the game, it can be landscape, portrait or auto.
When set it to landscape or portrait, and screen w/h ratio doesn't fit,
cc.view will automatically rotate the game canvas using CSS.
Note that this function doesn't have any effect in native,
in native, you need to set the application orientation in native project settings
@param orientation Possible values: cc.macro.ORIENTATION_LANDSCAPE | cc.macro.ORIENTATION_PORTRAIT | cc.macro.ORIENTATION_AUTO
*/
setOrientation(orientation: number): void;
/**
Sets whether the engine modify the "viewport" meta in your web page.
It's enabled by default, we strongly suggest you not to disable it.
And even when it's enabled, you can still set your own "viewport" meta, it won't be overridden
Only useful on web
@param enabled Enable automatic modification to "viewport" meta
*/
adjustViewPort(enabled: boolean): void;
/**
Retina support is enabled by default for Apple device but disabled for other devices,
it takes effect only when you called setDesignResolutionPolicy
Only useful on web
@param enabled Enable or disable retina display
*/
enableRetina(enabled: boolean): void;
/**
Check whether retina display is enabled.
Only useful on web
*/
isRetinaEnabled(): boolean;
/**
!#en Whether to Enable on anti-alias
!#zh 控制抗锯齿是否开启
@param enabled Enable or not anti-alias
*/
enableAntiAlias(enabled: boolean): void;
/**
!#en Returns whether the current enable on anti-alias
!#zh 返回当前是否抗锯齿
*/
isAntiAliasEnabled(): boolean;
/**
If enabled, the application will try automatically to enter full screen mode on mobile devices
You can pass true as parameter to enable it and disable it by passing false.
Only useful on web
@param enabled Enable or disable auto full screen on mobile devices
*/
enableAutoFullScreen(enabled: boolean): void;
/**
Check whether auto full screen is enabled.
Only useful on web
*/
isAutoFullScreenEnabled(): boolean;
/**
Get whether render system is ready(no matter opengl or canvas),
this name is for the compatibility with cocos2d-x, subclass must implement this method.
*/
isViewReady(): boolean;
/**
Sets the resolution translate on View.
@param offsetLeft offsetLeft
@param offsetTop offsetTop
*/
setContentTranslateLeftTop(offsetLeft: number, offsetTop: number): void;
/**
Returns the resolution translate on View
*/
getContentTranslateLeftTop(): Size;
/**
Returns the frame size of the view.
On native platforms, it returns the screen size since the view is a fullscreen view.
On web, it returns the size of the canvas's outer DOM element.
*/
getFrameSize(): Size;
/**
On native, it sets the frame size of view.
On web, it sets the size of the canvas's outer DOM element.
@param width width
@param height height
*/
setFrameSize(width: number, height: number): void;
/**
Returns the visible area size of the view port.
*/
getVisibleSize(): Size;
/**
Returns the visible area size of the view port.
*/
getVisibleSizeInPixel(): Size;
/**
Returns the visible origin of the view port.
*/
getVisibleOrigin(): Vec2;
/**
Returns the visible origin of the view port.
*/
getVisibleOriginInPixel(): Vec2;
/**
Returns whether developer can set content's scale factor.
*/
canSetContentScaleFactor(): boolean;
/**
Returns the current resolution policy
*/
getResolutionPolicy(): ResolutionPolicy;
/**
Sets the current resolution policy
@param resolutionPolicy resolutionPolicy
*/
setResolutionPolicy(resolutionPolicy: ResolutionPolicy|number): void;
/**
Sets the resolution policy with designed view size in points.
The resolution policy include:
[1] ResolutionExactFit Fill screen by stretch-to-fit: if the design resolution ratio of width to height is different from the screen resolution ratio, your game view will be stretched.
[2] ResolutionNoBorder Full screen without black border: if the design resolution ratio of width to height is different from the screen resolution ratio, two areas of your game view will be cut.
[3] ResolutionShowAll Full screen with black border: if the design resolution ratio of width to height is different from the screen resolution ratio, two black borders will be shown.
[4] ResolutionFixedHeight Scale the content's height to screen's height and proportionally scale its width
[5] ResolutionFixedWidth Scale the content's width to screen's width and proportionally scale its height
[cc.ResolutionPolicy] [Web only feature] Custom resolution policy, constructed by cc.ResolutionPolicy
@param width Design resolution width.
@param height Design resolution height.
@param resolutionPolicy The resolution policy desired
*/
setDesignResolutionSize(width: number, height: number, resolutionPolicy: ResolutionPolicy|number): void;
/**
Returns the designed size for the view.
Default resolution size is the same as 'getFrameSize'.
*/
getDesignResolutionSize(): Size;
/**
Sets the container to desired pixel resolution and fit the game content to it.
This function is very useful for adaptation in mobile browsers.
In some HD android devices, the resolution is very high, but its browser performance may not be very good.
In this case, enabling retina display is very costy and not suggested, and if retina is disabled, the image may be blurry.
But this API can be helpful to set a desired pixel resolution which is in between.
This API will do the following:
1. Set viewport's width to the desired width in pixel
2. Set body width to the exact pixel resolution
3. The resolution policy will be reset with designed view size in points.
@param width Design resolution width.
@param height Design resolution height.
@param resolutionPolicy The resolution policy desired
*/
setRealPixelResolution(width: number, height: number, resolutionPolicy: ResolutionPolicy|number): void;
/**
Sets view port rectangle with points.
@param x x
@param y y
@param w width
@param h height
*/
setViewPortInPoints(x: number, y: number, w: number, h: number): void;
/**
Sets Scissor rectangle with points.
@param x x
@param y y
@param w w
@param h h
*/
setScissorInPoints(x: number, y: number, w: number, h: number): void;
/**
Returns whether GL_SCISSOR_TEST is enable
*/
isScissorEnabled(): boolean;
/**
Returns the current scissor rectangle
*/
getScissorRect(): Rect;
/**
Sets the name of the view
@param viewName viewName
*/
setViewName(viewName: string): void;
/**
Returns the name of the view
*/
getViewName(): string;
/**
Returns the view port rectangle.
*/
getViewPortRect(): Rect;
/**
Returns scale factor of the horizontal direction (X axis).
*/
getScaleX(): number;
/**
Returns scale factor of the vertical direction (Y axis).
*/
getScaleY(): number;
/**
Returns device pixel ratio for retina display.
*/
getDevicePixelRatio(): number;
/**
Returns the real location in view for a translation based on a related position
@param tx The X axis translation
@param ty The Y axis translation
@param relatedPos The related position object including "left", "top", "width", "height" informations
*/
convertToLocationInView(tx: number, ty: number, relatedPos: any): Vec2;
}
/** cc.ContainerStrategy class is the root strategy class of container's scale strategy,
it controls the behavior of how to scale the cc.container and cc.game.canvas object
*/
export class ContainerStrategy {
/**
Manipulation before appling the strategy
@param view The target view
*/
preApply(view: View): void;
/**
Function to apply this strategy
@param view view
@param designedResolution designedResolution
*/
apply(view: View, designedResolution: Size): void;
/**
Manipulation after applying the strategy
@param view The target view
*/
postApply(view: View): void;
}
/** cc.ContentStrategy class is the root strategy class of content's scale strategy,
it controls the behavior of how to scale the scene and setup the viewport for the game
*/
export class ContentStrategy {
/**
Manipulation before applying the strategy
@param view The target view
*/
preApply(view: View): void;
/**
Function to apply this strategy
The return value is {scale: [scaleX, scaleY], viewport: {cc.Rect}},
The target view can then apply these value to itself, it's preferred not to modify directly its private variables
@param view view
@param designedResolution designedResolution
*/
apply(view: View, designedResolution: Size): any;
/**
Manipulation after applying the strategy
@param view The target view
*/
postApply(view: View): void;
}
/** undefined */
export class EqualToFrame extends ContainerStrategy {
}
/** undefined */
export class ProportionalToFrame extends ContainerStrategy {
}
/** undefined */
export class EqualToWindow extends EqualToFrame {
}
/** undefined */
export class ProportionalToWindow extends ProportionalToFrame {
}
/** undefined */
export class OriginalContainer extends ContainerStrategy {
}
/** cc.ResolutionPolicy class is the root strategy class of scale strategy,
its main task is to maintain the compatibility with Cocos2d-x
*/
export class ResolutionPolicy {
/**
@param containerStg The container strategy
@param contentStg The content strategy
*/
constructor(containerStg: ContainerStrategy, contentStg: ContentStrategy);
/**
Manipulation before applying the resolution policy
@param view The target view
*/
preApply(view: View): void;
/**
Function to apply this resolution policy
The return value is {scale: [scaleX, scaleY], viewport: {cc.Rect}},
The target view can then apply these value to itself, it's preferred not to modify directly its private variables
@param view The target view
@param designedResolution The user defined design resolution
*/
apply(view: View, designedResolution: Size): any;
/**
Manipulation after appyling the strategy
@param view The target view
*/
postApply(view: View): void;
/**
Setup the container's scale strategy
@param containerStg containerStg
*/
setContainerStrategy(containerStg: ContainerStrategy): void;
/**
Setup the content's scale strategy
@param contentStg contentStg
*/
setContentStrategy(contentStg: ContentStrategy): void;
/** The entire application is visible in the specified area without trying to preserve the original aspect ratio.
Distortion can occur, and the application may appear stretched or compressed. */
static EXACT_FIT: number;
/** The entire application fills the specified area, without distortion but possibly with some cropping,
while maintaining the original aspect ratio of the application. */
static NO_BORDER: number;
/** The entire application is visible in the specified area without distortion while maintaining the original
aspect ratio of the application. Borders can appear on two sides of the application. */
static SHOW_ALL: number;
/** The application takes the height of the design resolution size and modifies the width of the internal
canvas so that it fits the aspect ratio of the device
no distortion will occur however you must make sure your application works on different
aspect ratios */
static FIXED_HEIGHT: number;
/** The application takes the width of the design resolution size and modifies the height of the internal
canvas so that it fits the aspect ratio of the device
no distortion will occur however you must make sure your application works on different
aspect ratios */
static FIXED_WIDTH: number;
/** Unknow policy */
static UNKNOWN: number;
}
/** cc.visibleRect is a singleton object which defines the actual visible rect of the current view,
it should represent the same rect as cc.view.getViewportRect() */
export class visibleRect {
/**
initialize
@param visibleRect visibleRect
*/
init(visibleRect: Rect): void;
/** Top left coordinate of the screen related to the game scene. */
topLeft: Vec2;
/** Top right coordinate of the screen related to the game scene. */
topRight: Vec2;
/** Top center coordinate of the screen related to the game scene. */
top: Vec2;
/** Bottom left coordinate of the screen related to the game scene. */
bottomLeft: Vec2;
/** Bottom right coordinate of the screen related to the game scene. */
bottomRight: Vec2;
/** Bottom center coordinate of the screen related to the game scene. */
bottom: Vec2;
/** Center coordinate of the screen related to the game scene. */
center: Vec2;
/** Left center coordinate of the screen related to the game scene. */
left: Vec2;
/** Right center coordinate of the screen related to the game scene. */
right: Vec2;
/** Width of the screen. */
width: number;
/** Height of the screen. */
height: number;
}
/** The CallbacksHandler is an abstract class that can register and unregister callbacks by key.
Subclasses should implement their own methods about how to invoke the callbacks. */
export class _CallbacksHandler {
/**
@param key key
@param callback callback
@param target can be null
*/
add(key: string, callback: Function, target?: any): void;
/**
Check if the specified key has any registered callback. If a callback is also specified,
it will only return true if the callback is registered.
@param key key
@param callback callback
@param target target
*/
has(key: string, callback?: Function, target?: any): boolean;
/**
Removes all callbacks registered in a certain event type or all callbacks registered with a certain target
@param keyOrTarget The event key to be removed or the target to be removed
*/
removeAll(keyOrTarget: string|any): void;
/**
@param key key
@param callback callback
@param target target
*/
remove(key: string, callback: Function, target?: any): void;
}
/** !#en The callbacks invoker to handle and invoke callbacks by key.
!#zh CallbacksInvoker 用来根据 Key 管理并调用回调方法。 */
export class CallbacksInvoker extends _CallbacksHandler {
/**
@param key key
@param p1 p1
@param p2 p2
@param p3 p3
@param p4 p4
@param p5 p5
*/
invoke(key: string, p1?: any, p2?: any, p3?: any, p4?: any, p5?: any): void;
}
/** !#en Contains information collected during deserialization
!#zh 包含反序列化时的一些信息 */
export class Details {
/** list of the depends assets' uuid */
uuidList: string[];
/** the obj list whose field needs to load asset by uuid */
uuidObjList: any[];
/** the corresponding field name which referenced to the asset */
uuidPropList: string[];
/** the corresponding field name which referenced to the raw object */
rawProp: string;
reset(): void;
/**
@param obj obj
@param propName propName
*/
getUuidOf(obj: any, propName: string): string;
/**
@param obj obj
@param propName propName
@param uuid uuid
*/
push(obj: any, propName: string, uuid: string): void;
}
/** undefined */
export class url {
/**
Returns the url of raw assets, you will only need this if the raw asset is inside the "resources" folder.
@param url url
@example
```js
---
var url = cc.url.raw("textures/myTexture.png");
console.log(url); // "resources/raw/textures/myTexture.png"
```
*/
static raw(url: string): string;
/**
Returns the url of builtin raw assets. This method can only used in editor.
@param url url
@example
```js
---
var url = cc.url.builtinRaw("textures/myTexture.png");
console.log(url); // "resources/default-raw/textures/myTexture.png"
```
*/
static builtinRaw(url: string): string;
}
/**
This class allows to easily create OpenGL or Canvas 2D textures from images, text or raw data.
The created cc.Texture2D object will always have power-of-two dimensions.
Depending on how you create the cc.Texture2D object, the actual image area of the texture might be smaller than the texture dimensions
i.e. "contentSize" != (pixelsWide, pixelsHigh) and (maxS, maxT) != (1.0, 1.0).
Be aware that the content of the generated textures will be upside-down!
*/
export class Texture2D extends RawAsset implements EventTarget {
/** !#en
The url of the texture, this coule be empty if the texture wasn't created via a file.
!#zh
贴图文件的 url，当贴图不是由文件创建时值可能为空 */
url: string;
/** !#en
Whether the texture is loaded or not
!#zh
贴图是否已经成功加载 */
loaded: boolean;
/** !#en
Texture width in pixel
!#zh
贴图像素宽度 */
width: number;
/** !#en
Texture height in pixel
!#zh
贴图像素高度 */
height: number;
/**
Update texture options, not available in Canvas render mode.
image, format, premultiplyAlpha can not be updated in native.
@param options options
*/
update(options: {image: DOMImageElement; mipmap: boolean; format: PixelFormat; minFilter: Filter; magFilter: Filter; wrapS: WrapMode; wrapT: WrapMode; premultiplyAlpha: boolean; }): void;
/**
Get width in pixels.
*/
getPixelWidth(): number;
/**
Get height of in pixels.
*/
getPixelHeight(): number;
/**
Get content size.
*/
getContentSize(): Size;
/**
Get content size in pixels.
*/
getContentSizeInPixels(): Size;
/**
Init with HTML element.
@param element element
@example
```js
var img = new Image();
img.src = dataURL;
texture.initWithElement(img);
texture.handleLoadedTexture();
```
*/
initWithElement(element: HTMLImageElement|HTMLCanvasElement): void;
/**
Intializes with a texture2d with data.
@param data data
@param pixelFormat pixelFormat
@param pixelsWidth pixelsWidth
@param pixelsHeight pixelsHeight
@param contentSize contentSize is deprecated and ignored
*/
initWithData(data: TypedArray, pixelFormat: number, pixelsWidth: number, pixelsHeight: number, contentSize: Size): boolean;
/**
Initializes a texture from a UIImage object.
Extensions to make it easy to create a CCTexture2D object from an image file.
Note that RGBA type textures will have their alpha premultiplied - use the blending mode (gl.ONE, gl.ONE_MINUS_SRC_ALPHA).
@param uiImage uiImage
*/
initWithImage(uiImage: HTMLImageElement): boolean;
/**
HTMLElement Object getter, available only on web.
In most case, it will return null, because we are recycling the dom image element for better loading performance and lower image cache memory usage.
*/
getHtmlElementObj(): HTMLImageElement;
/**
Check whether texture is loaded.
*/
isLoaded(): boolean;
/**
Handler of texture loaded event.
@param premultiplied premultiplied
*/
handleLoadedTexture(premultiplied?: boolean): void;
/**
Description of cc.Texture2D.
*/
description(): string;
/**
Release texture.
*/
releaseTexture(): void;
/**
Pixel format of the texture.
*/
getPixelFormat(): number;
/**
Whether or not the texture has their Alpha premultiplied,
support only in WebGl rendering mode.
*/
hasPremultipliedAlpha(): boolean;
/**
Whether or not use mipmap, support only in WebGl rendering mode.
*/
hasMipmaps(): boolean;
/**
Sets the min filter, mag filter, wrap s and wrap t texture parameters.
If the texture size is NPOT (non power of 2), then in can only use gl.CLAMP_TO_EDGE in gl.TEXTURE_WRAP_{S,T}.
@param texParams texParams object or minFilter
@param magFilter magFilter
@param wrapS wrapS
@param wrapT wrapT
*/
setTexParameters(texParams: any|number, magFilter?: number, wrapS?: Texture2D.WrapMode, wrapT?: Texture2D.WrapMode): void;
/**
sets antialias texture parameters:
- GL_TEXTURE_MIN_FILTER = GL_NEAREST
- GL_TEXTURE_MAG_FILTER = GL_NEAREST
supported only in native or WebGl rendering mode
*/
setAntiAliasTexParameters(): void;
/**
Sets alias texture parameters:
GL_TEXTURE_MIN_FILTER = GL_NEAREST
GL_TEXTURE_MAG_FILTER = GL_NEAREST
supported only in native or WebGl rendering mode
*/
setAliasTexParameters(): void;
/** Pixel format of the texture. */
pixelFormat: number;
/** Width in pixels. */
pixelWidth: number;
/** Height in pixels. */
pixelHeight: number;
/**
!#en
Register an callback of a specific event type on the EventTarget.
!#zh
注册事件目标的特定事件类型回调。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.on(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
on(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
on(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Removes the listeners previously registered with the same type, callback, target and or useCapture,
if only type is passed as parameter, all listeners registered with that type will be removed.
!#zh
删除之前用同类型，回调，目标或 useCapture 注册的事件监听器，如果只传递 type，将会删除 type 类型的所有事件监听器。
@param type A string representing the event type being removed.
@param callback The callback to remove.
@param target The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
@param useCapture Specifies whether the callback being removed was registered as a capturing callback or not.
If not specified, useCapture defaults to false. If a callback was registered twice,
one with capture and one without, each must be removed separately. Removal of a capturing callback
does not affect a non-capturing version of the same listener, and vice versa.
@example
```js
// register touchEnd eventListener
var touchEnd = node.on(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
// remove touch end event listener
node.off(cc.Node.EventType.TOUCH_END, touchEnd, node);
// remove all touch end event listeners
node.off(cc.Node.EventType.TOUCH_END);
```
*/
off(type: string, callback?: Function, target?: any, useCapture?: boolean): void;
/**
!#en Removes all callbacks previously registered with the same target (passed as parameter).
This is not for removing all listeners in the current event target,
and this is not for removing all listeners the target parameter have registered.
It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.
!#zh 在当前 EventTarget 上删除指定目标（target 参数）注册的所有事件监听器。
这个函数无法删除当前 EventTarget 的所有事件监听器，也无法删除 target 参数所注册的所有事件监听器。
这个函数只能删除 target 参数在当前 EventTarget 上注册的所有事件监听器。
@param target The target to be searched for all related listeners
*/
targetOff(target: any): void;
/**
!#en
Register an callback of a specific event type on the EventTarget,
the callback will remove itself after the first time it is triggered.
!#zh
注册事件目标的特定事件类型回调，回调会在第一时间被触发后删除自身。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.once(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
once(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
once(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Dispatches an event into the event flow.
The event target is the EventTarget object upon which the dispatchEvent() method is called.
!#zh 分发事件到事件流中。
@param event The Event object that is dispatched into the event flow
*/
dispatchEvent(event: Event): void;
/**
!#en
Send an event to this object directly, this method will not propagate the event to any other objects.
The event will be created from the supplied message, you can get the "detail" argument from event.detail.
!#zh
该对象直接发送事件， 这种方法不会对事件传播到任何其他对象。
@param message the message to send
@param detail whatever argument the message needs
*/
emit(message: string, detail?: any): void;
}
/** cc.textureCache is a singleton object, it's the global cache for cc.Texture2D */
export class textureCache {
/**
Description
*/
static description(): string;
/**
Returns an already created texture. Returns null if the texture doesn't exist.
@param textureKeyName textureKeyName
@example
```js
------------------
var key = cc.textureCache.textureForKey("hello.png");
```
*/
static textureForKey(textureKeyName: string): Texture2D;
/**
Returns an already created texture. Returns null if the texture doesn't exist.
@param textureKeyName textureKeyName
@example
```js
------------------
var key = cc.textureCache.getTextureForKey("hello.png");
```
*/
static getTextureForKey(textureKeyName: string): Texture2D;
/**
@param texture texture
@example
```js
---------------
var cacheTextureForColor = cc.textureCache.getTextureColors(texture);
```
*/
static getTextureColors(texture: HTMLImageElement): any[];
/**
!#en get all textures
!#zh 获取所有贴图
*/
static getAllTextures(): Texture2D[];
/**
Purges the dictionary of loaded textures.
Call this method if you receive the "Memory Warning"
In the short term: it will free some resources preventing your app from being killed
In the medium term: it will allocate more resources
In the long term: it will be the same
@example
```js
--------
cc.textureCache.removeAllTextures();
```
*/
static removeAllTextures(): void;
/**
Deletes a texture from the cache given a texture.
@param texture texture
@example
```js
-----
cc.textureCache.removeTexture(texture);
```
*/
static removeTexture(texture: HTMLImageElement): void;
/**
Deletes a texture from the cache given a its key name.
@param textureKeyName textureKeyName
@example
```js
------
cc.textureCache.removeTexture("hello.png");
```
*/
static removeTextureForKey(textureKeyName: string): void;
/**
Returns a Texture2D object given an file image
If the file image was not previously loaded, it will create a new Texture2D
object and it will return it. It will use the filename as a key.
Otherwise it will return a reference of a previously loaded image.
Supported image extensions: .png, .jpg, .gif
@param url url
@param cb cb
@param target target
@example
```js
----
cc.textureCache.addImage("hello.png");
```
*/
static addImage(url: string, cb: Function, target: any): Texture2D;
/**
Cache the image data.
@param path path
@param texture texture
*/
static cacheImage(path: string, texture: HTMLImageElement|HTMLCanvasElement): void;
}
/** A base node for CCNode, it will:
- maintain scene hierarchy and active logic
- notifications if some properties changed
- define some interfaces shares between CCNode
- define machanisms for Enity Component Systems
- define prefab and serialize functions */
export class _BaseNode extends Object implements EventTarget {
/** !#en Name of node.
!#zh 该节点名称。 */
name: string;
/** !#en The uuid for editor, will be stripped before building project.
!#zh 主要用于编辑器的 uuid，在编辑器下可用于持久化存储，在项目构建之后将变成自增的 id。 */
uuid: string;
/** !#en All children nodes.
!#zh 节点的所有子节点。 */
children: Node[];
/** !#en All children nodes.
!#zh 节点的子节点数量。 */
childrenCount: number;
/** !#en
The local active state of this node.
Note that a Node may be inactive because a parent is not active, even if this returns true.
Use {{#crossLink "Node/activeInHierarchy:property"}}{{/crossLink}} if you want to check if the Node is actually treated as active in the scene.
!#zh
当前节点的自身激活状态。
值得注意的是，一个节点的父节点如果不被激活，那么即使它自身设为激活，它仍然无法激活。
如果你想检查节点在场景中实际的激活状态可以使用 {{#crossLink "Node/activeInHierarchy:property"}}{{/crossLink}}。 */
active: boolean;
/** !#en Indicates whether this node is active in the scene.
!#zh 表示此节点是否在场景中激活。 */
activeInHierarchy: boolean;
/** !#en Tag of node.
!#zh 节点标签。 */
tag: number;
/**
@param name name
*/
constructor(name?: string);
/** !#en The parent of the node.
!#zh 该节点的父节点。 */
parent: Node;
/**
!#en
Properties configuration function
All properties in attrs will be set to the node,
when the setter of the node is available,
the property will be set via setter function.
!#zh 属性配置函数。在 attrs 的所有属性将被设置为节点属性。
@param attrs Properties to be set to node
@example
```js
var attrs = { key: 0, num: 100 };
node.attr(attrs);
```
*/
attr(attrs: any): void;
/**
!#en Returns a child from the container given its tag.
!#zh 通过标签获取节点的子节点。
@param aTag An identifier to find the child node.
@example
```js
var child = node.getChildByTag(1001);
```
*/
getChildByTag(aTag: number): Node;
/**
!#en Returns a child from the container given its uuid.
!#zh 通过 uuid 获取节点的子节点。
@param uuid The uuid to find the child node.
@example
```js
var child = node.getChildByUuid(uuid);
```
*/
getChildByUuid(uuid: string): Node;
/**
!#en Returns a child from the container given its name.
!#zh 通过名称获取节点的子节点。
@param name A name to find the child node.
@example
```js
var child = node.getChildByName("Test Node");
```
*/
getChildByName(name: string): Node;
/**
!#en
Inserts a child to the node at a specified index.
!#zh
插入子节点到指定位置
@param child the child node to be inserted
@param siblingIndex the sibling index to place the child in
@example
```js
node.insertChild(child, 2);
```
*/
insertChild(child: Node, siblingIndex: number): void;
/**
!#en Get the sibling index.
!#zh 获取同级索引。
@example
```js
var index = node.getSiblingIndex();
```
*/
getSiblingIndex(): number;
/**
!#en Set the sibling index of this node.
!#zh 设置节点同级索引。
@param index index
@example
```js
node.setSiblingIndex(1);
```
*/
setSiblingIndex(index: number): void;
/**
!#en
Remove itself from its parent node. If cleanup is `true`, then also remove all events and actions.
If the cleanup parameter is not passed, it will force a cleanup, so it is recommended that you always pass in the `false` parameter when calling this API.
If the node orphan, then nothing happens.
!#zh
从父节点中删除该节点。如果不传入 cleanup 参数或者传入 `true`，那么这个节点上所有绑定的事件、action 都会被删除。
因此建议调用这个 API 时总是传入 `false` 参数。
如果这个节点是一个孤节点，那么什么都不会发生。
@param cleanup true if all actions and callbacks on this node should be removed, false otherwise.
@example
```js
node.removeFromParent();
node.removeFromParent(false);
```
*/
removeFromParent(cleanup?: boolean): void;
/**
!#en
Removes a child from the container. It will also cleanup all running actions depending on the cleanup parameter.
If the cleanup parameter is not passed, it will force a cleanup.
"remove" logic MUST only be on this method
If a class wants to extend the 'removeChild' behavior it only needs
to override this method.
!#zh
移除节点中指定的子节点，是否需要清理所有正在运行的行为取决于 cleanup 参数。
如果 cleanup 参数不传入，默认为 true 表示清理。
@param child The child node which will be removed.
@param cleanup true if all running actions and callbacks on the child node will be cleanup, false otherwise.
@example
```js
node.removeChild(newNode);
node.removeChild(newNode, false);
```
*/
removeChild(child: Node, cleanup?: boolean): void;
/**
!#en
Removes a child from the container by tag value. It will also cleanup all running actions depending on the cleanup parameter.
If the cleanup parameter is not passed, it will force a cleanup.
!#zh
通过标签移除节点中指定的子节点，是否需要清理所有正在运行的行为取决于 cleanup 参数。
如果 cleanup 参数不传入，默认为 true 表示清理。
@param tag An integer number that identifies a child node
@param cleanup true if all running actions and callbacks on the child node will be cleanup, false otherwise.
@example
```js
node.removeChildByTag(1001);
node.removeChildByTag(1001, false);
```
*/
removeChildByTag(tag: number, cleanup?: boolean): void;
/**
!#en
Removes all children from the container and do a cleanup all running actions depending on the cleanup parameter.
If the cleanup parameter is not passed, it will force a cleanup.
!#zh
移除节点所有的子节点，是否需要清理所有正在运行的行为取决于 cleanup 参数。
如果 cleanup 参数不传入，默认为 true 表示清理。
@param cleanup true if all running actions on all children nodes should be cleanup, false otherwise.
@example
```js
node.removeAllChildren();
node.removeAllChildren(false);
```
*/
removeAllChildren(cleanup?: boolean): void;
/**
!#en Is this node a child of the given node?
!#zh 是否是指定节点的子节点？
@param parent parent
@example
```js
node.isChildOf(newNode);
```
*/
isChildOf(parent: Node): boolean;
/**
!#en
Returns the component of supplied type if the node has one attached, null if it doesn't.
You can also get component in the node by passing in the name of the script.
!#zh
获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
传入参数也可以是脚本的名称。
@param typeOrClassName typeOrClassName
@example
```js
// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");
```
*/
getComponent(type: {prototype: T}): T;
getComponent(className: string): any;
/**
!#en Returns all components of supplied type in the node.
!#zh 返回节点上指定类型的所有组件。
@param typeOrClassName typeOrClassName
@example
```js
var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");
```
*/
getComponents(type: {prototype: T}): T[];
getComponents(className: string): any[];
/**
!#en Returns the component of supplied type in any of its children using depth first search.
!#zh 递归查找所有子节点中第一个匹配指定类型的组件。
@param typeOrClassName typeOrClassName
@example
```js
var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");
```
*/
getComponentInChildren(type: {prototype: T}): T;
getComponentInChildren(className: string): any;
/**
!#en Returns all components of supplied type in self or any of its children.
!#zh 递归查找自身或所有子节点中指定类型的组件
@param typeOrClassName typeOrClassName
@example
```js
var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");
```
*/
getComponentsInChildren(type: {prototype: T}): T[];
getComponentsInChildren(className: string): any[];
/**
!#en Adds a component class to the node. You can also add component to node by passing in the name of the script.
!#zh 向节点添加一个指定类型的组件类，你还可以通过传入脚本的名称来添加组件。
@param typeOrClassName The constructor or the class name of the component to add
@example
```js
var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");
```
*/
addComponent(type: {new(): T}): T;
addComponent(className: string): any;
/**
!#en
Removes a component identified by the given name or removes the component object given.
You can also use component.destroy() if you already have the reference.
!#zh
删除节点上的指定组件，传入参数可以是一个组件构造函数或组件名，也可以是已经获得的组件引用。
如果你已经获得组件引用，你也可以直接调用 component.destroy()
@param component The need remove component.
@example
```js
node.removeComponent(cc.Sprite);
var Test = require("Test");
node.removeComponent(Test);
```
*/
removeComponent(component: string|Function|Component): void;
/**
!#en
Destroy all children from the node, and release all their own references to other objects.
Actual destruct operation will delayed until before rendering.
!#zh
销毁所有子节点，并释放所有它们对其它对象的引用。
实际销毁操作会延迟到当前帧渲染前执行。
@example
```js
node.destroyAllChildren();
```
*/
destroyAllChildren(): void;
/**
!#en
Register an callback of a specific event type on the EventTarget.
!#zh
注册事件目标的特定事件类型回调。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.on(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
on(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
on(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Removes the listeners previously registered with the same type, callback, target and or useCapture,
if only type is passed as parameter, all listeners registered with that type will be removed.
!#zh
删除之前用同类型，回调，目标或 useCapture 注册的事件监听器，如果只传递 type，将会删除 type 类型的所有事件监听器。
@param type A string representing the event type being removed.
@param callback The callback to remove.
@param target The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
@param useCapture Specifies whether the callback being removed was registered as a capturing callback or not.
If not specified, useCapture defaults to false. If a callback was registered twice,
one with capture and one without, each must be removed separately. Removal of a capturing callback
does not affect a non-capturing version of the same listener, and vice versa.
@example
```js
// register touchEnd eventListener
var touchEnd = node.on(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
// remove touch end event listener
node.off(cc.Node.EventType.TOUCH_END, touchEnd, node);
// remove all touch end event listeners
node.off(cc.Node.EventType.TOUCH_END);
```
*/
off(type: string, callback?: Function, target?: any, useCapture?: boolean): void;
/**
!#en Removes all callbacks previously registered with the same target (passed as parameter).
This is not for removing all listeners in the current event target,
and this is not for removing all listeners the target parameter have registered.
It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.
!#zh 在当前 EventTarget 上删除指定目标（target 参数）注册的所有事件监听器。
这个函数无法删除当前 EventTarget 的所有事件监听器，也无法删除 target 参数所注册的所有事件监听器。
这个函数只能删除 target 参数在当前 EventTarget 上注册的所有事件监听器。
@param target The target to be searched for all related listeners
*/
targetOff(target: any): void;
/**
!#en
Register an callback of a specific event type on the EventTarget,
the callback will remove itself after the first time it is triggered.
!#zh
注册事件目标的特定事件类型回调，回调会在第一时间被触发后删除自身。
@param type A string representing the event type to listen for.
@param callback The callback that will be invoked when the event is dispatched.
The callback is ignored if it is a duplicate (the callbacks are unique).
@param target The target (this object) to invoke the callback, can be null
@param useCapture When set to true, the capture argument prevents callback
from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
@example
```js
node.once(cc.Node.EventType.TOUCH_END, function (event) {
cc.log("this is callback");
}, node);
```
*/
once(type: string, callback: (event: Event.EventCustom) => void, target?: any, useCapture?: boolean): (event: Event.EventCustom) => void;
once(type: string, callback: (event: T) => void, target?: any, useCapture?: boolean): (event: T) => void;
/**
!#en
Dispatches an event into the event flow.
The event target is the EventTarget object upon which the dispatchEvent() method is called.
!#zh 分发事件到事件流中。
@param event The Event object that is dispatched into the event flow
*/
dispatchEvent(event: Event): void;
/**
!#en
Send an event to this object directly, this method will not propagate the event to any other objects.
The event will be created from the supplied message, you can get the "detail" argument from event.detail.
!#zh
该对象直接发送事件， 这种方法不会对事件传播到任何其他对象。
@param message the message to send
@param detail whatever argument the message needs
*/
emit(message: string, detail?: any): void;
}
/** !#en
cc.AffineTransform class represent an affine transform matrix. It's composed basically by translation, rotation, scale transformations.
Please do not use its constructor directly, use cc.affineTransformMake alias function instead.
!#zh
cc.AffineTransform 类代表一个仿射变换矩阵。它基本上是由平移旋转，缩放转变所组成。
请不要直接使用它的构造，请使用 cc.affineTransformMake 函数代替。 */
export class AffineTransform {
/**
!#en Create a cc.AffineTransform object with all contents in the matrix.
!#zh 用在矩阵中的所有内容创建一个 cc.AffineTransform 对象。
@param a a
@param b b
@param c c
@param d d
@param tx tx
@param ty ty
*/
affineTransformMake(a: number, b: number, c: number, d: number, tx: number, ty: number): AffineTransform;
/**
!#en Clone a cc.AffineTransform object from the specified transform.
!#zh 克隆指定的 cc.AffineTransform 对象。
@param t t
*/
affineTransformClone(t: AffineTransform): AffineTransform;
/**
!#en Apply the affine transformation on a point.
!#zh 对一个点应用矩阵变换。
@param point or x.
@param transOrY transform matrix or y.
@param t transform matrix or y.
*/
pointApplyAffineTransform(point: Vec2|number, transOrY: AffineTransform|number, t: AffineTransform): Vec2;
/**
!#en Apply the affine transformation on a size.
!#zh 应用 Size 到仿射变换矩阵上。
@param size size
@param t t
*/
sizeApplyAffineTransform(size: Size, t: AffineTransform): Size;
/**
!#en
Create a identity transformation matrix:
[ 1, 0, 0,
0, 1, 0 ]
!#zh
单位矩阵：
[ 1, 0, 0,
0, 1, 0 ]
*/
affineTransformMakeIdentity(): AffineTransform;
/**
!#en Apply the affine transformation on a rect.
!#zh 应用 Rect 到仿射变换矩阵上。
@param rect rect
@param anAffineTransform anAffineTransform
*/
rectApplyAffineTransform(rect: Rect, anAffineTransform: AffineTransform): Rect;
/**
!#en Apply the affine transformation on a rect, and truns to an Oriented Bounding Box.
!#zh 应用 Rect 到仿射变换矩阵上, 并转换为有向包围盒
@param rect rect
@param anAffineTransform anAffineTransform
@param out_bl out_bl
@param out_tl out_tl
@param out_tr out_tr
@param out_br out_br
*/
obbApplyAffineTransform(rect: Rect, anAffineTransform: AffineTransform, out_bl: Vec2, out_tl: Vec2, out_tr: Vec2, out_br: Vec2): void;
/**
!#en Create a new affine transformation with a base transformation matrix and a translation based on it.
!#zh 基于一个基础矩阵加上一个平移操作来创建一个新的矩阵。
@param t The base affine transform object.
@param tx The translation on x axis.
@param ty The translation on y axis.
*/
affineTransformTranslate(t: AffineTransform, tx: number, ty: number): AffineTransform;
/**
!#en Create a new affine transformation with a base transformation matrix and a scale based on it.
!#zh 创建一个基础变换矩阵，并在此基础上进行了 Scale 仿射变换。
@param t The base affine transform object.
@param sx The scale on x axis.
@param sy The scale on y axis.
*/
affineTransformScale(t: AffineTransform, sx: number, sy: number): AffineTransform;
/**
!#en Create a new affine transformation with a base transformation matrix and a rotation based on it.
!#zh 创建一个基础变换矩阵，并在此基础上进行了 Rotation 仿射变换。
@param aTransform The base affine transform object.
@param anAngle The angle to rotate.
*/
affineTransformRotate(aTransform: AffineTransform, anAngle: number): AffineTransform;
/**
!#en
Concatenate a transform matrix to another and return the result:
t' = t1 * t2
!#zh 拼接两个矩阵，并返回结果：
t' = t1 * t2
@param t1 The first transform object.
@param t2 The transform object to concatenate.
*/
affineTransformConcat(t1: AffineTransform, t2: AffineTransform): AffineTransform;
/**
!#en
Concatenate a transform matrix to another
The results are reflected in the first matrix.
t' = t1 * t2
!#zh
拼接两个矩阵，将结果保存到第一个矩阵。
t' = t1 * t2
@param t1 The first transform object.
@param t2 The transform object to concatenate.
*/
affineTransformConcatIn(t1: AffineTransform, t2: AffineTransform): AffineTransform;
/**
!#en Return true if an affine transform equals to another, false otherwise.
!#zh 判断两个矩阵是否相等。
@param t1 t1
@param t2 t2
*/
affineTransformEqualToTransform(t1: AffineTransform, t2: AffineTransform): boolean;
/**
!#en Get the invert transform of an AffineTransform object.
!#zh 求逆矩阵。
@param t t
*/
affineTransformInvert(t: AffineTransform): AffineTransform;
/**
!#en Put the invert transform of an AffineTransform object into the out AffineTransform object.
!#zh 求逆矩阵并存入用户传入的矩阵对象参数。
@param t t
@param out out
*/
affineTransformInvert(t: AffineTransform, out: AffineTransform): void;
}
/** !#en
Representation of RGBA colors.
Each color component is a floating point value with a range from 0 to 255.
You can also use the convenience method {{#crossLink "cc/color:method"}}cc.color{{/crossLink}} to create a new Color.
!#zh
cc.Color 用于表示颜色。
它包含 RGBA 四个以浮点数保存的颜色分量，每个的值都在 0 到 255 之间。
您也可以通过使用 {{#crossLink "cc/color:method"}}cc.color{{/crossLink}} 的便捷方法来创建一个新的 Color。 */
export class Color extends ValueType {
/**
@param r red component of the color, default value is 0.
@param g green component of the color, defualt value is 0.
@param b blue component of the color, default value is 0.
@param a alpha component of the color, default value is 255.
*/
constructor(r?: number, g?: number, b?: number, a?: number);
/** !#en Solid white, RGBA is [255, 255, 255, 255].
!#zh 纯白色，RGBA 是 [255, 255, 255, 255]。 */
static WHITE: Color;
/** !#en Solid black, RGBA is [0, 0, 0, 255].
!#zh 纯黑色，RGBA 是 [0, 0, 0, 255]。 */
static BLACK: Color;
/** !#en Transparent, RGBA is [0, 0, 0, 0].
!#zh 透明，RGBA 是 [0, 0, 0, 0]。 */
static TRANSPARENT: Color;
/** !#en Grey, RGBA is [127.5, 127.5, 127.5].
!#zh 灰色，RGBA 是 [127.5, 127.5, 127.5]。 */
static GRAY: Color;
/** !#en Solid red, RGBA is [255, 0, 0].
!#zh 纯红色，RGBA 是 [255, 0, 0]。 */
static RED: Color;
/** !#en Solid green, RGBA is [0, 255, 0].
!#zh 纯绿色，RGBA 是 [0, 255, 0]。 */
static GREEN: Color;
/** !#en Solid blue, RGBA is [0, 0, 255].
!#zh 纯蓝色，RGBA 是 [0, 0, 255]。 */
static BLUE: Color;
/** !#en Yellow, RGBA is [255, 235, 4].
!#zh 黄色，RGBA 是 [255, 235, 4]。 */
static YELLOW: Color;
/** !#en Orange, RGBA is [255, 127, 0].
!#zh 橙色，RGBA 是 [255, 127, 0]。 */
static ORANGE: Color;
/** !#en Cyan, RGBA is [0, 255, 255].
!#zh 青色，RGBA 是 [0, 255, 255]。 */
static CYAN: Color;
/** !#en Magenta, RGBA is [255, 0, 255].
!#zh 洋红色（品红色），RGBA 是 [255, 0, 255]。 */
static MAGENTA: Color;
/**
!#en Clone a new color from the current color.
!#zh 克隆当前颜色。
@example
```js
var color = new cc.Color();
var newColor = color.clone();// Color {r: 0, g: 0, b: 0, a: 255}
```
*/
clone(): Color;
/**
!#en TODO
!#zh 判断两个颜色是否相等。
@param other other
@example
```js
var color1 = cc.Color.WHITE;
var color2 = new cc.Color(255, 255, 255);
cc.log(color1.equals(color2)); // true;
color2 = cc.Color.RED;
cc.log(color2.equals(color1)); // false;
```
*/
equals(other: Color): boolean;
/**
!#en TODO
!#zh 线性插值
@param to to
@param ratio the interpolation coefficient.
@param out optional, the receiving vector.
@example
```js
// Converts a white color to a black one trough time.
update: function (dt) {
var color = this.node.color;
if (color.equals(cc.Color.BLACK)) {
return;
}
this.ratio += dt * 0.1;
this.node.color = cc.Color.WHITE.lerp(cc.Color.BLACK, ratio);
}
```
*/
lerp(to: Color, ratio: number, out?: Color): Color;
/**
!#en TODO
!#zh 转换为方便阅读的字符串。
@example
```js
var color = cc.Color.WHITE;
color.toString(); // "rgba(255, 255, 255, 255)"
```
*/
toString(): string;
/**
!#en Gets red channel value
!#zh 获取当前颜色的红色值。
*/
getR(): number;
/**
!#en Sets red value and return the current color object
!#zh 设置当前的红色值，并返回当前对象。
@param red the new Red component.
@example
```js
var color = new cc.Color();
color.setR(255); // Color {r: 255, g: 0, b: 0, a: 255}
```
*/
setR(red: number): Color;
/**
!#en Gets green channel value
!#zh 获取当前颜色的绿色值。
*/
getG(): number;
/**
!#en Sets green value and return the current color object
!#zh 设置当前的绿色值，并返回当前对象。
@param green the new Green component.
@example
```js
var color = new cc.Color();
color.setG(255); // Color {r: 0, g: 255, b: 0, a: 255}
```
*/
setG(green: number): Color;
/**
!#en Gets blue channel value
!#zh 获取当前颜色的蓝色值。
*/
getB(): number;
/**
!#en Sets blue value and return the current color object
!#zh 设置当前的蓝色值，并返回当前对象。
@param blue the new Blue component.
@example
```js
var color = new cc.Color();
color.setB(255); // Color {r: 0, g: 0, b: 255, a: 255}
```
*/
setB(blue: number): Color;
/**
!#en Gets alpha channel value
!#zh 获取当前颜色的透明度值。
*/
getA(): number;
/**
!#en Sets alpha value and return the current color object
!#zh 设置当前的透明度，并返回当前对象。
@param alpha the new Alpha component.
@example
```js
var color = new cc.Color();
color.setA(0); // Color {r: 0, g: 0, b: 0, a: 0}
```
*/
setA(alpha: number): Color;
/**
!#en Convert color to css format.
!#zh 转换为 CSS 格式。
@param opt "rgba", "rgb", "#rgb" or "#rrggbb".
@example
```js
var color = cc.Color.BLACK;
color.toCSS(); // "#000";
color.toCSS("rgba"); // "rgba(0,0,0,1.00)";
color.toCSS("rgb"); // "rgba(0,0,0)";
color.toCSS("#rgb"); // "#000";
color.toCSS("#rrggbb"); // "#000000";
```
*/
toCSS(opt: string): string;
/**
!#en Clamp this color to make all components between 0 to 255。
!#zh 限制颜色数值，在 0 到 255 之间。
@example
```js
var color = new cc.Color(1000, 0, 0, 255);
color.clamp();
cc.log(color); // (255, 0, 0, 255)
```
*/
clamp(): void;
/**
!#en Read hex string and store color data into the current color object, the hex string must be formated as rgba or rgb.
!#zh 读取 16 进制颜色。
@param hexString hexString
@example
```js
var color = cc.Color.BLACK;
color.fromHEX("#FFFF33"); // Color {r: 255, g: 255, b: 51, a: 255};
```
*/
fromHEX(hexString: string): Color;
/**
!#en TODO
!#zh 转换为 16 进制。
@param fmt "#rgb" or "#rrggbb".
@example
```js
var color = cc.Color.BLACK;
color.toHEX("#rgb"); // "000";
color.toHEX("#rrggbb"); // "000000";
```
*/
toHEX(fmt: string): string;
/**
!#en Convert to 24bit rgb value.
!#zh 转换为 24bit 的 RGB 值。
@example
```js
var color = cc.Color.YELLOW;
color.toRGBValue(); // 16771844;
```
*/
toRGBValue(): number;
/**
!#en TODO
!#zh 读取 HSV（色彩模型）格式。
@param h h
@param s s
@param v v
@example
```js
var color = cc.Color.YELLOW;
color.fromHSV(0, 0, 1); // Color {r: 255, g: 255, b: 255, a: 255};
```
*/
fromHSV(h: number, s: number, v: number): Color;
/**
!#en TODO
!#zh 转换为 HSV（色彩模型）格式。
@example
```js
var color = cc.Color.YELLOW;
color.toHSV(); // Object {h: 0.1533864541832669, s: 0.9843137254901961, v: 1};
```
*/
toHSV(): any;
/**
!#en TODO
!#zh RGB 转换为 HSV。
@param r red, must be [0, 255].
@param g red, must be [0, 255].
@param b red, must be [0, 255].
@example
```js
cc.Color.rgb2hsv(255, 255, 255); // Object {h: 0, s: 0, v: 1};
```
*/
static rgb2hsv(r: number, g: number, b: number): any;
/**
!#en TODO
!#zh HSV 转换为 RGB。
@param h h
@param s s
@param v v
@example
```js
cc.Color.hsv2rgb(0, 0, 1); // Object {r: 255, g: 255, b: 255};
```
*/
static hsv2rgb(h: number, s: number, v: number): any;
}
/** !#en A 2D rectangle defined by x, y position and width, height.
!#zh 通过位置和宽高定义的 2D 矩形。 */
export class Rect extends ValueType {
/**
!#en
Constructor of cc.Rect class.
see {{#crossLink "cc/rect:method"}} cc.rect {{/crossLink}} for convenience method.
!#zh
cc.Rect类的构造函数。可以通过 {{#crossLink "cc/rect:method"}} cc.rect {{/crossLink}} 简便方法进行创建。
@param x x
@param y y
@param w w
@param h h
*/
constructor(x?: number, y?: number, w?: number, h?: number);
x: number;
y: number;
width: number;
height: number;
/**
!#en Creates a rectangle from two coordinate values.
!#zh 根据指定 2 个坐标创建出一个矩形区域。
@param v1 v1
@param v2 v2
@example
```js
cc.Rect.fromMinMax(cc.v2(10, 10), cc.v2(20, 20)); // Rect {x: 10, y: 10, width: 10, height: 10};
```
*/
static fromMinMax(v1: Vec2, v2: Vec2): Rect;
/**
!#en Checks if rect contains.
!#zh
判断 2 个矩形是否有包含。
返回 1 为 a 包含 b，如果 -1 为 b 包含 a,
0 这则都不包含。
@param a Rect a
@param b Rect b
@example
```js
var a = new cc.Rect(0, 0, 10, 10);
var b = new cc.Rect(5, 5, 5, 5);
var c = new cc.Rect(20, 20, 10, 10);
cc.Rect.contain(a, b); // 1;
cc.Rect.contain(b, a); // -1;
cc.Rect.contain(a, c); // 0;
```
*/
static contain(a: Rect, b: Rect): number;
/**
!#en TODO
!#zh 克隆一个新的 Rect。
@example
```js
var a = new cc.Rect(0, 0, 10, 10);
a.clone();// Rect {x: 0, y: 0, width: 10, height: 10}
```
*/
clone(): Rect;
/**
!#en TODO
!#zh 是否等于指定的矩形。
@param other other
@example
```js
var a = new cc.Rect(0, 0, 10, 10);
var b = new cc.Rect(0, 0, 10, 10);
a.equals(b);// true;
```
*/
equals(other: Rect): boolean;
/**
!#en TODO
!#zh 线性插值
@param to to
@param ratio the interpolation coefficient.
@param out optional, the receiving vector.
@example
```js
var a = new cc.Rect(0, 0, 10, 10);
var b = new cc.Rect(50, 50, 100, 100);
update (dt) {
// method 1;
var c = a.lerp(b, dt * 0.1);
// method 2;
a.lerp(b, dt * 0.1, c);
}
```
*/
lerp(to: Rect, ratio: number, out?: Rect): Rect;
/**
!#en TODO
!#zh 转换为方便阅读的字符串
@example
```js
var a = new cc.Rect(0, 0, 10, 10);
a.toString();// "(0.00, 0.00, 10.00, 10.00)";
```
*/
toString(): string;
/** !#en TODO
!#zh 矩形 x 轴上的最小值。 */
xMin: number;
/** !#en TODO
!#zh 矩形 y 轴上的最小值。 */
yMin: number;
/** !#en TODO
!#zh 矩形 x 轴上的最大值。 */
xMax: number;
/** !#en TODO
!#zh 矩形 y 轴上的最大值。 */
yMax: number;
/** !#en The position of the center of the rectangle.
!#zh 矩形的中心点。 */
center: Vec2;
/** !#en The X and Y position of the rectangle.
!#zh 矩形的 x 和 y 坐标。 */
origin: Vec2;
/** !#en Width and height of the rectangle.
!#zh 矩形的大小。 */
size: Size;
/**
!#en TODO
!#zh 当前矩形与指定矩形是否相交。
@param rect rect
@example
```js
var a = new cc.Rect(0, 0, 10, 10);
var b = new cc.Rect(0, 0, 20, 20);
a.intersects(b);// true
```
*/
intersects(rect: Rect): void;
/**
!#en TODO
!#zh 当前矩形是否包含指定坐标点。
Returns true if the point inside this rectangle.
@param point point
@example
```js
var a = new cc.Rect(0, 0, 10, 10);
var b = new cc.Vec2(0, 5);
a.contains(b);// true
```
*/
contains(point: Vec2): void;
/**
!#en Returns true if the other rect totally inside this rectangle.
!#zh 当前矩形是否包含指定矩形。
@param rect rect
@example
```js
var a = new cc.Rect(0, 0, 20, 20);
var b = new cc.Rect(0, 0, 10, 10);
a.containsRect(b);// true
```
*/
containsRect(rect: Rect): void;
}
/** !#en
cc.Size is the class for size object,
please do not use its constructor to create sizes,
use {{#crossLink "cc/size:method"}}{{/crossLink}} alias function instead.
It will be deprecated soon, please use cc.Vec2 instead.
!#zh
cc.Size 是 size 对象的类。
请不要使用它的构造函数创建的 size，
使用 {{#crossLink "cc/size:method"}}{{/crossLink}} 别名函数。
它不久将被取消，请使用cc.Vec2代替。 */
export class Size {
/**
@param width width
@param height height
*/
constructor(width: number|Size, height?: number);
width: number;
height: number;
/** !#en return a Size object with width = 0 and height = 0.
!#zh 返回一个宽度为 0 和高度为 0 的 Size 对象。 */
static ZERO: Size;
/**
!#en TODO
!#zh 克隆 size 对象。
@example
```js
var a = new cc.size(10, 10);
a.clone();// return Size {width: 0, height: 0};
```
*/
clone(): Size;
/**
!#en TODO
!#zh 当前 Size 对象是否等于指定 Size 对象。
@param other other
@example
```js
var a = new cc.size(10, 10);
a.equals(new cc.size(10, 10));// return true;
```
*/
equals(other: Size): boolean;
/**
!#en TODO
!#zh 线性插值。
@param to to
@param ratio the interpolation coefficient.
@param out optional, the receiving vector.
@example
```js
var a = new cc.size(10, 10);
var b = new cc.rect(50, 50, 100, 100);
update (dt) {
// method 1;
var c = a.lerp(b, dt * 0.1);
// method 2;
a.lerp(b, dt * 0.1, c);
}
```
*/
lerp(to: Rect, ratio: number, out?: Size): Size;
/**
!#en TODO
!#zh 转换为方便阅读的字符串。
@example
```js
var a = new cc.size(10, 10);
a.toString();// return "(10.00, 10.00)";
```
*/
toString(): string;
}
/** !#en the device accelerometer reports values for each axis in units of g-force.
!#zh 设备重力传感器传递的各个轴的数据。 */
export class Acceleration {
/**
@param x x
@param y y
@param z z
@param timestamp timestamp
*/
constructor(x: number, y: number, z: number, timestamp: number);
}
/** !#en Blend Function used for textures.
!#zh 图像的混合方式。 */
export class BlendFunc {
/**
@param src1 source blend function
@param dst1 destination blend function
*/
constructor(src1: number, dst1: number);
}
/** !#en
Enum for blend factor
Refer to: http://www.andersriggelsen.dk/glblendfunc.php
!#zh
混合因子
可参考: http://www.andersriggelsen.dk/glblendfunc.php */
export enum BlendFactor {
ONE = 0,
ZERO = 0,
SRC_ALPHA = 0,
SRC_COLOR = 0,
DST_ALPHA = 0,
DST_COLOR = 0,
ONE_MINUS_SRC_ALPHA = 0,
ONE_MINUS_SRC_COLOR = 0,
ONE_MINUS_DST_ALPHA = 0,
ONE_MINUS_DST_COLOR = 0,
blendFuncDisable = 0,
}
/** undefined */
export enum TextAlignment {
LEFT = 0,
CENTER = 0,
RIGHT = 0,
}
/** undefined */
export class WebGLColor {
/**
@param r r
@param g g
@param b b
@param a a
@param arrayBuffer arrayBuffer
@param offset offset
*/
constructor(r: number, g: number, b: number, a: number, arrayBuffer: any[], offset: number);
BYTES_PER_ELEMENT: number;
}
/** undefined */
export class Vertex2F {
/**
@param x x
@param y y
@param arrayBuffer arrayBuffer
@param offset offset
*/
constructor(x: number, y: number, arrayBuffer: any[], offset: number);
BYTES_PER_ELEMENT: number;
}
/** undefined */
export class Vertex3F {
/**
@param x x
@param y y
@param z z
@param arrayBuffer arrayBuffer
@param offset offset
*/
constructor(x: number, y: number, z: number, arrayBuffer: any[], offset: number);
BYTES_PER_ELEMENT: number;
}
/** undefined */
export class Tex2F {
/**
@param u u
@param v v
@param arrayBuffer arrayBuffer
@param offset offset
*/
constructor(u: number, v: number, arrayBuffer: any[], offset: number);
BYTES_PER_ELEMENT: number;
}
/** undefined */
export class Quad2 {
/**
@param tl tl
@param tr tr
@param bl bl
@param br br
@param arrayBuffer arrayBuffer
@param offset offset
*/
constructor(tl: Vertex2F, tr: Vertex2F, bl: Vertex2F, br: Vertex2F, arrayBuffer: any[], offset: number);
BYTES_PER_ELEMENT: number;
}
/** A 3D Quad. 4 * 3 floats */
export class Quad3 {
/**
@param bl1 bl1
@param br1 br1
@param tl1 tl1
@param tr1 tr1
@param arrayBuffer arrayBuffer
@param offset offset
*/
constructor(bl1: Vertex3F, br1: Vertex3F, tl1: Vertex3F, tr1: Vertex3F, arrayBuffer: any[], offset: number);
}
/** undefined */
export class V3F_C4B_T2F {
/**
@param vertices vertices
@param colors colors
@param texCoords texCoords
@param arrayBuffer arrayBuffer
@param offset offset
*/
constructor(vertices: Vertex3F, colors: Color, texCoords: Tex2F, arrayBuffer: any[], offset: number);
BYTES_PER_ELEMENT(): void;
}
/** undefined */
export class V3F_C4B_T2F_Quad {
/**
@param tl tl
@param bl bl
@param tr tr
@param br br
@param arrayBuffer arrayBuffer
@param offset offset
*/
constructor(tl: V3F_C4B_T2F, bl: V3F_C4B_T2F, tr: V3F_C4B_T2F, br: V3F_C4B_T2F, arrayBuffer: any[], offset: number);
BYTES_PER_ELEMENT: number;
}
/** undefined */
export class V2F_C4B_T2F {
/**
@param vertices vertices
@param colors colors
@param texCoords texCoords
@param arrayBuffer arrayBuffer
@param offset offset
*/
constructor(vertices: Vertex2F, colors: Color, texCoords: Tex2F, arrayBuffer: any[], offset: number);
BYTES_PER_ELEMENT: number;
}
/** undefined */
export class V2F_C4B_T2F_Triangle {
/**
@param a a
@param b b
@param c c
@param arrayBuffer arrayBuffer
@param offset offset
*/
constructor(a: V2F_C4B_T2F, b: V2F_C4B_T2F, c: V2F_C4B_T2F, arrayBuffer: any[], offset: number);
}
/** !#en The base class of all value types.
!#zh 所有值类型的基类。 */
export class ValueType {
/**
!#en This method returns an exact copy of current value.
!#zh 克隆当前值，该方法返回一个新对象，新对象的值和原对象相等。
*/
clone(): ValueType;
/**
!#en Compares this object with the other one.
!#zh 当前对象是否等于指定对象。
@param other other
*/
equals(other: ValueType): boolean;
/**
!#en
Linearly interpolates between this value to to value by ratio which is in the range [0, 1].
When ratio = 0 returns this. When ratio = 1 return to. When ratio = 0.5 returns the average of this and to.
!#zh
线性插值。
当 ratio = 0 时返回自身，ratio = 1 时返回目标，ratio = 0.5 返回自身和目标的平均值。。
@param to the to value
@param ratio the interpolation coefficient
*/
lerp(to: ValueType, ratio: number): ValueType;
/**
!#en TODO
!#zh 转换为方便阅读的字符串。
*/
toString(): string;
}
/** !#en Representation of 2D vectors and points.
!#zh 表示 2D 向量和坐标 */
export class Vec2 extends ValueType {
/**
!#en
Constructor
see {{#crossLink "cc/vec2:method"}}cc.v2{{/crossLink}} or {{#crossLink "cc/p:method"}}cc.p{{/crossLink}}
!#zh
构造函数，可查看 {{#crossLink "cc/vec2:method"}}cc.v2{{/crossLink}} 或者 {{#crossLink "cc/p:method"}}cc.p{{/crossLink}}
@param x x
@param y y
*/
constructor(x?: number, y?: number);
x: number;
y: number;
/**
!#en clone a Vec2 value
!#zh 克隆一个 Vec2 值
*/
clone(): Vec2;
/**
!#en TODO
!#zh 设置向量值。
@param newValue !#en new value to set. !#zh 要设置的新值
*/
set(newValue: Vec2): Vec2;
/**
!#en TODO
!#zh 当前的向量是否与指定的向量相等。
@param other other
*/
equals(other: Vec2): boolean;
/**
!#en TODO
!#zh 转换为方便阅读的字符串。
*/
toString(): string;
/**
!#en TODO
!#zh 线性插值。
@param to to
@param ratio the interpolation coefficient
@param out optional, the receiving vector
*/
lerp(to: Vec2, ratio: number, out?: Vec2): Vec2;
/**
!#en Adds this vector. If you want to save result to another vector, use add() instead.
!#zh 向量加法。如果你想保存结果到另一个向量，使用 add() 代替。
@param vector vector
@example
```js
var v = cc.v2(10, 10);
v.addSelf(cc.v2(5, 5));// return Vec2 {x: 15, y: 15};
```
*/
addSelf(vector: Vec2): Vec2;
/**
!#en Adds two vectors, and returns the new result.
!#zh 向量加法，并返回新结果。
@param vector vector
@param out optional, the receiving vector
@example
```js
var v = cc.v2(10, 10);
v.add(cc.v2(5, 5)); // return Vec2 {x: 15, y: 15};
var v1;
v.add(cc.v2(5, 5), v1); // return Vec2 {x: 15, y: 15};
```
*/
add(vector: Vec2, out?: Vec2): Vec2;
/**
!#en Subtracts one vector from this. If you want to save result to another vector, use sub() instead.
!#zh 向量减法。如果你想保存结果到另一个向量，可使用 sub() 代替。
@param vector vector
@example
```js
var v = cc.v2(10, 10);
v.subSelf(cc.v2(5, 5));// return Vec2 {x: 5, y: 5};
```
*/
subSelf(vector: Vec2): Vec2;
/**
!#en Subtracts one vector from this, and returns the new result.
!#zh 向量减法，并返回新结果。
@param vector vector
@param out optional, the receiving vector
@example
```js
var v = cc.v2(10, 10);
v.sub(cc.v2(5, 5)); // return Vec2 {x: 5, y: 5};
var v1;
v.sub(cc.v2(5, 5), v1); // return Vec2 {x: 5, y: 5};
```
*/
sub(vector: Vec2, out?: Vec2): Vec2;
/**
!#en Multiplies this by a number. If you want to save result to another vector, use mul() instead.
!#zh 缩放当前向量。如果你想结果保存到另一个向量，可使用 mul() 代替。
@param num num
@example
```js
var v = cc.v2(10, 10);
v.mulSelf(5);// return Vec2 {x: 50, y: 50};
```
*/
mulSelf(num: number): Vec2;
/**
!#en Multiplies by a number, and returns the new result.
!#zh 缩放当前向量，并返回新结果。
@param num num
@param out optional, the receiving vector
@example
```js
var v = cc.v2(10, 10);
v.mul(5); // return Vec2 {x: 50, y: 50};
var v1;
v.mul(5, v1); // return Vec2 {x: 50, y: 50};
```
*/
mul(num: number, out?: Vec2): Vec2;
/**
!#en Multiplies two vectors.
!#zh 分量相乘。
@param vector vector
@example
```js
var v = cc.v2(10, 10);
v.scaleSelf(cc.v2(5, 5));// return Vec2 {x: 50, y: 50};
```
*/
scaleSelf(vector: Vec2): Vec2;
/**
!#en Multiplies two vectors, and returns the new result.
!#zh 分量相乘，并返回新的结果。
@param vector vector
@param out optional, the receiving vector
@example
```js
var v = cc.v2(10, 10);
v.scale(cc.v2(5, 5)); // return Vec2 {x: 50, y: 50};
var v1;
v.scale(cc.v2(5, 5), v1); // return Vec2 {x: 50, y: 50};
```
*/
scale(vector: Vec2, out?: Vec2): Vec2;
/**
!#en Divides by a number. If you want to save result to another vector, use div() instead.
!#zh 向量除法。如果你想结果保存到另一个向量，可使用 div() 代替。
@param vector vector
@example
```js
var v = cc.v2(10, 10);
v.divSelf(5); // return Vec2 {x: 2, y: 2};
```
*/
divSelf(vector: Vec2): Vec2;
/**
!#en Divides by a number, and returns the new result.
!#zh 向量除法，并返回新的结果。
@param vector vector
@param out optional, the receiving vector
@example
```js
var v = cc.v2(10, 10);
v.div(5); // return Vec2 {x: 2, y: 2};
var v1;
v.div(5, v1); // return Vec2 {x: 2, y: 2};
```
*/
div(vector: Vec2, out?: Vec2): Vec2;
/**
!#en Negates the components. If you want to save result to another vector, use neg() instead.
!#zh 向量取反。如果你想结果保存到另一个向量，可使用 neg() 代替。
@example
```js
var v = cc.v2(10, 10);
v.negSelf(); // return Vec2 {x: -10, y: -10};
```
*/
negSelf(): Vec2;
/**
!#en Negates the components, and returns the new result.
!#zh 返回取反后的新向量。
@param out optional, the receiving vector
@example
```js
var v = cc.v2(10, 10);
var v1;
v.neg(v1); // return Vec2 {x: -10, y: -10};
```
*/
neg(out?: Vec2): Vec2;
/**
!#en Dot product
!#zh 当前向量与指定向量进行点乘。
@param vector vector
@example
```js
var v = cc.v2(10, 10);
v.dot(cc.v2(5, 5)); // return 100;
```
*/
dot(vector?: Vec2): number;
/**
!#en Cross product
!#zh 当前向量与指定向量进行叉乘。
@param vector vector
@example
```js
var v = cc.v2(10, 10);
v.cross(cc.v2(5, 5)); // return 0;
```
*/
cross(vector?: Vec2): number;
/**
!#en Returns the length of this vector.
!#zh 返回该向量的长度。
@example
```js
var v = cc.v2(10, 10);
v.mag(); // return 14.142135623730951;
```
*/
mag(): number;
/**
!#en Returns the squared length of this vector.
!#zh 返回该向量的长度平方。
@example
```js
var v = cc.v2(10, 10);
v.magSqr(); // return 200;
```
*/
magSqr(): number;
/**
!#en Make the length of this vector to 1.
!#zh 向量归一化，让这个向量的长度为 1。
@example
```js
var v = cc.v2(10, 10);
v.normalizeSelf(); // return Vec2 {x: 0.7071067811865475, y: 0.7071067811865475};
```
*/
normalizeSelf(): Vec2;
/**
!#en
Returns this vector with a magnitude of 1.
Note that the current vector is unchanged and a new normalized vector is returned. If you want to normalize the current vector, use normalizeSelf function.
!#zh
返回归一化后的向量。
注意，当前向量不变，并返回一个新的归一化向量。如果你想来归一化当前向量，可使用 normalizeSelf 函数。
@param out optional, the receiving vector
*/
normalize(out?: Vec2): Vec2;
/**
!#en Get angle in radian between this and vector.
!#zh 夹角的弧度。
@param vector vector
*/
angle(vector: Vec2): number;
/**
!#en Get angle in radian between this and vector with direction.
!#zh 带方向的夹角的弧度。
@param vector vector
*/
signAngle(vector: Vec2): number;
/**
!#en rotate
!#zh 返回旋转给定弧度后的新向量。
@param radians radians
@param out optional, the receiving vector
*/
rotate(radians: number, out?: Vec2): Vec2;
/**
!#en rotate self
!#zh 按指定弧度旋转向量。
@param radians radians
*/
rotateSelf(radians: number): Vec2;
/** !#en return a Vec2 object with x = 1 and y = 1.
!#zh 新 Vec2 对象。 */
static ONE: Vec2;
/** !#en return a Vec2 object with x = 0 and y = 0.
!#zh 返回 x = 0 和 y = 0 的 Vec2 对象。 */
static ZERO: Vec2;
/** !#en return a Vec2 object with x = 0 and y = 1.
!#zh 返回 x = 0 和 y = 1 的 Vec2 对象。 */
static UP: Vec2;
/** !#en return a Vec2 object with x = 1 and y = 0.
!#zh 返回 x = 1 和 y = 0 的 Vec2 对象。 */
static RIGHT: Vec2;
}
/** undefined */
export class PhysicsBoxCollider extends PhysicsCollider implements Collider.Box {
/** !#en Position offset
!#zh 位置偏移量 */
offset: Vec2;
/** !#en Box size
!#zh 包围盒大小 */
size: Size;
}
/** undefined */
export class PhysicsChainCollider extends PolygonCollider {
/** !#en Whether the chain is loop
!#zh 链条是否首尾相连 */
loop: boolean;
/** !#en Chain points
!#zh 链条顶点数组 */
points: [Vec2];
}
/** undefined */
export class PhysicsCircleCollider extends PhysicsCollider implements Collider.Circle {
/** !#en Position offset
!#zh 位置偏移量 */
offset: Vec2;
/** !#en Circle radius
!#zh 圆形半径 */
radius: number;
}
/** undefined */
export class PhysicsCollider {
/** !#en
The density.
!#zh
密度 */
density: number;
/** !#en
A sensor collider collects contact information but never generates a collision response
!#zh
一个传感器类型的碰撞体会产生碰撞回调，但是不会发生物理碰撞效果。 */
sensor: boolean;
/** !#en
The friction coefficient, usually in the range [0,1].
!#zh
摩擦系数，取值一般在 [0, 1] 之间 */
friction: number;
/** !#en
The restitution (elasticity) usually in the range [0,1].
!#zh
弹性系数，取值一般在 [0, 1]之间 */
restitution: number;
/** !#en
Physics collider will find the rigidbody component on the node and set to this property.
!#zh
碰撞体会在初始化时查找节点上是否存在刚体，如果查找成功则赋值到这个属性上。 */
body: RigidBody;
/**
!#en
Apply current changes to collider, this will regenerate inner box2d fixtures.
!#zh
应用当前 collider 中的修改，调用此函数会重新生成内部 box2d 的夹具。
*/
apply(): void;
/**
!#en
Get the world aabb of the collider
!#zh
获取碰撞体的世界坐标系下的包围盒
*/
getAABB(): void;
}
/** undefined */
export class PhysicsPolygonCollider extends PhysicsCollider implements Collider.Polygon {
/** !#en Position offset
!#zh 位置偏移量 */
offset: Vec2;
/** !#en Polygon points
!#zh 多边形顶点数组 */
points: [Vec2];
}
/** !#en
A distance joint constrains two points on two bodies
to remain at a fixed distance from each other. You can view
this as a massless, rigid rod.
!#zh
距离关节通过一个固定的长度来约束关节链接的两个刚体。你可以将它想象成一个无质量，坚固的木棍。 */
export class DistanceJoint extends Joint {
/** !#en
The distance separating the two ends of the joint.
!#zh
关节两端的距离 */
distance: number;
/** !#en
The spring frequency.
!#zh
弹性系数。 */
frequency: number;
/** !#en
The damping ratio.
!#zh
阻尼，表示关节变形后，恢复到初始状态受到的阻力。 */
0: number;
}
/** !#en
Base class for joints to connect rigidbody.
!#zh
关节类的基类 */
export class Joint extends Component {
/** !#en
The anchor of the rigidbody.
!#zh
刚体的锚点。 */
anchor: Vec2;
/** !#en
The anchor of the connected rigidbody.
!#zh
关节另一端刚体的锚点。 */
connectedAnchor: Vec2;
/** !#en
The rigidbody to which the other end of the joint is attached.
!#zh
关节另一端链接的刚体 */
connectedBody: RigidBody;
/** !#en
Should the two rigid bodies connected with this joint collide with each other?
!#zh
链接到关节上的两个刚体是否应该相互碰撞？ */
collideConnected: boolean;
/**
!#en
Apply current changes to joint, this will regenerate inner box2d joint.
!#zh
应用当前关节中的修改，调用此函数会重新生成内部 box2d 的关节。
*/
apply(): void;
/**
!#en
Get the anchor point on rigidbody in world coordinates.
!#zh
获取刚体世界坐标系下的锚点。
*/
getWorldAnchor(): Vec2;
/**
!#en
Get the anchor point on connected rigidbody in world coordinates.
!#zh
获取链接刚体世界坐标系下的锚点。
*/
getWorldConnectedAnchor(): Vec2;
/**
!#en
Gets the reaction force of the joint.
!#zh
获取关节的反作用力。
@param timeStep The time to calculate the reaction force for.
*/
getReactionForce(timeStep: number): number;
/**
!#en
Gets the reaction torque of the joint.
!#zh
获取关节的反扭矩。
@param timeStep The time to calculate the reaction torque for.
*/
getReactionTorque(timeStep: number): number;
}
/** !#en
A motor joint is used to control the relative motion
between two bodies. A typical usage is to control the movement
of a dynamic body with respect to the ground.
!#zh
马达关节被用来控制两个刚体间的相对运动。
一个典型的例子是用来控制一个动态刚体相对于地面的运动。 */
export class MotorJoint extends Joint {
/** !#en
The anchor of the rigidbody.
!#zh
刚体的锚点。 */
anchor: Vec2;
/** !#en
The anchor of the connected rigidbody.
!#zh
关节另一端刚体的锚点。 */
connectedAnchor: Vec2;
/** !#en
The linear offset from connected rigidbody to rigidbody.
!#zh
关节另一端的刚体相对于起始端刚体的位置偏移量 */
linearOffset: Vec2;
/** !#en
The angular offset from connected rigidbody to rigidbody.
!#zh
关节另一端的刚体相对于起始端刚体的角度偏移量 */
angularOffset: number;
/** !#en
The maximum force can be applied to rigidbody.
!#zh
可以应用于刚体的最大的力值 */
maxForce: number;
/** !#en
The maximum torque can be applied to rigidbody.
!#zh
可以应用于刚体的最大扭矩值 */
maxTorque: number;
/** !#en
The position correction factor in the range [0,1].
!#zh
位置矫正系数，范围为 [0, 1] */
correctionFactor: number;
}
/** !#en
A mouse joint is used to make a point on a body track a
specified world point. This a soft constraint with a maximum
force. This allows the constraint to stretch and without
applying huge forces.
Mouse Joint will auto register the touch event with the mouse region node,
and move the choosed rigidbody in touch move event.
Note : generally mouse joint only used in test bed.
!#zh
鼠标关节用于使刚体上的一个点追踪一个指定的世界坐标系下的位置。
鼠标关节可以指定一个最大的里来施加一个柔和的约束。
鼠标关节会自动使用 mouse region 节点来注册鼠标事件，并且在触摸移动事件中移动选中的刚体。
注意：一般鼠标关节只在测试环境中使用。 */
export class MouseJoint extends Joint {
/** !#en
The anchor of the rigidbody.
!#zh
刚体的锚点。 */
anchor: Vec2;
/** !#en
The anchor of the connected rigidbody.
!#zh
关节另一端刚体的锚点。 */
connectedAnchor: Vec2;
/** !#en
The node used to register touch evnet.
If this is null, it will be the joint's node.
!#zh
用于注册触摸事件的节点。
如果没有设置这个值，那么将会使用关节的节点来注册事件。 */
mouseRegion: Node;
/** !#en
The target point.
The mouse joint will move choosed rigidbody to target point.
!#zh
目标点，鼠标关节将会移动选中的刚体到指定的目标点 */
target: Vec2;
/** !#en
The spring frequency.
!#zh
弹簧系数。 */
frequency: number;
/** !#en
The damping ratio.
!#zh
阻尼，表示关节变形后，恢复到初始状态受到的阻力。 */
0: number;
/** !#en
The maximum force
!#zh
最大阻力值 */
maxForce: number;
}
/** !#en
A prismatic joint. This joint provides one degree of freedom: translation
along an axis fixed in rigidbody. Relative rotation is prevented. You can
use a joint limit to restrict the range of motion and a joint motor to
drive the motion or to model joint friction.
!#zh
移动关节指定了只能在一个方向上移动刚体。
你可以开启关节限制来设置刚体运行移动的间距，也可以开启马达来使用关节马达驱动刚体的运行。 */
export class PrismaticJoint extends Joint {
/** !#en
The local joint axis relative to rigidbody.
!#zh
指定刚体可以移动的方向。 */
localAxisA: Vec2;
/** !#en
The reference angle.
!#zh
相对角度 */
referenceAngle: number;
/** !#en
Enable joint distance limit?
!#zh
是否开启关节的距离限制？ */
enableLimit: boolean;
/** !#en
Enable joint motor?
!#zh
是否开启关节马达？ */
enableMotor: boolean;
/** !#en
The lower joint limit.
!#zh
刚体能够移动的最小值 */
lowerLimit: number;
/** !#en
The upper joint limit.
!#zh
刚体能够移动的最大值 */
upperLimit: number;
/** !#en
The maxium force can be applied to rigidbody to rearch the target motor speed.
!#zh
可以施加到刚体的最大力。 */
maxMotorForce: number;
/** !#en
The expected motor speed.
!#zh
期望的马达速度。 */
motorSpeed: number;
}
/** !#en
A revolute joint constrains two bodies to share a common point while they
are free to rotate about the point. The relative rotation about the shared
point is the joint angle. You can limit the relative rotation with
a joint limit that specifies a lower and upper angle. You can use a motor
to drive the relative rotation about the shared point. A maximum motor torque
is provided so that infinite forces are not generated.
!#zh
旋转关节可以约束两个刚体围绕一个点来进行旋转。
你可以通过开启关节限制来限制旋转的最大角度和最小角度。
你可以通过开启马达来施加一个扭矩力来驱动这两个刚体在这一点上的相对速度。 */
export class RevoluteJoint extends Joint {
/** !#en
The reference angle.
An angle between bodies considered to be zero for the joint angle.
!#zh
相对角度。
两个物体之间角度为零时可以看作相等于关节角度 */
referenceAngle: number;
/** !#en
The lower angle.
!#zh
角度的最低限制。 */
lowerAngle: number;
/** !#en
The upper angle.
!#zh
角度的最高限制。 */
upperAngle: number;
/** !#en
The maxium torque can be applied to rigidbody to rearch the target motor speed.
!#zh
可以施加到刚体的最大扭矩。 */
maxMotorTorque: number;
/** !#en
The expected motor speed.
!#zh
期望的马达速度。 */
motorSpeed: number;
/** !#en
Enable joint limit?
!#zh
是否开启关节的限制？ */
enableLimit: boolean;
/** !#en
Enable joint motor?
!#zh
是否开启关节马达？ */
enableMotor: boolean;
/**
!#en
Get the joint angle.
!#zh
获取关节角度。
*/
getJointAngle(): number;
}
/** !#en
A rope joint enforces a maximum distance between two points
on two bodies. It has no other effect.
Warning: if you attempt to change the maximum length during
the simulation you will get some non-physical behavior.
!#zh
绳子关节只指定两个刚体间的最大距离，没有其他的效果。
注意：如果你试图动态修改关节的长度，这有可能会得到一些意外的效果。 */
export class RopeJoint extends Joint {
/** !#en
The max length.
!#zh
最大长度。 */
maxLength: number;
}
/** !#en
A weld joint essentially glues two bodies together. A weld joint may
distort somewhat because the island constraint solver is approximate.
!#zh
熔接关节相当于将两个刚体粘在了一起。
熔接关节可能会使某些东西失真，因为约束求解器算出的都是近似值。 */
export class WeldJoint extends Joint {
/** !#en
The reference angle.
!#zh
相对角度。 */
referenceAngle: number;
/** !#en
The frequency.
!#zh
弹性系数。 */
frequency: number;
/** !#en
The damping ratio.
!#zh
阻尼，表示关节变形后，恢复到初始状态受到的阻力。 */
0: number;
}
/** !#en
A wheel joint. This joint provides two degrees of freedom: translation
along an axis fixed in bodyA and rotation in the plane. You can use a joint motor to drive
the rotation or to model rotational friction.
This joint is designed for vehicle suspensions.
!#zh
轮子关节提供两个维度的自由度：旋转和沿着指定方向上位置的移动。
你可以通过开启关节马达来使用马达驱动刚体的旋转。
轮组关节是专门为机动车类型设计的。 */
export class WheelJoint extends Joint {
/** !#en
The local joint axis relative to rigidbody.
!#zh
指定刚体可以移动的方向。 */
localAxisA: Vec2;
/** !#en
The maxium torque can be applied to rigidbody to rearch the target motor speed.
!#zh
可以施加到刚体的最大扭矩。 */
maxMotorTorque: number;
/** !#en
The expected motor speed.
!#zh
期望的马达速度。 */
motorSpeed: number;
/** !#en
Enable joint motor?
!#zh
是否开启关节马达？ */
enableMotor: boolean;
/** !#en
The spring frequency.
!#zh
弹性系数。 */
frequency: number;
/** !#en
The damping ratio.
!#zh
阻尼，表示关节变形后，恢复到初始状态受到的阻力。 */
dampingRatio: number;
}
/****************************************************
* audioEngine
*****************************************************/
export module audioEngine {
/** !#en Audio state.
!#zh 声音播放状态 */
export enum AudioState {
ERROR = 0,
INITIALZING = 0,
PLAYING = 0,
PAUSED = 0,
}
}
/****************************************************
* ParticleSystem
*****************************************************/
export module ParticleSystem {
/** !#en Enum for emitter modes
!#zh 发射模式 */
export enum EmitterMode {
GRAVITY = 0,
RADIUS = 0,
}
}
/****************************************************
* ParticleSystem
*****************************************************/
export module ParticleSystem {
/** !#en Enum for particles movement type.
!#zh 粒子位置类型 */
export enum PositionType {
FREE = 0,
RELATIVE = 0,
GROUPED = 0,
}
}
/****************************************************
* Node
*****************************************************/
export module Node {
/** !#en The event type supported by Node
!#zh Node 支持的事件类型 */
export class EventType {
/** !#en The event type for touch start event, you can use its value directly: 'touchstart'
!#zh 当手指触摸到屏幕时。 */
static TOUCH_START: string;
/** !#en The event type for touch move event, you can use its value directly: 'touchmove'
!#zh 当手指在屏幕上目标节点区域内移动时。 */
static TOUCH_MOVE: string;
/** !#en The event type for touch end event, you can use its value directly: 'touchend'
!#zh 当手指在目标节点区域内离开屏幕时。 */
static TOUCH_END: string;
/** !#en The event type for touch end event, you can use its value directly: 'touchcancel'
!#zh 当手指在目标节点区域外离开屏幕时。 */
static TOUCH_CANCEL: string;
/** !#en The event type for mouse down events, you can use its value directly: 'mousedown'
!#zh 当鼠标按下时触发一次。 */
static MOUSE_DOWN: string;
/** !#en The event type for mouse move events, you can use its value directly: 'mousemove'
!#zh 当鼠标在目标节点在目标节点区域中移动时，不论是否按下。 */
static MOUSE_MOVE: string;
/** !#en The event type for mouse enter target events, you can use its value directly: 'mouseenter'
!#zh 当鼠标移入目标节点区域时，不论是否按下。 */
static MOUSE_ENTER: string;
/** !#en The event type for mouse leave target events, you can use its value directly: 'mouseleave'
!#zh 当鼠标移出目标节点区域时，不论是否按下。 */
static MOUSE_LEAVE: string;
/** !#en The event type for mouse up events, you can use its value directly: 'mouseup'
!#zh 当鼠标从按下状态松开时触发一次。 */
static MOUSE_UP: string;
/** !#en The event type for mouse wheel events, you can use its value directly: 'mousewheel'
!#zh 当鼠标滚轮滚动时。 */
static MOUSE_WHEEL: string;
}
}
/****************************************************
* TiledMap
*****************************************************/
export module TiledMap {
/** !#en The orientation of tiled map.
!#zh Tiled Map 地图方向。 */
export enum Orientation {
ORTHO = 0,
HEX = 0,
ISO = 0,
NONE = 0,
MAP = 0,
LAYER = 0,
OBJECTGROUP = 0,
OBJECT = 0,
TILE = 0,
HORIZONTAL = 0,
VERTICAL = 0,
DIAGONAL = 0,
FLIPPED_ALL = 0,
FLIPPED_MASK = 0,
STAGGERAXIS_X = 0,
STAGGERAXIS_Y = 0,
STAGGERINDEX_ODD = 0,
STAGGERINDEX_EVEN = 0,
}
}
/****************************************************
* Collider
*****************************************************/
export module Collider {
/** !#en Defines a Box Collider .
!#zh 用来定义包围盒碰撞体 */
export class Box {
/** !#en Position offset
!#zh 位置偏移量 */
offset: Vec2;
/** !#en Box size
!#zh 包围盒大小 */
size: Size;
}
}
/****************************************************
* Collider
*****************************************************/
export module Collider {
/** !#en Defines a Circle Collider .
!#zh 用来定义圆形碰撞体 */
export class Circle {
/** !#en Position offset
!#zh 位置偏移量 */
offset: Vec2;
/** !#en Circle radius
!#zh 圆形半径 */
radius: number;
}
}
/****************************************************
* Collider
*****************************************************/
export module Collider {
/** !#en Defines a Polygon Collider .
!#zh 用来定义多边形碰撞体 */
export class Polygon {
/** !#en Position offset
!#zh 位置偏移量 */
offset: Vec2;
/** !#en Polygon points
!#zh 多边形顶点数组 */
points: [Vec2];
}
}
/****************************************************
* Button
*****************************************************/
export module Button {
/** !#en Enum for transition type.
!#zh 过渡类型 */
export enum Transition {
NONE = 0,
COLOR = 0,
SPRITE = 0,
SCALE = 0,
}
}
/****************************************************
* Component
*****************************************************/
export module Component {
/** !#en
Component will register a event to target component's handler.
And it will trigger the handler when a certain event occurs.
!@zh
“EventHandler” 类用来设置场景中的事件回调，
该类允许用户设置回调目标节点，目标组件名，组件方法名，
并可通过 emit 方法调用目标函数。 */
export class EventHandler {
/** !#en Event target
!#zh 目标节点 */
target: Node;
/** !#en Component name
!#zh 目标组件名 */
component: string;
/** !#en Event handler
!#zh 响应事件函数名 */
handler: string;
/** !#en Custom Event Data
!#zh 自定义事件数据 */
customEventData: string;
/**
@param events events
@param params params
*/
static emitEvents(events: Component.EventHandler[], ...params: any[]): void;
/**
!#en Emit event with params
!#zh 触发目标组件上的指定 handler 函数，该参数是回调函数的参数值（可不填）。
@param params params
@example
```js
// Call Function
var eventHandler = new cc.Component.EventHandler();
eventHandler.target = newTarget;
eventHandler.component = "MainMenu";
eventHandler.handler = "OnClick"
eventHandler.emit(["param1", "param2", ....]);
```
*/
emit(params: any[]): void;
}
}
/****************************************************
* EditBox
*****************************************************/
export module EditBox {
/** !#en Enum for keyboard return types
!#zh 键盘的返回键类型 */
export enum KeyboardReturnType {
DEFAULT = 0,
DONE = 0,
SEND = 0,
SEARCH = 0,
GO = 0,
}
}
/****************************************************
* EditBox
*****************************************************/
export module EditBox {
/** !#en The EditBox's InputMode defines the type of text that the user is allowed to enter.
!#zh 输入模式 */
export enum InputMode {
ANY = 0,
EMAIL_ADDR = 0,
NUMERIC = 0,
PHONE_NUMBER = 0,
URL = 0,
DECIMAL = 0,
SINGLE_LINE = 0,
}
}
/****************************************************
* EditBox
*****************************************************/
export module EditBox {
/** !#en Enum for the EditBox's input flags
!#zh 定义了一些用于设置文本显示和文本格式化的标志位。 */
export enum InputFlag {
PASSWORD = 0,
SENSITIVE = 0,
INITIAL_CAPS_WORD = 0,
INITIAL_CAPS_SENTENCE = 0,
INITIAL_CAPS_ALL_CHARACTERS = 0,
}
}
/****************************************************
* Label
*****************************************************/
export module Label {
/** !#en Enum for text alignment.
!#zh 文本横向对齐类型 */
export enum HorizontalAlign {
LEFT = 0,
CENTER = 0,
RIGHT = 0,
}
}
/****************************************************
* Label
*****************************************************/
export module Label {
/** !#en Enum for vertical text alignment.
!#zh 文本垂直对齐类型 */
export enum VerticalAlign {
TOP = 0,
CENTER = 0,
BOTTOM = 0,
}
}
/****************************************************
* Label
*****************************************************/
export module Label {
/** !#en Enum for Overflow.
!#zh Overflow 类型 */
export enum Overflow {
NONE = 0,
CLAMP = 0,
SHRINK = 0,
RESIZE_HEIGHT = 0,
}
}
/****************************************************
* Label
*****************************************************/
export module Label {
/** !#en Enum for font type.
!#zh Type 类型 */
export enum Type {
TTF = 0,
BMFont = 0,
SystemFont = 0,
}
}
/****************************************************
* Layout
*****************************************************/
export module Layout {
/** !#en Enum for Layout type
!#zh 布局类型 */
export enum Type {
NONE = 0,
HORIZONTAL = 0,
VERTICAL = 0,
GRID = 0,
}
}
/****************************************************
* Layout
*****************************************************/
export module Layout {
/** !#en Enum for Layout Resize Mode
!#zh 缩放模式 */
export enum ResizeMode {
NONE = 0,
CONTAINER = 0,
CHILDREN = 0,
}
}
/****************************************************
* Layout
*****************************************************/
export module Layout {
/** !#en Enum for Grid Layout start axis direction.
The items in grid layout will be arranged in each axis at first.;
!#zh 布局轴向，只用于 GRID 布局。 */
export enum AxisDirection {
HORIZONTAL = 0,
VERTICAL = 0,
}
}
/****************************************************
* Layout
*****************************************************/
export module Layout {
/** !#en Enum for vertical layout direction.
Used in Grid Layout together with AxisDirection is VERTICAL
!#zh 垂直方向布局方式 */
export enum VerticalDirection {
BOTTOM_TO_TOP = 0,
TOP_TO_BOTTOM = 0,
}
}
/****************************************************
* Layout
*****************************************************/
export module Layout {
/** !#en Enum for horizontal layout direction.
Used in Grid Layout together with AxisDirection is HORIZONTAL
!#zh 水平方向布局方式 */
export enum HorizontalDirection {
LEFT_TO_RIGHT = 0,
RIGHT_TO_LEFT = 0,
}
}
/****************************************************
* Mask
*****************************************************/
export module Mask {
/** !#en the type for mask.
!#zh 遮罩组件类型 */
export enum Type {
RECT = 0,
ELLIPSE = 0,
IMAGE_STENCIL = 0,
}
}
/****************************************************
* PageView
*****************************************************/
export module PageView {
/** !#en The Page View Size Mode
!#zh 页面视图每个页面统一的大小类型 */
export enum SizeMode {
Unified = 0,
Free = 0,
}
}
/****************************************************
* PageView
*****************************************************/
export module PageView {
/** !#en The Page View Direction
!#zh 页面视图滚动类型 */
export enum Direction {
Horizontal = 0,
Vertical = 0,
}
}
/****************************************************
* PageView
*****************************************************/
export module PageView {
/** !#en Enum for ScrollView event type.
!#zh 滚动视图事件类型 */
export enum EventType {
PAGE_TURNING = 0,
}
}
/****************************************************
* PageViewIndicator
*****************************************************/
export module PageViewIndicator {
/** !#en Enum for PageView Indicator direction
!#zh 页面视图指示器的摆放方向 */
export enum Direction {
HORIZONTAL = 0,
VERTICAL = 0,
}
}
/****************************************************
* ProgressBar
*****************************************************/
export module ProgressBar {
/** !#en Enum for ProgressBar mode
!#zh 进度条模式 */
export enum Mode {
HORIZONTAL = 0,
VERTICAL = 0,
FILLED = 0,
}
}
/****************************************************
* Scrollbar
*****************************************************/
export module Scrollbar {
/** Enum for Scrollbar direction */
export enum Direction {
HORIZONTAL = 0,
VERTICAL = 0,
}
}
/****************************************************
* ScrollView
*****************************************************/
export module ScrollView {
/** !#en Enum for ScrollView event type.
!#zh 滚动视图事件类型 */
export enum EventType {
SCROLL_TO_TOP = 0,
SCROLL_TO_BOTTOM = 0,
SCROLL_TO_LEFT = 0,
SCROLL_TO_RIGHT = 0,
SCROLLING = 0,
BOUNCE_TOP = 0,
BOUNCE_BOTTOM = 0,
BOUNCE_LEFT = 0,
BOUNCE_RIGHT = 0,
SCROLL_ENDED = 0,
TOUCH_UP = 0,
AUTOSCROLL_ENDED_WITH_THRESHOLD = 0,
SCROLL_BEGAN = 0,
}
}
/****************************************************
* Slider
*****************************************************/
export module Slider {
/** !#en The Slider Direction
!#zh 滑动器方向 */
export enum Direction {
Horizontal = 0,
Vertical = 0,
}
}
/****************************************************
* Sprite
*****************************************************/
export module Sprite {
/** !#en Enum for sprite type.
!#zh Sprite 类型 */
export enum Type {
SIMPLE = 0,
SLICED = 0,
TILED = 0,
FILLED = 0,
}
}
/****************************************************
* Sprite
*****************************************************/
export module Sprite {
/** !#en Enum for fill type.
!#zh 填充类型 */
export enum FillType {
HORIZONTAL = 0,
VERTICAL = 0,
RADIAL = 0,
}
}
/****************************************************
* Sprite
*****************************************************/
export module Sprite {
/** !#en Sprite Size can track trimmed size, raw size or none.
!#zh 精灵尺寸调整模式 */
export enum SizeMode {
CUSTOM = 0,
TRIMMED = 0,
RAW = 0,
}
}
/****************************************************
* VideoPlayer
*****************************************************/
export module VideoPlayer {
/** !#en Video event type
!#zh 视频事件类型 */
export enum EventType {
PLAYING = 0,
PAUSED = 0,
STOPPED = 0,
COMPLETED = 0,
META_LOADED = 0,
CLICKED = 0,
READY_TO_PLAY = 0,
}
}
/****************************************************
* VideoPlayer
*****************************************************/
export module VideoPlayer {
/** !#en Enum for video resouce type type.
!#zh 视频来源 */
export enum ResourceType {
REMOTE = 0,
LOCAL = 0,
}
}
/****************************************************
* WebView
*****************************************************/
export module WebView {
/** !#en WebView event type
!#zh 网页视图事件类型 */
export enum EventType {
LOADED = 0,
LOADING = 0,
ERROR = 0,
}
}
/****************************************************
* Event
*****************************************************/
export module Event {
/** !#en The Custom event
!#zh 自定义事件 */
export class EventCustom extends Event {
/**
@param type The name of the event (case-sensitive), e.g. "click", "fire", or "submit"
@param bubbles A boolean indicating whether the event bubbles up through the tree or not
*/
constructor(type: string, bubbles: boolean);
/** !#en A reference to the detailed data of the event
!#zh 事件的详细数据 */
detail: any;
/**
!#en Sets user data
!#zh 设置用户数据
@param data data
*/
setUserData(data: any): void;
/**
!#en Gets user data
!#zh 获取用户数据
*/
getUserData(): any;
/**
!#en Gets event name
!#zh 获取事件名称
*/
getEventName(): string;
/** !#en
The keyCode read-only property represents a system and implementation dependent numerical code identifying the unmodified value of the pressed key.
This is usually the decimal ASCII (RFC 20) or Windows 1252 code corresponding to the key.
If the key can't be identified, this value is 0.
!#zh
keyCode 是只读属性它表示一个系统和依赖于实现的数字代码，可以识别按键的未修改值。
这通常是十进制 ASCII (RFC20) 或者 Windows 1252 代码，所对应的密钥。
如果无法识别该键，则该值为 0。 */
keyCode: number;
}
}
/****************************************************
* SystemEvent
*****************************************************/
export module SystemEvent {
/** !#en The event type supported by SystemEvent
!#zh SystemEvent 支持的事件类型 */
export class EventType {
/** !#en The event type for press the key down event, you can use its value directly: 'keydown'
!#zh 当按下按键时触发的事件 */
static KEY_DOWN: string;
/** !#en The event type for press the key up event, you can use its value directly: 'keyup'
!#zh 当松开按键时触发的事件 */
static KEY_UP: string;
/** !#en The event type for press the devicemotion event, you can use its value directly: 'devicemotion'
!#zh 重力感应 */
static DEVICEMOTION: string;
}
}
/****************************************************
* Graphics
*****************************************************/
export module Graphics {
/** !#en Enum for LineCap.
!#zh 线段末端属性 */
export enum LineCap {
BUTT = 0,
ROUND = 0,
SQUARE = 0,
}
}
/****************************************************
* Graphics
*****************************************************/
export module Graphics {
/** !#en Enum for LineJoin.
!#zh 线段拐角属性 */
export enum LineJoin {
BEVEL = 0,
ROUND = 0,
MITER = 0,
}
}
/****************************************************
* Event
*****************************************************/
export module Event {
/** !#en The mouse event
!#zh 鼠标事件类型 */
export class EventMouse extends Event {
/**
!#en Sets scroll data.
!#zh 设置鼠标的滚动数据。
@param scrollX scrollX
@param scrollY scrollY
*/
setScrollData(scrollX: number, scrollY: number): void;
/**
!#en Returns the x axis scroll value.
!#zh 获取鼠标滚动的X轴距离，只有滚动时才有效。
*/
getScrollX(): number;
/**
!#en Returns the y axis scroll value.
!#zh 获取滚轮滚动的 Y 轴距离，只有滚动时才有效。
*/
getScrollY(): number;
/**
!#en Sets cursor location.
!#zh 设置当前鼠标位置。
@param x x
@param y y
*/
setLocation(x: number, y: number): void;
/**
!#en Returns cursor location.
!#zh 获取鼠标位置对象，对象包含 x 和 y 属性。
*/
getLocation(): Vec2;
/**
!#en Returns the current cursor location in screen coordinates.
!#zh 获取当前事件在游戏窗口内的坐标位置对象，对象包含 x 和 y 属性。
*/
getLocationInView(): Vec2;
/**
!#en Returns the previous touch location.
!#zh 获取鼠标点击在上一次事件时的位置对象，对象包含 x 和 y 属性。
*/
getPreviousLocation(): Vec2;
/**
!#en Returns the delta distance from the previous location to current location.
!#zh 获取鼠标距离上一次事件移动的距离对象，对象包含 x 和 y 属性。
*/
getDelta(): Vec2;
/**
!#en Returns the X axis delta distance from the previous location to current location.
!#zh 获取鼠标距离上一次事件移动的 X 轴距离。
*/
getDeltaX(): number;
/**
!#en Returns the Y axis delta distance from the previous location to current location.
!#zh 获取鼠标距离上一次事件移动的 Y 轴距离。
*/
getDeltaY(): number;
/**
!#en Sets mouse button.
!#zh 设置鼠标按键。
@param button button
*/
setButton(button: number): void;
/**
!#en Returns mouse button.
!#zh 获取鼠标按键。
*/
getButton(): number;
/**
!#en Returns location X axis data.
!#zh 获取鼠标当前位置 X 轴。
*/
getLocationX(): number;
/**
!#en Returns location Y axis data.
!#zh 获取鼠标当前位置 Y 轴。
*/
getLocationY(): number;
/** !#en The none event code of mouse event.
!#zh 无。 */
static NONE: number;
/** !#en The event type code of mouse down event.
!#zh 鼠标按下事件。 */
static DOWN: number;
/** !#en The event type code of mouse up event.
!#zh 鼠标按下后释放事件。 */
static UP: number;
/** !#en The event type code of mouse move event.
!#zh 鼠标移动事件。 */
static MOVE: number;
/** !#en The event type code of mouse scroll event.
!#zh 鼠标滚轮事件。 */
static SCROLL: number;
/** !#en The tag of Mouse left button.
!#zh 鼠标左键的标签。 */
static BUTTON_LEFT: number;
/** !#en The tag of Mouse right button (The right button number is 2 on browser).
!#zh 鼠标右键的标签。 */
static BUTTON_RIGHT: number;
/** !#en The tag of Mouse middle button (The right button number is 1 on browser).
!#zh 鼠标中键的标签。 */
static BUTTON_MIDDLE: number;
/** !#en The tag of Mouse button 4.
!#zh 鼠标按键 4 的标签。 */
static BUTTON_4: number;
/** !#en The tag of Mouse button 5.
!#zh 鼠标按键 5 的标签。 */
static BUTTON_5: number;
/** !#en The tag of Mouse button 6.
!#zh 鼠标按键 6 的标签。 */
static BUTTON_6: number;
/** !#en The tag of Mouse button 7.
!#zh 鼠标按键 7 的标签。 */
static BUTTON_7: number;
/** !#en The tag of Mouse button 8.
!#zh 鼠标按键 8 的标签。 */
static BUTTON_8: number;
}
}
/****************************************************
* Event
*****************************************************/
export module Event {
/** !#en The touch event
!#zh 触摸事件 */
export class EventTouch extends Event {
/**
@param touchArr The array of the touches
@param bubbles A boolean indicating whether the event bubbles up through the tree or not
*/
constructor(touchArr: any[], bubbles: boolean);
/** !#en The current touch object
!#zh 当前触点对象 */
touch: Touch;
/**
!#en Returns event code.
!#zh 获取事件类型。
*/
getEventCode(): number;
/**
!#en Returns touches of event.
!#zh 获取触摸点的列表。
*/
getTouches(): any[];
/**
!#en Sets touch location.
!#zh 设置当前触点位置
@param x x
@param y y
*/
setLocation(x: number, y: number): void;
/**
!#en Returns touch location.
!#zh 获取触点位置。
*/
getLocation(): Vec2;
/**
!#en Returns the current touch location in screen coordinates.
!#zh 获取当前触点在游戏窗口中的位置。
*/
getLocationInView(): Vec2;
/**
!#en Returns the previous touch location.
!#zh 获取触点在上一次事件时的位置对象，对象包含 x 和 y 属性。
*/
getPreviousLocation(): Vec2;
/**
!#en Returns the start touch location.
!#zh 获获取触点落下时的位置对象，对象包含 x 和 y 属性。
*/
getStartLocation(): Vec2;
/**
!#en Returns the id of cc.Touch.
!#zh 触点的标识 ID，可以用来在多点触摸中跟踪触点。
*/
getID(): number;
/**
!#en Returns the delta distance from the previous location to current location.
!#zh 获取触点距离上一次事件移动的距离对象，对象包含 x 和 y 属性。
*/
getDelta(): Vec2;
/**
!#en Returns the X axis delta distance from the previous location to current location.
!#zh 获取触点距离上一次事件移动的 x 轴距离。
*/
getDeltaX(): number;
/**
!#en Returns the Y axis delta distance from the previous location to current location.
!#zh 获取触点距离上一次事件移动的 y 轴距离。
*/
getDeltaY(): number;
/**
!#en Returns location X axis data.
!#zh 获取当前触点 X 轴位置。
*/
getLocationX(): number;
/**
!#en Returns location Y axis data.
!#zh 获取当前触点 Y 轴位置。
*/
getLocationY(): number;
}
}
/****************************************************
* Event
*****************************************************/
export module Event {
/** !#en The acceleration event
!#zh 加速度事件 */
export class EventAcceleration extends Event {
}
}
/****************************************************
* Event
*****************************************************/
export module Event {
/** !#en The keyboard event
!#zh 键盘事件 */
export class EventKeyboard extends Event {
}
}
/****************************************************
* Pipeline
*****************************************************/
export module Pipeline {
/** The downloader pipe, it can download several types of files:
1. Text
2. Image
3. Script
4. Audio
5. Assets
All unknown type will be downloaded as plain text.
You can pass custom supported types in the constructor. */
export class Downloader {
/**
Constructor of Downloader, you can pass custom supported types.
@param extMap Custom supported types with corresponded handler
@example
```js
var downloader = new Downloader({
// This will match all url with `.scene` extension or all url with `scene` type
'scene' : function (url, callback) {}
});
```
*/
constructor(extMap: any);
/**
Add custom supported types handler or modify existing type handler.
@param extMap Custom supported types with corresponded handler
*/
addHandlers(extMap: any): void;
}
}
/****************************************************
* Pipeline
*****************************************************/
export module Pipeline {
/** The loader pipe, it can load several types of files:
1. Images
2. JSON
3. Plist
4. Audio
5. Font
6. Cocos Creator scene
It will not interfere with items of unknown type.
You can pass custom supported types in the constructor. */
export class Loader {
/**
Constructor of Loader, you can pass custom supported types.
@param extMap Custom supported types with corresponded handler
@example
```js
var loader = new Loader({
// This will match all url with `.scene` extension or all url with `scene` type
'scene' : function (url, callback) {}
});
```
*/
constructor(extMap: any);
/**
Add custom supported types handler or modify existing type handler.
@param extMap Custom supported types with corresponded handler
*/
addHandlers(extMap: any): void;
}
}
/****************************************************
* LoadingItems
*****************************************************/
export module LoadingItems {
/** !#en The item states of the LoadingItems, its value could be LoadingItems.ItemState.WORKING | LoadingItems.ItemState.COMPLETET | LoadingItems.ItemState.ERROR
!#zh LoadingItems 队列中的加载项状态，状态的值可能是 LoadingItems.ItemState.WORKING | LoadingItems.ItemState.COMPLETET | LoadingItems.ItemState.ERROR */
export enum ItemState {
WORKING = 0,
COMPLETET = 0,
ERROR = 0,
}
}
/****************************************************
* Texture2D
*****************************************************/
export module Texture2D {
/** The texture pixel format, default value is RGBA8888 */
export enum PixelFormat {
RGB565 = 0,
RGB5A1 = 0,
RGBA4444 = 0,
RGB888 = 0,
RGBA8888 = 0,
A8 = 0,
I8 = 0,
AI88 = 0,
}
}
/****************************************************
* Texture2D
*****************************************************/
export module Texture2D {
/** The texture wrap mode */
export enum WrapMode {
REPEAT = 0,
CLAMP_TO_EDGE = 0,
MIRRORED_REPEAT = 0,
}
}
/****************************************************
* Texture2D
*****************************************************/
export module Texture2D {
/** The texture filter mode */
export enum Filter {
LINEAR = 0,
NEAREST = 0,
}
}
}
/** !#en
AnySDK is a third party solution that offers game developers SDK integration without making changes to the SDK's features or parameters.It can do all of this while remaining invisible to your end user.Our goal is to handle all the tedious SDK integration work for you so that you can use your time to focus on the game itself.No matter if it’s the channel SDK, user system, payment system, ad system, statistics system, sharing system or any other type of SDK: we’ll take care of it for you.
!#zh
AnySDK 为 CP 提供一套第三方 SDK 接入解决方案，整个接入过程，不改变任何 SDK 的功能、特性、参数等，对于最终玩家而言是完全透明无感知的。
目的是让 CP 商能有更多时间更专注于游戏本身的品质，所有 SDK 的接入工作统统交给我们吧。第三方 SDK 包括了渠道SDK、用户系统、支付系统、广告系统、统计系统、分享系统等等。 */
declare module anysdk {
/** !#en
agent manager of plugin
!#zh
插件管理对象 */
export var agentManager: anysdk.AgentManager;
/** !#en
agent manager of plugin
!#zh
插件管理类 */
export class AgentManager {
/**
!#en
AppKey appSecret and privateKey are the only three parameters generated
after the packing tool client finishes creating the game.
The oauthLoginServer parameter is the API address provided by the game service
to login verification
!#zh
appKey、appSecret、privateKey是通过 AnySDK 客户端工具创建游戏后生成的。
oauthLoginServer参数是游戏服务提供的用来做登陆验证转发的接口地址。
@param appKey appKey
@param appSecret appSecret
@param privateKey privateKey
@param oauthLoginServer oauthLoginServer
*/
init(appKey: string, appSecret: string, privateKey: string, oauthLoginServer: string): void;
/**
!#en
load all plugins, the operation includes SDK`s initialization
!#zh
加载所有插件，该操作包含了 SDKs 初始化
@param callback callback
@param target The object to bind to.
*/
loadAllPlugins(callback: Function, target: any): void;
/**
!#en
unload all plugins
!#zh
卸载插件
*/
unloadAllPlugins(): void;
/**
!#en
get user system plugin
!#zh
获取用户系统插件
*/
getUserPlugin(): anysdk.ProtocolUser;
/**
!#en
get IAP system plugins
!#zh
获取支付系统插件
*/
getIAPPlugins(): anysdk.ProtocolIAP[];
/**
!#en
get IAP system plugin
!#zh
获取支付系统插件
*/
getIAPPlugin(): anysdk.ProtocolIAP;
/**
!#en
get social system plugin
!#zh
获取社交系统插件
*/
getSocialPlugin(): anysdk.ProtocolSocial;
/**
!#en
get share system plugin
!#zh
获取分享系统插件
*/
getSharePlugin(): anysdk.ProtocolShare;
/**
!#en
get analytics system plugin
!#zh
获取统计系统插件
*/
getAnalyticsPlugin(): anysdk.ProtocolAnalytics;
/**
!#en
get ads system plugin
!#zh
获取广告系统插件
*/
getAdsPlugin(): anysdk.ProtocolAds;
/**
!#en
get push system plugin
!#zh
获取推送系统插件
*/
getPushPlugin(): anysdk.ProtocolPush;
/**
!#en
get REC system plugin
!#zh
获取录屏系统插件
*/
getRECPlugin(): anysdk.ProtocolREC;
/**
!#en
get crash system plugin
!#zh
获取崩溃分析系统插件
*/
getCrashPlugin(): anysdk.ProtocolCrash;
/**
!#en
get ad track system plugin
!#zh
获取广告追踪系统插件
*/
getAdTrackingPlugin(): anysdk.ProtocolAdTracking;
/**
!#en
get custom system plugin
!#zh
获取自定义系统插件
*/
getCustomPlugin(): anysdk.ProtocolCustom;
/**
!#en
get custom parameter
!#zh
获取自定义参数
*/
getCustomParam(): string;
/**
!#en
get channel id
!#zh
获取渠道唯一表示符
*/
getChannelId(): string;
/**
!#en
get status of analytics
!#zh
获取统计状态
*/
isAnaylticsEnabled(): boolean;
/**
!#en
set whether to analytics
!#zh
设置是否统计
@param enabled enabled
*/
setIsAnaylticsEnabled(enabled: boolean): void;
/**
!#en
destory instance
!#zh
销毁单例
*/
static end(): void;
/**
!#en
get instance
!#zh
获取单例
*/
static getInstance(): anysdk.AgentManager;
}
/** !#en
plugin protocol
!#zh
插件协议 */
export class PluginProtocol {
/**
!#en
Check whether the function is supported
!#zh
判断函数是否支持
@param functionName functionName
*/
isFunctionSupported(functionName: string): boolean;
/**
!#en
get plugin name
!#zh
获取插件名称
*/
getPluginName(): string;
/**
!#en
get plugin version
!#zh
获取插件版本
*/
getPluginVersion(): string;
/**
!#en
get SDK version
!#zh
获取 SDK 版本
*/
getSDKVersion(): string;
/**
!#en
void methods for reflections with parameter
!#zh
反射调用带参数的void方法
@param funName funName
@param args optional arguments
*/
callFuncWithParam(funName: string, ...args: any|anysdk.PluginParam[]): void;
/**
!#en
String methods for reflections with parameter
!#zh
反射调用带参数的 String 方法
@param funName funName
@param args optional arguments
*/
callStringFuncWithParam(funName: string, ...args: any|anysdk.PluginParam[]): string;
/**
!#en
int methods for reflections with parameter
!#zh
反射调用带参数的 Int 方法
@param funName funName
@param args optional arguments
*/
callIntFuncWithParam(funName: string, ...args: any|anysdk.PluginParam[]): number;
/**
!#en
boolean methods for reflections with parameter
!#zh
反射调用带参数的 boolean 方法
@param funName funName
@param args optional arguments
*/
callBoolFuncWithParam(funName: string, ...args: any|anysdk.PluginParam[]): boolean;
/**
!#en
float methods for reflections with parameter
!#zh
反射调用带参数的 float 方法
@param funName funName
@param args optional arguments
*/
callFloatFuncWithParam(funName: string, ...args: any|anysdk.PluginParam[]): number;
}
/** !#en
user protocol
!#zh
用户系统协议接口 */
export class ProtocolUser extends PluginProtocol {
/**
!#en
login interface
!#zh
登录接口
@param args optional arguments
*/
login(...args: string|any[]): void;
/**
!#en
get status of login
!#zh
获取登录状态
*/
isLogined(): boolean;
/**
!#en
get user ID
!#zh
获取用户唯一标示符
*/
getUserID(): string;
/**
!#en
get plugin ID
!#zh
获取插件ID
*/
getPluginId(): string;
/**
!#en
set listener
!#zh
设置用户系统的监听
@param listener listener
@param target target
*/
setListener(listener: Function, target: any): void;
/**
!#en
get listener
!#zh
获取用户系统的监听
*/
getListener(): Function;
/**
!#en
logout
Before to invoke, you need to verdict whether this properties existed
!#zh
登出，调用前需要判断属性是否存在
*/
logout(): void;
/**
!#en
show toolbar
Before to invoke, you need to verdict whether this properties existed
!#zh
显示悬浮窗，调用前需要判断属性是否存在
@param place place
*/
showToolBar(place: anysdk.ToolBarPlace): void;
/**
!#en
hide toolbar
Before to invoke, you need to verdict whether this properties existed
!#zh
隐藏悬浮窗，调用前需要判断属性是否存在
*/
hideToolBar(): void;
/**
!#en
enter platform
Before to invoke, you need to verdict whether this properties existed
!#zh
显示平台中心，调用前需要判断属性是否存在
*/
enterPlatform(): void;
/**
!#en
show exit page
Before to invoke, you need to verdict whether this properties existed
!#zh
显示退出界面，调用前需要判断属性是否存在
*/
exit(): void;
/**
!#en
show pause page
Before to invoke, you need to verdict whether this properties existed
!#zh
显示暂停界面，调用前需要判断属性是否存在
*/
pause(): void;
/**
!#en
Real-name registration
Before to invoke, you need to verdict whether this properties existed
!#zh
实名注册，调用前需要判断属性是否存在
*/
realNameRegister(): void;
/**
!#en
Anti-addiction query
Before to invoke, you need to verdict whether this properties existed
!#zh
防沉迷查询，调用前需要判断属性是否存在
*/
antiAddictionQuery(): void;
/**
!#en
submit game role information
Before to invoke, you need to verdict whether this properties existed
!#zh
提交角色信息，调用前需要判断属性是否存在
@param data data
*/
submitLoginGameRole(data: any): void;
/**
!#en
get user information
Before to invoke, you need to verdict whether this properties existed
!#zh
获取用户信息，调用前需要判断属性是否存在
@param info info
*/
getUserInfo(info: any): void;
/**
!#en
set login type
Before to invoke, you need to verdict whether this properties existed
!#zh
设置登录类型，调用前需要判断属性是否存在
@param info info
*/
getAvailableLoginType(info: any): void;
/**
!#en
set login type
Before to invoke, you need to verdict whether this properties existed
!#zh
设置登录类型，调用前需要判断属性是否存在
@param loginType loginType
*/
setLoginType(loginType: string): void;
/**
!#en
send to desktop
Before to invoke, you need to verdict whether this properties existed
!#zh
发送到桌面，调用前需要判断属性是否存在
*/
sendToDesktop(): void;
/**
!#en
open bbs
Before to invoke, you need to verdict whether this properties existed
!#zh
打开论坛，调用前需要判断属性是否存在
*/
openBBS(): void;
}
/** !#en
IAP protocol
!#zh
支付系统协议接口 */
export class ProtocolIAP extends PluginProtocol {
/**
!#en
pay interface
!#zh
支付接口
@param info Type:map
*/
payForProduct(info: any): void;
/**
!#en
get order ID
!#zh
获取订单ID
*/
getOrderId(): string;
/**
!#en
reset the pay status
!#zh
重置支付状态
*/
static resetPayState(): void;
/**
!#en
get plugin ID
!#zh
获取插件ID
*/
getPluginId(): string;
/**
!#en
set listener
!#zh
设置支付系统的监听
@param listener listener
@param target target
*/
setListener(listener: Function, target: any): void;
/**
!#en
get listener
!#zh
获取支付系统的监听
*/
getListener(): Function;
}
/** !#en
analytics protocol
!#zh
统计系统协议接口 */
export class ProtocolAnalytics extends PluginProtocol {
/**
!#en
Start a new session.
!#zh
启动会话
*/
startSession(): void;
/**
!#en
Stop a session.
!#zh
关闭会话
*/
stopSession(): void;
/**
!#en
Set the timeout for expiring a session.
!#zh
设置会话超时时间
@param millis Type: long
*/
setSessionContinueMillis(millis: number): void;
/**
!#en
log an error
!#zh
捕捉异常
@param errorId errorId
@param message message
*/
logError(errorId: string, message: string): void;
/**
!#en
log an event.
!#zh
捕捉事件
@param errorId errorId
@param args optional arguments Type: map
*/
logEvent(errorId: string, ...args: any[]): void;
/**
!#en
Track an event begin.
!#zh
统计事件开始
@param eventId eventId
*/
logTimedEventBegin(eventId: string): void;
/**
!#en
Track an event end.
!#zh
统计事件结束
@param eventId eventId
*/
logTimedEventEnd(eventId: string): void;
/**
!#en
set Whether to catch uncaught exceptions to server.
!#zh
设置是否开启自动异常捕捉
@param enabled enabled
*/
setCaptureUncaughtException(enabled: boolean): void;
/**
!#en
analytics account information
!#zh
统计玩家帐户信息
@param paramMap Type: map
*/
setAccount(paramMap: any): void;
/**
!#en
track user to request payment
!#zh
跟踪用户支付请求
@param paramMap Type: map
*/
onChargeRequest(paramMap: any): void;
/**
!#en
track Successful payment
!#zh
追踪用户支付成功
@param orderID orderID
*/
onChargeSuccess(orderID: string): void;
/**
!#en
track failed payment
!#zh
追踪用户支付失败
@param paramMap Type: map
*/
onChargeFail(paramMap: any): void;
/**
!#en
track Successful payment
!#zh
统计玩家支付成功
@param paramMap Type: map
*/
onChargeOnlySuccess(paramMap: any): void;
/**
!#en
track user purchase
!#zh
统计玩家消费
@param paramMap Type: map
*/
onPurchase(paramMap: any): void;
/**
!#en
track user to use goods
!#zh
统计玩家使用道具
@param paramMap Type: map
*/
onUse(paramMap: any): void;
/**
!#en
track user to reward goods
!#zh
统计玩家获取奖励
@param paramMap Type: map
*/
onReward(paramMap: any): void;
/**
!#en
start level
!#zh
开始关卡
@param paramMap Type: map
*/
startLevel(paramMap: any): void;
/**
!#en
finish level
!#zh
结束关卡
@param levelID levelID
*/
finishLevel(levelID: string): void;
/**
!#en
failed level
!#zh
关卡失败
@param paramMap Type: map
*/
failLevel(paramMap: any): void;
/**
!#en
start task
!#zh
开始任务
@param paramMap Type: map
*/
startTask(paramMap: any): void;
/**
!#en
finish task
!#zh
完成任务
@param taskID taskID
*/
finishTask(taskID: string): void;
/**
!#en
failed task
!#zh
任务失败
@param paramMap Type: map
*/
failTask(paramMap: any): void;
}
/** !#en
share protocol
!#zh
分享系统协议接口 */
export class ProtocolShare extends PluginProtocol {
/**
!#en
share interface
!#zh
分享
@param info Type: map
*/
share(info: any): void;
/**
!#en
set listener
!#zh
设置分享系统的监听
@param listener listener
@param target target
*/
setListener(listener: Function, target: any): void;
/**
!#en
get listener
!#zh
获取分享系统的监听
*/
getListener(): Function;
}
/** !#en
ads protocol
!#zh
广告系统协议接口 */
export class ProtocolAds extends PluginProtocol {
/**
!#en
hide ads view
!#zh
隐藏广告
@param adstype adstype
@param idx idx
*/
hideAds(adstype: anysdk.AdsType, idx: number): void;
/**
!#en
preload ads view
!#zh
预加载广告
@param adstype adstype
@param idx idx
*/
preloadAds(adstype: anysdk.AdsType, idx: number): void;
/**
!#en
query points
!#zh
查询分数
*/
queryPoints(): number;
/**
!#en
get whether the ads type is supported
!#zh
获取广告类型是否支持
@param arg0 arg0
*/
isAdTypeSupported(arg0: anysdk.AdsType): boolean;
/**
!#en
spend point
!#zh
消费分数
@param points points
*/
spendPoints(points: number): void;
/**
!#en
set listener
!#zh
设置广告系统的监听
@param listener listener
@param target target
*/
setListener(listener: Function, target: any): void;
/**
!#en
get listener
!#zh
获取广告系统的监听
*/
getListener(): Function;
}
/** !#en
social protocol
!#zh
社交系统协议接口 */
export class ProtocolSocial extends PluginProtocol {
/**
!#en
sign in
!#zh
登录
*/
signIn(): void;
/**
!#en
sign out
!#zh
登出
*/
signOut(): void;
/**
!#en
submit score
!#zh
提交分数
@param leadboardID leadboardID
@param score Type: long
*/
submitScore(leadboardID: string, score: number): void;
/**
!#en
show the id of Leaderboard page
!#zh
根据唯一标识符显示排行榜
@param leaderboardID leaderboardID
*/
showLeaderboard(leaderboardID: string): void;
/**
!#en
show the page of achievements
!#zh
显示成就榜
*/
showAchievements(): void;
/**
!#en
unlock achievement
!#zh
解锁成就
@param info Type: map
*/
share(info: any): void;
/**
!#en
set listener
!#zh
设置社交系统的监听
@param listener listener
@param target target
*/
setListener(listener: Function, target: any): void;
/**
!#en
get listener
!#zh
获取社交系统的监听
*/
getListener(): Function;
/**
!#en
get friends info
Before to invoke, you need to verdict whether this properties existed
!#zh
获取好友信息，调用前需要判断属性是否存在
*/
pauseRecording(): void;
/**
!#en
interact
Before to invoke, you need to verdict whether this properties existed
!#zh
订阅，调用前需要判断属性是否存在
*/
interact(): void;
/**
!#en
subscribe
Before to invoke, you need to verdict whether this properties existed
!#zh
关注，调用前需要判断属性是否存在
*/
subscribe(): void;
}
/** !#en
push protocol
!#zh
推送系统协议接口 */
export class ProtocolPush extends PluginProtocol {
/**
!#en
start Push services
!#zh
启动推送服务
*/
startPush(): void;
/**
!#en
close Push services
!#zh
暂停推送服务
*/
closePush(): void;
/**
!#en
delete alias
!#zh
删除别名
@param alias alias
*/
delAlias(alias: string): void;
/**
!#en
set alias
!#zh
设置别名
@param alias alias
*/
setAlias(alias: string): void;
/**
!#en
delete tags
!#zh
删除标签
@param tags Type: list
*/
delTags(tags: any): void;
/**
!#en
set tags
!#zh
设置标签
@param tags Type: list
*/
setTags(tags: any): void;
/**
!#en
set listener
!#zh
设置推送系统的监听
@param listener listener
@param target target
*/
setListener(listener: Function, target: any): void;
/**
!#en
get listener
!#zh
获取推送系统的监听
*/
getListener(): Function;
}
/** !#en
crash protocol
!#zh
崩溃分析系统协议接口 */
export class ProtocolCrash extends PluginProtocol {
/**
!#en
set user identifier
!#zh
统计用户唯一标识符
@param identifier identifier
*/
setUserIdentifier(identifier: string): void;
/**
!#en
The uploader captured in exception information
!#zh
上报异常信息
@param message message
@param exception exception
*/
reportException(message: string, exception: string): void;
/**
!#en
customize logging
!#zh
自定义日志记录
@param breadcrumb breadcrumb
*/
leaveBreadcrumb(breadcrumb: string): void;
}
/** !#en
REC protocol
!#zh
录屏系统协议接口 */
export class ProtocolREC extends PluginProtocol {
/**
!#en
share video
!#zh
分享视频
@param info Type: map
*/
share(info: any): void;
/**
!#en
Start to record video
!#zh
开始录制视频
*/
startRecording(): void;
/**
!#en
Start to record video
!#zh
结束录制视频
*/
stopRecording(): void;
/**
!#en
set listener
!#zh
设置录屏系统的监听
@param listener listener
@param target target
*/
setListener(listener: Function, target: any): void;
/**
!#en
get listener
!#zh
获取录屏系统的监听
*/
getListener(): Function;
/**
!#en
pause to record video
Before to invoke, you need to verdict whether this properties existed
!#zh
暂停录制视频，调用前需要判断属性是否存在
*/
pauseRecording(): void;
/**
!#en
resume to record video
Before to invoke, you need to verdict whether this properties existed
!#zh
恢复录制视频，调用前需要判断属性是否存在
*/
resumeRecording(): void;
/**
!#en
get whether the device is isAvailable
Before to invoke, you need to verdict whether this properties existed
!#zh
获取设备是否可用，调用前需要判断属性是否存在
*/
isAvailable(): boolean;
/**
!#en
get status of recording
Before to invoke, you need to verdict whether this properties existed
!#zh
获取录制状态，调用前需要判断属性是否存在
*/
isRecording(): boolean;
/**
!#en
show toolbar
Before to invoke, you need to verdict whether this properties existed
!#zh
显示悬浮窗，调用前需要判断属性是否存在
*/
showToolBar(): void;
/**
!#en
hide toolbar
Before to invoke, you need to verdict whether this properties existed
!#zh
隐藏悬浮窗，调用前需要判断属性是否存在
*/
hideToolBar(): void;
/**
!#en
show video center
Before to invoke, you need to verdict whether this properties existed
!#zh
显示视频中心，调用前需要判断属性是否存在
*/
showVideoCenter(): void;
/**
!#en
enter platform
Before to invoke, you need to verdict whether this properties existed
!#zh
显示平台中心，调用前需要判断属性是否存在
*/
enterPlatform(): void;
/**
!#en
Set the video data, it is recommended to check whether are recorded firstly
Before to invoke, you need to verdict whether this properties existed
!#zh
设置视频相关数据，建议先检查是否是正在录制，调用前需要判断属性是否存在
@param info Type: map
*/
setMetaData(info: any): void;
}
/** !#en
ad tracking protocol
!#zh
广告追踪系统协议接口 */
export class ProtocolAdTracking extends PluginProtocol {
/**
!#en
Call this method if you want to track register events as happening during a section.
!#zh
统计用户注册信息
@param productInfo Type: map
*/
onPay(productInfo: any): void;
/**
!#en
Call this method if you want to track register events as happening during a section.
!#zh
统计用户注册信息
@param userInfo Type: map
*/
onLogin(userInfo: any): void;
/**
!#en
Call this method if you want to track register events as happening during a section.
!#zh
统计用户注册信息
@param userId userId
*/
onRegister(userId: string): void;
/**
!#en
Call this method if you want to track custom events with parameters as happening during a section.
!#zh
统计自定义事件
@param eventId eventId
@param paramMap Type: map
*/
trackEvent(eventId: string, paramMap: any): void;
/**
!#en
Call this method with parameters if you want to create role as happening during a section.
!#zh
统计创建角色事件，调用前需要判断属性是否存在
@param userInfo Type: map
*/
onCreateRole(userInfo: any): void;
/**
!#en
Call this method if you want to track levelup events with parameters as happening during a section.
Before to invoke, you need to verdict whether this properties existed
!#zh
统计角色升级事件，调用前需要判断属性是否存在
@param info Type: map
*/
onLevelUp(info: any): void;
/**
!#en
Invoke this method with parameters if you want to start to pay as happening during a section.
Before to invoke, you need to verdict whether this properties existed
!#zh
统计开始充值事件，调用前需要判断属性是否存在
@param info Type: map
*/
onStartToPay(info: any): void;
}
/** !#en
custom protocol
!#zh
自定义系统协议接口 */
export class ProtocolCustom extends PluginProtocol {
/**
!#en
set listener
!#zh
设置自定义系统的监听
@param listener listener
@param target target
*/
setListener(listener: Function, target: any): void;
/**
!#en
get listener
!#zh
获取自定义系统的监听
*/
getListener(): Function;
}
/** !#en
Data structure class
!#zh
数据结构类 */
export class PluginParam {
/**
!#en
create plugin parameters
!#zh
创建对象
@param parameters parameters
*/
static create(parameters: number|string|any): anysdk.PluginParam;
}
/** !#en The callback of user system
!#zh 用户系统回调 */
export enum UserActionResultCode {
kInitSuccess = 0,
kInitFail = 0,
kLoginSuccess = 0,
kLoginNetworkError = 0,
kLoginNoNeed = 0,
kLoginFail = 0,
kLoginCancel = 0,
kLogoutSuccess = 0,
kLogoutFail = 0,
kPlatformEnter = 0,
kPlatformBack = 0,
kPausePage = 0,
kExitPage = 0,
kAntiAddictionQuery = 0,
kRealNameRegister = 0,
kAccountSwitchSuccess = 0,
kAccountSwitchFail = 0,
kOpenShop = 0,
kAccountSwitchCancel = 0,
kUserExtension = 0,
kSendToDesktopSuccess = 0,
kSendToDesktopFail = 0,
kGetAvailableLoginTypeSuccess = 0,
kGetAvailableLoginTypeFail = 0,
kGetUserInfoSuccess = 0,
kGetUserInfoFail = 0,
kOpenBBSSuccess = 0,
kOpenBBSFail = 0,
}
/** !#en The toolbar position of user type
!#zh 用户系统悬浮窗位置 */
export enum ToolBarPlace {
kToolBarTopLeft = 0,
kToolBarTopRight = 0,
kToolBarMidLeft = 0,
kToolBarMidRight = 0,
kToolBarBottomLeft = 0,
kToolBarBottomRight = 0,
}
/** !#en The callback of requesting reStringge
!#zh 支付系统支付请求回调 */
export enum PayResultCode {
kPaySuccess = 0,
kPayFail = 0,
kPayCancel = 0,
kPayNetworkError = 0,
kPayProductionInforIncomplete = 0,
kPayInitSuccess = 0,
kPayInitFail = 0,
kPayNowPaying = 0,
kPayReStringgeSuccess = 0,
kPayExtension = 0,
kPayNeedLoginAgain = 0,
kRequestSuccess = 0,
kRequestFail = 0,
}
/** !#en The enum of account type
!#zh 统计系统的账号类型 */
export enum AccountType {
ANONYMOUS = 0,
REGISTED = 0,
SINA_WEIBO = 0,
TENCENT_WEIBO = 0,
QQ = 0,
ND91 = 0,
}
/** !#en The enum of account operation
!#zh 统计系统的账号操作 */
export enum AccountOperate {
LOGIN = 0,
LOGOUT = 0,
REGISTER = 0,
}
/** !#en The enum of gender
!#zh 统计系统的账号性别 */
export enum AccountGender {
MALE = 0,
FEMALE = 0,
UNKNOWN = 0,
}
/** !#en The enum of task type
!#zh 统计系统的任务类型 */
export enum TaskType {
GUIDE_LINE = 0,
MAIN_LINE = 0,
BRANCH_LINE = 0,
DAILY = 0,
ACTIVITY = 0,
OTHER = 0,
}
/** !#en The callback of share system
!#zh 分享系统回调 */
export enum ShareResultCode {
kShareSuccess = 0,
kShareFail = 0,
kShareCancel = 0,
kShareNetworkError = 0,
kShareExtension = 0,
}
/** !#en The callback of social system
!#zh 社交系统回调 */
export enum SocialRetCode {
kScoreSubmitSucceed = 0,
kScoreSubmitfail = 0,
kAchUnlockSucceed = 0,
kAchUnlockFail = 0,
kSocialSignInSucceed = 0,
kSocialSignInFail = 0,
kSocialSignOutSucceed = 0,
kSocialSignOutFail = 0,
kSocialGetGameFriends = 0,
kSocialExtensionCode = 0,
kSocialGetFriendsInfoSuccess = 0,
kSocialGetFriendsInfoFail = 0,
kSocialAlreadySubscription = 0,
kSocialNoSubscription = 0,
kSocialSubscriptionFail = 0,
}
/** !#en The callback of ads system
!#zh 广告系统回调 */
export enum AdsResultCode {
kAdsReceived = 0,
kAdsShown = 0,
kAdsDismissed = 0,
kPointsSpendSucceed = 0,
kPointsSpendFailed = 0,
kNetworkError = 0,
kUnknownError = 0,
kOfferWallOnPointsChanged = 0,
kRewardedVideoWithReward = 0,
kInAppPurchaseFinished = 0,
kAdsClicked = 0,
kAdsExtension = 0,
}
/** !#en The enum of ads position
!#zh 广告位置 */
export enum AdsPos {
kPosCenter = 0,
kPosTop = 0,
kPosTopLeft = 0,
kPosTopRight = 0,
kPosBottom = 0,
kPosBottomLeft = 0,
kPosBottomRight = 0,
}
/** !#en The enum of ads type
!#zh 广告类型 */
export enum AdsType {
AD_TYPE_BANNER = 0,
AD_TYPE_FULLSCREEN = 0,
AD_TYPE_MOREAPP = 0,
AD_TYPE_OFFERWALL = 0,
AD_TYPE_REWARDEDVIDEO = 0,
AD_TYPE_NATIVEEXPRESS = 0,
AD_TYPE_NATIVEADVANCED = 0,
}
/** !#en The callback of push system
!#zh 推送系统回调 */
export enum PushActionResultCode {
kPushReceiveMessage = 0,
kPushExtensionCode = 0,
}
/** !#en The callback of custom system
!#zh 自定义系统回调 */
export enum CustomResultCode {
kCustomExtension = 0,
}
/** !#en The callback of REC system
!#zh 录屏系统回调 */
export enum RECResultCode {
kRECInitSuccess = 0,
kRECInitFail = 0,
kRECStartRecording = 0,
kRECStopRecording = 0,
kRECPauseRecording = 0,
kRECResumeRecording = 0,
kRECEnterSDKPage = 0,
kRECQuitSDKPage = 0,
kRECShareSuccess = 0,
kRECShareFail = 0,
kRECExtension = 0,
}
}
/** !#en
The global main namespace of DragonBones, all classes, functions,
properties and constants of DragonBones are defined in this namespace
!#zh
DragonBones 的全局的命名空间，
与 DragonBones 相关的所有的类，函数，属性，常量都在这个命名空间中定义。 */
declare module dragonBones {
/** !#en
The Armature Display of DragonBones
(Armature Display has a reference to a DragonBonesAsset and stores the state for ArmatureDisplay instance,
which consists of the current pose's bone SRT, slot colors, and which slot attachments are visible.
Multiple Armature Display can use the same DragonBonesAsset which includes all animations, skins, and attachments.)
!#zh
DragonBones 骨骼动画
(Armature Display 具有对骨骼数据的引用并且存储了骨骼实例的状态，
它由当前的骨骼动作，slot 颜色，和可见的 slot attachments 组成。
多个 Armature Display 可以使用相同的骨骼数据，其中包括所有的动画，皮肤和 attachments。)
*/
export class ArmatureDisplay extends cc._RendererUnderSG {
/** !#en
The DragonBones data contains the armatures information (bind pose bones, slots, draw order,
attachments, skins, etc) and animations but does not hold any state.
Multiple ArmatureDisplay can share the same DragonBones data.
!#zh
骨骼数据包含了骨骼信息（绑定骨骼动作，slots，渲染顺序，
attachments，皮肤等等）和动画但不持有任何状态。
多个 ArmatureDisplay 可以共用相同的骨骼数据。 */
dragonAsset: DragonBonesAsset;
/** !#en
The atlas asset for the DragonBones.
!#zh
骨骼数据所需的 Atlas Texture 数据。 */
dragonAtlasAsset: DragonBonesAtlasAsset;
/** !#en The name of current armature.
!#zh 当前的 Armature 名称。 */
armatureName: string;
/** !#en The name of current playing animation.
!#zh 当前播放的动画名称。 */
animationName: string;
_defaultArmatureIndex: number;
/** !#en The time scale of this armature.
!#zh 当前骨骼中所有动画的时间缩放率。 */
timeScale: number;
/** !#en The play times of the default animation.
-1 means using the value of config file;
0 means repeat for ever
>0 means repeat times
!#zh 播放默认动画的循环次数
-1 表示使用配置文件中的默认值;
0 表示无限循环
>0 表示循环次数 */
playTimes: number;
/** !#en Indicates whether open debug bones.
!#zh 是否显示 bone 的 debug 信息。 */
debugBones: boolean;
/**
!#en
Play the specified animation.
Parameter animName specify the animation name.
Parameter playTimes specify the repeat times of the animation.
-1 means use the value of the config file.
0 means play the animation for ever.
>0 means repeat times.
!#zh
播放指定的动画.
animName 指定播放动画的名称。
playTimes 指定播放动画的次数。
-1 为使用配置文件中的次数。
0 为无限循环播放。
>0 为动画的重复次数。
@param animName animName
@param playTimes playTimes
*/
playAnimation(animName: string, playTimes: number): dragonBones.AnimationState;
/**
!#en
Get the all armature names in the DragonBones Data.
!#zh
获取 DragonBones 数据中所有的 armature 名称
*/
getArmatureNames(): any[];
/**
!#en
Get the all animation names of specified armature.
!#zh
获取指定的 armature 的所有动画名称。
@param armatureName armatureName
*/
getAnimationNames(armatureName: string): any[];
/**
!#en
Add event listener for the DragonBones Event.
!#zh
添加 DragonBones 事件监听器。
@param eventType eventType
@param listener listener
@param target target
*/
addEventListener(eventType: dragonBones.EventObject, listener: Function, target: any): void;
/**
!#en
Remove the event listener for the DragonBones Event.
!#zh
移除 DragonBones 事件监听器。
@param eventType eventType
@param listener listener
@param target target
*/
removeEventListener(eventType: dragonBones.EventObject, listener: Function, target: any): void;
/**
!#en
Build the armature for specified name.
!#zh
构建指定名称的 armature 对象
@param armatureName armatureName
*/
buildArmature(armatureName: string): dragonBones.Armature;
/**
!#en
Get the current armature object of the ArmatureDisplay.
!#zh
获取 ArmatureDisplay 当前使用的 Armature 对象
*/
armature(): any;
}
/** !#en The skeleton data of dragonBones.
!#zh dragonBones 的 骨骼数据。 */
export class DragonBonesAsset extends cc.Asset {
/** !#en See http://developer.egret.com/cn/github/egret-docs/DB/dbLibs/dataFormat/index.html
!#zh 可查看 DragonBones 官方文档 http://developer.egret.com/cn/github/egret-docs/DB/dbLibs/dataFormat/index.html */
dragonBonesJson: string;
}
/** !#en The skeleton atlas data of dragonBones.
!#zh dragonBones 的骨骼纹理数据。 */
export class DragonBonesAtlasAsset extends cc.Asset {
atlasJson: string;
texture: cc.Texture2D;
}
}
/** !#en
The global main namespace of Spine, all classes, functions,
properties and constants of Spine are defined in this namespace
!#zh
Spine 的全局的命名空间，
与 Spine 相关的所有的类，函数，属性，常量都在这个命名空间中定义。 */
declare module sp {
/** !#en
The skeleton of Spine
(Skeleton has a reference to a SkeletonData and stores the state for skeleton instance,
which consists of the current pose's bone SRT, slot colors, and which slot attachments are visible.
Multiple skeletons can use the same SkeletonData which includes all animations, skins, and attachments.)
!#zh
Spine 骨骼动画
(Skeleton 具有对骨骼数据的引用并且存储了骨骼实例的状态，
它由当前的骨骼动作，slot 颜色，和可见的 slot attachments 组成。
多个 Skeleton 可以使用相同的骨骼数据，其中包括所有的动画，皮肤和 attachments。 */
export class Skeleton extends cc._RendererUnderSG {
/** !#en The skeletal animation is paused?
!#zh 该骨骼动画是否暂停。 */
paused: boolean;
/** !#en
The skeleton data contains the skeleton information (bind pose bones, slots, draw order,
attachments, skins, etc) and animations but does not hold any state.
Multiple skeletons can share the same skeleton data.
!#zh
骨骼数据包含了骨骼信息（绑定骨骼动作，slots，渲染顺序，
attachments，皮肤等等）和动画但不持有任何状态。
多个 Skeleton 可以共用相同的骨骼数据。 */
skeletonData: SkeletonData;
/** !#en The name of default skin.
!#zh 默认的皮肤名称。 */
defaultSkin: string;
/** !#en The name of default animation.
!#zh 默认的动画名称。 */
defaultAnimation: string;
/** !#en The name of current playing animation.
!#zh 当前播放的动画名称。 */
animation: string;
_defaultSkinIndex: number;
/** !#en TODO
!#zh 是否循环播放当前骨骼动画。 */
loop: boolean;
/** !#en Indicates whether to enable premultiplied alpha.
You should disable this option when image's transparent area appears to have opaque pixels,
or enable this option when image's half transparent area appears to be darken.
!#zh 是否启用贴图预乘。
当图片的透明区域出现色块时需要关闭该选项，当图片的半透明区域颜色变黑时需要启用该选项。 */
premultipliedAlpha: boolean;
/** !#en The time scale of this skeleton.
!#zh 当前骨骼中所有动画的时间缩放率。 */
timeScale: number;
/** !#en Indicates whether open debug slots.
!#zh 是否显示 slot 的 debug 信息。 */
debugSlots: boolean;
/** !#en Indicates whether open debug bones.
!#zh 是否显示 bone 的 debug 信息。 */
debugBones: boolean;
/**
!#en Computes the world SRT from the local SRT for each bone.
!#zh 重新更新所有骨骼的世界 Transform，
当获取 bone 的数值未更新时，即可使用该函数进行更新数值。
@example
```js
var bone = spine.findBone('head');
cc.log(bone.worldX); // return 0;
spine.updateWorldTransform();
bone = spine.findBone('head');
cc.log(bone.worldX); // return -23.12;
```
*/
updateWorldTransform(): void;
/**
!#en Sets the bones and slots to the setup pose.
!#zh 还原到起始动作
*/
setToSetupPose(): void;
/**
!#en
Sets the bones to the setup pose,
using the values from the `BoneData` list in the `SkeletonData`.
!#zh
设置 bone 到起始动作
使用 SkeletonData 中的 BoneData 列表中的值。
*/
setBonesToSetupPose(): void;
/**
!#en
Sets the slots to the setup pose,
using the values from the `SlotData` list in the `SkeletonData`.
!#zh
设置 slot 到起始动作。
使用 SkeletonData 中的 SlotData 列表中的值。
*/
setSlotsToSetupPose(): void;
/**
!#en
Finds a bone by name.
This does a string comparison for every bone.
Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Bone object.
!#zh
通过名称查找 bone。
这里对每个 bone 的名称进行了对比。
返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Bone 对象。
@param boneName boneName
*/
findBone(boneName: string): sp.spine.Bone;
/**
!#en
Finds a slot by name. This does a string comparison for every slot.
Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Slot object.
!#zh
通过名称查找 slot。这里对每个 slot 的名称进行了比较。
返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Slot 对象。
@param slotName slotName
*/
findSlot(slotName: string): sp.spine.Slot;
/**
!#en
Finds a skin by name and makes it the active skin.
This does a string comparison for every skin.
Note that setting the skin does not change which attachments are visible.
Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Skin object.
!#zh
按名称查找皮肤，激活该皮肤。这里对每个皮肤的名称进行了比较。
注意：设置皮肤不会改变 attachment 的可见性。
返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Skin 对象。
@param skinName skinName
*/
setSkin(skinName: string): sp.spine.Skin;
/**
!#en
Returns the attachment for the slot and attachment name.
The skeleton looks first in its skin, then in the skeleton data’s default skin.
Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Attachment object.
!#zh
通过 slot 和 attachment 的名称获取 attachment。Skeleton 优先查找它的皮肤，然后才是 Skeleton Data 中默认的皮肤。
返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Attachment 对象。
@param slotName slotName
@param attachmentName attachmentName
*/
getAttachment(slotName: string, attachmentName: string): sp.spine.Attachment;
/**
!#en
Sets the attachment for the slot and attachment name.
The skeleton looks first in its skin, then in the skeleton data’s default skin.
!#zh
通过 slot 和 attachment 的名字来设置 attachment。
Skeleton 优先查找它的皮肤，然后才是 Skeleton Data 中默认的皮肤。
@param slotName slotName
@param attachmentName attachmentName
*/
setAttachment(slotName: string, attachmentName: string): void;
/**
!#en
Sets runtime skeleton data to sp.Skeleton.
This method is different from the `skeletonData` property. This method is passed in the raw data provided by the Spine runtime, and the skeletonData type is the asset type provided by Creator.
!#zh
设置底层运行时用到的 SkeletonData。
这个接口有别于 `skeletonData` 属性，这个接口传入的是 Spine runtime 提供的原始数据，而 skeletonData 的类型是 Creator 提供的资源类型。
@param skeletonData skeletonData
@param ownsSkeletonData ownsSkeletonData
*/
setSkeletonData(skeletonData: sp.spine.SkeletonData, ownsSkeletonData: sp.spine.SkeletonData): void;
/**
!#en Sets animation state data.
The parameter type is {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.AnimationStateData.
!#zh 设置动画状态数据。
参数是 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.AnimationStateData。
@param stateData stateData
*/
setAnimationStateData(stateData: sp.spine.AnimationStateData): void;
/**
!#en
Mix applies all keyframe values,
interpolated for the specified time and mixed with the current values.
!#zh 为所有关键帧设定混合及混合时间（从当前值开始差值）。
@param fromAnimation fromAnimation
@param toAnimation toAnimation
@param duration duration
*/
setMix(fromAnimation: string, toAnimation: string, duration: number): void;
/**
!#en Sets event listener.
!#zh 设置动画事件监听器。
@param target target
@param callback callback
*/
setAnimationListener(target: any, callback: Function): void;
/**
!#en Set the current animation. Any queued animations are cleared.
Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry object.
!#zh 设置当前动画。队列中的任何的动画将被清除。
返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry 对象。
@param trackIndex trackIndex
@param name name
@param loop loop
*/
setAnimation(trackIndex: number, name: string, loop: boolean): sp.spine.TrackEntry;
/**
!#en Adds an animation to be played delay seconds after the current or last queued animation.
Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry object.
!#zh 添加一个动画到动画队列尾部，还可以延迟指定的秒数。
返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry 对象。
@param trackIndex trackIndex
@param name name
@param loop loop
@param delay delay
*/
addAnimation(trackIndex: number, name: string, loop: boolean, delay?: number): sp.spine.TrackEntry;
/**
!#en Find animation with specified name.
!#zh 查找指定名称的动画
@param name name
*/
findAnimation(name: string): sp.spine.Animation;
/**
!#en Returns track entry by trackIndex.
Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry object.
!#zh 通过 track 索引获取 TrackEntry。
返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry 对象。
@param trackIndex trackIndex
*/
getCurrent(trackIndex: void): sp.spine.TrackEntry;
/**
!#en Clears all tracks of animation state.
!#zh 清除所有 track 的动画状态。
*/
clearTracks(): void;
/**
!#en Clears track of animation state by trackIndex.
!#zh 清除出指定 track 的动画状态。
@param trackIndex trackIndex
*/
clearTrack(trackIndex: number): void;
/**
!#en Set the start event listener.
!#zh 用来设置开始播放动画的事件监听。
@param listener listener
*/
setStartListener(listener: Function): void;
/**
!#en Set the interrupt event listener.
!#zh 用来设置动画被打断的事件监听。
@param listener listener
*/
setInterruptListener(listener: Function): void;
/**
!#en Set the end event listener.
!#zh 用来设置动画播放完后的事件监听。
@param listener listener
*/
setEndListener(listener: Function): void;
/**
!#en Set the dispose event listener.
!#zh 用来设置动画将被销毁的事件监听。
@param listener listener
*/
setDisposeListener(listener: Function): void;
/**
!#en Set the complete event listener.
!#zh 用来设置动画播放一次循环结束后的事件监听。
@param listener listener
*/
setCompleteListener(listener: Function): void;
/**
!#en Set the animation event listener.
!#zh 用来设置动画播放过程中帧事件的监听。
@param listener listener
*/
setEventListener(listener: Function): void;
/**
!#en Set the start event listener for specified TrackEntry (only supported on Web).
!#zh 用来为指定的 TrackEntry 设置动画开始播放的事件监听。（只支持 Web 平台）
@param entry entry
@param listener listener
*/
setTrackStartListener(entry: sp.spine.TrackEntry, listener: Function): void;
/**
!#en Set the interrupt event listener for specified TrackEntry (only supported on Web).
!#zh 用来为指定的 TrackEntry 设置动画被打断的事件监听。（只支持 Web 平台）
@param entry entry
@param listener listener
*/
setTrackInterruptListener(entry: sp.spine.TrackEntry, listener: Function): void;
/**
!#en Set the end event listener for specified TrackEntry (only supported on Web).
!#zh 用来为指定的 TrackEntry 设置动画播放结束的事件监听。（只支持 Web 平台）
@param entry entry
@param listener listener
*/
setTrackEndListener(entry: sp.spine.TrackEntry, listener: Function): void;
/**
!#en Set the dispose event listener for specified TrackEntry (only supported on Web).
!#zh 用来为指定的 TrackEntry 设置动画即将被销毁的事件监听。（只支持 Web 平台）
@param entry entry
@param listener listener
*/
setTrackDisposeListener(entry: sp.spine.TrackEntry, listener: Function): void;
/**
!#en Set the complete event listener for specified TrackEntry (only supported on Web).
!#zh 用来为指定的 TrackEntry 设置动画一次循环播放结束的事件监听。（只支持 Web 平台）
@param entry entry
@param listener listener
*/
setTrackCompleteListener(entry: sp.spine.TrackEntry, listener: Function): void;
/**
!#en Set the event listener for specified TrackEntry (only supported on Web).
!#zh 用来为指定的 TrackEntry 设置动画帧事件的监听。（只支持 Web 平台）
@param entry entry
@param listener listener
*/
setTrackEventListener(entry: sp.spine.TrackEntry, listener: Function): void;
}
/** !#en The skeleton data of spine.
!#zh Spine 的 骨骼数据。 */
export class SkeletonData extends cc.Asset {
/** !#en See http://en.esotericsoftware.com/spine-json-format
!#zh 可查看 Spine 官方文档 http://zh.esotericsoftware.com/spine-json-format */
skeletonJson: any;
atlasText: string;
textures: cc.Texture2D[];
/** !#en
A scale can be specified on the JSON or binary loader which will scale the bone positions,
image sizes, and animation translations.
This can be useful when using different sized images than were used when designing the skeleton
in Spine. For example, if using images that are half the size than were used in Spine,
a scale of 0.5 can be used. This is commonly used for games that can run with either low or high
resolution texture atlases.
see http://en.esotericsoftware.com/spine-using-runtimes#Scaling
!#zh 可查看 Spine 官方文档： http://zh.esotericsoftware.com/spine-using-runtimes#Scaling */
scale: number;
/**
!#en Get the included SkeletonData used in spine runtime.
Returns a {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.SkeletonData object.
!#zh 获取 Spine Runtime 使用的 SkeletonData。
返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.SkeletonData 对象。
@param quiet quiet
*/
getRuntimeData(quiet?: boolean): sp.spine.SkeletonData;
}
/** !#en The event type of spine skeleton animation.
!#zh 骨骼动画事件类型。 */
export enum AnimationEventType {
START = 0,
END = 0,
COMPLETE = 0,
EVENT = 0,
}
}
/** !#en
`sp.spine` is the namespace for official Spine Runtime, which officially implemented and maintained by Spine.
Please refer to the official documentation for its detailed usage: [http://en.esotericsoftware.com/spine-using-runtimes](http://en.esotericsoftware.com/spine-using-runtimes)
!#zh
sp.spine 模块是 Spine 官方运行库的 API 入口，由 Spine 官方统一实现和维护，具体用法请参考：[http://zh.esotericsoftware.com/spine-using-runtimes](http://zh.esotericsoftware.com/spine-using-runtimes) */
declare module sp.spine {
}
/** !#en Some JavaScript decorators which can be accessed with "cc._decorator".
!#zh 一些 JavaScript 装饰器，目前可以通过 "cc._decorator" 来访问。
（这些 API 仍不完全稳定，有可能随着 JavaScript 装饰器的标准实现而调整） */
declare module cc._decorator {
/**
!#en
Declare the standard [ES6 Class](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes)
as CCClass, please see [Class](/docs/editors_and_tools/creator-chapters/scripting/class/) for details.
!#zh
将标准写法的 [ES6 Class](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes) 声明为 CCClass，具体用法请参阅[类型定义](/docs/creator/scripting/class/)。
@param name The class name used for serialization.
@example
```js
const {ccclass} = cc._decorator;
// define a CCClass, omit the name
@ccclass
class NewScript extends cc.Component {
// ...
}
// define a CCClass with a name
@ccclass('LoginData')
class LoginData {
// ...
}
```
*/
export function ccclass(name?: string): Function;
export function ccclass(_class?: Function): void;
/**
!#en
Declare property for [CCClass](/docs/editors_and_tools/creator-chapters/scripting/class/).
!#zh
定义 [CCClass](/docs/creator/scripting/class/) 所用的属性。
@param options an object with some property attributes
@example
```js
const {ccclass, property} = cc._decorator;
@ccclass
class NewScript extends cc.Component {
@property({
type: cc.Node
})
targetNode1 = null;
@property(cc.Node)
targetNode2 = null;
@property(cc.Button)
targetButton = null;
@property
_width = 100;
@property
get width () {
return this._width;
}
@property
set width (value) {
this._width = value;
}
@property
offset = new cc.Vec2(100, 100);
@property(cc.Vec2)
offsets = [];
@property(cc.Texture2D)
texture = "";
}
// above is equivalent to (上面的代码相当于):
var NewScript = cc.Class({
properties: {
targetNode1: {
default: null,
type: cc.Node
},
targetNode2: {
default: null,
type: cc.Node
},
targetButton: {
default: null,
type: cc.Button
},
_width: 100,
width: {
get () {
return this._width;
},
set (value) {
this._width = value;
}
},
offset: new cc.Vec2(100, 100)
offsets: {
default: [],
type: cc.Vec2
}
texture: {
default: "",
url: cc.Texture2D
},
}
});
```
*/
export function property(options?: {type?: any; url?: typeof cc.RawAsset; visible?: boolean|(() => boolean); displayName?: string; tooltip?: string; multiline?: boolean; readonly?: boolean; min?: number; max?: number; step?: number; range?: number[]; slide?: boolean; serializable?: boolean; formerlySerializedAs?: string; editorOnly?: boolean; override?: boolean; animatable?: boolean} | any[]|Function|cc.ValueType|number|string|boolean): Function;
export function property(_target: Object, _key: any, _desc?: any): void;
/**
!#en
Makes a CCClass that inherit from component execute in edit mode.
By default, all components are only executed in play mode,
which means they will not have their callback functions executed while the Editor is in edit mode.
!#zh
允许继承自 Component 的 CCClass 在编辑器里执行。
默认情况下，所有 Component 都只会在运行时才会执行，也就是说它们的生命周期回调不会在编辑器里触发。
@example
```js
const {ccclass, executeInEditMode} = cc._decorator;
@ccclass
@executeInEditMode
class NewScript extends cc.Component {
// ...
}
```
*/
export function executeInEditMode(): Function;
export function executeInEditMode(_class: Function): void;
/**
!#en
Automatically add required component as a dependency for the CCClass that inherit from component.
!#zh
为声明为 CCClass 的组件添加依赖的其它组件。当组件添加到节点上时，如果依赖的组件不存在，引擎将会自动将依赖组件添加到同一个节点，防止脚本出错。该设置在运行时同样有效。
@param requiredComponent requiredComponent
@example
```js
const {ccclass, requireComponent} = cc._decorator;
@ccclass
@requireComponent(cc.Sprite)
class SpriteCtrl extends cc.Component {
// ...
}
```
*/
export function requireComponent(requiredComponent: typeof cc.Component): Function;
/**
!#en
The menu path to register a component to the editors "Component" menu. Eg. "Rendering/CameraCtrl".
!#zh
将当前组件添加到组件菜单中，方便用户查找。例如 "Rendering/CameraCtrl"。
@param path The path is the menu represented like a pathname.
For example the menu could be "Rendering/CameraCtrl".
@example
```js
const {ccclass, menu} = cc._decorator;
@ccclass
@menu("Rendering/CameraCtrl")
class NewScript extends cc.Component {
// ...
}
```
*/
export function menu(path: string): Function;
/**
!#en
The execution order of lifecycle methods for Component.
Those less than 0 will execute before while those greater than 0 will execute after.
The order will only affect onLoad, onEnable, start, update and lateUpdate while onDisable and onDestroy will not be affected.
!#zh
设置脚本生命周期方法调用的优先级。优先级小于 0 的组件将会优先执行，优先级大于 0 的组件将会延后执行。优先级仅会影响 onLoad, onEnable, start, update 和 lateUpdate，而 onDisable 和 onDestroy 不受影响。
@param order The execution order of lifecycle methods for Component. Those less than 0 will execute before while those greater than 0 will execute after.
@example
```js
const {ccclass, executionOrder} = cc._decorator;
@ccclass
@executionOrder(1)
class CameraCtrl extends cc.Component {
// ...
}
```
*/
export function executionOrder(order: number): Function;
/**
!#en
Prevents Component of the same type (or subtype) to be added more than once to a Node.
!#zh
防止多个相同类型（或子类型）的组件被添加到同一个节点。
@example
```js
const {ccclass, disallowMultiple} = cc._decorator;
@ccclass
@disallowMultiple
class CameraCtrl extends cc.Component {
// ...
}
```
*/
export function disallowMultiple(): Function;
export function disallowMultiple(_class: Function): void;
/**
!#en
If specified, the editor's scene view will keep updating this node in 60 fps when it is selected, otherwise, it will update only if necessary.
This property is only available if executeInEditMode is true.
!#zh
当指定了 "executeInEditMode" 以后，playOnFocus 可以在选中当前组件所在的节点时，提高编辑器的场景刷新频率到 60 FPS，否则场景就只会在必要的时候进行重绘。
@example
```js
const {ccclass, playOnFocus, executeInEditMode} = cc._decorator;
@ccclass
@executeInEditMode
@playOnFocus
class CameraCtrl extends cc.Component {
// ...
}
```
*/
export function playOnFocus(): Function;
export function playOnFocus(_class: Function): void;
/**
!#en
Specifying the url of the custom html to draw the component in **Properties**.
!#zh
自定义当前组件在 **属性检查器** 中渲染时所用的网页 url。
@param url url
@example
```js
const {ccclass, inspector} = cc._decorator;
@ccclass
@inspector("packages://inspector/inspectors/comps/camera-ctrl.js")
class NewScript extends cc.Component {
// ...
}
```
*/
export function inspector(path: string): Function;
/**
!#en
The custom documentation URL.
!#zh
指定当前组件的帮助文档的 url，设置过后，在 **属性检查器** 中就会出现一个帮助图标，用户点击将打开指定的网页。
@param url url
@example
```js
const {ccclass, help} = cc._decorator;
@ccclass
@help("app://docs/html/components/spine.html")
class NewScript extends cc.Component {
// ...
}
```
*/
export function help(path: string): Function;
/**
NOTE:
The old mixins implemented in cc.Class(ES5) behaves exact the same as multiple inheritance.
But since ES6, class constructor can't be function-called and class methods become non-enumerable,
so we can not mix in ES6 Classes.
See:
[https://esdiscuss.org/topic/traits-are-now-impossible-in-es6-until-es7-since-rev32](https://esdiscuss.org/topic/traits-are-now-impossible-in-es6-until-es7-since-rev32)
One possible solution (but IDE unfriendly):
[http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes](http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/)
NOTE:
You must manually call mixins constructor, this is different from cc.Class(ES5).
@param ctor constructors to mix, only support ES5 constructors or classes defined by using `cc.Class`,
not support ES6 Classes.
@example
```js
const {ccclass, mixins} = cc._decorator;
class Animal { ... }
const Fly = cc.Class({
constructor () { ... }
});
@ccclass
@mixins(cc.EventTarget, Fly)
class Bird extends Animal {
constructor () {
super();
// You must manually call mixins constructor, this is different from cc.Class(ES5)
cc.EventTarget.call(this);
Fly.call(this);
}
// ...
}
```
*/
export function mixins(ctor: Function, ...rest: Function[]): Function;
}
/** This module provides some JavaScript utilities.
All members can be accessed with "cc.js". */
declare module cc.js {
/**
Check the obj whether is number or not
If a number is created by using 'new Number(10086)', the typeof it will be "object"...
Then you can use this function if you care about this case.
@param obj obj
*/
export function isNumber(obj: any): boolean;
/**
Check the obj whether is string or not.
If a string is created by using 'new String("blabla")', the typeof it will be "object"...
Then you can use this function if you care about this case.
@param obj obj
*/
export function isString(obj: any): boolean;
/**
This method is deprecated, use cc.js.mixin please.
Copy all properties not defined in obj from arguments[1...n]
@param obj object to extend its properties
@param sourceObj source object to copy properties from
*/
export function addon(obj: any, ...sourceObj: any[]): any;
/**
copy all properties from arguments[1...n] to obj
@param obj obj
@param sourceObj sourceObj
*/
export function mixin(obj: any, ...sourceObj: any[]): any;
/**
Derive the class from the supplied base class.
Both classes are just native javascript constructors, not created by cc.Class, so
usually you will want to inherit using {{#crossLink "cc/Class:method"}}cc.Class {{/crossLink}} instead.
@param cls cls
@param base the baseclass to inherit
*/
export function extend(cls: Function, base: Function): Function;
/**
Get super class
@param ctor the constructor of subclass
*/
export function getSuper(ctor: Function): Function;
/**
Removes all enumerable properties from object
@param obj obj
*/
export function clear(obj: any): void;
/**
Get property descriptor in object and all its ancestors
@param obj obj
@param name name
*/
export function getPropertyDescriptor(obj: any, name: string): any;
/**
Define value, just help to call Object.defineProperty.
The configurable will be true.
@param obj obj
@param prop prop
@param value value
@param writable writable
@param enumerable enumerable
*/
export function value(obj: any, prop: string, value: any, writable?: boolean, enumerable?: boolean): void;
/**
Define get set accessor, just help to call Object.defineProperty(...)
@param obj obj
@param prop prop
@param getter getter
@param setter setter
@param enumerable enumerable
*/
export function getset(obj: any, prop: string, getter: Function, setter: Function, enumerable?: boolean): void;
/**
Define get accessor, just help to call Object.defineProperty(...)
@param obj obj
@param prop prop
@param getter getter
@param enumerable enumerable
@param configurable configurable
*/
export function get(obj: any, prop: string, getter: Function, enumerable?: boolean, configurable?: boolean): void;
/**
Define set accessor, just help to call Object.defineProperty(...)
@param obj obj
@param prop prop
@param setter setter
@param enumerable enumerable
@param configurable configurable
*/
export function set(obj: any, prop: string, setter: Function, enumerable?: boolean, configurable?: boolean): void;
/**
Get class name of the object, if object is just a {} (and which class named 'Object'), it will return "".
(modified from the code from this stackoverflow post)
@param objOrCtor instance or constructor
*/
export function getClassName(objOrCtor: any|Function): string;
/**
Register the class by specified name manually
@param className className
@param constructor constructor
*/
export function setClassName(className: string, constructor: Function): void;
/**
Unregister a class from fireball.
If you dont need a registered class anymore, you should unregister the class so that Fireball will not keep its reference anymore.
Please note that its still your responsibility to free other references to the class.
@param constructor the class you will want to unregister, any number of classes can be added
*/
export function unregisterClass(...constructor: Function[]): void;
/**
Get the registered class by name
@param classname classname
*/
export function getClassByName(classname: string): Function;
/**
Defines a polyfill field for obsoleted codes.
@param obj YourObject or YourClass.prototype
@param obsoleted "OldParam" or "YourClass.OldParam"
@param newPropName "NewParam"
@param writable writable
*/
export function obsolete(obj: any, obsoleted: string, newPropName: string, writable?: boolean): void;
/**
Defines all polyfill fields for obsoleted codes corresponding to the enumerable properties of props.
@param obj YourObject or YourClass.prototype
@param objName "YourObject" or "YourClass"
@param props props
@param writable writable
*/
export function obsoletes(obj: any, objName: any, props: any, writable?: boolean): void;
/**
A string tool to construct a string with format string.
@param msg A JavaScript string containing zero or more substitution strings (%s).
@param subst JavaScript objects with which to replace substitution strings within msg. This gives you additional control over the format of the output.
@example
```js
cc.js.formatStr("a: %s, b: %s", a, b);
cc.js.formatStr(a, b, c);
```
*/
export function formatStr(msg: string|any, ...subst: any[]): string;
/**
!#en
A simple wrapper of `Object.create(null)` which ensures the return object have no prototype (and thus no inherited members). So we can skip `hasOwnProperty` calls on property lookups. It is a worthwhile optimization than the `{}` literal when `hasOwnProperty` calls are necessary.
!#zh
该方法是对 `Object.create(null)` 的简单封装。`Object.create(null)` 用于创建无 prototype （也就无继承）的空对象。这样我们在该对象上查找属性时，就不用进行 `hasOwnProperty` 判断。在需要频繁判断 `hasOwnProperty` 时，使用这个方法性能会比 `{}` 更高。
@param forceDictMode Apply the delete operator to newly created map object. This causes V8 to put the object in "dictionary mode" and disables creation of hidden classes which are very expensive for objects that are constantly changing shape.
*/
export function createMap(forceDictMode?: boolean): any;
/** undefined */
export class array {
/**
Removes the array item at the specified index.
@param array array
@param index index
*/
static removeAt(array: any[], index: number): void;
/**
Removes the array item at the specified index.
It's faster but the order of the array will be changed.
@param array array
@param index index
*/
static fastRemoveAt(array: any[], index: number): void;
/**
Removes the first occurrence of a specific object from the array.
@param array array
@param value value
*/
static remove(array: any[], value: any): boolean;
/**
Removes the first occurrence of a specific object from the array.
It's faster but the order of the array will be changed.
@param array array
@param value value
*/
static fastRemove(array: any[], value: number): void;
/**
Verify array's Type
@param array array
@param type type
*/
static verifyType(array: any[], type: Function): boolean;
/**
Removes from array all values in minusArr. For each Value in minusArr, the first matching instance in array will be removed.
@param array Source Array
@param minusArr minus Array
*/
static removeArray(array: any[], minusArr: any[]): void;
/**
Inserts some objects at index
@param array array
@param addObjs addObjs
@param index index
*/
static appendObjectsAt(array: any[], addObjs: any[], index: number): any[];
/**
Exact same function as Array.prototype.indexOf.
HACK: ugliy hack for Baidu mobile browser compatibility, stupid Baidu guys modify Array.prototype.indexOf for all pages loaded, their version changes strict comparison to non-strict comparison, it also ignores the second parameter of the original API, and this will cause event handler enter infinite loop.
Baidu developers, if you ever see this documentation, here is the standard: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf, Seriously!
@param searchElement Element to locate in the array.
@param fromIndex The index to start the search at
*/
static indexOf(searchElement: any, fromIndex?: number): number;
/**
Determines whether the array contains a specific value.
@param array array
@param value value
*/
static contains(array: any[], value: any): boolean;
/**
Copy an array's item to a new array (its performance is better than Array.slice)
@param array array
*/
static copy(array: any[]): any[];
}
/** !#en
A fixed-length object pool designed for general type.
The implementation of this object pool is very simple,
it can helps you to improve your game performance for objects which need frequent release and recreate operations
!#zh
长度固定的对象缓存池，可以用来缓存各种对象类型。
这个对象池的实现非常精简，它可以帮助您提高游戏性能，适用于优化对象的反复创建和销毁。 */
export class Pool {
/**
!#en
Constructor for creating an object pool for the specific object type.
You can pass a callback argument for process the cleanup logic when the object is recycled.
!#zh
使用构造函数来创建一个指定对象类型的对象池，您可以传递一个回调函数，用于处理对象回收时的清理逻辑。
@param cleanupFunc the callback method used to process the cleanup logic when the object is recycled.
@param size initializes the length of the array
*/
constructor(cleanupFunc: (obj: any) => void, size: number);
constructor(size: number);
/**
!#en
Get and initialize an object from pool. This method defaults to null and requires the user to implement it.
!#zh
获取并初始化对象池中的对象。这个方法默认为空，需要用户自己实现。
@param params parameters to used to initialize the object
*/
get(...params: any[]): any;
/** !#en
The current number of available objects, the default is 0, it will gradually increase with the recycle of the object,
the maximum will not exceed the size specified when the constructor is called.
!#zh
当前可用对象数量，一开始默认是 0，随着对象的回收会逐渐增大，最大不会超过调用构造函数时指定的 size。 */
count: number;
/**
!#en
Get an object from pool, if no available object in the pool, null will be returned.
!#zh
获取对象池中的对象，如果对象池没有可用对象，则返回空。
*/
_get(): any;
/**
!#en Put an object into the pool.
!#zh 向对象池返还一个不再需要的对象。
*/
put(): void;
/**
!#en Resize the pool.
!#zh 设置对象池容量。
*/
resize(): void;
}
}
declare namespace dragonBones {
/**
* @private
*/
const enum ArmatureType {
Armature = 0,
MovieClip = 1,
Stage = 2,
}
/**
* @private
*/
const enum DisplayType {
Image = 0,
Armature = 1,
Mesh = 2,
}
/**
* @private
*/
const enum ExtensionType {
FFD = 0,
AdjustColor = 10,
BevelFilter = 11,
BlurFilter = 12,
DropShadowFilter = 13,
GlowFilter = 14,
GradientBevelFilter = 15,
GradientGlowFilter = 16,
}
/**
* @private
*/
const enum EventType {
Frame = 10,
Sound = 11,
}
/**
* @private
*/
const enum ActionType {
Play = 0,
Stop = 1,
GotoAndPlay = 2,
GotoAndStop = 3,
FadeIn = 4,
FadeOut = 5,
}
/**
* @private
*/
const enum BlendMode {
Normal = 0,
Add = 1,
Alpha = 2,
Darken = 3,
Difference = 4,
Erase = 5,
HardLight = 6,
Invert = 7,
Layer = 8,
Lighten = 9,
Multiply = 10,
Overlay = 11,
Screen = 12,
Subtract = 13,
}
/**
* @private
*/
interface Map {
[key: string]: T;
}
/**
* DragonBones
*/
class DragonBones {
/**
* @private
*/
static PI_D: number;
/**
* @private
*/
static PI_H: number;
/**
* @private
*/
static PI_Q: number;
/**
* @private
*/
static ANGLE_TO_RADIAN: number;
/**
* @private
*/
static RADIAN_TO_ANGLE: number;
/**
* @private
*/
static SECOND_TO_MILLISECOND: number;
static VERSION: string;
/**
* @private
*/
static debug: boolean;
/**
* @private
*/
static debugDraw: boolean;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 基础对象。
* @version DragonBones 4.5
*/
abstract class BaseObject {
private static _hashCode;
private static _defaultMaxCount;
private static _maxCountMap;
private static _poolsMap;
private static _returnObject(object);
/**
* @language zh_CN
* 设置每种对象池的最大缓存数量。
* @param objectConstructor 对象类。
* @param maxCount 最大缓存数量。 (设置为 0 则不缓存)
* @version DragonBones 4.5
*/
static setMaxCount(objectConstructor: typeof BaseObject, maxCount: number): void;
/**
* @language zh_CN
* 清除对象池缓存的对象。
* @param objectConstructor 对象类。 (不设置则清除所有缓存)
* @version DragonBones 4.5
*/
static clearPool(objectConstructor?: typeof BaseObject): void;
/**
* @language zh_CN
* 从对象池中创建指定对象。
* @param objectConstructor 对象类。
* @version DragonBones 4.5
*/
static borrowObject(objectConstructor: {
new (): T;
}): T;
/**
* @language zh_CN
* 对象的唯一标识。
* @version DragonBones 4.5
*/
hashCode: number;
/**
* @private
*/
protected abstract _onClear(): void;
/**
* @language zh_CN
* 清除数据并返还对象池。
* @version DragonBones 4.5
*/
returnToPool(): void;
}
}
declare namespace dragonBones {
}
declare namespace dragonBones {
/**
* @language zh_CN
* 动画混合时，使用的淡出方式。
* @see dragonBones.Animation#fadeIn()
* @version DragonBones 4.5
*/
const enum AnimationFadeOutMode {
/**
* @language zh_CN
* 不淡出动画。
* @version DragonBones 4.5
*/
None = 0,
/**
* @language zh_CN
* 淡出同层的动画。
* @version DragonBones 4.5
*/
SameLayer = 1,
/**
* @language zh_CN
* 淡出同组的动画。
* @version DragonBones 4.5
*/
SameGroup = 2,
/**
* @language zh_CN
* 淡出同层并且同组的动画。
* @version DragonBones 4.5
*/
SameLayerAndGroup = 3,
/**
* @language zh_CN
* 淡出所有动画。
* @version DragonBones 4.5
*/
All = 4,
}
/**
* @language zh_CN
* 播放动画组件接口。 (Armature 和 WordClock 都实现了该接口)
* 任何实现了此接口的实例都可以加到 WorldClock 时钟中，由时钟统一控制动画的播放。
* @see dragonBones.WorldClock
* @see dragonBones.Armature
* @version DragonBones 3.0
*/
interface IAnimateble {
/**
* @language zh_CN
* 更新一个指定的时间。
* @param passedTime 前进的时间。 (以秒为单位)
* @version DragonBones 3.0
*/
advanceTime(passedTime: number): void;
}
/**
* @language zh_CN
* 动画控制器，用来播放动画数据，管理动画状态。
* @see dragonBones.AnimationData
* @see dragonBones.AnimationState
* @version DragonBones 3.0
*/
class Animation extends BaseObject {
/**
* @private
*/
private static _sortAnimationState(a, b);
/**
* @private
*/
static toString(): string;
/**
* @language zh_CN
* 动画的播放速度。 [(-N~0): 倒转播放, 0: 停止播放, (0~1): 慢速播放, 1: 正常播放, (1~N): 快速播放]
* @default 1
* @version DragonBones 3.0
*/
timeScale: number;
/**
* @private
*/
_armature: Armature;
private _isPlaying;
private _time;
private _duration;
private _lastAnimationState;
private _animations;
private _animationNames;
private _animationStates;
/**
* @inheritDoc
*/
protected _onClear(): void;
private _fadeOut(fadeOutTime, layer, group, fadeOutMode, pauseFadeOut);
/**
* @language zh_CN
* 清除所有正在播放的动画状态。
* @version DragonBones 4.5
*/
reset(): void;
/**
* @language zh_CN
* 暂停播放动画。
* @param animationName 动画状态的名称，如果未设置，则暂停所有动画状态。
* @see dragonBones.AnimationState
* @version DragonBones 3.0
*/
stop(animationName?: string): void;
/**
* @language zh_CN
* 播放动画。
* @param animationName 动画数据的名称，如果未设置，则播放默认动画，或将暂停状态切换为播放状态，或重新播放上一个正在播放的动画。
* @param playTimes 动画需要播放的次数。 [-1: 使用动画数据默认值, 0: 无限循环播放, [1~N]: 循环播放 N 次]
* @returns 返回控制这个动画数据的动画状态。
* @see dragonBones.AnimationState
* @version DragonBones 3.0
*/
play(animationName?: string, playTimes?: number): AnimationState;
/**
* @language zh_CN
* 淡入播放指定名称的动画。
* @param animationName 动画数据的名称。
* @param playTimes 循环播放的次数。 [-1: 使用数据默认值, 0: 无限循环播放, [1~N]: 循环播放 N 次]
* @param fadeInTime 淡入的时间。 [-1: 使用数据默认值, [0~N]: N 秒淡入完毕] (以秒为单位)
* @param layer 混合的图层，图层高会优先获取混合权重。
* @param group 混合的组，用于给动画状态编组，方便混合淡出控制。
* @param fadeOutMode 淡出的模式。
* @param additiveBlending 以叠加的形式混合。
* @param displayControl 是否对显示对象属性可控。
* @param pauseFadeOut 暂停需要淡出的动画。
* @param pauseFadeIn 暂停需要淡入的动画，直到淡入结束才开始播放。
* @returns 返回控制这个动画数据的动画状态。
* @see dragonBones.AnimationFadeOutMode
* @see dragonBones.AnimationState
* @version DragonBones 4.5
*/
fadeIn(animationName: string, fadeInTime?: number, playTimes?: number, layer?: number, group?: string, fadeOutMode?: AnimationFadeOutMode, additiveBlending?: boolean, displayControl?: boolean, pauseFadeOut?: boolean, pauseFadeIn?: boolean): AnimationState;
/**
* @language zh_CN
* 指定名称的动画从指定时间开始播放。
* @param animationName 动画数据的名称。
* @param time 时间。 (以秒为单位)
* @param playTimes 动画循环播放的次数。 [-1: 使用动画数据默认值, 0: 无限循环播放, [1~N]: 循环播放 N 次]
* @param toTime 播放到指定的时间，如果未设置则播放整个动画。
* @returns 返回控制这个动画数据的动画状态。
* @see dragonBones.AnimationState
* @version DragonBones 4.5
*/
gotoAndPlayByTime(animationName: string, time?: number, playTimes?: number, toTime?: number): AnimationState;
/**
* @language zh_CN
* 指定名称的动画从指定帧开始播放。
* @param animationName 动画数据的名称。
* @param frame 帧。
* @param playTimes 动画循环播放的次数。[-1: 使用动画数据默认值, 0: 无限循环播放, [1~N]: 循环播放 N 次]
* @param toFrame 播放到指定的帧，如果未设置则播放整个动画。
* @returns 返回控制这个动画数据的动画状态。
* @see dragonBones.AnimationState
* @version DragonBones 4.5
*/
gotoAndPlayByFrame(animationName: string, frame?: number, playTimes?: number, toFrame?: number): AnimationState;
/**
* @language zh_CN
* 指定名称的动画从指定进度开始播放。
* @param animationName 动画数据的名称。
* @param progress 进度。 [0~1]
* @param playTimes 动画循环播放的次数。[-1: 使用动画数据默认值, 0: 无限循环播放, [1~N]: 循环播放 N 次]
* @param toProgress 播放到指定的进度，如果未设置则播放整个动画。
* @returns 返回控制这个动画数据的动画状态。
* @see dragonBones.AnimationState
* @version DragonBones 4.5
*/
gotoAndPlayByProgress(animationName: string, progress?: number, playTimes?: number, toProgress?: number): AnimationState;
/**
* @language zh_CN
* 播放指定名称的动画到指定的时间并停止。
* @param animationName 动画数据的名称。
* @param time 时间。 (以秒为单位)
* @returns 返回控制这个动画数据的动画状态。
* @see dragonBones.AnimationState
* @version DragonBones 4.5
*/
gotoAndStopByTime(animationName: string, time?: number): AnimationState;
/**
* @language zh_CN
* 播放指定名称的动画到指定的帧并停止。
* @param animationName 动画数据的名称。
* @param frame 帧。
* @returns 返回控制这个动画数据的动画状态。
* @see dragonBones.AnimationState
* @version DragonBones 4.5
*/
gotoAndStopByFrame(animationName: string, frame?: number): AnimationState;
/**
* @language zh_CN
* 播放指定名称的动画到指定的进度并停止。
* @param animationName 动画数据的名称。
* @param progress 进度。 [0~1]
* @returns 返回控制这个动画数据的动画状态。
* @see dragonBones.AnimationState
* @version DragonBones 4.5
*/
gotoAndStopByProgress(animationName: string, progress?: number): AnimationState;
/**
* @language zh_CN
* 获取指定名称的动画状态。
* @param animationName 动画状态的名称。
* @see dragonBones.AnimationState
* @version DragonBones 3.0
*/
getState(animationName: string): AnimationState;
/**
* @language zh_CN
* 是否包含指定名称的动画数据。
* @param animationName 动画数据的名称。
* @see dragonBones.AnimationData
* @version DragonBones 3.0
*/
hasAnimation(animationName: string): boolean;
/**
* @language zh_CN
* 动画是否处于播放状态。
* @version DragonBones 3.0
*/
isPlaying: boolean;
/**
* @language zh_CN
* 所有动画状态是否均已播放完毕。
* @see dragonBones.AnimationState
* @version DragonBones 3.0
*/
isCompleted: boolean;
/**
* @language zh_CN
* 上一个正在播放的动画状态的名称。
* @see #lastAnimationState
* @version DragonBones 3.0
*/
lastAnimationName: string;
/**
* @language zh_CN
* 上一个正在播放的动画状态。
* @see dragonBones.AnimationState
* @version DragonBones 3.0
*/
lastAnimationState: AnimationState;
/**
* @language zh_CN
* 所有动画数据名称。
* @see #animations
* @version DragonBones 4.5
*/
animationNames: Array;
/**
* @language zh_CN
* 所有的动画数据。
* @see dragonBones.AnimationData
* @version DragonBones 4.5
*/
animations: Map;
/**
* @deprecated
* @see #play()
* @see #fadeIn()
* @see #gotoAndPlayByTime()
* @see #gotoAndPlayByFrame()
* @see #gotoAndPlayByProgress()
*/
gotoAndPlay(animationName: string, fadeInTime?: number, duration?: number, playTimes?: number, layer?: number, group?: string, fadeOutMode?: AnimationFadeOutMode, pauseFadeOut?: boolean, pauseFadeIn?: boolean): AnimationState;
/**
* @deprecated
* @see #gotoAndStopByTime()
* @see #gotoAndStopByFrame()
* @see #gotoAndStopByProgress()
*/
gotoAndStop(animationName: string, time?: number): AnimationState;
/**
* @deprecated
* @see #animationNames
* @see #animations
*/
animationList: Array;
/**
* @language zh_CN
* @deprecated
* @see #animationNames
* @see #animations
*/
animationDataList: Array;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 动画状态，播放动画时产生，可以对单个动画的播放进行更细致的控制和调节。
* @see dragonBones.Animation
* @see dragonBones.AnimationData
* @version DragonBones 3.0
*/
class AnimationState extends BaseObject {
/**
* @private
*/
static stateActionEnabled: boolean;
/**
* @private
*/
static toString(): string;
/**
* @language zh_CN
* 是否对插槽的颜色，显示序列索引，深度排序，行为等拥有控制的权限。
* @see dragonBones.Slot#displayController
* @version DragonBones 3.0
*/
displayControl: boolean;
/**
* @language zh_CN
* 是否以叠加的方式混合动画。
* @version DragonBones 3.0
*/
additiveBlending: boolean;
/**
* @private
*/
actionEnabled: boolean;
/**
* @language zh_CN
* 需要播放的次数。 [0: 无限循环播放, [1~N]: 循环播放 N 次]
* @version DragonBones 3.0
*/
playTimes: number;
/**
* @language zh_CN
* 播放速度。 [(-N~0): 倒转播放, 0: 停止播放, (0~1): 慢速播放, 1: 正常播放, (1~N): 快速播放]
* @default 1
* @version DragonBones 3.0
*/
timeScale: number;
/**
* @language zh_CN
* 进行动画混合时的权重。
* @default 1
* @version DragonBones 3.0
*/
weight: number;
/**
* @language zh_CN
* 自动淡出时需要的时间，当设置一个大于等于 0 的值，动画状态将会在播放完成后自动淡出。 (以秒为单位)
* @default -1
* @version DragonBones 3.0
*/
autoFadeOutTime: number;
/**
* @private
*/
fadeTotalTime: number;
/**
* @private
*/
private _isPlaying;
/**
* @private
*/
private _isPausePlayhead;
/**
* @private
*/
private _fadeTime;
/**
* @private
*/
private _time;
/**
* @private
*/
private _name;
/**
* @private
*/
private _armature;
/**
* @private
*/
private _animationData;
/**
* @private
*/
private _zOrderTimeline;
/**
* @private
*/
private _boneMask;
/**
* @private
*/
private _boneTimelines;
/**
* @private
*/
private _slotTimelines;
/**
* @private
*/
private _ffdTimelines;
/**
* @inheritDoc
*/
protected _onClear(): void;
private _updateTimelineStates();
private _advanceFadeTime(passedTime);
/**
* @language zh_CN
* 继续播放。
* @version DragonBones 3.0
*/
play(): void;
/**
* @language zh_CN
* 暂停播放。
* @version DragonBones 3.0
*/
stop(): void;
/**
* @language zh_CN
* 淡出动画。
* @param fadeOutTime 淡出时间。 (以秒为单位)
* @param pausePlayhead 淡出时是否暂停动画。 [true: 暂停, false: 不暂停]
* @version DragonBones 3.0
*/
fadeOut(fadeOutTime: number, pausePlayhead?: boolean): void;
/**
* @language zh_CN
* 是否包含指定的骨骼遮罩。
* @param name 指定的骨骼名称。
* @version DragonBones 3.0
*/
containsBoneMask(name: string): boolean;
/**
* @language zh_CN
* 添加指定的骨骼遮罩。
* @param boneName 指定的骨骼名称。
* @param recursive 是否为该骨骼的子骨骼添加遮罩。
* @version DragonBones 3.0
*/
addBoneMask(name: string, recursive?: boolean): void;
/**
* @language zh_CN
* 删除指定的骨骼遮罩。
* @param boneName 指定的骨骼名称。
* @param recursive 是否删除该骨骼的子骨骼遮罩。
* @version DragonBones 3.0
*/
removeBoneMask(name: string, recursive?: boolean): void;
/**
* @language zh_CN
* 删除所有骨骼遮罩。
* @version DragonBones 3.0
*/
removeAllBoneMask(): void;
/**
* @language zh_CN
* 动画图层。
* @see dragonBones.Animation#fadeIn()
* @version DragonBones 3.0
*/
layer: number;
/**
* @language zh_CN
* 动画组。
* @see dragonBones.Animation#fadeIn()
* @version DragonBones 3.0
*/
group: string;
/**
* @language zh_CN
* 动画名称。
* @see dragonBones.AnimationData#name
* @version DragonBones 3.0
*/
name: string;
/**
* @language zh_CN
* 动画数据。
* @see dragonBones.AnimationData
* @version DragonBones 3.0
*/
animationData: AnimationData;
/**
* @language zh_CN
* 是否播放完毕。
* @version DragonBones 3.0
*/
isCompleted: boolean;
/**
* @language zh_CN
* 是否正在播放。
* @version DragonBones 3.0
*/
isPlaying: boolean;
/**
* @language zh_CN
* 当前动画的播放次数。
* @version DragonBones 3.0
*/
currentPlayTimes: number;
/**
* @language zh_CN
* 当前动画的总时间。 (以秒为单位)
* @version DragonBones 3.0
*/
totalTime: number;
/**
* @language zh_CN
* 当前动画的播放时间。 (以秒为单位)
* @version DragonBones 3.0
*/
currentTime: number;
/**
* @deprecated
*/
autoTween: boolean;
/**
* @deprecated
* @see #animationData
*/
clip: AnimationData;
}
}
declare namespace dragonBones {
}
declare namespace dragonBones {
/**
* @language zh_CN
* WorldClock 提供时钟的支持，为每个加入到时钟的 IAnimatable 对象更新时间。
* @see dragonBones.IAnimatable
* @see dragonBones.Armature
* @version DragonBones 3.0
*/
class WorldClock implements IAnimateble {
private static _clock;
/**
* @language zh_CN
* 一个可以直接使用的全局 WorldClock 实例.
* @version DragonBones 3.0
*/
static clock: WorldClock;
/**
* @language zh_CN
* 当前的时间。 (以秒为单位)
* @version DragonBones 3.0
*/
time: number;
/**
* @language zh_CN
* 时间流逝的速度，用于实现动画的变速播放。 [0: 停止播放, (0~1): 慢速播放, 1: 正常播放, (1~N): 快速播放]
* @default 1
* @version DragonBones 3.0
*/
timeScale: number;
private _animatebles;
/**
* @language zh_CN
* 创建一个新的 WorldClock 实例。
* 通常并不需要单独创建 WorldClock 的实例，可以直接使用 WorldClock.clock 静态实例。
* (创建更多独立的 WorldClock 可以更灵活的为需要更新的 IAnimateble 实例分组，实现不同组不同速度的动画播放)
* @version DragonBones 3.0
*/
constructor();
/**
* @language zh_CN
* 为所有的 IAnimatable 实例向前播放一个指定的时间。 (通常这个方法需要在 ENTER_FRAME 事件的响应函数中被调用)
* @param passedTime 前进的时间。 (以秒为单位，当设置为 -1 时将自动计算当前帧与上一帧的时间差)
* @version DragonBones 3.0
*/
advanceTime(passedTime: number): void;
/**
* 是否包含指定的 IAnimatable 实例
* @param value 指定的 IAnimatable 实例。
* @returns [true: 包含，false: 不包含]。
* @version DragonBones 3.0
*/
contains(value: IAnimateble): boolean;
/**
* @language zh_CN
* 添加指定的 IAnimatable 实例。
* @param value IAnimatable 实例。
* @version DragonBones 3.0
*/
add(value: IAnimateble): void;
/**
* @language zh_CN
* 移除指定的 IAnimatable 实例。
* @param value IAnimatable 实例。
* @version DragonBones 3.0
*/
remove(value: IAnimateble): void;
/**
* @language zh_CN
* 清除所有的 IAnimatable 实例。
* @version DragonBones 3.0
*/
clear(): void;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 基础变换对象。
* @version DragonBones 4.5
*/
abstract class TransformObject extends BaseObject {
/**
* @language zh_CN
* 可以用于存储临时数据。
* @version DragonBones 3.0
*/
userData: any;
/**
* @language zh_CN
* 对象的名称。
* @version DragonBones 3.0
*/
name: string;
/**
* @language zh_CN
* 相对于骨架坐标系的矩阵。
* @version DragonBones 3.0
*/
globalTransformMatrix: Matrix;
/**
* @language zh_CN
* 相对于骨架坐标系的变换。
* @see dragonBones.Transform
* @version DragonBones 3.0
*/
global: Transform;
/**
* @language zh_CN
* 相对于骨架或父骨骼坐标系的绑定变换。
* @see dragonBones.Transform
* @version DragonBones 3.0
*/
origin: Transform;
/**
* @language zh_CN
* 相对于骨架或父骨骼坐标系的偏移变换。
* @see dragonBones.Transform
* @version DragonBones 3.0
*/
offset: Transform;
/**
* @private
*/
_armature: Armature;
/**
* @private
*/
_parent: Bone;
/**
* @private
*/
protected _globalTransformMatrix: Matrix;
/**
* @inheritDoc
*/
protected _onClear(): void;
/**
* @language zh_CN
* 所属的骨架。
* @see dragonBones.Armature
* @version DragonBones 3.0
*/
armature: Armature;
/**
* @language zh_CN
* 所属的父骨骼。
* @see dragonBones.Bone
* @version DragonBones 3.0
*/
parent: Bone;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 骨架，是骨骼动画系统的核心，由显示容器、骨骼、插槽、动画、事件系统构成。
* @see dragonBones.ArmatureData
* @see dragonBones.Bone
* @see dragonBones.Slot
* @see dragonBones.Animation
* @see dragonBones.IArmatureDisplay
* @version DragonBones 3.0
*/
class Armature extends BaseObject implements IAnimateble {
/**
* @private
*/
static toString(): string;
private static _onSortSlots(a, b);
/**
* @language zh_CN
* 可以用于存储临时数据。
* @version DragonBones 3.0
*/
userData: any;
/**
* @private
*/
_cacheFrameIndex: number;
/**
* @private
*/
_armatureData: ArmatureData;
/**
* @private
*/
_skinData: SkinData;
/**
* @private
*/
_animation: Animation;
/**
* @private
*/
_display: IArmatureDisplay;
/**
* @private
*/
_eventManager: IEventDispatcher;
private _delayDispose;
private _lockDispose;
private _slotsDirty;
private _replacedTexture;
private _bones;
private _slots;
private _actions;
private _events;
/**
* @inheritDoc
*/
protected _onClear(): void;
private _sortBones();
private _sortSlots();
private _doAction(value);
/**
* @private
*/
_sortZOrder(slotIndices: Array): void;
/**
* @private
*/
_bufferAction(value: ActionData): void;
/**
* @language zh_CN
* 释放骨架。 (会回收到内存池)
* @version DragonBones 3.0
*/
dispose(): void;
/**
* @language zh_CN
* 更新骨架和动画。 (可以使用时钟实例或显示容器来更新)
* @param passedTime 两帧之前的时间间隔。 (以秒为单位)
* @see dragonBones.IAnimateble
* @see dragonBones.WorldClock
* @see dragonBones.IArmatureDisplay
* @version DragonBones 3.0
*/
advanceTime(passedTime: number): void;
/**
* @language zh_CN
* 更新骨骼和插槽的变换。 (当骨骼没有动画状态或动画状态播放完成时，骨骼将不在更新)
* @param boneName 指定的骨骼名称，如果未设置，将更新所有骨骼。
* @param updateSlotDisplay 是否更新插槽的显示对象。
* @see dragonBones.Bone
* @see dragonBones.Slot
* @version DragonBones 3.0
*/
invalidUpdate(boneName?: string, updateSlotDisplay?: boolean): void;
/**
* @language zh_CN
* 获取指定名称的骨骼。
* @param name 骨骼的名称。
* @returns 骨骼。
* @see dragonBones.Bone
* @version DragonBones 3.0
*/
getBone(name: string): Bone;
/**
* @language zh_CN
* 通过显示对象获取骨骼。
* @param display 显示对象。
* @returns 包含这个显示对象的骨骼。
* @see dragonBones.Bone
* @version DragonBones 3.0
*/
getBoneByDisplay(display: any): Bone;
/**
* @language zh_CN
* 获取指定名称的插槽。
* @param name 插槽的名称。
* @returns 插槽。
* @see dragonBones.Slot
* @version DragonBones 3.0
*/
getSlot(name: string): Slot;
/**
* @language zh_CN
* 通过显示对象获取插槽。
* @param display 显示对象。
* @returns 包含这个显示对象的插槽。
* @see dragonBones.Slot
* @version DragonBones 3.0
*/
getSlotByDisplay(display: any): Slot;
/**
* @language zh_CN
* 替换骨架的主贴图，根据渲染引擎的不同，提供不同的贴图数据。
* @param texture 贴图。
* @version DragonBones 4.5
*/
replaceTexture(texture: any): void;
/**
* @language zh_CN
* 获取所有骨骼。
* @see dragonBones.Bone
* @version DragonBones 3.0
*/
getBones(): Array;
/**
* @language zh_CN
* 获取所有插槽。
* @see dragonBones.Slot
* @version DragonBones 3.0
*/
getSlots(): Array;
/**
* @language zh_CN
* 骨架名称。
* @see dragonBones.ArmatureData#name
* @version DragonBones 3.0
*/
name: string;
/**
* @language zh_CN
* 获取骨架数据。
* @see dragonBones.ArmatureData
* @version DragonBones 4.5
*/
armatureData: ArmatureData;
/**
* @language zh_CN
* 获得动画控制器。
* @see dragonBones.Animation
* @version DragonBones 3.0
*/
animation: Animation;
/**
* @language zh_CN
* 获取显示容器，插槽的显示对象都会以此显示容器为父级，根据渲染平台的不同，类型会不同，通常是 DisplayObjectContainer 类型。
* @version DragonBones 3.0
*/
display: IArmatureDisplay | any;
/**
* @language zh_CN
* 获取父插槽。 (当此骨架是某个骨架的子骨架时，可以通过此属性向上查找从属关系)
* @see dragonBones.Slot
* @version DragonBones 4.5
*/
parent: Slot;
/**
* @language zh_CN
* 动画缓存的帧率，当设置一个大于 0 的帧率时，将会开启动画缓存。
* 通过将动画数据缓存在内存中来提高运行性能，会有一定的内存开销。
* 帧率不宜设置的过高，通常跟动画的帧率相当且低于程序运行的帧率。
* 开启动画缓存后，某些功能将会失效，比如 Bone 和 Slot 的 offset 属性等。
* @see dragonBones.DragonBonesData#frameRate
* @see dragonBones.ArmatureData#frameRate
* @version DragonBones 4.5
*/
cacheFrameRate: number;
/**
* @language zh_CN
* 替换骨架的主贴图，根据渲染引擎的不同，提供不同的贴图数据。
* @version DragonBones 4.5
*/
replacedTexture: any;
/**
* @language zh_CN
* 开启动画缓存。
* @param frameRate 动画缓存的帧率
* @see #cacheFrameRate
* @version DragonBones 4.5
*/
enableAnimationCache(frameRate: number): void;
/**
* @language zh_CN
* 是否包含指定类型的事件。
* @param type 事件类型。
* @returns [true: 包含, false: 不包含]
* @version DragonBones 3.0
*/
hasEventListener(type: EventStringType): void;
/**
* @language zh_CN
* 添加事件。
* @param type 事件类型。
* @param listener 事件回调。
* @version DragonBones 3.0
*/
addEventListener(type: EventStringType, listener: Function, target: any): void;
/**
* @language zh_CN
* 移除事件。
* @param type 事件类型。
* @param listener 事件回调。
* @version DragonBones 3.0
*/
removeEventListener(type: EventStringType, listener: Function, target: any): void;
/**
* @deprecated
*/
addBone(value: Bone, parentName?: string): void;
/**
* @deprecated
*/
addSlot(value: Slot, parentName: string): void;
/**
* @deprecated
*/
removeBone(value: Bone): void;
/**
* @deprecated
*/
removeSlot(value: Slot): void;
/**
* @deprecated
* @see #display
*/
getDisplay(): any;
/**
* @deprecated
* @see #cacheFrameRate
*/
enableCache: boolean;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 骨骼，一个骨架中可以包含多个骨骼，骨骼以树状结构组成骨架。
* 骨骼在骨骼动画体系中是最重要的逻辑单元之一，负责动画中的平移旋转缩放的实现。
* @see dragonBones.BoneData
* @see dragonBones.Armature
* @see dragonBones.Slot
* @version DragonBones 3.0
*/
class Bone extends TransformObject {
/**
* @private
*/
static toString(): string;
/**
* @language zh_CN
* 是否继承父骨骼的平移。 [true: 继承, false: 不继承]
* @version DragonBones 3.0
*/
inheritTranslation: boolean;
/**
* @language zh_CN
* 是否继承父骨骼的旋转。 [true: 继承, false: 不继承]
* @version DragonBones 3.0
*/
inheritRotation: boolean;
/**
* @language zh_CN
* 是否继承父骨骼的缩放。 [true: 继承, false: 不继承]
* @version DragonBones 4.5
*/
inheritScale: boolean;
/**
* @language zh_CN
* IK 约束时骨骼方向是否为顺时针方向。 [true: 顺时针, false: 逆时针]
* @version DragonBones 4.5
*/
ikBendPositive: boolean;
/**
* @language zh_CN
* IK 约束的权重。
* @version DragonBones 4.5
*/
ikWeight: number;
/**
* @language zh_CN
* 骨骼长度。
* @version DragonBones 4.5
*/
length: number;
/**
* @private
*/
private _visible;
/**
* @private
*/
private _ikChain;
/**
* @private
*/
private _ikChainIndex;
/**
* @private
*/
private _ik;
/**
* @private
*/
private _bones;
/**
* @private
*/
private _slots;
/**
* @inheritDoc
*/
protected _onClear(): void;
/**
* @private
*/
private _updateGlobalTransformMatrix();
/**
* @private
*/
private _computeIKA();
/**
* @private
*/
private _computeIKB();
/**
* @inheritDoc
*/
_setArmature(value: Armature): void;
/**
* @language zh_CN
* 下一帧更新变换。 (当骨骼没有动画状态或动画状态播放完成时，骨骼将不在更新)
* @version DragonBones 3.0
*/
invalidUpdate(): void;
/**
* @language zh_CN
* 是否包含某个指定的骨骼或插槽。
* @returns [true: 包含，false: 不包含]
* @see dragonBones.TransformObject
* @version DragonBones 3.0
*/
contains(child: TransformObject): boolean;
/**
* @language zh_CN
* 所有的子骨骼。
* @version DragonBones 3.0
*/
getBones(): Array;
/**
* @language zh_CN
* 所有的插槽。
* @see dragonBones.Slot
* @version DragonBones 3.0
*/
getSlots(): Array;
/**
* @private
*/
ikChain: number;
/**
* @private
*/
ikChainIndex: number;
/**
* @language zh_CN
* 当前的 IK 约束目标。
* @version DragonBones 4.5
*/
ik: Bone;
/**
* @language zh_CN
* 控制此骨骼所有插槽的显示。
* @default true
* @see dragonBones.Slot
* @version DragonBones 3.0
*/
visible: boolean;
/**
* @deprecated
* @see dragonBones.Armature#getSlot()
*/
slot: Slot;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 骨架显示容器和事件的接口。
* @see dragonBones.Armature#display
* @version DragonBones 4.5
*/
interface IArmatureDisplay extends IEventDispatcher {
/**
* @language zh_CN
* 释放显示对象和骨架。
* @version DragonBones 4.5
*/
dispose(): void;
/**
* @language zh_CN
* 获取使用这个显示容器的骨架。
* @readOnly
* @see dragonBones.Armature
* @version DragonBones 4.5
*/
armature: Armature;
/**
* @language zh_CN
* 获取使用骨架的动画控制器。
* @readOnly
* @see dragonBones.Animation
* @version DragonBones 4.5
*/
animation: Animation;
/**
* @language zh_CN
* 由显示容器来更新骨架和动画。
* @param on 开启或关闭显示容器对骨架与动画的更新。
* @version DragonBones 4.5
*/
advanceTimeBySelf(on: boolean): void;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 插槽，附着在骨骼上，控制显示对象的显示状态和属性。
* 一个骨骼上可以包含多个插槽。
* 一个插槽中可以包含多个显示对象，同一时间只能显示其中的一个显示对象，但可以在动画播放的过程中切换显示对象实现帧动画。
* 显示对象可以是普通的图片纹理，也可以是子骨架的显示容器，网格显示对象，还可以是自定义的其他显示对象。
* @see dragonBones.Armature
* @see dragonBones.Bone
* @see dragonBones.SlotData
* @version DragonBones 3.0
*/
abstract class Slot extends TransformObject {
private static _helpPoint;
private static _helpMatrix;
/**
* @language zh_CN
* 子骨架是否继承父骨架的动画。 [true: 继承, false: 不继承]
* @default true
* @version DragonBones 4.5
*/
inheritAnimation: boolean;
/**
* @language zh_CN
* 显示对象受到控制的对象，应设置为动画状态的名称或组名称，设置为 null 则表示受所有的动画状态控制。
* @default null
* @see dragonBones.AnimationState#displayControl
* @see dragonBones.AnimationState#name
* @see dragonBones.AnimationState#group
* @version DragonBones 4.5
*/
displayController: string;
/**
* @private
*/
_zOrder: number;
/**
* @private
*/
_pivotX: number;
/**
* @private
*/
_pivotY: number;
/**
* @private
*/
_displayDataSet: SlotDisplayDataSet;
/**
* @private
*/
_meshData: MeshData;
/**
* @private
*/
_childArmature: Armature;
/**
* @private
*/
_rawDisplay: any;
/**
* @private
*/
_meshDisplay: any;
/**
* @private
*/
_cacheFrames: Array;
/**
* @private
*/
_colorTransform: ColorTransform;
/**
* @private
*/
_ffdVertices: Array;
/**
* @private
*/
_replacedDisplayDataSet: Array;
/**
* @private
*/
protected _displayDirty: boolean;
/**
* @private
*/
protected _blendModeDirty: boolean;
/**
* @private
*/
protected _originDirty: boolean;
/**
* @private
*/
protected _transformDirty: boolean;
/**
* @private
*/
protected _displayIndex: number;
/**
* @private
*/
protected _blendMode: BlendMode;
/**
* @private
*/
protected _display: any;
/**
* @private
*/
protected _localMatrix: Matrix;
/**
* @private
*/
protected _displayList: Array;
/**
* @private
*/
protected _meshBones: Array;
/**
* @inheritDoc
*/
protected _onClear(): void;
/**
* @private
*/
protected abstract _initDisplay(value: any): void;
/**
* @private
*/
protected abstract _disposeDisplay(value: any): void;
/**
* @private
*/
protected abstract _onUpdateDisplay(): void;
/**
* @private
*/
protected abstract _addDisplay(): void;
/**
* @private
*/
protected abstract _replaceDisplay(value: any): void;
/**
* @private
*/
protected abstract _removeDisplay(): void;
/**
* @private
*/
protected abstract _updateZOrder(): void;
/**
* @private
*/
protected abstract _updateBlendMode(): void;
/**
* @private
*/
protected abstract _updateColor(): void;
/**
* @private
*/
protected abstract _updateFilters(): void;
/**
* @private
*/
protected abstract _updateFrame(): void;
/**
* @private
*/
protected abstract _updateMesh(): void;
/**
* @private
*/
protected abstract _updateTransform(): void;
private _isMeshBonesUpdate();
/**
* @private
*/
protected _updatePivot(rawDisplayData: DisplayData, currentDisplayData: DisplayData, currentTextureData: TextureData): void;
/**
* @private
*/
protected _updateDisplay(): void;
/**
* @private
*/
protected _updateLocalTransformMatrix(): void;
/**
* @private
*/
protected _updateGlobalTransformMatrix(): void;
/**
* @private Factory
*/
_setDisplayList(value: Array): boolean;
/**
* @language zh_CN
* 在下一帧更新显示对象的状态。
* @version DragonBones 4.5
*/
invalidUpdate(): void;
/**
* @private
*/
rawDisplay: any;
/**
* @private
*/
MeshDisplay: any;
/**
* @language zh_CN
* 此时显示的显示对象在显示列表中的索引。
* @version DragonBones 4.5
*/
displayIndex: number;
/**
* @language zh_CN
* 包含显示对象或子骨架的显示列表。
* @version DragonBones 3.0
*/
displayList: Array;
/**
* @language zh_CN
* 此时显示的显示对象。
* @version DragonBones 3.0
*/
display: any;
/**
* @language zh_CN
* 此时显示的子骨架。
* @see dragonBones.Armature
* @version DragonBones 3.0
*/
childArmature: Armature;
/**
* @deprecated
* @see #display
*/
getDisplay(): any;
/**
* @deprecated
* @see #display
*/
setDisplay(value: any): void;
}
}
declare namespace dragonBones {
/**
* @private
*/
type EventStringType = string | "start" | "loopComplete" | "complete" | "fadeIn" | "fadeInComplete" | "fadeOut" | "fadeOutComplete" | "frameEvent" | "soundEvent";
/**
* @language zh_CN
* 事件接口。
* @version DragonBones 4.5
*/
interface IEventDispatcher {
/**
* @language zh_CN
* 是否包含指定类型的事件。
* @param type 事件类型。
* @returns [true: 包含, false: 不包含]
* @version DragonBones 4.5
*/
hasEvent(type: EventStringType): boolean;
/**
* @language zh_CN
* 添加事件。
* @param type 事件类型。
* @param listener 事件回调。
* @version DragonBones 4.5
*/
addEvent(type: EventStringType, listener: Function, target: any): void;
/**
* @language zh_CN
* 移除事件。
* @param type 事件类型。
* @param listener 事件回调。
* @version DragonBones 4.5
*/
removeEvent(type: EventStringType, listener: Function, target: any): void;
}
/**
* @language zh_CN
* 事件数据。
* @version DragonBones 4.5
*/
class EventObject extends BaseObject {
/**
* @language zh_CN
* 动画开始。
* @version DragonBones 4.5
*/
static START: string;
/**
* @language zh_CN
* 动画循环播放一次完成。
* @version DragonBones 4.5
*/
static LOOP_COMPLETE: string;
/**
* @language zh_CN
* 动画播放完成。
* @version DragonBones 4.5
*/
static COMPLETE: string;
/**
* @language zh_CN
* 动画淡入开始。
* @version DragonBones 4.5
*/
static FADE_IN: string;
/**
* @language zh_CN
* 动画淡入完成。
* @version DragonBones 4.5
*/
static FADE_IN_COMPLETE: string;
/**
* @language zh_CN
* 动画淡出开始。
* @version DragonBones 4.5
*/
static FADE_OUT: string;
/**
* @language zh_CN
* 动画淡出完成。
* @version DragonBones 4.5
*/
static FADE_OUT_COMPLETE: string;
/**
* @language zh_CN
* 动画帧事件。
* @version DragonBones 4.5
*/
static FRAME_EVENT: string;
/**
* @language zh_CN
* 动画声音事件。
* @version DragonBones 4.5
*/
static SOUND_EVENT: string;
/**
* @private
*/
static toString(): string;
/**
* @language zh_CN
* 事件类型。
* @version DragonBones 4.5
*/
type: EventStringType;
/**
* @language zh_CN
* 事件名称。 (帧标签的名称或声音的名称)
* @version DragonBones 4.5
*/
name: string;
/**
* @language zh_CN
* 扩展的数据。
* @version DragonBones 4.5
*/
data: any;
/**
* @language zh_CN
* 发出事件的骨架。
* @version DragonBones 4.5
*/
armature: Armature;
/**
* @language zh_CN
* 发出事件的骨骼。
* @version DragonBones 4.5
*/
bone: Bone;
/**
* @language zh_CN
* 发出事件的插槽。
* @version DragonBones 4.5
*/
slot: Slot;
/**
* @language zh_CN
* 发出事件的动画状态。
* @version DragonBones 4.5
*/
animationState: AnimationState;
/**
* @private
*/
frame: AnimationFrameData;
/**
* @language zh_CN
* 用户数据。
* @version DragonBones 4.5
*/
userData: any;
/**
* @inheritDoc
*/
protected _onClear(): void;
}
}
declare namespace dragonBones {
/**
* @private
*/
class ColorTransform {
alphaMultiplier: number;
redMultiplier: number;
greenMultiplier: number;
blueMultiplier: number;
alphaOffset: number;
redOffset: number;
greenOffset: number;
blueOffset: number;
constructor(alphaMultiplier?: number, redMultiplier?: number, greenMultiplier?: number, blueMultiplier?: number, alphaOffset?: number, redOffset?: number, greenOffset?: number, blueOffset?: number);
copyFrom(value: ColorTransform): void;
identity(): void;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 2D 矩阵。
* @version DragonBones 3.0
*/
class Matrix {
a: number;
b: number;
c: number;
d: number;
tx: number;
ty: number;
constructor(a?: number, b?: number, c?: number, d?: number, tx?: number, ty?: number);
/**
* @private
*/
toString(): string;
/**
* @language zh_CN
* 复制矩阵。
* @param value 需要复制的矩阵。
* @version DragonBones 3.0
*/
copyFrom(value: Matrix): void;
/**
* @language zh_CN
* 转换为恒等矩阵。
* @version DragonBones 3.0
*/
identity(): void;
/**
* @language zh_CN
* 将当前矩阵与另一个矩阵相乘。
* @param value 需要相乘的矩阵。
* @version DragonBones 3.0
*/
concat(value: Matrix): void;
/**
* @language zh_CN
* 转换为逆矩阵。
* @version DragonBones 3.0
*/
invert(): void;
/**
* @language zh_CN
* 将矩阵转换应用于指定点。
* @param x 横坐标。
* @param y 纵坐标。
* @param result 应用转换之后的坐标。
* @params delta 是否忽略 tx，ty 对坐标的转换。
* @version DragonBones 3.0
*/
transformPoint(x: number, y: number, result: {
x: number;
y: number;
}, delta?: boolean): void;
}
}
declare namespace dragonBones {
/**
* @private
*/
class Point {
x: number;
y: number;
constructor(x?: number, y?: number);
copyFrom(value: Point): void;
clear(): void;
}
}
declare namespace dragonBones {
/**
* @private
*/
class Rectangle {
x: number;
y: number;
width: number;
height: number;
constructor(x?: number, y?: number, width?: number, height?: number);
copyFrom(value: Rectangle): void;
clear(): void;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 2D 变换。
* @version DragonBones 3.0
*/
class Transform {
/**
* @language zh_CN
* 水平位移。
* @version DragonBones 3.0
*/
x: number;
/**
* @language zh_CN
* 垂直位移。
* @version DragonBones 3.0
*/
y: number;
/**
* @language zh_CN
* 水平倾斜。 (以弧度为单位)
* @version DragonBones 3.0
*/
skewX: number;
/**
* @language zh_CN
* 垂直倾斜。 (以弧度为单位)
* @version DragonBones 3.0
*/
skewY: number;
/**
* @language zh_CN
* 水平缩放。
* @version DragonBones 3.0
*/
scaleX: number;
/**
* @language zh_CN
* 垂直缩放。
* @version DragonBones 3.0
*/
scaleY: number;
/**
* @private
*/
static normalizeRadian(value: number): number;
/**
* @private
*/
constructor(
/**
* @language zh_CN
* 水平位移。
* @version DragonBones 3.0
*/
x?: number,
/**
* @language zh_CN
* 垂直位移。
* @version DragonBones 3.0
*/
y?: number,
/**
* @language zh_CN
* 水平倾斜。 (以弧度为单位)
* @version DragonBones 3.0
*/
skewX?: number,
/**
* @language zh_CN
* 垂直倾斜。 (以弧度为单位)
* @version DragonBones 3.0
*/
skewY?: number,
/**
* @language zh_CN
* 水平缩放。
* @version DragonBones 3.0
*/
scaleX?: number,
/**
* @language zh_CN
* 垂直缩放。
* @version DragonBones 3.0
*/
scaleY?: number);
/**
* @private
*/
toString(): string;
/**
* @private
*/
copyFrom(value: Transform): Transform;
/**
* @private
*/
identity(): Transform;
/**
* @private
*/
add(value: Transform): Transform;
/**
* @private
*/
minus(value: Transform): Transform;
/**
* @private
*/
fromMatrix(matrix: Matrix): Transform;
/**
* @language zh_CN
* 转换为矩阵。
* @param 矩阵。
* @version DragonBones 3.0
*/
toMatrix(matrix: Matrix): Transform;
/**
* @language zh_CN
* 旋转。 (以弧度为单位)
* @version DragonBones 3.0
*/
rotation: number;
}
}
declare namespace dragonBones {
/**
* @private
*/
abstract class TimelineData> extends BaseObject {
/**
* @private
*/
static toString(): string;
scale: number;
/**
* @private
*/
offset: number;
/**
* @private
*/
frames: Array;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
/**
* @private
*/
class ZOrderTimelineData extends TimelineData {
static toString(): string;
}
/**
* @private
*/
class BoneTimelineData extends TimelineData {
static cacheFrame(cacheFrames: Array, cacheFrameIndex: number, globalTransformMatrix: Matrix): Matrix;
static toString(): string;
bone: BoneData;
originalTransform: Transform;
cachedFrames: Array;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
cacheFrames(cacheFrameCount: number): void;
}
/**
* @private
*/
class SlotTimelineData extends TimelineData {
static cacheFrame(cacheFrames: Array, cacheFrameIndex: number, globalTransformMatrix: Matrix): Matrix;
static toString(): string;
slot: SlotData;
cachedFrames: Array;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
cacheFrames(cacheFrameCount: number): void;
}
/**
* @private
*/
class FFDTimelineData extends TimelineData {
static toString(): string;
displayIndex: number;
skin: SkinData;
slot: SlotDisplayDataSet;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 动画数据。
* @version DragonBones 3.0
*/
class AnimationData extends TimelineData {
/**
* @private
*/
static toString(): string;
/**
* @private
*/
hasAsynchronyTimeline: boolean;
/**
* @language zh_CN
* 持续的帧数。
* @version DragonBones 3.0
*/
frameCount: number;
/**
* @language zh_CN
* 循环播放的次数。 [0: 无限循环播放, [1~N]: 循环播放 N 次]
* @version DragonBones 3.0
*/
playTimes: number;
/**
* @language zh_CN
* 开始的时间。 (以秒为单位)
* @version DragonBones 3.0
*/
position: number;
/**
* @language zh_CN
* 持续的时间。 (以秒为单位)
* @version DragonBones 3.0
*/
duration: number;
/**
* @language zh_CN
* 淡入混合的时间。 (以秒为单位)
* @version DragonBones 3.0
*/
fadeInTime: number;
/**
* @private
*/
cacheTimeToFrameScale: number;
/**
* @language zh_CN
* 数据名称。
* @version DragonBones 3.0
*/
name: string;
/**
* @private
*/
animation: AnimationData;
/**
* @private
*/
zOrderTimeline: TimelineData;
/**
* @private
*/
boneTimelines: Map;
/**
* @private
*/
slotTimelines: Map;
/**
* @private
*/
ffdTimelines: Map>>;
/**
* @private
*/
cachedFrames: Array;
/**
* @private
*/
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
/**
* @private
*/
cacheFrames(value: number): void;
/**
* @private
*/
addBoneTimeline(value: BoneTimelineData): void;
/**
* @private
*/
addSlotTimeline(value: SlotTimelineData): void;
/**
* @private
*/
addFFDTimeline(value: FFDTimelineData): void;
/**
* @private
*/
getBoneTimeline(name: string): BoneTimelineData;
/**
* @private
*/
getSlotTimeline(name: string): SlotTimelineData;
/**
* @private
*/
getFFDTimeline(skinName: string, slotName: string, displayIndex: number): FFDTimelineData;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 骨架数据。
* @see dragonBones.Armature
* @version DragonBones 3.0
*/
class ArmatureData extends BaseObject {
private static _onSortSlots(a, b);
/**
* @private
*/
static toString(): string;
/**
* @language zh_CN
* 动画帧率。
* @version DragonBones 3.0
*/
frameRate: number;
/**
* @language zh_CN
* 骨架类型。
* @see dragonBones.ArmatureType
* @version DragonBones 3.0
*/
type: ArmatureType;
/**
* @language zh_CN
* 数据名称。
* @version DragonBones 3.0
*/
name: string;
/**
* @private
*/
parent: DragonBonesData;
/**
* @private
*/
userData: any;
/**
* @private
*/
aabb: Rectangle;
/**
* @language zh_CN
* 所有的骨骼数据。
* @see dragonBones.BoneData
* @version DragonBones 3.0
*/
bones: Map;
/**
* @language zh_CN
* 所有的插槽数据。
* @see dragonBones.SlotData
* @version DragonBones 3.0
*/
slots: Map;
/**
* @language zh_CN
* 所有的皮肤数据。
* @see dragonBones.SkinData
* @version DragonBones 3.0
*/
skins: Map;
/**
* @language zh_CN
* 所有的动画数据。
* @see dragonBones.AnimationData
* @version DragonBones 3.0
*/
animations: Map;
/**
* @private
*/
actions: Array;
/**
* @private
*/
cacheFrameRate: number;
/**
* @private
*/
scale: number;
private _boneDirty;
private _slotDirty;
private _defaultSkin;
private _defaultAnimation;
private _sortedBones;
private _sortedSlots;
private _bonesChildren;
/**
* @private
*/
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
private _sortBones();
private _sortSlots();
/**
* @private
*/
cacheFrames(value: number): void;
/**
* @private
*/
addBone(value: BoneData, parentName: string): void;
/**
* @private
*/
addSlot(value: SlotData): void;
/**
* @private
*/
addSkin(value: SkinData): void;
/**
* @private
*/
addAnimation(value: AnimationData): void;
/**
* @language zh_CN
* 获取指定名称的骨骼数据。
* @param name 骨骼数据名称。
* @see dragonBones.BoneData
* @version DragonBones 3.0
*/
getBone(name: string): BoneData;
/**
* @language zh_CN
* 获取指定名称的插槽数据。
* @param name 插槽数据名称。
* @see dragonBones.SlotData
* @version DragonBones 3.0
*/
getSlot(name: string): SlotData;
/**
* @language zh_CN
* 获取指定名称的皮肤数据。
* @param name 皮肤数据名称。
* @see dragonBones.SkinData
* @version DragonBones 3.0
*/
getSkin(name: string): SkinData;
/**
* @language zh_CN
* 获取指定名称的动画数据。
* @param name 动画数据名称。
* @see dragonBones.AnimationData
* @version DragonBones 3.0
*/
getAnimation(name: string): AnimationData;
/**
* @private
*/
sortedBones: Array;
/**
* @private
*/
sortedSlots: Array;
/**
* @language zh_CN
* 获取默认的皮肤数据。
* @see dragonBones.SkinData
* @version DragonBones 4.5
*/
defaultSkin: SkinData;
/**
* @language zh_CN
* 获取默认的动画数据。
* @see dragonBones.AnimationData
* @version DragonBones 4.5
*/
defaultAnimation: AnimationData;
}
/**
* @language zh_CN
* 骨骼数据。
* @see dragonBones.Bone
* @version DragonBones 3.0
*/
class BoneData extends BaseObject {
/**
* @private
*/
static toString(): string;
/**
* @private
*/
inheritTranslation: boolean;
/**
* @private
*/
inheritRotation: boolean;
/**
* @private
*/
inheritScale: boolean;
/**
* @private
*/
bendPositive: boolean;
/**
* @private
*/
chain: number;
/**
* @private
*/
chainIndex: number;
/**
* @private
*/
weight: number;
/**
* @private
*/
length: number;
/**
* @language zh_CN
* 数据名称。
* @version DragonBones 3.0
*/
name: string;
/**
* @language zh_CN
* 所属的父骨骼数据。
* @version DragonBones 3.0
*/
parent: BoneData;
/**
* @private
*/
ik: BoneData;
/**
* @private
*/
transform: Transform;
/**
* @private
*/
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
/**
* @language zh_CN
* 插槽数据。
* @see dragonBones.Slot
* @version DragonBones 3.0
*/
class SlotData extends BaseObject {
/**
* @private
*/
static DEFAULT_COLOR: ColorTransform;
/**
* @private
*/
static generateColor(): ColorTransform;
/**
* @private
*/
static toString(): string;
/**
* @private
*/
displayIndex: number;
/**
* @private
*/
zOrder: number;
/**
* @private
*/
blendMode: BlendMode;
/**
* @language zh_CN
* 数据名称。
* @version DragonBones 3.0
*/
name: string;
/**
* @language zh_CN
* 所属的父骨骼数据。
* @see dragonBones.BoneData
* @version DragonBones 3.0
*/
parent: BoneData;
/**
* @private
*/
color: ColorTransform;
/**
* @private
*/
actions: Array;
/**
* @private
*/
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
/**
* @language zh_CN
* 皮肤数据。
* @version DragonBones 3.0
*/
class SkinData extends BaseObject {
/**
* @private
*/
static toString(): string;
/**
* @language zh_CN
* 数据名称。
* @version DragonBones 3.0
*/
name: string;
/**
* @private
*/
slots: Map;
/**
* @private
*/
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
/**
* @private
*/
addSlot(value: SlotDisplayDataSet): void;
/**
* @private
*/
getSlot(name: string): SlotDisplayDataSet;
}
/**
* @private
*/
class SlotDisplayDataSet extends BaseObject {
static toString(): string;
slot: SlotData;
displays: Array;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
/**
* @private
*/
class DisplayData extends BaseObject {
static toString(): string;
isRelativePivot: boolean;
type: DisplayType;
name: string;
texture: TextureData;
armature: ArmatureData;
mesh: MeshData;
pivot: Point;
transform: Transform;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
/**
* @private
*/
class MeshData extends BaseObject {
static toString(): string;
skinned: boolean;
slotPose: Matrix;
uvs: Array;
vertices: Array;
vertexIndices: Array;
boneIndices: Array>;
weights: Array>;
boneVertices: Array>;
bones: Array;
inverseBindPose: Array;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 龙骨数据，包含多个骨架数据。
* @see dragonBones.ArmatureData
* @version DragonBones 3.0
*/
class DragonBonesData extends BaseObject {
/**
* @private
*/
static toString(): string;
/**
* @language zh_CN
* 是否开启共享搜索。 [true: 开启, false: 不开启]
* @default false
* @see dragonBones.ArmatureData
* @version DragonBones 4.5
*/
autoSearch: boolean;
/**
* @language zh_CN
* 动画帧频。
* @version DragonBones 3.0
*/
frameRate: number;
/**
* @language zh_CN
* 数据名称。
* @version DragonBones 3.0
*/
name: string;
/**
* @language zh_CN
* 所有的骨架数据。
* @see dragonBones.ArmatureData
* @version DragonBones 3.0
*/
armatures: Map;
private _armatureNames;
/**
* @inheritDoc
*/
protected _onClear(): void;
/**
* @language zh_CN
* 获取指定名称的骨架。
* @param name 骨架数据骨架名称。
* @see dragonBones.ArmatureData
* @version DragonBones 3.0
*/
getArmature(name: string): ArmatureData;
/**
* @language zh_CN
* 所有的骨架数据名称。
* @see #armatures
* @version DragonBones 3.0
*/
armatureNames: Array;
/**
* @deprecated
* @see dragonBones.BaseFactory#removeDragonBonesData()
*/
dispose(): void;
}
}
declare namespace dragonBones {
/**
* @private
*/
class ActionData extends BaseObject {
static toString(): string;
type: ActionType;
bone: BoneData;
slot: SlotData;
data: Array;
constructor();
protected _onClear(): void;
}
/**
* @private
*/
class EventData extends BaseObject {
static toString(): string;
type: EventType;
name: string;
data: any;
bone: BoneData;
slot: SlotData;
constructor();
protected _onClear(): void;
}
/**
* @private
*/
abstract class FrameData extends BaseObject {
position: number;
duration: number;
prev: T;
next: T;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
/**
* @private
*/
abstract class TweenFrameData extends FrameData {
static samplingCurve(curve: Array, frameCount: number): Array;
tweenEasing: number;
curve: Array;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
/**
* @private
*/
class AnimationFrameData extends FrameData {
static toString(): string;
actions: Array;
events: Array;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
/**
* @private
*/
class ZOrderFrameData extends FrameData {
zOrder: Array;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
/**
* @private
*/
class BoneFrameData extends TweenFrameData {
static toString(): string;
tweenScale: boolean;
tweenRotate: number;
guideCurve: Array;
transform: Transform;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
/**
* @private
*/
class SlotFrameData extends TweenFrameData {
static DEFAULT_COLOR: ColorTransform;
static generateColor(): ColorTransform;
static toString(): string;
displayIndex: number;
color: ColorTransform;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
/**
* @private
*/
class ExtensionFrameData extends TweenFrameData {
static toString(): string;
type: ExtensionType;
tweens: Array;
keys: Array;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
}
declare namespace dragonBones {
/**
* @private
*/
abstract class DataParser {
protected static DATA_VERSION_2_3: string;
protected static DATA_VERSION_3_0: string;
protected static DATA_VERSION_4_0: string;
protected static DATA_VERSION: string;
protected static TEXTURE_ATLAS: string;
protected static SUB_TEXTURE: string;
protected static FORMAT: string;
protected static IMAGE_PATH: string;
protected static WIDTH: string;
protected static HEIGHT: string;
protected static ROTATED: string;
protected static FRAME_X: string;
protected static FRAME_Y: string;
protected static FRAME_WIDTH: string;
protected static FRAME_HEIGHT: string;
protected static DRADON_BONES: string;
protected static ARMATURE: string;
protected static BONE: string;
protected static IK: string;
protected static SLOT: string;
protected static SKIN: string;
protected static DISPLAY: string;
protected static ANIMATION: string;
protected static Z_ORDER: string;
protected static FFD: string;
protected static FRAME: string;
protected static PIVOT: string;
protected static TRANSFORM: string;
protected static AABB: string;
protected static COLOR: string;
protected static FILTER: string;
protected static VERSION: string;
protected static IS_GLOBAL: string;
protected static FRAME_RATE: string;
protected static TYPE: string;
protected static NAME: string;
protected static PARENT: string;
protected static LENGTH: string;
protected static DATA: string;
protected static DISPLAY_INDEX: string;
protected static BLEND_MODE: string;
protected static INHERIT_TRANSLATION: string;
protected static INHERIT_ROTATION: string;
protected static INHERIT_SCALE: string;
protected static TARGET: string;
protected static BEND_POSITIVE: string;
protected static CHAIN: string;
protected static WEIGHT: string;
protected static FADE_IN_TIME: string;
protected static PLAY_TIMES: string;
protected static SCALE: string;
protected static OFFSET: string;
protected static POSITION: string;
protected static DURATION: string;
protected static TWEEN_EASING: string;
protected static TWEEN_ROTATE: string;
protected static TWEEN_SCALE: string;
protected static CURVE: string;
protected static GUIDE_CURVE: string;
protected static EVENT: string;
protected static SOUND: string;
protected static ACTION: string;
protected static ACTIONS: string;
protected static DEFAULT_ACTIONS: string;
protected static X: string;
protected static Y: string;
protected static SKEW_X: string;
protected static SKEW_Y: string;
protected static SCALE_X: string;
protected static SCALE_Y: string;
protected static ALPHA_OFFSET: string;
protected static RED_OFFSET: string;
protected static GREEN_OFFSET: string;
protected static BLUE_OFFSET: string;
protected static ALPHA_MULTIPLIER: string;
protected static RED_MULTIPLIER: string;
protected static GREEN_MULTIPLIER: string;
protected static BLUE_MULTIPLIER: string;
protected static UVS: string;
protected static VERTICES: string;
protected static TRIANGLES: string;
protected static WEIGHTS: string;
protected static SLOT_POSE: string;
protected static BONE_POSE: string;
protected static TWEEN: string;
protected static KEY: string;
protected static COLOR_TRANSFORM: string;
protected static TIMELINE: string;
protected static PIVOT_X: string;
protected static PIVOT_Y: string;
protected static Z: string;
protected static LOOP: string;
protected static AUTO_TWEEN: string;
protected static HIDE: string;
protected static _getArmatureType(value: string): ArmatureType;
protected static _getDisplayType(value: string): DisplayType;
protected static _getBlendMode(value: string): BlendMode;
protected static _getActionType(value: string): ActionType;
protected _data: DragonBonesData;
protected _armature: ArmatureData;
protected _skin: SkinData;
protected _slotDisplayDataSet: SlotDisplayDataSet;
protected _mesh: MeshData;
protected _animation: AnimationData;
protected _timeline: any;
protected _isOldData: boolean;
protected _isGlobalTransform: boolean;
protected _isAutoTween: boolean;
protected _animationTweenEasing: number;
protected _timelinePivot: Point;
protected _helpPoint: Point;
protected _helpTransformA: Transform;
protected _helpTransformB: Transform;
protected _helpMatrix: Matrix;
protected _rawBones: Array;
constructor();
/**
* @private
*/
abstract parseDragonBonesData(rawData: any, scale: number): DragonBonesData;
/**
* @private
*/
abstract parseTextureAtlasData(rawData: any, textureAtlasData: TextureAtlasData, scale: number): void;
private _getTimelineFrameMatrix(animation, timeline, position, transform);
protected _globalToLocal(armature: ArmatureData): void;
protected _mergeFrameToAnimationTimeline(framePostion: number, actions: Array, events: Array): void;
/**
* @deprecated
* @see dragonBones.BaseFactory#parseDragonBonesData()
*/
static parseDragonBonesData(rawData: any): DragonBonesData;
/**
* @deprecated
* @see dragonBones.BaseFactory#parsetTextureAtlasData()
*/
static parseTextureAtlasData(rawData: any, scale?: number): any;
}
}
declare namespace dragonBones {
/**
* @private
*/
class ObjectDataParser extends DataParser {
/**
* @private
*/
protected static _getBoolean(rawData: any, key: string, defaultValue: boolean): boolean;
/**
* @private
*/
protected static _getNumber(rawData: any, key: string, defaultValue: number): number;
/**
* @private
*/
protected static _getString(rawData: any, key: string, defaultValue: string): string;
/**
* @private
*/
protected static _getParameter(rawData: Array, index: number, defaultValue: any): any;
/**
* @private
*/
constructor();
/**
* @private
*/
protected _parseArmature(rawData: any, scale: number): ArmatureData;
/**
* @private
*/
protected _parseBone(rawData: any): BoneData;
/**
* @private
*/
protected _parseIK(rawData: any): void;
/**
* @private
*/
protected _parseSlot(rawData: any, zOrder: number): SlotData;
/**
* @private
*/
protected _parseSkin(rawData: any): SkinData;
/**
* @private
*/
protected _parseSlotDisplaySet(rawData: any): SlotDisplayDataSet;
/**
* @private
*/
protected _parseDisplay(rawData: any): DisplayData;
/**
* @private
*/
protected _parseMesh(rawData: any): MeshData;
/**
* @private
*/
protected _parseAnimation(rawData: any): AnimationData;
/**
* @private
*/
protected _parseBoneTimeline(rawData: any): BoneTimelineData;
/**
* @private
*/
protected _parseSlotTimeline(rawData: any): SlotTimelineData;
/**
* @private
*/
protected _parseFFDTimeline(rawData: any): FFDTimelineData;
/**
* @private
*/
protected _parseAnimationFrame(rawData: any, frameStart: number, frameCount: number): AnimationFrameData;
/**
* @private
*/
protected _parseZOrderFrame(rawData: any, frameStart: number, frameCount: number): ZOrderFrameData;
/**
* @private
*/
protected _parseBoneFrame(rawData: Object, frameStart: number, frameCount: number): BoneFrameData;
/**
* @private
*/
protected _parseSlotFrame(rawData: any, frameStart: number, frameCount: number): SlotFrameData;
/**
* @private
*/
protected _parseFFDFrame(rawData: any, frameStart: number, frameCount: number): ExtensionFrameData;
/**
* @private
*/
protected _parseTweenFrame>(rawData: any, frame: T, frameStart: number, frameCount: number): void;
/**
* @private
*/
protected _parseFrame>(rawData: any, frame: T, frameStart: number, frameCount: number): void;
/**
* @private
*/
protected _parseTimeline>(rawData: Object, timeline: TimelineData, frameParser: (rawData: any, frameStart: number, frameCount: number) => T): void;
/**
* @private
*/
protected _parseActionData(rawData: any, actions: Array, bone: BoneData, slot: SlotData): void;
/**
* @private
*/
protected _parseEventData(rawData: any, events: Array, bone: BoneData, slot: SlotData): void;
/**
* @private
*/
protected _parseTransform(rawData: Object, transform: Transform): void;
/**
* @private
*/
protected _parseColorTransform(rawData: Object, color: ColorTransform): void;
/**
* @inheritDoc
*/
parseDragonBonesData(rawData: any, scale?: number): DragonBonesData;
/**
* @inheritDoc
*/
parseTextureAtlasData(rawData: any, textureAtlasData: TextureAtlasData, scale?: number): void;
/**
* @private
*/
private static _instance;
/**
* @deprecated
* @see dragonBones.BaseFactory#parseDragonBonesData()
*/
static getInstance(): ObjectDataParser;
}
}
declare namespace dragonBones {
/**
* @language zh_CN
* 贴图集数据。
* @version DragonBones 3.0
*/
abstract class TextureAtlasData extends BaseObject {
/**
* @language zh_CN
* 是否开启共享搜索。 [true: 开启, false: 不开启]
* @default false
* @version DragonBones 4.5
*/
autoSearch: boolean;
/**
* @language zh_CN
* 贴图集缩放系数。
* @version DragonBones 3.0
*/
scale: number;
/**
* @language zh_CN
* 贴图集名称。
* @version DragonBones 3.0
*/
name: string;
/**
* @language zh_CN
* 贴图集图片路径。
* @version DragonBones 3.0
*/
imagePath: string;
/**
* @inheritDoc
*/
protected _onClear(): void;
/**
* @private
*/
getTexture(name: string): TextureData;
}
/**
* @private
*/
abstract class TextureData extends BaseObject {
static generateRectangle(): Rectangle;
rotated: boolean;
name: string;
frame: Rectangle;
parent: TextureAtlasData;
region: Rectangle;
constructor();
/**
* @inheritDoc
*/
protected _onClear(): void;
}
}
declare namespace dragonBones {
/**
* @private
*/
type BuildArmaturePackage = {
dataName?: string;
textureAtlasName?: string;
data?: DragonBonesData;
armature?: ArmatureData;
skin?: SkinData;
};
/**
* @language zh_CN
* 创建骨架的基础工厂。 (通常只需要一个全局工厂实例)
* @see dragonBones.DragonBonesData
* @see dragonBones.TextureAtlasData
* @see dragonBones.ArmatureData
* @see dragonBones.Armature
* @version DragonBones 3.0
*/
abstract class BaseFactory {
protected static _defaultParser: ObjectDataParser;
/**
* @language zh_CN
* 是否开启共享搜索。 [true: 开启, false: 不开启]
* 如果开启，创建一个骨架时，可以从多个龙骨数据中寻找骨架数据，或贴图集数据中寻找贴图数据。 (通常在有共享导出的数据时开启)
* @see dragonBones.DragonBonesData#autoSearch
* @see dragonBones.TextureAtlasData#autoSearch
* @version DragonBones 4.5
*/
autoSearch: boolean;
/**
* @private
*/
protected _dataParser: DataParser;
/**
* @private
*/
protected _dragonBonesDataMap: Map;
/**
* @private
*/
protected _textureAtlasDataMap: Map>;
/**
* @private
*/
constructor(dataParser?: DataParser);
/**
* @private
*/
protected _getTextureData(textureAtlasName: string, textureName: string): TextureData;
/**
* @private
*/
protected _fillBuildArmaturePackage(dataPackage: BuildArmaturePackage, dragonBonesName: string, armatureName: string, skinName: string, textureAtlasName: string): boolean;
/**
* @private
*/
protected _buildBones(dataPackage: BuildArmaturePackage, armature: Armature): void;
/**
* @private
*/
protected _buildSlots(dataPackage: BuildArmaturePackage, armature: Armature): void;
/**
* @private
*/
protected _replaceSlotDisplay(dataPackage: BuildArmaturePackage, displayData: DisplayData, slot: Slot, displayIndex: number): void;
/**
* @private
*/
protected abstract _generateTextureAtlasData(textureAtlasData: TextureAtlasData, textureAtlas: any): TextureAtlasData;
/**
* @private
*/
protected abstract _generateArmature(dataPackage: BuildArmaturePackage): Armature;
/**
* @private
*/
protected abstract _generateSlot(dataPackage: BuildArmaturePackage, slotDisplayDataSet: SlotDisplayDataSet, armature: Armature): Slot;
/**
* @language zh_CN
* 解析并添加龙骨数据。
* @param rawData 需要解析的原始数据。 (JSON)
* @param name 为数据提供一个名称，以便可以通过这个名称获取数据，如果未设置，则使用数据中的名称。
* @returns DragonBonesData
* @see #getDragonBonesData()
* @see #addDragonBonesData()
* @see #removeDragonBonesData()
* @see dragonBones.DragonBonesData
* @version DragonBones 4.5
*/
parseDragonBonesData(rawData: any, name?: string, scale?: number): DragonBonesData;
/**
* @language zh_CN
* 解析并添加贴图集数据。
* @param rawData 需要解析的原始数据。 (JSON)
* @param textureAtlas 贴图集数据。 (JSON)
* @param name 为数据指定一个名称，以便可以通过这个名称获取数据，如果未设置，则使用数据中的名称。
* @param scale 为贴图集设置一个缩放值。
* @returns 贴图集数据
* @see #getTextureAtlasData()
* @see #addTextureAtlasData()
* @see #removeTextureAtlasData()
* @see dragonBones.TextureAtlasData
* @version DragonBones 4.5
*/
parseTextureAtlasData(rawData: any, textureAtlas: Object, name?: string, scale?: number): TextureAtlasData;
/**
* @language zh_CN
* 获取指定名称的龙骨数据。
* @param name 数据名称。
* @returns DragonBonesData
* @see #parseDragonBonesData()
* @see #addDragonBonesData()
* @see #removeDragonBonesData()
* @see dragonBones.DragonBonesData
* @version DragonBones 3.0
*/
getDragonBonesData(name: string): DragonBonesData;
/**
* @language zh_CN
* 添加龙骨数据。
* @param data 龙骨数据。
* @param name 为数据指定一个名称，以便可以通过这个名称获取数据，如果未设置，则使用数据中的名称。
* @see #parseDragonBonesData()
* @see #getDragonBonesData()
* @see #removeDragonBonesData()
* @see dragonBones.DragonBonesData
* @version DragonBones 3.0
*/
addDragonBonesData(data: DragonBonesData, name?: string): void;
/**
* @language zh_CN
* 移除龙骨数据。
* @param name 数据名称。
* @param disposeData 是否释放数据。 [false: 不释放, true: 释放]
* @see #parseDragonBonesData()
* @see #getDragonBonesData()
* @see #addDragonBonesData()
* @see dragonBones.DragonBonesData
* @version DragonBones 3.0
*/
removeDragonBonesData(name: string, disposeData?: boolean): void;
/**
* @language zh_CN
* 获取指定名称的贴图集数据列表。
* @param name 数据名称。
* @returns 贴图集数据列表。
* @see #parseTextureAtlasData()
* @see #addTextureAtlasData()
* @see #removeTextureAtlasData()
* @see dragonBones.textures.TextureAtlasData
* @version DragonBones 3.0
*/
getTextureAtlasData(name: string): Array;
/**
* @language zh_CN
* 添加贴图集数据。
* @param data 贴图集数据。
* @param name 为数据指定一个名称，以便可以通过这个名称获取数据，如果未设置，则使用数据中的名称。
* @see #parseTextureAtlasData()
* @see #getTextureAtlasData()
* @see #removeTextureAtlasData()
* @see dragonBones.textures.TextureAtlasData
* @version DragonBones 3.0
*/
addTextureAtlasData(data: TextureAtlasData, name?: string): void;
/**
* @language zh_CN
* 移除贴图集数据。
* @param name 数据名称。
* @param disposeData 是否释放数据。 [false: 不释放, true: 释放]
* @see #parseTextureAtlasData()
* @see #getTextureAtlasData()
* @see #addTextureAtlasData()
* @see dragonBones.textures.TextureAtlasData
* @version DragonBones 3.0
*/
removeTextureAtlasData(name: string, disposeData?: boolean): void;
/**
* @language zh_CN
* 清除所有的数据。
* @param disposeData 是否释放数据。 [false: 不释放, true: 释放]
* @version DragonBones 4.5
*/
clear(disposeData?: boolean): void;
/**
* @language zh_CN
* 创建一个指定名称的骨架。
* @param armatureName 骨架数据名称。
* @param dragonBonesName 龙骨数据名称，如果未设置，将检索所有的龙骨数据，当多个龙骨数据中包含同名的骨架数据时，可能无法创建出准确的骨架。
* @param skinName 皮肤名称，如果未设置，则使用默认皮肤。
* @param textureAtlasName 贴图集数据名称，如果未设置，则使用龙骨数据。
* @returns 骨架
* @see dragonBones.Armature
* @version DragonBones 3.0
*/
buildArmature(armatureName: string, dragonBonesName?: string, skinName?: string, textureAtlasName?: string): Armature;
/**
* @language zh_CN
* 将指定骨架的动画替换成其他骨架的动画。 (通常这些骨架应该具有相同的骨架结构)
* @param toArmature 指定的骨架。
* @param fromArmatreName 其他骨架的名称。
* @param fromSkinName 其他骨架的皮肤名称，如果未设置，则使用默认皮肤。
* @param fromDragonBonesDataName 其他骨架属于的龙骨数据名称，如果未设置，则检索所有的龙骨数据。
* @param ifRemoveOriginalAnimationList 是否移除原有的动画。 [true: 移除, false: 不移除]
* @returns 是否替换成功。 [true: 成功, false: 不成功]
* @see dragonBones.Armature
* @version DragonBones 4.5
*/
copyAnimationsToArmature(toArmature: Armature, fromArmatreName: string, fromSkinName?: string, fromDragonBonesDataName?: string, ifRemoveOriginalAnimationList?: boolean): boolean;
/**
* @language zh_CN
* 将指定插槽的显示对象替换为指定资源创造出的显示对象。
* @param dragonBonesName 指定的龙骨数据名称。
* @param armatureName 指定的骨架名称。
* @param slotName 指定的插槽名称。
* @param displayName 指定的显示对象名称。
* @param slot 指定的插槽实例。
* @param displayIndex 要替换的显示对象的索引，如果未设置，则替换当前正在显示的显示对象。
* @version DragonBones 4.5
*/
replaceSlotDisplay(dragonBonesName: string, armatureName: string, slotName: string, displayName: string, slot: Slot, displayIndex?: number): void;
/**
* @language zh_CN
* 将指定插槽的显示对象列表替换为指定资源创造出的显示对象列表。
* @param dragonBonesName 指定的 DragonBonesData 名称。
* @param armatureName 指定的骨架名称。
* @param slotName 指定的插槽名称。
* @param slot 指定的插槽实例。
* @version DragonBones 4.5
*/
replaceSlotDisplayList(dragonBonesName: string, armatureName: string, slotName: string, slot: Slot): void;
/**
* @private
*/
getAllDragonBonesData(): Map;
/**
* @private
*/
getAllTextureAtlasData(): Map>;
}
}
declare let jsb: any;
/** Running in the editor. */
declare let CC_EDITOR: boolean;
/** Preview in browser or simulator. */
declare let CC_PREVIEW: boolean;
/** Running in the editor or preview. */
declare let CC_DEV: boolean;
/** Running in the editor or preview, or build in debug mode. */
declare let CC_DEBUG: boolean;
/** Running in published project. */
declare let CC_BUILD: boolean;
/** Running in native platform (mobile app, desktop app, or simulator). */
declare let CC_JSB: boolean;
/** Running in the engine's unit test. */
declare let CC_TEST: boolean;