-
-
Notifications
You must be signed in to change notification settings - Fork 78
/
Copy pathframework.d.ts
6906 lines (6906 loc) · 252 KB
/
framework.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
declare module es {
/**
* 全局核心类
*/
class Core {
/**
* 核心发射器。只发出核心级别的事件
*/
static emitter: Emitter<CoreEvents>;
static paused: boolean;
/**
* 是否启用调试渲染
*/
static debugRenderEndabled: boolean;
/**
* 简化对内部类的全局内容实例的访问
*/
private static _instance;
/**
* 用于确定是否应该使用EntitySystems
*/
static entitySystemsEnabled: boolean;
/**
* 是否正在debug模式
* 仅允许在create时进行更改
*/
readonly debug: boolean;
_nextScene: Scene;
_sceneTransition: SceneTransition;
/**
* 用于凝聚GraphicsDeviceReset事件
*/
_graphicsDeviceChangeTimer: ITimer;
/**
* 全局访问系统
*/
_globalManagers: GlobalManager[];
_coroutineManager: CoroutineManager;
_timerManager: TimerManager;
private constructor();
/**
* 提供对单例/游戏实例的访问
* @constructor
*/
static readonly Instance: Core;
_frameCounterElapsedTime: number;
_frameCounter: number;
_totalMemory: number;
_titleMemory: (totalMemory: number, frameCounter: number) => void;
_scene: Scene;
/**
* 当前活动的场景。注意,如果设置了该设置,在更新结束之前场景实际上不会改变
*/
/**
* 当前活动的场景。注意,如果设置了该设置,在更新结束之前场景实际上不会改变
* @param value
*/
static scene: Scene;
/**
* `Core`类的静态方法,用于创建`Core`的实例。
* @param debug {boolean} 是否为调试模式,默认为`true`
* @returns {Core} `Core`的实例
*/
static create(debug?: boolean): Core;
/**
* 添加一个全局管理器对象,它的更新方法将调用场景前的每一帧。
* @param manager
*/
static registerGlobalManager(manager: es.GlobalManager): void;
/**
* 删除全局管理器对象
* @param manager
*/
static unregisterGlobalManager(manager: GlobalManager): void;
/**
* 获取指定类型的全局管理器实例
* @param type 管理器类型的构造函数
* @returns 指定类型的全局管理器实例,如果找不到则返回 null
*/
static getGlobalManager<T extends GlobalManager>(type: new (...args: any[]) => T): T;
/**
* 临时运行SceneTransition,允许一个场景平滑过渡到另一个场景,并具有自定义效果
* @param sceneTransition
*/
static startSceneTransition<T extends SceneTransition>(sceneTransition: T): T;
/**
* 启动一个coroutine。Coroutine可以将number延时几秒或延时到其他startCoroutine.Yielding
* null将使coroutine在下一帧被执行。
* @param enumerator
*/
static startCoroutine(enumerator: any): ICoroutine;
/**
* 调度一个一次性或重复的计时器,该计时器将调用已传递的动作
* @param timeInSeconds
* @param repeats
* @param context
* @param onTime
*/
static schedule(timeInSeconds: number, repeats: boolean, context: any, onTime: (timer: ITimer) => void): Timer;
startDebugDraw(): void;
/**
* 在一个场景结束后,下一个场景开始之前调用
*/
onSceneChanged(): void;
protected initialize(): void;
/**
* `Core` 类的受保护的 `update` 方法,用于更新游戏状态。
* @param currentTime 当前时间戳,单位为毫秒,默认值为-1。
*/
protected update(currentTime?: number): void;
protected draw(): void;
}
}
declare module es {
enum LogType {
error = 0,
warn = 1,
log = 2,
info = 3,
trace = 4
}
class Debug {
/**
* 如果条件为true,则在控制台中以警告方式打印消息。
* @param condition 是否应该打印消息的条件
* @param format 要打印的消息格式
* @param args 与消息格式相对应的参数列表
*/
static warnIf(condition: boolean, format: string, ...args: any[]): void;
/**
* 在控制台中以警告方式打印消息。
* @param format 要打印的消息格式
* @param args 与消息格式相对应的参数列表
*/
static warn(format: string, ...args: any[]): void;
/**
* 在控制台中以错误方式打印消息。
* @param format 要打印的消息格式
* @param args 与消息格式相对应的参数列表
*/
static error(format: string, ...args: any[]): void;
/**
* 在控制台中以标准日志方式打印消息。
* @param type 要打印的日志类型
* @param format 要打印的消息格式
* @param args 与消息格式相对应的参数列表
*/
static log(type: LogType, format: string, ...args: any[]): void;
}
}
declare module es {
/**
* 我们在这里存储了各种系统的默认颜色,如对撞机调试渲染、Debug.drawText等。
* 命名方式尽可能采用CLASS-THING,以明确它的使用位置
*/
class DebugDefault {
static debugText: number;
static colliderBounds: number;
static colliderEdge: number;
static colliderPosition: number;
static colliderCenter: number;
static renderableBounds: number;
static renderableCenter: number;
static verletParticle: number;
static verletConstraintEdge: number;
}
}
declare module es {
class Insist {
static fail(message?: string, ...args: any[]): void;
static isTrue(condition: boolean, message?: string, ...args: any[]): void;
static isFalse(condition: boolean, message?: string, ...args: any[]): void;
static isNull(obj: any, message?: string, ...args: any[]): void;
static isNotNull(obj: any, message?: string, ...args: any[]): void;
static areEqual(first: any, second: any, message: string, ...args: any[]): void;
static areNotEqual(first: any, second: any, message: string, ...args: any[]): void;
}
}
declare module es {
class DebugConsole {
static Instance: DebugConsole;
}
}
declare module es {
/**
* 执行顺序
* - onAddedToEntity
* - OnEnabled
*
* 删除执行顺序
* - onRemovedFromEntity
*/
abstract class Component {
static _idGenerator: number;
/**
* 此组件的唯一标识
*/
readonly id: number;
/**
* 此组件附加的实体
*/
entity: Entity;
constructor();
/**
* 快速访问 this.entity.transform
*/
readonly transform: Transform;
private _enabled;
/**
* 如果组件和实体都已启用,则为。当启用该组件时,将调用该组件的生命周期方法。状态的改变会导致调用onEnabled/onDisable。
*/
/**
* 如果组件和实体都已启用,则为。当启用该组件时,将调用该组件的生命周期方法。状态的改变会导致调用onEnabled/onDisable。
* @param value
*/
enabled: boolean;
private _updateOrder;
/** 更新此实体上组件的顺序 */
/** 更新此实体上组件的顺序 */
updateOrder: number;
/**
* 当此组件已分配其实体,但尚未添加到实体的活动组件列表时调用。有用的东西,如物理组件,需要访问转换来修改碰撞体的属性。
*/
initialize(): void;
/**
* 在提交所有挂起的组件更改后,将该组件添加到场景时调用。此时,设置了实体字段和实体。场景也设定好了。
*/
onAddedToEntity(): void;
/**
* 当此组件从其实体中移除时调用。在这里做所有的清理工作。
*/
onRemovedFromEntity(): void;
/**
* 当实体的位置改变时调用。这允许组件知道它们由于父实体的移动而移动了。
* @param comp
*/
onEntityTransformChanged(comp: ComponentTransform): void;
/**
*当父实体或此组件启用时调用
*/
onEnabled(): void;
/**
* 禁用父实体或此组件时调用
*/
onDisabled(): void;
setEnabled(isEnabled: boolean): this;
setUpdateOrder(updateOrder: number): this;
/**
* 添加组件
* @param component 要添加的组件实例
* @returns 返回添加的组件实例
*/
addComponent<T extends Component>(component: T): T;
/**
* 获取组件
* @param type 组件类型
* @returns 返回获取到的组件实例
*/
getComponent<T extends Component>(type: new (...args: any[]) => T): T;
/**
* 获取一组指定类型的组件
* @param typeName 组件类型名
* @param componentList 可选参数,存储组件实例的数组
* @returns 返回指定类型的组件实例数组
*/
getComponents(typeName: any, componentList?: any[]): any[];
/**
* 判断实体是否包含指定类型的组件
* @param type 组件类型
* @returns 如果实体包含指定类型的组件,返回 true,否则返回 false。
*/
hasComponent(type: new (...args: any[]) => Component): boolean;
/**
* 删除组件
* @param component 可选参数,要删除的组件实例。如果未指定该参数,则删除当前实例上的组件。
*/
removeComponent(component?: Component): void;
}
}
declare module es {
class ComponentType {
static INDEX: number;
private index_;
private type_;
constructor(type: Class, index?: number);
getName(): string;
getIndex(): number;
toString(): string;
}
}
declare module es {
enum CoreEvents {
/**
* 当场景发生变化时触发
*/
sceneChanged = 0,
/**
* 每帧更新事件
*/
frameUpdated = 1,
/**
* 当渲染发生时触发
*/
renderChanged = 2
}
}
declare module es {
class EntityComparer implements IComparer<Entity> {
compare(self: Entity, other: Entity): number;
}
class Entity implements IEqualityComparable {
static entityComparer: IComparer<Entity>;
/**
* 当前实体所属的场景
*/
scene: Scene;
/**
* 实体名称。用于在场景范围内搜索实体
*/
name: string;
/**
* 此实体的唯一标识
*/
readonly id: number;
/**
* 封装实体的位置/旋转/缩放,并允许设置一个高层结构
*/
readonly transform: Transform;
/**
* 当前附加到此实体的所有组件的列表
*/
readonly components: ComponentList;
/**
* 指定应该调用这个entity update方法的频率。1表示每一帧,2表示每一帧,以此类推
*/
updateInterval: number;
componentBits: Bits;
constructor(name: string, id: number);
_isDestroyed: boolean;
/**
* 如果调用了destroy,那么在下一次处理实体之前这将一直为true
*/
readonly isDestroyed: boolean;
private _tag;
/**
* 你可以随意使用。稍后可以使用它来查询场景中具有特定标记的所有实体
*/
/**
* 你可以随意使用。稍后可以使用它来查询场景中具有特定标记的所有实体
* @param value
*/
tag: number;
private _enabled;
/**
* 启用/禁用实体。当禁用碰撞器从物理系统和组件中移除时,方法将不会被调用
*/
/**
* 启用/禁用实体。当禁用碰撞器从物理系统和组件中移除时,方法将不会被调用
* @param value
*/
enabled: boolean;
private _updateOrder;
/**
* 更新此实体的顺序。updateOrder还用于对scene.entities上的标签列表进行排序
*/
/**
* 更新此实体的顺序。updateOrder还用于对scene.entities上的标签列表进行排序
* @param value
*/
updateOrder: number;
parent: Transform;
readonly childCount: number;
position: Vector2;
localPosition: Vector2;
rotation: number;
rotationDegrees: number;
localRotation: number;
localRotationDegrees: number;
scale: Vector2;
localScale: Vector2;
readonly worldInverseTransform: Matrix2D;
readonly localToWorldTransform: Matrix2D;
readonly worldToLocalTransform: Matrix2D;
onTransformChanged(comp: ComponentTransform): void;
setParent(parent: Entity): any;
setParent(parent: Transform): any;
setPosition(x: number, y: number): this;
setLocalPosition(localPosition: Vector2): this;
setRotation(radians: number): this;
setRotationDegrees(degrees: number): this;
setLocalRotation(radians: number): this;
setLocalRotationDegrees(degrees: number): this;
setScale(scale: number): any;
setScale(scale: Vector2): any;
setLocalScale(scale: number): any;
setLocalScale(scale: Vector2): any;
/**
* 设置实体的标记
* @param tag
*/
setTag(tag: number): Entity;
/**
* 设置实体的启用状态。当禁用碰撞器从物理系统和组件中移除时,方法将不会被调用
* @param isEnabled
*/
setEnabled(isEnabled: boolean): this;
/**
* 设置此实体的更新顺序。updateOrder还用于对scene.entities上的标签列表进行排序
* @param updateOrder
*/
setUpdateOrder(updateOrder: number): this;
/**
* 从场景中删除实体并销毁所有子元素
*/
destroy(): void;
/**
* 将实体从场景中分离。下面的生命周期方法将被调用在组件上:OnRemovedFromEntity
*/
detachFromScene(): void;
/**
* 将一个先前分离的实体附加到一个新的场景
* @param newScene
*/
attachToScene(newScene: Scene): void;
/**
* 在提交了所有挂起的实体更改后,将此实体添加到场景时调用
*/
onAddedToScene(): void;
/**
* 当此实体从场景中删除时调用
*/
onRemovedFromScene(): void;
/**
* 每帧进行调用进行更新组件
*/
update(): void;
/**
* 创建组件的新实例。返回实例组件
* @param componentType
*/
createComponent<T extends Component>(componentType: new (...args: any[]) => T): T;
/**
* 将组件添加到组件列表中。返回组件。
* @param component
*/
addComponent<T extends Component>(component: T): T;
/**
* 获取类型T的第一个组件并返回它。如果没有找到组件,则返回null。
* @param type
*/
getComponent<T extends Component>(type: new (...args: any[]) => T): T;
/**
* 获取类型T的第一个并已加入场景的组件并返回它。如果没有找到组件,则返回null。
* @param type
* @returns
*/
getComponentInScene<T extends Component>(type: new (...args: any[]) => T): T;
/**
* 尝试获取T类型的组件。如果未找到任何组件,则返回false
* @param type
* @param outComponent
* @returns
*/
tryGetComponent<T extends Component>(type: new (...args: any[]) => T, outComponent: Ref<T>): boolean;
/**
* 检查实体是否具有该组件
* @param type
*/
hasComponent<T extends Component>(type: new (...args: any[]) => T): boolean;
/**
* 获取类型T的第一个组件并返回它。如果没有找到组件,将创建组件。
* @param type
*/
getOrCreateComponent<T extends Component>(type: new (...args: any[]) => T): T;
/**
* 获取typeName类型的所有组件,但不使用列表分配
* @param typeName
* @param componentList
*/
getComponents(typeName: any, componentList?: any[]): any[];
/**
* 从组件列表中删除组件
* @param component
*/
removeComponent(component: Component): void;
/**
* 从组件列表中删除类型为T的第一个组件
* @param type
*/
removeComponentForType<T extends Component>(type: any): boolean;
/**
* 从实体中删除所有组件
*/
removeAllComponents(): void;
tweenPositionTo(to: Vector2, duration?: number): ITween<Vector2>;
tweenLocalPositionTo(to: Vector2, duration?: number): ITween<Vector2>;
tweenScaleTo(to: Vector2, duration?: number): any;
tweenScaleTo(to: number, duration?: number): any;
tweenLocalScaleTo(to: Vector2, duration?: any): any;
tweenLocalScaleTo(to: number, duration?: any): any;
tweenRotationDegreesTo(to: number, duration?: number): TransformVector2Tween;
tweenLocalRotationDegreesTo(to: number, duration?: number): TransformVector2Tween;
compareTo(other: Entity): number;
equals(other: Entity): boolean;
toString(): string;
}
}
declare module es {
/** 2d 向量 */
class Vector2 implements IEquatable<Vector2> {
x: number;
y: number;
/**
* 从两个值构造一个带有X和Y的二维向量。
* @param x 二维空间中的x坐标
* @param y 二维空间的y坐标
*/
constructor(x?: number, y?: number);
static readonly zero: Vector2;
static readonly one: Vector2;
static readonly unitX: Vector2;
static readonly unitY: Vector2;
static readonly up: Vector2;
static readonly down: Vector2;
static readonly left: Vector2;
static readonly right: Vector2;
/**
*
* @param value1
* @param value2
*/
static add(value1: Vector2, value2: Vector2): Vector2;
/**
*
* @param value1
* @param value2
*/
static divide(value1: Vector2, value2: Vector2): Vector2;
static divideScaler(value1: Vector2, value2: number): Vector2;
/**
* 返回两个向量之间距离的平方
* @param value1
* @param value2
*/
static sqrDistance(value1: Vector2, value2: Vector2): number;
/**
* 将指定的值限制在一个范围内
* @param value1
* @param min
* @param max
*/
static clamp(value1: Vector2, min: Vector2, max: Vector2): Vector2;
/**
* 创建一个新的Vector2,其中包含指定向量的线性插值
* @param value1 第一个向量
* @param value2 第二个向量
* @param amount 加权值(0.0-1.0之间)
* @returns 指定向量的线性插值结果
*/
static lerp(value1: Vector2, value2: Vector2, amount: number): Vector2;
/**
* 创建一个新的Vector2,其中包含指定矢量的线性插值
* @param value1
* @param value2
* @param amount
* @returns
*/
static lerpPrecise(value1: Vector2, value2: Vector2, amount: number): Vector2;
/**
* 创建一个新的Vector2,该Vector2包含了通过指定的Matrix进行的二维向量变换。
* @param position
* @param matrix
*/
static transform(position: Vector2, matrix: Matrix2D): Vector2;
/**
* 创建一个新的Vector2,其中包含由指定的Matrix转换的指定法线
* @param normal
* @param matrix
*/
static transformNormal(normal: Vector2, matrix: Matrix): Vector2;
/**
* 返回两个向量之间的距离
* @param value1
* @param value2
* @returns 两个向量之间的距离
*/
static distance(vec1: Vector2, vec2: Vector2): number;
/**
* 返回两个向量之间的角度,单位是度数
* @param from
* @param to
*/
static angle(from: Vector2, to: Vector2): number;
/**
* 创建一个包含指定向量反转的新Vector2
* @param value
* @returns 矢量反演的结果
*/
static negate(value: Vector2): Vector2;
/**
* 向量的反射,输入为两个二维向量vector和normal。函数返回一个新的向量,即vector相对于normal的反射
* @param vector
* @param normal
* @returns
*/
static reflect(vector: Vector2, normal: Vector2): Vector2;
/**
* 创建一个新的Vector2,其中包含指定矢量的三次插值
* @param value1
* @param value2
* @param amount
* @returns
*/
static smoothStep(value1: Vector2, value2: Vector2, amount: number): Vector2;
setTo(x: number, y: number): void;
negate(): Vector2;
/**
*
* @param value
*/
add(v: Vector2): Vector2;
addEqual(v: Vector2): Vector2;
/**
*
* @param value
*/
divide(value: Vector2): Vector2;
divideScaler(value: number): Vector2;
/**
*
* @param value
*/
multiply(value: Vector2): Vector2;
/**
*
* @param value
* @returns
*/
multiplyScaler(value: number): Vector2;
/**
* 从当前Vector2减去一个Vector2
* @param value 要减去的Vector2
* @returns 当前Vector2
*/
sub(value: Vector2): Vector2;
subEqual(v: Vector2): Vector2;
dot(v: Vector2): number;
/**
*
* @param size
* @returns
*/
scale(size: number): Vector2;
scaleEqual(size: number): Vector2;
transform(matrix: Matrix2D): Vector2;
normalize(): Vector2;
/**
* 将这个Vector2变成一个方向相同的单位向量
*/
normalizeEqual(): Vector2;
magnitude(): number;
distance(v?: Vector2): number;
/**
* 返回该Vector2的平方长度
* @returns 这个Vector2的平方长度
*/
lengthSquared(): number;
/**
* 从原点到向量末端的距离
* @returns
*/
getLength(): number;
/**
* 四舍五入X和Y值
*/
round(): Vector2;
/**
* 返回以自己为中心点的左右角,单位为度
* @param left
* @param right
*/
angleBetween(left: Vector2, right: Vector2): number;
getDistance(other: Vector2): number;
getDistanceSquared(other: Vector2): number;
isBetween(v1: Vector2, v2: Vector2): boolean;
/**
* 两个向量的叉积
* @param other
* @returns
*/
cross(other: Vector2): number;
/**
* 计算向量与x轴之间的夹角
*/
getAngle(): number;
/**
* 比较当前实例是否等于指定的对象
* @param other 要比较的对象
* @returns 如果实例相同true 否则false
*/
equals(other: Vector2, tolerance?: number): boolean;
isValid(): boolean;
/**
* 创建一个新的Vector2,其中包含来自两个向量的最小值
* @param value1
* @param value2
* @returns
*/
static min(value1: Vector2, value2: Vector2): Vector2;
/**
* 创建一个新的Vector2,其中包含两个向量的最大值
* @param value1
* @param value2
* @returns
*/
static max(value1: Vector2, value2: Vector2): Vector2;
/**
* 创建一个新的Vector2,其中包含Hermite样条插值
* @param value1
* @param tangent1
* @param value2
* @param tangent2
* @param amount
* @returns
*/
static hermite(value1: Vector2, tangent1: Vector2, value2: Vector2, tangent2: Vector2, amount: number): Vector2;
static unsignedAngle(from: Vector2, to: Vector2, round?: boolean): number;
static fromAngle(angle: number, magnitude?: number): Vector2;
clone(): Vector2;
copyFrom(source: Vector2): Vector2;
}
}
declare module es {
/** 场景 */
class Scene {
/** 这个场景中的实体列表 */
readonly entities: EntityList;
/** 管理所有实体处理器 */
readonly entityProcessors: EntityProcessorList;
readonly _sceneComponents: SceneComponent[];
readonly identifierPool: IdentifierPool;
private _didSceneBegin;
constructor();
/**
* 初始化场景,可以在派生类中覆盖
*
* 这个方法会在场景创建时被调用。您可以在这个方法中添加实体和组件,
* 或者执行一些必要的准备工作,以便场景能够开始运行。
*/
initialize(): void;
/**
* 开始运行场景时调用此方法,可以在派生类中覆盖
*
* 这个方法会在场景开始运行时被调用。您可以在这个方法中执行场景开始时需要进行的操作。
* 比如,您可以开始播放一段背景音乐、启动UI等等。
*/
onStart(): void;
/**
* 卸载场景时调用此方法,可以在派生类中覆盖
*
* 这个方法会在场景被销毁时被调用。您可以在这个方法中销毁实体和组件、释放资源等等。
* 您也可以在这个方法中执行一些必要的清理工作,以确保场景被完全卸载。
*/
unload(): void;
/**
* 开始场景,初始化物理系统、启动实体处理器等
*
* 这个方法会启动场景。它将重置物理系统、启动实体处理器等,并调用onStart方法。
*/
begin(): void;
/**
* 结束场景,清除实体、场景组件、物理系统等
*
* 这个方法会结束场景。它将移除所有实体并调用它们的onRemovedFromScene方法,清除物理系统,结束实体处理器等,并调用unload方法。
*/
end(): void;
/**
* 更新场景,更新实体组件、实体处理器等
*/
update(): void;
/**
* 向组件列表添加并返回SceneComponent
* @param component
*/
addSceneComponent<T extends SceneComponent>(component: T): T;
/**
* 获取类型为T的第一个SceneComponent并返回它。如果没有找到组件,则返回null。
* @param type
*/
getSceneComponent<T extends SceneComponent>(type: any): T;
/**
* 获取类型为T的第一个SceneComponent并返回它。如果没有找到SceneComponent,则将创建SceneComponent。
* @param type
*/
getOrCreateSceneComponent<T extends SceneComponent>(type: any): T;
/**
* 从SceneComponents列表中删除一个SceneComponent
* @param component
*/
removeSceneComponent(component: SceneComponent): void;
/**
* 将实体添加到此场景,并返回它
* @param name
*/
createEntity(name: string): Entity;
/**
* 在场景的实体列表中添加一个实体
* @param entity
*/
addEntity(entity: Entity): Entity;
/**
* 从场景中删除所有实体
*/
destroyAllEntities(): void;
/**
* 搜索并返回第一个具有名称的实体
* @param name
*/
findEntity(name: string): Entity;
findEntityById(id: number): Entity;
/**
* 返回具有给定标记的所有实体
* @param tag
*/
findEntitiesWithTag(tag: number): Entity[];
/**
* 返回提一个具有该标记的实体
* @param tag
* @returns
*/
findEntityWithTag(tag: number): Entity;
/**
* 返回第一个启用加载的类型为T的组件
* @param type
*/
findComponentOfType<T extends Component>(type: new (...args: any[]) => T): T;
/**
* 返回类型为T的所有已启用已加载组件的列表
* @param type
*/
findComponentsOfType<T extends Component>(type: new (...args: any[]) => T): T[];
/**
* 返回场景中包含特定组件的实体列表
* @param type
* @returns
*/
findEntitiesOfComponent(...types: any[]): Entity[];
/**
* 在场景中添加一个EntitySystem处理器
* @param processor 处理器
*/
addEntityProcessor(processor: EntitySystem): EntitySystem;
/**
* 从场景中删除EntitySystem处理器
* @param processor
*/
removeEntityProcessor(processor: EntitySystem): void;
/**
* 获取EntitySystem处理器
*/
getEntityProcessor<T extends EntitySystem>(type: new (...args: any[]) => T): T;
}
}
declare module es {
/**
* SceneTransition用于从一个场景过渡到另一个场景,或在一个场景内进行效果转换。
* 如果sceneLoadAction为null,框架将执行场景内过渡,而不是加载新的场景中间过渡。
*/
abstract class SceneTransition {
/** 该函数应返回新加载的场景 */
protected sceneLoadAction: () => Scene;
/**
* 在loadNextScene执行时调用
* 这在进行场景间转换时非常有用,这样您就可以知道何时可以重新设置相机或重置任何实体
*/
onScreenObscured: Function;
/**
* 转换完成后调用,以便调用其他工作,例如启动另一个场景转换
*/
onTransitionCompleted: Function;
/**
* 指示此转换是否将加载新场景的标志
*/
_loadsNewScene: boolean;
private _hasPreviousSceneRender;
readonly hasPreviousSceneRender: boolean;
/**
* 将此用于两部分过渡。例如,褪色会先褪色为黑色,然后当_isNewSceneLoaded变为true时会褪色。
* 对于场景内转换,应在中点将isNewSceneLoaded设置为true,就像加载了新场景一样
*/
_isNewSceneLoaded: boolean;
protected constructor(sceneLoadAction: () => Scene);
protected LoadNextScene(): IterableIterator<string>;
/**
* 在前一个场景出现第一次(也是唯一一次)后调用。
* 此时,可以在生成一帧后加载新场景(因此第一次渲染调用发生在场景加载之前)
*/
onBeginTransition(): any;
/**
* 在渲染场景之前调用
*/
preRender(): void;
/**
* 在这里进行所有渲染
*/
render(): void;
/**
* 当过渡完成且新场景已设置时,将调用此函数
*/
protected transitionComplete(): void;
}
}
declare module es {
enum ComponentTransform {
position = 0,
scale = 1,
rotation = 2
}
enum DirtyType {
clean = 0,
positionDirty = 1,
scaleDirty = 2,
rotationDirty = 4
}
class Transform {
/** 与此转换关联的实体 */
readonly entity: Entity;
hierarchyDirty: DirtyType;
_localDirty: boolean;
_localPositionDirty: boolean;
_localScaleDirty: boolean;
_localRotationDirty: boolean;
_positionDirty: boolean;
_worldToLocalDirty: boolean;
_worldInverseDirty: boolean;
/**
* 值会根据位置、旋转和比例自动重新计算
*/
_localTransform: Matrix2D;
/**
* 值将自动从本地和父矩阵重新计算。
*/
_worldTransform: Matrix2D;
_rotationMatrix: Matrix2D;
_translationMatrix: Matrix2D;
_scaleMatrix: Matrix2D;
_children: Transform[];
constructor(entity: Entity);
/**
* 这个转换的所有子元素
*/
readonly childCount: number;
/**
* 变换在世界空间的旋转度
*/
/**
* 变换在世界空间的旋转度
* @param value
*/
rotationDegrees: number;
/**
* 旋转相对于父变换旋转的角度
*/
/**
* 旋转相对于父变换旋转的角度
* @param value
*/
localRotationDegrees: number;
readonly localToWorldTransform: Matrix2D;
_parent: Transform;
/**
* 获取此转换的父转换
*/
/**
* 设置此转换的父转换
* @param value
*/
parent: Transform;
_worldToLocalTransform: Matrix2D;
readonly worldToLocalTransform: Matrix2D;
_worldInverseTransform: Matrix2D;
readonly worldInverseTransform: Matrix2D;
_position: Vector2;
/**
* 变换在世界空间中的位置
*/
/**
* 变换在世界空间中的位置
* @param value
*/
position: Vector2;
_scale: Vector2;
/**
* 变换在世界空间的缩放
*/
/**
* 变换在世界空间的缩放
* @param value
*/
scale: Vector2;