Feature #1093 ยป 0077-Add-documentary-comment-about-action-sections.patch
| data/alien/actions.ruleset | ||
|---|---|---|
| ; requirements. Avoid double entries in the auto help by silencing it. | ||
| quiet_actions = "Transport Disembark 2", "Enter Hut 2", "Unit Move" | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Actions: | ||
| ; | ||
| ; action               = the action to configure. | ||
| ; ui_name              = What each action should be called when showing them to the player. | ||
| ;                        The first %s should be before the mnemonic of the action. | ||
| ;                        A Freeciv client that supports mnemonics will replace it with | ||
| ;                        the in-band signal that marks the following character as a mnemonic | ||
| ;                        in its graphical toolkit. | ||
| ;                        The second %s marks where extra details should be inserted. | ||
| ; | ||
| ; README.actions lists the possible actions | ||
| ; | ||
| ; */ <-- avoid gettext warnings | ||
| ;[action_placeholder] | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Enablers: | ||
| data/civ1/actions.ruleset | ||
|---|---|---|
| ; double entries in the auto help by silencing it. | ||
| quiet_actions = "Enter Hut 2", "Unit Move" | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Actions: | ||
| ; | ||
| ; action               = the action to configure. | ||
| ; ui_name              = What each action should be called when showing them to the player. | ||
| ;                        The first %s should be before the mnemonic of the action. | ||
| ;                        A Freeciv client that supports mnemonics will replace it with | ||
| ;                        the in-band signal that marks the following character as a mnemonic | ||
| ;                        in its graphical toolkit. | ||
| ;                        The second %s marks where extra details should be inserted. | ||
| ; | ||
| ; README.actions lists the possible actions | ||
| ; | ||
| ; */ <-- avoid gettext warnings | ||
| ;[action_placeholder] | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Enablers: | ||
| data/civ2/actions.ruleset | ||
|---|---|---|
| ; Can make the help text less redundant when you document it your self. | ||
| quiet_actions = "Unit Move" | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Actions: | ||
| ; | ||
| ; action               = the action to configure. | ||
| ; ui_name              = What each action should be called when showing them to the player. | ||
| ;                        The first %s should be before the mnemonic of the action. | ||
| ;                        A Freeciv client that supports mnemonics will replace it with | ||
| ;                        the in-band signal that marks the following character as a mnemonic | ||
| ;                        in its graphical toolkit. | ||
| ;                        The second %s marks where extra details should be inserted. | ||
| ; | ||
| ; README.actions lists the possible actions | ||
| ; | ||
| ; */ <-- avoid gettext warnings | ||
| ;[action_placeholder] | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Enablers: | ||
| data/civ2civ3/actions.ruleset | ||
|---|---|---|
| quiet_actions = "Transport Disembark 2", "Conquer City Shrink 2", "Enter Hut 2", | ||
|                 "Frighten Hut 2", "Unit Move" | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Actions: | ||
| ; | ||
| ; action               = the action to configure. | ||
| ; ui_name              = What each action should be called when showing them to the player. | ||
| ;                        The first %s should be before the mnemonic of the action. | ||
| ;                        A Freeciv client that supports mnemonics will replace it with | ||
| ;                        the in-band signal that marks the following character as a mnemonic | ||
| ;                        in its graphical toolkit. | ||
| ;                        The second %s marks where extra details should be inserted. | ||
| ; | ||
| ; README.actions lists the possible actions | ||
| ; | ||
| ; */ <-- avoid gettext warnings | ||
| ;[action_placeholder] | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Enablers: | ||
| data/classic/actions.ruleset | ||
|---|---|---|
| quiet_actions = "Transport Disembark 2", "Conquer City Shrink 2", "Enter Hut 2", | ||
|                 "Frighten Hut 2", "Conquer Extras 2", "Unit Move" | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Actions: | ||
| ; | ||
| ; action               = the action to configure. | ||
| ; ui_name              = What each action should be called when showing them to the player. | ||
| ;                        The first %s should be before the mnemonic of the action. | ||
| ;                        A Freeciv client that supports mnemonics will replace it with | ||
| ;                        the in-band signal that marks the following character as a mnemonic | ||
| ;                        in its graphical toolkit. | ||
| ;                        The second %s marks where extra details should be inserted. | ||
| ; | ||
| ; README.actions lists the possible actions | ||
| ; | ||
| ; */ <-- avoid gettext warnings | ||
| ;[action_placeholder] | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Enablers: | ||
| data/goldkeep/actions.ruleset | ||
|---|---|---|
| quiet_actions = "Transport Disembark 2", "Conquer City Shrink 2", "Enter Hut 2", | ||
|                 "Frighten Hut 2", "Conquer Extras 2", "Unit Move" | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Actions: | ||
| ; | ||
| ; action               = the action to configure. | ||
| ; ui_name              = What each action should be called when showing them to the player. | ||
| ;                        The first %s should be before the mnemonic of the action. | ||
| ;                        A Freeciv client that supports mnemonics will replace it with | ||
| ;                        the in-band signal that marks the following character as a mnemonic | ||
| ;                        in its graphical toolkit. | ||
| ;                        The second %s marks where extra details should be inserted. | ||
| ; | ||
| ; README.actions lists the possible actions | ||
| ; | ||
| ; */ <-- avoid gettext warnings | ||
| ;[action_placeholder] | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Enablers: | ||
| data/granularity/actions.ruleset | ||
|---|---|---|
| ; requirements. Avoid double entries in the auto help by silencing it. | ||
| quiet_actions = "Transport Disembark 2", "Unit Move" | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Actions: | ||
| ; | ||
| ; action               = the action to configure. | ||
| ; ui_name              = What each action should be called when showing them to the player. | ||
| ;                        The first %s should be before the mnemonic of the action. | ||
| ;                        A Freeciv client that supports mnemonics will replace it with | ||
| ;                        the in-band signal that marks the following character as a mnemonic | ||
| ;                        in its graphical toolkit. | ||
| ;                        The second %s marks where extra details should be inserted. | ||
| ; | ||
| ; README.actions lists the possible actions | ||
| ; | ||
| ; */ <-- avoid gettext warnings | ||
| ;[action_placeholder] | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Enablers: | ||
| data/multiplayer/actions.ruleset | ||
|---|---|---|
| quiet_actions = "Transport Disembark 2", "Conquer City Shrink 2", "Enter Hut 2", | ||
|                 "Frighten Hut 2", "Conquer Extras 2", "Unit Move" | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Actions: | ||
| ; | ||
| ; action               = the action to configure. | ||
| ; ui_name              = What each action should be called when showing them to the player. | ||
| ;                        The first %s should be before the mnemonic of the action. | ||
| ;                        A Freeciv client that supports mnemonics will replace it with | ||
| ;                        the in-band signal that marks the following character as a mnemonic | ||
| ;                        in its graphical toolkit. | ||
| ;                        The second %s marks where extra details should be inserted. | ||
| ; | ||
| ; README.actions lists the possible actions | ||
| ; | ||
| ; */ <-- avoid gettext warnings | ||
| ;[action_placeholder] | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Enablers: | ||
| data/ruledit/comments-3.3.txt | ||
|---|---|---|
| ; */ <-- avoid gettext warnings\n\ | ||
| " | ||
| actions = "\ | ||
| ; /* <-- avoid gettext warnings\n\ | ||
| ;\n\ | ||
| ; Actions:\n\ | ||
| ;\n\ | ||
| ; action               = the action to configure.\n\ | ||
| ; ui_name              = What each action should be called when showing them to the player.\n\ | ||
| ;                        The first %s should be before the mnemonic of the action.\n\ | ||
| ;                        A Freeciv client that supports mnemonics will replace it with\n\ | ||
| ;                        the in-band signal that marks the following character as a mnemonic\n\ | ||
| ;                        in its graphical toolkit.\n\ | ||
| ;                        The second %s marks where extra details should be inserted.\n\ | ||
| ;\n\ | ||
| ; README.actions lists the possible actions\n\ | ||
| ;\n\ | ||
| ; */ <-- avoid gettext warnings\n\ | ||
| " | ||
| enablers = "\ | ||
| \n\ | ||
| ; /* <-- avoid gettext warnings\n\ | ||
| ... | ... | |
| ;                    they should be tried.\n\ | ||
| " | ||
| ui_names = "\n\ | ||
| ; What each action should be called when showing them to the player.\n\ | ||
| ; The first \%s should be before the mnemonic of the action. A Freeciv client\n\ | ||
| ; that supports mnemonics will replace it with the in-band signal that marks\n\ | ||
| ; the following character as a mnemonic in its graphical toolkit.\n\ | ||
| ; The second \%s marks where extra details should be inserted.\n\ | ||
| " | ||
| dc_initial_odds = "\n\ | ||
| ; Some actions have a action dice roll before the action starts where it can\n\ | ||
| ; fail. The initial probability of success is 100% unless the action appears\n\ | ||
| data/sandbox/actions.ruleset | ||
|---|---|---|
| quiet_actions = "Transport Disembark 2", "Conquer City Shrink 2", "Enter Hut 2", | ||
|                 "Frighten Hut 2", "Conquer Extras 2", "Unit Move" | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Actions: | ||
| ; | ||
| ; action               = the action to configure. | ||
| ; ui_name              = What each action should be called when showing them to the player. | ||
| ;                        The first %s should be before the mnemonic of the action. | ||
| ;                        A Freeciv client that supports mnemonics will replace it with | ||
| ;                        the in-band signal that marks the following character as a mnemonic | ||
| ;                        in its graphical toolkit. | ||
| ;                        The second %s marks where extra details should be inserted. | ||
| ; | ||
| ; README.actions lists the possible actions | ||
| ; | ||
| ; */ <-- avoid gettext warnings | ||
| ;[action_placeholder] | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Enablers: | ||
| data/stub/actions.ruleset | ||
|---|---|---|
| ; Can make the help text less redundant when you document it your self. | ||
| ;quiet_actions = "Targeted Sabotage City", "Targeted Steal Tech", "Unit Move" | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Actions: | ||
| ; | ||
| ; action               = the action to configure. | ||
| ; ui_name              = What each action should be called when showing them to the player. | ||
| ;                        The first %s should be before the mnemonic of the action. | ||
| ;                        A Freeciv client that supports mnemonics will replace it with | ||
| ;                        the in-band signal that marks the following character as a mnemonic | ||
| ;                        in its graphical toolkit. | ||
| ;                        The second %s marks where extra details should be inserted. | ||
| ; | ||
| ; README.actions lists the possible actions | ||
| ; | ||
| ; */ <-- avoid gettext warnings | ||
| ;[action_placeholder] | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Enablers: | ||
| data/webperimental/actions.ruleset | ||
|---|---|---|
| ; Can make the help text less redundant when you document it your self. | ||
| quiet_actions = "Heal Unit", "Unit Move" | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Actions: | ||
| ; | ||
| ; action               = the action to configure. | ||
| ; ui_name              = What each action should be called when showing them to the player. | ||
| ;                        The first %s should be before the mnemonic of the action. | ||
| ;                        A Freeciv client that supports mnemonics will replace it with | ||
| ;                        the in-band signal that marks the following character as a mnemonic | ||
| ;                        in its graphical toolkit. | ||
| ;                        The second %s marks where extra details should be inserted. | ||
| ; | ||
| ; README.actions lists the possible actions | ||
| ; | ||
| ; */ <-- avoid gettext warnings | ||
| ;[action_placeholder] | ||
| ; /* <-- avoid gettext warnings | ||
| ; | ||
| ; Enablers: | ||
| tools/ruleutil/comments.c | ||
|---|---|---|
|   char *uflags_building; | ||
|   char *trade_settings; | ||
|   char *goods; | ||
|   char *actions; | ||
|   char *enablers; | ||
|   char *specialists; | ||
|   char *nations; | ||
| ... | ... | |
|   char *combat_rules_nuke_pop_loss; | ||
|   char *combat_rules_nuke_defender_survival; | ||
|   char *auto_attack; | ||
|   char *actions_ui_names; | ||
|   char *actions_dc_initial_odds; | ||
|   char *actions_quiet_actions; | ||
|   char *borders_radius_permanent; | ||
| ... | ... | |
|   comment_load(comments_storage.trade_settings, | ||
|                comment_file, "typedoc.trade_settings"); | ||
|   comment_load(comments_storage.goods, comment_file, "typedoc.goods"); | ||
|   comment_load(comments_storage.actions, comment_file, "typedoc.actions"); | ||
|   comment_load(comments_storage.enablers, comment_file, "typedoc.enablers"); | ||
|   comment_load(comments_storage.specialists, | ||
|                comment_file, "typedoc.specialists"); | ||
| ... | ... | |
|                "entrydoc.nuke_defender_survival_chance_pct"); | ||
|   comment_load(comments_storage.auto_attack, comment_file, | ||
|                "entrydoc.auto_attack"); | ||
|   comment_load(comments_storage.actions_ui_names, comment_file, | ||
|                "entrydoc.ui_names"); | ||
|   comment_load(comments_storage.actions_dc_initial_odds, comment_file, | ||
|                "entrydoc.dc_initial_odds"); | ||
|   comment_load(comments_storage.actions_quiet_actions, comment_file, | ||
| ... | ... | |
|   comment_write(sfile, comments_storage.goods, "Goods"); | ||
| } | ||
| /**********************************************************************//** | ||
|   Write actions header. | ||
| **************************************************************************/ | ||
| void comment_actions(struct section_file *sfile) | ||
| { | ||
|   comment_write(sfile, comments_storage.actions, "Actions"); | ||
| } | ||
| /**********************************************************************//** | ||
|   Write action enablers header. | ||
| **************************************************************************/ | ||
| ... | ... | |
|   comment_entry_write(sfile, comments_storage.auto_attack, "auto_attack"); | ||
| } | ||
| /**********************************************************************//** | ||
|   Write actions ui_name settings header. | ||
| **************************************************************************/ | ||
| void comment_actions_ui_names(struct section_file *sfile) | ||
| { | ||
|   comment_entry_write(sfile, comments_storage.actions_ui_names, "actions"); | ||
| } | ||
| /**********************************************************************//** | ||
|   Write actions diplchance_initial_odds settings header. | ||
| **************************************************************************/ | ||
| tools/ruleutil/comments.h | ||
|---|---|---|
| void comment_disasters(struct section_file *sfile); | ||
| void comment_achievements(struct section_file *sfile); | ||
| void comment_goods(struct section_file *sfile); | ||
| void comment_actions(struct section_file *sfile); | ||
| void comment_enablers(struct section_file *sfile); | ||
| void comment_specialists(struct section_file *sfile); | ||
| void comment_nationsets(struct section_file *sfile); | ||
| ... | ... | |
| void comment_combat_rules_nuke_pop_loss(struct section_file *sfile); | ||
| void comment_combat_rules_nuke_defender_survival(struct section_file *sfile); | ||
| void comment_auto_attack(struct section_file *sfile); | ||
| void comment_actions_ui_names(struct section_file *sfile); | ||
| void comment_actions_dc_initial_odds(struct section_file *sfile); | ||
| void comment_actions_quiet_actions(struct section_file *sfile); | ||
| void comment_borders_radius_permanent(struct section_file *sfile); | ||
| tools/ruleutil/rulesave.c | ||
|---|---|---|
|                     RS_DEFAULT_STEAL_MAP_REVEALS_CITIES, | ||
|                     "actions.steal_maps_reveals_all_cities", nullptr); | ||
|   comment_actions_ui_names(sfile); | ||
|   action_iterate(act_id) { | ||
|     struct action *act = action_by_number(act_id); | ||
| ... | ... | |
|     return FALSE; | ||
|   } | ||
|   comment_actions(sfile); | ||
|   for (i = 0; i < MAX_NUM_ACTIONS; i++) { | ||
|     struct action *paction = action_by_number(i); | ||