@expcluster/legacy 7.0.1

package/module/locale/zh-TW/expcore.cfg

@@ -0,0 +1,16 @@
+[expcore-data]
+description-preference=允許寫入資料。
+description-data=把用戶資料寫入電腦
+arg-option="All", "Statistics", "Settings", "Required" 之中
+set-preference=你的喜好已設定為 __1__ 。在你重新加入前將不會有任何改動。
+get-preference=你的喜好為 __1__ 。使用 /set-preference 來更改，使用 /save-data 來獲得一份資料副本。
+get-data=你的個人資料已寫入: factorio/script_output/expgaming_player_data.json
+data-failed=無法載入你的個人資料，任何改動將不會保存。
+data-restore=已載入你的個人資料，所有改動將會被保存。
+preference=儲存喜好
+preference-tooltip=那種資料將在退出時保存
+preference-value-tooltip=使用 /set-preference 來更換儲存喜好
+preference-All=所有資料都會被儲存
+preference-Statistics=只有數據, 設定和資料會被儲存
+preference-Settings=只有設定和資料會被儲存
+preference-Required=只有需要的資料會被儲存

package/module/locale/zh-TW/gui.cfg

@@ -0,0 +1,122 @@
+[player-list]
+main-tooltip=用戶名單
+open-action-bar=選項
+close-action-bar=關閉選項
+reason-confirm=確認原因
+reason-entry=輸入原因
+goto-player=傳送到用戶
+bring-player=傳送用戶到自己
+report-player=舉報用戶
+warn-player=警告用戶
+jail-player=監禁用戶
+kick-player=踢除用戶
+ban-player=封禁用戶
+afk-time=__1__% 地圖時間\n上次移動: __2__
+open-map=__1__ __2__\n__3__\n按下打開地圖
+
+[warp-list]
+main-caption=傳送陣清單 [img=info]
+main-tooltip=傳送陣清單
+sub-tooltip=傳送陣在 __1__ 秒內只能使用一次。 亦需在 __2__ 格之內使用\n__3__\n__4__\n__5__\n__6__\n__7__\n__8__
+sub-tooltip-current= - __1__ 你目前的傳送陣;
+sub-tooltip-connected= - __1__ 你可以到本傳送陣;
+sub-tooltip-different= - __1__ 該傳送陣未連接;
+sub-tooltip-cooldown= - __1__ 傳送冷卻中;
+sub-tooltip-not_available= - __1__ 你不在傳送陣範圍;
+sub-tooltip-bypass= - __1__ 你可以傳送到這裏;
+too-close=無法新建傳送陣; 太接近 __1__ 了
+too-close-to-water=無法新建傳送陣; 太接近水源了， 請移動 __1__ 格又或者填平該地方
+too-close-to-entities=無法新建傳送陣; 太接近其他東西， 請移動 __1__ 格又或者拆除該東西
+last-edit=最後由 __1__ 在 __2__ 更改\n按這在地圖上看
+add-tooltip=新建傳送陣
+confirm-tooltip=儲存更改
+cancel-tooltip=放棄更改
+edit-tooltip=現被 __1__ 修改中
+edit-tooltip-none=現沒有被人修改
+remove-tooltip=拆除傳送陣
+timer-tooltip=請等 __1__ 秒才再次傳送
+timer-tooltip-zero=你要等 __1__ 秒才可以再次傳送
+goto-tooltip=到 X __1__ Y __2__
+goto-bypass=到 X __1__ Y __2__， 繞行模式
+goto-bypass-different-network=到 X __1__ Y __2__， 繞行模式 (不同網絡)
+goto-same-warp=你已在該傳送陣
+goto-different-network=該傳送陣未連接， 你可使用電纜連接
+goto-cooldown=傳送冷卻中， 請等候冷卻
+goto-disabled=你不在傳送陣， 請移至任意傳送陣
+goto-edit=修改傳送陣圖案
+
+[bonus]
+description=取得 / 設定 Bonus 量。
+arg-amount=Bonus 數量， 0 來停用。
+set=你的 Bonus 已設為 __1__。
+get=你的 Bonus 為 __1__。
+perm=你沒有足夠權限設多過 __1__。
+display-fmms=挖掘速度
+display-fmms-tooltip=勢力挖掘速度
+display-frs=跑步速度
+display-frs-tooltip=勢力跑步速度
+display-fcs=合成速度
+display-fcs-tooltip=勢力合成速度
+display-fisb=儲存位
+display-fisb-tooltip=勢力儲存位
+display-fhb=生命
+display-fhb-tooltip=勢力生命
+display-frdb=到達距離
+display-frdb-tooltip=勢力到達距離
+display-fwrsm=機械人速度
+display-fwrsm-tooltip=勢力機械人速度
+display-fwrbm=機械人電力
+display-fwrbm-tooltip=勢力機械人電力
+display-fwrsb=械人儲存
+display-fwrsb-tooltip=勢力機械人儲存
+display-ffrlm=機械人生命
+display-ffrlm-tooltip=勢力戰鬥機械人生命時間
+
+[vlayer]
+main-tooltip=Vlayer 介面
+description-pbr=使用 Vlayer 為玩家電池充電
+description-vi=Vlayer 資訊
+pbr-not-running=vlayer 沒有運行
+display-item-solar=[img=entity/solar-panel] 太陽能板
+display-item-accumulator=[img=entity/accumulator] 蓄電池
+display-current-production=[virtual-signal=signal-P] 現時產能
+display-sustained-production=[virtual-signal=signal-S] 持續產能
+display-max-capacity=[virtual-signal=signal-C] 電池容量
+display-current-capacity=[virtual-signal=signal-E] 電池電量
+display-remaining-surface-area=[virtual-signal=signal-R] 餘下土地
+display-item-solar-tooltip=太陽能板數量
+display-item-accumulator-tooltip=蓄電池數量
+display-current-production-tooltip=現時電力產能
+display-sustained-production-tooltip=持續電力產能
+display-max-capacity-tooltip=電池最大容量
+display-current-capacity-tooltip=現時電池電量
+display-remaining-surface-area-tooltip=餘下土地。 放入堆填來增加
+steel-chest-detect=沒檢測到鋼箱
+steel-chest-empty=鋼箱不是空的
+control-refresh=刷新列表
+control-see=查看介面
+control-build=建造介面
+control-remove=拆除介面
+result-build=建造了
+result-remove=拆除了
+result-interface-location=__1__ 介面在 __2__
+interface-result=__1__ 在 __2__ __3__ __4__ 介面
+result-unable=無法建造 __1__ 介面，因 __2__
+result-multiple=檢測到多個鋼箱
+result-limit=超出最大限制
+result-space=空間不足
+control-type-energy=電力
+control-type-circuit=回路
+control-type-storage-input=放入箱
+control-type-storage-output=提取箱
+power-on-space-research=你要研究 [technology=__1__] 在 __2__ 級 才可使用太空平台 vlayer 功能。
+enter=現在進入 vlayer 區域選擇
+exit=已進入 vlayer 區域選擇
+
+[toolbar]
+main-caption=工具箱
+main-tooltip=工具箱設定\n選上來設定喜好
+reset=重設
+toggle=啟用喜好
+move-up=向上
+move-down=向下

