langband-engine Reference Documentation

Previous: MOUSE-EVENT Up: Package ORG.LANGBAND.ENGINE Next: OBJECT-KNOWLEDGE

OBJECT-KIND

Name

OBJECT-KIND -- class

Quick-index

(SETF ALLOC-LOCATIONS)(SETF OBJECT.POWER-LVL)GET-IMMUNITIESOBJECT.IGNORES
(SETF GET-ARMOUR-MODIFIER)(SETF OBJECT.SORT-VALUE)GET-LIGHT-RADIUSOBJECT.NAME
(SETF GET-ARMOUR-RATING)(SETF OBJECT.SPEED-MODIFIER)GET-NUMBER-OF-DAMAGE-DICEOBJECT.NUMERIC-ID
(SETF GET-DAMAGE-DICE)(SETF OBJECT.TEXT-COLOUR)GET-RESISTSOBJECT.POWER-LVL
(SETF GET-DAMAGE-MODIFIER)(SETF OBJECT.THE-KIND)GET-STAT-MODIFIERSOBJECT.SORT-VALUE
(SETF GET-ID)(SETF OBJECT.TRIED)GET-STAT-SUSTAINSOBJECT.SPEED-MODIFIER
(SETF GET-IMMUNITIES)(SETF OBJECT.WEIGHT)GET-TOHIT-MODIFIEROBJECT.TEXT-COLOUR
(SETF GET-LIGHT-RADIUS)(SETF TEXT-SYM)GET-VULNERABILITIESOBJECT.THE-KIND
(SETF GET-NUMBER-OF-DAMAGE-DICE)ABILITIESGFX-SYMOBJECT.TRIED
(SETF GET-RESISTS)ALLOC-LOCATIONSGFX-SYMOBJECT.WEIGHT
(SETF GET-STAT-MODIFIERS)ARMOUR-MODIFIERIDPOWER-LVL
(SETF GET-STAT-SUSTAINS)ARMOUR-RATINGIGNORESRESISTS
(SETF GET-TOHIT-MODIFIER)AWAREIMMUNITIESSORT-VALUE
(SETF GET-VULNERABILITIES)COSTLIGHT-RADIUSSPEED-MODIFIER
(SETF GFX-SYM)DAMAGE-DICELOCATIONSSTAT-MODIFIERS
(SETF OBJECT.ABILITIES)DAMAGE-MODIFIERNAMESTAT-SUSTAINS
(SETF OBJECT.AWARE)EASY-KNOWNUMBER-OF-DAMAGE-DICETEXT-COLOUR
(SETF OBJECT.COST)EFFECTSNUMERIC-IDTEXT-SYM
(SETF OBJECT.EASY-KNOW)EVENTSOBJECT.ABILITIESTEXT-SYM
(SETF OBJECT.EFFECTS)FLAGSOBJECT.AWARETHE-KIND
(SETF OBJECT.EVENTS)FLAVOUROBJECT.COSTTOHIT-MODIFIER
(SETF OBJECT.FLAGS)GET-ARMOUR-MODIFIEROBJECT.EASY-KNOWTRIED
(SETF OBJECT.FLAVOUR)GET-ARMOUR-RATINGOBJECT.EFFECTSVULNERABILITIES
(SETF OBJECT.IGNORES)GET-DAMAGE-DICEOBJECT.EVENTSWEIGHT
(SETF OBJECT.NAME)GET-DAMAGE-MODIFIEROBJECT.FLAGS 
(SETF OBJECT.NUMERIC-ID)GET-IDOBJECT.FLAVOUR 

Class details

(defclass OBJECT-KIND ()(...))
scopepackage ORG.LANGBAND.ENGINE
locationclasses.lisp
# variables34
# methods68

Methods

(SETF ALLOC-LOCATIONS) 
 ((SETF ALLOC-LOCATIONS) (OBJ OBJECT-KIND)) [accessor]
Description 

A list of conses on the form (depth . chance)

ALLOC-LOCATIONS 
 (ALLOC-LOCATIONS (OBJ OBJECT-KIND)) [accessor]
Description 

A list of conses on the form (depth . chance)

