Python SDK 文档
欢迎使用我们为比赛编写的 Python SDK！本文档将详细介绍可供选手调用的接口和功能，包括参数、返回值类型以及用法示例，帮助您更好地理解如何使用该 SDK 来控制您的无人作战系统参与比赛。
1. 模板说明
版本要求：Python 3.12
首先请安装依赖项，需要在命令行中输入：
pip install -r requirements.txt
你可以在 logic.py 中编写你的代码。对于有经验的开发者，你也可以修改项目中的其他任何文件。在命令行中运行以下命令来启动 agent：
python main.py --server <server> --token <token>
\<server>：游戏的服务器地址。（默认值：ws://localhost:14514）
\<token>：agent的令牌。（默认值：1919810）
例如：
python main.py --server ws://localhost:14514 --token 1919810
请注意：运行此模板前，请确保你的环境满足Python版本要求，并已正确安装所有依赖项。如果修改了模板内容，可能需要相应地调整运行命令或代码逻辑。在运行前，请务必检查你的服务器地址和令牌是否正确，以确保agent能够成功连接到游戏服务器。
2. 接口介绍
欢迎使用我们为比赛编写的 Python SDK！本文档将详细介绍可供选手调用的接口和功能，包括参数、返回值类型以及用法示例，帮助您更好地理解如何使用该 SDK 来控制您的无人作战系统参与比赛。
2.1. 初始化
from sdk import Agent
agent = Agent("<TOKEN>")
通过实例化 Agent 类并传入您的身份 token 字符串来初始化一个代理对象。该 token 是您在比赛中的唯一标识。
2.2. 连接比赛服务器
await agent.connect("比赛服务器地址")
使用 connect 方法连接到比赛服务器。您需要提供比赛服务器的地址。若本地测试，可使用默认地址 ws://localhost:14514。
2.3. 断开连接
await agent.disconnect()
使用 disconnect 方法断开与比赛服务器的连接。
2.4. 获取游戏状态信息
2.4.1. 获取所有玩家信息
players_info = agent.all_player_info
- 返回类型：Optional[List[PlayerInfo]]
all_player_info 属性将返回一个包含所有玩家信息的列表。每个玩家信息包括玩家的 ID、生命值、护甲、当前护甲血量、速度、当前武器、武器池、位置和背包物品等。
2.4.2. 获取地图信息
game_map = agent.map
- 返回类型：Optional[Map]
map 属性将返回地图信息，包括地图的长度和障碍物位置。
2.4.3. 获取资源信息
supplies = agent.supplies
- 返回类型：Optional[List[Supply]]
supplies 属性将返回一个包含所有资源信息的列表。每个资源信息包括资源的种类、位置和数量。
2.4.4. 获取安全区信息
safe_zone = agent.safe_zone
- 返回类型：Optional[SafeZone]
safe_zone 属性将返回安全区信息，包括安全区的中心位置和半径。
2.4.5. 获取自身 ID
self_id = agent.self_id
- 返回类型：Optional[int]
self_id 属性将返回自身玩家的 ID。
2.4.6. 获取ticks
ticks = agent.ticks
- 返回类型：Optional[int]
ticks 属性将返回当前ticks
2.5. 操作无人作战系统
2.5.1. 选择出生地
agent.choose_origin(position: Position[float])
- 参数：position (Position[float]) 代表出生地位置
- 返回类型：None
使用 choose_origin 方法选择无人作战系统的出生地。
2.5.2. 移动
agent.move(position: Position[float])
- 参数：position (Position[float]) 代表目标位置
- 返回类型：None
使用 move 方法使无人作战系统移动到指定位置。
2.5.3. 停止移动
agent.stop()
- 返回类型：None
使用 stop 方法停止无人作战系统的移动。
2.5.4. 拾取资源
agent.pick_up(item_kind: ItemKind, count: int)
- 参数：
- item_kind (ItemKind) - 资源种类
- count (int) - 数量
- 返回类型：None
使用 pick_up 方法使无人作战系统拾取地图上的资源。拾取当前脚下 1×1 方格上的资源
2.5.5. 放弃资源
agent.abandon(item_kind: ItemKind, count: int)
- 参数：
- item_kind (ItemKind) - 资源种类
- count (int) - 数量
- 返回类型：None
使用 abandon 方法使无人作战系统放弃背包中的指定数量的资源。
2.5.6. 切换武器
agent.switch_firearm(item_kind: FirearmKind)
- 参数：item_kind (FirearmKind) - 目标武器的种类
- 返回类型：None
使用 switch_firearm 方法切换无人作战系统的当前武器。
2.5.7. 使用药品
agent.use_medicine(medicine_kind: MedicineKind)
- 参数：medicine_kind (MedicineKind) - 药品种类
- 返回类型：None
使用 use_medicine 方法使用药品恢复无人作战系统的生命值。
2.5.8. 使用手榴弹
agent.use_grenade(position: Position[float])
- 参数：position (Position[float]) - 目标位置
- 返回类型：None
使用 use_grenade 方法投掷手榴弹攻击敌人或破坏墙体。
2.5.9. 攻击
agent.attack(position: Position[float])
- 参数：position (Position[float]) - 目标位置
- 返回类型：None
使用 attack 方法使无人作战系统攻击指定位置的敌人。
2.6. 其他
2.6.1. 判断游戏是否准备就绪
ready = agent.is_game_ready()
- 返回类型：bool
is_game_ready 方法将返回一个布尔值，指示游戏是否已准备就绪，即是否已获取到所有必要的游戏状态信息。