world_descriptor Struct Reference

#include <constdata.h>

---

Detailed Description

Data-file header.

Definition at line 12 of file constdata.h.

Data Fields
filelink	tileoffset
	Position in the data file of the tiles table.
filelink	itemoffset
	Item descriptions table.
filelink	generate_item
	Item generation table.
filelink	generate_currency
	Pointer to 'gold piece' item description.
filelink	startinginventory
	Player's starting inventory.
filelink	spelllist
	List of spells.
filelink	playerclasses
	Table of player classes.
filelink	stsizes
filelink	stdata
filelink	shopdescs
filelink	titlescreen_light_plane
filelink	titlescreen_dark_plane
uint	itementries
	Number of item types.
uint	numspells
	Number of spells.
uint	numplayerclasses
	Number of player classes.
uint	tutorialclass
	Index of the 'tutorial' player class.
uint	numshuffletabs
uint	shuffletabsize
uint	numshoptypes
uint	padding
filelink	mainmap
filelink	tutorialmap
filelink	misc_links

---

Field Documentation

struct filelink world_descriptor::generate_currency

Pointer to 'gold piece' item description. For handling shopkeepers, the game needs to know where the 'gold piece' item description is; this points to it. See also: itemdesc Definition at line 44 of file constdata.h. Referenced by give_gold().

struct filelink world_descriptor::generate_item

Item generation table. Whenever an item is to be generated, the game will dereference this pointer. Since pointers in the data file may correspond to probability tables, this allows random item selection. See also: itemdesc Definition at line 37 of file constdata.h. Referenced by place_items().

uint world_descriptor::itementries

Number of item types. Definition at line 76 of file constdata.h. Referenced by init_discoveries(), list_discoveries(), restore_game(), and save_game().

struct filelink world_descriptor::itemoffset

Item descriptions table. Each item is kept track of with an integer, which corresponds to its position in the item types array. This points to that array. When the data file is loaded, this pointer is dereferenced and stored in w->itemdescs for easier use. (To get the description of an item, do not use this directly; instead, use the ITEMDESC or ITEMDESCN macro.) See also: itemdesc world::itemdescs Definition at line 29 of file constdata.h. Referenced by link_data_file().

struct filelink world_descriptor::mainmap

Definition at line 85 of file constdata.h. Referenced by main_menu().

struct filelink world_descriptor::misc_links

Definition at line 88 of file constdata.h.

uint world_descriptor::numplayerclasses

Number of player classes. Definition at line 78 of file constdata.h. Referenced by init_player().

uint world_descriptor::numshoptypes

Definition at line 82 of file constdata.h. Referenced by place_shop().

uint world_descriptor::numshuffletabs

Definition at line 80 of file constdata.h. Referenced by init_shuffle_tab().

uint world_descriptor::numspells

Number of spells. Definition at line 77 of file constdata.h. Referenced by init_spells(), numSpellsKnown(), restore_game(), and save_game().

uint world_descriptor::padding

Definition at line 83 of file constdata.h.

struct filelink world_descriptor::playerclasses

Table of player classes. Points to the list of player classes, an array of classdesc. On load, this is dereferenced and cached as w->playerclasses; there is no need to use it directly. See also: world::playerclasses classdesc Definition at line 69 of file constdata.h. Referenced by link_data_file().

struct filelink world_descriptor::shopdescs

Definition at line 72 of file constdata.h. Referenced by link_data_file().

uint world_descriptor::shuffletabsize

Definition at line 81 of file constdata.h. Referenced by init_shuffle_tab(), restore_game(), and save_game().

struct filelink world_descriptor::spelllist

List of spells. Points to the spells table, an array of spelldesc. This is dereferenced and cached as w->spelldescs. See also: world::spelldescs spelldesc Definition at line 60 of file constdata.h. Referenced by link_data_file().

struct filelink world_descriptor::startinginventory

Player's starting inventory. Points to an int (number of items) followed by an array of item. See #data/items.m4. Note that this does depend on what class the player is, but that is handled entirely by the dereferencing operation. See also: item Definition at line 53 of file constdata.h. Referenced by init_inventory().

struct filelink world_descriptor::stdata

Definition at line 71 of file constdata.h. Referenced by link_data_file().

struct filelink world_descriptor::stsizes

Definition at line 70 of file constdata.h. Referenced by init_shuffle_tab().

struct filelink world_descriptor::tileoffset

Position in the data file of the tiles table. See also: tiledesc Definition at line 17 of file constdata.h. Referenced by link_data_file().

struct filelink world_descriptor::titlescreen_dark_plane

Definition at line 74 of file constdata.h.

struct filelink world_descriptor::titlescreen_light_plane

Definition at line 73 of file constdata.h.

uint world_descriptor::tutorialclass

Index of the 'tutorial' player class. Definition at line 79 of file constdata.h. Referenced by init_player().

struct filelink world_descriptor::tutorialmap

Definition at line 86 of file constdata.h. Referenced by main_menu().

---

The documentation for this struct was generated from the following file:

• include/constdata.h

---