Wick.Project.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: Project</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: Project</h1>

    
<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>
            <span class="ancestors"><a href="global.html#Wick">Wick</a>.</span>Project<span class="signature">(name, width, height, framerate, backgroundColor)</span><span class="type-signature"></span></h2>
        
            <div class="class-description">Class representing a Wick Project.</div>
        
    
</header>

<article>
    <div class="container-overview">
    
        
    <h2>Constructor</h2>
    

    <h4 class="name" id="Project"><span class="type-signature"></span>new Project<span class="signature">(name, width, height, framerate, backgroundColor)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Create a project.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Project name. Default "My Project".</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">Project width in pixels. Default 720.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">Project height in pixels. Default 405.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>framerate</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">Project framerate in frames-per-second. Default 12.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>backgroundColor</code></td>
            

            <td class="type">
            
                
<span class="param-type">Color</span>


            </td>

            
            <td class="description last">Project background color in hex. Default #ffffff.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line32">line 32</a>
    </li></ul></dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id="activeFrame"><span class="type-signature"></span>activeFrame<span class="type-signature"> :<a href="Wick.Frame.html">Wick.Frame</a></span></h4>


<div class="description">
    The active frame of the active layer.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Wick.Frame.html">Wick.Frame</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line268">line 268</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="activeFrames"><span class="type-signature"></span>activeFrames<span class="type-signature"> :Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>></span></h4>


<div class="description">
    The active frames of the active timeline.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line276">line 276</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="activeLayer"><span class="type-signature"></span>activeLayer<span class="type-signature"> :<a href="Wick.Layer.html">Wick.Layer</a></span></h4>


<div class="description">
    The active layer of the active timeline.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Wick.Layer.html">Wick.Layer</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line260">line 260</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="activeTimeline"><span class="type-signature"></span>activeTimeline<span class="type-signature"> :<a href="Wick.Timeline.html">Wick.Timeline</a></span></h4>


<div class="description">
    The timeline of the active clip.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Wick.Timeline.html">Wick.Timeline</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line252">line 252</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="activeTool"><span class="type-signature"></span>activeTool<span class="type-signature"> :<a href="Wick.Tool.html">Wick.Tool</a></span></h4>


<div class="description">
    The currently activated tool.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Wick.Tool.html">Wick.Tool</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1371">line 1371</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="assets"><span class="type-signature"></span>assets<span class="type-signature"> :Array.&lt;<a href="Wick.Asset.html">Wick.Asset</a>></span></h4>


<div class="description">
    The assets belonging to the project.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;<a href="Wick.Asset.html">Wick.Asset</a>></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line345">line 345</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="backgroundColor"><span class="type-signature"></span>backgroundColor<span class="type-signature"> :string</span></h4>


<div class="description">
    The background color of the project.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line240">line 240</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="canCreateTween"><span class="type-signature"></span>canCreateTween<span class="type-signature"></span></h4>


<div class="description">
    A tween can be created if frames are selected or if there is a frame under the playhead on the active layer.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line762">line 762</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="canDraw"><span class="type-signature"></span>canDraw<span class="type-signature"> :boolean</span></h4>


<div class="description">
    Returns true if there is currently an active frame to draw onto.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1576">line 1576</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="currentKey"><span class="type-signature"></span>currentKey<span class="type-signature"> :Array.&lt;string></span></h4>


<div class="description">
    The key to be used in the global 'key' variable in the scripting API. Update currentKey before you run any key script.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;string></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line569">line 569</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="error"><span class="type-signature"></span>error<span class="type-signature"> :Object</span></h4>


<div class="description">
    The current error, if one was thrown, during the last tick.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1106">line 1106</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="focus"><span class="type-signature"></span>focus<span class="type-signature"> :<a href="Wick.Clip.html">Wick.Clip</a></span></h4>


