The sucle Reference Manual

Table of Contents

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

The sucle Reference Manual

This is the sucle Reference Manual, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 15:05:46 2019 GMT+0.


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

1 Introduction

Minecraft in lisp !

click for video:
IMAGE ALT TEXT HERE

This One Weird Repo Microsoft Doesn't Want You To Know Will :astonished:Change Your Life :weary: [SECRET]

-_-
-_-
-_-
-_-
-_-
-_-
-_-
-_-
-_-
-_-
0_-
0_0 0_0 :pill:
:gem:
:bomb:
:meat_on_bone:
0_0

5 Reasons Why Your Life Will Change. Or not.

  1. Want to improve your coding skills? You can code While Playing 'minecraft

  2. Been wanting to play Minecraft but can't afford it? Well here you go.

  3. An Open Source license means no one can steal and destroy your items. AKA Notch, Jeb, Mojang, and Microsoft...

  4. Do you want to build the city of your dreams? To become the master of the world you inhabit and wreak destruction on the natural environment? Unfortunately cube programs all too often fail to give their users what they really want. What makes this repo different? Everything here is 100% Pure Free and Open Source Common Lisp. If you are not familiar with Common Lisp, do yourself a favor and click here.

:gem:
:pill:
:meat_on_bone:
:pill:
:meat_on_bone: (ノ◕ヮ◕)ノ :gem:
:bomb: :meat_on_bone:
0_0 :bomb: :pill: :meat_on_bone:
:bomb: :gem:
:meat_on_bone: :gem:
:bomb: :pill: :gem:
:bomb: :meat_on_bone: :gem:
:pill: :meat_on_bone: :pill: :meat_on_bone: (ノ◕ヮ◕)ノ :gem:
:bomb: :meat_on_bone: :bomb: :pill: :meat_on_bone: :bomb: :meat_on_bone: :bomb: :pill: :meat_on_bone: :bomb: :meat_on_bone: :gem:
:bomb: :pill: :gem:
:bomb: :meat_on_bone: :gem: :meat_on_bone: :gem: :bomb: :gem: :gem: :pill: :meat_on_bone: :pill: :meat_on_bone: (ノ◕ヮ◕)ノ :gem:
:bomb:

The Most Moddable Voxel Engine That Has Ever Existed

Features:

Personal Workflow:

  1. Generate a world based on perlin noise or some random function
  2. Fly around touching up the world with different "brushes" to use on the world. Create brushes at the REPL or in a source file and C-C C-C it
  1. Use the resulting terrain as the ultimate parkour experience
  2. Repeat 2-3
  3. Be a creative and interesting and artistic mineman pvp parkour legend

Please let me know if you:

How To Install:

https://github.com/pupcraft


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 sucle

Author

terminal625

License

MIT

Description

Cube Demo Game

Dependencies
Source

sucle.asd (file)

Component

basic0.lisp (file)


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

3 Files

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


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

3.1 Lisp


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

3.1.1 sucle.asd

Location

sucle.asd

Systems

sucle (system)


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

3.1.2 sucle/basic0.lisp

Parent

sucle (system)

Location

basic0.lisp

Packages

sucle

Exported Definitions

