docs/03-reference.markdown @ 10d0e52e7ef3
Add a couple of simple tests
author |
Steve Losh <steve@stevelosh.com> |
date |
Thu, 11 Aug 2016 01:22:39 +0000 |
parents |
19f3ffd6181e |
children |
(none) |
# API Reference
The following is a list of all user-facing parts of Beast.
If there are backwards-incompatible changes to anything listed here, they will
be noted in the changelog and the author will feel bad.
Anything not listed here is subject to change at any time with no warning, so
don't touch it.
[TOC]
## Package `BEAST`
### `CLEAR-ENTITIES` (function)
(CLEAR-ENTITIES)
### `DEFINE-ASPECT` (macro)
(DEFINE-ASPECT NAME &REST FIELDS)
### `DEFINE-ENTITY` (macro)
(DEFINE-ENTITY NAME ASPECTS &REST SLOTS)
### `DEFINE-SYSTEM` (macro)
(DEFINE-SYSTEM NAME
ARGLIST
&BODY
BODY)
### `ENTITY` (class)
#### Slot `ID`
* Allocation: `:INSTANCE`
* Initform: `(INCF BEAST::*ENTITY-ID-COUNTER*)`
* Reader: `ENTITY-ID`
#### Slot `%BEAST/ASPECTS`
* Allocation: `:CLASS`
* Initform: `NIL`
### `ENTITY-CREATED` (generic function)
(ENTITY-CREATED ENTITY)
### `ENTITY-DESTROYED` (generic function)
(ENTITY-DESTROYED ENTITY)
### `GET-ENTITY` (function)
(GET-ENTITY ID)
### `MAP-ENTITIES` (function)
(MAP-ENTITIES FUNCTION &OPTIONAL (TYPE 'ENTITY))
### `RUN-SYSTEM` (function)
(RUN-SYSTEM SYSTEM)