<div class="description">
    The currently focused clip.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Wick.Clip.html">Wick.Clip</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line451">line 451</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="framerate"><span class="type-signature"></span>framerate<span class="type-signature"> :number</span></h4>


<div class="description">
    The framerate of the project.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line225">line 225</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="height"><span class="type-signature"></span>height<span class="type-signature"> :number</span></h4>


<div class="description">
    The height of the project.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line210">line 210</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="hideCursor"><span class="type-signature"></span>hideCursor<span class="type-signature"> :boolean</span></h4>


<div class="description">
    Whether or not to hide the cursor while project is playing.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1564">line 1564</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="history"><span class="type-signature"></span>history<span class="type-signature"> :<a href="Wick.History.html">Wick.History</a></span></h4>


<div class="description">
    An instance of the Wick.History utility class for undo/redo functionality.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Wick.History.html">Wick.History</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line307">line 307</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="isMouseDown"><span class="type-signature"></span>isMouseDown<span class="type-signature"> :boolean</span></h4>


<div class="description">
    Determine if the mouse is down.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line508">line 508</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="keysDown"><span class="type-signature"></span>keysDown<span class="type-signature"> :Array.&lt;string></span></h4>


<div class="description">
    The keys that are currenty held down.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;string></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line520">line 520</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="keysJustPressed"><span class="type-signature"></span>keysJustPressed<span class="type-signature"> :Array.&lt;string></span></h4>


<div class="description">
    The keys were just pressed (i.e., are currently held down, but were not last tick).
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;string></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line532">line 532</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="keysJustReleased"><span class="type-signature"></span>keysJustReleased<span class="type-signature"></span></h4>


<div class="description">
    The keys that were just released (i.e. were down last tick back are no longer down.)
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line543">line 543</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="mouseMove"><span class="type-signature"></span>mouseMove<span class="type-signature"> :object</span></h4>


<div class="description">
    The amount the mouse has moved in the last tick
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line498">line 498</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="mousePosition"><span class="type-signature"></span>mousePosition<span class="type-signature"> :object</span></h4>


<div class="description">
    The position of the mouse
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line485">line 485</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="muted"><span class="type-signature"></span>muted<span class="type-signature"> :boolean</span></h4>


<div class="description">
    Is the project currently muted?
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1059">line 1059</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="playing"><span class="type-signature"></span>playing<span class="type-signature"> :boolean</span></h4>


<div class="description">
    Checks if the project is currently playing.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1157">line 1157</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="publishedMode"><span class="type-signature"></span>publishedMode<span class="type-signature"> :boolean</span></h4>


<div class="description">
    In "Published Mode", all layers will be rendered even if they are set to be hidden.
This is enabled during GIF/Video export, and enabled when the project is run standalone.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1082">line 1082</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="renderBlackBars"><span class="type-signature"></span>renderBlackBars<span class="type-signature"> :boolean</span></h4>


<div class="description">
    Should the project render black bars around the canvas area?
(These only show up if the size of the window/element that the project
is inside is a different size than the project dimensions).
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1069">line 1069</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="root"><span class="type-signature"></span>root<span class="type-signature"> :<a href="Wick.Clip.html">Wick.Clip</a></span></h4>


<div class="description">
    The root clip.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Wick.Clip.html">Wick.Clip</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line436">line 436</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="selection"><span class="type-signature"></span>selection<span class="type-signature"> :<a href="Wick.Selection.html">Wick.Selection</a></span></h4>


<div class="description">
    The project selection.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Wick.Selection.html">Wick.Selection</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line292">line 292</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="showClipBorders"><span class="type-signature"></span>showClipBorders<span class="type-signature"> :boolean</span></h4>


<div class="description">
    Toggle whether or not to render borders around clips.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1094">line 1094</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="tools"><span class="type-signature"></span>tools<span class="type-signature"> :Array.&lt;<a href="Wick.Tool.html">Wick.Tool</a>></span></h4>


