redscript-mc 3.0.1 → 3.0.2

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

@@ -0,0 +1,324 @@
+# Effects
+
+> Auto-generated from `src/stdlib/effects.mcrs` — do not edit manually.
+
+## API
+
+- [speed](#speed)
+- [jump](#jump)
+- [regen](#regen)
+- [resistance](#resistance)
+- [strength](#strength)
+- [invisible](#invisible)
+- [night_vision](#night-vision)
+- [slow_fall](#slow-fall)
+- [glow](#glow)
+- [clear_effects](#clear-effects)
+- [clear_effect](#clear-effect)
+- [buff_all](#buff-all)
+
+---
+
+## `speed` <Badge type="info" text="v1.0.0" />
+
+Give a speed boost to the target entity.
+
+```redscript
+fn speed(target: selector, duration: int, level: int)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Entity selector (e.g. @p, @a, @e[...]) |
+| `duration` | Effect duration in ticks (20 ticks = 1 second) |
+| `level` | Amplifier level (0 = Speed I, 1 = Speed II, ...) |
+
+**Returns:** void — applies minecraft:speed effect
+
+**Example**
+
+```redscript
+speed(@p, 200, 1)  // Speed II for 10 seconds
+```
+
+---
+
+## `jump` <Badge type="info" text="v1.0.0" />
+
+Give a jump boost to the target entity.
+
+```redscript
+fn jump(target: selector, duration: int, level: int)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Entity selector |
+| `duration` | Effect duration in ticks |
+| `level` | Amplifier level (0 = Jump Boost I, 1 = Jump Boost II, ...) |
+
+**Returns:** void — applies minecraft:jump_boost effect
+
+**Example**
+
+```redscript
+jump(@p, 100, 0)  // Jump Boost I for 5 seconds
+```
+
+---
+
+## `regen` <Badge type="info" text="v1.0.0" />
+
+Give regeneration to the target entity.
+
+```redscript
+fn regen(target: selector, duration: int, level: int)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Entity selector |
+| `duration` | Effect duration in ticks |
+| `level` | Amplifier level (0 = Regeneration I, ...) |
+
+**Returns:** void — applies minecraft:regeneration effect
+
+**Example**
+
+```redscript
+regen(@p, 60, 0)  // Regeneration I for 3 seconds
+```
+
+---
+
+## `resistance` <Badge type="info" text="v1.0.0" />
+
+Give damage resistance to the target entity.
+
+```redscript
+fn resistance(target: selector, duration: int, level: int)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Entity selector |
+| `duration` | Effect duration in ticks |
+| `level` | Amplifier level (0 = Resistance I, ...) |
+
+**Returns:** void — applies minecraft:resistance effect
+
+**Example**
+
+```redscript
+resistance(@p, 400, 0)  // Resistance I for 20 seconds
+```
+
+---
+
+## `strength` <Badge type="info" text="v1.0.0" />
+
+Give strength to the target entity.
+
+```redscript
+fn strength(target: selector, duration: int, level: int)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Entity selector |
+| `duration` | Effect duration in ticks |
+| `level` | Amplifier level (0 = Strength I, 1 = Strength II, ...) |
+
+**Returns:** void — applies minecraft:strength effect
+
+**Example**
+
+```redscript
+strength(@p, 200, 1)  // Strength II for 10 seconds
+```
+
+---
+
+## `invisible` <Badge type="info" text="v1.0.0" />
+
+Make the target entity invisible.
+
+```redscript
+fn invisible(target: selector, duration: int)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Entity selector |
+| `duration` | Effect duration in ticks |
+
+**Returns:** void — applies minecraft:invisibility at amplifier 0
+
+**Example**
+
+```redscript
+invisible(@p, 300)  // invisibility for 15 seconds
+```
+
+---
+
+## `night_vision` <Badge type="info" text="v1.0.0" />
+
+Give night vision to the target entity.
+
+```redscript
+fn night_vision(target: selector, duration: int)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Entity selector |
+| `duration` | Effect duration in ticks |
+
+**Returns:** void — applies minecraft:night_vision at amplifier 0
+
+**Example**
+
+```redscript
+night_vision(@p, 6000)  // night vision for 5 minutes
+```
+
+---
+
+## `slow_fall` <Badge type="info" text="v1.0.0" />
+
+Give slow falling to the target entity.
+
+```redscript
+fn slow_fall(target: selector, duration: int)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Entity selector |
+| `duration` | Effect duration in ticks |
+
+**Returns:** void — applies minecraft:slow_falling at amplifier 0
+
+**Example**
+
+```redscript
+slow_fall(@p, 200)  // slow falling for 10 seconds
+```
+
+---
+
+## `glow` <Badge type="info" text="v1.0.0" />
+
+Give the glowing outline effect to the target entity.
+
+```redscript
+fn glow(target: selector, duration: int)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Entity selector |
+| `duration` | Effect duration in ticks |
+
+**Returns:** void — applies minecraft:glowing at amplifier 0
+
+**Example**
+
+```redscript
+glow(@e[type=zombie], 100)  // make all zombies glow for 5 seconds
+```
+
+---
+
+## `clear_effects` <Badge type="info" text="v1.0.0" />
+
+Clear all active effects from the target entity.
+
+```redscript
+fn clear_effects(target: selector)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Entity selector |
+
+**Returns:** void — removes all potion effects via effect_clear
+
+**Example**
+
+```redscript
+clear_effects(@p)  // remove all effects from nearest player
+```
+
+---
+
+## `clear_effect` <Badge type="info" text="v1.0.0" />
+
+Clear a specific effect from the target entity.
+
+```redscript
+fn clear_effect(target: selector, eff: string)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Entity selector |
+| `eff` | Effect resource location string (e.g. "minecraft:speed") |
+
+**Returns:** void — removes the specified potion effect
+
+**Example**
+
+```redscript
+clear_effect(@p, "minecraft:poison")  // cure poison
+```
+
+---
+
+## `buff_all` <Badge type="info" text="v1.0.0" />
+
+Apply a full buff package (Speed I, Strength I, Regeneration I, Resistance I).
+
+```redscript
+fn buff_all(target: selector, duration: int)
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `target` | Entity selector |
+| `duration` | Duration in ticks for all four effects |
+
+**Returns:** void — applies speed, strength, regen, and resistance at level 1 (or 0 for resistance)
+
+**Example**
+
+```redscript
+buff_all(@p, 600)  // full buff for 30 seconds
+```
+
+---

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

@@ -0,0 +1,3 @@
+# Events
+
+> Auto-generated from `src/stdlib/events.mcrs` — do not edit manually.

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

@@ -0,0 +1,45 @@
+# Expr
+
+> Auto-generated from `src/stdlib/expr.mcrs` — do not edit manually.
+
+## API
+
+- [expr_eval](#expr-eval)
+
+---
+
+## `expr_eval` <Badge type="info" text="v1.2.0" />
+
+Evaluate an RPN (Reverse Polish Notation) token stream with a single variable substitution.
+
+Token encoding (all values × 10000):
+- Positive integer: literal value pushed onto the stack
+- `-10000`: variable `x` (replaced by the `x` argument)
+- `-1` ADD, `-2` SUB, `-3` MUL (fixed-point), `-4` DIV (fixed-point)
+- `-5` SIN (degrees × 10000 → result × 10000), `-6` COS, `-7` SQRT, `-8` ABS
+
+Internal stack depth: 16 elements. Behaviour is undefined for malformed token streams.
+
+```redscript
+fn expr_eval(tokens: int[], n: int, x: int): int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `tokens` | RPN token array of length n |
+| `n` | Number of tokens |
+| `x` | Variable value × 10000 substituted for token `-10000` |
+
+**Returns:** Top-of-stack value × 10000 after evaluating all tokens
+
+**Example**
+
+```redscript
+// 2*x + 1  →  RPN: [20000, -10000, -3, 10000, -1]
+let prog: int[] = [20000, -10000, -3, 10000, -1];
+expr_eval(prog, 5, 15000); // 40000  (2×1.5 + 1 = 4.0)
+```
+
+---

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

@@ -0,0 +1,141 @@
+# Fft
+
+> Auto-generated from `src/stdlib/fft.mcrs` — do not edit manually.
+
+## API
+
+- [dft_noop](#dft-noop)
+- [dft_real](#dft-real)
+- [dft_magnitude](#dft-magnitude)
+- [dft_power](#dft-power)
+- [dft_freq_bin](#dft-freq-bin)
+
+---
+
+## `dft_noop` <Badge type="info" text="v2.0.0" />
+
+Default no-op completion callback for `dft_coro`. Does nothing.
+
+```redscript
+fn dft_noop(): void
+```
+
+---
+
+## `dft_real` <Badge type="info" text="v2.0.0" />
+
+Compute the Discrete Fourier Transform of `input[0..n-1]`.
+
+Output arrays must be pre-allocated to length `n` and filled with zeros
+before calling.
+
+Formula: `X[k] = Σ x[j] * (cos(2πkj/n) - i·sin(2πkj/n))`
+
+```redscript
+fn dft_real(input: int[], n: int, out_re: int[], out_im: int[])
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `input` | Signal samples in fixed-point ×10000 |
+| `n` | Number of samples (≤ 16 recommended) |
+| `out_re` | Pre-allocated output array for real parts (×10000) |
+| `out_im` | Pre-allocated output array for imaginary parts (×10000) |
+
+**Example**
+
+```redscript
+let re: int[] = [0, 0, 0, 0]
+let im: int[] = [0, 0, 0, 0]
+dft_real(sig, 4, re, im)
+```
+
+---
+
+## `dft_magnitude` <Badge type="info" text="v2.0.0" />
+
+Return the magnitude of DFT bin `k`: `|X[k]| = sqrt(re[k]² + im[k]²)` in ×10000.
+
+Note: squaring ×10000 values can reach ~10⁹ per term, which fits in int32 for
+amplitudes ≤ ~46340. For larger amplitudes, scale the input before calling.
+
+```redscript
+fn dft_magnitude(re: int[], im: int[], k: int): int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `re` | Real output array from `dft_real` |
+| `im` | Imaginary output array from `dft_real` |
+| `k` | Bin index |
+
+**Returns:** Magnitude of bin `k` in ×10000 fixed-point
+
+**Example**
+
+```redscript
+let mag: int = dft_magnitude(re, im, 1)
+```
+
+---
+
+## `dft_power` <Badge type="info" text="v2.0.0" />
+
+Return the power spectrum value for bin `k`: `re[k]²/10000 + im[k]²/10000`.
+
+Division by 10000 prevents int32 overflow for values up to ~46340 (×10000).
+The result is in ×10000 scale (power units).
+
+```redscript
+fn dft_power(re: int[], im: int[], k: int): int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `re` | Real output array from `dft_real` |
+| `im` | Imaginary output array from `dft_real` |
+| `k` | Bin index |
+
+**Returns:** Power of bin `k` in ×10000 units
+
+**Example**
+
+```redscript
+let power: int = dft_power(re, im, 2)
+```
+
+---
+
+## `dft_freq_bin` <Badge type="info" text="v2.0.0" />
+
+Return the frequency (Hz) corresponding to DFT bin `k`.
+
+Formula: `freq = sample_rate_hz * k / n`
+
+```redscript
+fn dft_freq_bin(sample_rate_hz: int, n: int, k: int): int
+```
+
+**Parameters**
+
+| Parameter | Description |
+|-----------|-------------|
+| `sample_rate_hz` | Sampling rate in Hz (e.g. `20` for Minecraft tick rate) |
+| `n` | Transform size (number of samples) |
+| `k` | Bin index in range [0, n-1] |
+
+**Returns:** Frequency in Hz for bin `k`
+
+**Example**
+
+```redscript
+let freq: int = dft_freq_bin(20, 8, 3)
+```
+
+---