This is the escalator Reference Manual, version 0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Mar 15 05:59:30 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
escalatorAn experimental object system for high-performance games.
Elliott Slaughter <elliottslaughter@gmail.com>
MIT
0.0
iterate (system).
src (module).
Modules are listed depth-first from the system components tree.
escalator/srcescalator (system).
package.lisp (file).
entity.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
escalator/src/entity.lisppackage.lisp (file).
src (module).
defcomponent (macro).
defsystem (macro).
entity-component (function).
(setf entity-component) (function).
make-entity (function).
system-loop (macro).
*component-data* (special variable).
*component-meta* (special variable).
*system-code* (special variable).
component-data (function).
(setf component-data) (function).
component-meta (function).
(setf component-meta) (function).
contains-circularity-p (function).
dependency-index (function).
field-index (function).
next-uuid (function).
print-table (function).
system-code (function).
(setf system-code) (function).
total-order (function).
Packages are listed by definition order.
escalatorescl
common-lisp.
iterate.
defcomponent (macro).
defsystem (macro).
entity-component (function).
(setf entity-component) (function).
make-entity (function).
system-loop (macro).
*component-data* (special variable).
*component-meta* (special variable).
*system-code* (special variable).
component-data (function).
(setf component-data) (function).
component-meta (function).
(setf component-meta) (function).
contains-circularity-p (function).
dependency-index (function).
field-index (function).
next-uuid (function).
print-table (function).
system-code (function).
(setf system-code) (function).
total-order (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Defines a new component with the given dependencies and fields.
Internal:
* Error if name isn’t a non-nil symbol.
* Error if dependencies contains a non-symbol or nil.
* Error if fields contains a non-symbol or nil.
* Error if dependency doesn’t exist.
* Error if dependencies include self.
* Error if dependencies cause cycle in component precendence list.
* Warn on redefinition of component.
* Warn if field hides a previously defined field for any component.
* Adds component entry to *component-meta*
(name -> deps * fields * initargs * size).
* Defines macros for each field accessor.
* Initializes global hash-table for component in *component-data*.
Defines a system for the given component.
Internal:
* Error if name, entity, and component aren’t non-nil symbols.
* Error if dependencies aren’t symbols (nil allowed).
* Error if name doesn’t refer to a defined component.
* Error if number of dependencies doesn’t match component.
* Warns on redefinition of system.
* Stores code to operate on component data.
Returns the component instance for entity or nil.
Instantiates an entity from the given prototype (shallow copy) and
additionally associated with the specified components.
Internal:
* Error if any component doesn’t exist.
* Enforce uniqueness of components by pushing into a new list.
* Shallow copy prototype components.
* Instantiate new components (overwrite if they already exist).
* Copy references to dependencies (error if it doesn’t exist).
| Jump to: | (
C D E F M N P S T |
|---|
| Jump to: | (
C D E F M N P S T |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | E F M P S |
|---|
| Jump to: | E F M P S |
|---|