<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: Extension
— Documentation by YARD 0.9.26
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "extension";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="file_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="a_index.html">Index</a> »
<span class="title">File: Extension</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'><h1 id="extension">Extension</h1>
<p>Extension allows you to split your code into multiple files.</p>
<h2 id="make-a-new-extension">Make a new extension</h2>
<p>Make a new module, and extend <span class='object_link'><a href="Discorb/Extension.html" title="Discorb::Extension (module)">Discorb::Extension</a></span>.</p>
<pre class="code ruby"><code class="ruby"><span class='kw'>module</span> <span class='const'>MyExtension</span>
<span class='id identifier rubyid_extend'>extend</span> <span class='const'><span class='object_link'><a href="Discorb.html" title="Discorb (module)">Discorb</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Discorb/Extension.html" title="Discorb::Extension (module)">Extension</a></span></span>
<span class='comment'># ...
</span><span class='kw'>end</span>
</code></pre>
<h2 id="register-event">Register Event</h2>
<p>Use <span class='object_link'><a href="Discorb/Extension.html#event-instance_method" title="Discorb::Extension#event (method)">Discorb::Extension#event</a></span> to register event, or <span class='object_link'><a href="Discorb/Extension.html#once_event-instance_method" title="Discorb::Extension#once_event (method)">Discorb::Extension#once_event</a></span> to register event only once.</p>
<pre class="code ruby"><code class="ruby"><span class='kw'>module</span> <span class='const'>MyExtension</span>
<span class='id identifier rubyid_extend'>extend</span> <span class='const'><span class='object_link'><a href="Discorb.html" title="Discorb (module)">Discorb</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Discorb/Extension.html" title="Discorb::Extension (module)">Extension</a></span></span>
<span class='id identifier rubyid_event'>event</span> <span class='symbol'>:message</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_message'>message</span><span class='op'>|</span>
<span class='comment'># ...
</span> <span class='kw'>end</span>
<span class='id identifier rubyid_once_event'>once_event</span> <span class='symbol'>:ready</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_message'>message</span><span class='op'>|</span>
<span class='comment'># ...
</span> <span class='kw'>end</span>
<span class='kw'>end</span>
</code></pre>
<h2 id="load-extension">Load extension</h2>
<p>Use <span class='object_link'><a href="Discorb/Client.html#extend-instance_method" title="Discorb::Client#extend (method)">Discorb::Client#extend</a></span> to load extension.</p>
<h2 id="access-client-from-extension">Access Client from extension</h2>
<p>You can access <span class='object_link'><a href="Discorb/Client.html" title="Discorb::Client (class)">Discorb::Client</a></span> from extension with <code>@client</code>.</p>
<pre class="code ruby"><code class="ruby"><span class='kw'>module</span> <span class='const'>MyExtension</span>
<span class='id identifier rubyid_extend'>extend</span> <span class='const'><span class='object_link'><a href="Discorb.html" title="Discorb (module)">Discorb</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Discorb/Extension.html" title="Discorb::Extension (module)">Extension</a></span></span>
<span class='id identifier rubyid_event'>event</span> <span class='symbol'>:ready</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_message'>message</span><span class='op'>|</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Logged in as </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
</code></pre>
</div></div>
<div id="footer">
Generated from <a href="https://github.com/discorb-lib/discorb/tree/e42155c96632cd1f891ad5425c91656880213a05"><code>e42155c96632cd1f891ad5425c91656880213a05</code></a>, version (main), with YARD 0.9.26.
</div>
</div>
</body>
</html>