OSDN Git Service

クエスト実装に関するDoxygenコメントを追加。 / Add Doxygen comments for quest implementation.
authorDeskull <desull@users.sourceforge.jp>
Tue, 10 Nov 2015 11:52:57 +0000 (20:52 +0900)
committerDeskull <desull@users.sourceforge.jp>
Tue, 10 Nov 2015 11:52:57 +0000 (20:52 +0900)
src/defines.h
src/types.h

index 4bf935c..64bf19e 100644 (file)
@@ -4629,26 +4629,26 @@ extern int PlayerUID;
 /*
  * Quest status
  */
-#define QUEST_STATUS_UNTAKEN              0
-#define QUEST_STATUS_TAKEN                1
-#define QUEST_STATUS_COMPLETED            2
-#define QUEST_STATUS_REWARDED             3
-#define QUEST_STATUS_FINISHED             4
-#define QUEST_STATUS_FAILED               5
-#define QUEST_STATUS_FAILED_DONE          6
-#define QUEST_STATUS_STAGE_COMPLETED      7
+#define QUEST_STATUS_UNTAKEN              0 /*!< クエストステータス状態:未発生*/
+#define QUEST_STATUS_TAKEN                1 /*!< クエストステータス状態:発生中*/
+#define QUEST_STATUS_COMPLETED            2 /*!< クエストステータス状態:達成*/
+#define QUEST_STATUS_REWARDED             3 /*!< クエストステータス状態:報酬受け取り前*/
+#define QUEST_STATUS_FINISHED             4 /*!< クエストステータス状態:完了*/
+#define QUEST_STATUS_FAILED               5 /*!< クエストステータス状態:失敗*/
+#define QUEST_STATUS_FAILED_DONE          6 /*!< クエストステータス状態:失敗完了*/
+#define QUEST_STATUS_STAGE_COMPLETED      7 /*!< クエストステータス状態:ステージ毎達成*/
 
 /*
  * Quest type
  */
-#define QUEST_TYPE_KILL_LEVEL                1
-#define QUEST_TYPE_KILL_ANY_LEVEL            2
-#define QUEST_TYPE_FIND_ARTIFACT             3
-#define QUEST_TYPE_FIND_EXIT                 4
-#define QUEST_TYPE_KILL_NUMBER               5
-#define QUEST_TYPE_KILL_ALL                  6
-#define QUEST_TYPE_RANDOM                    7
-#define QUEST_TYPE_TOWER                     8
+#define QUEST_TYPE_KILL_LEVEL                1 /*!< クエスト目的: 特定のユニークモンスターを倒す */
+#define QUEST_TYPE_KILL_ANY_LEVEL            2 /*!< クエスト目的: イベント受託時点でランダムで選ばれた特定のユニークモンスターを倒す */
+#define QUEST_TYPE_FIND_ARTIFACT             3 /*!< クエスト目的: 特定のアーティファクトを発見する */
+#define QUEST_TYPE_FIND_EXIT                 4 /*!< クエスト目的: 脱出する */
+#define QUEST_TYPE_KILL_NUMBER               5 /*!< クエスト目的: モンスターを無差別に特定数倒す */
+#define QUEST_TYPE_KILL_ALL                  6 /*!< クエスト目的: エリア中のすべてのモンスターを全て倒す */
+#define QUEST_TYPE_RANDOM                    7 /*!< クエスト目的: ランダムクエストとして選ばれたユニーク1体を倒す */
+#define QUEST_TYPE_TOWER                     8 /*!< クエスト目的: 複数のエリアの全てのモンスターを倒す */
 
 /*
  * Initialization flags
@@ -4663,10 +4663,10 @@ extern int PlayerUID;
 /*
  * Quest flags
  */
