The climon Reference Manual

This is the climon Reference Manual, version 0.7.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:47:07 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 climon

The Simon game.

Maintainer

Nicolas Lamirault <>

Author

Nicolas Lamirault <>

License

MIT License

Version

0.7.0

Dependency

pal (system).

Source

climon.asd.

Child Component

src (module).


3 Modules

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


3.1 climon/src

Source

climon.asd.

Parent Component

climon (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 climon/climon.asd

Source

climon.asd.

Parent Component

climon (system).

ASDF Systems

climon.


4.1.2 climon/src/package.lisp

Source

climon.asd.

Parent Component

src (module).

Packages

climon.


4.1.3 climon/src/specials.lisp

Dependency

package.lisp (file).

Source

climon.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.4 climon/src/climon.lisp

Dependency

specials.lisp (file).

Source

climon.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 climon

The SIMON game.

Source

package.lisp.

Use List
  • common-lisp.
  • pal.
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *debug*

When T, active some logs for debugging.

Package

climon.

Source

specials.lisp.

Special Variable: *version*
Package

climon.

Source

specials.lisp.


6.1.2 Ordinary functions

Function: climon ()

Start the SIMON game.

Package

climon.

Source

climon.lisp.

Function: climon-sequence (&optional sequence)

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

Package

climon.

Source

climon.lisp.

Function: climon-test ()

Some test with the SIMON game.

Package

climon.

Source

climon.lisp.


6.2 Internals


6.2.1 Constants

Constant: +base-color+
Package

climon.

Source

specials.lisp.

Constant: +blue-area+
Package

climon.

Source

specials.lisp.

Constant: +blue-color+
Package

climon.

Source

specials.lisp.

Constant: +blue-sound+
Package

climon.

Source

specials.lisp.

Constant: +green-area+
Package

climon.

Source

specials.lisp.

Constant: +green-color+
Package

climon.

Source

specials.lisp.

Constant: +green-sound+
Package

climon.

Source

specials.lisp.

Constant: +height+

The default height.

Package

climon.

Source

specials.lisp.

Constant: +red-area+
Package

climon.

Source

specials.lisp.

Constant: +red-color+
Package

climon.

Source

specials.lisp.

Constant: +red-sound+
Package

climon.

Source

specials.lisp.

Constant: +width+

The default width.

Package

climon.

Source

specials.lisp.

Constant: +yellow-area+
Package

climon.

Source

specials.lisp.

Constant: +yellow-color+
Package

climon.

Source

specials.lisp.

Constant: +yellow-sound+
Package

climon.

Source

specials.lisp.


6.2.2 Special variables

Special Variable: *climon-directory*

Directory with contains CLIMON source files.

Package

climon.

Source

specials.lisp.

Special Variable: *random*

The random sequence.

Package

climon.

Source

specials.lisp.

Special Variable: *score*

The user’s score.

Package

climon.

Source

specials.lisp.

Special Variable: *simon*

The current Simon image.

Package

climon.

Source

specials.lisp.

Special Variable: *simons*

All Simons.

Package

climon.

Source

specials.lisp.

Special Variable: *sound*

The current Simon sound.

Package

climon.

Source

specials.lisp.

Special Variable: *sounds*

All sound assiocated with the color.

Package

climon.

Source

specials.lisp.

Special Variable: *speed*
Package

climon.

Source

specials.lisp.

Special Variable: *user*

Rank of the user’s answer.

Package

climon.

Source

specials.lisp.


6.2.3 Ordinary functions

Function: add-random-simon ()

Get a new random sequence.

Package

climon.

Source

climon.lisp.

Function: check-area-from-mouse (x y)

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

Package

climon.

Source

climon.lisp.

Function: check-user-answer (color)

Check the current user COLOR from the random sequence.

Package

climon.

Source

climon.lisp.

Function: good-answer-p (color)

Verify if the current COLOR is correct.

Package

climon.

Source

climon.lisp.

Function: initialize-simon ()

Creates all Simons.

Package

climon.

Source

climon.lisp.

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.

Function: play-sequence ()

Draw the current color, and play the associated sound.

Package

climon.

Source

climon.lisp.

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.


6.2.4 Generic functions

Generic Function: draw (simon)

Draw a Simon game with or not activate color.

Package

climon.

Source

climon.lisp.

Methods
Method: draw ((s simon))
Generic Reader: simon-image (object)
Package

climon.

Methods
Reader Method: simon-image ((simon simon))

automatically generated reader method

Source

climon.lisp.

Target Slot

image.

Generic Writer: (setf simon-image) (object)
Package

climon.

Methods
Writer Method: (setf simon-image) ((simon simon))

automatically generated writer method

Source

climon.lisp.

Target Slot

image.


6.2.5 Classes

Class: simon
Package

climon.

Source

climon.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: image
Package

pal-ffi.

Initargs

:image

Readers

simon-image.

Writers

(setf simon-image).

Class: simon-base
Package

climon.

Source

climon.lisp.

Direct superclasses

simon.

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

climon.

Source

climon.lisp.

Direct superclasses

simon.

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

climon.

Source

climon.lisp.

Direct superclasses

simon.

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

climon.

Source

climon.lisp.

Direct superclasses

simon.

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

climon.

Source

climon.lisp.

Direct superclasses

simon.

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

Appendix A Indexes


A.1 Concepts


A.2 Functions

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

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

A
add-random-simon: Private ordinary functions

C
check-area-from-mouse: Private ordinary functions
check-user-answer: Private ordinary functions
climon: Public ordinary functions
climon-sequence: Public ordinary functions
climon-test: Public ordinary functions

D
draw: Private generic functions
draw: Private generic functions

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

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

I
initialize-simon: Private ordinary functions

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

P
play-sequence: Private ordinary functions

S
set-simon: Private ordinary functions
simon-image: Private generic functions
simon-image: Private generic functions


A.3 Variables

Jump to:   *   +  
C   I   S  
Index Entry  Section

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

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

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

I
image: Private classes

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