From: deskull Date: Sun, 6 Dec 2020 21:27:19 +0000 (+0900) Subject: [Refactor] monster_type のDoxygenコメント追加． / Add Doxygen comments in monster_type. X-Git-Url: http://git.osdn.net/view?p=hengband%2Fhengband.git;a=commitdiff_plain;h=5031cbfd7edb671c1b0cf705744381f5a6a8c1fc [Refactor] monster_type のDoxygenコメント追加． / Add Doxygen comments in monster_type. --- diff --git a/src/system/monster-type-definition.h b/src/system/monster-type-definition.h index 7e26a0060..a3aa4a6ef 100644 --- a/src/system/monster-type-definition.h +++ b/src/system/monster-type-definition.h @@ -2,45 +2,46 @@ #include "monster/monster-timed-effect-types.h" -/* - * Monster information, for a specific monster. - * Note: fy, fx constrain dungeon size to 256x256 +/*! + * @brief Monster information, for a specific monster. + * @Note + * fy, fx constrain dungeon size to 256x256 * The "hold_o_idx" field points to the first object of a stack * of objects (if any) being carried by the monster (see above). */ typedef struct floor_type floor_type; typedef struct monster_race monster_race; typedef struct monster_type { - MONRACE_IDX r_idx; /* Monster race index 0 = dead. */ - MONRACE_IDX ap_r_idx; /* Monster race appearance index */ - floor_type *current_floor_ptr; + MONRACE_IDX r_idx; /*!< モンスターの実種族ID (これが0の時は死亡扱いになる) / Monster race index 0 = dead. */ + MONRACE_IDX ap_r_idx; /*!< モンスターの外見種族ID（あやしい影、たぬき、ジュラル星人誤認などにより変化する）Monster race appearance index */ + floor_type *current_floor_ptr; /*!< 所在フロアID（現状はfloor_type構造体によるオブジェクトは1つしかないためソースコード設計上の意義以外はない）*/ /* Sub-alignment flags for neutral monsters */ - #define SUB_ALIGN_NEUTRAL 0x0000 - #define SUB_ALIGN_EVIL 0x0001 - #define SUB_ALIGN_GOOD 0x0002 - BIT_FLAGS8 sub_align; /* Sub-alignment for a neutral monster */ + #define SUB_ALIGN_NEUTRAL 0x0000 /*!< モンスターのサブアライメント:中立 */ + #define SUB_ALIGN_EVIL 0x0001 /*!< モンスターのサブアライメント:善 */ + #define SUB_ALIGN_GOOD 0x0002 /*!< モンスターのサブアライメント:悪 */ + BIT_FLAGS8 sub_align; /*!< 中立属性のモンスターが召喚主のアライメントに従い一時的に立っている善悪陣営 / Sub-alignment for a neutral monster */ - POSITION fy; /* Y location on map */ - POSITION fx; /* X location on map */ - HIT_POINT hp; /* Current Hit points */ - HIT_POINT maxhp; /* Max Hit points */ - HIT_POINT max_maxhp; /* Max Max Hit points */ - HIT_POINT dealt_damage; /* Sum of damages dealt by player */ - TIME_EFFECT mtimed[MAX_MTIMED]; /* Timed status counter */ - SPEED mspeed; /* Monster "speed" */ - ACTION_ENERGY energy_need; /* Monster "energy" */ - POSITION cdis; /* Current dis from player */ - BIT_FLAGS8 mflag; /* Extra monster flags */ - BIT_FLAGS8 mflag2; /* Extra monster flags */ - bool ml; /* Monster is "visible" */ - OBJECT_IDX hold_o_idx; /* Object being held (if any) */ - POSITION target_y; /* Can attack !los player */ - POSITION target_x; /* Can attack !los player */ - STR_OFFSET nickname; /* Monster's Nickname */ - EXP exp; + POSITION fy; /*!< 所在グリッドY座標 / Y location on map */ + POSITION fx; /*!< 所在グリッドX座標 / X location on map */ + HIT_POINT hp; /*!< 現在のHP / Current Hit points */ + HIT_POINT maxhp; /*!< 現在の最大HP(衰弱効果などにより低下したものの反映) / Max Hit points */ + HIT_POINT max_maxhp; /*!< 生成時の初期最大HP / Max Max Hit points */ + HIT_POINT dealt_damage; /*!< これまでに蓄積して与えてきたダメージ / Sum of damages dealt by player */ + TIME_EFFECT mtimed[MAX_MTIMED]; /*!< 与えられた時限効果の残りターン / Timed status counter */ + SPEED mspeed; /*!< モンスターの個体加速値 / Monster "speed" */ + ACTION_ENERGY energy_need; /*!< モンスター次ターンまでに必要な行動エネルギー / Monster "energy" */ + POSITION cdis; /*!< 現在のプレイヤーから距離(逐一計算を避けるためのテンポラリ変数) Current dis from player */ + BIT_FLAGS8 mflag; /*!< モンスター個体に与えられた特殊フラグ1 / Extra monster flags */ + BIT_FLAGS8 mflag2; /*!< モンスター個体に与えられた特殊フラグ2 / Extra monster flags */ + bool ml; /*!< モンスターがプレイヤーにとって視認できるか(処理のためのテンポラリ変数) Monster is "visible" */ + OBJECT_IDX hold_o_idx; /*!< モンスターが盗み処理により保持しているアイテム(object_type構造体自身がリスト構造を持つ) Object being held (if any) */ + POSITION target_y; /*!< モンスターの攻撃目標対象Y座標 / Can attack !los player */ + POSITION target_x; /*!< モンスターの攻撃目標対象X座標 / Can attack !los player */ + STR_OFFSET nickname; /*!< ペットに与えられた名前の保存先文字列オフセット Monster's Nickname */ + EXP exp; /*!< モンスターの現在所持経験値 */ /* TODO: クローン、ペット、有効化は意義が異なるので別変数に切り離すこと。save/loadのバージョン更新が面倒そうだけど */ - BIT_FLAGS smart; /*!< Field for "smart_learn" - Some bit-flags for the "smart" field */ - MONSTER_IDX parent_m_idx; + BIT_FLAGS smart; /*!< モンスターのプレイヤーに対する学習状態 / Field for "smart_learn" - Some bit-flags for the "smart" field */ + MONSTER_IDX parent_m_idx; /*!< 召喚主のモンスターID */ } monster_type;