docs/CpuWatcher.html

<!DOCTYPE html>

<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width">
	<title>SpikeyBot-Discord Class: CpuWatcher</title>

	<!--[if lt IE 9]>
	<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
	<link type="text/css" rel="stylesheet" href="styles/sunlight.dark.css">

	<link type="text/css" rel="stylesheet" href="styles/site.slate.css">

</head>

<body>

<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
	<div class="navbar-header">
		<a class="navbar-brand" href="index.html">SpikeyBot-Discord</a>
		<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
        </button>
	</div>
	<div class="navbar-collapse collapse" id="topNavigation">
		<ul class="nav navbar-nav">
			
			<li class="dropdown">
				<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
				<ul class="dropdown-menu inline">
					<li><a href="module-lib_twemojiChecker.html">lib/twemojiChecker</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
				<ul class="dropdown-menu inline">
					<li><a href="ApiEndpoint.html">ApiEndpoint</a></li><li><a href="ApiRequestBody.html">ApiRequestBody</a></li><li><a href="AutoReact.html">AutoReact</a></li><li><a href="BotCommands.html">BotCommands</a></li><li><a href="ChatBot.html">ChatBot</a></li><li><a href="CmdScheduling.html">CmdScheduling</a></li><li><a href="CmdScheduling-ScheduledCommand.html">CmdScheduling~ScheduledCommand</a></li><li><a href="Command.html">Command</a></li><li><a href="Command-CommandSetting.html">Command~CommandSetting</a></li><li><a href="Command-SingleCommand.html">Command~SingleCommand</a></li><li><a href="Common.html">Common</a></li><li><a href="Connect4.html">Connect4</a></li><li><a href="Connect4_Game.html">Connect4#Game</a></li><li><a href="CpuWatcher.html">CpuWatcher</a></li><li><a href="Define.html">Define</a></li><li><a href="DevCmds.html">DevCmds</a></li><li><a href="Echo.html">Echo</a></li><li><a href="Echo-Character.html">Echo~Character</a></li><li><a href="FileServer.html">FileServer</a></li><li><a href="FunTranslators.html">FunTranslators</a></li><li><a href="HG.html">HG</a></li><li><a href="HGWeb.html">HGWeb</a></li><li><a href="HungryGames.html">HungryGames</a></li><li><a href="HungryGames-ActionManager.html">HungryGames~ActionManager</a></li><li><a href="HungryGames-ActionStore.html">HungryGames~ActionStore</a></li><li><a href="HungryGames-Action-GiveRoleAction.html">HungryGames~Action~GiveRoleAction</a></li><li><a href="HungryGames-Action-RunCommandAction.html">HungryGames~Action~RunCommandAction</a></li><li><a href="HungryGames-Action-SendAutoplayingMessageAlertAction.html">HungryGames~Action~SendAutoplayingMessageAlertAction</a></li><li><a href="HungryGames-Action-SendDayEndMessageAction.html">HungryGames~Action~SendDayEndMessageAction</a></li><li><a href="HungryGames-Action-SendDayStartMessageAction.html">HungryGames~Action~SendDayStartMessageAction</a></li><li><a href="HungryGames-Action-SendEventMessageAction.html">HungryGames~Action~SendEventMessageAction</a></li><li><a href="HungryGames-Action-SendMessageAction.html">HungryGames~Action~SendMessageAction</a></li><li><a href="HungryGames-Action-SendPlayerRankMessageAction.html">HungryGames~Action~SendPlayerRankMessageAction</a></li><li><a href="HungryGames-Action-SendStatusListAction.html">HungryGames~Action~SendStatusListAction</a></li><li><a href="HungryGames-Action-SendTeamRankMessageAction.html">HungryGames~Action~SendTeamRankMessageAction</a></li><li><a href="HungryGames-Action-SendVictorAction.html">HungryGames~Action~SendVictorAction</a></li><li><a href="HungryGames-Action-TakeRoleAction.html">HungryGames~Action~TakeRoleAction</a></li><li><a href="HungryGames-ArenaEvent.html">HungryGames~ArenaEvent</a></li><li><a href="HungryGames-Battle.html">HungryGames~Battle</a></li><li><a href="HungryGames-ChannelAction.html">HungryGames~ChannelAction</a></li><li><a href="HungryGames-Day.html">HungryGames~Day</a></li><li><a href="HungryGames-DefaultOptions.html">HungryGames~DefaultOptions</a></li><li><a href="HungryGames-DefaultOptions-BooleanOption.html">HungryGames~DefaultOptions~BooleanOption</a></li><li><a href="HungryGames-DefaultOptions-NumberOption.html">HungryGames~DefaultOptions~NumberOption</a></li><li><a href="HungryGames-DefaultOptions-ObjectOption.html">HungryGames~DefaultOptions~ObjectOption</a></li><li><a href="HungryGames-DefaultOptions-Option.html">HungryGames~DefaultOptions~Option</a></li><li><a href="HungryGames-DefaultOptions-SelectOption.html">HungryGames~DefaultOptions~SelectOption</a></li><li><a href="HungryGames-Event.html">HungryGames~Event</a></li><li><a href="HungryGames-EventContainer.html">HungryGames~EventContainer</a></li><li><a href="HungryGames-FinalEvent.html">HungryGames~FinalEvent</a></li><li><a href="HungryGames-ForcedOutcome.html">HungryGames~ForcedOutcome</a></li><li><a href="HungryGames-Game.html">HungryGames~Game</a></li><li><a href="HungryGames-Grammar.html">HungryGames~Grammar</a></li><li><a href="HungryGames-GuildGame.html">HungryGames~GuildGame</a></li><li><a href="HungryGames-MemberAction.html">HungryGames~MemberAction</a></li><li><a href="HungryGames-Messages.html">HungryGames~Messages</a></li><li><a href="HungryGames-NormalEvent.html">HungryGames~NormalEvent</a></li><li><a href="HungryGames-OutcomeProbabilities.html">HungryGames~OutcomeProbabilities</a></li><li><a href="HungryGames-Player.html">HungryGames~Player</a></li><li><a href="HungryGames-Simulator.html">HungryGames~Simulator</a></li><li><a href="HungryGames-Simulator-Worker.html">HungryGames~Simulator~Worker</a></li><li><a href="HungryGames-StatGroup.html">HungryGames~StatGroup</a></li><li><a href="HungryGames-StatManager.html">HungryGames~StatManager</a></li><li><a href="HungryGames-Stats.html">HungryGames~Stats</a></li><li><a href="HungryGames-Team.html">HungryGames~Team</a></li><li><a href="HungryGames-UserIconUrl.html">HungryGames~UserIconUrl</a></li><li><a href="HungryGames-WeaponEvent.html">HungryGames~WeaponEvent</a></li><li><a href="Images.html">Images</a></li><li><a href="LocaleManager.html">LocaleManager</a></li><li><a href="Main.html">Main</a></li><li><a href="MainModule.html">MainModule</a></li><li><a href="MemWatcher.html">MemWatcher</a></li><li><a href="MessageMaker.html">MessageMaker</a></li><li><a href="Messages.html">Messages</a></li><li><a href="Moderation.html">Moderation</a></li><li><a href="ModLog.html">ModLog</a></li><li><a href="ModLog-Settings.html">ModLog~Settings</a></li><li><a href="Music.html">Music</a></li><li><a href="NPC.html">NPC</a></li><li><a href="Patreon.html">Patreon</a></li><li><a href="Patreon-toExport.html">Patreon~toExport</a></li><li><a href="Pets.html">Pets</a></li><li><a href="Pets-BaseMoves.html">Pets~BaseMoves</a></li><li><a href="Pets-BasePetClasses.html">Pets~BasePetClasses</a></li><li><a href="Pets-BasePets.html">Pets~BasePets</a></li><li><a href="Pets-Constants.html">Pets~Constants</a></li><li><a href="Pets-NPC.html">Pets~NPC</a></li><li><a href="Pets-Pet.html">Pets~Pet</a></li><li><a href="Polling.html">Polling</a></li><li><a href="Polling-Poll.html">Polling~Poll</a></li><li><a href="RaidBlock.html">RaidBlock</a></li><li><a href="RaidBlock-RaidSettings.html">RaidBlock~RaidSettings</a></li><li><a href="RoleColors.html">RoleColors</a></li><li><a href="RoleManager.html">RoleManager</a></li><li><a href="Sandbox.html">Sandbox</a></li><li><a href="ShardingMaster.html">ShardingMaster</a></li><li><a href="ShardingMaster.ShardInfo.html">ShardingMaster.ShardInfo</a></li><li><a href="ShardingMaster.ShardStatus.html">ShardingMaster.ShardStatus</a></li><li><a href="ShardingSlave.html">ShardingSlave</a></li><li><a href="Shutdown.html">Shutdown</a></li><li><a href="SMLoader.html">SMLoader</a></li><li><a href="SpikeyBot.html">SpikeyBot</a></li><li><a href="Spotify.html">Spotify</a></li><li><a href="Strings.html">Strings</a></li><li><a href="Strings-Locale.html">Strings~Locale</a></li><li><a href="SubModule.html">SubModule</a></li><li><a href="TicTacToe.html">TicTacToe</a></li><li><a href="TicTacToe_Game.html">TicTacToe#Game</a></li><li><a href="TTS.html">TTS</a></li><li><a href="Twitch.html">Twitch</a></li><li><a href="Uno.html">Uno</a></li><li><a href="Uno_Card.html">Uno#Card</a></li><li><a href="Uno_Game.html">Uno#Game</a></li><li><a href="WebAccount.html">WebAccount</a></li><li><a href="WebApi.html">WebApi</a></li><li><a href="WebProxy.html">WebProxy</a></li><li><a href="WebSettings.html">WebSettings</a></li><li><a href="WebStats.html">WebStats</a></li><li><a href="WebUserData.html">WebUserData</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="interfaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Interfaces<b class="caret"></b></a>
				<ul class="dropdown-menu inline">
					<li><a href="HungryGames-Action.html">HungryGames~Action</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
				<ul class="dropdown-menu inline">
					<li><a href="global.html#__stack">__stack</a></li><li><a href="global.html#self">self</a></li><li><a href="global.html#sqlCon">sqlCon</a></li><li><a href="global.html#unhandledRejection">unhandledRejection</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="externals.list.html" class="dropdown-toggle" data-toggle="dropdown">Externals<b class="caret"></b></a>
				<ul class="dropdown-menu inline">
					<li><a href="external-Discord.html">Discord</a></li>
				</ul>
			</li>
			
		</ul>
        
            <div class="col-sm-3 col-md-3">
                <form class="navbar-form" role="search">
                    <div class="input-group">
                        <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
                        <div class="input-group-btn">
                            <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
                        </div>
                    </div>
                </form>
            </div>
        
	</div>

