Merge branch 'main' of https://github.com/ineveraskedforthis/alice

Author: ineveraskedforthis

assets/localisation/en-US/alice.csv

@@ -1803,7 +1803,7 @@ alice_declarewar_truce_with_explain;?Y$NATION$?W: Have truce with ?Y$TARGET$?W.
 alice_command_units_condition_1;?Y$NATION$?W is our subject
 alice_command_units_condition_2;Both you and the target is at war
 alice_command_units_condition_3;Target is not a player
-alice_command_units_condition_4;Playing singleplayer
+alice_command_units_condition_4;Is enabled in game rules
 free_trade_di;Free trade agreement
 free_trade_offer;$actor$ is offering a free trade agreement, allowing us to trade tariff-free for $years$ years
 alice_original_war_participant_not_in_war;?Y$NATION$?W is no longer in the war
@@ -1834,10 +1834,15 @@ alice_gamerule_fog_of_war;Fog of war
 alice_gamerule_fog_of_war_desc;Specifies whether to enable fog of war (FoW) to obscure vision of neutral/enemy provinces&units
 alice_gamerule_fog_of_war_opt_disabled;Fog of war is OFF
 alice_gamerule_fog_of_war_opt_enabled;Fog of war is ON
+alice_gamerule_fog_of_war_opt_disabled_for_observer; Fog of war is OFF for observer
 alice_gamerule_auto_concession_peace;Auto-peace when conceding wargoals
 alice_gamerule_auto_concession_peace_desc;Specifies whether a conceding peacedeal (ie one side surrenders to ALL added wargoals, or 100 warscore) will always be accepted no matter what
 alice_gamerule_auto_concession_peace_opt_cannot_reject;Conceding peace offers cannot be rejected
 alice_gamerule_auto_concession_peace_opt_can_reject;Conceding peace offers can be rejected
+alice_gamerule_command_units;Command AI puppet units while at war
+alice_gamerule_command_units_opt_disabled;Disabled
+alice_gamerule_command_units_opt_enabled;Enabled
+alice_gamerule_command_units_desc;Specifies whether AI puppet units may be commanded by the player at war
 alice_savegame_incompatible_warning;?RThis savegame is from a diffrent scenario than the currently loaded one. The save may be buggy, fail to load or crash the game.?W
 alice_show_all_saves_text;Show all saves
 alice_show_all_saves_tooltip;Toggle showing all saves (even potentially incompatible ones) in the save list
@@ -1878,7 +1883,7 @@ amsg_embargod;The nation has been embargoed
 save_name_label;File name (blank = auto)
 save_warning_tooltip;A file with this name already exists
 production_window_title;Production
-production_combine_types_toggle;Combine Types
+production_combine_types_toggle;Collapse Types
 production_table_name_header;Name
 production_table_size_header;Size
 production_table_amount_header;Quantity

assets/localisation/zh-CN/alice.csv

@@ -743,7 +743,7 @@ cancel_ally_explain_1;你不能取消自己盟约
 cancel_ally_explain_2;拥有至少 $x$ 外交点
 cancel_ally_explain_3;你已结盟
 cancel_ally_explain_4;你不能再加入一场战争
-cancel_ally_explain_5;你不能是目标国傀儡
+cancel_ally_explain_5;你不能是目标国附庸
 ally_explain_1;你不能与自己结盟
 ally_explain_2;你至少有 $x$ 外交点
 ally_explain_3;你目前不可能结盟
@@ -1733,7 +1733,7 @@ alice_declarewar_truce_with_explain;?Y$NATION$?W：休战于 ?Y$TARGET$?W。持
 alice_command_units_condition_1;?Y$NATION$?W 是我附庸
 alice_command_units_condition_2;你和目标处于战时。
 alice_command_units_condition_3;目标是非玩家
-alice_command_units_condition_4;玩单人游戏
+alice_command_units_condition_4;游戏规则中已启用
 free_trade_di;自由贸易协议
 free_trade_offer;$actor$ 提供了一项自由贸易协议，允许我们在 $years$ 年内免税贸易。
 alice_original_war_participant_not_in_war;?Y$NATION$?W 不再参战
@@ -1810,8 +1810,8 @@ alice_extra_navies_tooltip;+ ?Y$x$?W 更多海军
 alice_pop_details_ln_short;必
 alice_pop_details_en_short;日
 alice_pop_details_lx_short;奢