<div class="description">
    All tools belonging to the project.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;<a href="Wick.Tool.html">Wick.Tool</a>></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1355">line 1355</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="toolSettings"><span class="type-signature"></span>toolSettings<span class="type-signature"> :<a href="Wick.ToolSettings.html">Wick.ToolSettings</a></span></h4>


<div class="description">
    The tool settings for the project's tools.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Wick.ToolSettings.html">Wick.ToolSettings</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1363">line 1363</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="width"><span class="type-signature"></span>width<span class="type-signature"> :number</span></h4>


<div class="description">
    The width of the project.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line195">line 195</a>
    </li></ul></dd>
    

</dl>


        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="addAsset"><span class="type-signature"></span>addAsset<span class="signature">(asset)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Adds an asset to the project.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>asset</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Wick.Asset.html">Wick.Asset</a></span>


            </td>

            
            <td class="description last">The asset to add to the project.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line353">line 353</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="addObject"><span class="type-signature"></span>addObject<span class="signature">(object)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Adds an object to the project.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>object</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Wick.Base.html">Wick.Base</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1403">line 1403</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    returns true if the obejct was added successfully, false otherwise.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="breakApartSelection"><span class="type-signature"></span>breakApartSelection<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Breaks selected clips into their children clips and paths.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line961">line 961</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="cleanupUnusedAssets"><span class="type-signature"></span>cleanupUnusedAssets<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Remove assets from the project that are never used.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1605">line 1605</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="copySelectionToClipboard"><span class="type-signature"></span>copySelectionToClipboard<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Copy the contents of the selection to the clipboard.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line675">line 675</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    True if there was something to copy, false otherwise
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="createClipFromSelection"><span class="type-signature"></span>createClipFromSelection<span class="signature">(identifier, type)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Creates a symbol from the objects currently selected.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>identifier</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">the identifier to give the new symbol</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">"Clip" or "Button"</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line934">line 934</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="createClipInstanceFromAsset"><span class="type-signature"></span>createClipInstanceFromAsset<span class="signature">(asset, x, y, callback)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Adds an instance of a clip asset to the active frame.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>asset</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Wick.Asset.html">Wick.Asset</a></span>


            </td>

            
            <td class="description last">the asset to create the clip instance from</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">the x position to create the image path at</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">the y position to create the image path at</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last">the function to call after the path is created.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line920">line 920</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="createImagePathFromAsset"><span class="type-signature"></span>createImagePathFromAsset<span class="signature">(asset, x, y, callback)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Adds an image path to the active frame using a given asset as its image src.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>asset</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Wick.Asset.html">Wick.Asset</a></span>


            </td>

            
            <td class="description last">the asset to use for the image src</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">the x position to create the image path at</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">the y position to create the image path at</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last">the function to call after the path is created.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line904">line 904</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="createTween"><span class="type-signature"></span>createTween<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Create a new tween on all selected frames OR on the active frame of the active layer.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line789">line 789</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="cutSelectedFrames"><span class="type-signature"></span>cutSelectedFrames<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Cut the currently selected frames.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line721">line 721</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="cutSelectionToClipboard"><span class="type-signature"></span>cutSelectionToClipboard<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Copy the contents of the selection to the clipboard, and delete what was copied.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line689">line 689</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    True if there was something to cut, false otherwise
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="deleteSelectedObjects"><span class="type-signature"></span>deleteSelectedObjects<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Deletes all objects in the selection.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line638">line 638</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="doBooleanOperationOnSelection"><span class="type-signature"></span>doBooleanOperationOnSelection<span class="signature">(booleanOpName)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Perform a boolean operation on all selected paths.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>booleanOpName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The name of the boolean op function to use. See Wick.Path.booleanOp.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line654">line 654</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="duplicateSelection"><span class="type-signature"></span>duplicateSelection<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Copy and paste the current selection.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line710">line 710</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    True if there was something to duplicate, false otherwise
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="errorOccured"><span class="type-signature"></span>errorOccured<span class="signature">(message)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Called when an error occurs to forward to the onError function
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>message</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">the message to display for the error</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line187">line 187</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="extendFrames"><span class="type-signature"></span>extendFrames<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Move the right edge of all frames right one frame.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line815">line 815</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="extendFramesAndPushOtherFrames"><span class="type-signature"></span>extendFramesAndPushOtherFrames<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Move the right edge of all frames right one frame, and push other frames away.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line826">line 826</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="focusTimelineOfParentClip"><span class="type-signature"></span>focusTimelineOfParentClip<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Sets the project focus to the parent timeline of the currently focused clip.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line988">line 988</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="focusTimelineOfSelectedClip"><span class="type-signature"></span>focusTimelineOfSelectedClip<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Sets the project focus to the timeline of the selected clip.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line979">line 979</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="generateAudioTrack"><span class="type-signature"></span>generateAudioTrack<span class="signature">(args, callback)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Generate an audiobuffer containing all the project's sounds merged together.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>args</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
            <td class="description last">placeholder for future options, not currently used</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last">callback used to recieve the final audiobuffer.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1545">line 1545</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="generateImageSequence"><span class="type-signature"></span>generateImageSequence<span class="signature">(args, imageType, onProgress, onFinish)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Create a sequence of images from every frame in the project.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>args</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
            <td class="description last">Options for generating the image sequence</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>imageType</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">MIMEtype to use for rendered images. Defaults to 'image/png'.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>onProgress</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last">Function to call for each image loaded, useful for progress bars</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>onFinish</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last">Function to call when the images are all loaded.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1429">line 1429</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getAllFrames"><span class="type-signature"></span>getAllFrames<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    All frames in this project.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line284">line 284</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getAssetByName"><span class="type-signature"></span>getAssetByName<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Wick.Asset.html">Wick.Asset</a>}</span></h4>
    

