Skip to content

Commit 3758d43

Browse files
PhaserEditor2DPhaserEditor2D
committed
Help: phaser offline help.
1 parent ef2a7d9 commit 3758d43

File tree

155 files changed

+13883
-25169
lines changed

Some content is hidden

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

155 files changed

+13883
-25169
lines changed

‎source/phasereditor/BuildPhaserDocs/phaser-toc.xml

Lines changed: 407 additions & 872 deletions
Large diffs are not rendered by default.

‎source/phasereditor/BuildPhaserDocs/src/buildphaserdocs/BuildPhaserReferenceGuide.java

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,22 +48,27 @@ public static void main(String[] args) throws IOException {
4848
if (!Files.isDirectory(p) && (name.startsWith("Phaser.") || name.startsWith("PIXI."))) {
4949
try {
5050

51-
out.println("Processing " + p);
52-
toc.append("<topic href='html/phaser-doc/" + name + "' label='"
53-
+ name.substring(0, name.length() - 5) + "'> ");
51+
//out.println("Processing " + p);
52+
String topic = "<topic href='html/phaser-doc/" + name + "' label='"
53+
+ name.substring(0, name.length() - 5) + "'> ";
54+
toc.append(topic);
5455
String s = getJSDoc(p, toc);
5556
toc.append("</topic>\n");
5657

58+
5759
Files.write(Paths.get("output-docs").resolve(name), s.getBytes(), StandardOpenOption.CREATE);
5860

5961
} catch (Exception e) {
6062
e.printStackTrace();
6163
}
6264
}
6365
});
66+
6467
toc.append("</toc>\n");
6568

66-
Files.write(Paths.get("phaser-toc.xml"), toc.toString().getBytes(), StandardOpenOption.CREATE);
69+
String str = toc.toString();
70+
Files.write(Paths.get("phaser-toc.xml"), str.getBytes(), StandardOpenOption.CREATE);
71+
out.println(str);
6772
}
6873

