api-docs/modules/doukutsu.html

<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>doukutsu | </title>
	<meta name="description" content="Documentation for ">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
	<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title"></a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-externals" checked />
							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../index.html"></a>
				</li>
				<li>
					<a href="doukutsu.html">doukutsu</a>
				</li>
			</ul>
			<h1>Namespace doukutsu</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Functions</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="doukutsu.html#on" class="tsd-kind-icon">on</a></li>
								<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="doukutsu.html#playmusic" class="tsd-kind-icon">play<wbr>Music</a></li>
								<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="doukutsu.html#playsfx" class="tsd-kind-icon">play<wbr>Sfx</a></li>
								<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="doukutsu.html#setsetting" class="tsd-kind-icon">set<wbr>Setting</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Functions</h2>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
					<a name="on" class="tsd-anchor"></a>
					<h3>on</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
						<li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;init&quot;</span>, handler<span class="tsd-signature-symbol">: </span><a href="../index.html#eventhandler" class="tsd-signature-type" data-tsd-kind="Type alias">EventHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#eventhandler" class="tsd-signature-type" data-tsd-kind="Type alias">EventHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
						<li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;tick&quot;</span>, handler<span class="tsd-signature-symbol">: </span><a href="../index.html#eventhandler" class="tsd-signature-type" data-tsd-kind="Type alias">EventHandler</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/doukutsuscene.html" class="tsd-signature-type" data-tsd-kind="Interface">DoukutsuScene</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#eventhandler" class="tsd-signature-type" data-tsd-kind="Type alias">EventHandler</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/doukutsuscene.html" class="tsd-signature-type" data-tsd-kind="Interface">DoukutsuScene</a><span class="tsd-signature-symbol">&gt;</span></li>
						<li class="tsd-signature tsd-kind-icon">on&lt;T&gt;<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><a href="../index.html#eventhandler" class="tsd-signature-type" data-tsd-kind="Type alias">EventHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#eventhandler" class="tsd-signature-type" data-tsd-kind="Type alias">EventHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/doukutsu-rs/doukutsu-rs/blob/976281a/src/scripting/doukutsu.d.ts#L84">doukutsu.d.ts:84</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Registers an event handler called after all scripts are loaded.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>event: <span class="tsd-signature-type">&quot;init&quot;</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>event name</p>
									</div>
								</li>
								<li>
									<h5>handler: <a href="../index.html#eventhandler" class="tsd-signature-type" data-tsd-kind="Type alias">EventHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>event handler procedure</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="../index.html#eventhandler" class="tsd-signature-type" data-tsd-kind="Type alias">EventHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
						</li>
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/doukutsu-rs/doukutsu-rs/blob/976281a/src/scripting/doukutsu.d.ts#L91">doukutsu.d.ts:91</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Registers an event handler called on each tick.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>event: <span class="tsd-signature-type">&quot;tick&quot;</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>event name</p>
									</div>
								</li>
								<li>
									<h5>handler: <a href="../index.html#eventhandler" class="tsd-signature-type" data-tsd-kind="Type alias">EventHandler</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/doukutsuscene.html" class="tsd-signature-type" data-tsd-kind="Interface">DoukutsuScene</a><span class="tsd-signature-symbol">&gt;</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>event handler procedure</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="../index.html#eventhandler" class="tsd-signature-type" data-tsd-kind="Type alias">EventHandler</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/doukutsuscene.html" class="tsd-signature-type" data-tsd-kind="Interface">DoukutsuScene</a><span class="tsd-signature-symbol">&gt;</span></h4>
						</li>
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/doukutsu-rs/doukutsu-rs/blob/976281a/src/scripting/doukutsu.d.ts#L93">doukutsu.d.ts:93</a></li>
								</ul>
							</aside>
							<h4 class="tsd-type-parameters-title">Type parameters</h4>
							<ul class="tsd-type-parameters">
								<li>
									<h4>T</h4>
								</li>
							</ul>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>event: <span class="tsd-signature-type">string</span></h5>
								</li>
								<li>
									<h5>handler: <a href="../index.html#eventhandler" class="tsd-signature-type" data-tsd-kind="Type alias">EventHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="../index.html#eventhandler" class="tsd-signature-type" data-tsd-kind="Type alias">EventHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
					<a name="playmusic" class="tsd-anchor"></a>
					<h3>play<wbr>Music</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
						<li class="tsd-signature tsd-kind-icon">play<wbr>Music<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/doukutsu-rs/doukutsu-rs/blob/976281a/src/scripting/doukutsu.d.ts#L70">doukutsu.d.ts:70</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Changes current music to one with specified ID.
									If ID equals 0, the music is stopped.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>id: <span class="tsd-signature-type">number</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
					<a name="playsfx" class="tsd-anchor"></a>
					<h3>play<wbr>Sfx</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
						<li class="tsd-signature tsd-kind-icon">play<wbr>Sfx<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/doukutsu-rs/doukutsu-rs/blob/976281a/src/scripting/doukutsu.d.ts#L64">doukutsu.d.ts:64</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Plays a PixTone sound effect with specified ID.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>id: <span class="tsd-signature-type">number</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
					<a name="setsetting" class="tsd-anchor"></a>
					<h3>set<wbr>Setting</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Setting<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/doukutsu-rs/doukutsu-rs/blob/976281a/src/scripting/doukutsu.d.ts#L77">doukutsu.d.ts:77</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Sets an implementation-defined game setting.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>name: <span class="tsd-signature-type">string</span></h5>
								</li>
								<li>
									<h5>value: <span class="tsd-signature-type">any</span></h5>
									<div class="tsd-comment tsd-typography">
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
						</li>
					</ul>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class=" ">
						<a href="../index.html">Exports</a>
					</li>
					<li class="current tsd-kind-namespace">
						<a href="doukutsu.html">doukutsu</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
						<a href="doukutsu.html#on" class="tsd-kind-icon">on</a>
					</li>
					<li class=" tsd-kind-function tsd-parent-kind-namespace">
						<a href="doukutsu.html#playmusic" class="tsd-kind-icon">play<wbr>Music</a>
					</li>
					<li class=" tsd-kind-function tsd-parent-kind-namespace">
						<a href="doukutsu.html#playsfx" class="tsd-kind-icon">play<wbr>Sfx</a>
					</li>
					<li class=" tsd-kind-function tsd-parent-kind-namespace">
						<a href="doukutsu.html#setsetting" class="tsd-kind-icon">set<wbr>Setting</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>