src/grid.h

   1 #pragma once
   2
   3 /*!
   4  * @file grid.h
   5  * @brief ダンジョンの生成処理の基幹部分ヘッダーファイル
   6  * @date 2014/08/15
   7  * @details
   8  * Purpose: header file for grid.c, used only in dungeon generation
   9  * files (generate.c, rooms.c)
  10  * @author
  11  * Copyright (c) 1989 James E. Wilson, Robert A. Koeneke
  12  * This software may be copied and distributed for educational, research, and
  13  * not for profit purposes provided that this copyright and statement are
  14  * included in all such copies.
  15  */
  16
  17
  18  /*
  19   * A single "grid" in a Cave
  20   *
  21   * Note that several aspects of the code restrict the actual grid
  22   * to a max size of 256 by 256.  In partcular, locations are often
  23   * saved as bytes, limiting each coordinate to the 0-255 range.
  24   *
  25   * The "o_idx" and "m_idx" fields are very interesting.  There are
  26   * many places in the code where we need quick access to the actual
  27   * monster or object(s) in a given grid.  The easiest way to
  28   * do this is to simply keep the index of the monster and object
  29   * (if any) with the grid, but this takes 198*66*4 bytes of memory.
  30   * Several other methods come to mind, which require only half this
  31   * amound of memory, but they all seem rather complicated, and would
  32   * probably add enough code that the savings would be lost.  So for
  33   * these reasons, we simply store an index into the "o_list" and
  34   * ">m_list" arrays, using "zero" when no monster/object is present.
  35   *
  36   * Note that "o_idx" is the index of the top object in a stack of
  37   * objects, using the "next_o_idx" field of objects (see below) to
  38   * create the singly linked list of objects.  If "o_idx" is zero
  39   * then there are no objects in the grid.
  40   *
  41   * Note the special fields for the "MONSTER_FLOW" code.
  42   */
  43
  44 typedef struct player_type player_type; // TODO: Delete Finally.
  45
  46 typedef struct grid_type grid_type;
  47
  48 struct grid_type
  49 {
  50         BIT_FLAGS info;         /* Hack -- grid flags */
  51
  52         FEAT_IDX feat;          /* Hack -- feature type */
  53         OBJECT_IDX o_idx;               /* Object in this grid */
  54         MONSTER_IDX m_idx;              /* Monster in this grid */
  55
  56         /*! 地形の特別な情報を保存する / Special grid info
  57          * 具体的な使用一覧はクエスト行き階段の移行先クエストID、
  58          * 各ダンジョン入口の移行先ダンジョンID、
  59          *
  60          */
  61         s16b special;
  62
  63         FEAT_IDX mimic;         /* Feature to mimic */
  64
  65         byte cost;              /* Hack -- cost of flowing */
  66         byte dist;              /* Hack -- distance from player */
  67         byte when;              /* Hack -- when cost was computed */
  68 };
  69
  70 /*
  71  *  A structure type for terrain template of saving dungeon floor
  72  */
  73 typedef struct
  74 {
  75         BIT_FLAGS info;
  76         FEAT_IDX feat;
  77         FEAT_IDX mimic;
  78         s16b special;
  79         u16b occurrence;
  80 } grid_template_type;
  81
  82 #define feat_locked_door_random(DOOR_TYPE) \
  83         (feat_door[(DOOR_TYPE)].num_locked ? \
  84          feat_door[(DOOR_TYPE)].locked[randint0(feat_door[(DOOR_TYPE)].num_locked)] : feat_none)
  85
  86 #define feat_jammed_door_random(DOOR_TYPE) \
  87         (feat_door[(DOOR_TYPE)].num_jammed ? \
  88          feat_door[(DOOR_TYPE)].jammed[randint0(feat_door[(DOOR_TYPE)].num_jammed)] : feat_none)
  89
  90 /* Macros */
  91 #define set_cave_feat(FL,Y,X,F)    ((FL)->grid_array[(Y)][(X)].feat = (F))
  92 #define add_cave_info(FL,Y,X,I)    ((FL)->grid_array[(Y)][(X)].info |= (I))
  93
  94 /*!
  95  * @brief 指定座標に瓦礫を配置する
  96  * @param Y 指定Y座標
  97  * @param X 指定X座標
  98  */
  99 #define place_rubble(F,Y,X)       set_cave_feat(F,Y,X,feat_rubble)
 100
 101 /*!
 102  * @brief 指定座標がFLOOR属性を持ったマスかどうかを返す
 103  * @param Y 指定Y座標
 104  * @param X 指定X座標
 105  * @return FLOOR属性を持っているならばTRUE
 106  */
 107 #define is_floor_bold(F,Y,X) (F->grid_array[Y][X].info & CAVE_FLOOR)
 108 #define is_extra_bold(F,Y,X) (F->grid_array[Y][X].info & CAVE_EXTRA)
 109
 110 #define is_inner_bold(F,Y,X) (F->grid_array[Y][X].info & CAVE_INNER)
 111 #define is_outer_bold(F,Y,X) (F->grid_array[Y][X].info & CAVE_OUTER)
 112 #define is_solid_bold(F,Y,X) (F->grid_array[Y][X].info & CAVE_SOLID)
 113
 114 #define is_floor_grid(C) ((C)->info & CAVE_FLOOR)
 115 #define is_extra_grid(C) ((C)->info & CAVE_EXTRA)
 116 #define is_inner_grid(C) ((C)->info & CAVE_INNER)
 117 #define is_outer_grid(C) ((C)->info & CAVE_OUTER)
 118 #define is_solid_grid(C) ((C)->info & CAVE_SOLID)
 119
 120 /*
 121  * 特殊なマス状態フラグ / Special grid flags
 122  */
 123 #define CAVE_MARK       0x0001    /*!< 現在プレイヤーの記憶に収まっている / memorized feature */
 124 #define CAVE_GLOW       0x0002    /*!< マス自体が光源を持っている / self-illuminating */
 125 #define CAVE_ICKY       0x0004    /*!< 生成されたVaultの一部である / part of a vault */
 126 #define CAVE_ROOM       0x0008    /*!< 生成された部屋の一部である / part of a room */
 127 #define CAVE_LITE       0x0010    /*!< 現在光に照らされている / lite flag  */
 128 #define CAVE_VIEW       0x0020    /*!< 現在プレイヤーの視界に収まっている / view flag */
 129 #define CAVE_TEMP       0x0040    /*!< 光源に関する処理のアルゴリズム用記録フラグ / temp flag */
 130 #define CAVE_XTRA       0x0080    /*!< 視界に関する処理のアルゴリズム用記録フラグ(update_view()等参照) / misc flag */
 131 #define CAVE_MNLT       0x0100    /*!< モンスターの光源によって照らされている / Illuminated by monster */
 132 #define CAVE_MNDK       0x8000    /*!< モンスターの暗源によって暗闇になっている / Darken by monster */
 133
 134 /* Used only while floor generation */
 135 #define CAVE_FLOOR      0x0200  /*!< フロア属性のあるマス */
 136 #define CAVE_EXTRA      0x0400
 137 #define CAVE_INNER      0x0800
 138 #define CAVE_OUTER      0x1000
 139 #define CAVE_SOLID      0x2000
 140 #define CAVE_VAULT      0x4000
 141 #define CAVE_MASK (CAVE_FLOOR | CAVE_EXTRA | CAVE_INNER | CAVE_OUTER | CAVE_SOLID | CAVE_VAULT)
 142
 143 /* Used only after floor generation */
 144 #define CAVE_KNOWN      0x0200    /* Directly viewed or map detected flag */
 145 #define CAVE_NOTE       0x0400    /* Flag for delayed visual update (needs note_spot()) */
 146 #define CAVE_REDRAW     0x0800    /* Flag for delayed visual update (needs lite_spot()) */
 147 #define CAVE_OBJECT     0x1000    /* Mirror, glyph, etc. */
 148 #define CAVE_UNSAFE     0x2000    /* Might have trap */
 149 #define CAVE_IN_DETECT  0x4000    /* trap detected area (inner circle only) */
 150
 151 /* Types of conversions */
 152 #define CONVERT_TYPE_FLOOR   0
 153 #define CONVERT_TYPE_WALL    1
 154 #define CONVERT_TYPE_INNER   2
 155 #define CONVERT_TYPE_OUTER   3
 156 #define CONVERT_TYPE_SOLID   4
 157 #define CONVERT_TYPE_STREAM1 5
 158 #define CONVERT_TYPE_STREAM2 6
 159
 160 /* Externs */
 161
 162 extern bool new_player_spot(player_type *creature_ptr);
 163
 164 /* Types of doors */
 165 #define DOOR_DEFAULT    -1
 166 #define DOOR_DOOR        0
 167 #define DOOR_GLASS_DOOR  1
 168 #define DOOR_CURTAIN     2
 169
 170 #define MAX_DOOR_TYPES   3
 171
 172 extern void place_bound_perm_wall(player_type *player_ptr, grid_type *g_ptr);
 173
 174 extern bool is_known_trap(grid_type *g_ptr);
 175 extern bool is_hidden_door(grid_type *g_ptr);
 176 extern bool is_mirror_grid(grid_type *g_ptr);
 177 extern bool is_glyph_grid(grid_type *g_ptr);
 178 extern bool is_explosive_rune_grid(grid_type *g_ptr);
 179
 180 extern bool player_can_enter(player_type *creature_ptr, FEAT_IDX feature, BIT_FLAGS16 mode);
 181
 182 /*!
 183  * マス構造体のspecial要素を利用する地形かどうかを判定するマクロ / Is this feature has special meaning (except floor_id) with g_ptr->special?
 184  */
 185 #define feat_uses_special(F) (have_flag(f_info[(F)].flags, FF_SPECIAL))
 186
 187 /* grids.c */
 188 extern POSITION distance(POSITION y1, POSITION x1, POSITION y2, POSITION x2);
 189 extern void update_local_illumination(player_type *creature_ptr, POSITION y, POSITION x);
 190 extern bool no_lite(player_type *creature_ptr);
 191 extern void print_rel(player_type *subject_ptr, SYMBOL_CODE c, TERM_COLOR a, TERM_LEN y, TERM_LEN x);
 192 extern void note_spot(POSITION y, POSITION x);
 193 extern void lite_spot(POSITION y, POSITION x);
 194 extern void update_flow(player_type *subject_ptr);
 195 extern FEAT_IDX feat_state(FEAT_IDX feat, int action);
 196 extern void cave_alter_feat(player_type *player_ptr, POSITION y, POSITION x, int action);
 197 extern void remove_mirror(player_type *caster_ptr, POSITION y, POSITION x);
 198 extern bool is_open(FEAT_IDX feat);
 199 extern bool check_local_illumination(player_type *creature_ptr, POSITION y, POSITION x);
 200
 201 extern bool cave_monster_teleportable_bold(MONSTER_IDX m_idx, POSITION y, POSITION x, BIT_FLAGS mode);
 202 extern bool cave_player_teleportable_bold(POSITION y, POSITION x, BIT_FLAGS mode);
 203
 204 typedef enum grid_bold_type
 205 {
 206         floor,
 207         extra,
 208         extra_perm,
 209         inner,
 210         inner_perm,
 211         outer,
 212         outer_noperm,
 213         solid,
 214         solid_perm
 215 } grid_bold_type;
 216
 217 extern void place_grid(player_type *player_ptr, grid_type *g_ptr, grid_bold_type pg_type);
 218 extern bool darkened_grid(player_type *player_ptr, grid_type *g_ptr);
 219 extern void delete_monster(player_type *player_ptr, POSITION y, POSITION x);
 220 extern void place_bold(player_type *player_ptr, POSITION y, POSITION x, grid_bold_type gh_type);
 221 void place_solid_perm_bold(player_type *player_ptr, POSITION y, POSITION x);
 222 void place_solid_noperm_bold(player_type *player_ptr, POSITION y, POSITION x);
 223
 224 /*
 225  * Get feature mimic from f_info[] (applying "mimic" field)
 226  */
 227 #define get_feat_mimic(C) \
 228         (f_info[(C)->mimic ? (C)->mimic : (C)->feat].mimic)
 229
 230 /*
 231  * This macro allows us to efficiently add a grid to the "lite" array,
 232  * note that we are never called for illegal grids, or for grids which
 233  * have already been placed into the "lite" array, and we are never
 234  * called when the "lite" array is full.
 235  */
 236 #define cave_lite_hack(F,Y,X) \
 237 {\
 238         if (!((F)->grid_array[Y][X].info & (CAVE_LITE))) \
 239         { \
 240                 (F)->grid_array[Y][X].info |= (CAVE_LITE); \
 241                 (F)->lite_y[(F)->lite_n] = (Y); \
 242                 (F)->lite_x[(F)->lite_n++] = (X); \
 243         } \
 244 }
 245
 246 /*
 247  * For delayed visual update
 248  */
 249 #define cave_note_and_redraw_later(F,C,Y,X) \
 250 {\
 251         (C)->info |= CAVE_NOTE; \
 252         cave_redraw_later((F), (C), (Y), (X)); \
 253 }
 254
 255 /*
 256 * For delayed visual update
 257 */
 258 #define cave_redraw_later(F,G,Y,X) \
 259 {\
 260         if (!((G)->info & CAVE_REDRAW)) \
 261         { \
 262                 (G)->info |= CAVE_REDRAW; \
 263                 (F)->redraw_y[(F)->redraw_n] = (Y); \
 264                 (F)->redraw_x[(F)->redraw_n++] = (X); \
 265         } \
 266 }
 267
 268 /*
 269  * This macro allows us to efficiently add a grid to the "view" array,
 270  * note that we are never called for illegal grids, or for grids which
 271  * have already been placed into the "view" array, and we are never
 272  * called when the "view" array is full.
 273  */
 274 #define cave_view_hack(F,C,Y,X) \
 275 {\
 276     if (!((C)->info & (CAVE_VIEW))){\
 277     (C)->info |= (CAVE_VIEW); \
 278     (F)->view_y[(F)->view_n] = (Y); \
 279     (F)->view_x[(F)->view_n] = (X); \
 280     (F)->view_n++;}\
 281 }