The escalator Reference Manual

Table of Contents

The escalator Reference Manual

This is the escalator Reference Manual, version 0.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:44:35 2018 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 escalator

Author

Elliott Slaughter <elliottslaughter@gmail.com>

License

MIT

Description

An experimental object system for high-performance games.

Version

0.0

Dependency

iterate

Source

escalator.asd (file)

Component

src (module)

2 Modules

Modules are listed depth-first from the system components tree.

2.1 escalator/src

Parent

escalator (system)

Location

src/

Components

• package.lisp (file)
• entity.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 escalator.asd

Location

escalator.asd

Systems

escalator (system)

Packages

escalator-asd

3.1.2 escalator/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

escalator

3.1.3 escalator/src/entity.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/entity.lisp

Exported Definitions

• defcomponent (macro)
• defsystem (macro)
• entity-component (function)
• (setf entity-component) (function)
• make-entity (function)
• system-loop (macro)

Internal Definitions

• *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)

4 Packages

Packages are listed by definition order.

4.1 escalator-asd

Source

escalator.asd

Use List

• asdf/interface
• common-lisp

4.2 escalator

Source

package.lisp (file)

Nickname

escl

Use List

• iterate
• common-lisp

Exported Definitions

• defcomponent (macro)
• defsystem (macro)
• entity-component (function)
• (setf entity-component) (function)
• make-entity (function)
• system-loop (macro)

Internal Definitions

• *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)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Macros

Macro: defcomponent NAME (&rest DEPENDENCIES) (&rest FIELDS)

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*.

Package

escalator

Source

entity.lisp (file)

Macro: defsystem NAME (ENTITY COMPONENT &rest DEPENDENCIES) &body BODY

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.

Package

escalator

Source

entity.lisp (file)

Macro: system-loop ()

Package

escalator

Source

entity.lisp (file)

5.1.2 Functions

Function: entity-component ENTITY COMPONENT

Returns the component instance for entity or nil.

Package

escalator

Source

entity.lisp (file)

Writer

(setf entity-component) (function)

Function: (setf entity-component) VALUE ENTITY COMPONENT

Package

escalator

Source

entity.lisp (file)

Reader

entity-component (function)

Function: make-entity PROTOTYPE COMPONENTS &rest INITARGS

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).

Package

escalator

Source

entity.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *component-data*

Package

escalator

Source

entity.lisp (file)

Special Variable: *component-meta*

Package

escalator

Source

entity.lisp (file)

Special Variable: *system-code*

Package

escalator

Source

entity.lisp (file)

5.2.2 Functions

Function: component-data COMPONENT

Function: (setf component-data) VALUE COMPONENT

Package

escalator

Source

entity.lisp (file)

Function: component-meta COMPONENT

Function: (setf component-meta) VALUE COMPONENT

Package

escalator

Source

entity.lisp (file)

Function: contains-circularity-p GRAPH

Package

escalator

Source

entity.lisp (file)

Function: dependency-index COMPONENT DEPENDENCY

Package

escalator

Source

entity.lisp (file)

Function: field-index COMPONENT FIELD

Package

escalator

Source

entity.lisp (file)

Function: next-uuid ()

Package

escalator

Source

entity.lisp (file)

Function: print-table TABLE

Package

escalator

Source

entity.lisp (file)

Function: system-code COMPONENT

Function: (setf system-code) VALUE COMPONENT

Package

escalator

Source

entity.lisp (file)

Function: total-order GRAPH

Package

escalator

Source

entity.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types