src/system/angband.h

   1 #pragma once
   2
   3 /*!
   4  * @file angband.h
   5  * @brief Angband(変愚蛮怒)メインヘッダファイル
   6  * Main "Angband" header file
   7  * @date 2014/08/08
   8  * @author
   9  * Copyright (c) 1989 James E. Wilson
  10  * @details *
  11  * This software may be copied and distributed for educational, research, and
  12  * not for profit purposes provided that this copyright and statement are
  13  * included in all such copies.
  14  * This file has been modified for use with "Angband 2.8.2"
  15  */
  16
  17 /*
  18  * Then, include the header files for the low-level code
  19  */
  20 #include "term/z-form.h"
  21 #include "term/z-rand.h"
  22 #include "term/z-term.h"
  23 #include "term/z-util.h"
  24 #include "term/z-virt.h"
  25
  26 #include "locale/language-switcher.h"
  27
  28 /*
  29  * Include the "Angband" configuration header
  30  */
  31 #include "system/gamevalue.h"
  32
  33 /***** Some copyright messages follow below *****/
  34
  35 /*!
  36  *
  37  * @mainpage 変愚蛮怒仕様書
  38  *
  39  * @par
  40  * 変愚蛮怒の仕様をangband.hをソースにDoxygenで読めるようまとめておきます。<br>
  41  *
  42  * @par
  43  * - @ref page_basic "基本方針"
  44  * - @ref page_license "Angbandソース内ライセンス記述"
  45  *
  46  *
  47  *
  48  *
  49  */
  50
  51 /*!
  52  * @page page_basic リファクタリング基本方針
  53  *
  54  * 現在まとめ中。
  55  *
  56  * @ref index "メインページへ"
  57  */
  58
  59 /*!
  60  * @page page_license Angbandソース内ライセンス記述
  61  *
  62  * 以下、angband.hに当初から在った記述となります。
  63  * <pre>
  64  * Note that these copyright messages apply to an ancient version
  65  * of Angband, as in, from pre-2.4.frog-knows days, and thus the
  66  * reference to "5.0" is rather misleading...
  67  *
  68  * UNIX ANGBAND Version 5.0
  69  *
  70  * Original copyright message follows.
  71  *
  72  * ANGBAND Version 4.8  COPYRIGHT (c) Robert Alan Koeneke
  73  *
  74  *       I lovingly dedicate this game to hackers and adventurers
  75  *       everywhere...
  76  *
  77  *       Designer and Programmer:
  78  *              Robert Alan Koeneke
  79  *              University of Oklahoma
  80  *
  81  *       Assistant Programmer:
  82  *              Jimmey Wayne Todd
  83  *              University of Oklahoma
  84  *
  85  *       Assistant Programmer:
  86  *              Gary D. McAdoo
  87  *              University of Oklahoma
  88  *
  89  *       UNIX Port:
  90  *              James E. Wilson
  91  *              UC Berkeley
  92  *              wilson@ernie.Berkeley.EDU
  93  *              ucbvax!ucbernie!wilson
  94  *
  95  *       ANGBAND may be copied and modified freely as long as the above
  96  *       credits are retained.  No one who-so-ever may sell or market
  97  *       this software in any form without the expressed written consent
  98  *       of the author Robert Alan Koeneke.
  99  * </pre>
 100  *
 101  * @ref index "メインページへ"
 102  */
 103
 104 /*!
 105  * @dir action プレイヤーの行動実行処理(アイテム発動/移動/変異能力/開閉/レイシャル/走る/投擲/トラベル機能/掘削/装備持ち替え)
 106  * @dir artifact 固定アーティファクト/ランダムアーティファクトの生成処理
 107  * @dir autopick 自動拾い処理
 108  * @dir birth プレイヤーキャラクターメイク
 109  * @dir blue-magic 青魔法処理全般
 110  * @dir cmd-action プレイヤーの行動コマンド処理(攻撃/剣術/ものまね/超能力等職業固有能力/移動/開閉/ペット命令/レイシャル/射撃/トラベル/掘削/その他)
 111  * @dir cmd-building 施設の各サービス処理
 112  * @dir cmd-io 入出力コマンド処理(自動拾い設定/記録設定/ステータスダンプ/フロア地点指定/ゲームオプション/ヘルプ/各情報/思い出/マクロ/メニューウィンドウ/スクリーンダンプ/セーブ/階の雰囲気)
 113  * @dir cmd-item アイテムコマンド処理(壊す/食べる/装備する/魔道具吸収/飲む/読む/光源燃料補充/鍛冶/投擲/杖、魔法棒、ロッドの使用)
 114  * @dir cmd-visual 描画/表示に関するコマンド(再描画/全体マップ表示/シンボル変更)
 115  * @dir combat 白兵/射撃戦闘(命中処理/クリティカル処理/威力計算/オーラ反撃処理/剣術定義/幻覚時メッセージ/マーシャルアーツ/射撃武器処理/スレイ効果)
 116  * @dir core ゲーム進行処理部（TODO:各ファイル概要は後で追記）
 117  * @dir dungeon ダンジョンの進行補助処理(ダンジョン内のクエストなどが主)
 118  * @dir effect 各属性効果の判定や効力発揮
 119  * @dir flavor アイテムの特性やフレーバーテキスト表現
 120  * @dir floor フロア生成/管理処理
 121  * @dir game-option 詐欺モードも含めたゲームオプション
 122  * @dir grid グリッド(各マス)に関する処理
 123  * @dir info-reader *_info.txtの読み込み処理
 124  * @dir inventory 所持品に関する処理(フロアからの取得/呪いの品/攻撃による損壊/所持状態の記述/所持数表記/アイテムスロット/ザック溢れ/選択処理/自然充填)
 125  * @dir store 店舗処理
 126  */