</div>
</div>


<div class="container" id="toc-content">
<div class="row">

	
	<div class="col-md-8">
	
		<div id="main">
			

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

<header>
    
        <h2>
        CpuWatcher
        </h2>
        
    
</header>


<article>
    <div class="container-overview">
    
        
<hr>
<dt>
    <h4 class="name" id="CpuWatcher"><span class="type-signature"></span>new CpuWatcher()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        Manages watching loop timings to help find causes of
inconsistent event loops.
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="cpuWatcher.js.html">cpuWatcher.js</a>,
				 <a href="cpuWatcher.js.html#sunlight-1-line-10">line 10</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

    
    </div>

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

        
    <ul>
        <li><a href="SubModule.html">SubModule</a></li>
    </ul>


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

        <dl>
            
<hr>
<dt class="name" id="_lastLoopTime">
    <h4 id="_lastLoopTime"><span class="type-signature">&lt;private> </span>_lastLoopTime<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The timestamp of the last event loop start.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="cpuWatcher.js.html">cpuWatcher.js</a>,
				 <a href="cpuWatcher.js.html#sunlight-1-line-42">line 42</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="_loopLogFrequency">
    <h4 id="_loopLogFrequency"><span class="type-signature">&lt;private, constant> </span>_loopLogFrequency<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        How often to log periodic event loop statistics.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>60 seconds</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="cpuWatcher.js.html">cpuWatcher.js</a>,
				 <a href="cpuWatcher.js.html#sunlight-1-line-50">line 50</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="_loopLogTime">
    <h4 id="_loopLogTime"><span class="type-signature">&lt;private> </span>_loopLogTime<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        Timestamp of the last time loop timings were logged.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="cpuWatcher.js.html">cpuWatcher.js</a>,
				 <a href="cpuWatcher.js.html#sunlight-1-line-57">line 57</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="_loopWarnThresh">
    <h4 id="_loopWarnThresh"><span class="type-signature">&lt;private, constant> </span>_loopWarnThresh<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        If a single event loop takes longer than this time, log that