package/module/module.json

@@ -0,0 +1,14 @@
+{
+	"name": "exp_legacy",
+	"load": [
+		"control.lua"
+	],
+	"require": [
+	],
+	"dependencies": {
+		"clusterio": "*",
+		"exp_util": "*",
+		"exp_roles": "*",
+		"exp_gui": "*"
+	}
+}

package/module/module_exports.lua

@@ -0,0 +1,3 @@
+--- Can contain anything you want to allow other plugins to have access to, this example exposes the control file
+-- Access the exports from other modules using require("modules/exp_legacy")
+return require("modules/exp_legacy/control")

package/module/modules/control/jail.lua

@@ -0,0 +1,119 @@
+--[[-- Control Module - Jail
+    - Adds a way to jail players.
+    @control Jail
+    @alias Jail
+
+    @usage
+    -- import the module from the control modules
+    local Jail = require("modules.exp_legacy.modules.control.jail") --- @dep modules.control.jail
+
+    -- This will give 'MrBiter' the jail role, which suppresses all of their other roles
+    -- the player name and reason are only so they can be included in the event for user feedback
+    Jail.jail_player('MrBiter', 'Cooldude2606', 'Likes biters too much')
+
+    -- This will remove the jail role from 'MrBiter', restoring their other roles
+    -- again as above the player name is only used in the event for user feedback
+    Jail.unjail_player('MrBiter', 'Cooldude2606')
+]]
+
+local Roles = require("modules/exp_roles")
+
+local valid_player = function(p) return type(p) == "userdata" and p or game.get_player(p) end
+
+--- The role given to jailed players, it has a higher priority than every other role
+local function jail_role()
+    return assert(Roles.get_role_by_name("Jail"), "The Jail role does not exist")
+end
+
+local Jail = {
+    events = {
+        --- When a player is assigned to jail
+        -- @event on_player_jailed
+        -- @tparam number player_index the index of the player who was jailed
+        -- @tparam string by_player_name the name of the player who jailed the other player
+        -- @tparam string reason the reason that the player was jailed
+        on_player_jailed = script.generate_event_name(),
+        --- When a player is unassigned from jail
+        -- @event on_player_unjailed
+        -- @tparam number player_index the index of the player who was unjailed
+        -- @tparam string by_player_name the name of the player who unjailed the other player
+        on_player_unjailed = script.generate_event_name(),
+    },
+}
+
+--- Used to emit the jail related events
+-- @tparam number event the name of the event that will be emited
+-- @tparam LuaPlayer player the player who is being acted on
+-- @tparam string by_player_name the player who is doing the action
+-- @tparam string reason the reason for the action (jail)
+local function event_emit(event, player, by_player_name, reason)
+    script.raise_event(event, {
+        name = event,
+        tick = game.tick,
+        player_index = player.index,
+        by_player_name = by_player_name,
+        reason = reason,
+    })
+end
+
+--- Jail.
+-- Functions related to jail
+-- @section jail-functions
+
+--- Checks if the player is currently in jail
+-- @tparam LuaPlayer player the player to check if they are in jail
+-- @treturn boolean whether the player is currently in jail
+function Jail.is_jailed(player)
+    local valid = valid_player(player)
+    return valid ~= nil and jail_role():has_player(valid)
+end
+
+--- Moves a player to jail, which suppresses all of their other roles
+-- @tparam LuaPlayer player the player who will be jailed
+-- @tparam string by_player_name the name of the player who is doing the jailing
+-- @tparam[opt='Non given.'] string reason the reason that the player is being jailed
+-- @treturn boolean wheather the user was jailed successfully
+function Jail.jail_player(player, by_player_name, reason)
+    player = valid_player(player)
+    if not player then return end
+    if not by_player_name then return end
+
+    reason = reason or "Non given."
+
+    local role = jail_role()
+    if role:has_player(player) then return end
+
+    player.walking_state = { walking = false, direction = player.walking_state.direction }
+    player.riding_state = { acceleration = defines.riding.acceleration.nothing, direction = player.riding_state.direction }
+    player.mining_state = { mining = false }
+    player.shooting_state = { state = defines.shooting.not_shooting, position = player.shooting_state.position }
+    player.picking_state = false
+    player.repair_state = { repairing = false, position = player.repair_state.position }
+
+    role:assign(player, { by_player_name = by_player_name, silent = true })
+
+    event_emit(Jail.events.on_player_jailed, player, by_player_name, reason)
+
+    return true
+end
+
+--- Moves a player out of jail, which restores all of their other roles
+-- @tparam LuaPlayer player the player that will be unjailed
+-- @tparam string by_player_name the name of the player that is doing the unjail
+-- @treturn boolean whether the player was unjailed successfully
+function Jail.unjail_player(player, by_player_name)
+    player = valid_player(player)
+    if not player then return end
+    if not by_player_name then return end
+
+    local role = jail_role()
+    if not role:has_player(player) then return end
+
+    role:unassign(player, { by_player_name = by_player_name, silent = true })
+
+    event_emit(Jail.events.on_player_unjailed, player, by_player_name)
+
+    return true
+end
+
+return Jail