<div class="description">
    Retrieve an asset from the project by its name.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The name of the asset to get.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line390">line 390</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The asset
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Wick.Asset.html">Wick.Asset</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="getAssetByUUID"><span class="type-signature"></span>getAssetByUUID<span class="signature">(uuid)</span><span class="type-signature"> &rarr; {<a href="Wick.Asset.html">Wick.Asset</a>}</span></h4>
    

<div class="description">
    Retrieve an asset from the project by its UUID.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>uuid</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The UUID of the asset to get.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line373">line 373</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The asset
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Wick.Asset.html">Wick.Asset</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="getAssets"><span class="type-signature"></span>getAssets<span class="signature">(type)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Wick.Asset.html">Wick.Asset</a>>}</span></h4>
    

<div class="description">
    The assets belonging to the project.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Optional, filter assets by type ("Sound"/"Image"/"Clip"/"Button")</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line401">line 401</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The assets in the project
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;<a href="Wick.Asset.html">Wick.Asset</a>></span>


    </dd>
</dl>

    
    <h4 class="name" id="getAudioInfo"><span class="type-signature"></span>getAudioInfo<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Create an object containing info on all sounds in the project.
Format:
  start: The amount of time in milliseconds to cut from the beginning of the sound.
  end: The amount of time that the sound will play before stopping.
  offset: The amount of time to offset the start of the sound.
  src: The source of the sound as a dataURL.
  filetype: The file type of the sound asset.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1526">line 1526</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getFonts"><span class="type-signature"></span>getFonts<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    A list of all "fontFamily" in the asset library.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line415">line 415</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="hasFont"><span class="type-signature"></span>hasFont<span class="signature">(fontFamily)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Check if a FontAsset with a given fontFamily exists in the project.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>fontFamily</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The font to check for</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line426">line 426</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="importFile"><span class="type-signature"></span>importFile<span class="signature">(file, callback)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Creates an asset from a File object and adds that asset to the project.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>file</code></td>
            

            <td class="type">
            
                
