langband-engine Reference Documentation

Previous: UNIQUE-MONSTER Up: Package ORG.LANGBAND.ENGINE Next: VINFO-HACK

VARIANT

Name

VARIANT -- class inheriting ACTIVATABLE

Quick-index

(SETF GET-ID)(SETF VARIANT.STAT-LENGTH)MAX-CHARLEVELVARIANT.HOUSE-TYPES
(SETF VARIANT.ATTACK-DESCRIPTIONS)(SETF VARIANT.STATS)MAX-DEPTHVARIANT.IMAGES
(SETF VARIANT.ATTACK-TYPES)(SETF VARIANT.TRAPS)MONSTERSVARIANT.INFORMATION
(SETF VARIANT.CLASSES)(SETF VARIANT.TURN)MONSTERS-BY-LEVELVARIANT.LEVEL-BUILDERS
(SETF VARIANT.CONFIG-PATH)(SETF VARIANT.TURN-EVENTS)NAMEVARIANT.MAX-CHARLEVEL
(SETF VARIANT.DAY-LENGTH)(SETF VARIANT.VERSION)NUM-VERSIONVARIANT.MAX-DEPTH
(SETF VARIANT.DOORS)(SETF VARIANT.VISUAL-EFFECTS)OBJECTSVARIANT.MONSTERS
(SETF VARIANT.EFFECTS)(SETF VARIANT.VISUAL-STATES)OBJECTS-BY-LEVELVARIANT.MONSTERS-BY-LEVEL
(SETF VARIANT.ELEMENTS)(SETF VARIANT.WORN-ITEM-SLOTS)RACESVARIANT.NAME
(SETF VARIANT.EVENT-TYPES)(SETF VARIANT.XP-TABLE)ROOM-BUILDERSVARIANT.NUM-VERSION
(SETF VARIANT.FILTERS)ATTACK-DESCRIPTIONSSETTINGSVARIANT.OBJECTS
(SETF VARIANT.FLAVOUR-TYPES)ATTACK-TYPESSTAT-LENGTHVARIANT.OBJECTS-BY-LEVEL
(SETF VARIANT.FLOOR-TYPES)CLASSESSTATSVARIANT.RACES
(SETF VARIANT.GENDERS)CONFIG-PATHTRAPSVARIANT.ROOM-BUILDERS
(SETF VARIANT.GFX-PATH)DAY-LENGTHTURNVARIANT.SETTINGS
(SETF VARIANT.HELP-TOPICS)DOORSTURN-EVENTSVARIANT.STAT-LENGTH
(SETF VARIANT.HOUSE-OWNERS)EFFECTSVARIANT.ATTACK-DESCRIPTIONSVARIANT.STATS
(SETF VARIANT.HOUSE-TYPES)ELEMENTSVARIANT.ATTACK-TYPESVARIANT.TRAPS
(SETF VARIANT.IMAGES)EVENT-TYPESVARIANT.CLASSESVARIANT.TURN
(SETF VARIANT.INFORMATION)FILTERSVARIANT.CONFIG-PATHVARIANT.TURN-EVENTS
(SETF VARIANT.LEVEL-BUILDERS)FLAVOUR-TYPESVARIANT.DAY-LENGTHVARIANT.VERSION
(SETF VARIANT.MAX-CHARLEVEL)FLOOR-TYPESVARIANT.DOORSVARIANT.VISUAL-EFFECTS
(SETF VARIANT.MAX-DEPTH)GENDERSVARIANT.EFFECTSVARIANT.VISUAL-STATES
(SETF VARIANT.MONSTERS)GET-IDVARIANT.ELEMENTSVARIANT.WORN-ITEM-SLOTS
(SETF VARIANT.MONSTERS-BY-LEVEL)GFX-PATHVARIANT.EVENT-TYPESVARIANT.XP-TABLE
(SETF VARIANT.NAME)HELP-TOPICSVARIANT.FILTERSVERSION
(SETF VARIANT.NUM-VERSION)HOUSE-OWNERSVARIANT.FLAVOUR-TYPESVISUAL-EFFECTS
(SETF VARIANT.OBJECTS)HOUSE-TYPESVARIANT.FLOOR-TYPESVISUAL-STATES
(SETF VARIANT.OBJECTS-BY-LEVEL)IDVARIANT.GENDERSWORN-ITEM-SLOTS
(SETF VARIANT.RACES)IMAGESVARIANT.GFX-PATHXP-TABLE
(SETF VARIANT.ROOM-BUILDERS)INFORMATIONVARIANT.HELP-TOPICS 
(SETF VARIANT.SETTINGS)LEVEL-BUILDERSVARIANT.HOUSE-OWNERS 