something went wrong.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>1000000 nanoseconds</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="cpuWatcher.js.html">cpuWatcher.js</a>,
				 <a href="cpuWatcher.js.html#sunlight-1-line-28">line 28</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="_maxLoopTime">
    <h4 id="_maxLoopTime"><span class="type-signature">&lt;private> </span>_maxLoopTime<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The amount of time the longest event loop took during the
last interval.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="cpuWatcher.js.html">cpuWatcher.js</a>,
				 <a href="cpuWatcher.js.html#sunlight-1-line-65">line 65</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="_numLoops">
    <h4 id="_numLoops"><span class="type-signature">&lt;private> </span>_numLoops<span class="type-signature"> :bigint</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The number of event loops that took place during the last
interval.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="cpuWatcher.js.html">cpuWatcher.js</a>,
				 <a href="cpuWatcher.js.html#sunlight-1-line-81">line 81</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="_totalLoopTime">
    <h4 id="_totalLoopTime"><span class="type-signature">&lt;private> </span>_totalLoopTime<span class="type-signature"> :bigint</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The sum of all event loop delays during the last interval
for averaging.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="cpuWatcher.js.html">cpuWatcher.js</a>,
				 <a href="cpuWatcher.js.html#sunlight-1-line-73">line 73</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="_watchLoop">
    <h4 id="_watchLoop"><span class="type-signature">&lt;private> </span>_watchLoop<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        Flag of whether to keep monitoring the event loop timing.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="cpuWatcher.js.html">cpuWatcher.js</a>,
				 <a href="cpuWatcher.js.html#sunlight-1-line-35">line 35</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="bot">
    <h4 id="bot"><span class="type-signature">&lt;nullable> </span>bot<span class="type-signature"> :<a href="SpikeyBot.html">SpikeyBot</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The parent SpikeyBot instance. Defaults to required cache value for