<span class="param-type">File</span>


            </td>

            
            <td class="description last">File object to be read and converted into an asset.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last">Function with the created Wick Asset. Can be passed undefined on improper file input.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line582">line 582</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="initialize"><span class="type-signature"></span>initialize<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Used to initialize the state of elements within the project. Should only be called after
deserialization of project and all objects within the project.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line122">line 122</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="inject"><span class="type-signature"></span>inject<span class="signature">(element)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Inject the project into an element on a webpage and start playing the project.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>element</code></td>
            

            <td class="type">
            
                
<span class="param-type">Element</span>


            </td>

            
            <td class="description last">the element to inject the project into</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1292">line 1292</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="insertBlankFrame"><span class="type-signature"></span>insertBlankFrame<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Inserts a blank frame into the timeline at the position of the playhead.
If the playhead is over an existing frame, that frame will be cut in half,
and a blank frame will be added to fill the empty space created by the cut.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line732">line 732</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="isKeyDown"><span class="type-signature"></span>isKeyDown<span class="signature">(key)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Check if a key is being pressed.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The name of the key to check</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line553">line 553</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="isKeyJustPressed"><span class="type-signature"></span>isKeyJustPressed<span class="signature">(key)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Check if a key was just pressed.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The name of the key to check</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line561">line 561</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="loadAssets"><span class="type-signature"></span>loadAssets<span class="signature">(callback)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Loads all Assets in the project's asset library. This must be called after opening a project.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last">Called when all assets are done loading.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1585">line 1585</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="moveSelectedFramesLeft"><span class="type-signature"></span>moveSelectedFramesLeft<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Shift all selected frames over one frame to the left
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line869">line 869</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="moveSelectedFramesRight"><span class="type-signature"></span>moveSelectedFramesRight<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Shift all selected frames over one frame to the right
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line856">line 856</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="mute"><span class="type-signature"></span>mute<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Disable all sounds from playing
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1044">line 1044</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="objectIsMouseTarget"><span class="type-signature"></span>objectIsMouseTarget<span class="signature">(object)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Check if an object is a mouse target (if the mouse is currently hovered over the object)
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>object</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Wick.Tickable.html">Wick.Tickable</a></span>


            </td>

            
            <td class="description last">the object to check if it is a mouse target</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1556">line 1556</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="onError"><span class="type-signature"></span>onError<span class="signature">(fn)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Assign a function to be called when a user error happens (not script