Class details

(defclass VARIANT (ACTIVATABLE)(...))
scopepackage ORG.LANGBAND.ENGINE
locationclasses.lisp
inheritsACTIVATABLE
# variables42
# methods84

Methods

(SETF GET-ID) 
 ((SETF GET-ID) (OBJ VARIANT)) [accessor]

GET-ID 
 (GET-ID (OBJ VARIANT)) [accessor]

(SETF VARIANT.ATTACK-DESCRIPTIONS) 
 ((SETF VARIANT.ATTACK-DESCRIPTIONS) (OBJ VARIANT)) [accessor]

VARIANT.ATTACK-DESCRIPTIONS 
 (VARIANT.ATTACK-DESCRIPTIONS (OBJ VARIANT)) [accessor]

(SETF VARIANT.ATTACK-TYPES) 
 ((SETF VARIANT.ATTACK-TYPES) (OBJ VARIANT)) [accessor]

VARIANT.ATTACK-TYPES 
 (VARIANT.ATTACK-TYPES (OBJ VARIANT)) [accessor]
Called By 

GET-ATTACK-TYPE

(SETF VARIANT.CLASSES) 
 ((SETF VARIANT.CLASSES) (OBJ VARIANT)) [accessor]

VARIANT.CLASSES 
 (VARIANT.CLASSES (OBJ VARIANT)) [accessor]
Called By 

(SETF GET-CHAR-CLASS) and GET-CHAR-CLASS

(SETF VARIANT.CONFIG-PATH) 
 ((SETF VARIANT.CONFIG-PATH) (OBJ VARIANT)) [accessor]
Description 

where are the configuration-files?

VARIANT.CONFIG-PATH 
 (VARIANT.CONFIG-PATH (OBJ VARIANT)) [accessor]
Description 

where are the configuration-files?

(SETF VARIANT.DAY-LENGTH) 
 ((SETF VARIANT.DAY-LENGTH) (OBJ VARIANT)) [accessor]

VARIANT.DAY-LENGTH 
 (VARIANT.DAY-LENGTH (OBJ VARIANT)) [accessor]
Called By 

ACTIVATE-OBJECT

(SETF VARIANT.DOORS) 
 ((SETF VARIANT.DOORS) (OBJ VARIANT)) [accessor]
Description 

A table with door-types.

VARIANT.DOORS 
 (VARIANT.DOORS (OBJ VARIANT)) [accessor]
Description 

A table with door-types.

Called By 

DEFINE-DOOR-TYPE and GET-DOOR-TYPE

(SETF VARIANT.EFFECTS) 
 ((SETF VARIANT.EFFECTS) (OBJ VARIANT)) [accessor]
Description 

List of legal effects and effects to handle for variant.

VARIANT.EFFECTS 
 (VARIANT.EFFECTS (OBJ VARIANT)) [accessor]
Description 

List of legal effects and effects to handle for variant.

Called By 

DEFINE-EFFECT and IS-LEGAL-EFFECT?

(SETF VARIANT.ELEMENTS) 
 ((SETF VARIANT.ELEMENTS) (OBJ VARIANT)) [accessor]
Description 

List of legal elements and elements to handle for variant.

Called By 

ACTIVATE-OBJECT

VARIANT.ELEMENTS 
 (VARIANT.ELEMENTS (OBJ VARIANT)) [accessor]
Description 

List of legal elements and elements to handle for variant.

Called By 

%VAN-FILL-RESISTS, ACTIVATE-OBJECT, DEFINE-ELEMENT, GET-ELEMENT-FLAG, GET-ELEMENT-NUMBER and IS-LEGAL-ELEMENT?

(SETF VARIANT.EVENT-TYPES) 
 ((SETF VARIANT.EVENT-TYPES) (OBJ VARIANT)) [accessor]