6974
public static String getJSDoc(Path file, StringBuilder topics) throws IOException {

‎source/phasereditor/phasereditor.help/html/phaser-doc/PIXI.AbstractFilter.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ <h4 class="name " id="AbstractFilter"><span class="type-signature"></span>new Ab
1010
</dt>
1111
<dd>
1212
<div class="description">
13-
<p>This is the base class for creating a PIXI filter. Currently only webGL supports filters. If you want to make a custom filter this should be your base class.</p>
13+
<p>This is the base class for creating a PIXI filter. Currently only webGL supports filters.<br>If you want to make a custom filter this should be your base class.</p>
1414
</div>
1515
<h5>Parameters:</h5>
1616
<table class="params table table-striped">

‎source/phasereditor/phasereditor.help/html/phaser-doc/PIXI.BaseTexture.html

Lines changed: 61 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ <h5>Parameters:</h5>
2424
<tbody>
2525
<tr>
2626
<td class="name"><code>source</code></td>
27-
<td class="type"> <span class="param-type">String</span> </td>
27+
<td class="type"> <span class="param-type">String</span> | <span class="param-type">Canvas</span> </td>
2828
<td class="description last"><p>the source object (image or canvas)</p></td>
2929
</tr>
3030
<tr>
@@ -38,7 +38,7 @@ <h5>Parameters:</h5>
3838
<dt class="tag-source">
3939
Source -
4040
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
41-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-9">line 9</a>
41+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-5">line 5</a>
4242
</dt>
4343
</dl>
4444
</dd>
@@ -56,7 +56,7 @@ <h4 class="name " id="hasLoaded"><span class="type-signature">&lt;readonly&gt; <
5656
<dt class="tag-source">
5757
Source -
5858
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
59-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-55">line 55</a>
59+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-51">line 51</a>
6060
</dt>
6161
</dl>
6262
</dd>
@@ -71,19 +71,7 @@ <h4 class="name " id="height"><span class="type-signature">&lt;readonly&gt; </sp
7171
<dt class="tag-source">
7272
Source -
7373
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
74-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-37">line 37</a>
75-
</dt>
76-
</dl>
77-
</dd>
78-
<dt>
79-
<h4 class="name " id="imageUrl"><span class="type-signature"></span>imageUrl<span class="type-signature"> :String</span></h4>
80-
</dt>
81-
<dd>
82-
<dl class="details">
83-
<dt class="tag-source">
84-
Source -
85-
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
86-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-132">line 132</a>
74+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-33">line 33</a>
8775
</dt>
8876
</dl>
8977
</dd>
@@ -92,13 +80,13 @@ <h4 class="name " id="mipmap"><span class="type-signature"></span>mipmap<span cl
9280
</dt>
9381
<dd>
9482
<div class="description">
95-
<p>Set this to true if a mipmap of this texture needs to be generated. This value needs to be set before the texture is used Also the texture must be a power of two size to work</p>
83+
<p>Set this to true if a mipmap of this texture needs to be generated. This value needs to be set before the texture is used<br>Also the texture must be a power of two size to work</p>
9684
</div>
9785
<dl class="details">
9886
<dt class="tag-source">
9987
Source -
10088
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
101-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-92">line 92</a>
89+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-86">line 86</a>
10290
</dt>
10391
</dl>
10492
</dd>
@@ -121,7 +109,7 @@ <h4 class="name " id="premultipliedAlpha"><span class="type-signature"></span>pr
121109
<dt class="tag-source">
122110
Source -
123111
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
124-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-74">line 74</a>
112+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-68">line 68</a>
125113
</dt>
126114
</dl>
127115
</dd>
@@ -136,7 +124,7 @@ <h4 class="name " id="resolution"><span class="type-signature"></span>resolution
136124
<dt class="tag-source">
137125
Source -
138126
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
139-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-20">line 20</a>
127+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-16">line 16</a>
140128
</dt>
141129
</dl>
142130
</dd>
@@ -159,7 +147,7 @@ <h4 class="name " id="scaleMode"><span class="type-signature"></span>scaleMode<s
159147
<dt class="tag-source">
160148
Source -
161149
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
162-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-46">line 46</a>
150+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-42">line 42</a>
163151
</dt>
164152
</dl>
165153
</dd>
@@ -169,13 +157,13 @@ <h4 class="name " id="skipRender"><span class="type-signature"></span>skipRender
169157
<dd>
170158
<div class="description">
171159
<p>A BaseTexture can be set to skip the rendering phase in the WebGL Sprite Batch.</p>
172-
<p>You may want to do this if you have a parent Sprite with no visible texture (i.e. uses the internal <code>__default</code> texture) that has children that you do want to render, without causing a batch flush in the process.</p>
160+
<p>You may want to do this if you have a parent Sprite with no visible texture (i.e. uses the internal <code>__default</code> texture)<br>that has children that you do want to render, without causing a batch flush in the process.</p>
173161
</div>
174162
<dl class="details">
175163
<dt class="tag-source">
176164
Source -
177165
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
178-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-121">line 121</a>
166+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-115">line 115</a>
179167
</dt>
180168
</dl>
181169
</dd>
@@ -190,7 +178,7 @@ <h4 class="name " id="source"><span class="type-signature"></span>source<span cl
190178
<dt class="tag-source">
191179
Source -
192180
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
193-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-64">line 64</a>
181+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-60">line 60</a>
194182
</dt>
195183
</dl>
196184
</dd>
@@ -205,7 +193,7 @@ <h4 class="name " id="width"><span class="type-signature">&lt;readonly&gt; </spa
205193
<dt class="tag-source">
206194
Source -
207195
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
208-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-28">line 28</a>
196+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-24">line 24</a>
209197
</dt>
210198
</dl>
211199
</dd>
@@ -253,57 +241,7 @@ <h5>Returns:</h5>
253241
<dt class="tag-source">
254242
Source -
255243
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
256-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-295">line 295</a>
257-
</dt>
258-
</dl>
259-
</dd>
260-
<dt>
261-
<h4 class="name " id=".fromImage"><span class="type-signature">&lt;static&gt; </span>fromImage<span class="signature">(imageUrl, crossorigin, scaleMode)</span><span class="type-signature"> ? {<a href="PIXI.BaseTexture.html">PIXI.BaseTexture</a>}</span></h4>
262-
</dt>
263-
<dd>
264-
<div class="description">
265-
<p>Helper function that creates a base texture from the given image url. If the image is not in the base texture cache it will be created and loaded.</p>
266-
</div>
267-
<h5>Parameters:</h5>
268-
<table class="params table table-striped">
269-
<thead>
270-
<tr>
271-
<th>Name</th>
272-
<th>Type</th>
273-
<th class="last">Description</th>
274-
</tr>
275-
</thead>
276-
<tbody>
277-
<tr>
278-
<td class="name"><code>imageUrl</code></td>
279-
<td class="type"> <span class="param-type">String</span> </td>
280-
<td class="description last"><p>The image url of the texture</p></td>
281-
</tr>
282-
<tr>
283-
<td class="name"><code>crossorigin</code></td>
284-
<td class="type"> <span class="param-type">Boolean</span> </td>
285-
<td class="description last"><p>-</p></td>
286-
</tr>
287-
<tr>
288-
<td class="name"><code>scaleMode</code></td>
289-
<td class="type"> <span class="param-type">Number</span> </td>
290-
<td class="description last"><p>See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values</p></td>
291-
</tr>
292-
</tbody>
293-
</table>
294-
<h5>Returns:</h5>
295-
<div class="returns">
296-
<div class="returns-type">
297-
<span class="param-type"><a href="PIXI.BaseTexture.html">PIXI.BaseTexture</a></span> -
298-
</div>
299-
<div class="returns-desc param-desc">
300-
</div>
301-
</div>
302-
<dl class="details">
303-
<dt class="tag-source">
304-
Source -
305-
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
306-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-252">line 252</a>
244+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-224">line 224</a>
307245
</dt>
308246
</dl>
309247
</dd>
@@ -318,7 +256,7 @@ <h4 class="name " id="destroy"><span class="type-signature"></span>destroy<span
318256
<dt class="tag-source">
319257
Source -
320258
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
321-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-167">line 167</a>
259+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-154">line 154</a>
322260
</dt>
323261
</dl>
324262
</dd>
@@ -333,7 +271,7 @@ <h4 class="name " id="dirty"><span class="type-signature"></span>dirty<span clas
333271
<dt class="tag-source">
334272
Source -
335273
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
336-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-211">line 211</a>
274+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-183">line 183</a>
337275
</dt>
338276
</dl>
339277
</dd>
@@ -342,7 +280,7 @@ <h4 class="name " id="forceLoaded"><span class="type-signature"></span>forceLoad
342280
</dt>
343281
<dd>
344282
<div class="description">
345-
<p>Forces this BaseTexture to be set as loaded, with the given width and height. Then calls BaseTexture.dirty. Important for when you don't want to modify the source object by forcing in <code>complete</code> or dimension properties it may not have.</p>
283+
<p>Forces this BaseTexture to be set as loaded, with the given width and height.<br>Then calls BaseTexture.dirty.<br>Important for when you don't want to modify the source object by forcing in <code>complete</code> or dimension properties it may not have.</p>
346284
</div>
347285
<h5>Parameters:</h5>
348286
<table class="params table table-striped">
@@ -376,7 +314,7 @@ <h5>Parameters:</h5>
376314
<dt class="tag-source">
377315
Source -
378316
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
379-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-149">line 149</a>
317+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-137">line 137</a>
380318
</dt>
381319
</dl>
382320
</dd>
@@ -385,48 +323,60 @@ <h4 class="name " id="unloadFromGPU"><span class="type-signature"></span>unloadF
385323
</dt>
386324
<dd>
387325
<div class="description">
388-
<p>Removes the base texture from the GPU, useful for managing resources on the GPU. Atexture is still 100% usable and will simply be reuploaded if there is a sprite on screen that is using it.</p>
326+
<p>Removes the base texture from the GPU, useful for managing resources on the GPU.<br>Atexture is still 100% usable and will simply be reuploaded if there is a sprite on screen that is using it.</p>
389327
</div>
390328
<dl class="details">
391329
<dt class="tag-source">
392330
Source -
393331
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
394-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-224">line 224</a>
332+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-196">line 196</a>
395333
</dt>
396334
</dl>
397335
</dd>
398336
<dt>
399-
<h4 class="name " id="updateSourceImage"><span class="type-signature"></span>updateSourceImage<span class="signature">(newSrc)</span><span class="type-signature"></span></h4>
337+
<h4 class="name toc-deprecated" id="updateSourceImage"><span class="type-signature"></span>updateSourceImage<span class="signature">(newSrc)</span><span class="type-signature"></span></h4>
400338
</dt>
401339
<dd>
402-
<div class="description">
403-
<p>Changes the source image of the texture</p>
404-
</div>
405-
<h5>Parameters:</h5>
406-
<table class="params table table-striped">
407-
<thead>
408-
<tr>
409-
<th>Name</th>
410-
<th>Type</th>
411-
<th class="last">Description</th>
412-
</tr>
413-
</thead>
414-
<tbody>
415-
<tr>
416-
<td class="name"><code>newSrc</code></td>
417-
<td class="type"> <span class="param-type">String</span> </td>
418-
<td class="description last"><p>the path of the image</p></td>
419-
</tr>
420-
</tbody>
421-
</table>
422-
<dl class="details">
423-
<dt class="tag-source">
424-
Source -
425-
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
426-
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-198">line 198</a>
427-
</dt>
428-
</dl>
429-
</dd>
340+
</dd>
341+
<dt class="important deprecated-notice">
342+
This method is
343+
<em>deprecated</em> and should not be used. It may be removed in the future.
344+
</dt>
345+
<div class="description">
346+
<p>Changes the source image of the texture</p>
347+
</div>
348+
<h5>Parameters:</h5>
349+
<table class="params table table-striped">
350+
<thead>
351+
<tr>
352+
<th>Name</th>
353+
<th>Type</th>
354+
<th class="last">Description</th>
355+
</tr>
356+
</thead>
357+
<tbody>
358+
<tr>
359+
<td class="name"><code>newSrc</code></td>
360+
<td class="type"> <span class="param-type">String</span> </td>
361+
<td class="description last"><p>the path of the image</p></td>
362+
</tr>
363+
</tbody>
364+
</table>
365+
<dl class="details">
366+
<dt class="important tag-deprecated">
367+
Deprecated:
368+
</dt>
369+
<dd class="tag-deprecated">
370+
<ul>
371+
<li>true</li>
372+
</ul>
373+
</dd>
374+
<dt class="tag-source">
375+
Source -
376+
<a href="src_pixi_textures_BaseTexture.js.html">pixi/textures/BaseTexture.js</a>,
377+
<a href="src_pixi_textures_BaseTexture.js.html#sunlight-1-line-171">line 171</a>
378+
</dt>
379+
</dl>
430380
</dl>
431381
</article>
432382
</section></head></html>

‎source/phasereditor/phasereditor.help/html/phaser-doc/PIXI.CanvasPool.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ <h4 class="name " id=".pool"><span class="type-signature">&lt;static&gt; </span>
3434
<dt class="tag-source">
3535
Source -
3636
<a href="src_pixi_utils_CanvasPool.js.html">pixi/utils/CanvasPool.js</a>,
37-
<a href="src_pixi_utils_CanvasPool.js.html#sunlight-1-line-173">line 173</a>
37+
<a href="src_pixi_utils_CanvasPool.js.html#sunlight-1-line-177">line 177</a>
3838
</dt>
3939
</dl>
4040
</dd>
@@ -135,7 +135,7 @@ <h5>Returns:</h5>
135135
<dt class="tag-source">
136136
Source -
137137
<a href="src_pixi_utils_CanvasPool.js.html">pixi/utils/CanvasPool.js</a>,
138-
<a href="src_pixi_utils_CanvasPool.js.html#sunlight-1-line-147">line 147</a>
138+
<a href="src_pixi_utils_CanvasPool.js.html#sunlight-1-line-151">line 151</a>
139139
</dt>
140140
</dl>
141141
</dd>
@@ -159,7 +159,7 @@ <h5>Returns:</h5>
159159
<dt class="tag-source">
160160
Source -
161161
<a href="src_pixi_utils_CanvasPool.js.html">pixi/utils/CanvasPool.js</a>,
162-
<a href="src_pixi_utils_CanvasPool.js.html#sunlight-1-line-123">line 123</a>
162+
<a href="src_pixi_utils_CanvasPool.js.html#sunlight-1-line-127">line 127</a>
163163
</dt>
164164
</dl>
165165
</dd>
@@ -223,7 +223,7 @@ <h5>Parameters:</h5>
223223
<dt class="tag-source">
224224
Source -
225225
<a href="src_pixi_utils_CanvasPool.js.html">pixi/utils/CanvasPool.js</a>,
226-
<a href="src_pixi_utils_CanvasPool.js.html#sunlight-1-line-102">line 102</a>
226+
<a href="src_pixi_utils_CanvasPool.js.html#sunlight-1-line-104">line 104</a>
227227
</dt>
228228
</dl>
229229
</dd>

0 commit comments

Comments
 (0)