-
Notifications
You must be signed in to change notification settings - Fork 193
/
Copy pathsrc_file_File.ts.html
1814 lines (1431 loc) · 52.8 KB
/
src_file_File.ts.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>src\file\File.ts - Kiwi.js</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="Kiwi.js"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 1.4.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/Kiwi.Animations.Animation.html">Kiwi.Animations.Animation</a></li>
<li><a href="../classes/Kiwi.Animations.Sequence.html">Kiwi.Animations.Sequence</a></li>
<li><a href="../classes/Kiwi.Animations.Tween.html">Kiwi.Animations.Tween</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Back.html">Kiwi.Animations.Tweens.Easing.Back</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Bounce.html">Kiwi.Animations.Tweens.Easing.Bounce</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Circular.html">Kiwi.Animations.Tweens.Easing.Circular</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Cubic.html">Kiwi.Animations.Tweens.Easing.Cubic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Elastic.html">Kiwi.Animations.Tweens.Easing.Elastic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Exponential.html">Kiwi.Animations.Tweens.Easing.Exponential</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Linear.html">Kiwi.Animations.Tweens.Easing.Linear</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Quadratic.html">Kiwi.Animations.Tweens.Easing.Quadratic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Quartic.html">Kiwi.Animations.Tweens.Easing.Quartic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Quintic.html">Kiwi.Animations.Tweens.Easing.Quintic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Sinusoidal.html">Kiwi.Animations.Tweens.Easing.Sinusoidal</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.TweenManager.html">Kiwi.Animations.Tweens.TweenManager</a></li>
<li><a href="../classes/Kiwi.Camera.html">Kiwi.Camera</a></li>
<li><a href="../classes/Kiwi.CameraManager.html">Kiwi.CameraManager</a></li>
<li><a href="../classes/Kiwi.Component.html">Kiwi.Component</a></li>
<li><a href="../classes/Kiwi.ComponentManager.html">Kiwi.ComponentManager</a></li>
<li><a href="../classes/Kiwi.Components.AnimationManager.html">Kiwi.Components.AnimationManager</a></li>
<li><a href="../classes/Kiwi.Components.ArcadePhysics.html">Kiwi.Components.ArcadePhysics</a></li>
<li><a href="../classes/Kiwi.Components.Box.html">Kiwi.Components.Box</a></li>
<li><a href="../classes/Kiwi.Components.Input.html">Kiwi.Components.Input</a></li>
<li><a href="../classes/Kiwi.Components.Sound.html">Kiwi.Components.Sound</a></li>
<li><a href="../classes/Kiwi.Entity.html">Kiwi.Entity</a></li>
<li><a href="../classes/Kiwi.Files.AudioFile.html">Kiwi.Files.AudioFile</a></li>
<li><a href="../classes/Kiwi.Files.DataFile.html">Kiwi.Files.DataFile</a></li>
<li><a href="../classes/Kiwi.Files.DataLibrary.html">Kiwi.Files.DataLibrary</a></li>
<li><a href="../classes/Kiwi.Files.File.html">Kiwi.Files.File</a></li>
<li><a href="../classes/Kiwi.Files.FileStore.html">Kiwi.Files.FileStore</a></li>
<li><a href="../classes/Kiwi.Files.Loader.html">Kiwi.Files.Loader</a></li>
<li><a href="../classes/Kiwi.Files.TextureFile.html">Kiwi.Files.TextureFile</a></li>
<li><a href="../classes/Kiwi.Game.html">Kiwi.Game</a></li>
<li><a href="../classes/Kiwi.GameManager.html">Kiwi.GameManager</a></li>
<li><a href="../classes/Kiwi.GameObjects.Sprite.html">Kiwi.GameObjects.Sprite</a></li>
<li><a href="../classes/Kiwi.GameObjects.StaticImage.html">Kiwi.GameObjects.StaticImage</a></li>
<li><a href="../classes/Kiwi.GameObjects.TextField.html">Kiwi.GameObjects.TextField</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileMap.html">Kiwi.GameObjects.Tilemap.TileMap</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileMapLayer.html">Kiwi.GameObjects.Tilemap.TileMapLayer</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileMapLayerIsometric.html">Kiwi.GameObjects.Tilemap.TileMapLayerIsometric</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileMapLayerOrthogonal.html">Kiwi.GameObjects.Tilemap.TileMapLayerOrthogonal</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileType.html">Kiwi.GameObjects.Tilemap.TileType</a></li>
<li><a href="../classes/Kiwi.Geom.AABB.html">Kiwi.Geom.AABB</a></li>
<li><a href="../classes/Kiwi.Geom.Circle.html">Kiwi.Geom.Circle</a></li>
<li><a href="../classes/Kiwi.Geom.Intersect.html">Kiwi.Geom.Intersect</a></li>
<li><a href="../classes/Kiwi.Geom.IntersectResult.html">Kiwi.Geom.IntersectResult</a></li>
<li><a href="../classes/Kiwi.Geom.Line.html">Kiwi.Geom.Line</a></li>
<li><a href="../classes/Kiwi.Geom.Matrix.html">Kiwi.Geom.Matrix</a></li>
<li><a href="../classes/Kiwi.Geom.Point.html">Kiwi.Geom.Point</a></li>
<li><a href="../classes/Kiwi.Geom.Ray.html">Kiwi.Geom.Ray</a></li>
<li><a href="../classes/Kiwi.Geom.Rectangle.html">Kiwi.Geom.Rectangle</a></li>
<li><a href="../classes/Kiwi.Geom.Transform.html">Kiwi.Geom.Transform</a></li>
<li><a href="../classes/Kiwi.Geom.Vector2.html">Kiwi.Geom.Vector2</a></li>
<li><a href="../classes/Kiwi.Group.html">Kiwi.Group</a></li>
<li><a href="../classes/Kiwi.HUD.HUDComponents.Counter.html">Kiwi.HUD.HUDComponents.Counter</a></li>
<li><a href="../classes/Kiwi.HUD.HUDComponents.Time.html">Kiwi.HUD.HUDComponents.Time</a></li>
<li><a href="../classes/Kiwi.HUD.HUDComponents.WidgetInput.html">Kiwi.HUD.HUDComponents.WidgetInput</a></li>
<li><a href="../classes/Kiwi.HUD.HUDDisplay.html">Kiwi.HUD.HUDDisplay</a></li>
<li><a href="../classes/Kiwi.HUD.HUDManager.html">Kiwi.HUD.HUDManager</a></li>
<li><a href="../classes/Kiwi.HUD.HUDWidget.html">Kiwi.HUD.HUDWidget</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Bar.html">Kiwi.HUD.Widget.Bar</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.BasicScore.html">Kiwi.HUD.Widget.BasicScore</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Button.html">Kiwi.HUD.Widget.Button</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Icon.html">Kiwi.HUD.Widget.Icon</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.IconBar.html">Kiwi.HUD.Widget.IconBar</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Menu.html">Kiwi.HUD.Widget.Menu</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.MenuItem.html">Kiwi.HUD.Widget.MenuItem</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.TextField.html">Kiwi.HUD.Widget.TextField</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Time.html">Kiwi.HUD.Widget.Time</a></li>
<li><a href="../classes/Kiwi.IChild.html">Kiwi.IChild</a></li>
<li><a href="../classes/Kiwi.Input.Finger.html">Kiwi.Input.Finger</a></li>
<li><a href="../classes/Kiwi.Input.InputManager.html">Kiwi.Input.InputManager</a></li>
<li><a href="../classes/Kiwi.Input.Key.html">Kiwi.Input.Key</a></li>
<li><a href="../classes/Kiwi.Input.Keyboard.html">Kiwi.Input.Keyboard</a></li>
<li><a href="../classes/Kiwi.Input.Keycodes.html">Kiwi.Input.Keycodes</a></li>
<li><a href="../classes/Kiwi.Input.Mouse.html">Kiwi.Input.Mouse</a></li>
<li><a href="../classes/Kiwi.Input.MouseCursor.html">Kiwi.Input.MouseCursor</a></li>
<li><a href="../classes/Kiwi.Input.Pointer.html">Kiwi.Input.Pointer</a></li>
<li><a href="../classes/Kiwi.Input.Touch.html">Kiwi.Input.Touch</a></li>
<li><a href="../classes/Kiwi.PluginManager.html">Kiwi.PluginManager</a></li>
<li><a href="../classes/Kiwi.Renderers.CanvasRenderer.html">Kiwi.Renderers.CanvasRenderer</a></li>
<li><a href="../classes/Kiwi.Renderers.GLArrayBuffer.html">Kiwi.Renderers.GLArrayBuffer</a></li>
<li><a href="../classes/Kiwi.Renderers.GLBlendMode.html">Kiwi.Renderers.GLBlendMode</a></li>
<li><a href="../classes/Kiwi.Renderers.GLElementArrayBuffer.html">Kiwi.Renderers.GLElementArrayBuffer</a></li>
<li><a href="../classes/Kiwi.Renderers.GLRenderManager.html">Kiwi.Renderers.GLRenderManager</a></li>
<li><a href="../classes/Kiwi.Renderers.GLTextureManager.html">Kiwi.Renderers.GLTextureManager</a></li>
<li><a href="../classes/Kiwi.Renderers.GLTextureWrapper.html">Kiwi.Renderers.GLTextureWrapper</a></li>
<li><a href="../classes/Kiwi.Renderers.Renderer.html">Kiwi.Renderers.Renderer</a></li>
<li><a href="../classes/Kiwi.Renderers.TextureAtlasRenderer.html">Kiwi.Renderers.TextureAtlasRenderer</a></li>
<li><a href="../classes/Kiwi.Shaders.ShaderManager.html">Kiwi.Shaders.ShaderManager</a></li>
<li><a href="../classes/Kiwi.Shaders.ShaderPair.html">Kiwi.Shaders.ShaderPair</a></li>
<li><a href="../classes/Kiwi.Shaders.TextureAtlasShader.html">Kiwi.Shaders.TextureAtlasShader</a></li>
<li><a href="../classes/Kiwi.Signal.html">Kiwi.Signal</a></li>
<li><a href="../classes/Kiwi.SignalBinding.html">Kiwi.SignalBinding</a></li>
<li><a href="../classes/Kiwi.Sound.Audio.html">Kiwi.Sound.Audio</a></li>
<li><a href="../classes/Kiwi.Sound.AudioLibrary.html">Kiwi.Sound.AudioLibrary</a></li>
<li><a href="../classes/Kiwi.Sound.AudioManager.html">Kiwi.Sound.AudioManager</a></li>
<li><a href="../classes/Kiwi.Stage.html">Kiwi.Stage</a></li>
<li><a href="../classes/Kiwi.State.html">Kiwi.State</a></li>
<li><a href="../classes/Kiwi.StateConfig.html">Kiwi.StateConfig</a></li>
<li><a href="../classes/Kiwi.StateManager.html">Kiwi.StateManager</a></li>
<li><a href="../classes/Kiwi.System.Bootstrap.html">Kiwi.System.Bootstrap</a></li>
<li><a href="../classes/Kiwi.System.Device.html">Kiwi.System.Device</a></li>
<li><a href="../classes/Kiwi.Textures.SingleImage.html">Kiwi.Textures.SingleImage</a></li>
<li><a href="../classes/Kiwi.Textures.SpriteSheet.html">Kiwi.Textures.SpriteSheet</a></li>
<li><a href="../classes/Kiwi.Textures.TextureAtlas.html">Kiwi.Textures.TextureAtlas</a></li>
<li><a href="../classes/Kiwi.Textures.TextureLibrary.html">Kiwi.Textures.TextureLibrary</a></li>
<li><a href="../classes/Kiwi.Time.Clock.html">Kiwi.Time.Clock</a></li>
<li><a href="../classes/Kiwi.Time.ClockManager.html">Kiwi.Time.ClockManager</a></li>
<li><a href="../classes/Kiwi.Time.MasterClock.html">Kiwi.Time.MasterClock</a></li>
<li><a href="../classes/Kiwi.Time.Timer.html">Kiwi.Time.Timer</a></li>
<li><a href="../classes/Kiwi.Time.TimerEvent.html">Kiwi.Time.TimerEvent</a></li>
<li><a href="../classes/Kiwi.Utils.Canvas.html">Kiwi.Utils.Canvas</a></li>
<li><a href="../classes/Kiwi.Utils.Color.html">Kiwi.Utils.Color</a></li>
<li><a href="../classes/Kiwi.Utils.Common.html">Kiwi.Utils.Common</a></li>
<li><a href="../classes/Kiwi.Utils.GameMath.html">Kiwi.Utils.GameMath</a></li>
<li><a href="../classes/Kiwi.Utils.Log.html">Kiwi.Utils.Log</a></li>
<li><a href="../classes/Kiwi.Utils.RandomDataGenerator.html">Kiwi.Utils.RandomDataGenerator</a></li>
<li><a href="../classes/Kiwi.Utils.RequestAnimationFrame.html">Kiwi.Utils.RequestAnimationFrame</a></li>
<li><a href="../classes/Kiwi.Utils.Version.html">Kiwi.Utils.Version</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/Animations.html">Animations</a></li>
<li><a href="../modules/Components.html">Components</a></li>
<li><a href="../modules/Easing.html">Easing</a></li>
<li><a href="../modules/Files.html">Files</a></li>
<li><a href="../modules/GameObjects.html">GameObjects</a></li>
<li><a href="../modules/Geom.html">Geom</a></li>
<li><a href="../modules/HUD.html">HUD</a></li>
<li><a href="../modules/HUDComponents.html">HUDComponents</a></li>
<li><a href="../modules/Input.html">Input</a></li>
<li><a href="../modules/Kiwi.html">Kiwi</a></li>
<li><a href="../modules/Renderers.html">Renderers</a></li>
<li><a href="../modules/Shaders.html">Shaders</a></li>
<li><a href="../modules/Sound.html">Sound</a></li>
<li><a href="../modules/System.html">System</a></li>
<li><a href="../modules/Textures.html">Textures</a></li>
<li><a href="../modules/Tilemap.html">Tilemap</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/Tweens.html">Tweens</a></li>
<li><a href="../modules/Utils.html">Utils</a></li>
<li><a href="../modules/Utils..html">Utils.</a></li>
<li><a href="../modules/Widget.html">Widget</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1 class="file-heading">File: src\file\File.ts</h1>
<div class="file">
<pre class="code prettyprint linenums">
/**
*
* @module Kiwi
* @submodule Files
*
*/
module Kiwi.Files {
/**
* Base class which handles the loading of an external data file an xhr.
* TextureFile, AudioFile contain fallback loading via tags and all extended Files contain methods for processing the files.
*
* Also can contain information about the file (like file size, last modified, e.t.c.)
* Uses an object literal in its constructor since 1.2 (which is preferred), but also contains previous construction support.
*
* @class File
* @namespace Kiwi.Files
* @constructor
* @param game {Kiwi.Game} The game that this file is for
* @param params {Object} Options for this file.
* @param params.key {String} User defined name for this file. This would be how the user would access it in the file store.
* @param params.url {String} Location of the file to be loaded.
* @param {Object} [params.metadata={}] Any metadata to be associated with the file.
* @param [params.state=null] {Kiwi.State} The state that this file belongs to. Used for defining global assets vs local assets.
* @param [params.fileStore=null] {Kiwi.Files.FileStore} The filestore that this file should be save in automatically when loaded.
* @param [params.type=UNKNOWN] {Number} The type of file this is.
* @param [params.tags] {Array} Any tags to be associated with this file.
* @param [params.timeout=TIMEOUT_DELAY] {Number} Sets the timeout delay when loading via ajax.
* @return {Kiwi.Files.File}
*
*/
export class File {
constructor(game: Kiwi.Game, params:any) {
this.game = game;
this.onComplete = new Kiwi.Signal;
this.onProgress = new Kiwi.Signal;
if (Kiwi.Utils.Common.isNumeric(params)) {
//Deprecate
this._parseParamsOld(params, arguments[2], arguments[3], arguments[4], arguments[5]);
} else {
this.key = params.key;
this._assignFileDetails(params.url);
this.parseParams(params);
}
}
/**
* Assigns properties and variables for the constructor as in pre 1.2 Kiwi versions.
*
* @method _parseParamsOld
* @since 1.2.0
* @param dataType {Number} The type of file that is being loaded. For this you can use the STATIC properties that are located on this class for quick code completion.
* @param path {String} The location of the file that is to be loaded.
* @param [name=''] {String} A name for the file. If no name is specified then the files name will be used.
* @param [saveToFileStore=true] {Boolean} If the file should be saved on the file store or not.
* @param [storeAsGlobal=true] {Boolean} If this file should be stored as a global file, or if it should be destroyed when this state gets switched out.
* @private
*/
private _parseParamsOld(dataType: number, url: string, name: string = '', saveToFileStore: boolean = true, storeAsGlobal: boolean = true) {
this.dataType = dataType;
this._assignFileDetails(url);
if (saveToFileStore) {
this.fileStore = this.game.fileStore;
}
if (this.game.states.current && !storeAsGlobal) {
this.ownerState = this.game.states.current;
}
}
/**
* Sets properties for this instance based on an object literal passed. Used when the class is being created.
*
* @method parseParams
* @since 1.2.0
* @param [params] {Object}
* @param [params.metadata={}] {Object} Any metadata to be associated with the file.
* @param [params.state=null] {Kiwi.State} The state that this file belongs to. Used for defining global assets vs local assets.
* @param [params.fileStore=null] {Kiwi.Files.FileStore} The filestore that this file should be save in automatically when loaded.
* @param [params.type=UNKNOWN] {Number} The type of file this is.
* @param [params.tags] {Array} Any tags to be associated with this file.
* @param [params.timeout=TIMEOUT_DELAY] {Number} Sets the timeout delay when loading via ajax.
* @protected
*/
protected parseParams(params: any) {
this.fileStore = params.fileStore || null;
this.ownerState = params.state || null;
this.metadata = params.metadata || {};
if ( Kiwi.Utils.Common.isUndefined(params.timeout) ) {
this.timeOutDelay = params.timeout;
} else {
this.timeOutDelay = Kiwi.Files.File.TIMEOUT_DELAY;
}
if (Kiwi.Utils.Common.isUndefined(params.type)) {
this.dataType = File.UNKNOWN;
} else {
this.dataType = params.type;
}
if (params.tags && Kiwi.Utils.Common.isArray(params.tags)) {
for (var i = 0; i < params.tags.length; i++) {
this.addTag(params.tags[i]);
}
}
}
/**
* Gets the file details from the URL passed. Name, extension, and path are extracted.
*
* @method _assignFileDetails
* @param url {String}
* @private
* @since 1.2.0
*/
private _assignFileDetails( url:string ) {
this.URL = url;
if ( url.lastIndexOf('/') > -1) {
this.name = url.substr( url.lastIndexOf('/') + 1 );
this.path = url.substr(0, url.lastIndexOf('/') + 1);
} else {
this.path = '';
this.name = url;
}
// Not safe if there is a query string after the file extension
this.extension = url.substr( url.lastIndexOf('.') + 1).toLowerCase();
}
/**
* Returns the type of this object
* @method objType
* @return {String} "File"
* @public
*/
public objType() {
return "File";
}
/**
* The game that this file belongs to.
* @property game
* @type Kiwi.Game
* @since 1.2.0
* @public
*/
public game: Kiwi.Game;
/**
* ---------------
* Generic Properties
* ---------------
**/
/**
* Indicates if this file can be loaded in parallel to other files.
* This is usually only used files are using the tag loaders and not XHR.
*
* @property _loadInParallel
* @type Boolean
* @default false
* @since 1.2.0
* @private
*/
protected _loadInParallel: boolean = false;
/**
* READ ONLY: Indicates if this file can be loaded in parallel to other files.
* This is usually only used files are using the tag loaders and not XHR.
*
* @property loadInParallel
* @type Boolean
* @default false
* @readOnly
* @since 1.2.0
* @private
*/
public get loadInParallel(): boolean {
return this._loadInParallel;
}
/**
* The filestore this file should be added to when it has loaded.
* This can be replaced with a custom one if wanted.
*
* @property fileStore
* @type Kiwi.Files.FileStore
* @since 1.2.0
* @public
*/
public fileStore: Kiwi.Files.FileStore;
/**
* If this file is using tag loading instead of the XHR method.
* Only used by extended classes
*
* @property useTagLoader
* @type Boolean
* @since 1.2.0
* @protected
*/
protected useTagLoader: boolean = false;
/**
* The 'key' is the user defined name and the users way of accessing this file once loaded.
* @property key
* @type String
* @public
*/
public key: string;
/**
* A dictionary, stores any information relating to this file.
* Used when loading images that are to be used as a spritesheet or texture atlas.
* @property data
* @type Any
* @public
*/
public metadata: any;
/**
* Holds the type of data that is being loaded.
* This should be used with the STATIC properties that hold the various datatypes that can be loaded.
*
* @property dataType
* @type String
* @public
*/
public dataType: number;
/**
* ---------------
* File Information
* ---------------
*/
/**
* The name of the file being loaded.
*
* @property name
* @type String
* @since 1.2.0
* @public
*/
public name: string;
/**
* The location of where the file is placed without the file itself (So without the files name).
* Example: If the file you are load is located at 'images/awesomeImage.png' then the filepath will be 'images/'
*
* @property path
* @type String
* @since 1.2.0
* @public
*/
public path: string;
/**
* The extension of the file that is being loaded.
* This is based upon what the file path that the developer specifies.
*
* @property extension
* @type String
* @since 1.2.0
* @public
*/
public extension: string;
/**
* The full filepath including the file itself.
*
* @property URL
* @type String
* @since 1.2.0
* @public
*/
public URL: string;
/**
* The type of file that is being loaded.
* Is only ever given a value when used with the XHR method of loading OR if you use 'loadDetails' before hand.
* The value is based off of the 'Content-Type' of the XHR's response header returns.
*
* @property type
* @type String
* @public
*/
public type: string;
/**
* The size of the file that was/is being loaded.
* Only has a value when the file was loaded by the XHR method OR you request the file information beforehand using 'loadDetails'.
*
* @property size
* @type Number
* @default 0
* @since 1.2.0
* @public
*/
public size: number = 0;
/**
* ---------------
* Callbacks
* ---------------
*/
/**
* Signal which dispatches events when the file has successfully loaded.
*
* @property onComplete
* @type Kiwi.Signal
* @since 1.2.0
* @public
*/
public onComplete: Kiwi.Signal;
/**
* Signal which dispatches events when the file is loading.
* Not guarenteed to dispatch events as it depends on the method of loading being performed
*
* @property onProgress
* @type Kiwi.Signal
* @since 1.2.0
* @public
*/
public onProgress: Kiwi.Signal;
/**
* ---------------
* Loading
* ---------------
**/
/**
* The particular piece of data that the developer wanted loaded. This is in a format that is based upon the datatype passed.
* @property data
* @type Any
* @public
*/
public data: any;
/**
* The number of milliseconds that the XHR should wait before timing out.
* Set this to NULL if you want it to not timeout.
*
* Default changed in v1.3.1 to null
*
* @property timeOutDelay
* @type Number
* @default null
* @public
*/
public timeOutDelay: number = Kiwi.Files.File.TIMEOUT_DELAY;
/**
* The default number of milliseconds that the XHR should wait before timing out.
* By default this is set to NULL, and so requests will not timeout.
*
* Default changed in v1.3.1 to null
*
* @property TIMEOUT_DELAY
* @type Number
* @static
* @since 1.2.0
* @default null
* @public
*/
public static TIMEOUT_DELAY: number = null;
/**
* The number of attempts at loading there have currently been at loading the file.
* This is only used with XHR methods of loading.
* @property attemptCounter
* @type Number
* @protected
*/
protected attemptCounter: number = 0;
/**
* The maximum attempts at loading the file that there is allowed.
* @property maxLoadAttempts
* @type Number
* @default 2
* @public
*/
public maxLoadAttempts: number = Kiwi.Files.File.MAX_LOAD_ATTEMPTS;
/**
* The default maximum attempts at loading the file that there is allowed.
* @property MAX_LOAD_ATTEMPTS
* @type Number
* @default 2
* @static
* @since 1.2.0
* @public
*/
public static MAX_LOAD_ATTEMPTS: number = 2;
/**
* Starts the loading process for this file.
* Passing parameters to this method has been deprecated and only exists for backwards compatibility.
*
* @method load
* @public
*/
public load(onCompleteCallback?: any, onProgressCallback?: any, customFileStore?: Kiwi.Files.FileStore, maxLoadAttempts?: number, timeout?: number) {
//Not currently loading?
if (this.loading) {
Kiwi.Log.error('Kiwi.Files.File: File loading is in progress. Cannot be told to load again.', '#loading');
return;
}
Kiwi.Log.log("Kiwi.Files.File: Starting to load '" + this.name + "'", '#file', '#loading');
//Set the variables based on the parameters passed
//To be deprecated
if (onCompleteCallback) this.onComplete.add( onCompleteCallback );
if (onProgressCallback) this.onProgress.add( onProgressCallback );
if (customFileStore) this.fileStore = customFileStore;
if (typeof maxLoadAttempts !== "undefined") this.maxLoadAttempts = maxLoadAttempts;
if (typeof timeout !== "undefined") this.timeOutDelay = timeout;
//Start Loading!!!
this._start();
this._load();
}
/**
* Increments the counter, and calls the approprate loading method.
* @method _load
* @since 1.2.0
* @protected
*/
protected _load() {
this.attemptCounter++;
this.xhrLoader( 'GET', 'text' );
}
/**
* Should be called by the loading method. Dispatches the 'onProgress' callback.
* @method loadProgress
* @since 1.2.0
* @protected
*/
protected loadProgress() {
this.onProgress.dispatch(this);
}
/**
* Called by the loading methods when the file has been loaded and successfully processed.
* Dispatches the 'onComplete' callback and sets the appropriate properties.
* @method loadSuccess
* @since 1.2.0
* @protected
*/
protected loadSuccess() {
//If already completed skip
if (this.complete) {
return;
}
this.success = true;
this.hasError = false;
this._stop();
if (this.fileStore) {
this.fileStore.addFile(this.key, this);
}
this.onComplete.dispatch(this);
}
/**
* Executed when the loading process fails.
* This could be for any reason
*
* @method loadError
* @param error {Any} The event / reason for the file to not be loaded.
* @since 1.2.0
* @protected
*/
protected loadError(error: any) {
//Try again?
if (this.attemptCounter >= this.maxLoadAttempts) {
//Failed
Kiwi.Log.log("Kiwi.Files.File: Failed to load file '" + this.name + "'. Trying Again", '#loading');
this.hasError = true;
this.success = false;
this.error = error;
this._stop();
this.onComplete.dispatch(this);
} else {
Kiwi.Log.log("Kiwi.Files.File: Failed to load file '" + this.name + "'", '#loading');
//Try Again
this._load();
}
}
/**
* ---------------
* XHR Loading
* ---------------
**/
/**
* Sets up a XHR loader based on the properties of this file and parameters passed.
*
* @method xhrLoader
* @param [method="GET"] {String} The method this request should be made in.
* @param [responseType="text"] {String} The type of response we are expecting.
* @param [timeoutDelay] {Number}
* @protected
*/
protected xhrLoader(method: string = 'GET', responseType: string = 'text', timeoutDelay: number = this.timeOutDelay) {
this._xhr = new XMLHttpRequest();
this._xhr.open(method, this.URL, true);
if (timeoutDelay !== null) {
this._xhr.timeout = timeoutDelay;
}
this._xhr.responseType = responseType;
this._xhr.onload = (event) => this.xhrOnLoad(event);
this._xhr.onerror = (event) => this.loadError(event);
this._xhr.onprogress = (event) => this.xhrOnProgress(event);
var _that = this;
this._xhr.onreadystatechange = function () {
_that.readyState = _that._xhr.readyState;
};
this._xhr.onloadstart = function (event) {
_that.timeStarted = event.timeStamp;
_that.lastProgress = event.timeStamp;
};
this._xhr.ontimeout = function(event) {
_that.hasTimedOut = true;
};
this._xhr.onloadend = function (event) {
_that.xhrOnLoad(event);
};
this._xhr.send();
}
/**
* Progress event fired whilst the file is loading via XHR.
* @method xhrOnProgress
* @param event {Any}
* @protected
*/
protected xhrOnProgress(event) {
this.bytesLoaded = parseInt(event.loaded);
this.bytesTotal = parseInt(event.total);
this.percentLoaded = Math.round((this.bytesLoaded / this.bytesTotal) * 100);
this.onProgress.dispatch(this);
}
/**
* Fired when the file has been loaded.
* Checks that the response contains information before marking it as a success.
*
* @method xhrOnLoad
* @param event {Any}
* @protected
*/
protected xhrOnLoad(event) {
//Deprecate
this.status = this._xhr.status;
this.statusText = this._xhr.statusText;
// If there is a status, then use that for our check. Otherwise we will base it on the response
if (this.status && this.status === 200 || !this.status && this._xhr.response) {
this._getXhrHeaderInfo();
this.buffer = this._xhr.response; //Deprecate
this.processXhr(this._xhr.response);
} else {
this.loadError(event);
}