OSDN Git Service

#37287 (2.2.0.40) cmd1.c内のC4457警告に対応。 / Deal C4457 warning in cmd1.c.
[hengband/hengband.git] / src / wizard2.c
index 2ec862c..6447a81 100644 (file)
@@ -1,20 +1,21 @@
-/* File: wizard2.c */
-
-/*
- * Copyright (c) 1997 Ben Harrison, and others
- *
+/*!
+ * @file wizard2.c
+ * @brief ウィザードモードの処理(特別処理中心) / Wizard commands
+ * @date 2014/09/07
+ * @author
+ * Copyright (c) 1997 Ben Harrison, and others<br>
  * This software may be copied and distributed for educational, research,
  * and not for profit purposes provided that this copyright and statement
- * are included in all such copies.  Other copyrights may also apply.
+ * are included in all such copies.  Other copyrights may also apply.<br>
+ * 2014 Deskull rearranged comment for Doxygen.<br>
  */
 
-/* Purpose: Wizard commands */
-
 #include "angband.h"
 
 
-/*
- * Roll the hitdie -- aux of do_cmd_rerate()
+/*!
+ * @brief プレイヤーのヒットダイスを振り直す / Roll the hitdie -- aux of do_cmd_rerate()
+ * @return なし
  */
 void do_cmd_rerate_aux(void)
 {
@@ -50,8 +51,10 @@ void do_cmd_rerate_aux(void)
 }
 
 
