From 02877e19f3197f304547c321362e058f880a38b4 Mon Sep 17 00:00:00 2001 From: Deskull Date: Tue, 10 Nov 2015 20:52:57 +0900 Subject: [PATCH] =?utf8?q?=E3=82=AF=E3=82=A8=E3=82=B9=E3=83=88=E5=AE=9F?= =?utf8?q?=E8=A3=85=E3=81=AB=E9=96=A2=E3=81=99=E3=82=8BDoxygen=E3=82=B3?= =?utf8?q?=E3=83=A1=E3=83=B3=E3=83=88=E3=82=92=E8=BF=BD=E5=8A=A0=E3=80=82?= =?utf8?q?=20/=20Add=20Doxygen=20comments=20for=20quest=20implementation.?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit --- src/defines.h | 40 ++++++++++++++++++++-------------------- src/types.h | 40 +++++++++++++++++++++------------------- 2 files changed, 41 insertions(+), 39 deletions(-) diff --git a/src/defines.h b/src/defines.h index 4bf935cac..64bf19e08 100644 --- a/src/defines.h +++ b/src/defines.h @@ -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 diff --git a/src/types.h b/src/types.h index 943039e3f..3197fa600 100644 --- a/src/types.h +++ b/src/types.h @@ -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*/ }; -- 2.11.0