hg.stevelosh.com > docs.stevelosh.com

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8"/>
        <title> API Reference / beast</title>
        <link rel="stylesheet" href="../_dmedia/tango.css"/>
        <link rel="stylesheet/less" type="text/css" href="../_dmedia/style.less"/>
        <script src="../_dmedia/less.js" type="text/javascript">
        </script>
    </head>
    <body class="content">
        <div class="wrap">
            <header><h1><a href="..">beast</a></h1></header>
                <div class="markdown">
<h1 id="api-reference"><a href="">API Reference</a></h1><p>The following is a list of all user-facing parts of Beast.</p>
<p>If there are backwards-incompatible changes to anything listed here, they will
be noted in the changelog and the author will feel bad.</p>
<p>Anything not listed here is subject to change at any time with no warning, so
don't touch it.</p>
<div class="toc">
<ul>
<li><a href="#package-beast">Package BEAST</a><ul>
<li><a href="#clear-entities-function">CLEAR-ENTITIES (function)</a></li>
<li><a href="#create-entity-function">CREATE-ENTITY (function)</a></li>
<li><a href="#define-aspect-macro">DEFINE-ASPECT (macro)</a></li>
<li><a href="#define-entity-macro">DEFINE-ENTITY (macro)</a></li>
<li><a href="#define-system-macro">DEFINE-SYSTEM (macro)</a></li>
<li><a href="#destroy-entity-function">DESTROY-ENTITY (function)</a></li>
<li><a href="#entity-class">ENTITY (class)</a><ul>
<li><a href="#slot-id">Slot ID</a></li>
<li><a href="#slot-beastaspects">Slot %BEAST/ASPECTS</a></li>
</ul>
</li>
<li><a href="#entity-created-generic-function">ENTITY-CREATED (generic function)</a></li>
<li><a href="#entity-destroyed-generic-function">ENTITY-DESTROYED (generic function)</a></li>
<li><a href="#get-entity-function">GET-ENTITY (function)</a></li>
<li><a href="#map-entities-function">MAP-ENTITIES (function)</a></li>
</ul>
</li>
</ul></div>
<h2 id="package-beast">Package <code>BEAST</code></h2>
<h3 id="clear-entities-function"><code>CLEAR-ENTITIES</code> (function)</h3>
<div class="codehilite"><pre>(CLEAR-ENTITIES)
</pre></div>


<h3 id="create-entity-function"><code>CREATE-ENTITY</code> (function)</h3>
<div class="codehilite"><pre>(CREATE-ENTITY CLASS &amp;REST INITARGS)
</pre></div>


<h3 id="define-aspect-macro"><code>DEFINE-ASPECT</code> (macro)</h3>
<div class="codehilite"><pre>(DEFINE-ASPECT NAME &amp;REST FIELDS)
</pre></div>


<h3 id="define-entity-macro"><code>DEFINE-ENTITY</code> (macro)</h3>
<div class="codehilite"><pre>(DEFINE-ENTITY NAME ASPECTS &amp;REST SLOTS)
</pre></div>


<h3 id="define-system-macro"><code>DEFINE-SYSTEM</code> (macro)</h3>
<div class="codehilite"><pre>(DEFINE-SYSTEM NAME-AND-OPTIONS
    ARGLIST
  &amp;BODY
  BODY)
</pre></div>


<h3 id="destroy-entity-function"><code>DESTROY-ENTITY</code> (function)</h3>
<div class="codehilite"><pre>(DESTROY-ENTITY ENTITY)
</pre></div>


<h3 id="entity-class"><code>ENTITY</code> (class)</h3>
<h4 id="slot-id">Slot <code>ID</code></h4>
<ul>
<li>Allocation: <code>:INSTANCE</code></li>
<li>Initform: <code>(INCF BEAST::*ENTITY-ID-COUNTER*)</code></li>
<li>Reader: <code>ENTITY-ID</code></li>
</ul>
<h4 id="slot-beastaspects">Slot <code>%BEAST/ASPECTS</code></h4>
<ul>
<li>Allocation: <code>:CLASS</code></li>
<li>Initform: <code>NIL</code></li>
</ul>
<h3 id="entity-created-generic-function"><code>ENTITY-CREATED</code> (generic function)</h3>
<div class="codehilite"><pre>(ENTITY-CREATED ENTITY)
</pre></div>


<h3 id="entity-destroyed-generic-function"><code>ENTITY-DESTROYED</code> (generic function)</h3>
<div class="codehilite"><pre>(ENTITY-DESTROYED ENTITY)
</pre></div>


<h3 id="get-entity-function"><code>GET-ENTITY</code> (function)</h3>
<div class="codehilite"><pre>(GET-ENTITY ID)
</pre></div>


<h3 id="map-entities-function"><code>MAP-ENTITIES</code> (function)</h3>
<div class="codehilite"><pre>(MAP-ENTITIES FUNCTION &amp;OPTIONAL (TYPE 'ENTITY))
</pre></div>
                </div>
            <footer><p><i>Made with Lisp and love by <a href="http://stevelosh.com/">Steve Losh</a> in Reykjavík, Iceland.</i></p>
<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-15328874-3', 'auto');
  ga('send', 'pageview');

</script></footer>
        </div>
    </body>
</html>
author	Steve Losh <steve@stevelosh.com>
date	Thu, 11 Aug 2016 04:57:15 +0000
parents	e39f82a93a1d
children	1ce97acb6755