lywsvip/oops-plugin-framework
1
0
Fork 0
mirror of https://gitee.com/dgflash/oops-plugin-framework.git synced 2026-05-10 23:45:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

更新文档

Browse Source
This commit is contained in:
dgflash
2022-09-02 15:14:33 +08:00
parent a7eeba8659
commit 8bcbc8179b
28 changed files with 464 additions and 379 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/classes/ResLoader.html
View File

@@ -105,7 +105,7 @@
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>加载一个资源</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">res</span><span class="hl-1">.</span><span class="hl-5">load</span><span class="hl-1">(</span><span class="hl-4">&quot;spine_path&quot;</span><span class="hl-1">, </span><span class="hl-0">sp</span><span class="hl-1">.</span><span class="hl-0">SkeletonData</span><span class="hl-1">, (</span><span class="hl-0">err</span><span class="hl-1">: </span><span class="hl-2">Error</span><span class="hl-1"> | </span><span class="hl-2">null</span><span class="hl-1">, </span><span class="hl-0">sd</span><span class="hl-1">: </span><span class="hl-2">sp</span><span class="hl-1">.</span><span class="hl-2">SkeletonData</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><br/><span class="hl-1">});</span>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">res</span><span class="hl-1">.</span><span class="hl-7">load</span><span class="hl-1">(</span><span class="hl-6">&quot;spine_path&quot;</span><span class="hl-1">, </span><span class="hl-0">sp</span><span class="hl-1">.</span><span class="hl-0">SkeletonData</span><span class="hl-1">, (</span><span class="hl-0">err</span><span class="hl-1">: </span><span class="hl-4">Error</span><span class="hl-1"> | </span><span class="hl-4">null</span><span class="hl-1">, </span><span class="hl-0">sd</span><span class="hl-1">: </span><span class="hl-4">sp</span><span class="hl-1">.</span><span class="hl-4">SkeletonData</span><span class="hl-1">) </span><span class="hl-8">=&gt;</span><span class="hl-1"> {</span><br/><br/><span class="hl-1">});</span>
</code></pre>
</div>
<div class="tsd-type-parameters">
@@ -299,7 +299,7 @@
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>加载资源包</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-6">var</span><span class="hl-1"> </span><span class="hl-0">serverUrl</span><span class="hl-1"> = </span><span class="hl-4">&quot;http://192.168.1.8:8080/&quot;</span><span class="hl-1">; </span><span class="hl-9">// 服务器地址</span><br/><span class="hl-6">var</span><span class="hl-1"> </span><span class="hl-0">md5</span><span class="hl-1"> = </span><span class="hl-4">&quot;8e5c0&quot;</span><span class="hl-1">; </span><span class="hl-9">// Cocos Creator 构建后的MD5字符</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">res</span><span class="hl-1">.</span><span class="hl-5">loadBundle</span><span class="hl-1">(</span><span class="hl-0">serverUrl</span><span class="hl-1">,</span><span class="hl-0">md5</span><span class="hl-1">);</span>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-0">serverUrl</span><span class="hl-1"> = </span><span class="hl-6">&quot;http://192.168.1.8:8080/&quot;</span><span class="hl-1">; </span><span class="hl-3">// 服务器地址</span><br/><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-0">md5</span><span class="hl-1"> = </span><span class="hl-6">&quot;8e5c0&quot;</span><span class="hl-1">; </span><span class="hl-3">// Cocos Creator 构建后的MD5字符</span><br/><span class="hl-5">await</span><span class="hl-1"> </span><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">res</span><span class="hl-1">.</span><span class="hl-7">loadBundle</span><span class="hl-1">(</span><span class="hl-0">serverUrl</span><span class="hl-1">,</span><span class="hl-0">md5</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
@@ -365,7 +365,7 @@
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>加载文件夹中的资源</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-9">// 加载进度事件</span><br/><span class="hl-6">var</span><span class="hl-1"> </span><span class="hl-5">onProgressCallback</span><span class="hl-1"> = (</span><span class="hl-0">finished</span><span class="hl-1">: </span><span class="hl-2">number</span><span class="hl-1">, </span><span class="hl-0">total</span><span class="hl-1">: </span><span class="hl-2">number</span><span class="hl-1">, </span><span class="hl-0">item</span><span class="hl-1">: </span><span class="hl-2">any</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-4">&quot;资源加载进度&quot;</span><span class="hl-1">, </span><span class="hl-0">finished</span><span class="hl-1">, </span><span class="hl-0">total</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-9">// 加载完成事件</span><br/><span class="hl-6">var</span><span class="hl-1"> </span><span class="hl-5">onCompleteCallback</span><span class="hl-1"> = () </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-4">&quot;资源加载完成&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">res</span><span class="hl-1">.</span><span class="hl-5">loadDir</span><span class="hl-1">(</span><span class="hl-4">&quot;game&quot;</span><span class="hl-1">, </span><span class="hl-0">onProgressCallback</span><span class="hl-1">, </span><span class="hl-0">onCompleteCallback</span><span class="hl-1">);</span>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-3">// 加载进度事件</span><br/><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-7">onProgressCallback</span><span class="hl-1"> = (</span><span class="hl-0">finished</span><span class="hl-1">: </span><span class="hl-4">number</span><span class="hl-1">, </span><span class="hl-0">total</span><span class="hl-1">: </span><span class="hl-4">number</span><span class="hl-1">, </span><span class="hl-0">item</span><span class="hl-1">: </span><span class="hl-4">any</span><span class="hl-1">) </span><span class="hl-8">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-6">&quot;资源加载进度&quot;</span><span class="hl-1">, </span><span class="hl-0">finished</span><span class="hl-1">, </span><span class="hl-0">total</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">// 加载完成事件</span><br/><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-7">onCompleteCallback</span><span class="hl-1"> = () </span><span class="hl-8">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-6">&quot;资源加载完成&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">res</span><span class="hl-1">.</span><span class="hl-7">loadDir</span><span class="hl-1">(</span><span class="hl-6">&quot;game&quot;</span><span class="hl-1">, </span><span class="hl-0">onProgressCallback</span><span class="hl-1">, </span><span class="hl-0">onCompleteCallback</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-type-parameters">
@@ -559,7 +559,7 @@
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>加载远程资源</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-6">var</span><span class="hl-1"> </span><span class="hl-0">opt</span><span class="hl-1">: </span><span class="hl-2">IRemoteOptions</span><span class="hl-1"> = { </span><span class="hl-0">ext:</span><span class="hl-1"> </span><span class="hl-4">&quot;.png&quot;</span><span class="hl-1"> };</span><br/><span class="hl-6">var</span><span class="hl-1"> </span><span class="hl-5">onComplete</span><span class="hl-1"> = (</span><span class="hl-0">err</span><span class="hl-1">: </span><span class="hl-2">Error</span><span class="hl-1"> | </span><span class="hl-2">null</span><span class="hl-1">, </span><span class="hl-0">data</span><span class="hl-1">: </span><span class="hl-2">ImageAsset</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-8">texture</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-5">Texture2D</span><span class="hl-1">();</span><br/><span class="hl-0">texture</span><span class="hl-1">.</span><span class="hl-0">image</span><span class="hl-1"> = </span><span class="hl-0">data</span><span class="hl-1">;</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-8">spriteFrame</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-5">SpriteFrame</span><span class="hl-1">();</span><br/><span class="hl-0">spriteFrame</span><span class="hl-1">.</span><span class="hl-0">texture</span><span class="hl-1"> = </span><span class="hl-0">texture</span><span class="hl-1">;</span><br/><br/><span class="hl-6">var</span><span class="hl-1"> </span><span class="hl-0">sprite</span><span class="hl-1"> = </span><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-0">sprite</span><span class="hl-1">.</span><span class="hl-5">addComponent</span><span class="hl-1">(</span><span class="hl-0">Sprite</span><span class="hl-1">);</span><br/><span class="hl-0">sprite</span><span class="hl-1">.</span><span class="hl-0">spriteFrame</span><span class="hl-1"> = </span><span class="hl-0">spriteFrame</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">res</span><span class="hl-1">.</span><span class="hl-5">loadRemote</span><span class="hl-1">&lt;</span><span class="hl-2">ImageAsset</span><span class="hl-1">&gt;(</span><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-0">url</span><span class="hl-1">, </span><span class="hl-0">opt</span><span class="hl-1">, </span><span class="hl-0">onComplete</span><span class="hl-1">);</span>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-0">opt</span><span class="hl-1">: </span><span class="hl-4">IRemoteOptions</span><span class="hl-1"> = { </span><span class="hl-0">ext:</span><span class="hl-1"> </span><span class="hl-6">&quot;.png&quot;</span><span class="hl-1"> };</span><br/><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-7">onComplete</span><span class="hl-1"> = (</span><span class="hl-0">err</span><span class="hl-1">: </span><span class="hl-4">Error</span><span class="hl-1"> | </span><span class="hl-4">null</span><span class="hl-1">, </span><span class="hl-0">data</span><span class="hl-1">: </span><span class="hl-4">ImageAsset</span><span class="hl-1">) </span><span class="hl-8">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-10">texture</span><span class="hl-1"> = </span><span class="hl-8">new</span><span class="hl-1"> </span><span class="hl-7">Texture2D</span><span class="hl-1">();</span><br/><span class="hl-0">texture</span><span class="hl-1">.</span><span class="hl-0">image</span><span class="hl-1"> = </span><span class="hl-0">data</span><span class="hl-1">;</span><br/><br/><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-10">spriteFrame</span><span class="hl-1"> = </span><span class="hl-8">new</span><span class="hl-1"> </span><span class="hl-7">SpriteFrame</span><span class="hl-1">();</span><br/><span class="hl-0">spriteFrame</span><span class="hl-1">.</span><span class="hl-0">texture</span><span class="hl-1"> = </span><span class="hl-0">texture</span><span class="hl-1">;</span><br/><br/><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-0">sprite</span><span class="hl-1"> = </span><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-0">sprite</span><span class="hl-1">.</span><span class="hl-7">addComponent</span><span class="hl-1">(</span><span class="hl-0">Sprite</span><span class="hl-1">);</span><br/><span class="hl-0">sprite</span><span class="hl-1">.</span><span class="hl-0">spriteFrame</span><span class="hl-1"> = </span><span class="hl-0">spriteFrame</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">res</span><span class="hl-1">.</span><span class="hl-7">loadRemote</span><span class="hl-1">&lt;</span><span class="hl-4">ImageAsset</span><span class="hl-1">&gt;(</span><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-0">url</span><span class="hl-1">, </span><span class="hl-0">opt</span><span class="hl-1">, </span><span class="hl-0">onComplete</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-type-parameters">