(SETF GET-ARMOUR-MODIFIER) 
 ((SETF GET-ARMOUR-MODIFIER) (OBJ OBJECT-KIND)) [accessor]

GET-ARMOUR-MODIFIER 
 (GET-ARMOUR-MODIFIER (OBJ OBJECT-KIND)) [accessor]

(SETF GET-ARMOUR-RATING) 
 ((SETF GET-ARMOUR-RATING) (OBJ OBJECT-KIND)) [accessor]

GET-ARMOUR-RATING 
 (GET-ARMOUR-RATING (OBJ OBJECT-KIND)) [accessor]

(SETF GET-DAMAGE-DICE) 
 ((SETF GET-DAMAGE-DICE) (OBJ OBJECT-KIND)) [accessor]

GET-DAMAGE-DICE 
 (GET-DAMAGE-DICE (OBJ OBJECT-KIND)) [accessor]

(SETF GET-DAMAGE-MODIFIER) 
 ((SETF GET-DAMAGE-MODIFIER) (OBJ OBJECT-KIND)) [accessor]

GET-DAMAGE-MODIFIER 
 (GET-DAMAGE-MODIFIER (OBJ OBJECT-KIND)) [accessor]

(SETF GET-ID) 
 ((SETF GET-ID) (OBJ OBJECT-KIND)) [accessor]

GET-ID 
 (GET-ID (OBJ OBJECT-KIND)) [accessor]

(SETF GET-IMMUNITIES) 
 ((SETF GET-IMMUNITIES) (OBJ OBJECT-KIND)) [accessor]
Description 

The value is tied to registered elements.

GET-IMMUNITIES 
 (GET-IMMUNITIES (OBJ OBJECT-KIND)) [accessor]
Description 

The value is tied to registered elements.

(SETF GET-LIGHT-RADIUS) 
 ((SETF GET-LIGHT-RADIUS) (OBJ OBJECT-KIND)) [accessor]
Description 

Value is non-negative integer.

Called By 

PROCESS-WORLD&

GET-LIGHT-RADIUS 
 (GET-LIGHT-RADIUS (OBJ OBJECT-KIND)) [accessor]
Description 

Value is non-negative integer.

(SETF GET-NUMBER-OF-DAMAGE-DICE) 
 ((SETF GET-NUMBER-OF-DAMAGE-DICE) (OBJ OBJECT-KIND)) [accessor]

GET-NUMBER-OF-DAMAGE-DICE 
 (GET-NUMBER-OF-DAMAGE-DICE (OBJ OBJECT-KIND)) [accessor]

(SETF GET-RESISTS) 
 ((SETF GET-RESISTS) (OBJ OBJECT-KIND)) [accessor]
Description 

The value is tied to registered elements.

GET-RESISTS 
 (GET-RESISTS (OBJ OBJECT-KIND)) [accessor]
Description 

The value is tied to registered elements.

(SETF GET-STAT-MODIFIERS) 
 ((SETF GET-STAT-MODIFIERS) (OBJ OBJECT-KIND)) [accessor]
Called By 

BOOST-STATS!

GET-STAT-MODIFIERS 
 (GET-STAT-MODIFIERS (OBJ OBJECT-KIND)) [accessor]
Called By 

BOOST-STATS!

(SETF GET-STAT-SUSTAINS) 
 ((SETF GET-STAT-SUSTAINS) (OBJ OBJECT-KIND)) [accessor]
Description 

The value is tied to registered stats.

GET-STAT-SUSTAINS 
 (GET-STAT-SUSTAINS (OBJ OBJECT-KIND)) [accessor]
Description 

The value is tied to registered stats.

(SETF GET-TOHIT-MODIFIER) 
 ((SETF GET-TOHIT-MODIFIER) (OBJ OBJECT-KIND)) [accessor]

GET-TOHIT-MODIFIER 
 (GET-TOHIT-MODIFIER (OBJ OBJECT-KIND)) [accessor]

(SETF GET-VULNERABILITIES) 
 ((SETF GET-VULNERABILITIES) (OBJ OBJECT-KIND)) [accessor]
Description 

The value is tied to registered elements.

GET-VULNERABILITIES 
 (GET-VULNERABILITIES (OBJ OBJECT-KIND)) [accessor]