Description 

table with known events that can occur.

VARIANT.EVENT-TYPES 
 (VARIANT.EVENT-TYPES (OBJ VARIANT)) [accessor]
Description 

table with known events that can occur.

Called By 

FIND-EVENT-FOR-KEY and REGISTER-EVENT&

(SETF VARIANT.FILTERS) 
 ((SETF VARIANT.FILTERS) (OBJ VARIANT)) [accessor]

VARIANT.FILTERS 
 (VARIANT.FILTERS (OBJ VARIANT)) [accessor]
Called By 

APPLY-FILTERS-ON-OBJ and REGISTER-LEVEL!

(SETF VARIANT.FLAVOUR-TYPES) 
 ((SETF VARIANT.FLAVOUR-TYPES) (OBJ VARIANT)) [accessor]

VARIANT.FLAVOUR-TYPES 
 (VARIANT.FLAVOUR-TYPES (OBJ VARIANT)) [accessor]
Called By 

%FILED-OBJECT-KIND, DEFINE-FLAVOUR-TYPE, FIND-FLAVOUR-TYPE and FLAVOUR-SIMPLE-OBJECT-KIND!

(SETF VARIANT.FLOOR-TYPES) 
 ((SETF VARIANT.FLOOR-TYPES) (OBJ VARIANT)) [accessor]

VARIANT.FLOOR-TYPES 
 (VARIANT.FLOOR-TYPES (OBJ VARIANT)) [accessor]
Called By 

(SETF COORD-FLOOR), (SETF GET-FLOOR-TYPE), GET-FLOOR, GET-FLOOR-TYPE and READ-MAP

(SETF VARIANT.GENDERS) 
 ((SETF VARIANT.GENDERS) (OBJ VARIANT)) [accessor]
Description 

List of legal genders for players and monsters.

VARIANT.GENDERS 
 (VARIANT.GENDERS (OBJ VARIANT)) [accessor]
Description 

List of legal genders for players and monsters.

Called By 

%QUERY-FOR-GENDER and ACTIVATE-OBJECT

(SETF VARIANT.GFX-PATH) 
 ((SETF VARIANT.GFX-PATH) (OBJ VARIANT)) [accessor]
Description 

What is the path to variant specific graphics?

VARIANT.GFX-PATH 
 (VARIANT.GFX-PATH (OBJ VARIANT)) [accessor]
Description 

What is the path to variant specific graphics?

Called By 

LOAD-IMAGE&

(SETF VARIANT.HELP-TOPICS) 
 ((SETF VARIANT.HELP-TOPICS) (OBJ VARIANT)) [accessor]

VARIANT.HELP-TOPICS 
 (VARIANT.HELP-TOPICS (OBJ VARIANT)) [accessor]
Called By 

DISPLAY-HELP-TOPICS

(SETF VARIANT.HOUSE-OWNERS) 
 ((SETF VARIANT.HOUSE-OWNERS) (OBJ VARIANT)) [accessor]

VARIANT.HOUSE-OWNERS 
 (VARIANT.HOUSE-OWNERS (OBJ VARIANT)) [accessor]
Called By 

ESTABLISH-OWNER& and GET-OWNER

(SETF VARIANT.HOUSE-TYPES) 
 ((SETF VARIANT.HOUSE-TYPES) (OBJ VARIANT)) [accessor]

VARIANT.HOUSE-TYPES 
 (VARIANT.HOUSE-TYPES (OBJ VARIANT)) [accessor]
Called By 

ESTABLISH-HOUSE& and GET-HOUSE

(SETF VARIANT.IMAGES) 
 ((SETF VARIANT.IMAGES) (OBJ VARIANT)) [accessor]
Description 

An array of relevant images to a variant.

Called By 

ACTIVATE-OBJECT

VARIANT.IMAGES 
 (VARIANT.IMAGES (OBJ VARIANT)) [accessor]
Description 

An array of relevant images to a variant.

Called By 

LOAD-IMAGE&

(SETF VARIANT.INFORMATION) 
 ((SETF VARIANT.INFORMATION) (OBJ VARIANT)) [accessor]

VARIANT.INFORMATION 
 (VARIANT.INFORMATION (OBJ VARIANT)) [accessor]
