/
Crafty-loader.html
145 lines (122 loc) · 8.85 KB
/
Crafty-loader.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Crafty - JavaScript Game Engine</title>
<link type="text/css" rel="stylesheet" href="../global.css"/>
<link href='http://fonts.googleapis.com/css?family=Arvo:regular,bold' rel='stylesheet' type='text/css'>
<link rel="shortcut icon" href="../favicon.ico">
</head>
<body>
<div id="header">
<div id="inner">
<a href="http://craftyjs.com"><img id="logo" src="../images/logo.png" alt="Crafty - JavaScript Game Engine" /></a>
<ul>
<li><a href="http://craftyjs.com/tutorial/">Getting Started</a></li>
<li><a href="api/">Documentation</a></li>
<li><a href="https://groups.google.com/forum/#!forum/craftyjs">Forum</a></li>
<li><a href="http://craftycomponents.com/">Modules</a></li>
<li class="emph"><a href="http://craftycomponents.com/components/single/8/crafty">Download</a></li>
</ul>
</div>
</div>
<div id="main">
<div id="main-left"></div>
<div id="main-right"></div>
<div id="content"><div id='doc-nav'><ul id='doc-level-one'><li><a href='events.html'>List of Events</a></li><li>Core<ul><li><a href='Crafty.html'>Crafty</a></li><li><a href='Crafty-Core.html'>Crafty Core</a></li><li><a href='Crafty-extend.html'>Crafty.extend</a></li><li><a href='Crafty-init.html'>Crafty.init</a></li><li><a href='Crafty-stop.html'>Crafty.stop</a></li><li><a href='Crafty-pause.html'>Crafty.pause</a></li><li><a href='Crafty-isPaused.html'>Crafty.isPaused</a></li><li><a href='Crafty-addEntityFactory.html'>Crafty.addEntityFactory</a></li><li><a href='Crafty-newFactoryEntity.html'>Crafty.newFactoryEntity</a></li><li><a href='Crafty-e.html'>Crafty.e</a></li><li><a href='Crafty-c.html'>Crafty.c</a></li><li><a href='Crafty-trigger.html'>Crafty.trigger</a></li><li><a href='Crafty-bind.html'>Crafty.bind</a></li><li><a href='Crafty-unbind.html'>Crafty.unbind</a></li><li><a href='Crafty-frame.html'>Crafty.frame</a></li><li><a href='Crafty-settings.html'>Crafty.settings</a></li><li><a href='Crafty-clone.html'>Crafty.clone</a></li><li><a href='Crafty-support.html'>Crafty.support</a></li><li><a href='Crafty-stage.html'>Crafty.stage</a></li></ul></li><li>Internal<ul><li><a href='Crafty-timer.html'>Crafty.timer</a></li></ul></li><li>Events<ul><li><a href='Crafty-trigger.html'>Crafty.trigger</a></li><li><a href='Crafty-bind.html'>Crafty.bind</a></li><li><a href='Crafty-unbind.html'>Crafty.unbind</a></li><li><a href='Crafty-addEvent.html'>Crafty.addEvent</a></li><li><a href='Crafty-removeEvent.html'>Crafty.removeEvent</a></li></ul></li><li>2D<ul><li><a href='Crafty-HashMap.html'>Crafty.HashMap</a></li><li><a href='Crafty-map.html'>Crafty.map</a></li><li><a href='2D.html'>2D</a></li><li><a href='Gravity.html'>Gravity</a></li><li><a href='Crafty-polygon.html'>Crafty.polygon</a></li><li><a href='Crafty-circle.html'>Crafty.circle</a></li><li><a href='Collision.html'>Collision</a></li><li><a href='Crafty-isometric.html'>Crafty.isometric</a></li><li><a href='Crafty-math.html'>Crafty.math</a></li><li><a href='Crafty-math-Vector2D.html'>Crafty.math.Vector2D</a></li><li><a href='Crafty-math-Matrix2D.html'>Crafty.math.Matrix2D</a></li></ul></li><li>Graphics<ul><li><a href='DOM.html'>DOM</a></li><li><a href='Crafty-DOM.html'>Crafty.DOM</a></li><li><a href='HTML.html'>HTML</a></li><li><a href='Crafty-sprite.html'>Crafty.sprite</a></li><li><a href='Crafty-background.html'>Crafty.background</a></li><li><a href='Sprite.html'>Sprite</a></li><li><a href='Canvas.html'>Canvas</a></li><li><a href='Crafty-canvas.html'>Crafty.canvas</a></li><li><a href='Color.html'>Color</a></li><li><a href='Tint.html'>Tint</a></li><li><a href='Image.html'>Image</a></li><li><a href='Crafty-toRGB.html'>Crafty.toRGB</a></li><li><a href='Crafty-DrawManager.html'>Crafty.DrawManager</a></li><li><a href='Text.html'>Text</a></li></ul></li><li>Utilities<ul><li><a href='Storage.html'>Storage</a></li><li><a href='Crafty-Time.html'>Crafty Time</a></li></ul></li><li>Misc<ul><li><a href='Crafty-support.html'>Crafty.support</a></li><li><a href='Crafty-addEvent.html'>Crafty.addEvent</a></li><li><a href='Crafty-removeEvent.html'>Crafty.removeEvent</a></li><li><a href='Crafty-device.html'>Crafty.device</a></li></ul></li><li>Stage<ul><li><a href='Crafty-background.html'>Crafty.background</a></li><li><a href='Crafty-viewport.html'>Crafty.viewport</a></li><li><a href='Crafty-scene.html'>Crafty.scene</a></li></ul></li><li>Input<ul><li><a href='Crafty-keys.html'>Crafty.keys</a></li><li><a href='Crafty-mouseButtons.html'>Crafty.mouseButtons</a></li><li><a href='Crafty-keydown.html'>Crafty.keydown</a></li><li><a href='Crafty-touchDispatch.html'>Crafty.touchDispatch</a></li><li><a href='KeyboardEvent.html'>KeyboardEvent</a></li><li><a href='Crafty-eventObject.html'>Crafty.eventObject</a></li><li><a href='Mouse.html'>Mouse</a></li><li><a href='Draggable.html'>Draggable</a></li><li><a href='Keyboard.html'>Keyboard</a></li><li><a href='Multiway.html'>Multiway</a></li><li><a href='Fourway.html'>Fourway</a></li><li><a href='Twoway.html'>Twoway</a></li></ul></li><li>Animation<ul><li><a href='SpriteAnimation.html'>SpriteAnimation</a></li><li><a href='Tween.html'>Tween</a></li></ul></li><li>Scenes<ul><li><a href='Crafty-scene.html'>Crafty.scene</a></li></ul></li><li>Audio<ul><li><a href='Crafty-audio.html'>Crafty.audio</a></li></ul></li><li>Assets<ul><li><a href='Crafty-assets.html'>Crafty.assets</a></li><li><a href='Crafty-asset.html'>Crafty.asset</a></li><li><a href='Crafty-image_whitelist.html'>Crafty.image_whitelist</a></li><li><a href='Crafty-loader.html'>Crafty.loader</a></li><li><a href='Crafty-modules.html'>Crafty.modules</a></li></ul></li></ul></div><div id='doc-content'><h1>Crafty.loader</h1>
<p><code>public void Crafty.load(Array assets, Function onLoad[, Function onProgress, Function onError])</code></p>
<dl>
<dt>assets</dt>
<dd>Array of assets to load (accepts sounds and images)</dd>
<dt>onLoad</dt>
<dd>Callback when the assets are loaded</dd>
<dt>onProgress</dt>
<dd>Callback when an asset is loaded. Contains information about assets loaded</dd>
<dt>onError</dt>
<dd>Callback when an asset fails to load</dd>
</dl>
<p>Preloader for all assets. Takes an array of URLs and
adds them to the <code>Crafty.assets</code> object.</p>
<p>Files with suffixes in <code>image_whitelist</code> (case insensitive) will be loaded.</p>
<p>If <code>Crafty.support.audio</code> is <code>true</code>, files with the following suffixes <code>mp3</code>, <code>wav</code>, <code>ogg</code> and <code>mp4</code> (case insensitive) can be loaded.</p>
<p>The <code>onProgress</code> function will be passed on object with information about
the progress including how many assets loaded, total of all the assets to
load and a percentage of the progress.</p>
<pre><code>{ loaded: j, total: total, percent: (j / total * 100) ,src:src})
</code></pre>
<p><code>onError</code> will be passed with the asset that couldn't load.</p>
<p>When <code>onError</code> is not provided, the onLoad is loaded even some assets are not successfully loaded. Otherwise, onLoad will be called no matter whether there are errors or not.</p>
<h3>Example</h3>
<pre><code>Crafty.load(["images/sprite.png", "sounds/jump.mp3"],
function() {
//when loaded
Crafty.scene("main"); //go to main scene
Crafty.audio.play("jump.mp3"); //Play the audio file
},
function(e) {
//progress
},
function(e) {
//uh oh, error loading
}
);
</code></pre>
<h3>See Also</h3>
<ul>
<li><a href="Crafty-assets.html">Crafty.assets
</a></li>
</ul>
<h3>See Also</h3>
<ul>
<li><a href="Crafty-image_whitelist.html">Crafty.image_whitelist
</a></li>
</ul>
</div></div>
</div>
<div class="clearer"></div>
<div id="footer">
<div id="contact">
<a href="http://twitter.com/craftyjs">
<img src="/images/twitter.png" />
@craftyjs
</a>
<a href="http://webchat.freenode.net">
<img src="/images/comment.png" />
#crafty@freenode.net
</a>
<a href="https://groups.google.com/forum/#!forum/craftyjs">
<img src="/images/google.png" />
google groups
</a>
<a href="mailto:louis@craftyjs.com">
<img src="/images/email.png" />
louis@craftyjs.com
</a>
<a href="https://github.com/craftyjs/Crafty">
<img src="/images/github.png" />
github
</a>
</div>
<ul>
<li>
<a href="/api/">Documentation</a>
</li>
<li>
<a href="http://craftycomponents.com/">Modules</a>
</li>
<li>
<a href="https://groups.google.com/forum/#!forum/craftyjs">Forum</a>
</li>
<li>
<a href="/tutorial/">Tutorial</a>
</li>
<li>
<a href="http://craftycomponents.com/components/single/8/crafty">Download</a>
</li>
</ul>
<p>
© Crafty 2010. Crafty is distributed under the <a href="http://en.wikipedia.org/wiki/MIT_License">MIT</a> or <a href="http://en.wikipedia.org/wiki/GNU_General_Public_License">GPL</a>
license.
</p>
</div>
</body>
</html>