Description 

The value is tied to registered elements.

(SETF GFX-SYM) 
 ((SETF GFX-SYM) (OBJ OBJECT-KIND)) [accessor]
Description 

A precoded 24-bit bitfield specifying which graphical symbol to use.

GFX-SYM 
 (GFX-SYM (OBJ OBJECT-KIND)) [accessor]
Description 

A precoded 24-bit bitfield specifying which graphical symbol to use.

(SETF OBJECT.ABILITIES) 
 ((SETF OBJECT.ABILITIES) (OBJ OBJECT-KIND)) [accessor]

OBJECT.ABILITIES 
 (OBJECT.ABILITIES (OBJ OBJECT-KIND)) [accessor]

(SETF OBJECT.AWARE) 
 ((SETF OBJECT.AWARE) (OBJ OBJECT-KIND)) [accessor]
Description 

The player is 'aware' of the item's effects

Called By 

%FILED-OBJECT-KIND

OBJECT.AWARE 
 (OBJECT.AWARE (OBJ OBJECT-KIND)) [accessor]
Description 

The player is 'aware' of the item's effects

Called By 

WRITE-OBJ-DESCRIPTION, WRITE-OBJ-DESCRIPTION, WRITE-OBJ-DESCRIPTION, WRITE-OBJ-DESCRIPTION and WRITE-OBJ-DESCRIPTION

(SETF OBJECT.COST) 
 ((SETF OBJECT.COST) (OBJ OBJECT-KIND)) [accessor]
Description 

Non-negative integer, denoting one unit of the currency.

OBJECT.COST 
 (OBJECT.COST (OBJ OBJECT-KIND)) [accessor]
Description 

Non-negative integer, denoting one unit of the currency.

Called By 

CREATE-GOLD and GET-PRICE

(SETF OBJECT.EASY-KNOW) 
 ((SETF OBJECT.EASY-KNOW) (OBJ OBJECT-KIND)) [accessor]
Description 

Is it easy to understand the use of the object?

OBJECT.EASY-KNOW 
 (OBJECT.EASY-KNOW (OBJ OBJECT-KIND)) [accessor]
Description 

Is it easy to understand the use of the object?

(SETF OBJECT.EFFECTS) 
 ((SETF OBJECT.EFFECTS) (OBJ OBJECT-KIND)) [accessor]
Description 

Is a list of effect-entry objects.

OBJECT.EFFECTS 
 (OBJECT.EFFECTS (OBJ OBJECT-KIND)) [accessor]
Description 

Is a list of effect-entry objects.

Called By 

INTERACTIVE-USE-ITEM! and USE-OBJECT!

(SETF OBJECT.EVENTS) 
 ((SETF OBJECT.EVENTS) (OBJ OBJECT-KIND)) [accessor]
Description 

should be a list of conses (event . function-obj)

OBJECT.EVENTS 
 (OBJECT.EVENTS (OBJ OBJECT-KIND)) [accessor]
Description 

should be a list of conses (event . function-obj)

(SETF OBJECT.FLAGS) 
 ((SETF OBJECT.FLAGS) (OBJ OBJECT-KIND)) [accessor]
Description 

List of symbols, may be the empry list.

OBJECT.FLAGS 
 (OBJECT.FLAGS (OBJ OBJECT-KIND)) [accessor]
Description 

List of symbols, may be the empry list.

Called By 

ADD-OBJECT-KNOWLEDGE-FLAG! and DISPLAY-OBJECT-RECALL

(SETF OBJECT.FLAVOUR) 
 ((SETF OBJECT.FLAVOUR) (OBJ OBJECT-KIND)) [accessor]
Description 

The flavour is either nil or a cons (desc . colour).

Called By 

%FILED-OBJECT-KIND and FLAVOUR-SIMPLE-OBJECT-KIND!

OBJECT.FLAVOUR 
 (OBJECT.FLAVOUR (OBJ OBJECT-KIND)) [accessor]
Description 

The flavour is either nil or a cons (desc . colour).

Called By 

