/
reference.html
667 lines (615 loc) · 34.2 KB
/
reference.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
<!DOCTYPE HTML>
<!-- Generated automatically with the Cydoc utility -->
<!-- Cydoc was written by Caleb Place of Gymbyl Coding -->
<head>
<title>CBE Parameter Reference</title>
<style type="text/css">body{font-family:Athelas,Cochin,"EB Garamond",Garamont,"Times New Roman",Times;font-weight:400;color:#000;line-height:1;background-color:#0ff;letter-spacing:.1em}h1,h2,h3,h4,h5{font-weight:400}h2{font-size:1.2em}.cydoc-top-title{font-size:1.5em;color:#088;text-align:center}.cydoc-category-title{font-size:1.2em;color:#000}h4{line-height:1;font-weight:400;margin-bottom:0}.cydoc-list-title{color:#000;margin-top:0;margin-bottom:4px;margin-right:1em;text-align:right}p{font-size:10pt;color:#066;text-indent:1em}p.sameline{display:inline;text-indent:0}.mini{font-size:.7em}a{color:#0aa;text-decoration:none}a.cydoc-list-label{color:#088}a.code *{color:#fff}a.code:hover *,a:hover{color:#0cc}div{border-style:hidden;text-indent:0;margin-left:0}div.content{margin-left:40px;margin-right:40px}div.cydoc-navbar{margin-bottom:20px;margin-left:20px;margin-right:20px;padding-top:30px;padding-bottom:30px;border-left:solid;border-left-color:#0bb;border-left-width:1px;float:right;min-width:200px}div.cydoc-navbar ul{border-right:solid;border-right-width:1px;border-right-color:#ddd}hr{border-top:solid;border-top-width:1px;border-top-color:#0bb;margin-left:6px;margin-right:6px;margin-top:3px;margin-bottom:3px}footer{font-size:4pt;position:fixed;background-color:#0bb;border-radius:3px;padding:3px;bottom:5px;right:5px;color:#0ff}footer:after{content:"Powered by Cydoc v1.0.3 | Theme: Cydoc Default"}ul{margin-top:4px;margin-bottom:4px;margin-left:10px;padding-top:4px;padding-bottom:4px;padding-left:6px;padding-right:0}li{list-style-type:none;font-size:.8em;line-height:1;display:block;margin-left:0;margin-right:6px;padding-top:4px;padding-bottom:4px;padding-left:10px;padding-right:10px}li.cydoc-list-label{color:#0bb;display:block;text-align:right}li.cydoc-list-label:hover{color:#0ff;background-color:#0bb}li.cydoc-list-label:hover *{color:#0ff}code,pre{font-family:"Ubuntu Mono","Anonymous Pro","Menlo",monospace}code{padding:1px;border-radius:5px;background-color:#0dd}</style>
</head>
<!-- Main HTML Content -->
<html>
<h2 class="cydoc-top-title">CBE Parameter Reference<br><mini>3.1</mini></h2>
<!-- Navbar -->
<div class="cydoc-navbar">
<ul>
<h4 class="cydoc-list-title"><a href="#vent-parameters">Vent Parameters</a></h4>
<a class="cydoc-list-label" href="#vent-parameters-x"><li class="cydoc-list-label">x</li></a>
<a class="cydoc-list-label" href="#vent-parameters-y"><li class="cydoc-list-label">y</li></a>
<a class="cydoc-list-label" href="#vent-parameters-contentx"><li class="cydoc-list-label">contentX</li></a>
<a class="cydoc-list-label" href="#vent-parameters-contenty"><li class="cydoc-list-label">contentY</li></a>
<a class="cydoc-list-label" href="#vent-parameters-build"><li class="cydoc-list-label">build</li></a>
<a class="cydoc-list-label" href="#vent-parameters-particleproperties"><li class="cydoc-list-label">particleProperties</li></a>
<a class="cydoc-list-label" href="#vent-parameters-scale"><li class="cydoc-list-label">scale</li></a>
<a class="cydoc-list-label" href="#vent-parameters-scalex"><li class="cydoc-list-label">scaleX</li></a>
<a class="cydoc-list-label" href="#vent-parameters-scaley"><li class="cydoc-list-label">scaleY</li></a>
<a class="cydoc-list-label" href="#vent-parameters-parentgroup"><li class="cydoc-list-label">parentGroup</li></a>
<a class="cydoc-list-label" href="#vent-parameters-isactive"><li class="cydoc-list-label">isActive</li></a>
<a class="cydoc-list-label" href="#vent-parameters-title"><li class="cydoc-list-label">title</li></a>
<a class="cydoc-list-label" href="#vent-parameters-rotatetowardvel"><li class="cydoc-list-label">rotateTowardVel</li></a>
<a class="cydoc-list-label" href="#vent-parameters-towardveloffset"><li class="cydoc-list-label">towardVelOffset</li></a>
<a class="cydoc-list-label" href="#vent-parameters-color"><li class="cydoc-list-label">color</li></a>
<a class="cydoc-list-label" href="#vent-parameters-cyclecolor"><li class="cydoc-list-label">cycleColor</li></a>
<a class="cydoc-list-label" href="#vent-parameters-curcolor"><li class="cydoc-list-label">curColor</li></a>
<a class="cydoc-list-label" href="#vent-parameters-colorincr"><li class="cydoc-list-label">colorIncr</li></a>
<a class="cydoc-list-label" href="#vent-parameters-emitdelay"><li class="cydoc-list-label">emitDelay</li></a>
<a class="cydoc-list-label" href="#vent-parameters-peremit"><li class="cydoc-list-label">perEmit</li></a>
<a class="cydoc-list-label" href="#vent-parameters-emissionnum"><li class="cydoc-list-label">emissionNum</li></a>
<a class="cydoc-list-label" href="#vent-parameters-startalpha"><li class="cydoc-list-label">startAlpha</li></a>
<a class="cydoc-list-label" href="#vent-parameters-lifealpha"><li class="cydoc-list-label">lifeAlpha</li></a>
<a class="cydoc-list-label" href="#vent-parameters-endalpha"><li class="cydoc-list-label">endAlpha</li></a>
<a class="cydoc-list-label" href="#vent-parameters-intime"><li class="cydoc-list-label">inTime</li></a>
<a class="cydoc-list-label" href="#vent-parameters-lifetime"><li class="cydoc-list-label">lifeTime</li></a>
<a class="cydoc-list-label" href="#vent-parameters-outtime"><li class="cydoc-list-label">outTime</li></a>
<a class="cydoc-list-label" href="#vent-parameters-oncreation"><li class="cydoc-list-label">onCreation</li></a>
<a class="cydoc-list-label" href="#vent-parameters-oncreationtime"><li class="cydoc-list-label">onCreationTime</li></a>
<a class="cydoc-list-label" href="#vent-parameters-ondeath"><li class="cydoc-list-label">onDeath</li></a>
<a class="cydoc-list-label" href="#vent-parameters-onupdate"><li class="cydoc-list-label">onUpdate</li></a>
<a class="cydoc-list-label" href="#vent-parameters-onventinit"><li class="cydoc-list-label">onVentInit</li></a>
<a class="cydoc-list-label" href="#vent-parameters-onemitbegin"><li class="cydoc-list-label">onEmitBegin</li></a>
<a class="cydoc-list-label" href="#vent-parameters-onemitend"><li class="cydoc-list-label">onEmitEnd</li></a>
<a class="cydoc-list-label" href="#vent-parameters-positiontype"><li class="cydoc-list-label">positionType</li></a>
<a class="cydoc-list-label" href="#vent-parameters-radius"><li class="cydoc-list-label">radius</li></a>
<a class="cydoc-list-label" href="#vent-parameters-xradius"><li class="cydoc-list-label">xRadius</li></a>
<a class="cydoc-list-label" href="#vent-parameters-yradius"><li class="cydoc-list-label">yRadius</li></a>
<a class="cydoc-list-label" href="#vent-parameters-innerradius"><li class="cydoc-list-label">innerRadius</li></a>
<a class="cydoc-list-label" href="#vent-parameters-innerxradius"><li class="cydoc-list-label">innerXRadius</li></a>
<a class="cydoc-list-label" href="#vent-parameters-inneryradius"><li class="cydoc-list-label">innerYRadius</li></a>
<a class="cydoc-list-label" href="#vent-parameters-point1"><li class="cydoc-list-label">point1</li></a>
<a class="cydoc-list-label" href="#vent-parameters-point2"><li class="cydoc-list-label">point2</li></a>
<a class="cydoc-list-label" href="#vent-parameters-linedensity"><li class="cydoc-list-label">lineDensity</li></a>
<a class="cydoc-list-label" href="#vent-parameters-rectleft"><li class="cydoc-list-label">rectLeft</li></a>
<a class="cydoc-list-label" href="#vent-parameters-recttop"><li class="cydoc-list-label">rectTop</li></a>
<a class="cydoc-list-label" href="#vent-parameters-rectwidth"><li class="cydoc-list-label">rectWidth</li></a>
<a class="cydoc-list-label" href="#vent-parameters-rectheight"><li class="cydoc-list-label">rectHeight</li></a>
<a class="cydoc-list-label" href="#vent-parameters-pointlist"><li class="cydoc-list-label">pointList</li></a>
<a class="cydoc-list-label" href="#vent-parameters-cyclepoint"><li class="cydoc-list-label">cyclePoint</li></a>
<a class="cydoc-list-label" href="#vent-parameters-pointincr"><li class="cydoc-list-label">pointIncr</li></a>
<a class="cydoc-list-label" href="#vent-parameters-curpoint"><li class="cydoc-list-label">curPoint</li></a>
</ul>
</div>
<!-- Content Div -->
<div class="content">
<a name="vent-parameters"></a>
<h4 class="cydoc-category-title">Vent Parameters</h4>
<br>
<hr></hr>
<br>
<a name="vent-parameters-x"></a>
<h4 class="cydoc-element-title">x</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-y">y</a>, <a href="#vent-parameters-contentx">contentX</a>, <a href="#vent-parameters-contenty">contentY</a>
</font>
<p>The position of the vent on the X-axis.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-y"></a>
<h4 class="cydoc-element-title">y</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-x">x</a>, <a href="#vent-parameters-contentx">contentX</a>, <a href="#vent-parameters-contenty">contentY</a>
</font>
<p>The position of the vent on the Y-axis.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-contentx"></a>
<h4 class="cydoc-element-title">contentX</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-x">x</a>, <a href="#vent-parameters-y">y</a>, <a href="#vent-parameters-contenty">contentY</a>
</font>
<p>The position of the vent's content group on the X-axis.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-contenty"></a>
<h4 class="cydoc-element-title">contentY</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-x">x</a>, <a href="#vent-parameters-y">y</a>, <a href="#vent-parameters-contentx">contentX</a>
</font>
<p>The position of the vent's content group on the Y-axis.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-build"></a>
<h4 class="cydoc-element-title">build</h4>
<font class="mini">
Type: function
<br>
Related: (none)
</font>
<p>A function that builds and returns a display object that CBE will use as a particle.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-particleproperties"></a>
<h4 class="cydoc-element-title">particleProperties</h4>
<font class="mini">
Type: table
<br>
Related: (none)
</font>
<p>A table of properties that are transferred to each particle on creation.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-scale"></a>
<h4 class="cydoc-element-title">scale</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-scalex">scaleX</a>, <a href="#vent-parameters-scaley">scaleY</a>
</font>
<p>The scale of the vent. Used as default for <code>scaleX</code> and <code>scaleY</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-scalex"></a>
<h4 class="cydoc-element-title">scaleX</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-scale">scale</a>, <a href="#vent-parameters-scaley">scaleY</a>
</font>
<p>The scale of the vent on the X-axis. Defaults to <code>scale</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-scaley"></a>
<h4 class="cydoc-element-title">scaleY</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-scale">scale</a>, <a href="#vent-parameters-scalex">scaleX</a>
</font>
<p>The scale of the vent on the Y-axis. Defaults to <code>scale</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-parentgroup"></a>
<h4 class="cydoc-element-title">parentGroup</h4>
<font class="mini">
Type: Corona display object
<br>
Related: (none)
</font>
<p>The group that the vent's content will be inserted into.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-isactive"></a>
<h4 class="cydoc-element-title">isActive</h4>
<font class="mini">
Type: Boolean
<br>
Related: (none)
</font>
<p>Whether this vent accepts <code>startMaster()</code> and <code>emitMaster()</code> commands in a VentGroup.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-title"></a>
<h4 class="cydoc-element-title">title</h4>
<font class="mini">
Type: string
<br>
Related: (none)
</font>
<p>The access-ID of the vent in a VentGroup. Used in VentGroup commands that apply only to specific vents.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-rotatetowardvel"></a>
<h4 class="cydoc-element-title">rotateTowardVel</h4>
<font class="mini">
Type: Boolean
<br>
Related: <a href="#vent-parameters-towardveloffset">towardVelOffset</a>
</font>
<p>Whether particles rotate to face the direction they are travelling.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-towardveloffset"></a>
<h4 class="cydoc-element-title">towardVelOffset</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-rotatetowardvel">rotateTowardVel</a>
</font>
<p>An offset by which particles are rotated toward their direction if <code>rotateTowardVel</code> is enabled.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-color"></a>
<h4 class="cydoc-element-title">color</h4>
<font class="mini">
Type: table
<br>
Related: <a href="#vent-parameters-cyclecolor">cycleColor</a>, <a href="#vent-parameters-curcolor">curColor</a>, <a href="#vent-parameters-colorincr">colorIncr</a>
</font>
<p>A table containing inner tables that specify the color of particles. The inner tables must be in the form of <code>{r, g, b}</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-cyclecolor"></a>
<h4 class="cydoc-element-title">cycleColor</h4>
<font class="mini">
Type: Boolean
<br>
Related: <a href="#vent-parameters-color">color</a>, <a href="#vent-parameters-curcolor">curColor</a>, <a href="#vent-parameters-colorincr">colorIncr</a>
</font>
<p>If set to <code>true</code>, particle colors will be cycled through in order. If set to <code>false</code>, particles will be colored randomly from the color table.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-curcolor"></a>
<h4 class="cydoc-element-title">curColor</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-color">color</a>, <a href="#vent-parameters-cyclecolor">cycleColor</a>, <a href="#vent-parameters-colorincr">colorIncr</a>
</font>
<p>The color color cycling starts with if <code>cycleColor</code> is <code>true</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-colorincr"></a>
<h4 class="cydoc-element-title">colorIncr</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-color">color</a>, <a href="#vent-parameters-cyclecolor">cycleColor</a>, <a href="#vent-parameters-curcolor">curColor</a>
</font>
<p>The value by which the current color is incremented if <code>cycleColor</code> is <code>true</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-emitdelay"></a>
<h4 class="cydoc-element-title">emitDelay</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-peremit">perEmit</a>, <a href="#vent-parameters-emissionnum">emissionNum</a>
</font>
<p>The delay between particle emission sequences.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-peremit"></a>
<h4 class="cydoc-element-title">perEmit</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-emitdelay">emitDelay</a>, <a href="#vent-parameters-emissionnum">emissionNum</a>
</font>
<p>The number of particles emitted for each emission sequence.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-emissionnum"></a>
<h4 class="cydoc-element-title">emissionNum</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-emitdelay">emitDelay</a>, <a href="#vent-parameters-peremit">perEmit</a>
</font>
<p>The number of emission sequences to toggle when <code>vent.start()</code> is called.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-startalpha"></a>
<h4 class="cydoc-element-title">startAlpha</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-lifealpha">lifeAlpha</a>, <a href="#vent-parameters-endalpha">endAlpha</a>
</font>
<p>The alpha particles are when they are created.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-lifealpha"></a>
<h4 class="cydoc-element-title">lifeAlpha</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-startalpha">startAlpha</a>, <a href="#vent-parameters-endalpha">endAlpha</a>
</font>
<p>The alpha particles are during their life span.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-endalpha"></a>
<h4 class="cydoc-element-title">endAlpha</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-startalpha">startAlpha</a>, <a href="#vent-parameters-lifealpha">lifeAlpha</a>
</font>
<p>The alpha particles are when they are destroyed.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-intime"></a>
<h4 class="cydoc-element-title">inTime</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-lifetime">lifeTime</a>, <a href="#vent-parameters-outtime">outTime</a>
</font>
<p>The duration of the transition from startAlpha to lifeAlpha.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-lifetime"></a>
<h4 class="cydoc-element-title">lifeTime</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-intime">inTime</a>, <a href="#vent-parameters-outtime">outTime</a>
</font>
<p>The duration of the particle's life span, when no alpha changes are taking place and the particle's alpha is <code>lifeAlpha</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-outtime"></a>
<h4 class="cydoc-element-title">outTime</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-intime">inTime</a>, <a href="#vent-parameters-lifetime">lifeTime</a>
</font>
<p>The duration of the transition from <code>lifeAlpha</code> to <code>endAlpha</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-oncreation"></a>
<h4 class="cydoc-element-title">onCreation</h4>
<font class="mini">
Type: function
<br>
Related: <a href="#vent-parameters-oncreationtime">onCreationTime</a>, <a href="#vent-parameters-ondeath">onDeath</a>, <a href="#vent-parameters-onupdate">onUpdate</a>
</font>
<p>A function called when a particle is created. The particle, the vent, and the vent's content group are passed as arguments.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-oncreationtime"></a>
<h4 class="cydoc-element-title">onCreationTime</h4>
<font class="mini">
Type: string
<br>
Related: <a href="#vent-parameters-oncreation">onCreation</a>
</font>
<p>When during the particle's creation sequence to call the onCreation function.</p>
<p>Supported Values:
<ul>
<li><code>afterBuild</code>: Calls the function directly after the particle is built. The particle has only the CBE particle core methods and values.</li>
<li><code>afterVel</code>: Calls the function once the particle's velocity has been set.</li>
<li><code>afterColor</code>: Calls the function once the particle has been colored and has the <code>.colorChange()</code> function available.</li>
<li><code>afterPosition</code>: Calls the function once the particle has been positioned.</li>
</ul>
</p>
<br>
<hr></hr><br>
<a name="vent-parameters-ondeath"></a>
<h4 class="cydoc-element-title">onDeath</h4>
<font class="mini">
Type: function
<br>
Related: <a href="#vent-parameters-oncreation">onCreation</a>, <a href="#vent-parameters-onupdate">onUpdate</a>
</font>
<p>A function called when the particle's life span is over and it is destroyed. The particle, the vent, and the vent's content group are passed as arguments.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-onupdate"></a>
<h4 class="cydoc-element-title">onUpdate</h4>
<font class="mini">
Type: function
<br>
Related: <a href="#vent-parameters-oncreation">onCreation</a>, <a href="#vent-parameters-ondeath">onDeath</a>
</font>
<p>A function called each frame for each particle that is updated. The particle, the vent, and the vent's content group are passed as arguments.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-onventinit"></a>
<h4 class="cydoc-element-title">onVentInit</h4>
<font class="mini">
Type: function
<br>
Related: (none)
</font>
<p>A function called when a vent is created using the parameters. The vent is passed as an argument. This is a good place to set up extra vent properties or custom values.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-onemitbegin"></a>
<h4 class="cydoc-element-title">onEmitBegin</h4>
<font class="mini">
Type: function
<br>
Related: <a href="#vent-parameters-onemitend">onEmitEnd</a>
</font>
<p>A function called directly before an emission sequence begins.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-onemitend"></a>
<h4 class="cydoc-element-title">onEmitEnd</h4>
<font class="mini">
Type: function
<br>
Related: <a href="#vent-parameters-onemitbegin">onEmitBegin</a>
</font>
<p>A function called directly after an emission sequence ends.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-positiontype"></a>
<h4 class="cydoc-element-title">positionType</h4>
<font class="mini">
Type: string
<br>
Related: <a href="#vent-parameters-radius">radius</a>, <a href="#vent-parameters-xradius">xRadius</a>, <a href="#vent-parameters-yradius">yRadius</a>, <a href="#vent-parameters-innerradius">innerRadius</a>, <a href="#vent-parameters-innerxradius">innerXRadius</a>, <a href="#vent-parameters-inneryradius">innerYRadius</a>, <a href="#vent-parameters-point1">point1</a>, <a href="#vent-parameters-point2">point2</a>, <a href="#vent-parameters-linedensity">lineDensity</a>, <a href="#vent-parameters-rectleft">rectLeft</a>, <a href="#vent-parameters-recttop">rectTop</a>, <a href="#vent-parameters-rectwidth">rectWidth</a>, <a href="#vent-parameters-rectheight">rectHeight</a>, <a href="#vent-parameters-pointlist">pointList</a>, <a href="#vent-parameters-cyclepoint">cyclePoint</a>, <a href="#vent-parameters-curpoint">curPoint</a>, <a href="#vent-parameters-x">x</a>, <a href="#vent-parameters-y">y</a>
</font>
<p>Specifies the way particles are positioned.</p>
<p>Supported Values:
<ul>
<li><code>inRadius</code>: Makes particles appear inside an elliptical shape. To customize, see <code>radius</code>, <code>xRadius</code>, <code>yRadius</code>, <code>innerRadius</code>, <code>innerXRadius</code>, and <code>innerYRadius</code>.</li>
<li><code>alongLine</code>: Makes particles appear along a line. To customize, see <code>point1</code>, <code>point2</code>, and <code>lineDensity</code>.</li>
<li><code>inRect</code>: Makes particles appear inside of a rectangle. To customize, see <code>rectLeft</code>, <code>rectTop</code>, <code>rectWidth</code>, and <code>rectHeight</code>.</li>
<li><code>atPoint</code>: Makes particles appear at a single <code>(x, y)</code> point. To customize, see <code>x</code> and <code>y</code>.</li>
<li><code>fromPointList</code>: Makes particles appear on multiple points from the <code>pointList</code>. To customize, see <code>pointList</code>, and <code>cyclePoint</code>.</li>
<li><code>custom function</code>: Position particles using your own custom function. It must return two numbers, <code>x</code> and <code>y</code>, respectively. To use this capability, make this parameter, <code>positionType</code>, a function.</li>
</ul>
</p>
<br>
<hr></hr><br>
<a name="vent-parameters-radius"></a>
<h4 class="cydoc-element-title">radius</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-xradius">xRadius</a>, <a href="#vent-parameters-yradius">yRadius</a>, <a href="#vent-parameters-innerradius">innerRadius</a>, <a href="#vent-parameters-innerxradius">innerXRadius</a>, <a href="#vent-parameters-inneryradius">innerYRadius</a>
</font>
<p>The master size of the ellipse particles will appear in if <code>positionType</code> is <code>inRadius</code>. Acts as a default for <code>xRadius</code> and <code>yRadius</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-xradius"></a>
<h4 class="cydoc-element-title">xRadius</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-radius">radius</a>, <a href="#vent-parameters-yradius">yRadius</a>, <a href="#vent-parameters-innerradius">innerRadius</a>, <a href="#vent-parameters-innerxradius">innerXRadius</a>, <a href="#vent-parameters-inneryradius">innerYRadius</a>
</font>
<p>The half-width of the ellipse particles will appear in if <code>positionType</code> is <code>inRadius</code>. Defaults to <code>radius</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-yradius"></a>
<h4 class="cydoc-element-title">yRadius</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-radius">radius</a>, <a href="#vent-parameters-xradius">xRadius</a>, <a href="#vent-parameters-innerradius">innerRadius</a>, <a href="#vent-parameters-innerxradius">innerXRadius</a>, <a href="#vent-parameters-inneryradius">innerYRadius</a>
</font>
<p>The half-height of the ellipse particles will appear in if <code>positionType</code> is <code>inRadius</code>. Defaults to <code>radius</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-innerradius"></a>
<h4 class="cydoc-element-title">innerRadius</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-radius">radius</a>, <a href="#vent-parameters-xradius">xRadius</a>, <a href="#vent-parameters-yradius">yRadius</a>, <a href="#vent-parameters-innerxradius">innerXRadius</a>, <a href="#vent-parameters-inneryradius">innerYRadius</a>
</font>
<p>The master size of the ellipse particles will be blocked from appearing in if <code>positionType</code> is <code>inRadius</code>. Acts as a default for <code>innerXRadius</code> and <code>innerYRadius</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-innerxradius"></a>
<h4 class="cydoc-element-title">innerXRadius</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-radius">radius</a>, <a href="#vent-parameters-xradius">xRadius</a>, <a href="#vent-parameters-yradius">yRadius</a>, <a href="#vent-parameters-innerradius">innerRadius</a>, <a href="#vent-parameters-inneryradius">innerYRadius</a>
</font>
<p>The half-width of the ellipse particles will be blocked from appearing in if <code>positionType</code> is <code>inRadius</code>. Defaults to <code>innerRadius</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-inneryradius"></a>
<h4 class="cydoc-element-title">innerYRadius</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-radius">radius</a>, <a href="#vent-parameters-xradius">xRadius</a>, <a href="#vent-parameters-yradius">yRadius</a>, <a href="#vent-parameters-innerradius">innerRadius</a>, <a href="#vent-parameters-innerxradius">innerXRadius</a>
</font>
<p>The half-height of the ellipse particles will be blocked from appearing in if <code>positionType</code> is <code>inRadius</code>. Defaults to <code>innerRadius</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-point1"></a>
<h4 class="cydoc-element-title">point1</h4>
<font class="mini">
Type: table
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-point2">point2</a>, <a href="#vent-parameters-linedensity">lineDensity</a>
</font>
<p>The <code>(x, y)</code> location of the first point of the line particles will appear on if <code>positionType</code> is <code>alongLine</code>. Provided in the form of <code>{x, y}</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-point2"></a>
<h4 class="cydoc-element-title">point2</h4>
<font class="mini">
Type: table
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-point1">point1</a>, <a href="#vent-parameters-linedensity">lineDensity</a>
</font>
<p>The <code>(x, y)</code> location of the second point of the line particles will appear on if <code>positionType</code> is <code>alongLine</code>. Provided in the form of <code>{x, y}</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-linedensity"></a>
<h4 class="cydoc-element-title">lineDensity</h4>
<font class="mini">
Type: table
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-point1">point1</a>, <a href="#vent-parameters-point2">point2</a>
</font>
<p>The number of points to calculate along the line if <code>positionType</code> is <code>alongLine</code>. If set to the string <code>total</code>, will make an unbroken line.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-rectleft"></a>
<h4 class="cydoc-element-title">rectLeft</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-recttop">rectTop</a>, <a href="#vent-parameters-rectwidth">rectWidth</a>, <a href="#vent-parameters-rectheight">rectHeight</a>
</font>
<p>The left side of the rectangle particles appear inside if <code>positionType</code> is <code>inRect</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-recttop"></a>
<h4 class="cydoc-element-title">rectTop</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-rectleft">rectLeft</a>, <a href="#vent-parameters-rectwidth">rectWidth</a>, <a href="#vent-parameters-rectheight">rectHeight</a>
</font>
<p>The top side of the rectangle particles appear inside if <code>positionType</code> is <code>inRect</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-rectwidth"></a>
<h4 class="cydoc-element-title">rectWidth</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-rectleft">rectLeft</a>, <a href="#vent-parameters-recttop">rectTop</a>, <a href="#vent-parameters-rectheight">rectHeight</a>
</font>
<p>The width of the rectangle particles appear inside if <code>positionType</code> is <code>inRect</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-rectheight"></a>
<h4 class="cydoc-element-title">rectHeight</h4>
<font class="mini">
Type: number
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-rectleft">rectLeft</a>, <a href="#vent-parameters-recttop">rectTop</a>, <a href="#vent-parameters-rectwidth">rectWidth</a>
</font>
<p>The height of the rectangle particles appear inside if <code>positionType</code> is <code>inRect</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-pointlist"></a>
<h4 class="cydoc-element-title">pointList</h4>
<font class="mini">
Type: table
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-cyclepoint">cyclePoint</a>, <a href="#vent-parameters-pointincr">pointIncr</a>, <a href="#vent-parameters-curpoint">curPoint</a>
</font>
<p>The list of points particles will appear in if <code>positionType</code> is <code>fromPointList</code>. Provided in the form of <code>{{x, y}, {x, y}, {x, y}, ... }</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-cyclepoint"></a>
<h4 class="cydoc-element-title">cyclePoint</h4>
<font class="mini">
Type: Boolean
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-pointlist">pointList</a>, <a href="#vent-parameters-pointincr">pointIncr</a>, <a href="#vent-parameters-curpoint">curPoint</a>
</font>
<p>Whether points are chosen in order or randomly from the <code>pointTable</code> if <code>positionType</code> is <code>fromPointList</code>. If set to <code>true</code>, points are chosen in order. If <code>false</code>, they are picked randomly.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-pointincr"></a>
<h4 class="cydoc-element-title">pointIncr</h4>
<font class="mini">
Type: Boolean
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-pointlist">pointList</a>, <a href="#vent-parameters-cyclepoint">cyclePoint</a>, <a href="#vent-parameters-curpoint">curPoint</a>
</font>
<p>The value by which the current point is incremented if <code>cyclePoint</code> is <code>true</code>.</p>
<br>
<hr></hr><br>
<a name="vent-parameters-curpoint"></a>
<h4 class="cydoc-element-title">curPoint</h4>
<font class="mini">
Type: Boolean
<br>
Related: <a href="#vent-parameters-positiontype">positionType</a>, <a href="#vent-parameters-pointlist">pointList</a>, <a href="#vent-parameters-pointincr">pointIncr</a>, <a href="#vent-parameters-curpoint">curPoint</a>
</font>
<p>The point point cycling starts with if <code>positionType</code> is <code>fromPointList</code>.</p>
<br>
<footer></footer>
</div>
</html>