-/*
- * Hack -- Rerate Hitpoints
+/*!
+ * @brief プレイヤーのヒットダイスを振り直した後明示を行う / Hack -- Rerate Hitpoints
+ * @param display TRUEならば体力ランクを明示する
+ * @return なし
  */
 void do_cmd_rerate(bool display)
 {
@@ -91,8 +94,9 @@ void do_cmd_rerate(bool display)
 
 #ifdef ALLOW_WIZARD
 
-/*
- * Dimension Door
+/*!
+ * @brief 必ず成功するウィザードモード用次元の扉処理 / Wizard Dimension Door
+ * @return 実際にテレポートを行ったらTRUEを返す
  */
 static bool wiz_dimension_door(void)
 {
@@ -106,9 +110,39 @@ static bool wiz_dimension_door(void)
 }
 
 
-/*
- * Create the artifact of the specified number -- DAN
- *
+/*!
+ * @brief プレイ日数を変更する / Set gametime.
+ * @return 実際に変更を行ったらTRUEを返す
+ */
+static bool set_gametime(void)
+{
+       int tmp_int = 0;
+       char ppp[80], tmp_val[40];
+
+       /* Prompt */
+       sprintf(ppp, "Dungeon Turn (0-%d): ", dungeon_turn_limit);
+
+       /* Default */
+       sprintf(tmp_val, "%d", dungeon_turn);
+
+       /* Query */
+       if (!get_string(ppp, tmp_val, 10)) return (FALSE);
+
+       /* Extract */
+       tmp_int = atoi(tmp_val);
+
+       /* Verify */
+       if (tmp_int >= dungeon_turn_limit) tmp_int = dungeon_turn_limit - 1;
+       else if (tmp_int < 0) tmp_int = 0;
+       dungeon_turn = turn = tmp_int;
+       return (TRUE);
+
+}
+
+
+/*!
+ * @brief 指定されたIDの固定アーティファクトを生成する / Create the artifact of the specified number
+ * @return なし
  */
 static void wiz_create_named_art(void)
 {
@@ -124,15 +158,16 @@ static void wiz_create_named_art(void)
        if(a_idx >= max_a_idx) a_idx = 0; 
 
        /* Create the artifact */
-       (void)create_named_art(a_idx, py, px);
+       (void)create_named_art(a_idx, p_ptr->y, p_ptr->x);
 
        /* All done */
        msg_print("Allocated.");
 }
 
 
-/*
- * Hack -- quick debugging hook
+/*!
+ * @brief ウィザードモード用モンスター調査 / Hack -- quick debugging hook
+ * @return なし
  */
 static void do_cmd_wiz_hack_ben(void)
 {
@@ -142,18 +177,20 @@ static void do_cmd_wiz_hack_ben(void)
 }
 
 
-
 #ifdef MONSTER_HORDES
 
-/* Summon a horde of monsters */
+/*!
+ * @brief ウィザードモード用モンスターの群れ生成 / Summon a horde of monsters
+ * @return なし
+ */
 static void do_cmd_summon_horde(void)
 {
-       int wy = py, wx = px;
+       int wy = p_ptr->y, wx = p_ptr->x;
        int attempts = 1000;
 
        while (--attempts)
        {
-               scatter(&wy, &wx, py, px, 3, 0);
+               scatter(&wy, &wx, p_ptr->y, p_ptr->x, 3, 0);
                if (cave_empty_bold(wy, wx)) break;
        }
 
@@ -162,9 +199,9 @@ static void do_cmd_summon_horde(void)
 
 #endif /* MONSTER_HORDES */
 
-
-/*
- * Output a long int in binary format.
+/*!
+ * @brief 32ビット変数のビット配列を並べて描画する / Output a long int in binary format.
+ * @return なし
  */
 static void prt_binary(u32b flags, int row, int col)
 {
@@ -189,10 +226,15 @@ static void prt_binary(u32b flags, int row, int col)
 }
 
 
-#define K_MAX_DEPTH 110
+#define K_MAX_DEPTH 110 /*!< アイテムの階層毎生成率を表示する最大階 */
 
-/*
- * Output a rarity graph for a type of object.
+/*!
+ * @brief アイテムの階層毎生成率を表示する / Output a rarity graph for a type of object.
+ * @param tval ベースアイテムの大項目ID
+ * @param sval ベースアイテムの小項目ID
+ * @param row 表示列
+ * @param col 表示行
+ * @return なし
  */
 static void prt_alloc(byte tval, byte sval, int row, int col)
 {
@@ -200,8 +242,7 @@ static void prt_alloc(byte tval, byte sval, int row, int col)
        int home = 0;
        u32b rarity[K_MAX_DEPTH];
        u32b total[K_MAX_DEPTH];
-       s32b maxd = 1, display[22];
-       byte c = TERM_WHITE;
+       s32b display[22];
        cptr r = "+---Rate---+";
        object_kind *k_ptr;
 
@@ -281,6 +322,11 @@ static void prt_alloc(byte tval, byte sval, int row, int col)
        prt(r, row, col);
 }
 
+/*!
+ * @brief プレイヤーの職業を変更する
+ * @return なし
+ * @todo 魔法領域の再選択などがまだ不完全、要実装。
+ */
 static void do_cmd_wiz_reset_class(void)
 {
        int tmp_int;
@@ -315,8 +361,9 @@ static void do_cmd_wiz_reset_class(void)
 }
 
 
-/*
- * Hack -- Teleport to the target
+/*!
+ * @brief ウィザードモード用処理としてターゲット中の相手をテレポートバックする / Hack -- Teleport to the target
+ * @return なし
  */
 static void do_cmd_wiz_bamf(void)
 {
@@ -328,8 +375,10 @@ static void do_cmd_wiz_bamf(void)
 }
 
 
-/*
+/*!
+ * @brief プレイヤーの現能力値を調整する
  * Aux function for "do_cmd_wiz_change()".     -RAK-
+ * @return なし
  */
 static void do_cmd_wiz_change_aux(void)
 {
@@ -438,8 +487,10 @@ static void do_cmd_wiz_change_aux(void)
 }
 
 
-/*
+/*!
+ * @brief プレイヤーの現能力値を調整する(メインルーチン)
  * Change various "permanent" player variables.
+ * @return なし
  */
 static void do_cmd_wiz_change(void)
 {
@@ -451,7 +502,12 @@ static void do_cmd_wiz_change(void)
 }
 
 
-/*
+/*!
+ * @brief アイテムの詳細ステータスを表示する / 
+ * Change various "permanent" player variables.
+ * @param o_ptr 詳細を表示するアイテム情報の参照ポインタ
+ * @return なし
+ * @details
  * Wizard routines for creating objects                -RAK-
  * And for manipulating them!                   -Bernd-
  *
@@ -505,9 +561,6 @@ static void do_cmd_wiz_change(void)
  *
  * Hack -- this function will allow you to create multiple artifacts.
  * This "feature" may induce crashes or other nasty effects.
- */
-
-/*
  * Just display an item's properties (debug-info)
  * Originally by David Reeve Sward <sward+@CMU.EDU>
  * Verbose item flags by -Bernd-
@@ -585,17 +638,17 @@ static void wiz_display_item(object_type *o_ptr)
 }
 
 
-/*
- * A structure to hold a tval and its description
+/*!
+ * ベースアイテムの大項目IDの種別名をまとめる構造体 / A structure to hold a tval and its description
  */
 typedef struct tval_desc
 {
-       int        tval;
-       cptr       desc;
+       int        tval; /*!< 大項目のID */
+       cptr       desc; /*!< 大項目名 */
 } tval_desc;
 
-/*
- * A list of tvals and their textual names
+/*!
+ * ベースアイテムの大項目IDの種別名定義 / A list of tvals and their textual names
  */
 static tval_desc tvals[] =
 {
@@ -654,8 +707,11 @@ static tval_desc tvals[] =
 };
 
 
-/*
- * Strip an "object name" into a buffer
+/*!
+ * @brief nameバッファ内からベースアイテム名を返す / Strip an "object name" into a buffer
+ * @param buf ベースアイテム格納先の参照ポインタ
+ * @param k_idx ベースアイテムID
+ * @return なし
  */
 void strip_name(char *buf, int k_idx)
 {
@@ -683,12 +739,13 @@ void strip_name(char *buf, int k_idx)
 }
 
 
-/*
+/*!
+ * @brief ベースアイテムのウィザード生成のために大項目IDと小項目IDを取得する /
  * Specify tval and sval (type and subtype of object) originally
+ * @return ベースアイテムID
+ * @details
  * by RAK, heavily modified by -Bernd-
- *
  * This function returns the k_idx of an object type, or zero if failed
- *
  * List up to 50 choices in three columns
  */
 static int wiz_create_itemtype(void)
@@ -787,15 +844,16 @@ static int wiz_create_itemtype(void)
 }
 
 
-/*
- * Tweak an item
+/*!
+ * @briefアイテムの基礎能力値を調整する / Tweak an item
+ * @param o_ptr 調整するアイテムの参照ポインタ
+ * @return なし
  */
 static void wiz_tweak_item(object_type *o_ptr)
 {
        cptr p;
        char tmp_val[80];
 
-
        /* Hack -- leave artifacts alone */
        if (object_is_artifact(o_ptr)) return;
 
@@ -825,8 +883,11 @@ static void wiz_tweak_item(object_type *o_ptr)
 }
 
 
-/*
+/*!
+ * @brief アイテムの質を選択して再生成する /
  * Apply magic to an item or turn it into an artifact. -Bernd-
+ * @param o_ptr 再生成の対象となるアイテム情報の参照ポインタ
+ * @return なし
  */
 static void wiz_reroll_item(object_type *o_ptr)
 {
@@ -957,9 +1018,11 @@ static void wiz_reroll_item(object_type *o_ptr)
 
 
 
-/*
+/*!
+ * @brief 検査対象のアイテムを基準とした生成テストを行う /
  * Try to create an item again. Output some statistics.    -Bernd-
- *
+ * @param o_ptr 生成テストの基準となるアイテム情報の参照ポインタ
+ * @return なし
  * The statistics are correct now.  We acquire a clean grid, and then
  * repeatedly place an object in this grid, copying it into an item
  * holder, and then deleting the object.  We fiddle with the artifact
@@ -1125,8 +1188,11 @@ static void wiz_statistics(object_type *o_ptr)
 }
 
 
-/*
+/*!
+ * @brief 検査対象のアイテムの数を変更する /
  * Change the quantity of a the item
+ * @param o_ptr 変更するアイテム情報構造体の参照ポインタ
+ * @return なし
  */
 static void wiz_quantity_item(object_type *o_ptr)
 {
@@ -1164,7 +1230,11 @@ static void wiz_quantity_item(object_type *o_ptr)
        }
 }
 
-/* debug command for blue mage */
+/*!
+ * @brief 青魔導師の魔法を全て習得済みにする /
+ * debug command for blue mage
+ * @return なし
+ */
 static void do_cmd_wiz_blue_mage(void)
 {
 
@@ -1193,12 +1263,15 @@ static void do_cmd_wiz_blue_mage(void)
 }
 
 
-/*
+/*!
+ * @brief アイテム検査のメインルーチン /
  * Play with an item. Options include:
- *   - Output statistics (via wiz_roll_item)
- *   - Reroll item (via wiz_reroll_item)
- *   - Change properties (via wiz_tweak_item)
- *   - Change the number of items (via wiz_quantity_item)
+ * @return なし
+ * @details 
+ *   - Output statistics (via wiz_roll_item)<br>
+ *   - Reroll item (via wiz_reroll_item)<br>
+ *   - Change properties (via wiz_tweak_item)<br>
+ *   - Change the number of items (via wiz_quantity_item)<br>
  */
 static void do_cmd_wiz_play(void)
 {
@@ -1328,8 +1401,11 @@ static void do_cmd_wiz_play(void)
 }
 
 
-/*
+/*!
+ * @brief 任意のベースアイテム生成のメインルーチン /
  * Wizard routine for creating objects         -RAK-
+ * @return なし
+ * @details
  * Heavily modified to allow magification and artifactification  -Bernd-
  *
  * Note that wizards cannot create objects on top of other objects.
@@ -1372,7 +1448,7 @@ static void wiz_create_item(void)
                        if (a_info[i].sval != k_info[k_idx].sval) continue;
 
                        /* Create this artifact */
-                       (void)create_named_art(i, py, px);
+                       (void)create_named_art(i, p_ptr->y, p_ptr->x);
 
                        /* All done */
                        msg_print("Allocated(INSTA_ART).");
@@ -1391,15 +1467,17 @@ static void wiz_create_item(void)
        apply_magic(q_ptr, dun_level, AM_NO_FIXED_ART);
 
        /* Drop the object from heaven */
-       (void)drop_near(q_ptr, -1, py, px);
+       (void)drop_near(q_ptr, -1, p_ptr->y, p_ptr->x);
 
        /* All done */
        msg_print("Allocated.");
 }
 
 