FLAVOUR-SIMPLE-OBJECT-KIND!, WRITE-OBJ-DESCRIPTION, WRITE-OBJ-DESCRIPTION and WRITE-OBJ-DESCRIPTION

(SETF OBJECT.IGNORES) 
 ((SETF OBJECT.IGNORES) (OBJ OBJECT-KIND)) [accessor]
Description 

The value is tied to registered elements.

Called By 

SHARED-INITIALIZE

OBJECT.IGNORES 
 (OBJECT.IGNORES (OBJ OBJECT-KIND)) [accessor]
Description 

The value is tied to registered elements.

Called By 

SHARED-INITIALIZE

(SETF OBJECT.NAME) 
 ((SETF OBJECT.NAME) (OBJ OBJECT-KIND)) [accessor]

OBJECT.NAME 
 (OBJECT.NAME (OBJ OBJECT-KIND)) [accessor]
Called By 
CREATE-AOBJ-FROM-KINDDISPLAY-OBJECT-RECALLINITIALISE-OBJECT-KIND!
INITIALISE-OBJECT-KIND!OBJECT.NAMEOK-OBJECT?
OK-OBJECT?OK-OBJECT?OK-OBJECT?
OK-OBJECT?OK-OBJECT?PRINT-OBJECT
WRITE-OBJ-DESCRIPTIONWRITE-OBJ-DESCRIPTIONWRITE-OBJ-DESCRIPTION
WRITE-OBJ-DESCRIPTIONWRITE-OBJ-DESCRIPTIONWRITE-OBJ-DESCRIPTION
WRITE-OBJ-DESCRIPTIONWRITE-OBJ-DESCRIPTION 

(SETF OBJECT.NUMERIC-ID) 
 ((SETF OBJECT.NUMERIC-ID) (OBJ OBJECT-KIND)) [accessor]

OBJECT.NUMERIC-ID 
 (OBJECT.NUMERIC-ID (OBJ OBJECT-KIND)) [accessor]
Called By 

PRINT-OBJECT

(SETF OBJECT.POWER-LVL) 
 ((SETF OBJECT.POWER-LVL) (OBJ OBJECT-KIND)) [accessor]
Description 

A non-negative integer denoting how powerful the object is.

OBJECT.POWER-LVL 
 (OBJECT.POWER-LVL (OBJ OBJECT-KIND)) [accessor]
Description 

A non-negative integer denoting how powerful the object is.

(SETF OBJECT.SORT-VALUE) 
 ((SETF OBJECT.SORT-VALUE) (OBJ OBJECT-KIND)) [accessor]
Description 

Non-negative integer denoting where the object will be in an object-list.

OBJECT.SORT-VALUE 
 (OBJECT.SORT-VALUE (OBJ OBJECT-KIND)) [accessor]
Description 

Non-negative integer denoting where the object will be in an object-list.

(SETF OBJECT.SPEED-MODIFIER) 
 ((SETF OBJECT.SPEED-MODIFIER) (OBJ OBJECT-KIND)) [accessor]

OBJECT.SPEED-MODIFIER 
 (OBJECT.SPEED-MODIFIER (OBJ OBJECT-KIND)) [accessor]

(SETF OBJECT.TEXT-COLOUR) 
 ((SETF OBJECT.TEXT-COLOUR) (OBJ OBJECT-KIND)) [accessor]
Description 

Colour used in textual descriptions of the object.

OBJECT.TEXT-COLOUR 
 (OBJECT.TEXT-COLOUR (OBJ OBJECT-KIND)) [accessor]
Description 

Colour used in textual descriptions of the object.

(SETF OBJECT.THE-KIND) 
 ((SETF OBJECT.THE-KIND) (OBJ OBJECT-KIND)) [accessor]

OBJECT.THE-KIND 
 (OBJECT.THE-KIND (OBJ OBJECT-KIND)) [accessor]
Called By 

%FILED-OBJECT-KIND, FLAVOUR-SIMPLE-OBJECT-KIND!, PICK-UP-FROM-FLOOR! and STORE-BUYS-ITEM?

(SETF OBJECT.TRIED) 
 ((SETF OBJECT.TRIED) (OBJ OBJECT-KIND)) [accessor]
Description 

The player has 'tried' one of the items

