redscript-mc 3.0.1 → 3.0.2

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

@@ -0,0 +1,153 @@
+# Teams
+
+> Auto-generated from `src/stdlib/teams.mcrs` — do not edit manually.
+
+## 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`
+
+Creates a team and applies a display color.
+
+```redscript
+fn create_team(name: string, color: string)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `name` | Team name used by the scoreboard team system |
+| `color` | Minecraft team color string such as `red` or `blue` |
+
+**Example**
+
+```redscript
+create_team("spectator", "gray")
+```
+
+---
+
+## `create_red_team`
+
+Creates the standard red team with friendly fire disabled.
+
+```redscript
+fn create_red_team()
+```
+
+**Example**
+
+```redscript
+create_red_team()
+```
+
+---
+
+## `create_blue_team`
+
+Creates the standard blue team with friendly fire disabled.
+
+```redscript
+fn create_blue_team()
+```
+
+---
+
+## `create_green_team`
+
+Creates the standard green team with friendly fire disabled.
+
+```redscript
+fn create_green_team()
+```
+
+---
+
+## `create_yellow_team`
+
+Creates the standard yellow team with friendly fire disabled.
+
+```redscript
+fn create_yellow_team()
+```
+
+---
+
+## `add_to_team`
+
+Adds an entity or player selector to a team.
+
+```redscript
+fn add_to_team(target: selector, team_name: string)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Target selector to join the team |
+| `team_name` | Existing team name |
+
+---
+
+## `remove_from_teams`
+
+Removes an entity or player selector from all teams.
+
+```redscript
+fn remove_from_teams(target: selector)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Target selector to remove from teams |
+
+---
+
+## `setup_two_teams`
+
+Creates the default two-team setup used by many arena games.
+This creates `red` and `blue`.
+
+```redscript
+fn setup_two_teams()
+```
+
+---
+
+## `setup_four_teams`
+
+Creates the default four-team setup.
+This creates `red`, `blue`, `green`, and `yellow`.
+
+```redscript
+fn setup_four_teams()
+```
+
+---
+
+## `cleanup_teams`
+
+Removes the default team set created by this module.
+Safe to call during cleanup even if some teams were unused.
+
+```redscript
+fn cleanup_teams()
+```
+
+---

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

@@ -0,0 +1,246 @@
+# Timer
+
+> Auto-generated from `src/stdlib/timer.mcrs` — do not edit manually.
+
+## 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`
+
+Create a new timer with the given duration in ticks.
+
+```redscript
+fn new(duration: int) -> Timer
+```
+
+---
+
+## `Timer.start`
+
+Start or resume the timer.
+
+```redscript
+fn start(self)
+```
+
+---
+
+## `Timer.pause`
+
+Pause the timer.
+
+```redscript
+fn pause(self)
+```
+
+---
+
+## `Timer.reset`
+
+Reset elapsed ticks back to zero.
+
+```redscript
+fn reset(self)
+```
+
+---
+
+## `Timer.done`
+
+Check whether the timer has reached its duration.
+
+```redscript
+fn done(self) -> bool
+```
+
+---
+
+## `Timer.elapsed`
+
+Get elapsed ticks.
+
+```redscript
+fn elapsed(self) -> int
+```
+
+---
+
+## `Timer.remaining`
+
+Get remaining ticks, clamped at zero.
+
+```redscript
+fn remaining(self) -> int
+```
+
+---
+
+## `Timer.tick`
+
+Manually advance the timer by one tick when active.
+
+```redscript
+fn tick(self)
+```
+
+---
+
+## `tick_to_seconds` <Badge type="info" text="v1.0.0" />
+
+Convert Minecraft ticks to whole seconds (20 ticks = 1 second).
+
+```redscript
+fn tick_to_seconds(ticks: int): int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `ticks` | Elapsed ticks |
+
+**Returns:** ticks / 20
+
+**Example**
+
+```redscript
+let s = tick_to_seconds(100)  // result: 5
+```
+
+---
+
+## `tick_to_ms` <Badge type="info" text="v1.0.0" />
+
+Convert Minecraft ticks to milliseconds (1 tick = 50 ms).
+
+```redscript
+fn tick_to_ms(ticks: int): int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `ticks` | Elapsed ticks |
+
+**Returns:** ticks * 50
+
+**Example**
+
+```redscript
+let ms = tick_to_ms(20)  // result: 1000
+```
+
+---
+
+## `seconds_to_ticks` <Badge type="info" text="v1.0.0" />
+
+Convert seconds to Minecraft ticks (1 second = 20 ticks).
+
+```redscript
+fn seconds_to_ticks(s: int): int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `s` | Seconds |
+
+**Returns:** s * 20
+
+**Example**
+
+```redscript
+let t = seconds_to_ticks(5)  // result: 100
+```
+
+---
+
+## `format_time_s` <Badge type="info" text="v1.0.0" />
+
+Extract seconds component from a tick count (0-59).
+
+```redscript
+fn format_time_s(ticks: int): int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `ticks` | Elapsed ticks |
+
+**Returns:** (ticks / 20) % 60
+
+**Example**
+
+```redscript
+let s = format_time_s(1500)  // result: 15  (75 seconds mod 60)
+```
+
+---
+
+## `format_time_m` <Badge type="info" text="v1.0.0" />
+
+Extract minutes component from a tick count (0-59).
+
+```redscript
+fn format_time_m(ticks: int): int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `ticks` | Elapsed ticks |
+
+**Returns:** (ticks / 1200) % 60
+
+**Example**
+
+```redscript
+let m = format_time_m(72000)  // result: 0  (1 hour)
+```
+
+---
+
+## `format_time_h` <Badge type="info" text="v1.0.0" />
+
+Extract hours component from a tick count.
+
+```redscript
+fn format_time_h(ticks: int): int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `ticks` | Elapsed ticks |
+
+**Returns:** ticks / 72000
+
+**Example**
+
+```redscript
+let h = format_time_h(144000)  // result: 2
+```
+
+---

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

