The tile-grid Reference Manual

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

The tile-grid Reference Manual

This is the tile-grid Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 07:23:31 2022 GMT+0.

Table of Contents


1 Introduction

tile-grid

A simple tile grid implementation.

Overview

Presents a grid object which has a width and height, and a 2-dimensional array of cells. Cells have X and Y coordinates, as well as a bitfield of various user-definable properties that can be added/removed with an included API.

Install

(ql:quickload :tile-grid)

License

Copyright © 2020-2022 Michael Fiano mail@mfiano.net.

Licensed under the MIT License.


2 Systems

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


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

2.1 tile-grid

A simple tile grid implementation.

Author

Michael Fiano <mail@mfiano.net>

Home Page

https://git.mfiano.net/mfiano/tile-grid

License

MIT

Version

0.1.0

Dependency

mfiano-utils (system).

Source

tile-grid.asd.

Child Components

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   [Contents][Index]

3.1.1 tile-grid/tile-grid.asd

Source

tile-grid.asd.

Parent Component

tile-grid (system).

ASDF Systems

tile-grid.


3.1.2 tile-grid/package.lisp

Source

tile-grid.asd.

Parent Component

tile-grid (system).

Packages

tile-grid.


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

3.1.3 tile-grid/tile-grid.lisp

Dependency

package.lisp (file).

Source

tile-grid.asd.

Parent Component

tile-grid (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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

4.1 tile-grid

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


5.1.1 Macros

Macro: do-cells ((&key w h x1 y1 x2 y2) grid cell &body body)
Package

tile-grid.

Source

tile-grid.lisp.


5.1.2 Ordinary functions

Function: cell-empty-p (cell)
Package

tile-grid.

Source

tile-grid.lisp.

Function: clear-properties (cell)
Package

tile-grid.

Source

tile-grid.lisp.

Function: copy-grid (source target)
Package

tile-grid.

Source

tile-grid.lisp.

Function: get-cell (grid x y)
Package

tile-grid.

Source

tile-grid.lisp.

Reader: height (instance)
Writer: (setf height) (instance)
Package

tile-grid.

Source

tile-grid.lisp.

Target Slot

height.

Function: make-grid (width height)
Package

tile-grid.

Source

tile-grid.lisp.

Reader: properties (instance)
Writer: (setf properties) (instance)
Package

tile-grid.

Source

tile-grid.lisp.

Target Slot

properties.

Function: reset-grid (grid)
Package

tile-grid.

Source

tile-grid.lisp.

Reader: width (instance)
Writer: (setf width) (instance)
Package

tile-grid.

Source

tile-grid.lisp.

Target Slot

width.

Reader: x (instance)
Writer: (setf x) (instance)
Package

tile-grid.

Source

tile-grid.lisp.

Target Slot

x.

Reader: y (instance)
Writer: (setf y) (instance)
Package

tile-grid.

Source

tile-grid.lisp.

Target Slot

y.


5.1.3 Generic functions

Generic Function: add-properties (cell type &rest properties)
Package

tile-grid.

Source

tile-grid.lisp.

Methods
Method: add-properties (cell type &rest properties)
Generic Function: cell-contains-p (cell type property)
Package

tile-grid.

Source

tile-grid.lisp.

Methods
Method: cell-contains-p (cell type property)
Generic Function: remove-properties (cell type &rest properties)
Package

tile-grid.

Source

tile-grid.lisp.

Methods
Method: remove-properties (cell type &rest properties)

5.1.4 Structures

Structure: cell
Package

tile-grid.

Source

tile-grid.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: x
Type

fixnum

Initform

0

Readers

x.

Writers

(setf x).

Slot: y
Type

fixnum

Initform

0

Readers

y.

Writers

(setf y).

Slot: properties
Type

hash-table

Initform

(mfiano-utils:dict (function eq))

Readers

properties.

Writers

(setf properties).

Structure: grid
Package

tile-grid.

Source

tile-grid.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: width
Type

mfiano-utils:ub16

Initform

0

Readers

width.

Writers

(setf width).

Slot: height
Type

mfiano-utils:ub16

Initform

0

Readers

height.

Writers

(setf height).

Slot: cells
Type

(simple-array tile-grid:cell (*))

Initform

(make-array 0 :element-type (quote tile-grid:cell))

Readers

cells.

Writers

(setf cells).


5.2 Internals


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

5.2.1 Ordinary functions

Function: %make-grid (&key width height cells)
Package

tile-grid.

Source

tile-grid.lisp.

Reader: cells (instance)
Writer: (setf cells) (instance)
Package

tile-grid.

Source

tile-grid.lisp.

Target Slot

cells.

Function: make-cell (x y)
Package

tile-grid.

Source

tile-grid.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   %   (  
A   C   D   F   G   H   M   P   R   W   X   Y  
Index Entry  Section

%
%make-grid: Private ordinary functions

(
(setf cells): Private ordinary functions
(setf height): Public ordinary functions
(setf properties): Public ordinary functions
(setf width): Public ordinary functions
(setf x): Public ordinary functions
(setf y): Public ordinary functions

A
add-properties: Public generic functions
add-properties: Public generic functions

C
cell-contains-p: Public generic functions
cell-contains-p: Public generic functions
cell-empty-p: Public ordinary functions
cells: Private ordinary functions
clear-properties: Public ordinary functions
copy-grid: Public ordinary functions

D
do-cells: Public macros

F
Function, %make-grid: Private ordinary functions
Function, (setf cells): Private ordinary functions
Function, (setf height): Public ordinary functions
Function, (setf properties): Public ordinary functions
Function, (setf width): Public ordinary functions
Function, (setf x): Public ordinary functions
Function, (setf y): Public ordinary functions
Function, cell-empty-p: Public ordinary functions
Function, cells: Private ordinary functions
Function, clear-properties: Public ordinary functions
Function, copy-grid: Public ordinary functions
Function, get-cell: Public ordinary functions
Function, height: Public ordinary functions
Function, make-cell: Private ordinary functions
Function, make-grid: Public ordinary functions
Function, properties: Public ordinary functions
Function, reset-grid: Public ordinary functions
Function, width: Public ordinary functions
Function, x: Public ordinary functions
Function, y: Public ordinary functions

G
Generic Function, add-properties: Public generic functions
Generic Function, cell-contains-p: Public generic functions
Generic Function, remove-properties: Public generic functions
get-cell: Public ordinary functions

H
height: Public ordinary functions

M
Macro, do-cells: Public macros
make-cell: Private ordinary functions
make-grid: Public ordinary functions
Method, add-properties: Public generic functions
Method, cell-contains-p: Public generic functions
Method, remove-properties: Public generic functions

P
properties: Public ordinary functions

R
remove-properties: Public generic functions
remove-properties: Public generic functions
reset-grid: Public ordinary functions

W
width: Public ordinary functions

X
x: Public ordinary functions

Y
y: Public ordinary functions

Jump to:   %   (  
A   C   D   F   G   H   M   P   R   W   X   Y