267 lines
12 KiB
HTML
267 lines
12 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>LightcordGlobal | lightcordapi</title>
|
|
<meta name="description" content="Documentation for lightcordapi">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</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">lightcordapi</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>
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/_index_.html">"index"</a>
|
|
</li>
|
|
<li>
|
|
<a href="_index_.lightcordglobal.html">LightcordGlobal</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface LightcordGlobal</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The main Lightcord exports. Can be accessed with <code>window.Lightcord</code></p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">LightcordGlobal</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<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>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.lightcordglobal.html#api" class="tsd-kind-icon">Api</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.lightcordglobal.html#betterdiscord" class="tsd-kind-icon">Better<wbr>Discord</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.lightcordglobal.html#discordmodules" class="tsd-kind-icon">Discord<wbr>Modules</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.lightcordglobal.html#settings" class="tsd-kind-icon">Settings</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="api" class="tsd-anchor"></a>
|
|
<h3>Api</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Api<span class="tsd-signature-symbol">:</span> <a href="../modules/_index_.html#lightcordapiglobal" class="tsd-signature-type">LightcordApiGlobal</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/index.ts:81</li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="betterdiscord" class="tsd-anchor"></a>
|
|
<h3>Better<wbr>Discord</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Better<wbr>Discord<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>BdApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">BdApi</span><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/index.ts:82</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-index-signature">
|
|
<h5><span class="tsd-signature-symbol">[</span>mod: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>Bd<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">BdApi</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="discordmodules" class="tsd-anchor"></a>
|
|
<h3>Discord<wbr>Modules</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Discord<wbr>Modules<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>constants<span class="tsd-signature-symbol">: </span><a href="_types_discordconstantstypes_.discordconstantstype.html" class="tsd-signature-type">DiscordConstantsType</a><span class="tsd-signature-symbol">; </span>dispatcher<span class="tsd-signature-symbol">: </span><a href="_types_discorddispatchertypes_.dispatchertypes.html" class="tsd-signature-type">DispatcherTypes</a><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/index.ts:70</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>constants<span class="tsd-signature-symbol">: </span><a href="_types_discordconstantstypes_.discordconstantstype.html" class="tsd-signature-type">DiscordConstantsType</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>dispatcher<span class="tsd-signature-symbol">: </span><a href="_types_discorddispatchertypes_.dispatchertypes.html" class="tsd-signature-type">DispatcherTypes</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Internal Discord's dispatcher - can be used to subscribe to gateway events / client events.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="settings" class="tsd-anchor"></a>
|
|
<h3>Settings</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Settings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>callRingingBeat<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>devMode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/index.ts:77</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>call<wbr>Ringing<wbr>Beat<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>dev<wbr>Mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="globals ">
|
|
<a href="../globals.html"><em>Globals</em></a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="../modules/_index_.html">"index"</a>
|
|
<ul>
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_index_.__global.html">__global</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="_index_.lightcordglobal.html" class="tsd-kind-icon">Lightcord<wbr>Global</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_index_.lightcordglobal.html#api" class="tsd-kind-icon">Api</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_index_.lightcordglobal.html#betterdiscord" class="tsd-kind-icon">Better<wbr>Discord</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_index_.lightcordglobal.html#discordmodules" class="tsd-kind-icon">Discord<wbr>Modules</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_index_.lightcordglobal.html#settings" class="tsd-kind-icon">Settings</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_index_.html#lightcordapiglobal" class="tsd-kind-icon">Lightcord<wbr>Api<wbr>Global</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_index_.html#lightcordapimainexports" class="tsd-kind-icon">lightcord<wbr>Api<wbr>Main<wbr>Exports</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal tsd-parent-kind-module">
|
|
<a href="../modules/_index_.html#lightcordapi" class="tsd-kind-icon">Lightcord<wbr>Api</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-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
|
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</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> |