autocompletion, updates to current reference at init.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#bot">SubModule#bot</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#bot">SubModule#bot</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-70">line 70</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="client">
    <h4 id="client"><span class="type-signature"></span>client<span class="type-signature"> :Discord~Client</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The current bot client. Defaults to require cache value for editor
autocompletion, updates to current reference at init.
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Discord~Client</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#client">SubModule#client</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#client">SubModule#client</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-44">line 44</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="command">
    <h4 id="command"><span class="type-signature"></span>command<span class="type-signature"> :<a href="Command.html">Command</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The command object for registering command listeners. Defaults to require
cache value for editor autocompletion, updates to current reference at
init.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#command">SubModule#command</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#command">SubModule#command</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-53">line 53</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="commit">
    <h4 id="commit"><span class="type-signature">&lt;constant> </span>commit<span class="type-signature"> :string</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The commit at HEAD at the time this module was loaded. Essentially the
version of this submodule.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#commit">SubModule#commit</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#commit">SubModule#commit</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-80">line 80</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="common">
    <h4 id="common"><span class="type-signature"></span>common<span class="type-signature"> :<a href="Common.html">Common</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The common object. Defaults to require cache value for editor
autocompletion, updates to current reference at init.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#common">SubModule#common</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#common">SubModule#common</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-61">line 61</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="Discord">
    <h4 id="Discord"><span class="type-signature"></span>Discord<span class="type-signature"> :Discord</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The current Discord object instance of the bot. Defaults to require cache
value for editor autocompletion, updates to current reference at init.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#Discord">SubModule#Discord</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#Discord">SubModule#Discord</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-36">line 36</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="helpMessage">
    <h4 id="helpMessage"><span class="type-signature">&lt;abstract> </span>helpMessage<span class="type-signature"> :undefined|string|Discord~EmbedBuilder</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The help message to show the user in the main help message.
    </div>
    

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

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

<span class="param-type">Discord~EmbedBuilder</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#helpMessage">SubModule#helpMessage</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#helpMessage">SubModule#helpMessage</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-18">line 18</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="initialized">
    <h4 id="initialized"><span class="type-signature">&lt;protected, readonly> </span>initialized<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        Has this subModule been initialized yet (Has begin() been called).
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#initialized">SubModule#initialized</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#initialized">SubModule#initialized</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-113">line 113</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="loadTime">
    <h4 id="loadTime"><span class="type-signature">&lt;constant> </span>loadTime<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The time at which this module was loaded for use in checking if the
module needs to be reloaded because the file has been modified since
loading.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#loadTime">SubModule#loadTime</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#loadTime">SubModule#loadTime</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-93">line 93</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="myName">
    <h4 id="myName"><span class="type-signature">&lt;protected> </span>myName<span class="type-signature"> :string</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The name of this submodule. Used for differentiating in the log. Should
