mirror of
https://gitee.com/dgflash/oops-plugin-framework.git
synced 2026-06-03 18:49:23 +08:00
ECS架API文件
This commit is contained in:
dgflash
@@ -172,7 +172,7 @@
|
||||
|
||||
<h3>Zh</h3><p>该组件被附加到的节点。组件总会附加到一个节点。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">comp</span><span class="hl-1">.</span><span class="hl-0">node</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">comp</span><span class="hl-1">.</span><span class="hl-0">node</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div><aside class="tsd-sources">
|
||||
<p>Inherited from Component.node</p>
|
||||
@@ -222,7 +222,7 @@
|
||||
<h3>Zh</h3><p>返回一个值用来判断 onLoad 是否被调用过，不等于 0 时调用过，等于 0 时未调用。</p>
|
||||
|
||||
<h3>Read Only</h3>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-0">_isOnLoadCalled</span><span class="hl-1"> > </span><span class="hl-9">0</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-0">_isOnLoadCalled</span><span class="hl-1"> > </span><span class="hl-10">0</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Deprecated</h3><p>since v3.5.0, this is an engine private interface that will be removed in the future.</p>
|
||||
@@ -243,7 +243,7 @@
|
||||
|
||||
<h3>Default</h3><p>true</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-0">comp</span><span class="hl-1">.</span><span class="hl-0">enabled</span><span class="hl-1"> = </span><span class="hl-8">true</span><span class="hl-1">;</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">comp</span><span class="hl-1">.</span><span class="hl-0">enabled</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-0">comp</span><span class="hl-1">.</span><span class="hl-0">enabled</span><span class="hl-1"> = </span><span class="hl-6">true</span><span class="hl-1">;</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">comp</span><span class="hl-1">.</span><span class="hl-0">enabled</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||||
@@ -272,7 +272,7 @@
|
||||
<h3>Zh</h3><p>表示该组件是否被启用并且所在的节点也处于激活状态。</p>
|
||||
|
||||
<h3>Read Only</h3>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">comp</span><span class="hl-1">.</span><span class="hl-0">enabledInHierarchy</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">comp</span><span class="hl-1">.</span><span class="hl-0">enabledInHierarchy</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||||
@@ -324,7 +324,7 @@ but this is often caused by a particular logical requirements, which is not norm
|
||||
<h3>Default</h3><p>true</p>
|
||||
|
||||
<h3>Read Only</h3>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">Node</span><span class="hl-1">, </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-10">node</span><span class="hl-1"> = </span><span class="hl-8">new</span><span class="hl-1"> </span><span class="hl-7">Node</span><span class="hl-1">();</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-0">isValid</span><span class="hl-1">); </span><span class="hl-3">// true</span><br/><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">destroy</span><span class="hl-1">();</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-0">isValid</span><span class="hl-1">); </span><span class="hl-3">// true, still valid in this frame</span><br/><span class="hl-3">// after a frame...</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-0">isValid</span><span class="hl-1">); </span><span class="hl-3">// false, destroyed in the end of last frame</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">Node</span><span class="hl-1">, </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-8">node</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-7">Node</span><span class="hl-1">();</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-0">isValid</span><span class="hl-1">); </span><span class="hl-3">// true</span><br/><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">destroy</span><span class="hl-1">();</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-0">isValid</span><span class="hl-1">); </span><span class="hl-3">// true, still valid in this frame</span><br/><span class="hl-3">// after a frame...</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-0">isValid</span><span class="hl-1">); </span><span class="hl-3">// false, destroyed in the end of last frame</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||||
@@ -382,7 +382,7 @@ but this is often caused by a particular logical requirements, which is not norm
|
||||
<h3>Zh</h3><p>组件的 uuid，用于编辑器。</p>
|
||||
|
||||
<h3>Read Only</h3>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">comp</span><span class="hl-1">.</span><span class="hl-0">uuid</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">comp</span><span class="hl-1">.</span><span class="hl-0">uuid</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
@@ -437,7 +437,7 @@ This method should be removed if script priority is supported.</p>
|
||||
|
||||
<h3>Deprecated</h3><p>since v3.5.0, this is an engine private interface that will be removed in the future.</p>
|
||||
|
||||
<h3>Example</h3><pre><code><span class="hl-3">// You can override the _destruct method if you need, for example:</span><br/><span class="hl-1"> </span><span class="hl-2">_destruct</span><span class="hl-1">: </span><span class="hl-8">function</span><span class="hl-1"> () {</span><br/><span class="hl-1"> </span><span class="hl-5">for</span><span class="hl-1"> (</span><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-0">key</span><span class="hl-1"> </span><span class="hl-8">in</span><span class="hl-1"> </span><span class="hl-8">this</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (</span><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-7">hasOwnProperty</span><span class="hl-1">(</span><span class="hl-0">key</span><span class="hl-1">)) {</span><br/><span class="hl-1"> </span><span class="hl-5">switch</span><span class="hl-1"> (</span><span class="hl-8">typeof</span><span class="hl-1"> </span><span class="hl-8">this</span><span class="hl-1">[</span><span class="hl-0">key</span><span class="hl-1">]) {</span><br/><span class="hl-1"> </span><span class="hl-5">case</span><span class="hl-1"> </span><span class="hl-6">'string'</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-8">this</span><span class="hl-1">[</span><span class="hl-0">key</span><span class="hl-1">] = </span><span class="hl-6">''</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">break</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">case</span><span class="hl-1"> </span><span class="hl-6">'object'</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-5">case</span><span class="hl-1"> </span><span class="hl-6">'function'</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-8">this</span><span class="hl-1">[</span><span class="hl-0">key</span><span class="hl-1">] = </span><span class="hl-8">null</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">break</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span>
|
||||
<h3>Example</h3><pre><code><span class="hl-3">// You can override the _destruct method if you need, for example:</span><br/><span class="hl-1"> </span><span class="hl-2">_destruct</span><span class="hl-1">: </span><span class="hl-6">function</span><span class="hl-1"> () {</span><br/><span class="hl-1"> </span><span class="hl-5">for</span><span class="hl-1"> (</span><span class="hl-6">var</span><span class="hl-1"> </span><span class="hl-0">key</span><span class="hl-1"> </span><span class="hl-6">in</span><span class="hl-1"> </span><span class="hl-6">this</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (</span><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-7">hasOwnProperty</span><span class="hl-1">(</span><span class="hl-0">key</span><span class="hl-1">)) {</span><br/><span class="hl-1"> </span><span class="hl-5">switch</span><span class="hl-1"> (</span><span class="hl-6">typeof</span><span class="hl-1"> </span><span class="hl-6">this</span><span class="hl-1">[</span><span class="hl-0">key</span><span class="hl-1">]) {</span><br/><span class="hl-1"> </span><span class="hl-5">case</span><span class="hl-1"> </span><span class="hl-9">'string'</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-6">this</span><span class="hl-1">[</span><span class="hl-0">key</span><span class="hl-1">] = </span><span class="hl-9">''</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">break</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">case</span><span class="hl-1"> </span><span class="hl-9">'object'</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-5">case</span><span class="hl-1"> </span><span class="hl-9">'function'</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-6">this</span><span class="hl-1">[</span><span class="hl-0">key</span><span class="hl-1">] = </span><span class="hl-6">null</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">break</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||||
@@ -528,7 +528,7 @@ a custom axis aligned bounding box (AABB), so the editor's scene view can pe
|
||||
|
||||
<h3>Zh</h3><p>向节点添加一个指定类型的组件类，你还可以通过传入脚本的名称来添加组件。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">Sprite</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-10">sprite</span><span class="hl-1"> = </span><span class="hl-0">node</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>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">Sprite</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-8">sprite</span><span class="hl-1"> = </span><span class="hl-0">node</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>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-type-parameters">
|
||||
@@ -556,7 +556,7 @@ a custom axis aligned bounding box (AABB), so the editor's scene view can pe
|
||||
|
||||
<h3>Zh</h3><p>向节点添加一个指定类型的组件类，你还可以通过传入脚本的名称来添加组件。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-10">test</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">addComponent</span><span class="hl-1">(</span><span class="hl-6">"Test"</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-8">test</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">addComponent</span><span class="hl-1">(</span><span class="hl-9">"Test"</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-parameters">
|
||||
@@ -608,7 +608,7 @@ You can also get component in the node by passing in the name of the script.</p>
|
||||
<h3>Zh</h3><p>获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。<br/>
|
||||
传入参数也可以是脚本的名称。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">Sprite</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-3">// get sprite component.</span><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-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponent</span><span class="hl-1">(</span><span class="hl-0">Sprite</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">Sprite</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-3">// get sprite component.</span><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-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponent</span><span class="hl-1">(</span><span class="hl-0">Sprite</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-type-parameters">
|
||||
@@ -638,7 +638,7 @@ You can also get component in the node by passing in the name of the script.</p>
|
||||
<h3>Zh</h3><p>获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。<br/>
|
||||
传入参数也可以是脚本的名称。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-3">// get custom test calss.</span><br/><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-0">test</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponent</span><span class="hl-1">(</span><span class="hl-6">"Test"</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-3">// get custom test calss.</span><br/><span class="hl-6">var</span><span class="hl-1"> </span><span class="hl-0">test</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponent</span><span class="hl-1">(</span><span class="hl-9">"Test"</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-parameters">
|
||||
@@ -662,7 +662,7 @@ You can also get component in the node by passing in the name of the script.</p>
|
||||
|
||||
<h3>Zh</h3><p>递归查找所有子节点中第一个匹配指定类型的组件。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">Sprite</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-10">sprite</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponentInChildren</span><span class="hl-1">(</span><span class="hl-0">Sprite</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">Sprite</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-8">sprite</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponentInChildren</span><span class="hl-1">(</span><span class="hl-0">Sprite</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-type-parameters">
|
||||
@@ -690,7 +690,7 @@ You can also get component in the node by passing in the name of the script.</p>
|
||||
|
||||
<h3>Zh</h3><p>递归查找所有子节点中第一个匹配指定类型的组件。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-0">Test</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponentInChildren</span><span class="hl-1">(</span><span class="hl-6">"Test"</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-6">var</span><span class="hl-1"> </span><span class="hl-0">Test</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponentInChildren</span><span class="hl-1">(</span><span class="hl-9">"Test"</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-parameters">
|
||||
@@ -714,7 +714,7 @@ You can also get component in the node by passing in the name of the script.</p>
|
||||
|
||||
<h3>Zh</h3><p>返回节点上指定类型的所有组件。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">Sprite</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-10">sprites</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponents</span><span class="hl-1">(</span><span class="hl-0">Sprite</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">Sprite</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-8">sprites</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponents</span><span class="hl-1">(</span><span class="hl-0">Sprite</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-type-parameters">
|
||||
@@ -742,7 +742,7 @@ You can also get component in the node by passing in the name of the script.</p>
|
||||
|
||||
<h3>Zh</h3><p>返回节点上指定类型的所有组件。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-10">tests</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponents</span><span class="hl-1">(</span><span class="hl-6">"Test"</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-8">tests</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponents</span><span class="hl-1">(</span><span class="hl-9">"Test"</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-parameters">
|
||||
@@ -766,7 +766,7 @@ You can also get component in the node by passing in the name of the script.</p>
|
||||
|
||||
<h3>Zh</h3><p>递归查找自身或所有子节点中指定类型的组件。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">Sprite</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-10">sprites</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponentsInChildren</span><span class="hl-1">(</span><span class="hl-0">Sprite</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">Sprite</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-8">sprites</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponentsInChildren</span><span class="hl-1">(</span><span class="hl-0">Sprite</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-type-parameters">
|
||||
@@ -794,7 +794,7 @@ You can also get component in the node by passing in the name of the script.</p>
|
||||
|
||||
<h3>Zh</h3><p>递归查找自身或所有子节点中指定类型的组件。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-10">tests</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponentsInChildren</span><span class="hl-1">(</span><span class="hl-6">"Test"</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-8">tests</span><span class="hl-1"> = </span><span class="hl-0">node</span><span class="hl-1">.</span><span class="hl-7">getComponentsInChildren</span><span class="hl-1">(</span><span class="hl-9">"Test"</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-parameters">
|
||||
@@ -1017,7 +1017,7 @@ If the task is already scheduled, then the interval parameter will be updated wi
|
||||
<h3>Zh</h3><p>使用定时器系统调度一个自定义的回调任务。<br/>
|
||||
如果回调任务已调度，那么将不会重复调度它，只会更新时间间隔参数。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-7">schedule</span><span class="hl-1">((</span><span class="hl-0">dt</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> </span><span class="hl-8">void</span><span class="hl-1"> </span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-6">`time: </span><span class="hl-8">${</span><span class="hl-0">dt</span><span class="hl-8">}</span><span class="hl-6">`</span><span class="hl-1">), </span><span class="hl-9">1</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-7">schedule</span><span class="hl-1">((</span><span class="hl-0">dt</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> </span><span class="hl-6">void</span><span class="hl-1"> </span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-9">`time: </span><span class="hl-6">${</span><span class="hl-0">dt</span><span class="hl-6">}</span><span class="hl-9">`</span><span class="hl-1">), </span><span class="hl-10">1</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-parameters">
|
||||
@@ -1057,7 +1057,7 @@ If the task is already scheduled, then the interval parameter will be updated wi
|
||||
|
||||
<h3>See</h3><p><a href="DelegateComponent.html#schedule">schedule</a></p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-6">'cc'</span><span class="hl-1">;</span><br/><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-7">scheduleOnce</span><span class="hl-1">((</span><span class="hl-0">dt</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> </span><span class="hl-8">void</span><span class="hl-1"> </span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-6">`time: </span><span class="hl-8">${</span><span class="hl-0">dt</span><span class="hl-8">}</span><span class="hl-6">`</span><span class="hl-1">), </span><span class="hl-9">2</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">import</span><span class="hl-1"> { </span><span class="hl-0">log</span><span class="hl-1"> } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-9">'cc'</span><span class="hl-1">;</span><br/><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-7">scheduleOnce</span><span class="hl-1">((</span><span class="hl-0">dt</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> </span><span class="hl-6">void</span><span class="hl-1"> </span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-9">`time: </span><span class="hl-6">${</span><span class="hl-0">dt</span><span class="hl-6">}</span><span class="hl-9">`</span><span class="hl-1">), </span><span class="hl-10">2</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-parameters">
|
||||
@@ -1103,7 +1103,7 @@ You can only call its super class method inside it. It should not be called manu
|
||||
|
||||
<h3>Zh</h3><p>取消调度一个自定义的回调任务。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-7">unschedule</span><span class="hl-1">(</span><span class="hl-0">_callback</span><span class="hl-1">);</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-7">unschedule</span><span class="hl-1">(</span><span class="hl-0">_callback</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-parameters">
|
||||
@@ -1127,7 +1127,7 @@ You can only call its super class method inside it. It should not be called manu
|
||||
|
||||
<h3>Zh</h3><p>取消调度所有已调度的回调函数。</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-7">unscheduleAllCallbacks</span><span class="hl-1">();</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-7">unscheduleAllCallbacks</span><span class="hl-1">();</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||||
@@ -1187,7 +1187,8 @@ You can only call its super class method inside it. It should not be called manu
|
||||
<div class="tsd-accordion-details">
|
||||
<ul>
|
||||
<li><a href="../modules.html">oops-<wbr/>framework</a>
|
||||
<ul></ul></li></ul></div></details></nav>
|
||||
<ul>
|
||||
<li class="tsd-kind-namespace"><a href="../modules/ecs.html">ecs</a></li></ul></li></ul></div></details></nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul>
|
||||
<li class="current tsd-kind-class"><a href="DelegateComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Delegate<wbr/>Component</span></a>
|
||||
|
||||
Reference in New Issue
Block a user