Called By 

GET-INFORMATION, HAS-INFORMATION? and REMOVE-INFORMATION!

(SETF VARIANT.LEVEL-BUILDERS) 
 ((SETF VARIANT.LEVEL-BUILDERS) (OBJ VARIANT)) [accessor]

VARIANT.LEVEL-BUILDERS 
 (VARIANT.LEVEL-BUILDERS (OBJ VARIANT)) [accessor]
Called By 

GET-LEVEL-BUILDER and REGISTER-LEVEL-BUILDER!

(SETF VARIANT.MAX-CHARLEVEL) 
 ((SETF VARIANT.MAX-CHARLEVEL) (OBJ VARIANT)) [accessor]

VARIANT.MAX-CHARLEVEL 
 (VARIANT.MAX-CHARLEVEL (OBJ VARIANT)) [accessor]
Called By 

%MAKE-LEVEL-ARRAY

(SETF VARIANT.MAX-DEPTH) 
 ((SETF VARIANT.MAX-DEPTH) (OBJ VARIANT)) [accessor]

VARIANT.MAX-DEPTH 
 (VARIANT.MAX-DEPTH (OBJ VARIANT)) [accessor]
Called By 

CREATE-BASIC-ALLOCATION-TABLE and GET-LEVEL-APPROPRIATE-ENCHANTMENT

(SETF VARIANT.MONSTERS) 
 ((SETF VARIANT.MONSTERS) (OBJ VARIANT)) [accessor]
Description 

these are just monster-types.. not active monsters.

VARIANT.MONSTERS 
 (VARIANT.MONSTERS (OBJ VARIANT)) [accessor]
Description 

these are just monster-types.. not active monsters.

Called By 

%FILED-MONSTER-KIND and DEFINE-MONSTER-KIND

(SETF VARIANT.MONSTERS-BY-LEVEL) 
 ((SETF VARIANT.MONSTERS-BY-LEVEL) (OBJ VARIANT)) [accessor]
Description 

these are monster-types organised by levels.

VARIANT.MONSTERS-BY-LEVEL 
 (VARIANT.MONSTERS-BY-LEVEL (OBJ VARIANT)) [accessor]
Description 

these are monster-types organised by levels.

Called By 

INITIALISE-MONSTERS&

(SETF VARIANT.NAME) 
 ((SETF VARIANT.NAME) (OBJ VARIANT)) [accessor]

VARIANT.NAME 
 (VARIANT.NAME (OBJ VARIANT)) [accessor]
Called By 

GET-ELEMENT-FLAG and GET-ELEMENT-NUMBER

(SETF VARIANT.NUM-VERSION) 
 ((SETF VARIANT.NUM-VERSION) (OBJ VARIANT)) [accessor]
Description 

A never-displayed version-number that code can use for compatibility checks, savegames and internal use. version is for display, num-version for active-use. u16b should be enough.

VARIANT.NUM-VERSION 
 (VARIANT.NUM-VERSION (OBJ VARIANT)) [accessor]
Description 

A never-displayed version-number that code can use for compatibility checks, savegames and internal use. version is for display, num-version for active-use. u16b should be enough.

(SETF VARIANT.OBJECTS) 
 ((SETF VARIANT.OBJECTS) (OBJ VARIANT)) [accessor]
Description 

these are just object-types.. not active objects.

VARIANT.OBJECTS 
 (VARIANT.OBJECTS (OBJ VARIANT)) [accessor]
Description 

these are just object-types.. not active objects.

Called By 

%FILED-OBJECT-KIND, DEFINE-OBJECT-KIND and DISTRIBUTE-FLAVOURS!

(SETF VARIANT.OBJECTS-BY-LEVEL) 
 ((SETF VARIANT.OBJECTS-BY-LEVEL) (OBJ VARIANT)) [accessor]
Description 

these are object-types organised by levels.

VARIANT.OBJECTS-BY-LEVEL 
 (VARIANT.OBJECTS-BY-LEVEL (OBJ VARIANT)) [accessor]
Description 

these are object-types organised by levels.

Called By 

INITIALISE-OBJECTS&

(SETF VARIANT.RACES) 
 ((SETF VARIANT.RACES) (OBJ VARIANT)) [accessor]