-#define QUEST_FLAG_SILENT  0x01 /* no messages fro completion */
-#define QUEST_FLAG_PRESET  0x02 /* quest is outside the main dungeon */
-#define QUEST_FLAG_ONCE    0x04 /* quest is marked finished after leaving */
-#define QUEST_FLAG_TOWER   0x08 /* Tower quest is special */
+#define QUEST_FLAG_SILENT  0x01 /*!< クエストフラグ: クエスト進行に関する情報表示を抑止する / no messages from completion */
+#define QUEST_FLAG_PRESET  0x02 /*!< クエストフラグ: クエストがダンジョン外で発生する / quest is outside the main dungeon */
+#define QUEST_FLAG_ONCE    0x04 /*!< クエストフラグ: クエストがフロアを出た時点で完了する / quest is marked finished after leaving */
+#define QUEST_FLAG_TOWER   0x08 /*!< クエストフラグ: クエスト:塔の形式で進行する / Tower quest is special */
 
 /*
  * Available graphic modes
index 943039e..3197fa6 100644 (file)
@@ -332,7 +332,7 @@ struct monster_race
        u16b artifact_rarity[4];        /* 特定アーティファクトレア度 */
        u16b artifact_percent[4]; /* 特定アーティファクトドロップ率 */
 
-       u32b arena_ratio; /* アリーナの評価修正値(%基準 / 0=100%)*/
+       u32b arena_ratio;               /* アリーナの評価修正値(%基準 / 0=100%) / Arena */
 
        s16b next_r_idx;
        u32b next_exp;
@@ -353,7 +353,7 @@ struct monster_race
 
        byte cur_num;                   /* Monster population on current level */
 
-       s16b floor_id;                  /* Location of unique monster */
+       s16b floor_id;          /* Location of unique monster */
 
 
        s16b r_sights;                  /* Count sightings of this monster */
@@ -382,7 +382,7 @@ struct monster_race
        u32b r_flags4;                  /* Observed racial flags */
        u32b r_flags5;                  /* Observed racial flags */
        u32b r_flags6;                  /* Observed racial flags */
-       /* u32b r_flags7; */                    /* Observed racial flags */
+       /* u32b r_flags7; */    /* Observed racial flags */
        u32b r_flagsr;                  /* Observed racial resistance flags */
 };
 
@@ -684,32 +684,34 @@ struct option_type
 };
 
 
-/*
- * Structure for the "quests"
- */
 typedef struct quest_type quest_type;
 
+/*!
+ * @struct quest_type
+ * @brief クエスト情報の構造体 / Structure for the "quests".
+ */
+
 struct quest_type
 {
-       s16b status;            /* Is the quest taken, completed, finished? */
+       s16b status;            /*!< クエストの進行ステータス / Is the quest taken, completed, finished? */
 
-       s16b type;              /* The quest type */
+       s16b type;              /*!< クエストの種別 / The quest type */
 
-       char name[60];          /* Quest name */
-       s16b level;             /* Dungeon level */
-       s16b r_idx;             /* Monster race */
+       char name[60];          /*!< クエスト名 / Quest name */
+       s16b level;             /*!< 処理階層 / Dungeon level */
+       s16b r_idx;             /*!< クエスト対象のモンスターID / Monster race */
 
-       s16b cur_num;           /* Number killed */
-       s16b max_num;           /* Number required */
+       s16b cur_num;           /*!< 撃破したモンスターの数 / Number killed */
+       s16b max_num;           /*!< 求められるモンスターの撃破数 / Number required */
 
-       s16b k_idx;             /* object index */
-       s16b num_mon;           /* number of monsters on level */
+       s16b k_idx;             /*!< クエスト対象のアイテムID / object index */
+       s16b num_mon;           /*!< QUEST_TYPE_KILL_NUMBER時の目標撃破数 number of monsters on level */
 
-       byte flags;             /* quest flags */
-       byte dungeon;           /* quest dungeon */
+       byte flags;             /*!< クエストに関するフラグビット / quest flags */
+       byte dungeon;           /*!< クエスト対象のダンジョンID / quest dungeon */
 
-       byte complev;           /* player level (complete) */
-       u32b comptime;          /* quest clear time*/
+       byte complev;           /*!< クリア時プレイヤーレベル / player level (complete) */
+       u32b comptime;          /*!< クリア時ゲーム時間 /  quest clear time*/
 };