/* ************************************************************************
* File: db.h Part of CircleMUD *
* Usage: header file for database handling *
* *
* All rights reserved. See license.doc for complete information. *
* *
* Copyright (C) 1993, 94 by the Trustees of the Johns Hopkins University *
* CircleMUD is based on DikuMUD, Copyright (C) 1990, 1991. *
************************************************************************ */
#ifndef _db_h_
#define _db_h_
#include <stdio.h>
/* names of various files and directories */
#define INDEX_FILE "index" /* index of world files */
#define MINDEX_FILE "index.mini" /* ... and for mini-mud-mode */
#define WLD_PREFIX "world/wld" /* room definitions */
#define MOB_PREFIX "world/mob" /* monster prototypes */
#define OBJ_PREFIX "world/obj" /* object prototypes */
#define ZON_PREFIX "world/zon" /* zon defs & command tables */
#define SHP_PREFIX "world/shp" /* shop definitions */
#define QST_PREFIX "world/qst" /* autoquests */
#define CREDITS_FILE "text/credits" /* for the 'credits' command */
#define NEWS_FILE "text/news" /* for the 'news' command */
#define MOTD_FILE "text/motd" /* messages of the day / mortal */
#define IMOTD_FILE "text/imotd" /* messages of the day / immort */
#define HELP_KWRD_FILE "text/help_table"/* for HELP <keywrd> */
#define HELP_PAGE_FILE "text/help" /* for HELP <CR> */
#define INFO_FILE "text/info" /* for INFO */
#define WIZLIST_FILE "text/wizlist" /* for WIZLIST */
#define IMMLIST_FILE "text/immlist" /* for IMMLIST */
#define BACKGROUND_FILE "text/background" /* for the background story */
#define POLICIES_FILE "text/policies" /* player policies/rules */
#define HANDBOOK_FILE "text/handbook" /* handbook for new immorts */
#define HINDEX_FILE "text/index" /* index of help files */
#define WIZHELP_FILE "text/wizhelp" /* for WIZHELP <keywrd> */
#define IDEA_FILE "misc/ideas" /* for the 'idea'-command */
#define TYPO_FILE "misc/typos" /* 'typo' */
#define BUG_FILE "misc/bugs" /* 'bug' */
#define MESS_FILE "misc/messages" /* damage messages */
#define SOCMESS_FILE "misc/socials" /* messgs for social acts */
#define XNAME_FILE "misc/xnames" /* invalid name substrings */
#define PLAYER_FILE "etc/players" /* the player database */
#define MAIL_FILE "etc/plrmail" /* for the mudmail system */
#define BAN_FILE "etc/badsites" /* for the siteban system */
#define HCONTROL_FILE "etc/hcontrol" /* for the house system */
#define PLR_PREFIX "etc/pfiles"
#define PLR_INDEX_FILE "etc/pfiles/plr_index"
#define SLASH "/"
/* change these if you want to put all files in the same directory (or if
you just like big file names
*/
#define PLR_SUFFIX ""
/* new bitvector data for use in player_index_element */
#define PINDEX_DELETED (1 << 11) /* deleted player */
#define PINDEX_NODELETE (1 << 12) /* protected player */
#define PINDEX_SELFDELETE (1 << 11) /* player is selfdeleting*/
/* public procedures in db.c */
void boot_db(void);
int create_entry(char *name);
void zone_update(void);
int real_room(int virt);
char *fread_string(FILE *fl, char *error);
long get_id_by_name(char *name);
char *get_name_by_id(long id);
int load_char(char *name, struct char_data *ch);
void save_char(struct char_data *ch, sh_int load_room);
void init_char(struct char_data *ch);
struct char_data *create_char(void);
struct char_data *read_mobile(int nr, int type);
int real_mobile(int virt);
int vnum_mobile(char *searchname, struct char_data *ch);
void clear_char(struct char_data *ch);
void reset_char(struct char_data *ch);
void free_char(struct char_data *ch);
void read_etext(struct char_data *ch);
void write_etext(struct char_data *ch);
struct obj_data *create_obj(void);
void clear_object(struct obj_data *obj);
void clear_room(struct room_data *room);
void free_obj(struct obj_data *obj);
void free_room(struct room_data *room);
int real_object(int virt);
struct obj_data *read_object(int nr, int type);
int vnum_object(char *searchname, struct char_data *ch);
int real_shop(int virt);
int real_quest(int virt);
/* structure for the reset commands */
struct reset_com {
char command; /* current command */
bool if_flag; /* if TRUE: exe only if preceding exe'd */
int arg1; /* */
int arg2; /* Arguments to the command */
int arg3; /* */
int line; /* line number this command appears on */
/*
* Commands: *
* 'M': Read a mobile *
* 'O': Read an object *
* 'G': Give obj to mob *
* 'P': Put obj in obj *
* 'G': Obj to char *
* 'E': Obj to char equip *
* 'D': Set state of door *
*/
};
/* zone definition structure. for the 'zone-table' */
struct zone_data {
char *name; /* name of this zone */
int lifespan; /* how long between resets (minutes) */
int age; /* current age of this zone (minutes) */
int top; /* upper limit for rooms in this zone */
int security; /* security rating for node */
int connected; /* zone is connected */
int alert; /* alert level for zones with Matrix rooms */
int reset_mode; /* conditions for reset (see below) */
int number; /* virtual number of this zone */
sh_int num_cmds; // number of commands in the table
int editor_ids[5]; // array of zone editors
struct reset_com *cmd; /* command table for reset */
/*
* Reset mode: *
* 0: Don't reset, and don't update age. *
* 1: Reset if no PC's are located in zone. *
* 2: Just reset. *
*/
};
/* for queueing zones for update */
struct reset_q_element {
int zone_to_reset; /* ref to zone_data */
struct reset_q_element *next;
};
/* structure for the update queue */
struct reset_q_type {
struct reset_q_element *head;
struct reset_q_element *tail;
};
struct player_index_element {
char *name;
long id;
int level;
int flags;
time_t last;
};
struct help_index_element {
char *keyword;
long pos;
};
/* global buffering system */
#ifdef __DB_CC__
char buf[MAX_STRING_LENGTH];
char buf1[MAX_STRING_LENGTH];
char buf2[MAX_STRING_LENGTH];
char arg[MAX_STRING_LENGTH];
#else
extern char buf[MAX_STRING_LENGTH];
extern char buf1[MAX_STRING_LENGTH];
extern char buf2[MAX_STRING_LENGTH];
extern char arg[MAX_STRING_LENGTH];
#endif
#ifndef __CONFIG_CC__
extern char *OK;
extern char *NOPERSON;
extern char *NOEFFECT;
#endif
#endif