-/*
+/*!
+ * @brief プレイヤーを完全回復する /
  * Cure everything instantly
+ * @return なし
  */
 static void do_cmd_wiz_cure_all(void)
 {
@@ -1454,8 +1532,10 @@ static void do_cmd_wiz_cure_all(void)
 }
 
 
-/*
+/*!
+ * @brief 任意のダンジョン及び階層に飛ぶ /
  * Go to any level
+ * @return なし
  */
 static void do_cmd_wiz_jump(void)
 {
@@ -1519,7 +1599,7 @@ static void do_cmd_wiz_jump(void)
        if (record_stair) do_cmd_write_nikki(NIKKI_WIZ_TELE,0,NULL);
 
        p_ptr->inside_quest = 0;
-       energy_use = 0;
+       p_ptr->energy_use = 0;
 
        /* Prevent energy_need from being too lower than 0 */
        p_ptr->energy_need = 0;
@@ -1535,8 +1615,10 @@ static void do_cmd_wiz_jump(void)
 }
 
 
-/*
+/*!
+ * @brief 全ベースアイテムを鑑定済みにする /
  * Become aware of a lot of objects
+ * @return なし
  */
 static void do_cmd_wiz_learn(void)
 {
@@ -1566,8 +1648,11 @@ static void do_cmd_wiz_learn(void)
 }
 
 