be defined before begin().
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#myName">SubModule#myName</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#myName">SubModule#myName</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-103">line 103</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt class="name" id="postPrefix">
    <h4 id="postPrefix"><span class="type-signature">&lt;abstract> </span>postPrefix<span class="type-signature"> :string</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        The postfix for the global prefix for this subModule. Must be defined
before begin(), otherwise it is ignored.
    </div>
    

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


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#postPrefix">SubModule#postPrefix</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#postPrefix">SubModule#postPrefix</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-28">line 28</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        </dl>
    

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

        <dl>
            
<hr>
<dt>
    <h4 class="name" id="_queueLoopCheck"><span class="type-signature">&lt;private> </span>_queueLoopCheck()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        Time how long the next event loop will take. Calls itself
every event loop until {@see _watchLoop} is set to false.
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="cpuWatcher.js.html">cpuWatcher.js</a>,
				 <a href="cpuWatcher.js.html#sunlight-1-line-101">line 101</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="begin"><span class="type-signature"></span>begin(Discord, client, command, common, bot)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        Initialize this submodule.
    </div>
    

        <h5>Parameters:</h5>
        

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

            
            <td class="description last">The Discord object for the API library.</td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type">Discord~Client</span>


            </td>

            
            <td class="description last">The client that represents this bot.</td>
        </tr>

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

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


            </td>

            
            <td class="description last">The command instance in which to
register command listeners.</td>
        </tr>

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

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


            </td>

            
            <td class="description last">Class storing common functions.</td>
        </tr>

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

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


            </td>

            
            <td class="description last">The parent SpikeyBot instance.</td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#begin">SubModule#begin</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#begin">SubModule#begin</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-136">line 136</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="debug"><span class="type-signature">&lt;protected> </span>debug(msg)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        Log using common.logDebug, but automatically set name.
    </div>
    

        <h5>Parameters:</h5>
        

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

            
            <td class="description last">The message to log.</td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#debug">SubModule#debug</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#debug">SubModule#debug</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-223">line 223</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="end"><span class="type-signature"></span>end()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        Trigger subModule to shutdown and get ready for process terminating.
    </div>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#end">SubModule#end</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#end">SubModule#end</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-201">line 201</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="error"><span class="type-signature">&lt;protected> </span>error(msg)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        Log using common.error, but automatically set name.
    </div>
    

        <h5>Parameters:</h5>
        

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

            
            <td class="description last">The message to log.</td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#error">SubModule#error</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#error">SubModule#error</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-241">line 241</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="initialize"><span class="type-signature">&lt;protected> </span>initialize()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        The function called at the end of begin() for further initialization
specific to the subModule. Must be defined before begin() is called.
    </div>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#initialize">SubModule#initialize</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#initialize">SubModule#initialize</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-122">line 122</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="log"><span class="type-signature">&lt;protected> </span>log(msg)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        Log using common.log, but automatically set name.
    </div>
    

        <h5>Parameters:</h5>
        

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

            
            <td class="description last">The message to log.</td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#log">SubModule#log</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#log">SubModule#log</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-214">line 214</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="reloadable"><span class="type-signature">&lt;abstract> </span>reloadable()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        Check if this module is in a state that is ready to be
reloaded. If false is returned, this module should not be unloaded and
doing such may risk putting the module into an uncontrollable state. This
is different from unloadable, which checks if this module can be stopped
completely, this checks if the module can be stopped and restarted.
    </div>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#reloadable">SubModule#reloadable</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#reloadable">SubModule#reloadable</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-292">line 292</a>
			</li>
		</ul>
	</dd>
	

	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
	<dd class="tag-see">
		<ul>
			<li>SubModule~unloadable</li>
			</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    True if can be reloaded, false if cannot.
</div>


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


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="save"><span class="type-signature">&lt;abstract> </span>save( [opt])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        Saves all data to files necessary for saving current state.
    </div>
    

        <h5>Parameters:</h5>
        

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

        <th>Type</th>

        
        <th>Argument</th>
        

        <th>Default</th>
        

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

    <tbody>
    

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

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    'sync'
                
                </td>
            

            <td class="description last">Can be 'async', otherwise defaults to
synchronous.</td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#save">SubModule#save</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#save">SubModule#save</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-262">line 262</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="shutdown"><span class="type-signature">&lt;protected> </span>shutdown()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        Shutdown and disable this submodule. Removes all event listeners.
    </div>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#shutdown">SubModule#shutdown</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#shutdown">SubModule#shutdown</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-251">line 251</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="unloadable"><span class="type-signature">&lt;abstract> </span>unloadable()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        Check if this module is in a state that is ready to be