start (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 sucle

Source

basic0.lisp (file)

Use List
Exported Definitions

start (function)

Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Functions

Function: start ()
Package

sucle

Source

basic0.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *app*
Package

sucle

Source

basic0.lisp (file)

Special Variable: *drag-offset-x*
Package

sucle

Source

basic0.lisp (file)

Special Variable: *drag-offset-y*
Package

sucle

Source

basic0.lisp (file)

Special Variable: *glyph-height*
Package

sucle

Source

basic0.lisp (file)

Special Variable: *glyph-width*
Package

sucle

Source

basic0.lisp (file)

Special Variable: *hovering*
Package

sucle

Source

basic0.lisp (file)

Special Variable: *mouse-x*
Package

sucle

Source

basic0.lisp (file)

Special Variable: *mouse-y*
Package

sucle

Source

basic0.lisp (file)

Special Variable: *saved-session*
Package

sucle

Source

basic0.lisp (file)

Special Variable: *selection*
Package

sucle

Source

basic0.lisp (file)

Special Variable: *sprite-chain-stack*
Package

sucle

Source

basic0.lisp (file)

Special Variable: *sprite-chain-stack-depth*
Package

sucle

Source

basic0.lisp (file)

Special Variable: *ticks*
Package

sucle

Source

basic0.lisp (file)


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

5.2.2 Functions

Function: app ()
Package

sucle

Source

basic0.lisp (file)

Function: bottom-layer ()
Package

sucle

Source

basic0.lisp (file)

Function: bytecolor R G B &optional A

each channel is from 0 to 3

Package

sucle

Source

basic0.lisp (file)

Function: closest-multiple X N
Package

sucle

Source

basic0.lisp (file)

Function: draw-string X Y STRING &optional FGCOL BGCOL BOLD-P UNDERLINE-P
Package

sucle

Source

basic0.lisp (file)

Function: init ()
Package

sucle

Source

basic0.lisp (file)

Function: integer-point X Y
Package

sucle

Source

basic0.lisp (file)

Function: new-layer ()
Package

sucle

Source

basic0.lisp (file)

Function: our-load ()
Package

sucle

Source

basic0.lisp (file)

Function: per-frame ()
Package

sucle

Source

basic0.lisp (file)

Function: plain-button FUN &optional STR POS SPRITE

a statically named button

Package

sucle

Source

basic0.lisp (file)

Function: pop-sprite-chain-stack ()
Package

sucle

Source

basic0.lisp (file)

Function: push-sprite-chain-stack &optional NEW-TOP
Package

sucle

Source

basic0.lisp (file)

Function: random-point ()
Package

sucle

Source

basic0.lisp (file)

Function: render-stuff ()
Package

sucle

Source

basic0.lisp (file)

Function: replace-sprite-chain-stack ()
Package

sucle

Source

basic0.lisp (file)

Function: save ()
Package

sucle

Source

basic0.lisp (file)

Function: string-bounding-box STRING &optional RECTANGLE
Package

sucle

Source

basic0.lisp (file)

Function: string-bounds STRING
Package

sucle

Source

basic0.lisp (file)

Function: update-bounds SPRITE
Package

sucle

Source

basic0.lisp (file)


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

5.2.3 Generic functions

Generic Function: sprite.absolute-rectangle OBJECT
Generic Function: (setf sprite.absolute-rectangle) NEW-VALUE OBJECT
Package

sucle

Methods
Method: sprite.absolute-rectangle (SPRITE sprite)

automatically generated reader method

Source

basic0.lisp (file)

Method: (setf sprite.absolute-rectangle) NEW-VALUE (SPRITE sprite)

automatically generated writer method

Source

basic0.lisp (file)

Generic Function: sprite.bounding-box OBJECT
Generic Function: (setf sprite.bounding-box) NEW-VALUE OBJECT
Package

sucle

Methods
Method: sprite.bounding-box (SPRITE sprite)

automatically generated reader method

Source

basic0.lisp (file)

Method: (setf sprite.bounding-box) NEW-VALUE (SPRITE sprite)

automatically generated writer method

Source

basic0.lisp (file)

Generic Function: sprite.onclick OBJECT
Generic Function: (setf sprite.onclick) NEW-VALUE OBJECT
Package

sucle

Methods
Method: sprite.onclick (SPRITE sprite)

automatically generated reader method

Source

basic0.lisp (file)

Method: (setf sprite.onclick) NEW-VALUE (SPRITE sprite)

automatically generated writer method

Source

basic0.lisp (file)

Generic Function: sprite.position OBJECT
Generic Function: (setf sprite.position) NEW-VALUE OBJECT
Package

sucle

Methods
Method: sprite.position (SPRITE sprite)

automatically generated reader method

Source

basic0.lisp (file)

Method: (setf sprite.position) NEW-VALUE (SPRITE sprite)

automatically generated writer method

Source

basic0.lisp (file)

Generic Function: sprite.string OBJECT
Generic Function: (setf sprite.string) NEW-VALUE OBJECT
Package

sucle

Methods
Method: sprite.string (SPRITE sprite)

automatically generated reader method

Source

basic0.lisp (file)

Method: (setf sprite.string) NEW-VALUE (SPRITE sprite)

automatically generated writer method

Source

basic0.lisp (file)

Generic Function: sprite.tickfun OBJECT
Generic Function: (setf sprite.tickfun) NEW-VALUE OBJECT
Package

sucle

Methods
Method: sprite.tickfun (SPRITE sprite)

automatically generated reader method

Source

basic0.lisp (file)

Method: (setf sprite.tickfun) NEW-VALUE (SPRITE sprite)

automatically generated writer method

Source

basic0.lisp (file)


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

5.2.4 Classes

Class: sprite ()
Package

sucle

Source

basic0.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: bounding-box
Initargs

:bounding-box

Initform

(make-instance (quote rectangle:rectangle) :x0 -0.25 :y0 -0.25 :x1 0.25 :y1 0.25)

Readers

sprite.bounding-box (generic function)

Writers

(setf sprite.bounding-box) (generic function)

Slot: absolute-rectangle
Initargs

:absolute-rectangle

Initform

(make-instance (quote rectangle:rectangle))

Readers

sprite.absolute-rectangle (generic function)

Writers

(setf sprite.absolute-rectangle) (generic function)

Slot: string
Initargs

:string

Initform

"hello world"

Readers

sprite.string (generic function)

Writers

(setf sprite.string) (generic function)

Slot: tickfun
Initargs

:tickfun

Readers

sprite.tickfun (generic function)

Writers

(setf sprite.tickfun) (generic function)

Slot: onclick
Initargs

:onclick

Readers

sprite.onclick (generic function)

Writers

(setf sprite.onclick) (generic function)

Slot: position
Initargs

:position

Initform

(make-instance (quote point:point))

Readers

sprite.position (generic function)

Writers

(setf sprite.position) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

F
File, Lisp, sucle.asd: The sucle<dot>asd file
File, Lisp, sucle/basic0.lisp: The sucle/basic0<dot>lisp file

L
Lisp File, sucle.asd: The sucle<dot>asd file
Lisp File, sucle/basic0.lisp: The sucle/basic0<dot>lisp file

S
sucle.asd: The sucle<dot>asd file
sucle/basic0.lisp: The sucle/basic0<dot>lisp file

Jump to:   F   L   S  

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

A.2 Functions

Jump to:   (  
A   B   C   D   F   G   I   M   N   O   P   R   S   U  
Index Entry  Section

(
(setf sprite.absolute-rectangle): Internal generic functions
(setf sprite.absolute-rectangle): Internal generic functions
(setf sprite.bounding-box): Internal generic functions
(setf sprite.bounding-box): Internal generic functions
(setf sprite.onclick): Internal generic functions
(setf sprite.onclick): Internal generic functions
(setf sprite.position): Internal generic functions
(setf sprite.position): Internal generic functions
(setf sprite.string): Internal generic functions
(setf sprite.string): Internal generic functions
(setf sprite.tickfun): Internal generic functions
(setf sprite.tickfun): Internal generic functions

A
app: Internal functions

B
bottom-layer: Internal functions
bytecolor: Internal functions

C
closest-multiple: Internal functions

D
draw-string: Internal functions

F
Function, app: Internal functions
Function, bottom-layer: Internal functions
Function, bytecolor: Internal functions
Function, closest-multiple: Internal functions
Function, draw-string: Internal functions
Function, init: Internal functions
Function, integer-point: Internal functions
Function, new-layer: Internal functions
Function, our-load: Internal functions
Function, per-frame: Internal functions
Function, plain-button: Internal functions
Function, pop-sprite-chain-stack: Internal functions
Function, push-sprite-chain-stack: Internal functions
Function, random-point: Internal functions
Function, render-stuff: Internal functions
Function, replace-sprite-chain-stack: Internal functions
Function, save: Internal functions
Function, start: Exported functions
Function, string-bounding-box: Internal functions
Function, string-bounds: Internal functions
Function, update-bounds: Internal functions

G
Generic Function, (setf sprite.absolute-rectangle): Internal generic functions
Generic Function, (setf sprite.bounding-box): Internal generic functions
Generic Function, (setf sprite.onclick): Internal generic functions
Generic Function, (setf sprite.position): Internal generic functions
Generic Function, (setf sprite.string): Internal generic functions
Generic Function, (setf sprite.tickfun): Internal generic functions
Generic Function, sprite.absolute-rectangle: Internal generic functions
Generic Function, sprite.bounding-box: Internal generic functions
Generic Function, sprite.onclick: Internal generic functions
Generic Function, sprite.position: Internal generic functions
Generic Function, sprite.string: Internal generic functions
Generic Function, sprite.tickfun: Internal generic functions

I
init: Internal functions
integer-point: Internal functions

M
Method, (setf sprite.absolute-rectangle): Internal generic functions
Method, (setf sprite.bounding-box): Internal generic functions
Method, (setf sprite.onclick): Internal generic functions
Method, (setf sprite.position): Internal generic functions
Method, (setf sprite.string): Internal generic functions
Method, (setf sprite.tickfun): Internal generic functions
Method, sprite.absolute-rectangle: Internal generic functions
Method, sprite.bounding-box: Internal generic functions
Method, sprite.onclick: Internal generic functions
Method, sprite.position: Internal generic functions
Method, sprite.string: Internal generic functions
Method, sprite.tickfun: Internal generic functions

N
new-layer: Internal functions

O
our-load: Internal functions

P
per-frame: Internal functions
plain-button: Internal functions
pop-sprite-chain-stack: Internal functions
push-sprite-chain-stack: Internal functions

R
random-point: Internal functions
render-stuff: Internal functions
replace-sprite-chain-stack: Internal functions

S
save: Internal functions
sprite.absolute-rectangle: Internal generic functions
sprite.absolute-rectangle: Internal generic functions
sprite.bounding-box: Internal generic functions
sprite.bounding-box: Internal generic functions
sprite.onclick: Internal generic functions
sprite.onclick: Internal generic functions
sprite.position: Internal generic functions
sprite.position: Internal generic functions
sprite.string: Internal generic functions
sprite.string: Internal generic functions
sprite.tickfun: Internal generic functions
sprite.tickfun: Internal generic functions
start: Exported functions
string-bounding-box: Internal functions
string-bounds: Internal functions

U
update-bounds: Internal functions

Jump to:   (  
A   B   C   D   F   G   I   M   N   O   P   R   S   U  

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

A.3 Variables

Jump to:   *  
A   B   O   P   S   T  
Index Entry  Section

*
*app*: Internal special variables
*drag-offset-x*: Internal special variables
*drag-offset-y*: Internal special variables
*glyph-height*: Internal special variables
*glyph-width*: Internal special variables
*hovering*: Internal special variables
*mouse-x*: Internal special variables
*mouse-y*: Internal special variables
*saved-session*: Internal special variables
*selection*: Internal special variables
*sprite-chain-stack*: Internal special variables
*sprite-chain-stack-depth*: Internal special variables
*ticks*: Internal special variables

A
absolute-rectangle: Internal classes

B
bounding-box: Internal classes

O
onclick: Internal classes

P
position: Internal classes

S
Slot, absolute-rectangle: Internal classes
Slot, bounding-box: Internal classes
Slot, onclick: Internal classes
Slot, position: Internal classes
Slot, string: Internal classes
Slot, tickfun: Internal classes
Special Variable, *app*: Internal special variables
Special Variable, *drag-offset-x*: Internal special variables
Special Variable, *drag-offset-y*: Internal special variables
Special Variable, *glyph-height*: Internal special variables
Special Variable, *glyph-width*: Internal special variables
Special Variable, *hovering*: Internal special variables
Special Variable, *mouse-x*: Internal special variables
Special Variable, *mouse-y*: Internal special variables
Special Variable, *saved-session*: Internal special variables
Special Variable, *selection*: Internal special variables
Special Variable, *sprite-chain-stack*: Internal special variables
Special Variable, *sprite-chain-stack-depth*: Internal special variables
Special Variable, *ticks*: Internal special variables
string: Internal classes

T
tickfun: Internal classes

Jump to:   *  
A   B   O   P   S   T  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
Class, sprite: Internal classes

P
Package, sucle: The sucle package

S
sprite: Internal classes
sucle: The sucle system
sucle: The sucle package
System, sucle: The sucle system

Jump to:   C   P   S