Skip to content

Commit

Permalink
document node:update() method
Browse files Browse the repository at this point in the history
  • Loading branch information
ianmaclarty committed Nov 12, 2018
1 parent c99436d commit eb3aecd
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,7 @@
<li><a href="#node:action">node:action([id,] action)</a></li>
<li><a href="#node:late_action">node:late_action([id,] action)</a></li>
<li><a href="#node:cancel">node:cancel(id)</a></li>
<li><a href="#node:update">node:update()</a></li>
<li><a href="#nodeappendchild">node:append(child)</a></li>
<li><a href="#nodeprependchild">node:prepend(child)</a></li>
<li><a href="#noderemovechild">node:remove(child)</a></li>
Expand Down Expand Up @@ -1953,6 +1954,9 @@ <h3 id="node:late_action" class="method-def">node:late_action([id,] action)</h3>
<p>See also <a href="#node:action">node:action</a>.</p>
<h3 id="node:cancel" class="method-def">node:cancel(id)</h3>
<p>Cancels an action.</p>
<h3 id="node:update" class="method-def">node:update()</h3>
<p>Executes actions on a node and its descendents. Actions are still only run once per frame, so if the give node's actions have already been run, they won't run again.</p>
<p>Use this method to execute actions on nodes that are not attached to the window, for example nodes that are being manually rendered into a framebuffer.</p>
<h3 id="nodeappendchild" class="func-def">node:append(child)</h3>
<p>Appends <code>child</code> to the end of <code>node</code>'s child list and returns <code>node</code>.</p>
<h3 id="nodeprependchild" class="func-def">node:prepend(child)</h3>
Expand Down
9 changes: 9 additions & 0 deletions doc/scene_nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,15 @@ See also [node:action](#node:action).

Cancels an action.

### node:update() {#node:update .method-def}

Executes actions on a node and its descendents. Actions are still only run
once per frame, so if the give node's actions have already been run, they
won't run again.

Use this method to execute actions on nodes that are not attached to the window,
for example nodes that are being manually rendered into a framebuffer.

### node:append(child) {.func-def}

Appends `child` to the end of `node`'s child list and returns `node`.
Expand Down

0 comments on commit eb3aecd

Please sign in to comment.