redscript-mc 3.0.1 → 3.0.2

package/redscript-docs/docs/zh/stdlib/teams.md

@@ -0,0 +1,150 @@
+# Teams
+
+> 本文档由 `src/stdlib/teams.mcrs` 自动生成，请勿手动编辑。
+
+## API 列表
+
+- [create_team](#create-team)
+- [create_red_team](#create-red-team)
+- [create_blue_team](#create-blue-team)
+- [create_green_team](#create-green-team)
+- [create_yellow_team](#create-yellow-team)
+- [add_to_team](#add-to-team)
+- [remove_from_teams](#remove-from-teams)
+- [setup_two_teams](#setup-two-teams)
+- [setup_four_teams](#setup-four-teams)
+- [cleanup_teams](#cleanup-teams)
+
+---
+
+## `create_team`
+
+创建一个队伍并设置显示颜色
+
+```redscript
+fn create_team(name: string, color: string)
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `name` | 计分板队伍名称 |
+| `color` | Minecraft 队伍颜色字符串，如 `red` 或 `blue` |
+
+**示例**
+
+```redscript
+create_team("spectator", "gray")
+```
+
+---
+
+## `create_red_team`
+
+创建默认红队，并关闭队友伤害
+
+```redscript
+fn create_red_team()
+```
+
+**示例**
+
+```redscript
+create_red_team()
+```
+
+---
+
+## `create_blue_team`
+
+创建默认蓝队，并关闭队友伤害
+
+```redscript
+fn create_blue_team()
+```
+
+---
+
+## `create_green_team`
+
+创建默认绿队，并关闭队友伤害
+
+```redscript
+fn create_green_team()
+```
+
+---
+
+## `create_yellow_team`
+
+创建默认黄队，并关闭队友伤害
+
+```redscript
+fn create_yellow_team()
+```
+
+---
+
+## `add_to_team`
+
+将目标选择器加入指定队伍
+
+```redscript
+fn add_to_team(target: selector, team_name: string)
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `target` | 要加入队伍的目标选择器 |
+| `team_name` | 已存在的队伍名称 |
+
+---
+
+## `remove_from_teams`
+
+将目标选择器从所有队伍中移除
+
+```redscript
+fn remove_from_teams(target: selector)
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `target` | 要移除的目标选择器 |
+
+---
+
+## `setup_two_teams`
+
+创建默认的双队配置（红队和蓝队）
+
+```redscript
+fn setup_two_teams()
+```
+
+---
+
+## `setup_four_teams`
+
+创建默认的四队配置（红蓝绿黄）
+
+```redscript
+fn setup_four_teams()
+```
+
+---
+
+## `cleanup_teams`
+
+删除本模块默认创建的四个标准队伍
+
+```redscript
+fn cleanup_teams()
+```
+
+---

package/redscript-docs/docs/zh/stdlib/timer.md

@@ -0,0 +1,254 @@
+# Timer
+
+> 本文档由 `src/stdlib/timer.mcrs` 自动生成，请勿手动编辑。
+
+## API 列表
+
+- [Timer.new](#timer-new)
+- [Timer.start](#timer-start)
+- [Timer.pause](#timer-pause)
+- [Timer.reset](#timer-reset)
+- [Timer.done](#timer-done)
+- [Timer.elapsed](#timer-elapsed)
+- [Timer.remaining](#timer-remaining)
+- [Timer.tick](#timer-tick)
+- [tick_to_seconds](#tick-to-seconds)
+- [tick_to_ms](#tick-to-ms)
+- [seconds_to_ticks](#seconds-to-ticks)
+- [format_time_s](#format-time-s)
+- [format_time_m](#format-time-m)
+- [format_time_h](#format-time-h)
+
+---
+
+## `Timer.new`
+
+创建一个指定持续时长的新计时器
+
+```redscript
+fn new(duration: int) -> Timer
+```
+
+**返回：** 新的 Timer 实例
+
+---
+
+## `Timer.start`
+
+启动或继续计时器
+
+```redscript
+fn start(self)
+```
+
+---
+
+## `Timer.pause`
+
+暂停计时器
+
+```redscript
+fn pause(self)
+```
+
+---
+
+## `Timer.reset`
+
+将已流逝的刻数重置为零
+
+```redscript
+fn reset(self)
+```
+
+---
+
+## `Timer.done`
+
+检查计时器是否已达到持续时间
+
+```redscript
+fn done(self) -> bool
+```
+
+**返回：** 若已完成返回 true，否则返回 false
+
+---
+
+## `Timer.elapsed`
+
+获取已流逝的游戏刻数
+
+```redscript
+fn elapsed(self) -> int
+```
+
+**返回：** 已流逝刻数
+
+---
+
+## `Timer.remaining`
+
+获取剩余刻数（最小为 0）
+
+```redscript
+fn remaining(self) -> int
+```
+
+**返回：** 剩余刻数，不足时为 0
+
+---
+
+## `Timer.tick`
+
+在计时器激活时手动推进一刻
+
+```redscript
+fn tick(self)
+```
+
+---
+
+## `tick_to_seconds` <Badge type="info" text="v1.0.0" />
+
+将 Minecraft 游戏刻转换为整秒（20 刻 = 1 秒）
+
+```redscript
+fn tick_to_seconds(ticks: int): int
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `ticks` | 游戏刻数 |
+
+**返回：** ticks / 20
+
+**示例**
+
+```redscript
+let s = tick_to_seconds(100)  // result: 5
+```
+
+---
+
+## `tick_to_ms` <Badge type="info" text="v1.0.0" />
+
+将游戏刻转换为毫秒（1 刻 = 50 ms）
+
+```redscript
+fn tick_to_ms(ticks: int): int
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `ticks` | 游戏刻数 |
+
+**返回：** ticks * 50
+
+**示例**
+
+```redscript
+let ms = tick_to_ms(20)  // result: 1000
+```
+
+---
+
+## `seconds_to_ticks` <Badge type="info" text="v1.0.0" />
+
+将秒转换为 Minecraft 游戏刻（1 秒 = 20 刻）
+
+```redscript
+fn seconds_to_ticks(s: int): int
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `s` | 秒数 |
+
+**返回：** s * 20
+
+**示例**
+
+```redscript
+let t = seconds_to_ticks(5)  // result: 100
+```
+
+---
+
+## `format_time_s` <Badge type="info" text="v1.0.0" />
+
+从刻数中提取秒分量（0-59）
+
+```redscript
+fn format_time_s(ticks: int): int
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `ticks` | 游戏刻数 |
+
+**返回：** (ticks / 20) % 60
+
+**示例**
+
+```redscript
+let s = format_time_s(1500)  // result: 15  (75 seconds mod 60)
+```
+
+---
+
+## `format_time_m` <Badge type="info" text="v1.0.0" />
+
+从刻数中提取分钟分量（0-59）
+
+```redscript
+fn format_time_m(ticks: int): int
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `ticks` | 游戏刻数 |
+
+**返回：** (ticks / 1200) % 60
+
+**示例**
+
+```redscript
+let m = format_time_m(72000)  // result: 0  (1 hour)
+```
+
+---
+
+## `format_time_h` <Badge type="info" text="v1.0.0" />
+
+从刻数中提取小时分量
+
+```redscript
+fn format_time_h(ticks: int): int
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `ticks` | 游戏刻数 |
+
+**返回：** ticks / 72000
+
+**示例**
+
+```redscript
+let h = format_time_h(144000)  // result: 2
+```
+
+---

package/redscript-docs/docs/zh/stdlib/vec.md

@@ -0,0 +1,158 @@
+# Vec
+
+> 本文档由 `src/stdlib/vec.mcrs` 自动生成，请勿手动编辑。
+
+## API 列表
+
+- [dot2d](#dot2d)
+- [length2d_fixed](#length2d-fixed)
+- [dot3d](#dot3d)
+- [cross3d_x](#cross3d-x)
+- [cross3d_y](#cross3d-y)
+- [cross3d_z](#cross3d-z)
+
+---
+
+## `dot2d` <Badge type="info" text="v1.0.0" />
+
+两个二维整数向量的点积
+
+```redscript
+fn dot2d(ax: int, ay: int, bx: int, by: int) -> int
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `ax` | 向量 A 的 X 分量 |
+| `ay` | 向量 A 的 Y 分量 |
+| `bx` | 向量 B 的 X 分量 |
+| `by` | 向量 B 的 Y 分量 |
+
+**返回：** ax*bx + ay*by
+
+**示例**
+
+```redscript
+let d = dot2d(3, 4, 3, 4)  // result: 25
+```
+
+---
+
+## `length2d_fixed` <Badge type="info" text="v1.0.0" />
+
+二维向量的欧几里得长度，结果 ×1000 定点数
+
+```redscript
+fn length2d_fixed(x: int, y: int) -> int
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `x` | X 分量（保持 |x|, |y| ≤ ~1000 以避免溢出） |
+| `y` | Y 分量 |
+
+**返回：** sqrt(x²+y²) × 1000
+
+**示例**
+
+```redscript
+let l = length2d_fixed(3, 4)  // result: 5000
+```
+
+---
+
+## `dot3d` <Badge type="info" text="v1.0.0" />
+
+两个三维整数向量的点积
+
+```redscript
+fn dot3d(ax: int, ay: int, az: int, bx: int, by: int, bz: int) -> int
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `ax` | 向量 A 的 X 分量 |
+| `ay` | 向量 A 的 Y 分量 |
+| `az` | 向量 A 的 Z 分量 |
+| `bx` | 向量 B 的 X 分量 |
+| `by` | 向量 B 的 Y 分量 |
+| `bz` | 向量 B 的 Z 分量 |
+
+**返回：** ax*bx + ay*by + az*bz
+
+**示例**
+
+```redscript
+let d = dot3d(1, 0, 0, 1, 0, 0)  // result: 1
+```
+
+---
+
+## `cross3d_x` <Badge type="info" text="v1.0.0" />
+
+叉积 A×B 的 X 分量（ay*bz - az*by）
+
+```redscript
+fn cross3d_x(ax: int, ay: int, az: int, bx: int, by: int, bz: int) -> int
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `ax` | A 的 X 分量 |
+| `bx` | B 的 X 分量 |
+
+**返回：** ay*bz - az*by
+
+---
+
+## `cross3d_y` <Badge type="info" text="v1.0.0" />
+
+叉积 A×B 的 Y 分量（az*bx - ax*bz）
+
+```redscript
+fn cross3d_y(ax: int, ay: int, az: int, bx: int, by: int, bz: int) -> int
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `ax` | A 的 X 分量 |
+| `bx` | B 的 X 分量 |
+
+**返回：** az*bx - ax*bz
+
+---
+
+## `cross3d_z` <Badge type="info" text="v1.0.0" />
+
+叉积 A×B 的 Z 分量（ax*by - ay*bx）
+
+```redscript
+fn cross3d_z(ax: int, ay: int, az: int, bx: int, by: int, bz: int) -> int
+```
+
+**参数**
+
+| 参数 | 说明 |
+|------|------|
+| `ax` | A 的 X 分量 |
+| `bx` | B 的 X 分量 |
+
+**返回：** ax*by - ay*bx
+
+**示例**
+
+```redscript
+let z = cross3d_z(1, 0, 0, 0, 1, 0)  // result: 1
+```
+
+---