-/*
+/*!
+ * @brief 現在のフロアに合ったモンスターをランダムに召喚する /
  * Summon some creatures
+ * @param num 生成処理回数
+ * @return なし
  */
 static void do_cmd_wiz_summon(int num)
 {
@@ -1575,36 +1660,45 @@ static void do_cmd_wiz_summon(int num)
 
        for (i = 0; i < num; i++)
        {
-               (void)summon_specific(0, py, px, dun_level, 0, (PM_ALLOW_GROUP | PM_ALLOW_UNIQUE));
+               (void)summon_specific(0, p_ptr->y, p_ptr->x, dun_level, 0, (PM_ALLOW_GROUP | PM_ALLOW_UNIQUE));
        }
 }
 
 
-/*
+
+/*!
+ * @brief モンスターを種族IDを指定して敵対的に召喚する /
  * Summon a creature of the specified type
- *
+ * @param r_idx モンスター種族ID
+ * @return なし
+ * @details
  * XXX XXX XXX This function is rather dangerous
  */
 static void do_cmd_wiz_named(int r_idx)
 {
-       (void)summon_named_creature(0, py, px, r_idx, (PM_ALLOW_SLEEP | PM_ALLOW_GROUP));
+       (void)summon_named_creature(0, p_ptr->y, p_ptr->x, r_idx, (PM_ALLOW_SLEEP | PM_ALLOW_GROUP));
 }
 
 
