/
Crafty Core.html
238 lines (224 loc) · 36.8 KB
/
Crafty Core.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
<!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 - Crafty Core</title>
<link type="text/css" rel="stylesheet" href="/craftyjs-site.css" />
<link href='http://fonts.googleapis.com/css?family=Arvo:regular,bold' rel='stylesheet' type='text/css'>
<link href='http://fonts.googleapis.com/css?family=Open+Sans:400,300,600' rel='stylesheet' type='text/css'>
<link rel="shortcut icon" href="/favicon.ico">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.5.2/jquery.min.js" type="text/javascript"></script>
<link rel="stylesheet" href="/github.css"/>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-23935213-2']);
_gaq.push(['_trackPageview']);
(function () {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id = "header-background"> </div>
<div id = "page-frame">
<div id="header">
<nav class="navbar">
<div class="container-fluid">
<div class="navbar-header">
<a class="navbar-brand" href="/"> <img class="logo" src="/images/text-logo.png" /> </a>
</div>
<div class="collapse navbar-collapse navbar-right" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav">
<li><a href="/">Home</a></li>
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/documentation/">Documentation</a></li>
<li><a href="/api/">API</a></li>
<li><a href="https://groups.google.com/forum/#!forum/craftyjs">Forum</a></li>
<li><a href="/components/">Components</a></li>
<li class="emph"><a href="/#install">Download</a></li>
</ul>
</div>
</div>
</nav>
</div>
<div id="main">
<div id="content" class="container">
<div id="docs"><div class="toc-holder" id="doc-nav"><ul id="doc-level-one"><li><a href="events.html">List of Events</a></li><li class="category">Core<ul class="category-list"><li><a href="Crafty.html">Crafty</a></li><li><a href="Crafty Core.html">Crafty Core</a></li><li><a href="Crafty-bind.html">Crafty.bind</a></li><li><a href="Crafty-c.html">Crafty.c</a></li><li><a href="Crafty-clone.html">Crafty.clone</a></li><li><a href="Crafty-e.html">Crafty.e</a></li><li><a href="Crafty-extend.html">Crafty.extend</a></li><li><a href="Crafty-frame.html">Crafty.frame</a></li><li><a href="Crafty-getVersion.html">Crafty.getVersion</a></li><li><a href="Crafty-init.html">Crafty.init</a></li><li><a href="Crafty-isPaused.html">Crafty.isPaused</a></li><li><a href="Crafty-one.html">Crafty.one</a></li><li><a href="Crafty-pause.html">Crafty.pause</a></li><li><a href="Crafty-settings.html">Crafty.settings</a></li><li><a href="Crafty-stage.html">Crafty.stage</a></li><li><a href="Crafty-stop.html">Crafty.stop</a></li><li><a href="Crafty-support.html">Crafty.support</a></li><li><a href="Crafty-trigger.html">Crafty.trigger</a></li><li><a href="Crafty-unbind.html">Crafty.unbind</a></li><li><a href="Crafty-uniqueBind.html">Crafty.uniqueBind</a></li></ul></li><li class="category">2D<ul class="category-list"><li><a href="2D.html">2D</a></li><li><a href="Collision.html">Collision</a></li><li><a href="Crafty-circle.html">Crafty.circle</a></li><li><a href="Crafty-diamondIso.html">Crafty.diamondIso</a></li><li><a href="Crafty-HashMap.html">Crafty.HashMap</a></li><li><a href="Crafty-isometric.html">Crafty.isometric</a></li><li><a href="Crafty-map.html">Crafty.map</a></li><li><a href="Crafty-math.html">Crafty.math</a></li><li><a href="Crafty-math-Matrix2D.html">Crafty.math.Matrix2D</a></li><li><a href="Crafty-math-Vector2D.html">Crafty.math.Vector2D</a></li><li><a href="Crafty-polygon.html">Crafty.polygon</a></li><li><a href="Gravity.html">Gravity</a></li></ul></li><li class="category">Animation<ul class="category-list"><li><a href="SpriteAnimation.html">SpriteAnimation</a></li><li><a href="Tween.html">Tween</a></li></ul></li><li class="category">Assets<ul class="category-list"><li><a href="Crafty-asset.html">Crafty.asset</a></li><li><a href="Crafty-assets.html">Crafty.assets</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-paths.html">Crafty.paths</a></li><li><a href="Crafty-removeAssets.html">Crafty.removeAssets</a></li></ul></li><li class="category">Audio<ul class="category-list"><li><a href="Crafty-audio.html">Crafty.audio</a></li></ul></li><li class="category">Debug<ul class="category-list"><li><a href="DebugCanvas.html">DebugCanvas</a></li><li><a href="DebugPolygon.html">DebugPolygon</a></li><li><a href="DebugRectangle.html">DebugRectangle</a></li><li><a href="SolidHitBox.html">SolidHitBox</a></li><li><a href="VisibleMBR.html">VisibleMBR</a></li><li><a href="WiredHitBox.html">WiredHitBox</a></li></ul></li><li class="category">Events<ul class="category-list"><li><a href="Crafty-addEvent.html">Crafty.addEvent</a></li><li><a href="Crafty-bind.html">Crafty.bind</a></li><li><a href="Crafty-one.html">Crafty.one</a></li><li><a href="Crafty-removeEvent.html">Crafty.removeEvent</a></li><li><a href="Crafty-trigger.html">Crafty.trigger</a></li><li><a href="Crafty-unbind.html">Crafty.unbind</a></li><li><a href="Crafty-uniqueBind.html">Crafty.uniqueBind</a></li></ul></li><li class="category">Game Loop<ul class="category-list"><li><a href="Crafty-timer.html">Crafty.timer</a></li></ul></li><li class="category">Graphics<ul class="category-list"><li><a href="Canvas.html">Canvas</a></li><li><a href="Color.html">Color</a></li><li><a href="Crafty-assignColor.html">Crafty.assignColor</a></li><li><a href="Crafty-background.html">Crafty.background</a></li><li><a href="Crafty-canvas.html">Crafty.canvas</a></li><li><a href="Crafty-DOM.html">Crafty.DOM</a></li><li><a href="Crafty-DrawManager.html">Crafty.DrawManager</a></li><li><a href="Crafty-pixelart.html">Crafty.pixelart</a></li><li><a href="Crafty-sprite.html">Crafty.sprite</a></li><li><a href="DOM.html">DOM</a></li><li><a href="HTML.html">HTML</a></li><li><a href="Image.html">Image</a></li><li><a href="Particles.html">Particles</a></li><li><a href="Sprite.html">Sprite</a></li><li><a href="Text.html">Text</a></li></ul></li><li class="category">Input<ul class="category-list"><li><a href="Crafty-eventObject.html">Crafty.eventObject</a></li><li><a href="Crafty-keydown.html">Crafty.keydown</a></li><li><a href="Crafty-keys.html">Crafty.keys</a></li><li><a href="Crafty-mouseButtons.html">Crafty.mouseButtons</a></li><li><a href="Crafty-mouseDispatch.html">Crafty.mouseDispatch</a></li><li><a href="Crafty-touchDispatch.html">Crafty.touchDispatch</a></li><li><a href="Draggable.html">Draggable</a></li><li><a href="Fourway.html">Fourway</a></li><li><a href="Keyboard.html">Keyboard</a></li><li><a href="KeyboardEvent.html">KeyboardEvent</a></li><li><a href="Mouse.html">Mouse</a></li><li><a href="Multiway.html">Multiway</a></li><li><a href="Twoway.html">Twoway</a></li></ul></li><li class="category">Misc<ul class="category-list"><li><a href="Crafty-addEvent.html">Crafty.addEvent</a></li><li><a href="Crafty-device.html">Crafty.device</a></li><li><a href="Crafty-removeEvent.html">Crafty.removeEvent</a></li><li><a href="Crafty-support.html">Crafty.support</a></li></ul></li><li class="category">Model<ul class="category-list"><li><a href="Model.html">Model</a></li></ul></li><li class="category">Scenes<ul class="category-list"><li><a href="Crafty-scene.html">Crafty.scene</a></li></ul></li><li class="category">Stage<ul class="category-list"><li><a href="Crafty-background.html">Crafty.background</a></li><li><a href="Crafty-scene.html">Crafty.scene</a></li><li><a href="Crafty-viewport.html">Crafty.viewport</a></li></ul></li><li class="category">Utilities<ul class="category-list"><li><a href="Delay.html">Delay</a></li><li><a href="Storage.html">Storage</a></li></ul></li></ul></div><div id="doc-content" class="doc-page-holder"><div class="doc-page"><h1>Crafty Core</h1><div id="Crafty Core"><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L64-72">src/core.js#L64-72</a></div><div class="triggered-events"><h4>Events</h4><div class="trigger-list"><dl class="trigger"><dt>NewEntityName <span class="trigger-data">[ entity name { String }]</span></dt><dd>After setting new name for entity</dd></dl><dl class="trigger"><dt>NewComponent <span class="trigger-data">[ Component { String }]</span></dt><dd>when a new component is added to the entity</dd></dl><dl class="trigger"><dt>RemoveComponent <span class="trigger-data">[ Component { String }]</span></dt><dd>when a component is removed from the entity</dd></dl><dl class="trigger"><dt>Remove </dt><dd>when the entity is removed by calling .destroy()</dd></dl></div></div><span class="markdown"><p>Set of methods added to every single entity.</p>
</span></div><div><h4>Methods and Properties</h4><ul class="page-toc"><li><a href="#-addComponent">.addComponent</a></li><li><a href="#-attr">.attr</a></li><li><a href="#-bind">.bind</a></li><li><a href="#-clone">.clone</a></li><li><a href="#-destroy">.destroy</a></li><li><a href="#-each">.each</a></li><li><a href="#-get">.get</a></li><li><a href="#-getId">.getId</a></li><li><a href="#-has">.has</a></li><li><a href="#-one">.one</a></li><li><a href="#-removeComponent">.removeComponent</a></li><li><a href="#-requires">.requires</a></li><li><a href="#-setName">.setName</a></li><li><a href="#-setter">.setter</a></li><li><a href="#-timeout">.timeout</a></li><li><a href="#-toArray">.toArray</a></li><li><a href="#-toggleComponent">.toggleComponent</a></li><li><a href="#-trigger">.trigger</a></li><li><a href="#-unbind">.unbind</a></li><li><a href="#-uniqueBind">.uniqueBind</a></li></ul><div id=".addComponent"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.addComponent</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L195-220">src/core.js#L195-220</a></div><div class="crafty-method"><code class="signature">public this .addComponent(String componentList)</code><dl class="parameter"><dt> componentList </dt><dd><span class="markdown"><p>A string of components to add separated by a comma <code>,</code></p>
</span></dd></dl></div><div class="crafty-method"><code class="signature">public this .addComponent(String Component1[, .., String ComponentN])</code><dl class="parameter"><dt> Component# </dt><dd><span class="markdown"><p>Component ID to add.</p>
</span></dd></dl></div><span class="markdown"><p>Adds a component to the selected entities or entity.</p>
<p>Components are used to extend the functionality of entities.
This means it will copy properties and assign methods to
augment the functionality of the entity.</p>
<p>For adding multiple components, you can either pass a string with
all the component names (separated by commas), or pass each component name as
an argument.</p>
<p>If the component has a function named <code>init</code> it will be called.</p>
<p>If the entity already has the component, the component is skipped (nothing happens).</p>
</span><div class="example"><h4>Example</h4><span class="markdown"><pre><code class="hljs "><span class="hljs-keyword">this</span>.addComponent(<span class="hljs-string">"2D, Canvas"</span>);
<span class="hljs-keyword">this</span>.addComponent(<span class="hljs-string">"2D"</span>, <span class="hljs-string">"Canvas"</span>);</code></pre></span></div></div><div id=".attr"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.attr</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L406-449">src/core.js#L406-449</a></div><div class="triggered-events"><h4>Events</h4><div class="trigger-list"><dl class="trigger"><dt>Change <span class="trigger-data">[ Data { {key: value} }]</span></dt><dd>when properties change</dd></dl></div></div><span class="markdown"></span><div class="crafty-method"><code class="signature">public this .attr(String property, Any value[, Boolean silent[, Boolean recursive]])</code><dl class="parameter"><dt> property </dt><dd><span class="markdown"><p>Property of the entity to modify</p>
</span></dd></dl><dl class="parameter"><dt> value </dt><dd><span class="markdown"><p>Value to set the property to</p>
</span></dd></dl><dl class="parameter"><dt> silent </dt><dd><span class="markdown"><p>If you would like to supress events</p>
</span></dd></dl><dl class="parameter"><dt> recursive </dt><dd><span class="markdown"><p>If you would like merge recursively</p>
</span></dd></dl></div><span class="markdown"><p>Use this method to set any property of the entity.</p>
</span><div class="crafty-method"><code class="signature">public this .attr(Object map[, Boolean silent[, Boolean recursive]])</code><dl class="parameter"><dt> map </dt><dd><span class="markdown"><p>Object where each key is the property to modify and the value as the property value</p>
</span></dd></dl><dl class="parameter"><dt> silent </dt><dd><span class="markdown"><p>If you would like to supress events</p>
</span></dd></dl><dl class="parameter"><dt> recursive </dt><dd><span class="markdown"><p>If you would like merge recursively</p>
</span></dd></dl></div><span class="markdown"><p>Use this method to set multiple properties of the entity.</p>
<p>Setter options:
<code>silent</code>: If you want to prevent it from firing events.
<code>recursive</code>: If you pass in an object you could overwrite sibling keys, this recursively merges instead of just merging it. This is <code>false</code> by default, unless you are using dot notation <code>name.first</code>.</p>
</span><div class="crafty-method"><code class="signature">public Any .attr(String property)</code><dl class="parameter"><dt> property </dt><dd><span class="markdown"><p>Property of the entity to modify</p>
</span></dd></dl><dl class="parameter returns"><dt class="returns"> [Returns] </dt><dd><span class="markdown"><p>Value - the value of the property</p>
</span></dd></dl></div><span class="markdown"><p>Use this method to get any property of the entity. You can also retrieve the property using <code>this.property</code>.</p>
</span><div class="example"><h4>Example</h4><span class="markdown"><pre><code class="hljs "><span class="hljs-keyword">this</span>.attr({key: <span class="hljs-string">"value"</span>, prop: <span class="hljs-number">5</span>});
<span class="hljs-keyword">this</span>.attr(<span class="hljs-string">"key"</span>); <span class="hljs-comment">// returns "value"</span>
<span class="hljs-keyword">this</span>.attr(<span class="hljs-string">"prop"</span>); <span class="hljs-comment">// returns 5</span>
<span class="hljs-keyword">this</span>.key; <span class="hljs-comment">// "value"</span>
<span class="hljs-keyword">this</span>.prop; <span class="hljs-comment">// 5</span>
<span class="hljs-keyword">this</span>.attr(<span class="hljs-string">"key"</span>, <span class="hljs-string">"newvalue"</span>);
<span class="hljs-keyword">this</span>.attr(<span class="hljs-string">"key"</span>); <span class="hljs-comment">// returns "newvalue"</span>
<span class="hljs-keyword">this</span>.key; <span class="hljs-comment">// "newvalue"</span>
<span class="hljs-keyword">this</span>.attr(<span class="hljs-string">"parent.child"</span>, <span class="hljs-string">"newvalue"</span>);
<span class="hljs-keyword">this</span>.parent; <span class="hljs-comment">// {child: "newvalue"};</span>
<span class="hljs-keyword">this</span>.attr(<span class="hljs-string">'parent.child'</span>); <span class="hljs-comment">// "newvalue"</span></code></pre></span></div></div><div id=".bind"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.bind</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L603-635">src/core.js#L603-635</a></div><div class="crafty-method"><code class="signature">public this .bind(String eventName, Function callback)</code><dl class="parameter"><dt> eventName </dt><dd><span class="markdown"><p>Name of the event to bind to</p>
</span></dd></dl><dl class="parameter"><dt> callback </dt><dd><span class="markdown"><p>Method to execute when the event is triggered</p>
</span></dd></dl></div><span class="markdown"><p>Attach the current entity (or entities) to listen for an event.</p>
<p>Callback will be invoked when an event with the event name passed
is triggered. Depending on the event, some data may be passed
via an argument to the callback function.</p>
<p>The first argument is the event name (can be anything) whilst the
second argument is the callback. If the event has data, the
callback should have an argument.</p>
<p>Events are arbitrary and provide communication between components.
You can trigger or bind an event even if it doesn't exist yet.</p>
<p>Unlike DOM events, Crafty events are exectued synchronously.</p>
</span><div class="example"><h4>Example</h4><span class="markdown"><pre><code class="hljs "><span class="hljs-keyword">this</span>.attr(<span class="hljs-string">"triggers"</span>, <span class="hljs-number">0</span>); <span class="hljs-comment">//set a trigger count</span>
<span class="hljs-keyword">this</span>.bind(<span class="hljs-string">"myevent"</span>, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">this</span>.triggers++; <span class="hljs-comment">//whenever myevent is triggered, increment</span>
});
<span class="hljs-keyword">this</span>.bind(<span class="hljs-string">"EnterFrame"</span>, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">this</span>.trigger(<span class="hljs-string">"myevent"</span>); <span class="hljs-comment">//trigger myevent on every frame</span>
});</code></pre></span></div><div><h4>See Also</h4><ul class="see-also-list"><li><a href="-trigger.html">.trigger</a></li><li><a href="-unbind.html">.unbind</a></li></ul></div></div><div id=".clone"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.clone</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L884-891">src/core.js#L884-891</a></div><div class="crafty-method"><code class="signature">public Entity .clone(void)</code><dl class="parameter returns"><dt class="returns"> [Returns] </dt><dd><span class="markdown"><p>Cloned entity of the current entity</p>
</span></dd></dl></div><span class="markdown"><p>Method will create another entity with the exact same
properties, components and methods as the current entity.</p>
</span></div><div id=".destroy"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.destroy</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L933-937">src/core.js#L933-937</a></div><div class="crafty-method"><code class="signature">public this .destroy(void)</code></div><span class="markdown"><p>Will remove all event listeners and delete all properties as well as removing from the stage</p>
</span></div><div id=".each"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.each</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L805-824">src/core.js#L805-824</a></div><div class="crafty-method"><code class="signature">public this .each(Function method)</code><dl class="parameter"><dt> method </dt><dd><span class="markdown"><p>Method to call on each iteration</p>
</span></dd></dl></div><span class="markdown"><p>Iterates over found entities, calling a function for every entity.</p>
<p>The function will be called for every entity and will pass the index
in the iteration as an argument. The context (value of <code>this</code>) of the
function will be the current entity in the iteration.</p>
</span><div class="example"><h4>Example</h4><span class="markdown"><p>Destroy every second 2D entity</p>
<pre><code class="hljs ">Crafty(<span class="hljs-string">"2D"</span>).each(<span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(i)</span> </span>{
<span class="hljs-keyword">if</span>(i % <span class="hljs-number">2</span> === <span class="hljs-number">0</span>) {
<span class="hljs-keyword">this</span>.destroy();
}
});</code></pre></span></div></div><div id=".get"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.get</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L837-862">src/core.js#L837-862</a></div><div class="crafty-method"><code class="signature">public Array .get()</code><dl class="parameter returns"><dt class="returns"> [Returns] </dt><dd><span class="markdown"><p>An array of entities corresponding to the active selector</p>
</span></dd></dl></div><span class="markdown"></span><div class="crafty-method"><code class="signature">public Entity .get(Number index)</code><dl class="parameter returns"><dt class="returns"> [Returns] </dt><dd><span class="markdown"><p>an entity belonging to the current selection</p>
</span></dd></dl><dl class="parameter"><dt> index </dt><dd><span class="markdown"><p>The index of the entity to return. If negative, counts back from the end of the array.</p>
</span></dd></dl></div><span class="markdown"></span><div class="example"><h4>Example</h4><span class="markdown"><p>Get an array containing every "2D" entity</p>
<pre><code class="hljs "><span class="hljs-keyword">var</span> arr = Crafty(<span class="hljs-string">"2D"</span>).get()</code></pre><p>Get the first entity matching the selector</p>
<pre><code class="hljs "><span class="hljs-comment">// equivalent to Crafty("2D").get()[0], but doesn't create a new array</span>
<span class="hljs-keyword">var</span> e = Crafty(<span class="hljs-string">"2D"</span>).get(<span class="hljs-number">0</span>)</code></pre><p>Get the last "2D" entity matching the selector</p>
<pre><code class="hljs "><span class="hljs-keyword">var</span> e = Crafty(<span class="hljs-string">"2D"</span>).get(-<span class="hljs-number">1</span>)</code></pre></span></div></div><div id=".getId"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.getId</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L371-385">src/core.js#L371-385</a></div><div class="crafty-method"><code class="signature">public Number .getId(void)</code></div><span class="markdown"><p>Returns the ID of this entity.</p>
<p>For better performance, simply use the this[0] property.</p>
</span><div class="example"><h4>Example</h4><span class="markdown"><p>Finding out the <code>ID</code> of an entity can be done by returning the property <code>0</code>.</p>
<pre><code class="hljs "> <span class="hljs-keyword">var</span> ent = Crafty.e(<span class="hljs-string">"2D"</span>);
ent[<span class="hljs-number">0</span>]; <span class="hljs-comment">//ID</span>
ent.getId(); <span class="hljs-comment">//also ID</span></code></pre></span></div></div><div id=".has"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.has</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L391-400">src/core.js#L391-400</a></div><div class="crafty-method"><code class="signature">public Boolean .has(String component)</code></div><span class="markdown"><p>Returns <code>true</code> or <code>false</code> depending on if the
entity has the given component.</p>
<p>For better performance, simply use the <code>.__c</code> object
which will be <code>true</code> if the entity has the component or
will not exist (or be <code>false</code>).</p>
</span></div><div id=".one"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.one</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L683-693">src/core.js#L683-693</a></div><div class="crafty-method"><code class="signature">public Number one(String eventName, Function callback)</code><dl class="parameter"><dt> eventName </dt><dd><span class="markdown"><p>Name of the event to bind to</p>
</span></dd></dl><dl class="parameter"><dt> callback </dt><dd><span class="markdown"><p>Method to execute upon event triggered</p>
</span></dd></dl><dl class="parameter returns"><dt class="returns"> [Returns] </dt><dd><span class="markdown"><p>ID of the current callback used to unbind</p>
</span></dd></dl></div><span class="markdown"><p>Works like Crafty.bind, but will be unbound once the event triggers.</p>
</span><div><h4>See Also</h4><ul class="see-also-list"><li><a href="-bind.html">.bind</a></li></ul></div></div><div id=".removeComponent"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.removeComponent</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L336-352">src/core.js#L336-352</a></div><div class="crafty-method"><code class="signature">public this .removeComponent(String Component[, soft])</code><dl class="parameter"><dt> component </dt><dd><span class="markdown"><p>Component to remove</p>
</span></dd></dl><dl class="parameter"><dt> soft </dt><dd><span class="markdown"><p>Whether to soft remove it (defaults to <code>true</code>)</p>
</span></dd></dl></div><span class="markdown"><p>Removes a component from an entity. A soft remove (the default) will only
refrain <code>.has()</code> from returning true. Hard will remove all
associated properties and methods.</p>
</span><div class="example"><h4>Example</h4><span class="markdown"><pre><code class="hljs "><span class="hljs-keyword">var</span> e = Crafty.e(<span class="hljs-string">"2D,DOM,Test"</span>);
e.removeComponent(<span class="hljs-string">"Test"</span>); <span class="hljs-comment">//Soft remove Test component</span>
e.removeComponent(<span class="hljs-string">"Test"</span>, <span class="hljs-literal">false</span>); <span class="hljs-comment">//Hard remove Test component</span></code></pre></span></div></div><div id=".requires"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.requires</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L315-330">src/core.js#L315-330</a></div><div class="crafty-method"><code class="signature">public this .requires(String componentList)</code><dl class="parameter"><dt> componentList </dt><dd><span class="markdown"><p>List of components that must be added</p>
</span></dd></dl></div><span class="markdown"><p>Makes sure the entity has the components listed. If the entity does not
have the component, it will add it.</p>
<p>(In the current version of Crafty, this function behaves exactly the same
as <code>addComponent</code>. By convention, developers have used <code>requires</code> for
component dependencies -- i.e. to indicate specifically that one component
will only work properly if another component is present -- and used
<code>addComponent</code> in all other situations.)</p>
</span><div><h4>See Also</h4><ul class="see-also-list"><li><a href="-addComponent.html">.addComponent</a></li></ul></div></div><div id=".setName"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.setName</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L175-184">src/core.js#L175-184</a></div><div class="crafty-method"><code class="signature">public this .setName(String name)</code><dl class="parameter"><dt> name </dt><dd><span class="markdown"><p>A human readable name for debugging purposes.</p>
</span></dd></dl></div><span class="markdown"></span><div class="example"><h4>Example</h4><span class="markdown"><pre><code class="hljs "><span class="hljs-keyword">this</span>.setName(<span class="hljs-string">"Player"</span>);</code></pre></span></div></div><div id=".setter"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.setter</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L911-919">src/core.js#L911-919</a></div><div class="crafty-method"><code class="signature">public this .setter(String property, Function callback)</code><dl class="parameter"><dt> property </dt><dd><span class="markdown"><p>Property to watch for modification</p>
</span></dd></dl><dl class="parameter"><dt> callback </dt><dd><span class="markdown"><p>Method to execute if the property is modified</p>
</span></dd></dl></div><span class="markdown"><p>Will watch a property waiting for modification and will then invoke the
given callback when attempting to modify.</p>
</span></div><div id=".timeout"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.timeout</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L574-591">src/core.js#L574-591</a></div><div class="crafty-method"><code class="signature">public this .timeout(Function callback, Number delay)</code><dl class="parameter"><dt> callback </dt><dd><span class="markdown"><p>Method to execute after given amount of milliseconds</p>
</span></dd></dl><dl class="parameter"><dt> delay </dt><dd><span class="markdown"><p>Amount of milliseconds to execute the method</p>
</span></dd></dl></div><span class="markdown"><p>The delay method will execute a function after a given amount of time in milliseconds.</p>
<p>Essentially a wrapper for <code>setTimeout</code>.</p>
</span><div class="example"><h4>Example</h4><span class="markdown"><p>Destroy itself after 100 milliseconds</p>
<pre><code class="hljs "><span class="hljs-keyword">this</span>.timeout(<span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">this</span>.destroy();
}, <span class="hljs-number">100</span>);</code></pre></span></div></div><div id=".toArray"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.toArray</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L562-568">src/core.js#L562-568</a></div><div class="crafty-method"><code class="signature">public this .toArray(void)</code></div><span class="markdown"><p>This method will simply return the found entities as an array of ids. To get an array of the actual entities, use <code>get()</code>.</p>
</span><div><h4>See Also</h4><ul class="see-also-list"><li><a href="-get.html">.get</a></li></ul></div></div><div id=".toggleComponent"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.toggleComponent</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L255-276">src/core.js#L255-276</a></div><div class="crafty-method"><code class="signature">public this .toggleComponent(String ComponentList)</code><dl class="parameter"><dt> ComponentList </dt><dd><span class="markdown"><p>A string of components to add or remove separated by a comma <code>,</code></p>
</span></dd></dl></div><div class="crafty-method"><code class="signature">public this .toggleComponent(String Component1[, .., String componentN])</code><dl class="parameter"><dt> Component# </dt><dd><span class="markdown"><p>Component ID to add or remove.</p>
</span></dd></dl></div><span class="markdown"><p>Add or Remove Components from an entity.</p>
</span><div class="example"><h4>Example</h4><span class="markdown"><pre><code class="hljs "><span class="hljs-keyword">var</span> e = Crafty.e(<span class="hljs-string">"2D,DOM,Test"</span>);
e.toggleComponent(<span class="hljs-string">"Test,Test2"</span>); <span class="hljs-comment">//Remove Test, add Test2</span>
e.toggleComponent(<span class="hljs-string">"Test,Test2"</span>); <span class="hljs-comment">//Add Test, remove Test2</span></code></pre><pre><code class="hljs "><span class="hljs-keyword">var</span> e = Crafty.e(<span class="hljs-string">"2D,DOM,Test"</span>);
e.toggleComponent(<span class="hljs-string">"Test"</span>,<span class="hljs-string">"Test2"</span>); <span class="hljs-comment">//Remove Test, add Test2</span>
e.toggleComponent(<span class="hljs-string">"Test"</span>,<span class="hljs-string">"Test2"</span>); <span class="hljs-comment">//Add Test, remove Test2</span>
e.toggleComponent(<span class="hljs-string">"Test"</span>); <span class="hljs-comment">//Remove Test</span></code></pre></span></div></div><div id=".trigger"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.trigger</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L745-759">src/core.js#L745-759</a></div><div class="crafty-method"><code class="signature">public this .trigger(String eventName[, Object data])</code><dl class="parameter"><dt> eventName </dt><dd><span class="markdown"><p>Event to trigger</p>
</span></dd></dl><dl class="parameter"><dt> data </dt><dd><span class="markdown"><p>Arbitrary data that will be passed into every callback as an argument</p>
</span></dd></dl></div><span class="markdown"><p>Trigger an event with arbitrary data. Will invoke all callbacks with
the context (value of <code>this</code>) of the current entity object.</p>
<p><em>Note: This will only execute callbacks within the current entity, no other entity.</em></p>
<p>The first argument is the event name to trigger and the optional
second argument is the arbitrary event data. This can be absolutely anything.</p>
<p>Unlike DOM events, Crafty events are exectued synchronously.</p>
</span></div><div id=".unbind"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.unbind</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L705-716">src/core.js#L705-716</a></div><div class="crafty-method"><code class="signature">public this .unbind(String eventName[, Function callback])</code><dl class="parameter"><dt> eventName </dt><dd><span class="markdown"><p>Name of the event to unbind</p>
</span></dd></dl><dl class="parameter"><dt> callback </dt><dd><span class="markdown"><p>Function to unbind</p>
</span></dd></dl></div><span class="markdown"><p>Removes binding with an event from current entity.</p>
<p>Passing an event name will remove all events bound to
that event. Passing a reference to the callback will
unbind only that callback.</p>
</span><div><h4>See Also</h4><ul class="see-also-list"><li><a href="-bind.html">.bind</a></li><li><a href="-trigger.html">.trigger</a></li></ul></div></div><div id=".uniqueBind"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.uniqueBind</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/core.js#L665-675">src/core.js#L665-675</a></div><div class="crafty-method"><code class="signature">public Number .uniqueBind(String eventName, Function callback)</code><dl class="parameter"><dt> eventName </dt><dd><span class="markdown"><p>Name of the event to bind to</p>
</span></dd></dl><dl class="parameter"><dt> callback </dt><dd><span class="markdown"><p>Method to execute upon event triggered</p>
</span></dd></dl><dl class="parameter returns"><dt class="returns"> [Returns] </dt><dd><span class="markdown"><p>ID of the current callback used to unbind</p>
</span></dd></dl></div><span class="markdown"><p>Works like Crafty.bind, but prevents a callback from being bound multiple times.</p>
</span><div><h4>See Also</h4><ul class="see-also-list"><li><a href="-bind.html">.bind</a></li></ul></div></div></div></div></div></div>
</div>
</div>
<div class="clearer"></div>
<div id="footer">
<div id="contact">
<a href="https://groups.google.com/forum/#!forum/craftyjs">
<img src="/images/google.png" />
google groups</a>
<a href="mailto:starwed@gmail.com">
<img src="/images/email.png" />
starwed@gmail.com</a>
<a href="https://github.com/craftyjs/Crafty">
<img src="/images/github.png" />
github</a>
</div>
<ul>
<li><a href="/">Home</a></li>
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/documentation/">Documentation</a></li>
<li><a href="/api/">API</a></li>
<li><a href="https://groups.google.com/forum/#!forum/craftyjs">Forum</a></li>
<li><a href="/modules/">Modules</a></li>
<li class="emph"><a href="/download/">Download</a></li>
</ul>
<p>
© Crafty 2010-2015. 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>
</div>
</body>
</html>