unloaded. If false is returned, this module should not be unloaded and
doing such may risk putting the module into an uncontrollable state.
    </div>
    

<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#unloadable">SubModule#unloadable</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#unloadable">SubModule#unloadable</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-276">line 276</a>
			</li>
		</ul>
	</dd>
	

	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
	<dd class="tag-see">
		<ul>
			<li>SubModule~reloadable</li>
			</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    True if can be unloaded, false if cannot.
</div>


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


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="warn"><span class="type-signature">&lt;protected> </span>warn(msg)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        Log using common.logWarning, but automatically set name.
    </div>
    

        <h5>Parameters:</h5>
        

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

            
            <td class="description last">The message to log.</td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="SubModule.html#warn">SubModule#warn</a>
			</li>
		</ul>
	</dd>
	

    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubModule.html#warn">SubModule#warn</a>
    </li></ul></dd>
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="subModule.js.html">subModule.js</a>,
				 <a href="subModule.js.html#sunlight-1-line-232">line 232</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        </dl>
    

</article>

</section>


		</div>
	</div>

	<div class="clearfix"></div>

	
		<div class="col-md-3">
			<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
		</div>
	

</div>
</div>


    <div class="modal fade" id="searchResults">
      <div class="modal-dialog">
        <div class="modal-content">
          <div class="modal-header">
            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
            <h4 class="modal-title">Search results</h4>
          </div>
          <div class="modal-body"></div>
          <div class="modal-footer">
            <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
          </div>
        </div><!-- /.modal-content -->
      </div><!-- /.modal-dialog -->
    </div>


<footer>


	<span class="copyright">
	<small>Website Contact: <a href="mailto:web@spikeybot.com">web@spikeybot.com</a>.</small><br><small>&copy; Copyright 2019-2020, Campbell Crowley. <a href="https://docs.google.com/document/d/1SAC2aPxxeNqRjlZzjwrnCyyWWyt09ZP-AP7BDBjjQDg/edit?usp=sharing">Privacy Policy</a></small>
	</span>

<span class="jsdoc-message">
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
	
		on Sunday, July 23, 2023 4:25 PM (-07:00)
	
	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>

<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>

    <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>


<script>
$( function () {
	$( "[id*='$']" ).each( function () {
		var $this = $( this );

		$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
	} );

	$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
		var $this = $( this );

		var example = $this.find( "code" );
		exampleText = example.html();
		var lang = /{@lang (.*?)}/.exec( exampleText );
		if ( lang && lang[1] ) {
			exampleText = exampleText.replace( lang[0], "" );
			example.html( exampleText );
			lang = lang[1];
		} else {
			var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
			lang = langClassMatch ? langClassMatch[1] : "javascript";
		}

		if ( lang ) {

			$this
			.addClass( "sunlight-highlight-" + lang )
			.addClass( "linenums" )
			.html( example.html() );

		}
	} );

	Sunlight.highlightAll( {
		lineNumbers : true,
		showMenu : true,
		enableDoclinks : true
	} );

	$.catchAnchorLinks( {
        navbarOffset: 10
	} );
	$( "#toc" ).toc( {
		anchorName  : function ( i, heading, prefix ) {
			return $( heading ).attr( "id" ) || ( prefix + i );
		},
		selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
		showAndHide : false,
		smoothScrolling: true
	} );

	$( "#main span[id^='toc']" ).addClass( "toc-shim" );
	$( '.dropdown-toggle' ).dropdown();

    $( "table" ).each( function () {
      var $this = $( this );
      $this.addClass('table');
    } );

} );
</script>


<!--Navigation and Symbol Display-->


<!--Google Analytics-->

<script>
	(function ( i, s, o, g, r, a, m ) {
		i['GoogleAnalyticsObject'] = r;
		i[r] = i[r] || function () {
			(i[r].q = i[r].q || []).push( arguments )
		}, i[r].l = 1 * new Date();
		a = s.createElement( o ),
			m = s.getElementsByTagName( o )[0];
		a.async = 1;
		a.src = g;
		m.parentNode.insertBefore( a, m )
	})( window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga' );

	ga( 'create', 'UA-89923351-1', 'www.spikeybot.com' );
	ga( 'send', 'pageview' );
</script>


    <script type="text/javascript">
        $(document).ready(function() {
            SearcherDisplay.init();
        });
    </script>


</body>
</html>