The cl-tetris3d Reference Manual

Table of Contents

The cl-tetris3d Reference Manual

This is the cl-tetris3d Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 09:50:55 2019 GMT+0.

1 Introduction

cl-tetris3d

Yet another 3D tetris.

How to run:

> (ql:quickload :cl-tetris3d)
> (cl-tetris3d:run)

Enjoy!

Controls:

• A - move figure left

• D - move figure right

• S - move figure down

• space - immediately land figure

• Q - rotate figure counterclockwise

• E - rotate figure clockwise

• P - pause/unpause

• Esc - quit

• left, right, up, down, page up, page down -- rotate and zoom camera

Make executable (SBCL Only!):

There are two ways to do it:

1. Run interpeter from shell (it doesn't work within Slime), and run the following commands from REPL:

> (ql:quickload :cl-tetris3d)
> (cl-tetris3d:make-executable)

2. Run ./sbcl-make-executable.run script

After that you should get the ./cl-tetris3d binary.

2 Systems

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

2.1 cl-tetris3d

Maintainer

Nedokushev Michael <michael.nedokushev@gmail.com>

Author

Nedokushev Michael <michael.nedokushev@gmail.com>

License

MIT (also see COPYING file for details)

Description

Yet another 3D Tetris clone

Version

0.0.1

Dependencies

• cl-opengl
• lispbuilder-sdl
• cl-glu
• iterate

Source

cl-tetris3d.asd (file)

Components

• package.lisp (file)
• tetris.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 cl-tetris3d.asd

Location

cl-tetris3d.asd

Systems

cl-tetris3d (system)

Packages

cl-tetris3d-asd

3.1.2 cl-tetris3d/package.lisp

Parent

cl-tetris3d (system)

Location

package.lisp

Packages

cl-tetris3d

3.1.3 cl-tetris3d/tetris.lisp

Dependency

package.lisp (file)

Parent

cl-tetris3d (system)

Location

tetris.lisp

Exported Definitions

• make-executable (function)
• run (function)

Internal Definitions

• *figures* (special variable)
• arena (class)
• body (method)
• (setf body) (method)
• build-cube (function)
• choose-figure (generic function)
• choose-figure (method)
• color (method)
• (setf color) (method)
• do-dotimes-twice (macro)
• draw-arena (generic function)
• draw-arena (method)
• draw-figure (generic function)
• draw-figure (method)
• draw-world (generic function)
• draw-world (method)
• field (method)
• (setf field) (method)
• figure (class)
• figure->arena (generic function)
• figure->arena (method)
• gl-init (function)
• height (method)
• (setf height) (method)
• move-figure (generic function)
• move-figure (method)
• random-color (function)
• rotate-collision-p (generic function)
• rotate-collision-p (method)
• rotate-figure-clockwise (generic function)
• rotate-figure-clockwise (method)
• rotate-figure-counterclockwise (generic function)
• rotate-figure-counterclockwise (method)
• vanish-lines (generic function)
• vanish-lines (method)
• width (method)
• (setf width) (method)
• x (method)
• (setf x) (method)
• x-d (method)
• (setf x-d) (method)
• y (method)
• (setf y) (method)

4 Packages

Packages are listed by definition order.

4.1 cl-tetris3d-asd

Source

cl-tetris3d.asd

Use List

• asdf/interface
• common-lisp

4.2 cl-tetris3d

Source

package.lisp (file)

Use List

• iterate
• common-lisp

Exported Definitions

• make-executable (function)
• run (function)

Internal Definitions

• *figures* (special variable)
• arena (class)
• body (generic function)
• body (method)
• (setf body) (method)
• (setf body) (generic function)
• build-cube (function)
• choose-figure (generic function)
• choose-figure (method)
• color (generic function)
• color (method)
• (setf color) (method)
• (setf color) (generic function)
• do-dotimes-twice (macro)
• draw-arena (generic function)
• draw-arena (method)
• draw-figure (generic function)
• draw-figure (method)
• draw-world (generic function)
• draw-world (method)
• field (generic function)
• field (method)
• (setf field) (method)
• (setf field) (generic function)
• figure (class)
• figure->arena (generic function)
• figure->arena (method)
• gl-init (function)
• height (generic function)
• height (method)
• (setf height) (method)
• (setf height) (generic function)
• move-figure (generic function)
• move-figure (method)
• random-color (function)
• rotate-collision-p (generic function)
• rotate-collision-p (method)
• rotate-figure-clockwise (generic function)
• rotate-figure-clockwise (method)
• rotate-figure-counterclockwise (generic function)
• rotate-figure-counterclockwise (method)
• vanish-lines (generic function)
• vanish-lines (method)
• width (generic function)
• width (method)
• (setf width) (method)
• (setf width) (generic function)
• x (generic function)
• x (method)
• (setf x) (method)
• (setf x) (generic function)
• x-d (generic function)
• x-d (method)
• (setf x-d) (method)
• (setf x-d) (generic function)
• y (generic function)
• y (method)
• (setf y) (method)
• (setf y) (generic function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: make-executable ()

Package

cl-tetris3d

Source

tetris.lisp (file)

Function: run &key WIDTH HEIGHT BPP

Package

cl-tetris3d

Source

tetris.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *figures*

Package

cl-tetris3d

Source

tetris.lisp (file)

5.2.2 Macros

Macro: do-dotimes-twice (H W) &body BODY

Package

cl-tetris3d

Source

tetris.lisp (file)

5.2.3 Functions

Function: build-cube HEIGHT WIDTH

Package

cl-tetris3d

Source

tetris.lisp (file)

Function: gl-init WIDTH HEIGHT

Package

cl-tetris3d

Source

tetris.lisp (file)

Function: random-color ()

Package

cl-tetris3d

Source

tetris.lisp (file)

5.2.4 Generic functions

Generic Function: body OBJECT

Generic Function: (setf body) NEW-VALUE OBJECT

Package

cl-tetris3d

Methods

Method: body (FIGURE figure)

automatically generated reader method

Source

tetris.lisp (file)

Method: (setf body) NEW-VALUE (FIGURE figure)

automatically generated writer method

Source

tetris.lisp (file)

Generic Function: choose-figure FIGURE ARENA

Package

cl-tetris3d

Source

tetris.lisp (file)

Methods

Method: choose-figure (FIGURE figure) (ARENA arena)

Generic Function: color OBJECT

Generic Function: (setf color) NEW-VALUE OBJECT

Package

cl-tetris3d

Methods

Method: color (FIGURE figure)

automatically generated reader method

Source

tetris.lisp (file)

Method: (setf color) NEW-VALUE (FIGURE figure)

automatically generated writer method

Source

tetris.lisp (file)

Generic Function: draw-arena ARENA

Package

cl-tetris3d

Source

tetris.lisp (file)

Methods

Method: draw-arena (ARENA arena)

Generic Function: draw-figure FIGURE ARENA

Package

cl-tetris3d

Source

tetris.lisp (file)

Methods

Method: draw-figure (FIGURE figure) (ARENA arena)

Generic Function: draw-world ARENA FIGURE &key X Y Z

Package

cl-tetris3d

Source

tetris.lisp (file)

Methods

Method: draw-world (ARENA arena) (FIGURE figure) &key X Y Z

Generic Function: field OBJECT

Generic Function: (setf field) NEW-VALUE OBJECT

Package

cl-tetris3d

Methods

Method: field (ARENA arena)

automatically generated reader method

Source

tetris.lisp (file)

Method: (setf field) NEW-VALUE (ARENA arena)

automatically generated writer method

Source

tetris.lisp (file)

Generic Function: figure->arena FIGURE ARENA

Package

cl-tetris3d

Source

tetris.lisp (file)

Methods

Method: figure->arena (FIGURE figure) (ARENA arena)

Generic Function: height OBJECT

Generic Function: (setf height) NEW-VALUE OBJECT

Package

cl-tetris3d

Methods

Method: height (ARENA arena)

automatically generated reader method

Source

tetris.lisp (file)

Method: (setf height) NEW-VALUE (ARENA arena)

automatically generated writer method

Source

tetris.lisp (file)

Generic Function: move-figure FIGURE ARENA &key MOVE-SIDEWAYS

Package

cl-tetris3d

Source

tetris.lisp (file)

Methods

Method: move-figure (FIGURE figure) (ARENA arena) &key MOVE-SIDEWAYS

Generic Function: rotate-collision-p FIGURE ARENA

Package

cl-tetris3d

Source

tetris.lisp (file)

Methods

Method: rotate-collision-p (FIGURE figure) (ARENA arena)

Generic Function: rotate-figure-clockwise FIGURE

Package

cl-tetris3d

Source

tetris.lisp (file)

Methods

Method: rotate-figure-clockwise (FIGURE figure)

Generic Function: rotate-figure-counterclockwise FIGURE

Package

cl-tetris3d

Source

tetris.lisp (file)

Methods

Method: rotate-figure-counterclockwise (FIGURE figure)

Generic Function: vanish-lines ARENA

Package

cl-tetris3d

Source

tetris.lisp (file)

Methods

Method: vanish-lines (ARENA arena)

Generic Function: width OBJECT

Generic Function: (setf width) NEW-VALUE OBJECT

Package

cl-tetris3d

Methods

Method: width (ARENA arena)

automatically generated reader method

Source

tetris.lisp (file)

Method: (setf width) NEW-VALUE (ARENA arena)

automatically generated writer method

Source

tetris.lisp (file)

Generic Function: x OBJECT

Generic Function: (setf x) NEW-VALUE OBJECT

Package

cl-tetris3d

Methods

Method: x (FIGURE figure)

automatically generated reader method

Source

tetris.lisp (file)

Method: (setf x) NEW-VALUE (FIGURE figure)

automatically generated writer method

Source

tetris.lisp (file)

Generic Function: x-d OBJECT

Generic Function: (setf x-d) NEW-VALUE OBJECT

Package

cl-tetris3d

Methods

Method: x-d (FIGURE figure)

automatically generated reader method

Source

tetris.lisp (file)

Method: (setf x-d) NEW-VALUE (FIGURE figure)

automatically generated writer method

Source

tetris.lisp (file)

Generic Function: y OBJECT

Generic Function: (setf y) NEW-VALUE OBJECT

Package

cl-tetris3d

Methods

Method: y (FIGURE figure)

automatically generated reader method

Source

tetris.lisp (file)

Method: (setf y) NEW-VALUE (FIGURE figure)

automatically generated writer method

Source

tetris.lisp (file)

5.2.5 Classes

Class: arena ()

Package

cl-tetris3d

Source

tetris.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• choose-figure (method)
• rotate-collision-p (method)
• move-figure (method)
• draw-figure (method)
• draw-world (method)
• figure->arena (method)
• vanish-lines (method)
• draw-arena (method)
• field (method)
• field (method)
• height (method)
• height (method)
• width (method)
• width (method)

Direct slots

Slot: width

Initargs

:width

Initform

8

Readers

width (generic function)

Writers

(setf width) (generic function)

Slot: height

Initargs

:height

Initform

12

Readers

height (generic function)

Writers

(setf height) (generic function)

Slot: field

Initargs

:field

Initform

(make-array (quote (12 8)) :initial-element nil)

Readers

field (generic function)

Writers

(setf field) (generic function)

Class: figure ()

Package

cl-tetris3d

Source

tetris.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• choose-figure (method)
• rotate-collision-p (method)
• move-figure (method)
• draw-figure (method)
• draw-world (method)
• figure->arena (method)
• rotate-figure-counterclockwise (method)
• rotate-figure-clockwise (method)
• body (method)
• body (method)
• color (method)
• color (method)
• x-d (method)
• x-d (method)
• y (method)
• y (method)
• x (method)
• x (method)

Direct slots

Slot: x

Initargs

:x

Initform

0

Readers

x (generic function)

Writers

(setf x) (generic function)

Slot: y

Initargs

:y

Initform

0

Readers

y (generic function)

Writers

(setf y) (generic function)

Slot: x-d

Initargs

:x-d

Initform

0

Readers

x-d (generic function)

Writers

(setf x-d) (generic function)

Slot: color

Initargs

:color

Initform

(cl-tetris3d::random-color)

Readers

color (generic function)

Writers

(setf color) (generic function)

Slot: body

Initargs

:body

Readers

body (generic function)

Writers

(setf body) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types