Skip to content

Commit

Permalink
Update description
Browse files Browse the repository at this point in the history
  • Loading branch information
rexrainbow committed Nov 17, 2023
1 parent 6693400 commit 6c7c2e1
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 15 deletions.
15 changes: 8 additions & 7 deletions docs/docs/timeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,6 @@ Schedule commands to happen at specific times in the future, built-in object of

### Create timeline

Steps

1. Test time (`at`, `in`, `from`)
1. Test enable (`if`)
1. Run actions (`set`, `tween`, `run`, `sound`, `event`)
1. Control (`once`, `stop`)

```javascript
var timeline = scene.add.timeline([
{
Expand Down Expand Up @@ -99,6 +92,14 @@ var timeline = scene.add.timeline([

The Timeline always starts paused.

### Steps of commands

For each tick, for each command :

1. Test time (`at`, `in`, `from`)
1. Test enable (`if`)
1. Run actions (`set`, `tween`, `run`, `sound`, `event`)
1. Control (`once`, `stop`)

### Start

Expand Down
2 changes: 1 addition & 1 deletion docs/site/search/search_index.json

Large diffs are not rendered by default.

Binary file modified docs/site/sitemap.xml.gz
Binary file not shown.
29 changes: 22 additions & 7 deletions docs/site/timeline/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7609,6 +7609,13 @@
Create timeline
</a>

</li>

<li class="md-nav__item">
<a href="#steps-of-commands" class="md-nav__link">
Steps of commands
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -9545,6 +9552,13 @@
Create timeline
</a>

</li>

<li class="md-nav__item">
<a href="#steps-of-commands" class="md-nav__link">
Steps of commands
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -9635,13 +9649,6 @@ <h2 id="introduction">Introduction<a class="headerlink" href="#introduction" tit
</ul>
<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h2>
<h3 id="create-timeline">Create timeline<a class="headerlink" href="#create-timeline" title="Permanent link">&para;</a></h3>
<p>Steps </p>
<ol>
<li>Test time (<code>at</code>, <code>in</code>, <code>from</code>)</li>
<li>Test enable (<code>if</code>)</li>
<li>Run actions (<code>set</code>, <code>tween</code>, <code>run</code>, <code>sound</code>, <code>event</code>)</li>
<li>Control (<code>once</code>, <code>stop</code>)</li>
</ol>
<div class="highlight"><pre><span></span><code><span class="kd">var</span><span class="w"> </span><span class="nx">timeline</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">scene</span><span class="p">.</span><span class="nx">add</span><span class="p">.</span><span class="nx">timeline</span><span class="p">([</span><span class="w"> </span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="c1">// Time condition</span>
Expand Down Expand Up @@ -9732,6 +9739,14 @@ <h3 id="create-timeline">Create timeline<a class="headerlink" href="#create-time
</li>
</ul>
<p>The Timeline always starts paused.</p>
<h3 id="steps-of-commands">Steps of commands<a class="headerlink" href="#steps-of-commands" title="Permanent link">&para;</a></h3>
<p>For each tick, for each command :</p>
<ol>
<li>Test time (<code>at</code>, <code>in</code>, <code>from</code>)</li>
<li>Test enable (<code>if</code>)</li>
<li>Run actions (<code>set</code>, <code>tween</code>, <code>run</code>, <code>sound</code>, <code>event</code>)</li>
<li>Control (<code>once</code>, <code>stop</code>)</li>
</ol>
<h3 id="start">Start<a class="headerlink" href="#start" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><span class="nx">timeline</span><span class="p">.</span><span class="nx">play</span><span class="p">();</span>
</code></pre></div>
Expand Down

0 comments on commit 6c7c2e1

Please sign in to comment.