VARIANT.RACES 
 (VARIANT.RACES (OBJ VARIANT)) [accessor]
Called By 

GET-CHAR-RACE and GET-RACES-AS-A-LIST

(SETF VARIANT.ROOM-BUILDERS) 
 ((SETF VARIANT.ROOM-BUILDERS) (OBJ VARIANT)) [accessor]

VARIANT.ROOM-BUILDERS 
 (VARIANT.ROOM-BUILDERS (OBJ VARIANT)) [accessor]
Called By 

DEFINE-ROOM and GET-ROOM

(SETF VARIANT.SETTINGS) 
 ((SETF VARIANT.SETTINGS) (OBJ VARIANT)) [accessor]
Description 

table with settings for various parts of the code, see later

VARIANT.SETTINGS 
 (VARIANT.SETTINGS (OBJ VARIANT)) [accessor]
Description 

table with settings for various parts of the code, see later

(SETF VARIANT.STAT-LENGTH) 
 ((SETF VARIANT.STAT-LENGTH) (OBJ VARIANT)) [accessor]

VARIANT.STAT-LENGTH 
 (VARIANT.STAT-LENGTH (OBJ VARIANT)) [accessor]
Called By 

DISPLAY-PLAYER-STATS

(SETF VARIANT.STATS) 
 ((SETF VARIANT.STATS) (OBJ VARIANT)) [accessor]
Called By 

DEFINE-CHARACTER-STAT

VARIANT.STATS 
 (VARIANT.STATS (OBJ VARIANT)) [accessor]
Called By 

CAN-LEARN-MORE-SPELLS?, DEFINE-CHARACTER-STAT, GET-STAT-INFO-VALUE, GET-STAT-NAME-FROM-NUM, GET-STAT-NAME-FROM-SYM, GET-STAT-NUM-FROM-SYM, GET-STAT-OBJ, HANDLE-PLAYER-UPDATES! and IS-LEGAL-STAT?

(SETF VARIANT.TRAPS) 
 ((SETF VARIANT.TRAPS) (OBJ VARIANT)) [accessor]
Description 

A table with trap-types.

VARIANT.TRAPS 
 (VARIANT.TRAPS (OBJ VARIANT)) [accessor]
Description 

A table with trap-types.

Called By 

%FILED-TRAP and DEFINE-TRAP-TYPE

(SETF VARIANT.TURN) 
 ((SETF VARIANT.TURN) (OBJ VARIANT)) [accessor]
Called By 

%FILED-VARIANT and ACTIVATE-OBJECT

VARIANT.TURN 
 (VARIANT.TURN (OBJ VARIANT)) [accessor]
Called By 

ACTIVATE-OBJECT, EXECUTE-TURN-EVENTS!, ON-MOVE-TO-COORD, PROCESS-WORLD& and RUN-LEVEL!

(SETF VARIANT.TURN-EVENTS) 
 ((SETF VARIANT.TURN-EVENTS) (OBJ VARIANT)) [accessor]

VARIANT.TURN-EVENTS 
 (VARIANT.TURN-EVENTS (OBJ VARIANT)) [accessor]
Called By 

EXECUTE-TURN-EVENTS! and REGISTER-TURN-EVENT!

(SETF VARIANT.VERSION) 
 ((SETF VARIANT.VERSION) (OBJ VARIANT)) [accessor]
Description 

A string describing the version, useful for displaying.

VARIANT.VERSION 
 (VARIANT.VERSION (OBJ VARIANT)) [accessor]
Description 

A string describing the version, useful for displaying.

(SETF VARIANT.VISUAL-EFFECTS) 
 ((SETF VARIANT.VISUAL-EFFECTS) (OBJ VARIANT)) [accessor]

VARIANT.VISUAL-EFFECTS 
 (VARIANT.VISUAL-EFFECTS (OBJ VARIANT)) [accessor]
Called By 

DEFINE-SPELL, INITIALISE-OBJECT-KIND!, INITIALISE-OBJECT-KIND! and INITIALISE-OBJECT-KIND!

(SETF VARIANT.VISUAL-STATES) 
 ((SETF VARIANT.VISUAL-STATES) (OBJ VARIANT)) [accessor]
Description 

The various states that can be shown for the player.