OBJECT.TRIED 
 (OBJECT.TRIED (OBJ OBJECT-KIND)) [accessor]
Description 

The player has 'tried' one of the items

(SETF OBJECT.WEIGHT) 
 ((SETF OBJECT.WEIGHT) (OBJ OBJECT-KIND)) [accessor]
Description 

Non-negative integer, each about 50g.

OBJECT.WEIGHT 
 (OBJECT.WEIGHT (OBJ OBJECT-KIND)) [accessor]
Description 

Non-negative integer, each about 50g.

Called By 

HANDLE-PLAYER-UPDATES!, OBJECT.WEIGHT and THROW-OBJECT

(SETF TEXT-SYM) 
 ((SETF TEXT-SYM) (OBJ OBJECT-KIND)) [accessor]
Description 

A precoded 24-bit bitfield specifying whichtextual symbol to use.

TEXT-SYM 
 (TEXT-SYM (OBJ OBJECT-KIND)) [accessor]
Description 

A precoded 24-bit bitfield specifying whichtextual symbol to use.

Slots

 slot ABILITIES is of type T
 slot ARMOUR-MODIFIER is of type T
 slot ARMOUR-RATING is of type T

AWARE 
slot AWARE is of type T
Description 

The player is 'aware' of the item's effects

COST 
slot COST is of type T
Description 

Non-negative integer, denoting one unit of the currency.

 slot DAMAGE-DICE is of type T
 slot DAMAGE-MODIFIER is of type T

EASY-KNOW 
slot EASY-KNOW is of type T
Description 

Is it easy to understand the use of the object?

EFFECTS 
slot EFFECTS is of type T
Description 

Is a list of effect-entry objects.

EVENTS 
slot EVENTS is of type T
Description 

should be a list of conses (event . function-obj)

FLAGS 
slot FLAGS is of type T
Description 

List of symbols, may be the empry list.

FLAVOUR 
slot FLAVOUR is of type T
Description 

The flavour is either nil or a cons (desc . colour).

GFX-SYM 
slot GFX-SYM is of type T
Description 

A precoded 24-bit bitfield specifying which graphical symbol to use.

ID 
slot ID is of type T

IGNORES 
slot IGNORES is of type T
Description 

The value is tied to registered elements.

IMMUNITIES 
slot IMMUNITIES is of type T
Description 

The value is tied to registered elements.

LIGHT-RADIUS 
slot LIGHT-RADIUS is of type T
Description 

Value is non-negative integer.

LOCATIONS 
slot LOCATIONS is of type T
Description 

A list of conses on the form (depth . chance)

 slot NAME is of type T
 slot NUMBER-OF-DAMAGE-DICE is of type T
 slot NUMERIC-ID is of type T

POWER-LVL 
slot POWER-LVL is of type T
Description 

A non-negative integer denoting how powerful the object is.

RESISTS 
slot RESISTS is of type T
Description 

The value is tied to registered elements.

SORT-VALUE 
slot SORT-VALUE is of type T
Description 

Non-negative integer denoting where the object will be in an object-list.

 slot SPEED-MODIFIER is of type T
 slot STAT-MODIFIERS is of type T

STAT-SUSTAINS 
slot STAT-SUSTAINS is of type T
Description 

The value is tied to registered stats.

TEXT-COLOUR 
slot TEXT-COLOUR is of type T
Description 

Colour used in textual descriptions of the object.

TEXT-SYM 
slot TEXT-SYM is of type T
Description 

A precoded 24-bit bitfield specifying whichtextual symbol to use.

 slot THE-KIND is of type T
 slot TOHIT-MODIFIER is of type T

TRIED 
slot TRIED is of type T
Description 

The player has 'tried' one of the items

VULNERABILITIES 
slot VULNERABILITIES is of type T
Description 

The value is tied to registered elements.

WEIGHT 
slot WEIGHT is of type T
Description 

Non-negative integer, each about 50g.

Previous: MOUSE-EVENT Up: Package ORG.LANGBAND.ENGINE Next: OBJECT-KNOWLEDGE

langband-engine Reference Documentation

This documentation was generated Autumn 2003 from the original sources by Albert v.0.4.9.