# burgerAPI

**Repository Path**: hangback/burgerAPI

## Basic Information

- **Project Name**: burgerAPI
- **Description**: 蛋仔派对豆油汉堡所创建的库
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-14
- **Last Updated**: 2025-04-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 任务库
### 快速开始

创建任务集
> `CreateTasks(binder : Role) -> integer`
```lua
local roles = GameAPI.get_all_valid_roles()
for _, role in ipairs(roles) do
    CreateTasks(role) ---给所有玩家创建任务集
end
```

导入任务配置表
> `ImportTasks(tasks : integer, source : string)`
```lua
local tasks = CreateTasks(role)
ImportTasks(tasks, "ur_path_to_config")
```

任务配置表格式
```lua
{
    ["name"] = "ur_tasks_name", ---@type string 你的任务集合名称
    ["list"] = { ---@type task[] 任务列表
        { ---@type task 一个任务单元
            ["name"] = "task1", ---@type string 该任务的名称
            ["weight"] = 0, ---@type integer 任务的权重
            ["kind"] = 1, ---@type TaskType : integer 任务类型(1:主线, 2:日常, 3:活动, 4:节日)
            ["desc"] = "task1_desc", ---@type string 该任务的描述
            ["condition"] = { ---@type condition[] 条件列表（需要所有条件完成）
                 {---@type condition 条件单元
                    ["form"] = EVENT.SOMETHING ---@type EVENT 事件名，触发该事件后条件即可满足，当事件为CUSTOM_EVENT时只能手动加分
                    ["tar_count"] = 1 ---@type integer 目标计数，该事件需要被触发的次数
                }
            },
            ["reward"] = { ---@type TaskReward
                ["exp"] = 1, ---@type integer 完成该任务奖励的经验数
                ["event"] = "target_event" ---@type string 完成该任务后触发的事件（会携带玩家参数）
            }
        }
    }
}
```
绑定任务集界面

    BindTasksPage(
        tasks : integer, --传入的任务集
        units : ListENode, --下面三个界面控件的父级控件
        names : ListENode, --名称控件，用于展示单个任务的名称
        descs : ListENode, --描述控件，用于展示单个任务的描述
        counts : ListENode, --进度控件，用于展示单个任务的进度
        tag : ENode, --标签控件，用于展示任务集的标签按钮
        page : ENode --页数控件，用于展示当前任务集所在页面信息
    )

更改任务页码
> `TurnTasksPage(tasks : integer, page : integer)`
```lua
local tasks = CreateTasks(role)
TurnTasksPage(tasks, 1) ---只在绑定了界面时生效
```

## 贡献
- 豆油汉堡：蛋仔乐园创作者