饥荒Mod 开发(十八)：Mod 添加配置选项

饥荒Mod 开发(十七)：手动保存和加载，无限重生
饥荒Mod 开发(十九)：显示简易血量

我们可能需要给Mod 增加一些配置，比如是否开启全图，是否禁用自动保存等等，代码中就可以根据这些配置来做不同的逻辑。

添加配置

需要在modinfo.lua 中添加配置代码，配置格式是固定的。

configuration_options = {
    {
        name = "show_full_map", -- 配置项的名称
        label = "显示全图", -- 配置项的标签
        options = { -- 配置项的选项
            {description = "是", data = true}, -- 选项描述和对应的数据
            {description = "否", data = false},
        },
        default = true, -- 默认值
    },
    {
        name = "health_per_second", -- 配置项的名称
        label = "每秒钟恢复的血量", -- 配置项的标签
        options = { -- 配置项的选项
            {description = "1", data = 1}, -- 选项描述和对应的数据
            {description = "2", data = 2},
            {description = "3", data = 3},
            {description = "4", data = 4},
            {description = "5", data = 5},
        },
        default = 5, -- 默认值
    },
    {
        name = "pet_name", -- 配置项的名称
        label = "宠物名字", -- 配置项的标签
        options = { -- 配置项的选项
            {description = "pigpet", data = "pigpet"}, -- 选项描述和对应的数据
        },
        default = "pigpet", -- 默认值
    }
}

获取配置

-- 读取是否显示全图的配置，参数填 配置里的name 字段
local showFullMap = GetModConfigData("show_full_map")
-- 根据配置设置是否显示全图
if showFullMap then
    -- 显示全图的逻辑
    -- ...
else
    -- 不显示全图的逻辑
    -- ...
end