package/module/modules/control/protection.lua

@@ -0,0 +1,204 @@
+--[[-- Control Module - Protection
+    - Controls protected entities
+    @control Protection
+    @alias Protection
+]]
+
+local Storage = require("modules/exp_util/storage")
+local Event = require("modules/exp_legacy/utils/event") --- @dep utils.event
+local config = require("modules.exp_legacy.config.protection") --- @dep config.protection
+local EntityProtection = {
+    protected_entity_names = table.deep_copy(config.always_protected_names),
+    protected_entity_types = table.deep_copy(config.always_protected_types),
+    events = {
+        --- When a player mines a protected entity
+        -- @event on_player_mined_protected
+        -- @tparam number player_index the player index of the player who got mined the entity
+        -- @tparam LuaEntity entity the entity which was mined
+        on_player_mined_protected = script.generate_event_name(),
+        --- When a player repeatedly mines protected entities
+        -- @event on_repeat_violation
+        -- @tparam number player_index the player index of the player who got mined the entities
+        -- @tparam LuaEntity entity the last entity which was mined
+        on_repeat_violation = script.generate_event_name(),
+    },
+}
+
+-- Convert config tables into lookup tables
+for _, config_key in ipairs{ "always_protected_names", "always_protected_types", "always_trigger_repeat_names", "always_trigger_repeat_types" } do
+    local tbl = config[config_key]
+    for key, value in ipairs(tbl) do
+        tbl[key] = nil
+        tbl[value] = true
+    end
+end
+
+local Roles = require("modules/exp_roles")
+
+----- Storage Variables -----
+--- Variables stored in the global table
+
+local protected_entities = {} -- All entities which are protected
+local protected_areas = {} -- All areas which are protected
+local repeats = {} -- Stores repeat removals by players
+
+Storage.register({
+    protected_entities = protected_entities,
+    protected_areas = protected_areas,
+    repeats = repeats,
+}, function(tbl)
+    protected_entities = tbl.protected_entities
+    protected_areas = tbl.protected_areas
+    repeats = tbl.repeats
+end)
+
+----- Local Functions -----
+--- Functions used internally to search and add to the protected array
+
+--- Get the key used in protected_entities
+local function get_entity_key(entity)
+    return string.format("%i,%i", math.floor(entity.position.x), math.floor(entity.position.y))
+end
+
+--- Get the key used in protected_areas
+local function get_area_key(area)
+    return string.format("%i,%i", math.floor(area.left_top.x), math.floor(area.left_top.y))
+end
+
+--- Check if an entity is always protected
+local function check_always_protected(entity)
+    return config.always_protected_names[entity.name] or config.always_protected_types[entity.type] or false
+end
+
+--- Check if an entity always triggers repeat protection
+local function check_always_trigger_repeat(entity)
+    return config.always_trigger_repeat_names[entity.name] or config.always_trigger_repeat_types[entity.type] or false
+end
+
+----- Public Functions -----
+--- Functions used to add and remove protected entities
+
+--- Add an entity to the protected list
+function EntityProtection.add_entity(entity)
+    local entities = protected_entities[entity.surface.index]
+    if not entities then
+        entities = {}
+        protected_entities[entity.surface.index] = entities
+    end
+    entities[get_entity_key(entity)] = entity
+end
+
+--- Remove an entity from the protected list
+function EntityProtection.remove_entity(entity)
+    local entities = protected_entities[entity.surface.index]
+    if not entities then return end
+    entities[get_entity_key(entity)] = nil
+end
+
+--- Get all protected entities on a surface
+function EntityProtection.get_entities(surface)
+    return protected_entities[surface.index] or {}
+end
+
+--- Check if an entity is protected
+function EntityProtection.is_entity_protected(entity)
+    if check_always_protected(entity) then return true end
+    local entities = protected_entities[entity.surface.index]
+    if not entities then return false end
+    return entities[get_entity_key(entity)] == entity
+end
+
+--- Add an area to the protected list
+function EntityProtection.add_area(surface, area)
+    local areas = protected_areas[surface.index]
+    if not areas then
+        areas = {}
+        protected_areas[surface.index] = areas
+    end
+    areas[get_area_key(area)] = area
+end
+
+--- Remove an area from the protected list
+function EntityProtection.remove_area(surface, area)
+    local areas = protected_areas[surface.index]
+    if not areas then return end
+    areas[get_area_key(area)] = nil
+end
+
+--- Get all protected areas on a surface
+function EntityProtection.get_areas(surface)
+    return protected_areas[surface.index] or {}
+end
+
+--- Check if an entity is protected
+function EntityProtection.is_position_protected(surface, position)
+    local areas = protected_areas[surface.index]
+    if not areas then return false end
+    for _, area in pairs(areas) do
+        if area.left_top.x <= position.x and area.left_top.y <= position.y
+        and area.right_bottom.x >= position.x and area.right_bottom.y >= position.y
+        then
+            return true
+        end
+    end
+
+    return false
+end
+
+----- Events -----
+--- All events registered by this module
+
+--- Raise events for protected entities
+Event.add(defines.events.on_pre_player_mined_item, function(event)
+    local entity = event.entity
+    local player = game.players[event.player_index]
+    -- Check if the player should be ignored
+    if config.ignore_admins and player.admin then return end
+    if entity.last_user == nil or entity.last_user.index == player.index then return end
+    if config.ignore_permission and Roles.player_has_permission(player, config.ignore_permission) then return end
+
+    -- Check if the entity is protected
+    if EntityProtection.is_entity_protected(entity)
+    or EntityProtection.is_position_protected(entity.surface, entity.position)
+    then
+        -- Update repeats
+        local player_repeats = repeats[player.name]
+        if not player_repeats then
+            player_repeats = { last = game.tick, count = 0 }
+            repeats[player.name] = player_repeats
+        end
+        player_repeats.last = game.tick
+        player_repeats.count = player_repeats.count + 1
+        -- Send events
+        event.name = EntityProtection.events.on_player_mined_protected
+        script.raise_event(EntityProtection.events.on_player_mined_protected, event)
+        if check_always_trigger_repeat(entity) or player_repeats.count >= config.repeat_count then
+            player_repeats.count = 0 -- Reset to avoid spamming of events
+            event.name = EntityProtection.events.on_repeat_violation
+            script.raise_event(EntityProtection.events.on_repeat_violation, event)
+        end
+    end
+end)
+
+--- Remove old repeats
+Event.on_nth_tick(config.refresh_rate, function()
+    local old = game.tick - config.repeat_lifetime
+    for player_name, player_repeats in pairs(repeats) do
+        if player_repeats.last <= old then
+            repeats[player_name] = nil
+        end
+    end
+end)
+
+--- When an entity is removed remove it from the protection list
+local function event_remove_entity(event)
+    EntityProtection.remove_entity(event.entity)
+end
+
+Event.add(defines.events.on_space_platform_pre_mined, event_remove_entity)
+Event.add(defines.events.on_pre_player_mined_item, event_remove_entity)
+Event.add(defines.events.on_robot_pre_mined, event_remove_entity)
+Event.add(defines.events.on_entity_died, event_remove_entity)
+Event.add(defines.events.script_raised_destroy, event_remove_entity)
+
+return EntityProtection