-/*
+/*!
+ * @brief モンスターを種族IDを指定してペット召喚する /
  * Summon a creature of the specified type
- *
+ * @param r_idx モンスター種族ID
+ * @return なし
+ * @details
  * XXX XXX XXX This function is rather dangerous
  */
 static void do_cmd_wiz_named_friendly(int r_idx)
 {
-       (void)summon_named_creature(0, py, px, r_idx, (PM_ALLOW_SLEEP | PM_ALLOW_GROUP | PM_FORCE_PET));
+       (void)summon_named_creature(0, p_ptr->y, p_ptr->x, r_idx, (PM_ALLOW_SLEEP | PM_ALLOW_GROUP | PM_FORCE_PET));
 }
 
 
 
-/*
+/*!
+ * @brief プレイヤー近辺の全モンスターを消去する /
  * Hack -- Delete all nearby monsters
+ * @return なし
  */
 static void do_cmd_wiz_zap(void)
 {
@@ -1639,8 +1733,10 @@ static void do_cmd_wiz_zap(void)
 }
 
 
-/*
+/*!
+ * @brief フロアに存在する全モンスターを消去する /
  * Hack -- Delete all monsters
+ * @return なし
  */
 static void do_cmd_wiz_zap_all(void)
 {
@@ -1671,8 +1767,10 @@ static void do_cmd_wiz_zap_all(void)
 }
 
 
-/*
+/*!
+ * @brief 指定された地点の地形IDを変更する /
  * Create desired feature
+ * @return なし
  */
 static void do_cmd_wiz_create_feature(void)
 {
@@ -1738,8 +1836,10 @@ static void do_cmd_wiz_create_feature(void)
 #define NUM_O_SET 8
 #define NUM_O_BIT 32
 
-/*
+/*!
+ * @brief 現在のオプション設定をダンプ出力する /
  * Hack -- Dump option bits usage
+ * @return なし
  */
 static void do_cmd_dump_options(void)
 {
@@ -1830,16 +1930,17 @@ extern void do_cmd_debug(void);
 
 
 
-/*
+/*!
+ * @brief デバッグコマンドを選択する処理のメインルーチン /
  * Ask for and parse a "debug command"
  * The "command_arg" may have been set.
+ * @return なし
  */
 void do_cmd_debug(void)
 {
        int     x, y;
        char    cmd;
 
-
        /* Get a "debug command" */
        get_com("Debug Command: ", &cmd, FALSE);
 
@@ -1932,7 +2033,7 @@ void do_cmd_debug(void)
        /* Good Objects */
        case 'g':
                if (command_arg <= 0) command_arg = 1;
-               acquirement(py, px, command_arg, FALSE, FALSE, TRUE);
+               acquirement(p_ptr->y, p_ptr->x, command_arg, FALSE, FALSE, TRUE);
                break;
 
        /* Hitpoint rerating */
@@ -2011,26 +2112,22 @@ void do_cmd_debug(void)
                teleport_player(10, 0L);
                break;
 
-#if 0
        /* Complete a Quest -KMW- */
        case 'q':
-               for (i = 0; i < max_quests; i++)
+               if(p_ptr->inside_quest)
                {
-                       if (p_ptr->quest[i].status == QUEST_STATUS_TAKEN)
+                       if (quest[p_ptr->inside_quest].status == QUEST_STATUS_TAKEN)
                        {
-                               p_ptr->quest[i].status++;
-                               msg_print("Completed Quest");
-                               msg_print(NULL);
+                               complete_quest(p_ptr->inside_quest);
                                break;
                        }
                }
-               if (i == max_quests)
+               else
                {
                        msg_print("No current quest");
                        msg_print(NULL);
                }
                break;
-#endif
 
        /* Make every dungeon square "known" to test streamers -KMW- */
        case 'u':
@@ -2053,7 +2150,7 @@ void do_cmd_debug(void)
        /* Special(Random Artifact) Objects */
        case 'S':
                if (command_arg <= 0) command_arg = 1;
-               acquirement(py, px, command_arg, TRUE, TRUE, TRUE);
+               acquirement(p_ptr->y, p_ptr->x, command_arg, TRUE, TRUE, TRUE);
                break;
 
        /* Teleport */
@@ -2061,10 +2158,16 @@ void do_cmd_debug(void)
                teleport_player(100, 0L);
                break;
 
+       /* Game Time Setting */
+       case 'T':
+               set_gametime();
+               break;
+
+
        /* Very Good Objects */
        case 'v':
                if (command_arg <= 0) command_arg = 1;
-               acquirement(py, px, command_arg, TRUE, FALSE, TRUE);
+               acquirement(p_ptr->y, p_ptr->x, command_arg, TRUE, FALSE, TRUE);
                break;
 
        /* Wizard Light the Level */