Skip to content

Commit 4b295e6

Browse files
ProcStackProcStack
committed
Added pxlNav v0.0.26 Docs
https://procstack.github.io/pxlNav-docs
1 parent a5105b5 commit 4b295e6

File tree

170 files changed

+98319
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

170 files changed

+98319
-1
lines changed

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ lerna-debug.log*
1010
dev
1111
Source/js/pxlRooms/CabinEnvironment
1212
Source/js/pxlRooms/VoidEnvironment
13-
pxlNav-*
1413

1514
# Maya likes being Maya
1615
.mayaSwatches

‎docs/assets/pxlNav_TheOutlet_2025-2-8_Coastline_sm.jpg‎

184 KB
Loading

‎docs/assets/ssScriptEditor.jpg‎

386 KB
Loading

‎docs/pxlNav-docs/BillowSmoke.html‎

Lines changed: 942 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/pxlNav-docs/BillowSmoke_BillowSmoke.html‎

Lines changed: 310 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,310 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
5+
<meta charset="utf-8">
6+
<title>BillowSmoke - Documentation</title>
7+
8+
9+
<script src="scripts/prettify/prettify.js"></script>
10+
<script src="scripts/prettify/lang-css.js"></script>
11+
<!--[if lt IE 9]>
12+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13+
<![endif]-->
14+
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
15+
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16+
<script src="scripts/nav.js" defer></script>
17+
18+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
19+
</head>
20+
<body>
21+
22+
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
23+
<label for="nav-trigger" class="navicon-button x">
24+
<div class="navicon"></div>
25+
</label>
26+
27+
<label for="nav-trigger" class="overlay"></label>
28+
29+
<nav >
30+
31+
<input type="text" id="nav-search" placeholder="Search" />
32+
33+
34+
<h2><a href="index.html">Home</a></h2><h2><a href="https://procstack.github.io/Outlet.htm" target="_blank" class="menu-item" id="pxlNav_Example" >pxlNav Example : The Outlet</a></h2><h3>Modules</h3><ul><li><a href="module-pxlNav.html">pxlNav</a></li><li><a href="pxlNav.module_pxlEffects.html">pxlNav.pxlEffects</a></li><li><a href="pxlNav.module_pxlEnv.html">pxlEnv</a></li><li><a href="pxlNav.pxlEffects.module_pxlParticles.html">pxlNav.pxlEffects.pxlParticles</a></li><li><a href="pxlNav.pxlEnv.module_pxlRoom.html">pxlRoom</a></li></ul><h3>Classes</h3><ul><li><a href="BillowSmoke_BillowSmoke.html">BillowSmoke</a></li><li><a href="EmberWisps_EmberWisps.html">EmberWisps</a></li><li><a href="FloatingDust_FloatingDust.html">FloatingDust</a></li><li><a href="HeightMap_HeightMap.html">HeightMap</a></li><li><a href="pxlEffects.pxlParticles.html">pxlParticles</a></li><li></li><li></li><li></li><li><a href="pxlEffects.pxlParticles.ParticleBase.html">ParticleBase</a></li><li><a href="pxlNav.pxlHUD.html">pxlHUD</a></li><li><a href="pxlRoom_RoomEnvironment.html">pxlRoom/RoomEnvironment</a><ul class='methods'><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#addColliderHelper">addColliderHelper</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#animPostLoad">animPostLoad</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#applyRoomPass">applyRoomPass</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#build">build</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#castRay">castRay</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#cleanupPortalRender">cleanupPortalRender</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#fbxPostLoad">fbxPostLoad</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#getArtistInfo">getArtistInfo</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#getColliders">getColliders</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#getCurrentShader">getCurrentShader</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#getLerpAvgRate">getLerpAvgRate</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#getLerpRate">getLerpRate</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#getName">getName</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#getShaderList">getShaderList</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#hasColliderType">hasColliderType</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#hasColliders">hasColliders</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#hitColliders">hitColliders</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#init">init</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#onMessage">onMessage</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#prepPortalRender">prepPortalRender</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#readShader">readShader</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#resetCamera">resetCamera</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#resize">resize</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#setDependencies">setDependencies</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#setFog">setFog</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#setPortalTexture">setPortalTexture</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#setShader">setShader</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#setUserHeight">setUserHeight</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#start">start</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#step">step</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#stepColliderHelper">stepColliderHelper</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#stop">stop</a></li><li data-type='method'><a href="pxlRoom_RoomEnvironment.html#toCameraPos">toCameraPos</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="pxlNav.module_pxlEffects-pxlEffects.html">pxlEffects</a></li><li><a href="pxlNav.pxlAnim.html">pxlAnim</a></li><li><a href="pxlNav.pxlAudio.html">pxlAudio</a></li><li><a href="pxlNav.pxlAutoCam.html">pxlAutoCam</a></li><li><a href="pxlNav.pxlCamera.html">pxlCamera</a></li><li><a href="pxlNav.pxlColliders.html">pxlColliders</a></li><li><a href="pxlNav.pxlCookie.html">pxlCookie</a></li><li><a href="pxlNav.pxlDevice.html">pxlDevice</a></li><li><a href="pxlNav.pxlFile.html">pxlFile</a></li><li><a href="pxlNav.pxlGuiDraws.html">pxlGuiDraws</a></li><li><a href="pxlNav.pxlQuality.html">pxlQuality</a></li><li><a href="pxlNav.pxlTimer.html">pxlTimer</a></li><li><a href="pxlNav.pxlUser.html">pxlUser</a></li><li><a href="pxlNav.pxlUtils.html">pxlUtils</a></li></ul>undefined
35+
36+
</nav>
37+
38+
<div id="main">
39+
40+
<h1 class="page-title">BillowSmoke</h1>
41+
42+
43+
44+
45+
46+
47+
48+
<section>
49+
50+
<header>
51+
52+
<h2>
53+
54+
BillowSmoke
55+
56+
</h2>
57+
58+
59+
</header>
60+
61+
<article>
62+
63+
<div class="container-overview">
64+
65+
66+
67+
68+
69+
<h4 class="name" id="BillowSmoke"><span class="type-signature"></span>new BillowSmoke<span class="signature">(room, systemName<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
70+
71+
72+
73+
74+
75+
76+
<dl class="details">
77+
78+
<dt class="tag-description">Description:</dt>
79+
<dd class="tag-description"><ul class="dummy"><li>Create a BillowSmoke instance.</li></ul></dd>
80+
81+
82+
83+
<dt class="tag-source">Source:</dt>
84+
<dd class="tag-source"><ul class="dummy"><li>
85+
<a href="pxlNav_effects_particles_BillowSmoke.js.html">pxlNav/effects/particles/BillowSmoke.js</a>, <a href="pxlNav_effects_particles_BillowSmoke.js.html#line32">line 32</a>
86+
</li></ul></dd>
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+
</dl>
119+
120+
121+
122+
123+
124+
125+
126+
127+
128+
129+
130+
131+
132+
<h5 class="h5-parameters">Parameters:</h5>
133+
134+
135+
<table class="params">
136+
<thead>
137+
<tr>
138+
139+
<th>Name</th>
140+
141+
142+
<th>Type</th>
143+
144+
145+
<th>Attributes</th>
146+
147+
148+
149+
<th>Default</th>
150+
151+
152+
<th class="last">Description</th>
153+
</tr>
154+
</thead>
155+
156+
<tbody>
157+
158+
159+
<tr>
160+
161+
<td class="name"><code>room</code></td>
162+
163+
164+
<td class="type">
165+
166+
167+
<span class="param-type">Object</span>
168+
169+
170+
171+
172+
</td>
173+
174+
175+
<td class="attributes">
176+
177+
178+
179+
180+
181+
</td>
182+
183+
184+
185+
<td class="default">
186+
187+
<code>null</code>
188+
189+
</td>
190+
191+
192+
<td class="description last">The room object where the particles will be added.</td>
193+
</tr>
194+
195+
196+
197+
<tr>
198+
199+
<td class="name"><code>systemName</code></td>
200+
201+
202+
<td class="type">
203+
204+
205+
<span class="param-type">string</span>
206+
207+
208+
209+
210+
</td>
211+
212+
213+
<td class="attributes">
214+
215+
&lt;optional><br>
216+
217+
218+
219+
220+
221+
</td>
222+
223+
224+
225+
<td class="default">
226+
227+
<code>'billowSmoke'</code>
228+
229+
</td>
230+
231+
232+
<td class="description last">The name of the particle system.</td>
233+
</tr>
234+
235+
236+
</tbody>
237+
</table>
238+
239+
240+
241+
242+
243+
244+
245+
246+
247+
248+
249+
250+
251+
252+
253+
254+
255+
256+
257+
258+
</div>
259+
260+
261+
262+
263+
264+
265+
266+
267+
268+
269+
270+
271+
272+
273+
274+
275+
276+
277+
278+
279+
280+
</article>
281+
282+
</section>
283+
284+
285+
286+
287+
288+
289+
</div>
290+
291+
<br class="clear">
292+
293+
<footer>
294+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Mon Mar 03 2025 08:05:19 GMT-0500 (Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
295+
</footer>
296+
297+
<script>prettyPrint();</script>
298+
<script src="scripts/polyfill.js"></script>
299+
<script src="scripts/linenumber.js"></script>
300+
301+
<script src="scripts/search.js" defer></script>
302+
303+
304+
305+
<script src="https://unpkg.com/mermaid/dist/mermaid.js"></script>
306+
307+
<script src="docs-init.js"></script>
308+
309+
</body>
310+
</html>

0 commit comments

Comments
 (0)