errors - errors such as drawing tool errors, invalid selection props, etc)
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>fn</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last">the function to call when errors happen</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line179">line 179</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="pasteClipboardContents"><span class="type-signature"></span>pasteClipboardContents<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Paste the contents of the clipboard into the project.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line702">line 702</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    True if there was something to paste in the clipboard, false otherwise.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="play"><span class="type-signature"></span>play<span class="signature">(args)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Start playing the project.
Arguments: onError: Called when a script error occurs during a tick.
           onBeforeTick: Called before every tick
           onAfterTick: Called after every tick
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>args</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
            <td class="description last">Optional arguments</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1168">line 1168</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="playSound"><span class="type-signature"></span>playSound<span class="signature">(assetName, options)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Plays the sound in the asset library with the given name.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>assetName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the sound asset to play</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">options for the sound. See Wick.SoundAsset.play</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line999">line 999</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="recenter"><span class="type-signature"></span>recenter<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Sets zoom and pan such that the canvas fits in the window, with some padding.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1321">line 1321</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="redo"><span class="type-signature"></span>redo<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Redo the last action that was undone.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line335">line 335</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    true if there was something to redo, false otherwise.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="removeAsset"><span class="type-signature"></span>removeAsset<span class="signature">(asset)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Removes an asset from the project. Also removes all instances of that asset from the project.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>asset</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Wick.Asset.html">Wick.Asset</a></span>


            </td>

            
            <td class="description last">The asset to remove from the project.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line363">line 363</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="resetZoomAndPan"><span class="type-signature"></span>resetZoomAndPan<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Resets zoom and pan (zoom resets to 1.0, pan resets to (0,0)).
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1332">line 1332</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="runScheduledScripts"><span class="type-signature"></span>runScheduledScripts<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Run scripts in schedule, in order based on Tickable.possibleScripts.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1136">line 1136</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="scheduleScript"><span class="type-signature"></span>scheduleScript<span class="signature">(uuid, name, parameters)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Schedules a script to be run at the end of the current tick.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>uuid</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">the UUID of the object running the script.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">the name of the script to run, see Tickable.possibleScripts.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>parameters</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">An object of key,value pairs to send as parameters to the script which runs.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1125">line 1125</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="selectAll"><span class="type-signature"></span>selectAll<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Selects all objects that are visible on the canvas (excluding locked layers and onion skinned objects)
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line882">line 882</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="shrinkFrames"><span class="type-signature"></span>shrinkFrames<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Move the right edge of all frames left one frame.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line835">line 835</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="shrinkFramesAndPullOtherFrames"><span class="type-signature"></span>shrinkFramesAndPullOtherFrames<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Move the right edge of all frames left one frame, and pull other frames along.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line847">line 847</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Stop playing the project.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1244">line 1244</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="stopAllSounds"><span class="type-signature"></span>stopAllSounds<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Stops all sounds playing from frames and sounds played using playSound().
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1029">line 1029</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="stopSound"><span class="type-signature"></span>stopSound<span class="signature">(assetName, id)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Stops sound(s) currently playing.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>assetName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The name of the SoundAsset to stop.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">(optional) The ID of the sound to stop. Returned by playSound. If an ID is not given, all instances of the given sound asset will be stopped.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1015">line 1015</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="tick"><span class="type-signature"></span>tick<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
    

