docs/IdleRPG.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Documentation &middot; Class: IdleRPG</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: IdleRPG</h1>
      

<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>IdleRPG<span class="signature">(config)</span><span class="type-signature"> &rarr; {<a href="IdleRPG.html">IdleRPG</a>}</span></h2>
        
            <div class="class-description">Generic IdleRPG definition.</div>
        
    
</header>

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

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

<div class="description">
    C
</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>config</code></td>
            

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


            </td>

            
            <td class="description last">Settings for IdleRPG to use.
                <h6>Properties</h6>
                

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

            
            <td class="description last">Tick interval (in milliseconds).</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="idlerpg.js.html">idlerpg.js</a>, <a href="idlerpg.js.html#line33">line 33</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Instance of IdleRPG.
</div>


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


    </dd>
</dl>

    
    </div>

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

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

<div class="description">
    Gets a list of all "currently active" IdleRPG players.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="idlerpg.js.html">idlerpg.js</a>, <a href="idlerpg.js.html#line545">line 545</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    List of players.
</div>


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


    </dd>
</dl>

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

<div class="description">
    Gets an up-to-date list of all IdleRPG players.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="idlerpg.js.html">idlerpg.js</a>, <a href="idlerpg.js.html#line517">line 517</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    List of players.
</div>


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


    </dd>
</dl>

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

<div class="description">
    Get a Player profile by ID.
</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>id</code></td>
            

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


            </td>

            
            <td class="description last">Player ID.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="idlerpg.js.html">idlerpg.js</a>, <a href="idlerpg.js.html#line321">line 321</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Instance of the Player object.
</div>


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


    </dd>
</dl>

    
    <h4 class="name" id="_registerUser"><span class="type-signature">(async) </span>_registerUser<span class="signature">(user)</span><span class="type-signature"> &rarr; {Player}</span></h4>
    

<div class="description">
    Takes a User object and registers it as a player.
</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>user</code></td>
            

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


            </td>

            
            <td class="description last">User to register as a Player.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="idlerpg.js.html">idlerpg.js</a>, <a href="idlerpg.js.html#line616">line 616</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Instance of the Player object.
</div>


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


    </dd>
</dl>

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

<div class="description">
    Commit to the current game state.  Writes state to disk, then broadcasts any
outstanding changes.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="idlerpg.js.html">idlerpg.js</a>, <a href="idlerpg.js.html#line176">line 176</a>
    </li></ul></dd>
    

</dl>


<h5>Fires:</h5>
<ul>
    <li>{IdleRPG#event:patches} An array of changes since the last commit.</li>
</ul>


<h5>Returns:</h5>

        
<div class="param-desc">
    Indicates successful commit.
</div>


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


    </dd>
</dl>

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

<div class="description">
    Entry point for running IdleRPG.  Creates a datastore, subscribes to events,
initializes the clock, and emits a "ready" event when complete.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="idlerpg.js.html">idlerpg.js</a>, <a href="idlerpg.js.html#line76">line 76</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Chainable method.
</div>


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


    </dd>
</dl>

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

<div class="description">
    Clock frame.  Called once per cycle (tick).
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="idlerpg.js.html">idlerpg.js</a>, <a href="idlerpg.js.html#line151">line 151</a>
    </li></ul></dd>
    

</dl>


<h5>Fires:</h5>
<ul>
    <li>{IdleRPG#event:tick} Emitted once the clock cycle is complete.</li>
</ul>


<h5>Returns:</h5>

        
<div class="param-desc">
    Chainable method.
</div>


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


    </dd>
</dl>

    
</article>

</section>


    </div>
    <nav><h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Core.html">Core</a></li><li><a href="IdleRPG.html">IdleRPG</a></li></ul></nav>
    <br class="clear" />
    <footer>
      <a href="https://github.com/FabricLabs/idlerpg">Source Code</a> &middot; <a href="/">Documentation</a> &middot; <a href="https://to.matrix.pub/#idlerpg:roleplaygateway.com">Play</a> &middot; <a href="https://to.fabric.pub/#idlerpg:matrix.org">Chat</a>
    </footer>
    <script type="text/javascript">
      prettyPrint();
    </script>
    <script src="scripts/linenumber.js"></script>
  </body>
</html>