/
Particles.html
152 lines (136 loc) · 19.1 KB
/
Particles.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
<!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 - Particles</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-defineField.html">Crafty.defineField()</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-s.html">Crafty.s()</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="AngularMotion.html">AngularMotion</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-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="Crafty-raycast.html">Crafty.raycast()</a></li><li><a href="Crafty-rectManager.html">Crafty.rectManager</a></li><li><a href="Gravity.html">Gravity</a></li><li><a href="GroundAttacher.html">GroundAttacher</a></li><li><a href="Motion.html">Motion</a></li><li><a href="Supportable.html">Supportable</a></li></ul></li><li class="category">Animation<ul class="category-list"><li><a href="Crafty-easing.html">Crafty.easing</a></li><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-imageWhitelist.html">Crafty.imageWhitelist()</a></li><li><a href="Crafty-load.html">Crafty.load()</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">Controls<ul class="category-list"><li><a href="Controllable.html">Controllable</a></li><li><a href="Controls.html">Controls</a></li><li><a href="Draggable.html">Draggable</a></li><li><a href="Fourway.html">Fourway</a></li><li><a href="Jumper.html">Jumper</a></li><li><a href="Multiway.html">Multiway</a></li><li><a href="Twoway.html">Twoway</a></li></ul></li><li class="category">Debug<ul class="category-list"><li><a href="Crafty-error.html">Crafty.error()</a></li><li><a href="Crafty-log.html">Crafty.log()</a></li><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="SolidAreaMap.html">SolidAreaMap</a></li><li><a href="SolidHitBox.html">SolidHitBox</a></li><li><a href="SolidMBR.html">SolidMBR</a></li><li><a href="WiredAreaMap.html">WiredAreaMap</a></li><li><a href="WiredHitBox.html">WiredHitBox</a></li><li><a href="WiredMBR.html">WiredMBR</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="CanvasLayer.html">CanvasLayer</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-createLayer.html">Crafty.createLayer()</a></li><li><a href="Crafty-defaultShader.html">Crafty.defaultShader()</a></li><li><a href="Crafty-domHelper.html">Crafty.domHelper</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="Crafty-WebGLShader.html">Crafty.WebGLShader()</a></li><li><a href="DOM.html">DOM</a></li><li><a href="DomLayer.html">DomLayer</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="Renderable.html">Renderable</a></li><li><a href="Sprite.html">Sprite</a></li><li><a href="Text.html">Text</a></li><li><a href="WebGL.html">WebGL</a></li><li><a href="WebGLLayer.html">WebGLLayer</a></li></ul></li><li class="category">Input<ul class="category-list"><li><a href="AreaMap.html">AreaMap</a></li><li><a href="Button.html">Button</a></li><li><a href="Crafty-findPointerEventTargetByComponent.html">Crafty.findPointerEventTargetByComponent()</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-multitouch.html">Crafty.multitouch()</a></li><li><a href="Crafty-selected.html">Crafty.selected</a></li><li><a href="Crafty-translatePointerEventCoordinates.html">Crafty.translatePointerEventCoordinates()</a></li><li><a href="Keyboard.html">Keyboard</a></li><li><a href="KeyboardState.html">KeyboardState</a></li><li><a href="KeyboardSystem.html">KeyboardSystem</a></li><li><a href="Mouse.html">Mouse</a></li><li><a href="MouseDrag.html">MouseDrag</a></li><li><a href="MouseState.html">MouseState</a></li><li><a href="MouseSystem.html">MouseSystem</a></li><li><a href="MouseWheel.html">MouseWheel</a></li><li><a href="Touch.html">Touch</a></li><li><a href="TouchState.html">TouchState</a></li><li><a href="TouchSystem.html">TouchSystem</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="Crafty-math.html">Crafty.math</a></li><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>Particles <span class="page-badge">Component</span></h1><div class="doclet" id="Particles"><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/deff7307581e69badb10b3ca08c7d0a6675d80c2/src/graphics/particles.js#L8-L24">src/graphics/particles.js#L8-L24</a></div><div class="triggered-events"><h4>Events</h4><div class="trigger-list"><dl class="trigger"><dt>ParticleStart </dt><dd>when the particle animation has started</dd></dl><dl class="trigger"><dt>ParticleEnd </dt><dd>when the particle animation has finished</dd></dl></div></div><span class="markdown"><p>Create particle effects.</p>
<p>Particles won't be drawn outside the entity's bounds. Make sure to adjust the entity's dimensions accordingly.</p>
</span><div class="note"><span class="markdown"><p><strong>Note:</strong> Particles effects currently work exclusively with the Canvas render backend. Particles won't be drawn if the browser doesn't support this!</p>
</span></div><div><h4>See Also</h4><ul class="see-also-list"><li><a href="#-particles">.particles</a></li></ul></div></div><div><h4>Methods</h4><ul class="page-toc"><li><a href="#-particles">.particles()</a></li><li><a href="#-pauseParticles">.pauseParticles()</a></li><li><a href="#-resumeParticles">.resumeParticles()</a></li></ul><div class="doclet" id="-particles"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.particles()</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/deff7307581e69badb10b3ca08c7d0a6675d80c2/src/graphics/particles.js#L62-L120">src/graphics/particles.js#L62-L120</a></div><div class="crafty-method"><code class="signature"><span class="sig-phrase"><span class="sig-qualifier">public </span><span class="sig-qualifier">this </span><span class="sig-noun">.particles</span></span><span class="sig-seperator">([</span><span class="sig-phrase"><span class="sig-qualifier">Object </span><span class="sig-noun">options</span></span><span class="sig-seperator">])</span></code><dl class="parameter"><dt> options </dt><dd><span class="markdown"><p>Map of options that specify the behavior and look of the particles.</p>
</span></dd></dl></div><span class="markdown"><p>Create a new particle animation.</p>
<p>If the <code>options</code> object is missing a property, the default will be used.
Default options are listed in the example below.</p>
<p>Invoking this method without an <code>options</code> object will restart the particle animation
with the previously used options, or the default options otherwise.</p>
</span><div class="example"><h4>Example</h4><span class="markdown"><pre><code class="hljs "><span class="hljs-keyword">var</span> options = {
<span class="hljs-attr">maxParticles</span>: <span class="hljs-number">150</span>,
<span class="hljs-attr">size</span>: <span class="hljs-number">18</span>,
<span class="hljs-attr">sizeRandom</span>: <span class="hljs-number">4</span>,
<span class="hljs-attr">speed</span>: <span class="hljs-number">1</span>,
<span class="hljs-attr">speedRandom</span>: <span class="hljs-number">1.2</span>,
<span class="hljs-comment">// Lifespan in frames</span>
lifeSpan: <span class="hljs-number">29</span>,
<span class="hljs-attr">lifeSpanRandom</span>: <span class="hljs-number">7</span>,
<span class="hljs-comment">// Angle is calculated clockwise: 12pm is 0deg, 3pm is 90deg etc.</span>
angle: <span class="hljs-number">65</span>,
<span class="hljs-attr">angleRandom</span>: <span class="hljs-number">34</span>,
<span class="hljs-attr">startColour</span>: [<span class="hljs-number">255</span>, <span class="hljs-number">131</span>, <span class="hljs-number">0</span>, <span class="hljs-number">1</span>],
<span class="hljs-attr">startColourRandom</span>: [<span class="hljs-number">48</span>, <span class="hljs-number">50</span>, <span class="hljs-number">45</span>, <span class="hljs-number">0</span>],
<span class="hljs-attr">endColour</span>: [<span class="hljs-number">245</span>, <span class="hljs-number">35</span>, <span class="hljs-number">0</span>, <span class="hljs-number">0</span>],
<span class="hljs-attr">endColourRandom</span>: [<span class="hljs-number">60</span>, <span class="hljs-number">60</span>, <span class="hljs-number">60</span>, <span class="hljs-number">0</span>],
<span class="hljs-comment">// Only applies when fastMode is off, specifies how sharp the gradients are drawn</span>
sharpness: <span class="hljs-number">20</span>,
<span class="hljs-attr">sharpnessRandom</span>: <span class="hljs-number">10</span>,
<span class="hljs-comment">// Random spread from origin</span>
spread: <span class="hljs-number">10</span>,
<span class="hljs-comment">// How many frames should this last</span>
duration: <span class="hljs-number">-1</span>,
<span class="hljs-comment">// Will draw squares instead of circle gradients</span>
fastMode: <span class="hljs-literal">false</span>,
<span class="hljs-attr">gravity</span>: { <span class="hljs-attr">x</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">y</span>: <span class="hljs-number">0.1</span> },
<span class="hljs-comment">// sensible values are 0-3</span>
jitter: <span class="hljs-number">0</span>,
<span class="hljs-comment">// Offset for the origin of the particles</span>
originOffset: {<span class="hljs-attr">x</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">y</span>: <span class="hljs-number">0</span>}
};
Crafty.e(<span class="hljs-string">"2D, Canvas, Particles"</span>)
.attr({ <span class="hljs-attr">w</span>: <span class="hljs-number">200</span>, <span class="hljs-attr">h</span>: <span class="hljs-number">200</span> })
<span class="hljs-comment">// debug entity's bounds while developing</span>
<span class="hljs-comment">// make sure particles fit into entity's bounds</span>
.addComponent(<span class="hljs-string">'WiredMBR'</span>)
<span class="hljs-comment">// init particle animation</span>
.particles(options);</code></pre></span></div></div><div class="doclet" id="-pauseParticles"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.pauseParticles()</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/deff7307581e69badb10b3ca08c7d0a6675d80c2/src/graphics/particles.js#L392-L410">src/graphics/particles.js#L392-L410</a></div><div class="crafty-method"><code class="signature"><span class="sig-phrase"><span class="sig-qualifier">public </span><span class="sig-noun">this.pauseParticles</span></span><span class="sig-seperator">()</span></code></div><span class="markdown"><p>The pauseParticles will freeze these particles in execution.</p>
</span><div class="example"><h4>Example</h4><span class="markdown"><pre><code class="hljs "><span class="hljs-comment">// start particle animation</span>
<span class="hljs-keyword">var</span> ent = Crafty.e(<span class="hljs-string">"Particles"</span>).particles(someParticleConfig);
<span class="hljs-comment">// and some time later, the gameplay is paused (or only</span>
<span class="hljs-comment">// a part of it is frozen)</span>
ent.pauseParticles();</code></pre></span></div></div><div class="doclet" id="-resumeParticles"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">.resumeParticles()</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/deff7307581e69badb10b3ca08c7d0a6675d80c2/src/graphics/particles.js#L415-L436">src/graphics/particles.js#L415-L436</a></div><div class="crafty-method"><code class="signature"><span class="sig-phrase"><span class="sig-qualifier">public </span><span class="sig-noun">this.resumeParticles</span></span><span class="sig-seperator">()</span></code></div><span class="markdown"><p>The resumeParticles will resume earlier paused particles</p>
</span><div class="example"><h4>Example</h4><span class="markdown"><pre><code class="hljs "><span class="hljs-comment">// start particle animation</span>
<span class="hljs-keyword">var</span> ent = Crafty.e(<span class="hljs-string">"Particles"</span>).particles(someParticleConfig);
<span class="hljs-comment">// and some time later, the gameplay is paused (or only</span>
<span class="hljs-comment">// a part of it is frozen)</span>
ent.pauseParticles();
<span class="hljs-comment">// and we resume the particles again</span>
ent.resumeParticles();</code></pre></span></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="/components/">Modules</a></li>
<li class="emph"><a href="/#install">Download</a></li>
</ul>
<p>
© Crafty 2010-2015. Crafty is distributed under the <a href="http://en.wikipedia.org/wiki/MIT_License">MIT License</a>.
</p>
</div>
</div>
</body>
</html>