<div class="description">
    Ticks the project.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1207">line 1207</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    An object containing information about an error, if one occured while running scripts. Null otherwise.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

    
    <h4 class="name" id="tryToAutoCreateTween"><span class="type-signature"></span>tryToAutoCreateTween<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Tries to create a tween if there is an empty space between tweens.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line805">line 805</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="undo"><span class="type-signature"></span>undo<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Undo the last action.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line319">line 319</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    true if there was something to undo, false otherwise.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="unmute"><span class="type-signature"></span>unmute<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Enable all sounds to play
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1051">line 1051</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="zoomIn"><span class="type-signature"></span>zoomIn<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Zooms the canvas in.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1340">line 1340</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="zoomOut"><span class="type-signature"></span>zoomOut<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Zooms the canvas out.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Project.js.html">base/Project.js</a>, <a href="base_Project.js.html#line1347">line 1347</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BuiltinAssets.html">BuiltinAssets</a></li><li><a href="GlobalAPI.html">GlobalAPI</a></li><li><a href="paper.SelectionGUI.html">SelectionGUI</a></li><li><a href="paper-paper.Selection.html">Selection</a></li><li><a href="SelectionWidget.html">SelectionWidget</a></li><li><a href="Wick.AutoSave.html">AutoSave</a></li><li><a href="Wick.Base.html">Base</a></li><li><a href="Wick.Button.html">Button</a></li><li><a href="Wick.Clip.html">Clip</a></li><li><a href="Wick.Clipboard.html">Clipboard</a></li><li><a href="Wick.FileCache.html">FileCache</a></li><li><a href="Wick.Frame.html">Frame</a></li><li><a href="Wick.GUIElement.Project.html">Project</a></li><li><a href="Wick.GUIElement.Timeline.html">Timeline</a></li><li><a href="Wick.GUIElement-Wick.GUIElement.Breadcrumbs.html">Breadcrumbs</a></li><li><a href="Wick.GUIElement-Wick.GUIElement.Button.html">Button</a></li><li><a href="Wick.History.html">History</a></li><li><a href="Wick.HTMLExport.html">HTMLExport</a></li><li><a href="Wick.HTMLPreview.html">HTMLPreview</a></li><li><a href="Wick.ImageSequence.html">ImageSequence</a></li><li><a href="Wick.Layer.html">Layer</a></li><li><a href="Wick.Path.html">Path</a></li><li><a href="Wick.Project.html">Project</a></li><li><a href="Wick.Selection.html">Selection</a></li><li><a href="Wick.Tickable.html">Tickable</a></li><li><a href="Wick.Timeline.html">Timeline</a></li><li><a href="Wick.Tools-Wick.Tools.Brush.html">Brush</a></li><li><a href="Wick.Tools-Wick.Tools.Cursor.html">Cursor</a></li><li><a href="Wick.Tools-Wick.Tools.Ellipse.html">Ellipse</a></li><li><a href="Wick.Tools-Wick.Tools.Eraser.html">Eraser</a></li><li><a href="Wick.Tools-Wick.Tools.Eyedropper.html">Eyedropper</a></li><li><a href="Wick.Tools-Wick.Tools.FillBucket.html">FillBucket</a></li><li><a href="Wick.Tools-Wick.Tools.Interact.html">Interact</a></li><li><a href="Wick.Tools-Wick.Tools.Line.html">Line</a></li><li><a href="Wick.Tools-Wick.Tools.None.html">None</a></li><li><a href="Wick.Tools-Wick.Tools.Pan.html">Pan</a></li><li><a href="Wick.Tools-Wick.Tools.Pencil.html">Pencil</a></li><li><a href="Wick.Tools-Wick.Tools.Rectangle.html">Rectangle</a></li><li><a href="Wick.Tools-Wick.Tools.Text.html">Text</a></li><li><a href="Wick.Tools-Wick.Tools.Zoom.html">Zoom</a></li><li><a href="Wick.Transformation.html">Transformation</a></li><li><a href="Wick.Tween.html">Tween</a></li><li><a href="Wick.View-Wick.View.Clip.html">Clip</a></li><li><a href="Wick.View-Wick.View.Frame.html">Frame</a></li><li><a href="Wick.View-Wick.View.Path.html">Path</a></li><li><a href="Wick.View-Wick.View.Selection.html">Selection</a></li><li><a href="Wick.WickFile.html">WickFile</a></li><li><a href="Wick.WickObjectFile.html">WickObjectFile</a></li><li><a href="Wick.ZIPExport.html">ZIPExport</a></li><li><a href="WickObjectCache.html">WickObjectCache</a></li><li><a href="Wick-Wick.Asset.html">Asset</a></li><li><a href="Wick-Wick.AudioTrack.html">AudioTrack</a></li><li><a href="Wick-Wick.ClipAsset.html">ClipAsset</a></li><li><a href="Wick-Wick.Color.html">Color</a></li><li><a href="Wick-Wick.FileAsset.html">FileAsset</a></li><li><a href="Wick-Wick.FontAsset.html">FontAsset</a></li><li><a href="Wick-Wick.GIFAsset.html">GIFAsset</a></li><li><a href="Wick-Wick.GUIElement.html">GUIElement</a></li><li><a href="Wick-Wick.ImageAsset.html">ImageAsset</a></li><li><a href="Wick-Wick.SoundAsset.html">SoundAsset</a></li><li><a href="Wick-Wick.SVGAsset.html">SVGAsset</a></li><li><a href="Wick-Wick.Tool.html">Tool</a></li><li><a href="Wick-Wick.ToolSettings.html">ToolSettings</a></li><li><a href="Wick-Wick.View.html">View</a></li></ul><h3>Global</h3><ul><li><a href="global.html#type">type</a></li><li><a href="global.html#Wick">Wick</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Fri Apr 24 2020 15:26:13 GMT-0400 (Eastern Daylight Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>