The climon Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The climon Reference Manual

This is the climon Reference Manual, version 0.7.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:31:38 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Climon

License MIT GitHub version

Master :

Develop:

This is the classic Simon game in Common Lisp.

Required softwares

You will need :

and dependencies :

$ sudo apt-get install libsdl1.2-dev libsdl-image1.2-dev libsdl-mixer1.2-dev

Installation

Commands

Available commands :

Screenshots

0.1

Development

Support / Contribute

See here

Changelog

A changelog is available here.

License

See LICENSE.

Contact

Nicolas Lamirault nicolas.lamirault@gmail.com


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 climon

Maintainer

Nicolas Lamirault <nicolas.lamirault@gmail.com>

Author

Nicolas Lamirault <nicolas.lamirault@gmail.com>

License

MIT License

Description

The Simon game.

Version

0.7.0

Dependency

pal

Source

climon.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Previous: , Up: Modules   [Contents][Index]

3.1 climon/src

Parent

climon (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 climon.asd

Location

climon.asd

Systems

climon (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 climon/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

climon


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 climon/src/specials.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/specials.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

4.1.4 climon/src/climon.lisp

Dependency

specials.lisp (file)

Parent

src (module)

Location

src/climon.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 climon

The SIMON game.

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *debug*

When T, active some logs for debugging.

Package

climon

Source

specials.lisp (file)

Special Variable: *version*
Package

climon

Source

specials.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: climon ()

Start the SIMON game.

Package

climon

Source

climon.lisp (file)

Function: climon-sequence &optional SEQUENCE

Start a test : Press SPACE to start a sequence of sound and color.

Package

climon

Source

climon.lisp (file)

Function: climon-test ()

Some test with the SIMON game.

Package

climon

Source

climon.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Constants

Constant: +base-color+
Package

climon

Source

specials.lisp (file)

Constant: +blue-area+
Package

climon

Source

specials.lisp (file)

Constant: +blue-color+
Package

climon

Source

specials.lisp (file)

Constant: +blue-sound+
Package

climon

Source

specials.lisp (file)

Constant: +green-area+
Package

climon

Source

specials.lisp (file)

Constant: +green-color+
Package

climon

Source

specials.lisp (file)

Constant: +green-sound+
Package

climon

Source

specials.lisp (file)

Constant: +height+

The default height.

Package

climon

Source

specials.lisp (file)

Constant: +red-area+
Package

climon

Source

specials.lisp (file)

Constant: +red-color+
Package

climon

Source

specials.lisp (file)

Constant: +red-sound+
Package

climon

Source

specials.lisp (file)

Constant: +width+

The default width.

Package

climon

Source

specials.lisp (file)

Constant: +yellow-area+
Package

climon

Source

specials.lisp (file)

Constant: +yellow-color+
Package

climon

Source

specials.lisp (file)

Constant: +yellow-sound+
Package

climon

Source

specials.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Special variables

Special Variable: *climon-directory*

Directory with contains CLIMON source files.

Package

climon

Source

specials.lisp (file)

Special Variable: *random*

The random sequence.

Package

climon

Source

specials.lisp (file)

Special Variable: *score*

The user’s score.

Package

climon

Source

specials.lisp (file)

Special Variable: *simon*

The current Simon image.

Package

climon

Source

specials.lisp (file)

Special Variable: *simons*

All Simons.

Package

climon

Source

specials.lisp (file)

Special Variable: *sound*

The current Simon sound.

Package

climon

Source

specials.lisp (file)

Special Variable: *sounds*

All sound assiocated with the color.

Package

climon

Source

specials.lisp (file)

Special Variable: *speed*
Package

climon

Source

specials.lisp (file)

Special Variable: *user*

Rank of the user’s answer.

Package

climon

Source

specials.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Functions

Function: add-random-simon ()

Get a new random sequence.

Package

climon

Source

climon.lisp (file)

Function: check-area-from-mouse X Y

If the mouse is over a color, update the screen.

Package

climon

Source

climon.lisp (file)

Function: check-user-answer COLOR

Check the current user COLOR from the random sequence.

Package

climon

Source

climon.lisp (file)

Function: good-answer-p COLOR

Verify if the current COLOR is correct.

Package

climon

Source

climon.lisp (file)

Function: initialize-simon ()

Creates all Simons.

Package

climon

Source

climon.lisp (file)

Function: mouse-in-area-p AREA X Y

Check if the mouse with X and Y coordonates is over the AREA.

Package

climon

Source

climon.lisp (file)

Function: play-sequence ()

Draw the current color, and play the associated sound.

Package

climon

Source

climon.lisp (file)

Function: set-simon COLOR

Set current Simon sound and image with the specified COLOR which could be :yellow, :blue, :red or :green.

Package

climon

Source

climon.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Generic functions

Generic Function: draw SIMON

Draw a Simon game with or not activate color.

Package

climon

Source

climon.lisp (file)

Methods
Method: draw (S simon)
Generic Function: simon-image OBJECT
Generic Function: (setf simon-image) NEW-VALUE OBJECT
Package

climon

Methods
Method: simon-image (SIMON simon)

automatically generated reader method

Source

climon.lisp (file)

Method: (setf simon-image) NEW-VALUE (SIMON simon)

automatically generated writer method

Source

climon.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.5 Classes

Class: simon ()
Package

climon

Source

climon.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: image
Initargs

:image

Readers

simon-image (generic function)

Writers

(setf simon-image) (generic function)

Class: simon-base ()
Package

climon

Source

climon.lisp (file)

Direct superclasses

simon (class)

Direct Default Initargs
InitargValue
:image(pal:tag (quote climon::simon-base))
Class: simon-blue ()
Package

climon

Source

climon.lisp (file)

Direct superclasses

simon (class)

Direct Default Initargs
InitargValue
:image(pal:tag (quote climon::simon-blue))
Class: simon-green ()
Package

climon

Source

climon.lisp (file)

Direct superclasses

simon (class)

Direct Default Initargs
InitargValue
:image(pal:tag (quote climon::simon-green))
Class: simon-red ()
Package

climon

Source

climon.lisp (file)

Direct superclasses

simon (class)

Direct Default Initargs
InitargValue
:image(pal:tag (quote climon::simon-red))
Class: simon-yellow ()
Package

climon

Source

climon.lisp (file)

Direct superclasses

simon (class)

Direct Default Initargs
InitargValue
:image(pal:tag (quote climon::simon-yellow))

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
climon.asd: The climon<dot>asd file
climon/src: The climon/src module
climon/src/climon.lisp: The climon/src/climon<dot>lisp file
climon/src/package.lisp: The climon/src/package<dot>lisp file
climon/src/specials.lisp: The climon/src/specials<dot>lisp file

F
File, Lisp, climon.asd: The climon<dot>asd file
File, Lisp, climon/src/climon.lisp: The climon/src/climon<dot>lisp file
File, Lisp, climon/src/package.lisp: The climon/src/package<dot>lisp file
File, Lisp, climon/src/specials.lisp: The climon/src/specials<dot>lisp file

L
Lisp File, climon.asd: The climon<dot>asd file
Lisp File, climon/src/climon.lisp: The climon/src/climon<dot>lisp file
Lisp File, climon/src/package.lisp: The climon/src/package<dot>lisp file
Lisp File, climon/src/specials.lisp: The climon/src/specials<dot>lisp file

M
Module, climon/src: The climon/src module

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   C   D   F   G   I   M   P   S  
Index Entry  Section

(
(setf simon-image): Internal generic functions
(setf simon-image): Internal generic functions

A
add-random-simon: Internal functions

C
check-area-from-mouse: Internal functions
check-user-answer: Internal functions
climon: Exported functions
climon-sequence: Exported functions
climon-test: Exported functions

D
draw: Internal generic functions
draw: Internal generic functions

F
Function, add-random-simon: Internal functions
Function, check-area-from-mouse: Internal functions
Function, check-user-answer: Internal functions
Function, climon: Exported functions
Function, climon-sequence: Exported functions
Function, climon-test: Exported functions
Function, good-answer-p: Internal functions
Function, initialize-simon: Internal functions
Function, mouse-in-area-p: Internal functions
Function, play-sequence: Internal functions
Function, set-simon: Internal functions

G
Generic Function, (setf simon-image): Internal generic functions
Generic Function, draw: Internal generic functions
Generic Function, simon-image: Internal generic functions
good-answer-p: Internal functions

I
initialize-simon: Internal functions

M
Method, (setf simon-image): Internal generic functions
Method, draw: Internal generic functions
Method, simon-image: Internal generic functions
mouse-in-area-p: Internal functions

P
play-sequence: Internal functions

S
set-simon: Internal functions
simon-image: Internal generic functions
simon-image: Internal generic functions

Jump to:   (  
A   C   D   F   G   I   M   P   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
C   I   S  
Index Entry  Section

*
*climon-directory*: Internal special variables
*debug*: Exported special variables
*random*: Internal special variables
*score*: Internal special variables
*simon*: Internal special variables
*simons*: Internal special variables
*sound*: Internal special variables
*sounds*: Internal special variables
*speed*: Internal special variables
*user*: Internal special variables
*version*: Exported special variables

+
+base-color+: Internal constants
+blue-area+: Internal constants
+blue-color+: Internal constants
+blue-sound+: Internal constants
+green-area+: Internal constants
+green-color+: Internal constants
+green-sound+: Internal constants
+height+: Internal constants
+red-area+: Internal constants
+red-color+: Internal constants
+red-sound+: Internal constants
+width+: Internal constants
+yellow-area+: Internal constants
+yellow-color+: Internal constants
+yellow-sound+: Internal constants

C
Constant, +base-color+: Internal constants
Constant, +blue-area+: Internal constants
Constant, +blue-color+: Internal constants
Constant, +blue-sound+: Internal constants
Constant, +green-area+: Internal constants
Constant, +green-color+: Internal constants
Constant, +green-sound+: Internal constants
Constant, +height+: Internal constants
Constant, +red-area+: Internal constants
Constant, +red-color+: Internal constants
Constant, +red-sound+: Internal constants
Constant, +width+: Internal constants
Constant, +yellow-area+: Internal constants
Constant, +yellow-color+: Internal constants
Constant, +yellow-sound+: Internal constants

I
image: Internal classes

S
Slot, image: Internal classes
Special Variable, *climon-directory*: Internal special variables
Special Variable, *debug*: Exported special variables
Special Variable, *random*: Internal special variables
Special Variable, *score*: Internal special variables
Special Variable, *simon*: Internal special variables
Special Variable, *simons*: Internal special variables
Special Variable, *sound*: Internal special variables
Special Variable, *sounds*: Internal special variables
Special Variable, *speed*: Internal special variables
Special Variable, *user*: Internal special variables
Special Variable, *version*: Exported special variables

Jump to:   *   +  
C   I   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
Class, simon: Internal classes
Class, simon-base: Internal classes
Class, simon-blue: Internal classes
Class, simon-green: Internal classes
Class, simon-red: Internal classes
Class, simon-yellow: Internal classes
climon: The climon system
climon: The climon package

P
Package, climon: The climon package

S
simon: Internal classes
simon-base: Internal classes
simon-blue: Internal classes
simon-green: Internal classes
simon-red: Internal classes
simon-yellow: Internal classes
System, climon: The climon system

Jump to:   C   P   S