scrawl-canvas
Version:
Version 8.9.4 - 19 Nov 2022
992 lines (635 loc) • 40 kB
HTML
<html>
<head>
<title>Action factory</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<link rel="stylesheet" media="all" href="../../docco.css" />
</head>
<body>
<div id="container">
<div id="background"></div>
<ul id="jump_to">
<li>
<a class="large" href="javascript:void(0);">Jump To …</a>
<a class="small" href="javascript:void(0);">+</a>
<div id="jump_wrapper">
<div id="jump_page_wrapper">
<div id="jump_page">
<a class="source" href="../core/animationloop.html">
./source/core/animationloop.js
</a>
<a class="source" href="../core/document.html">
./source/core/document.js
</a>
<a class="source" href="../core/events.html">
./source/core/events.js
</a>
<a class="source" href="../core/init.html">
./source/core/init.js
</a>
<a class="source" href="../core/library.html">
./source/core/library.js
</a>
<a class="source" href="../core/random-seed.html">
./source/core/random-seed.js
</a>
<a class="source" href="../core/snippets.html">
./source/core/snippets.js
</a>
<a class="source" href="../core/userInteraction.html">
./source/core/userInteraction.js
</a>
<a class="source" href="../core/utilities.html">
./source/core/utilities.js
</a>
<a class="source" href="action.html">
./source/factory/action.js
</a>
<a class="source" href="anchor.html">
./source/factory/anchor.js
</a>
<a class="source" href="animation.html">
./source/factory/animation.js
</a>
<a class="source" href="bezier.html">
./source/factory/bezier.js
</a>
<a class="source" href="block.html">
./source/factory/block.js
</a>
<a class="source" href="canvas.html">
./source/factory/canvas.js
</a>
<a class="source" href="cell.html">
./source/factory/cell.js
</a>
<a class="source" href="cog.html">
./source/factory/cog.js
</a>
<a class="source" href="color.html">
./source/factory/color.js
</a>
<a class="source" href="conicGradient.html">
./source/factory/conicGradient.js
</a>
<a class="source" href="coordinate.html">
./source/factory/coordinate.js
</a>
<a class="source" href="crescent.html">
./source/factory/crescent.js
</a>
<a class="source" href="element.html">
./source/factory/element.js
</a>
<a class="source" href="emitter.html">
./source/factory/emitter.js
</a>
<a class="source" href="filter.html">
./source/factory/filter.js
</a>
<a class="source" href="filterEngine-bluenoiseData.html">
./source/factory/filterEngine-bluenoiseData.js
</a>
<a class="source" href="filterEngine.html">
./source/factory/filterEngine.js
</a>
<a class="source" href="fontAttributes.html">
./source/factory/fontAttributes.js
</a>
<a class="source" href="gradient.html">
./source/factory/gradient.js
</a>
<a class="source" href="grid.html">
./source/factory/grid.js
</a>
<a class="source" href="group.html">
./source/factory/group.js
</a>
<a class="source" href="imageAsset.html">
./source/factory/imageAsset.js
</a>
<a class="source" href="line.html">
./source/factory/line.js
</a>
<a class="source" href="lineSpiral.html">
./source/factory/lineSpiral.js
</a>
<a class="source" href="loom.html">
./source/factory/loom.js
</a>
<a class="source" href="mesh.html">
./source/factory/mesh.js
</a>
<a class="source" href="net.html">
./source/factory/net.js
</a>
<a class="source" href="noiseAsset.html">
./source/factory/noiseAsset.js
</a>
<a class="source" href="oval.html">
./source/factory/oval.js
</a>
<a class="source" href="palette.html">
./source/factory/palette.js
</a>
<a class="source" href="particle.html">
./source/factory/particle.js
</a>
<a class="source" href="particleForce.html">
./source/factory/particleForce.js
</a>
<a class="source" href="particleHistory.html">
./source/factory/particleHistory.js
</a>
<a class="source" href="particleSpring.html">
./source/factory/particleSpring.js
</a>
<a class="source" href="particleWorld.html">
./source/factory/particleWorld.js
</a>
<a class="source" href="pattern.html">
./source/factory/pattern.js
</a>
<a class="source" href="phrase.html">
./source/factory/phrase.js
</a>
<a class="source" href="picture.html">
./source/factory/picture.js
</a>
<a class="source" href="polygon.html">
./source/factory/polygon.js
</a>
<a class="source" href="polyline.html">
./source/factory/polyline.js
</a>
<a class="source" href="quadratic.html">
./source/factory/quadratic.js
</a>
<a class="source" href="quaternion.html">
./source/factory/quaternion.js
</a>
<a class="source" href="radialGradient.html">
./source/factory/radialGradient.js
</a>
<a class="source" href="rawAsset.html">
./source/factory/rawAsset.js
</a>
<a class="source" href="rdAsset.html">
./source/factory/rdAsset.js
</a>
<a class="source" href="rectangle.html">
./source/factory/rectangle.js
</a>
<a class="source" href="renderAnimation.html">
./source/factory/renderAnimation.js
</a>
<a class="source" href="shape.html">
./source/factory/shape.js
</a>
<a class="source" href="spiral.html">
./source/factory/spiral.js
</a>
<a class="source" href="spriteAsset.html">
./source/factory/spriteAsset.js
</a>
<a class="source" href="stack.html">
./source/factory/stack.js
</a>
<a class="source" href="star.html">
./source/factory/star.js
</a>
<a class="source" href="state.html">
./source/factory/state.js
</a>
<a class="source" href="tetragon.html">
./source/factory/tetragon.js
</a>
<a class="source" href="ticker.html">
./source/factory/ticker.js
</a>
<a class="source" href="tracer.html">
./source/factory/tracer.js
</a>
<a class="source" href="tween.html">
./source/factory/tween.js
</a>
<a class="source" href="unstackedElement.html">
./source/factory/unstackedElement.js
</a>
<a class="source" href="vector.html">
./source/factory/vector.js
</a>
<a class="source" href="videoAsset.html">
./source/factory/videoAsset.js
</a>
<a class="source" href="wheel.html">
./source/factory/wheel.js
</a>
<a class="source" href="../mixin/anchor.html">
./source/mixin/anchor.js
</a>
<a class="source" href="../mixin/asset.html">
./source/mixin/asset.js
</a>
<a class="source" href="../mixin/assetAdvancedFunctionality.html">
./source/mixin/assetAdvancedFunctionality.js
</a>
<a class="source" href="../mixin/assetConsumer.html">
./source/mixin/assetConsumer.js
</a>
<a class="source" href="../mixin/base.html">
./source/mixin/base.js
</a>
<a class="source" href="../mixin/cascade.html">
./source/mixin/cascade.js
</a>
<a class="source" href="../mixin/delta.html">
./source/mixin/delta.js
</a>
<a class="source" href="../mixin/displayShape.html">
./source/mixin/displayShape.js
</a>
<a class="source" href="../mixin/dom.html">
./source/mixin/dom.js
</a>
<a class="source" href="../mixin/entity.html">
./source/mixin/entity.js
</a>
<a class="source" href="../mixin/filter.html">
./source/mixin/filter.js
</a>
<a class="source" href="../mixin/mimic.html">
./source/mixin/mimic.js
</a>
<a class="source" href="../mixin/path.html">
./source/mixin/path.js
</a>
<a class="source" href="../mixin/pattern.html">
./source/mixin/pattern.js
</a>
<a class="source" href="../mixin/pivot.html">
./source/mixin/pivot.js
</a>
<a class="source" href="../mixin/position.html">
./source/mixin/position.js
</a>
<a class="source" href="../mixin/shapeBasic.html">
./source/mixin/shapeBasic.js
</a>
<a class="source" href="../mixin/shapeCurve.html">
./source/mixin/shapeCurve.js
</a>
<a class="source" href="../mixin/shapePathCalculation.html">
./source/mixin/shapePathCalculation.js
</a>
<a class="source" href="../mixin/styles.html">
./source/mixin/styles.js
</a>
<a class="source" href="../mixin/tween.html">
./source/mixin/tween.js
</a>
</div>
</div>
</li>
</ul>
<ul class="sections">
<li id="section-1">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-1">§</a>
</div>
<h1 id="action-factory">Action factory</h1>
<p>Actions are (reversible) functions added to a Scrawl-canvas <a href="./ticker.html">Ticker</a> timeline. They trigger as the ticker passes through the point (along the ticker’s timeline):</p>
<ul>
<li>if the timeline is moving forwards the <strong>action</strong> function will be invoked</li>
<li>if the timeline is moving backwards the <strong>revert</strong> function will be invoked</li>
</ul>
</div>
</li>
<li id="section-2">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-2">§</a>
</div>
<p>TODO: basic packet and kill functionality tested in Demo DOM-004, but there’s a lot of Ticker/Tween/Action functionality that needs to be explored and tested further (see <a href="./ticker.html#section-2">Ticker TODO section</a> for issues and suggested work).</p>
</div>
</li>
<li id="section-3">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-3">§</a>
</div>
<h4 id="demos">Demos:</h4>
<ul>
<li><a href="../../demo/dom-006.html">DOM-006</a>- Tween actions on a DOM element; tracking tween and ticker activity (analytics)</li>
</ul>
</div>
</li>
<li id="section-4">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-4">§</a>
</div>
<h4 id="imports">Imports</h4>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">import</span> { constructors } <span class="hljs-keyword">from</span> <span class="hljs-string">'../core/library.js'</span>;
<span class="hljs-keyword">import</span> { mergeOver, pushUnique, xt, λ<span class="hljs-literal">null</span>, Ωempty } <span class="hljs-keyword">from</span> <span class="hljs-string">'../core/utilities.js'</span>;
<span class="hljs-keyword">import</span> baseMix <span class="hljs-keyword">from</span> <span class="hljs-string">'../mixin/base.js'</span>;
<span class="hljs-keyword">import</span> tweenMix <span class="hljs-keyword">from</span> <span class="hljs-string">'../mixin/tween.js'</span>;</pre></div></div>
</li>
<li id="section-5">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-5">§</a>
</div>
<h4 id="action-constructor">Action constructor</h4>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">const</span> <span class="hljs-title class_">Action</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">items = Ωempty</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">makeName</span>(items.<span class="hljs-property">name</span>);
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">register</span>();
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">set</span>(<span class="hljs-variable language_">this</span>.<span class="hljs-property">defs</span>);
<span class="hljs-variable language_">this</span>.<span class="hljs-property">action</span> = λ<span class="hljs-literal">null</span>;
<span class="hljs-variable language_">this</span>.<span class="hljs-property">revert</span> = λ<span class="hljs-literal">null</span>;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">set</span>(items);
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">calculateEffectiveTime</span>();
<span class="hljs-keyword">if</span> (<span class="hljs-title function_">xt</span>(items.<span class="hljs-property">ticker</span>)) <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">addToTicker</span>(items.<span class="hljs-property">ticker</span>);
<span class="hljs-keyword">return</span> <span class="hljs-variable language_">this</span>;
};</pre></div></div>
</li>
<li id="section-6">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-6">§</a>
</div>
<h4 id="action-prototype">Action prototype</h4>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">let</span> P = <span class="hljs-title class_">Action</span>.<span class="hljs-property"><span class="hljs-keyword">prototype</span></span> = <span class="hljs-title class_">Object</span>.<span class="hljs-title function_">create</span>(<span class="hljs-title class_">Object</span>.<span class="hljs-property"><span class="hljs-keyword">prototype</span></span>);
P.<span class="hljs-property">type</span> = <span class="hljs-string">'Action'</span>;
P.<span class="hljs-property">lib</span> = <span class="hljs-string">'tween'</span>;
P.<span class="hljs-property">isArtefact</span> = <span class="hljs-literal">false</span>;
P.<span class="hljs-property">isAsset</span> = <span class="hljs-literal">false</span>;</pre></div></div>
</li>
<li id="section-7">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-7">§</a>
</div>
<h4 id="mixins">Mixins</h4>
</div>
<div class="content"><div class='highlight'><pre>P = <span class="hljs-title function_">baseMix</span>(P);
P = <span class="hljs-title function_">tweenMix</span>(P);</pre></div></div>
</li>
<li id="section-8">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-8">§</a>
</div>
<h4 id="action-attributes">Action attributes</h4>
<ul>
<li>Attributes defined in the <a href="../mixin/base.html">base mixin</a>: <strong>name</strong>.</li>
<li>Attributes defined in the <a href="../mixin/tween.html">tween mixin</a>: <strong>order</strong>, <strong>ticker</strong>, <strong>targets</strong>, <strong>time</strong>, <strong>action</strong>, <strong>reverseOnCycleEnd</strong>, <strong>reversed</strong>.</li>
</ul>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">let</span> defaultAttributes = {</pre></div></div>
</li>
<li id="section-9">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-9">§</a>
</div>
<p><strong>revert</strong> - a function that is triggered when a tween is running in reverse direction. Should be a counterpart to the <strong>action</strong> function (defined in mixin/tween.js) to reverse the actions performed by that function.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="hljs-attr">revert</span>: <span class="hljs-literal">null</span>
};
P.<span class="hljs-property">defs</span> = <span class="hljs-title function_">mergeOver</span>(P.<span class="hljs-property">defs</span>, defaultAttributes);</pre></div></div>
</li>
<li id="section-10">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-10">§</a>
</div>
<h4 id="packet-management">Packet management</h4>
</div>
<div class="content"><div class='highlight'><pre>P.<span class="hljs-property">packetExclusions</span> = <span class="hljs-title function_">pushUnique</span>(P.<span class="hljs-property">packetExclusions</span>, [<span class="hljs-string">'targets'</span>]);
P.<span class="hljs-property">packetFunctions</span> = <span class="hljs-title function_">pushUnique</span>(P.<span class="hljs-property">packetFunctions</span>, [<span class="hljs-string">'revert'</span>, <span class="hljs-string">'action'</span>]);
P.<span class="hljs-property">finalizePacketOut</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">copy, items</span>) {
<span class="hljs-keyword">if</span> (<span class="hljs-title class_">Array</span>.<span class="hljs-title function_">isArray</span>(<span class="hljs-variable language_">this</span>.<span class="hljs-property">targets</span>)) copy.<span class="hljs-property">targets</span> = <span class="hljs-variable language_">this</span>.<span class="hljs-property">targets</span>.<span class="hljs-title function_">map</span>(<span class="hljs-function"><span class="hljs-params">t</span> =></span> t.<span class="hljs-property">name</span>);
<span class="hljs-keyword">return</span> copy;
};</pre></div></div>
</li>
<li id="section-11">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-11">§</a>
</div>
<h4 id="clone-management">Clone management</h4>
<p>No additional clone functionality required</p>
</div>
</li>
<li id="section-12">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-12">§</a>
</div>
<h4 id="kill-management">Kill management</h4>
<p>No additional kill functionality required</p>
</div>
</li>
<li id="section-13">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-13">§</a>
</div>
<h4 id="get-set-deltaset">Get, Set, deltaSet</h4>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">let</span> S = P.<span class="hljs-property">setters</span>;</pre></div></div>
</li>
<li id="section-14">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-14">§</a>
</div>
<p>Argument must be a function, or a variable holding a reference to a function</p>
</div>
<div class="content"><div class='highlight'><pre>S.<span class="hljs-property">revert</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">revert</span> = item;
<span class="hljs-keyword">if</span> (<span class="hljs-keyword">typeof</span> <span class="hljs-variable language_">this</span>.<span class="hljs-property">revert</span> !== <span class="hljs-string">'function'</span>) <span class="hljs-variable language_">this</span>.<span class="hljs-property">revert</span> = λ<span class="hljs-literal">null</span>;
};</pre></div></div>
</li>
<li id="section-15">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-15">§</a>
</div>
<p>Internal attribute. Set true after the ticker moves past the instance’s time value (and set false if the ticker is moving backwards)</p>
</div>
<div class="content"><div class='highlight'><pre>S.<span class="hljs-property">triggered</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-keyword">if</span> (<span class="hljs-variable language_">this</span>.<span class="hljs-property">triggered</span> !== item) {
<span class="hljs-keyword">if</span> (item) <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">action</span>();
<span class="hljs-keyword">else</span> <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">revert</span>();
<span class="hljs-variable language_">this</span>.<span class="hljs-property">triggered</span> = item;
}
};</pre></div></div>
</li>
<li id="section-16">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-16">§</a>
</div>
<p><code>set</code> - we perform some additional functionality in the Action <code>set</code> function</p>
<ul>
<li>updating the Action’s Ticker object happens here</li>
<li>recalculating effectiveDuration happens here if the <strong>time</strong> value change</li>
</ul>
</div>
<div class="content"><div class='highlight'><pre>P.<span class="hljs-property">set</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">items = Ωempty</span>) {
<span class="hljs-keyword">const</span> keys = <span class="hljs-title class_">Object</span>.<span class="hljs-title function_">keys</span>(items),
keysLen = keys.<span class="hljs-property">length</span>;
<span class="hljs-keyword">if</span> (keysLen) {
<span class="hljs-keyword">const</span> setters = <span class="hljs-variable language_">this</span>.<span class="hljs-property">setters</span>,
defs = <span class="hljs-variable language_">this</span>.<span class="hljs-property">defs</span>;
<span class="hljs-keyword">let</span> predefined, i, iz, key, value;
<span class="hljs-keyword">for</span> (i = <span class="hljs-number">0</span>; i < keysLen; i++) {
key = keys[i];
value = items[key];
<span class="hljs-keyword">if</span> (key && key !== <span class="hljs-string">'name'</span> && value != <span class="hljs-literal">null</span>) {
predefined = setters[key];
<span class="hljs-keyword">if</span> (predefined) predefined.<span class="hljs-title function_">call</span>(<span class="hljs-variable language_">this</span>, value);
<span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span> (<span class="hljs-keyword">typeof</span> defs[key] !== <span class="hljs-string">'undefined'</span>) <span class="hljs-variable language_">this</span>[key] = value;
}
}
<span class="hljs-keyword">let</span> ticker = (<span class="hljs-title function_">xt</span>(items.<span class="hljs-property">ticker</span>)) ? <span class="hljs-variable language_">this</span>.<span class="hljs-property">ticker</span> : <span class="hljs-literal">false</span>;
<span class="hljs-keyword">if</span> (ticker) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">ticker</span> = ticker;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">addToTicker</span>(items.<span class="hljs-property">ticker</span>);
}
<span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span> (<span class="hljs-title function_">xt</span>(items.<span class="hljs-property">time</span>)) <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">calculateEffectiveTime</span>();
}
<span class="hljs-keyword">return</span> <span class="hljs-variable language_">this</span>;
};</pre></div></div>
</li>
<li id="section-17">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-17">§</a>
</div>
<h4 id="animation">Animation</h4>
</div>
</li>
<li id="section-18">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-18">§</a>
</div>
<p><code>getEndTime</code> - Ticker-related help function</p>
</div>
<div class="content"><div class='highlight'><pre>P.<span class="hljs-property">getEndTime</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params"></span>) {
<span class="hljs-keyword">return</span> <span class="hljs-variable language_">this</span>.<span class="hljs-property">effectiveTime</span>;
};</pre></div></div>
</li>
<li id="section-19">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-19">§</a>
</div>
<p><code>update</code> - check to see if the action (or revert) functions need to be invoked, and invokes them as-and-when required.</p>
<p>TODO: 0% times will fire the action function when the ticker is moving both forwards and backwards, but never fires the revert function. All other %times appear to work as expected.</p>
</div>
<div class="content"><div class='highlight'><pre>P.<span class="hljs-property">update</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">items</span>) {
<span class="hljs-keyword">let</span> reversed = <span class="hljs-variable language_">this</span>.<span class="hljs-property">reversed</span>,
effectiveTime = <span class="hljs-variable language_">this</span>.<span class="hljs-property">effectiveTime</span>,
triggered = <span class="hljs-variable language_">this</span>.<span class="hljs-property">triggered</span>,
reverseOnCycleEnd = <span class="hljs-variable language_">this</span>.<span class="hljs-property">reverseOnCycleEnd</span>,
tick = items.<span class="hljs-property">tick</span>,
reverseTick = items.<span class="hljs-property">reverseTick</span>,
willLoop = items.<span class="hljs-property">willLoop</span>,
next = items.<span class="hljs-property">next</span>;
<span class="hljs-keyword">if</span> (reversed) {
<span class="hljs-keyword">if</span> (reverseTick >= effectiveTime) {
<span class="hljs-keyword">if</span> (!triggered) {
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">action</span>();
<span class="hljs-variable language_">this</span>.<span class="hljs-property">triggered</span> = <span class="hljs-literal">true</span>;
}
}
<span class="hljs-keyword">else</span> {
<span class="hljs-keyword">if</span> (triggered) {
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">revert</span>();
<span class="hljs-variable language_">this</span>.<span class="hljs-property">triggered</span> = <span class="hljs-literal">false</span>;
}
}
}
<span class="hljs-keyword">else</span> {
<span class="hljs-keyword">if</span> (tick >= effectiveTime) {
<span class="hljs-keyword">if</span> (!triggered) {
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">action</span>();
<span class="hljs-variable language_">this</span>.<span class="hljs-property">triggered</span> = <span class="hljs-literal">true</span>;
}
}
<span class="hljs-keyword">else</span> {
<span class="hljs-keyword">if</span> (triggered) {
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">revert</span>();
<span class="hljs-variable language_">this</span>.<span class="hljs-property">triggered</span> = <span class="hljs-literal">false</span>;
}
}
}
<span class="hljs-keyword">if</span> (willLoop) <span class="hljs-variable language_">this</span>.<span class="hljs-property">triggered</span> = !<span class="hljs-variable language_">this</span>.<span class="hljs-property">triggered</span>;
<span class="hljs-keyword">return</span> <span class="hljs-literal">true</span>;
};</pre></div></div>
</li>
<li id="section-20">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-20">§</a>
</div>
<h4 id="factory">Factory</h4>
<pre><code><span class="hljs-keyword">let</span> myaction = scrawl.<span class="hljs-title function_">makeAction</span>({
<span class="hljs-comment">// Unique name (can be computer generated)</span>
<span class="hljs-attr">name</span>: <span class="hljs-string">'red'</span>,
<span class="hljs-comment">// Scrawl-canvas ticker object, or its name String</span>
<span class="hljs-attr">ticker</span>: tickerObject,
<span class="hljs-comment">// Any Scrawl-canvas object that can be actioned</span>
<span class="hljs-comment">// - or that object's name String</span>
<span class="hljs-comment">// - or a (mixed) array of targets</span>
<span class="hljs-attr">targets</span>: scrawlCanvasObject,
<span class="hljs-comment">// String% distance from ticker start, or a similar time value</span>
<span class="hljs-attr">time</span>: <span class="hljs-string">'6.25%'</span>,
<span class="hljs-comment">// 'action' and 'revert' functions, to be applied to targets</span>
<span class="hljs-attr">action</span>: <span class="hljs-keyword">function</span> (<span class="hljs-params"></span>) {
element.<span class="hljs-title function_">set</span>({
<span class="hljs-attr">css</span>: {
<span class="hljs-attr">backgroundColor</span>: <span class="hljs-string">'red'</span>,
},
});
},
<span class="hljs-attr">revert</span>: <span class="hljs-keyword">function</span> (<span class="hljs-params"></span>) {
element.<span class="hljs-title function_">set</span>({
<span class="hljs-attr">css</span>: {
<span class="hljs-attr">backgroundColor</span>: <span class="hljs-string">'blue'</span>,
},
});
},
});
</code></pre>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">const</span> makeAction = <span class="hljs-keyword">function</span> (<span class="hljs-params">items</span>) {
<span class="hljs-keyword">if</span> (!items) <span class="hljs-keyword">return</span> <span class="hljs-literal">false</span>;
<span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">Action</span>(items);
};
constructors.<span class="hljs-property">Action</span> = <span class="hljs-title class_">Action</span>;</pre></div></div>
</li>
<li id="section-21">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-21">§</a>
</div>
<h4 id="exports">Exports</h4>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">export</span> {
makeAction,
};</pre></div></div>
</li>
</ul>
</div>
</body>
</html>