-alice_pop_details_need_weight;权重
-alice_pop_details_need_weight_tooltip;所选商品预算优先级
+alice_pop_details_need_weight;倾向
+alice_pop_details_need_weight_tooltip;预算优先级
 button_pop_budget;打开预算信息
 pop_budget_details;预算信息
 pop_budget_unemployment;失业补贴
@@ -1923,3 +1923,24 @@ directive_description_naval;尽力建设升级海军基地
 directive_description_forts;尽力建设升级边界要塞
 directive_description_commodity;扩大生产优先 ?Y$x$?W
 pop_migration_culture;人群倾向于迁移到其文化核心地区：$x$
+chat_timed_out;$playername$ 超时
+disconnected_message_header;断开连接
+disconnected_message_name_taken;名称被占用。试试别的名称。
+disconnected_message_incorrect_password;大厅密码错误
+disconnected_message_timed_out;连接超时
+disconnected_message_kicked;你被主持请出大厅
+disconnected_message_banned;你被主持禁入大厅
+disconnected_message_on_banlist;你已被禁入大厅
+disconnected_message_game_ended;游戏结束了
+disconnected_message_game_full;大厅太多玩家
+disconnected_message_invalid_command_received_client;网络错误：收到主机发布的错误或无效命令。查看日志。
+private_message_btn_disabled_tooltip;别自言自语了
+private_message_button_tooltip;点击切换是否接受聊天
+player_loaded_status;准备
+player_loading_status;加载
+player_oos_status;结果偏差（OOS）
+alice_gamerule_fog_of_war_opt_disabled_for_observer;战争迷雾对观察者关闭
+alice_gamerule_command_units;战时指挥AI附庸单位
+alice_gamerule_command_units_opt_disabled;禁用
+alice_gamerule_command_units_opt_enabled;启用
+alice_gamerule_command_units_desc;玩家战时是否可指挥AI附庸单位

assets/lua/custom_ffi.lua

@@ -51,6 +51,15 @@ ffi.cdef[[
     int32_t local_player_nation();
 
     void console_log(const char text[]);
+
+    int32_t lua_get_gamerule_id_by_name(const char gamerule_name[]);
+	int32_t lua_get_gamerule_option_id_by_name(const char gamerule_option_name[]);
+	bool lua_check_gamerule(int32_t gamerule_id, uint8_t opt_id);
+	int32_t lua_get_active_gamerule_option(int32_t gamerule_id);
+
+	
+	
+	
 ]]
 
 
@@ -84,6 +93,42 @@ function MILITARY.get_stats(a)
 	return ffi.C.alice_get_unit_stats(a)
 end
 
+
+GAMERULE = {}
+
+---returns the gamerule ID for the gamerule with the supplied name
+---@param the text name of a gamerule
+---@return a gamerule ID, or -1 if there is no gamerule with that name
+function GAMERULE.get_gamerule_id_by_name(gamerule_name)
+	return ffi.C.lua_get_gamerule_id_by_name(gamerule_name)
+end
+
+
+---returns a numeric ID for the gamerule option with the supplied name
+---@param the text name of a gamerule option
+---@return a numeric ID for the a matching gamerule option
+function GAMERULE.get_gamerule_option_id_by_name(gamerule_option_name)
+	return ffi.C.check_gamerule_option_by_name(gamerule_option_name)
+end
+
+---returns true if the given gamerule has the specified option ID selected, false otherwise
+---@param the numeric ID of the gamerule
+---@param the numeric ID of the gamerule option to check.
+---@return a boolean representing if the specified gamerule option is selected
+function GAMERULE.check_gamerule(gamerule_id, opt_id)
+	return ffi.C.lua_check_gamerule(gamerule_id, opt_id)
+end
+
+
+
+---returns the currently active gamerule option ID for a gamerule ID
+---@param the numeric ID of the gamerule
+---@return a numeric ID representing the active gamerule option
+function GAMERULE.get_active_gamerule_option(gamerule_id)
+	return ffi.C.lua_get_active_gamerule_option(gamerule_id)
+end
+
+
 ON_ACTION = {}
 
 ---@param name string

assets/lua/game_scripts/gamerule.lua