Called By 

DEFINE-VISUAL-STATE

VARIANT.VISUAL-STATES 
 (VARIANT.VISUAL-STATES (OBJ VARIANT)) [accessor]
Description 

The various states that can be shown for the player.

Called By 

DEFINE-VISUAL-STATE, DISPLAY-VISUAL-STATES, GET-VISUAL-STATE and MODIFY-VISUAL-STATE!

(SETF VARIANT.WORN-ITEM-SLOTS) 
 ((SETF VARIANT.WORN-ITEM-SLOTS) (OBJ VARIANT)) [accessor]
Called By 

REGISTER-SLOT-ORDER&

VARIANT.WORN-ITEM-SLOTS 
 (VARIANT.WORN-ITEM-SLOTS (OBJ VARIANT)) [accessor]
Called By 

%GET-EQUIP-KEYS and MAKE-EQUIPMENT-SLOTS

(SETF VARIANT.XP-TABLE) 
 ((SETF VARIANT.XP-TABLE) (OBJ VARIANT)) [accessor]

VARIANT.XP-TABLE 
 (VARIANT.XP-TABLE (OBJ VARIANT)) [accessor]

Slots

 slot ATTACK-DESCRIPTIONS is of type T
 slot ATTACK-TYPES is of type T
 slot CLASSES is of type T

CONFIG-PATH 
slot CONFIG-PATH is of type T
Description 

where are the configuration-files?

DAY-LENGTH 
slot DAY-LENGTH is of type T

DOORS 
slot DOORS is of type T
Description 

A table with door-types.

EFFECTS 
slot EFFECTS is of type T
Description 

List of legal effects and effects to handle for variant.

ELEMENTS 
slot ELEMENTS is of type T
Description 

List of legal elements and elements to handle for variant.

EVENT-TYPES 
slot EVENT-TYPES is of type T
Description 

table with known events that can occur.

 slot FILTERS is of type T
 slot FLAVOUR-TYPES is of type T
 slot FLOOR-TYPES is of type T

GENDERS 
slot GENDERS is of type T
Description 

List of legal genders for players and monsters.

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

What is the path to variant specific graphics?

 slot HELP-TOPICS is of type T
 slot HOUSE-OWNERS is of type T
 slot HOUSE-TYPES is of type T
 slot ID is of type T

IMAGES 
slot IMAGES is of type T
Description 

An array of relevant images to a variant.

 slot INFORMATION is of type T
 slot LEVEL-BUILDERS is of type T
 slot MAX-CHARLEVEL is of type T
 slot MAX-DEPTH is of type T

MONSTERS 
slot MONSTERS is of type T
Description 

these are just monster-types.. not active monsters.

MONSTERS-BY-LEVEL 
slot MONSTERS-BY-LEVEL is of type T
Description 

these are monster-types organised by levels.

NAME 
slot NAME is of type T

NUM-VERSION 
slot NUM-VERSION is of type T
Description 

A never-displayed version-number that code can use for compatibility checks, savegames and internal use. version is for display, num-version for active-use. u16b should be enough.

OBJECTS 
slot OBJECTS is of type T
Description 

these are just object-types.. not active objects.

OBJECTS-BY-LEVEL 
slot OBJECTS-BY-LEVEL is of type T
Description 

these are object-types organised by levels.

 slot RACES is of type T
 slot ROOM-BUILDERS is of type T

SETTINGS 
slot SETTINGS is of type T
Description 

table with settings for various parts of the code, see later

 slot STAT-LENGTH is of type T
 slot STATS is of type T

TRAPS 
slot TRAPS is of type T
Description 

A table with trap-types.

 slot TURN is of type T
 slot TURN-EVENTS is of type T

VERSION 
slot VERSION is of type T
Description 

A string describing the version, useful for displaying.

VISUAL-EFFECTS 
slot VISUAL-EFFECTS is of type T

VISUAL-STATES 
slot VISUAL-STATES is of type T
Description 

The various states that can be shown for the player.

 slot WORN-ITEM-SLOTS is of type T
 slot XP-TABLE is of type T

Previous: UNIQUE-MONSTER Up: Package ORG.LANGBAND.ENGINE Next: VINFO-HACK

langband-engine Reference Documentation

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