@@ -0,0 +1,158 @@
+# Vec
+
+> Auto-generated from `src/stdlib/vec.mcrs` — do not edit manually.
+
+## 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" />
+
+Dot product of two 2D integer vectors.
+
+```redscript
+fn dot2d(ax: int, ay: int, bx: int, by: int) -> int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `ax` | X component of vector A |
+| `ay` | Y component of vector A |
+| `bx` | X component of vector B |
+| `by` | Y component of vector B |
+
+**Returns:** ax*bx + ay*by
+
+**Example**
+
+```redscript
+let d = dot2d(3, 4, 3, 4)  // result: 25
+```
+
+---
+
+## `length2d_fixed` <Badge type="info" text="v1.0.0" />
+
+Euclidean length of a 2D vector, returned as ×1000 fixed-point.
+
+```redscript
+fn length2d_fixed(x: int, y: int) -> int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `x` | X component (raw integer; keep |x|,|y| ≤ ~1000 to avoid overflow) |
+| `y` | Y component |
+
+**Returns:** sqrt(x²+y²) × 1000
+
+**Example**
+
+```redscript
+let l = length2d_fixed(3, 4)  // result: 5000
+```
+
+---
+
+## `dot3d` <Badge type="info" text="v1.0.0" />
+
+Dot product of two 3D integer vectors.
+
+```redscript
+fn dot3d(ax: int, ay: int, az: int, bx: int, by: int, bz: int) -> int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `ax` | X component of vector A |
+| `ay` | Y component of vector A |
+| `az` | Z component of vector A |
+| `bx` | X component of vector B |
+| `by` | Y component of vector B |
+| `bz` | Z component of vector B |
+
+**Returns:** ax*bx + ay*by + az*bz
+
+**Example**
+
+```redscript
+let d = dot3d(1, 0, 0, 1, 0, 0)  // result: 1
+```
+
+---
+
+## `cross3d_x` <Badge type="info" text="v1.0.0" />
+
+X component of the cross product A×B (ay*bz − az*by).
+
+```redscript
+fn cross3d_x(ax: int, ay: int, az: int, bx: int, by: int, bz: int) -> int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `ax` | X of A  @param ay  Y of A  @param az  Z of A |
+| `bx` | X of B  @param by  Y of B  @param bz  Z of B |
+
+**Returns:** ay*bz - az*by
+
+---
+
+## `cross3d_y` <Badge type="info" text="v1.0.0" />
+
+Y component of the cross product A×B (az*bx − ax*bz).
+
+```redscript
+fn cross3d_y(ax: int, ay: int, az: int, bx: int, by: int, bz: int) -> int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `ax` | X of A  @param ay  Y of A  @param az  Z of A |
+| `bx` | X of B  @param by  Y of B  @param bz  Z of B |
+
+**Returns:** az*bx - ax*bz
+
+---
+
+## `cross3d_z` <Badge type="info" text="v1.0.0" />
+
+Z component of the cross product A×B (ax*by − ay*bx).
+
+```redscript
+fn cross3d_z(ax: int, ay: int, az: int, bx: int, by: int, bz: int) -> int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `ax` | X of A  @param ay  Y of A  @param az  Z of A |
+| `bx` | X of B  @param by  Y of B  @param bz  Z of B |
+
+**Returns:** ax*by - ay*bx
+
+**Example**
+
+```redscript
+let z = cross3d_z(1, 0, 0, 0, 1, 0)  // result: 1
+```
+
+---