@@ -0,0 +1,97 @@
+--- This file contains all lua functions used by hardcoded gamerules
+
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_allow_sphereling_declare_war_on_spherelord_opt_no_on_select(gamerule_id)
+end
+
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_allow_sphereling_declare_war_on_spherelord_opt_no_on_deselect(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_allow_sphereling_declare_war_on_spherelord_opt_yes_on_select(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_allow_sphereling_declare_war_on_spherelord_opt_yes_on_deselect(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_allow_partial_retreat_opt_disabled_on_select(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_allow_partial_retreat_opt_disabled_on_deselect(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_allow_partial_retreat_opt_enabled_on_select(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_allow_partial_retreat_opt_enabled_on_deselect(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_fog_of_war_opt_disabled_on_select(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_fog_of_war_opt_disabled_on_deselect(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_fog_of_war_opt_enabled_on_select(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_fog_of_war_opt_enabled_on_deselect(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_fog_of_war_opt_disabled_for_observer_on_select(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_fog_of_war_opt_disabled_for_observer_on_deselect(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_auto_concession_peace_opt_cannot_reject_on_select(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_auto_concession_peace_opt_cannot_reject_on_deselect(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_auto_concession_peace_opt_can_reject_on_select(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_auto_concession_peace_opt_can_reject_on_deselect(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_command_units_opt_disabled_on_select(gamerule_id)
+	-- get all commanded units back to their original owners when the gamerule is disabled
+	for nation_id = 0, NATION.size() - 1 do
+		if(NATION.get_overlord_commanding_units(nation_id)) then
+			NATION.set_overlord_commanding_units(nation_id, false)
+		end
+	end
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_command_units_opt_disabled_on_deselect(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_command_units_opt_enabled_on_select(gamerule_id)
+end
+
+---@param gamerule_id gamerule id
+function alice.alice_gamerule_command_units_opt_enabled_on_deselect(gamerule_id)
+end

docs/extensions.md

@@ -574,9 +574,10 @@ These relate to occupations
 These relate to gamerules
 
 - `alice_can_goto_war_against_spherelord_default_setting = 1.0f` - Sets the default setting for the hardcoded gamerule deciding whether a sphereling can goto war against its spherelord. Can be either 1 (which means they can declare war against spherelord), or 0 (which means they cannot). Default is 1
-- `alice_allow_partial_retreat_default_setting = 0.0f` - Sets the default setting for the hardcoded gamerule deciding whether armies can partial-retreat from battles. 1.0 means it is enabled, while 0 means it is disabled.
+- `alice_allow_partial_retreat_default_setting = 0.0f` - Sets the default setting for the hardcoded gamerule deciding whether armies can partial-retreat from battles. 1.0 means it is enabled, 0 means it is disabled, and 2.0 it is disabled only for the observer tag
 - `alice_fog_of_war_default_setting = 1.0f` - Sets the default setting for the hardcoded gamerule deciding whether fog og war is on or off. 1.0 means fog of war is on, where 0.0 means it is off.
 - `alice_auto_concession_peace_default_setting = 1.0f` - Sets the default setting for the hardcoded gamerule deciding whether a peacedeal will be force-accepted if it is conceding all wargoals (or if the peacedeal concedes 100 warscore or higher). 1.0 means forced-peaces are disabled, where 0.0 means they are enabled.
+- `alice_command_units_default_setting = 0.0f` - Decides whether AI puppets' units can be commanded by players while at war. A value of 0.0f means it is disabled, while a value of 1.0f means it is enabled
 
 ### Support for reforms based on party issues
 
@@ -841,23 +842,14 @@ scripted_gamerule = {
 	name = "test_gamerule"
 	option = {
 		name = "test__gameruleopt_1"
-		on_select = {
-			set_global_flag = rule_1
-		}
-		on_deselect = {
-			clr_global_flag = rule_1
-		}
+		on_select = "opt1_on_select"
+		on_deselect = "opt1_on_deselect"
 	}
 	option = {
 		name = "test__gameruleopt_2"
 		default_option = yes
-		on_select = {
-			set_global_flag = rule_2
-		}
-		on_deselect = {
-			clr_global_flag = rule_2
-		}
-	}
+		on_select = "opt2_on_select"
+		on_deselect = "opt2_on_deselect"
 	
 }
 ```
@@ -869,7 +861,8 @@ Each gamerule may have one or more options. Each option also has a mandatory `na
 
 Next there is the `default_option` member. This simply signals which of the options is selected by default on a new save.
 
-Lastly, there is the `on_select` and `on_deselect` members. These describe a scripted effect to run when said option is either selected or deselected respectively. In the example above it will set a global flag when enabled, and clear that same flag when disabled.
+Lastly, there is the `on_select` and `on_deselect` members. These describe the name of a lua function which should be run when the corrosponding option is selected/deselected. The function should start with the "alice" prefix take a single parameter, which is the numeric ID of the gamerule which was changed.
+Eg. in the previous example, if `"test_gameruleopt_2"` was selected, the function named `alice.opt2_on_select` would be run.
 
 You can also check the state of a gamerule directly in a trigger, with the following trigger:
 
@@ -880,6 +873,7 @@ check_gamerule = {
 }_
 ```
 Here, it evaluates if the gamerule with name `test_gamerule` is set to the option with the name `test_gameruleopt_1`.
+The gamerule can also be checked in lua code, by calling `GAMERULE.check_gamerule_option_by_name` or `GAMERULE.check_gamerule_option_by_id`. 
 
 There are also some hardcoded gamerules which interact with base gameplay directly which is not present in the gamerules.txt file. These can also have their selected option checked with `check_gamerule` trigger. Below is a list of names of the hardcoded gamerules and their options:
 
@@ -898,3 +892,7 @@ There are also some hardcoded gamerules which interact with base gameplay direct
 - `alice_gamerule_auto_concession_peace`: Name of gamerule for enabling/disabling auto peacing in cases of the enemy conceding all wargoals
 	- `alice_gamerule_auto_concession_peace_opt_cannot_reject`: Option for the auto-peace being enabled
 	- `alice_gamerule_auto_concession_peace_opt_can_reject`: Option for the auto-peace being disabled
+
+- `alice_gamerule_command_units`: Name of gamerule for enabling/disabling commanding AI puppets' troops in wars
+    - `alice_gamerule_command_units_opt_disabled`: Option for it being disabled
+    - `alice_gamerule_command_units_opt_disabled`: Option for it being enabled

docs/features/out-of-battle.md

@@ -35,3 +35,13 @@
 
 # US18 Ships repairs
 
+# US101 Sieges and Occupations
+
+| AC1 | Forts are built once with construction cost of some goods comparable to an extra factory level. |
+| AC2 | Forts reduce siege speed by alice_fort_siege_slowdown factor (0.75 by default) per level. |
+| AC3 | Forts increase hostile siege attrition by state.defines.alice_fort_siege_attrition_per_level per level (0.35 by default). | 
+| AC4 | Forts moderately impact victory points score of a province (+1 per fort level). |
+| AC5 | Engineers reduce the effective fort level. Number of engineers required to reduce by 1 level depends on the sieging army size. At least state.defines.engineer_unit_ratio required (0.1 by default) |
+| AC6 | Recon units increase occupation speed of any province. At least state.defines.recon_unit_ratio is required (0.1 by default) |
+| AC7 | Nation sieges its owned provinces 25% faster. |
+| AC8 | Nation sieges its core provinces 10% faster. |

src/common_types/container_types_dcon.hpp

@@ -23,8 +23,10 @@ namespace sys {
 
 struct gamerule_option {
 	dcon::text_key name;
-	dcon::effect_key on_select;
-	dcon::effect_key on_deselect;
+
+	dcon::text_key on_select_lua_function;
+	dcon::text_key on_deselect_lua_function;
+
 
 	bool operator==(const gamerule_option& other) const = default;
 	bool operator!=(const gamerule_option& other) const = default;

src/common_types/debug_string_convertions.cpp

@@ -9,7 +9,7 @@ std::string to_debug_string(const event_option& obj) {
 }
 
 std::string to_debug_string(const gamerule_option& obj)  {
-	return "(name;on_select;on_deselect) => " + std::to_string(obj.name.value) + ";" + std::to_string(obj.on_select.value) + ";" + std::to_string(obj.on_deselect.value);
+	return "(name;on_select_lua_function;on_deselect_lua_function) => " + std::to_string(obj.name.value) + ";" + std::to_string(obj.on_select_lua_function.value) + ";" + std::to_string(obj.on_deselect_lua_function.value);
 }