@dnd-ed/jsshenanigans 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +98 -98
- package/package.json +4 -1
- package/src/character.d.ts +82 -82
- package/src/codec.d.ts +20 -20
- package/src/conditions.d.ts +40 -40
- package/src/defaults.d.ts +15 -15
- package/src/errors.d.ts +8 -8
- package/src/index.d.ts +46 -46
- package/src/index.js +49 -49
- package/src/nodes.d.ts +356 -356
- package/src/tools.d.ts +28 -28
- package/src/types.d.ts +875 -875
- package/src/types.js +3532 -3532
- package/src/utils.d.ts +33 -33
package/README.md
CHANGED
|
@@ -1,98 +1,98 @@
|
|
|
1
|
-
<div align="center">
|
|
2
|
-
<img src="https://raw.githubusercontent.com/dnd-ed/jsshenanigans/refs/heads/main/assets/jss_logo.png" alt="jsslogo" width="700" />
|
|
3
|
-
<br />
|
|
4
|
-
<em>the ssssnakiest way to build jjs movesets</em>
|
|
5
|
-
</div>
|
|
6
|
-
|
|
7
|
-

|
|
8
|
-
|
|
9
|
-
> [!IMPORTANT]
|
|
10
|
-
> This library is a JavaScript port of [PythonShenanigans](https://github.com/dnd-ed/pythonshenanigans),
|
|
11
|
-
> which is itself inspired by [FormunaGit/libjjs](https://github.com/FormunaGit/libjjs).
|
|
12
|
-
> When publishing code that uses this library, please credit
|
|
13
|
-
> *"itzdanti and JSShenanigans contributors (jsshenanigans, https://github.com/dnd-ed/jsshenanigans)"*,
|
|
14
|
-
> *"itzdanti and PythonShenanigans contributors (pythonshenanigans, https://github.com/dnd-ed/pythonshenanigans)"*,
|
|
15
|
-
> and *"Formuna (libjjs, https://github.com/FormunaGit/libjjs)"*.
|
|
16
|
-
|
|
17
|
-
## How?
|
|
18
|
-
|
|
19
|
-
<details>
|
|
20
|
-
<summary>TL;DR, character codes are generated by compressing JSON through zstd and base64-encoding it.</summary>
|
|
21
|
-
|
|
22
|
-
The way character codes are generated is by taking the original JSON and
|
|
23
|
-
compressing it through [zstd](https://github.com/facebook/zstd) and then
|
|
24
|
-
base64-encoding it. This is very easy to reverse, and can be used to create
|
|
25
|
-
custom movesets externally without the need for Roblox or JJS.
|
|
26
|
-
|
|
27
|
-
Decoding a code with base64 and zstd gives the original JSON. From there, a
|
|
28
|
-
script can modify the JSON to create a custom moveset.
|
|
29
|
-
</details>
|
|
30
|
-
|
|
31
|
-
## Usage
|
|
32
|
-
|
|
33
|
-
First, install the library using `npm install @dnd-ed/jsshenanigans`.
|
|
34
|
-
|
|
35
|
-
Then, in a JavaScript file, import the library as `jss` and create a character:
|
|
36
|
-
|
|
37
|
-
```js
|
|
38
|
-
import * as jss from "@dnd-ed/jsshenanigans";
|
|
39
|
-
|
|
40
|
-
const character = new jss.Character();
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
From here, you can create skills using `character.create.skill()`.
|
|
44
|
-
|
|
45
|
-
```js
|
|
46
|
-
character.create.skill("Super Cool Skill", { cooldown: 5 });
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
Nodes live in their own module, so import them too:
|
|
50
|
-
|
|
51
|
-
```js
|
|
52
|
-
import * as nodes from "@dnd-ed/jsshenanigans/nodes";
|
|
53
|
-
|
|
54
|
-
character.create.skill("Punch", [nodes.HITBOX({ damage: 5 })]);
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
Check out `demo/demo.js` for a full example.
|
|
58
|
-
|
|
59
|
-
## TypeScript
|
|
60
|
-
|
|
61
|
-
The library ships type declarations, so TypeScript and editors with a language
|
|
62
|
-
server get full autocomplete for every builder.
|
|
63
|
-
|
|
64
|
-
## Features
|
|
65
|
-
|
|
66
|
-
- [x] Support for every documented node, condition and property, including
|
|
67
|
-
`PARTICLE`, `LOOK` and `SETMELEE`
|
|
68
|
-
- [x] Support for all skill types
|
|
69
|
-
- [x] Exports as a JJS-valid character code
|
|
70
|
-
- I recommend you paste it into JJS to check if it's working, then copy the character block's export
|
|
71
|
-
- [x] Branch support
|
|
72
|
-
- [x] Variable names for animations, easing styles/directions, effects, etc
|
|
73
|
-
- [ ] Custom nodes
|
|
74
|
-
- [ ] Domain node
|
|
75
|
-
- [ ] Fake rigs
|
|
76
|
-
- [ ] Fake rig animations
|
|
77
|
-
|
|
78
|
-
## Requirements
|
|
79
|
-
|
|
80
|
-
Node.js **22.15+** (it ships `zstd` in `node:zlib`). No required runtime
|
|
81
|
-
dependencies.
|
|
82
|
-
|
|
83
|
-
## zstd backends
|
|
84
|
-
|
|
85
|
-
The codec picks a backend automatically:
|
|
86
|
-
|
|
87
|
-
1. `node:zlib` --- the default, native, and the only one that can compress.
|
|
88
|
-
2. [`fzstd`](https://www.npmjs.com/package/fzstd) --- an optional, pure-JS
|
|
89
|
-
fallback. It can only *decompress*, so it is used for reading codes when
|
|
90
|
-
`node:zlib` is unavailable.
|
|
91
|
-
|
|
92
|
-
Set `JSSHENANIGANS_ZSTD_BACKEND` (e.g. to `"fzstd"`) to prefer a specific one.
|
|
93
|
-
Run `npm run bench` to compare the installed backends; `node:zlib` is several
|
|
94
|
-
times faster, which is why it stays the default.
|
|
95
|
-
|
|
96
|
-
## License
|
|
97
|
-
|
|
98
|
-
MIT. See `LICENSE` and `NOTICE.md`.
|
|
1
|
+
<div align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/dnd-ed/jsshenanigans/refs/heads/main/assets/jss_logo.png" alt="jsslogo" width="700" />
|
|
3
|
+
<br />
|
|
4
|
+
<em>the ssssnakiest way to build jjs movesets</em>
|
|
5
|
+
</div>
|
|
6
|
+
|
|
7
|
+

|
|
8
|
+
|
|
9
|
+
> [!IMPORTANT]
|
|
10
|
+
> This library is a JavaScript port of [PythonShenanigans](https://github.com/dnd-ed/pythonshenanigans),
|
|
11
|
+
> which is itself inspired by [FormunaGit/libjjs](https://github.com/FormunaGit/libjjs).
|
|
12
|
+
> When publishing code that uses this library, please credit
|
|
13
|
+
> *"itzdanti and JSShenanigans contributors (jsshenanigans, https://github.com/dnd-ed/jsshenanigans)"*,
|
|
14
|
+
> *"itzdanti and PythonShenanigans contributors (pythonshenanigans, https://github.com/dnd-ed/pythonshenanigans)"*,
|
|
15
|
+
> and *"Formuna (libjjs, https://github.com/FormunaGit/libjjs)"*.
|
|
16
|
+
|
|
17
|
+
## How?
|
|
18
|
+
|
|
19
|
+
<details>
|
|
20
|
+
<summary>TL;DR, character codes are generated by compressing JSON through zstd and base64-encoding it.</summary>
|
|
21
|
+
|
|
22
|
+
The way character codes are generated is by taking the original JSON and
|
|
23
|
+
compressing it through [zstd](https://github.com/facebook/zstd) and then
|
|
24
|
+
base64-encoding it. This is very easy to reverse, and can be used to create
|
|
25
|
+
custom movesets externally without the need for Roblox or JJS.
|
|
26
|
+
|
|
27
|
+
Decoding a code with base64 and zstd gives the original JSON. From there, a
|
|
28
|
+
script can modify the JSON to create a custom moveset.
|
|
29
|
+
</details>
|
|
30
|
+
|
|
31
|
+
## Usage
|
|
32
|
+
|
|
33
|
+
First, install the library using `npm install @dnd-ed/jsshenanigans`.
|
|
34
|
+
|
|
35
|
+
Then, in a JavaScript file, import the library as `jss` and create a character:
|
|
36
|
+
|
|
37
|
+
```js
|
|
38
|
+
import * as jss from "@dnd-ed/jsshenanigans";
|
|
39
|
+
|
|
40
|
+
const character = new jss.Character();
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
From here, you can create skills using `character.create.skill()`.
|
|
44
|
+
|
|
45
|
+
```js
|
|
46
|
+
character.create.skill("Super Cool Skill", { cooldown: 5 });
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Nodes live in their own module, so import them too:
|
|
50
|
+
|
|
51
|
+
```js
|
|
52
|
+
import * as nodes from "@dnd-ed/jsshenanigans/nodes";
|
|
53
|
+
|
|
54
|
+
character.create.skill("Punch", [nodes.HITBOX({ damage: 5 })]);
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Check out `demo/demo.js` for a full example.
|
|
58
|
+
|
|
59
|
+
## TypeScript
|
|
60
|
+
|
|
61
|
+
The library ships type declarations, so TypeScript and editors with a language
|
|
62
|
+
server get full autocomplete for every builder.
|
|
63
|
+
|
|
64
|
+
## Features
|
|
65
|
+
|
|
66
|
+
- [x] Support for every documented node, condition and property, including
|
|
67
|
+
`PARTICLE`, `LOOK` and `SETMELEE`
|
|
68
|
+
- [x] Support for all skill types
|
|
69
|
+
- [x] Exports as a JJS-valid character code
|
|
70
|
+
- I recommend you paste it into JJS to check if it's working, then copy the character block's export
|
|
71
|
+
- [x] Branch support
|
|
72
|
+
- [x] Variable names for animations, easing styles/directions, effects, etc
|
|
73
|
+
- [ ] Custom nodes
|
|
74
|
+
- [ ] Domain node
|
|
75
|
+
- [ ] Fake rigs
|
|
76
|
+
- [ ] Fake rig animations
|
|
77
|
+
|
|
78
|
+
## Requirements
|
|
79
|
+
|
|
80
|
+
Node.js **22.15+** (it ships `zstd` in `node:zlib`). No required runtime
|
|
81
|
+
dependencies.
|
|
82
|
+
|
|
83
|
+
## zstd backends
|
|
84
|
+
|
|
85
|
+
The codec picks a backend automatically:
|
|
86
|
+
|
|
87
|
+
1. `node:zlib` --- the default, native, and the only one that can compress.
|
|
88
|
+
2. [`fzstd`](https://www.npmjs.com/package/fzstd) --- an optional, pure-JS
|
|
89
|
+
fallback. It can only *decompress*, so it is used for reading codes when
|
|
90
|
+
`node:zlib` is unavailable.
|
|
91
|
+
|
|
92
|
+
Set `JSSHENANIGANS_ZSTD_BACKEND` (e.g. to `"fzstd"`) to prefer a specific one.
|
|
93
|
+
Run `npm run bench` to compare the installed backends; `node:zlib` is several
|
|
94
|
+
times faster, which is why it stays the default.
|
|
95
|
+
|
|
96
|
+
## License
|
|
97
|
+
|
|
98
|
+
MIT. See `LICENSE` and `NOTICE.md`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dnd-ed/jsshenanigans",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"description": "A JavaScript library for creating, loading and modifying Jujutsu Shenanigans movesets.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"jujutsu",
|
|
@@ -94,6 +94,9 @@
|
|
|
94
94
|
"optionalDependencies": {
|
|
95
95
|
"fzstd": "^0.1.1"
|
|
96
96
|
},
|
|
97
|
+
"publishConfig": {
|
|
98
|
+
"access": "public"
|
|
99
|
+
},
|
|
97
100
|
"repository": {
|
|
98
101
|
"type": "git",
|
|
99
102
|
"url": "git+https://github.com/dnd-ed/jsshenanigans.git"
|
package/src/character.d.ts
CHANGED
|
@@ -1,82 +1,82 @@
|
|
|
1
|
-
import type { Node } from "./nodes.js";
|
|
2
|
-
import type { BranchDefinition } from "./utils.js";
|
|
3
|
-
|
|
4
|
-
export type SkillKind = "SKILL" | "SPECIAL" | "MELEE" | "CHASE" | "AWAKENING";
|
|
5
|
-
|
|
6
|
-
export interface Skill {
|
|
7
|
-
NAME?: string;
|
|
8
|
-
K_NAME?: string;
|
|
9
|
-
KEY?: number;
|
|
10
|
-
DATA?: string;
|
|
11
|
-
[key: string]: unknown;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
export interface SkillOptions {
|
|
15
|
-
/** The skill's node list (also accepted as the second positional argument). */
|
|
16
|
-
line?: Node[];
|
|
17
|
-
kind?: SkillKind;
|
|
18
|
-
cooldown?: number | null;
|
|
19
|
-
key?: number | null;
|
|
20
|
-
add?: boolean;
|
|
21
|
-
duration?: number | null;
|
|
22
|
-
delay?: number | null;
|
|
23
|
-
properties?: Record<string, number | boolean | string> | null;
|
|
24
|
-
conditions?: Array<Record<string, unknown>> | null;
|
|
25
|
-
branches?: Record<string, BranchDefinition> | null;
|
|
26
|
-
tooltip?: string | null;
|
|
27
|
-
color?: string | null;
|
|
28
|
-
extra?: Record<string, unknown> | null;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
export interface SkillSummary {
|
|
32
|
-
kind: string | undefined;
|
|
33
|
-
name: string | undefined;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
export interface CharacterOptions {
|
|
37
|
-
hide_character_extras?: boolean;
|
|
38
|
-
raw?: unknown[] | null;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
export declare class CreateHelper {
|
|
42
|
-
character: Character;
|
|
43
|
-
/** Create a skill, with the node list as the second argument. */
|
|
44
|
-
skill(name: string, line?: Node[], options?: SkillOptions): void;
|
|
45
|
-
/** Create a skill, with the node list inside `options.line`. */
|
|
46
|
-
skill(name: string, options?: SkillOptions): void;
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
export declare class Character {
|
|
50
|
-
raw: Skill[];
|
|
51
|
-
create: CreateHelper;
|
|
52
|
-
|
|
53
|
-
constructor(options?: CharacterOptions);
|
|
54
|
-
|
|
55
|
-
/** Load a character from a JJS character code. Fields are kept verbatim. */
|
|
56
|
-
static from_code(code: string): Character;
|
|
57
|
-
|
|
58
|
-
/** Load a character from a raw JSON string (the inner a code holds). */
|
|
59
|
-
static from_raw(rawJson: string): Character;
|
|
60
|
-
|
|
61
|
-
/** Append a raw skill object, checked shallowly. */
|
|
62
|
-
create_raw_skill(skill: Skill): void;
|
|
63
|
-
|
|
64
|
-
/** Export the character as a raw JSON string. */
|
|
65
|
-
export_raw(): string;
|
|
66
|
-
|
|
67
|
-
/** Export the character as a JJS-compatible character code. */
|
|
68
|
-
export_character_code(): string;
|
|
69
|
-
|
|
70
|
-
/** Alias for `export_character_code`. */
|
|
71
|
-
to_code(): string;
|
|
72
|
-
|
|
73
|
-
get length(): number;
|
|
74
|
-
|
|
75
|
-
[Symbol.iterator](): IterableIterator<Skill>;
|
|
76
|
-
|
|
77
|
-
/** A list of `{ kind, name }` for every entry, in order. */
|
|
78
|
-
get skills(): SkillSummary[];
|
|
79
|
-
|
|
80
|
-
_used_keys(): Set<number>;
|
|
81
|
-
_next_key(): number;
|
|
82
|
-
}
|
|
1
|
+
import type { Node } from "./nodes.js";
|
|
2
|
+
import type { BranchDefinition } from "./utils.js";
|
|
3
|
+
|
|
4
|
+
export type SkillKind = "SKILL" | "SPECIAL" | "MELEE" | "CHASE" | "AWAKENING";
|
|
5
|
+
|
|
6
|
+
export interface Skill {
|
|
7
|
+
NAME?: string;
|
|
8
|
+
K_NAME?: string;
|
|
9
|
+
KEY?: number;
|
|
10
|
+
DATA?: string;
|
|
11
|
+
[key: string]: unknown;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export interface SkillOptions {
|
|
15
|
+
/** The skill's node list (also accepted as the second positional argument). */
|
|
16
|
+
line?: Node[];
|
|
17
|
+
kind?: SkillKind;
|
|
18
|
+
cooldown?: number | null;
|
|
19
|
+
key?: number | null;
|
|
20
|
+
add?: boolean;
|
|
21
|
+
duration?: number | null;
|
|
22
|
+
delay?: number | null;
|
|
23
|
+
properties?: Record<string, number | boolean | string> | null;
|
|
24
|
+
conditions?: Array<Record<string, unknown>> | null;
|
|
25
|
+
branches?: Record<string, BranchDefinition> | null;
|
|
26
|
+
tooltip?: string | null;
|
|
27
|
+
color?: string | null;
|
|
28
|
+
extra?: Record<string, unknown> | null;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export interface SkillSummary {
|
|
32
|
+
kind: string | undefined;
|
|
33
|
+
name: string | undefined;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export interface CharacterOptions {
|
|
37
|
+
hide_character_extras?: boolean;
|
|
38
|
+
raw?: unknown[] | null;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
export declare class CreateHelper {
|
|
42
|
+
character: Character;
|
|
43
|
+
/** Create a skill, with the node list as the second argument. */
|
|
44
|
+
skill(name: string, line?: Node[], options?: SkillOptions): void;
|
|
45
|
+
/** Create a skill, with the node list inside `options.line`. */
|
|
46
|
+
skill(name: string, options?: SkillOptions): void;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export declare class Character {
|
|
50
|
+
raw: Skill[];
|
|
51
|
+
create: CreateHelper;
|
|
52
|
+
|
|
53
|
+
constructor(options?: CharacterOptions);
|
|
54
|
+
|
|
55
|
+
/** Load a character from a JJS character code. Fields are kept verbatim. */
|
|
56
|
+
static from_code(code: string): Character;
|
|
57
|
+
|
|
58
|
+
/** Load a character from a raw JSON string (the inner a code holds). */
|
|
59
|
+
static from_raw(rawJson: string): Character;
|
|
60
|
+
|
|
61
|
+
/** Append a raw skill object, checked shallowly. */
|
|
62
|
+
create_raw_skill(skill: Skill): void;
|
|
63
|
+
|
|
64
|
+
/** Export the character as a raw JSON string. */
|
|
65
|
+
export_raw(): string;
|
|
66
|
+
|
|
67
|
+
/** Export the character as a JJS-compatible character code. */
|
|
68
|
+
export_character_code(): string;
|
|
69
|
+
|
|
70
|
+
/** Alias for `export_character_code`. */
|
|
71
|
+
to_code(): string;
|
|
72
|
+
|
|
73
|
+
get length(): number;
|
|
74
|
+
|
|
75
|
+
[Symbol.iterator](): IterableIterator<Skill>;
|
|
76
|
+
|
|
77
|
+
/** A list of `{ kind, name }` for every entry, in order. */
|
|
78
|
+
get skills(): SkillSummary[];
|
|
79
|
+
|
|
80
|
+
_used_keys(): Set<number>;
|
|
81
|
+
_next_key(): number;
|
|
82
|
+
}
|
package/src/codec.d.ts
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
/** Every zstd frame begins with these four bytes. */
|
|
2
|
-
export declare const ZSTD_MAGIC: Uint8Array;
|
|
3
|
-
|
|
4
|
-
/** Environment variable used to prefer a specific zstd backend. */
|
|
5
|
-
export declare const ENV_BACKEND: string;
|
|
6
|
-
|
|
7
|
-
/** Return the name of the zstd implementation currently in use. */
|
|
8
|
-
export declare function backend_name(): string;
|
|
9
|
-
|
|
10
|
-
/** zstd-compress a JSON string and base64-encode the result. */
|
|
11
|
-
export declare function compress(rawJson: string): string;
|
|
12
|
-
|
|
13
|
-
/** Base64-decode `code` and zstd-decompress it back into a JSON string. */
|
|
14
|
-
export declare function decompress(code: string): string;
|
|
15
|
-
|
|
16
|
-
/** Serialise a character payload (an array of skills) into a character code. */
|
|
17
|
-
export declare function encode(payload: unknown): string;
|
|
18
|
-
|
|
19
|
-
/** Decode a character code back into JavaScript objects. */
|
|
20
|
-
export declare function decode(code: string): unknown;
|
|
1
|
+
/** Every zstd frame begins with these four bytes. */
|
|
2
|
+
export declare const ZSTD_MAGIC: Uint8Array;
|
|
3
|
+
|
|
4
|
+
/** Environment variable used to prefer a specific zstd backend. */
|
|
5
|
+
export declare const ENV_BACKEND: string;
|
|
6
|
+
|
|
7
|
+
/** Return the name of the zstd implementation currently in use. */
|
|
8
|
+
export declare function backend_name(): string;
|
|
9
|
+
|
|
10
|
+
/** zstd-compress a JSON string and base64-encode the result. */
|
|
11
|
+
export declare function compress(rawJson: string): string;
|
|
12
|
+
|
|
13
|
+
/** Base64-decode `code` and zstd-decompress it back into a JSON string. */
|
|
14
|
+
export declare function decompress(code: string): string;
|
|
15
|
+
|
|
16
|
+
/** Serialise a character payload (an array of skills) into a character code. */
|
|
17
|
+
export declare function encode(payload: unknown): string;
|
|
18
|
+
|
|
19
|
+
/** Decode a character code back into JavaScript objects. */
|
|
20
|
+
export declare function decode(code: string): unknown;
|
package/src/conditions.d.ts
CHANGED
|
@@ -1,40 +1,40 @@
|
|
|
1
|
-
export interface Condition {
|
|
2
|
-
K_NAME: string;
|
|
3
|
-
[key: string]: unknown;
|
|
4
|
-
}
|
|
5
|
-
|
|
6
|
-
export interface FlipOptions {
|
|
7
|
-
/** If false the check must pass; if true it must not. */
|
|
8
|
-
flip?: boolean;
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
/** Check if the player is in the air. */
|
|
12
|
-
export declare function IN_AIR(options?: FlipOptions): Condition;
|
|
13
|
-
|
|
14
|
-
/** Check if the player is jumping. */
|
|
15
|
-
export declare function IS_JUMPING(options?: FlipOptions): Condition;
|
|
16
|
-
|
|
17
|
-
/** Check if the player is hovering their cursor over another player. */
|
|
18
|
-
export declare function HAS_TARGET(options?: FlipOptions): Condition;
|
|
19
|
-
|
|
20
|
-
/** Check if the player has their awakening. */
|
|
21
|
-
export declare function IS_AWAKENED(options?: FlipOptions): Condition;
|
|
22
|
-
|
|
23
|
-
/** Check how much of the awakening bar the player has. */
|
|
24
|
-
export declare function HAS_AWK_BAR(
|
|
25
|
-
options?: FlipOptions & { amount?: number },
|
|
26
|
-
): Condition;
|
|
27
|
-
|
|
28
|
-
/** Check how much durability the current move has. */
|
|
29
|
-
export declare function DURABILITY(options?: { durability?: number }): Condition;
|
|
30
|
-
|
|
31
|
-
/** Check how much health the player has. */
|
|
32
|
-
export declare function HAS_HEALTH(
|
|
33
|
-
options?: FlipOptions & { amount?: number },
|
|
34
|
-
): Condition;
|
|
35
|
-
|
|
36
|
-
/** Check if the player is in a domain. */
|
|
37
|
-
export declare function IS_IN_DOMAIN(options?: FlipOptions): Condition;
|
|
38
|
-
|
|
39
|
-
/** Check if the player is holding the skill key. */
|
|
40
|
-
export declare function IS_HOLDING(options?: FlipOptions): Condition;
|
|
1
|
+
export interface Condition {
|
|
2
|
+
K_NAME: string;
|
|
3
|
+
[key: string]: unknown;
|
|
4
|
+
}
|
|
5
|
+
|
|
6
|
+
export interface FlipOptions {
|
|
7
|
+
/** If false the check must pass; if true it must not. */
|
|
8
|
+
flip?: boolean;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
/** Check if the player is in the air. */
|
|
12
|
+
export declare function IN_AIR(options?: FlipOptions): Condition;
|
|
13
|
+
|
|
14
|
+
/** Check if the player is jumping. */
|
|
15
|
+
export declare function IS_JUMPING(options?: FlipOptions): Condition;
|
|
16
|
+
|
|
17
|
+
/** Check if the player is hovering their cursor over another player. */
|
|
18
|
+
export declare function HAS_TARGET(options?: FlipOptions): Condition;
|
|
19
|
+
|
|
20
|
+
/** Check if the player has their awakening. */
|
|
21
|
+
export declare function IS_AWAKENED(options?: FlipOptions): Condition;
|
|
22
|
+
|
|
23
|
+
/** Check how much of the awakening bar the player has. */
|
|
24
|
+
export declare function HAS_AWK_BAR(
|
|
25
|
+
options?: FlipOptions & { amount?: number },
|
|
26
|
+
): Condition;
|
|
27
|
+
|
|
28
|
+
/** Check how much durability the current move has. */
|
|
29
|
+
export declare function DURABILITY(options?: { durability?: number }): Condition;
|
|
30
|
+
|
|
31
|
+
/** Check how much health the player has. */
|
|
32
|
+
export declare function HAS_HEALTH(
|
|
33
|
+
options?: FlipOptions & { amount?: number },
|
|
34
|
+
): Condition;
|
|
35
|
+
|
|
36
|
+
/** Check if the player is in a domain. */
|
|
37
|
+
export declare function IS_IN_DOMAIN(options?: FlipOptions): Condition;
|
|
38
|
+
|
|
39
|
+
/** Check if the player is holding the skill key. */
|
|
40
|
+
export declare function IS_HOLDING(options?: FlipOptions): Condition;
|
package/src/defaults.d.ts
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import type { Node } from "./nodes.js";
|
|
2
|
-
|
|
3
|
-
/** Node K_NAME -> builder name in `nodes`. */
|
|
4
|
-
export declare const _NODE_BUILDERS: Readonly<Record<string, string>>;
|
|
5
|
-
|
|
6
|
-
/** Default node objects, derived from the builders themselves. */
|
|
7
|
-
export declare const NODE_DEFAULTS: Readonly<Record<string, Node>>;
|
|
8
|
-
|
|
9
|
-
export declare const PROPERTIES_DEFAULTS: Readonly<
|
|
10
|
-
Record<string, number | boolean | string>
|
|
11
|
-
>;
|
|
12
|
-
|
|
13
|
-
export declare const CONDITIONS_DEFAULTS: Readonly<
|
|
14
|
-
Record<string, Record<string, number | boolean>>
|
|
15
|
-
>;
|
|
1
|
+
import type { Node } from "./nodes.js";
|
|
2
|
+
|
|
3
|
+
/** Node K_NAME -> builder name in `nodes`. */
|
|
4
|
+
export declare const _NODE_BUILDERS: Readonly<Record<string, string>>;
|
|
5
|
+
|
|
6
|
+
/** Default node objects, derived from the builders themselves. */
|
|
7
|
+
export declare const NODE_DEFAULTS: Readonly<Record<string, Node>>;
|
|
8
|
+
|
|
9
|
+
export declare const PROPERTIES_DEFAULTS: Readonly<
|
|
10
|
+
Record<string, number | boolean | string>
|
|
11
|
+
>;
|
|
12
|
+
|
|
13
|
+
export declare const CONDITIONS_DEFAULTS: Readonly<
|
|
14
|
+
Record<string, Record<string, number | boolean>>
|
|
15
|
+
>;
|
package/src/errors.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
/** Base class for every error raised by this library. */
|
|
2
|
-
export declare class JsshenanigansError extends Error {}
|
|
3
|
-
|
|
4
|
-
/** Raised when a string is not a valid Jujutsu Shenanigans character code. */
|
|
5
|
-
export declare class InvalidCharacterCodeError extends JsshenanigansError {}
|
|
6
|
-
|
|
7
|
-
/** Raised when no usable zstd backend could be loaded. */
|
|
8
|
-
export declare class BackendNotFoundError extends JsshenanigansError {}
|
|
1
|
+
/** Base class for every error raised by this library. */
|
|
2
|
+
export declare class JsshenanigansError extends Error {}
|
|
3
|
+
|
|
4
|
+
/** Raised when a string is not a valid Jujutsu Shenanigans character code. */
|
|
5
|
+
export declare class InvalidCharacterCodeError extends JsshenanigansError {}
|
|
6
|
+
|
|
7
|
+
/** Raised when no usable zstd backend could be loaded. */
|
|
8
|
+
export declare class BackendNotFoundError extends JsshenanigansError {}
|
package/src/index.d.ts
CHANGED
|
@@ -1,46 +1,46 @@
|
|
|
1
|
-
export * from "./errors.js";
|
|
2
|
-
export {
|
|
3
|
-
ENV_BACKEND,
|
|
4
|
-
ZSTD_MAGIC,
|
|
5
|
-
backend_name,
|
|
6
|
-
compress,
|
|
7
|
-
decode,
|
|
8
|
-
decompress,
|
|
9
|
-
encode,
|
|
10
|
-
} from "./codec.js";
|
|
11
|
-
export { Character } from "./character.js";
|
|
12
|
-
export type {
|
|
13
|
-
CharacterOptions,
|
|
14
|
-
CreateHelper,
|
|
15
|
-
Skill,
|
|
16
|
-
SkillKind,
|
|
17
|
-
SkillOptions,
|
|
18
|
-
SkillSummary,
|
|
19
|
-
} from "./character.js";
|
|
20
|
-
export { dumps, describe } from "./tools.js";
|
|
21
|
-
export type { DescribeResult, SkillInfo } from "./tools.js";
|
|
22
|
-
export { Animations } from "./types.js";
|
|
23
|
-
export type {
|
|
24
|
-
AnimationRef,
|
|
25
|
-
AttackTypeName,
|
|
26
|
-
BodyPartName,
|
|
27
|
-
EasingDirectionName,
|
|
28
|
-
EasingStyleName,
|
|
29
|
-
EffectName,
|
|
30
|
-
SkillName,
|
|
31
|
-
SpecialName,
|
|
32
|
-
StateName,
|
|
33
|
-
} from "./types.js";
|
|
34
|
-
export { Branch, Properties } from "./utils.js";
|
|
35
|
-
export type { BranchDefinition, PropertiesOptions } from "./utils.js";
|
|
36
|
-
|
|
37
|
-
import * as codec from "./codec.js";
|
|
38
|
-
import * as conditions from "./conditions.js";
|
|
39
|
-
import * as nodes from "./nodes.js";
|
|
40
|
-
import * as tools from "./tools.js";
|
|
41
|
-
import * as types from "./types.js";
|
|
42
|
-
|
|
43
|
-
export { codec, conditions, nodes, tools, types };
|
|
44
|
-
|
|
45
|
-
/** The library version. */
|
|
46
|
-
export declare const VERSION: string;
|
|
1
|
+
export * from "./errors.js";
|
|
2
|
+
export {
|
|
3
|
+
ENV_BACKEND,
|
|
4
|
+
ZSTD_MAGIC,
|
|
5
|
+
backend_name,
|
|
6
|
+
compress,
|
|
7
|
+
decode,
|
|
8
|
+
decompress,
|
|
9
|
+
encode,
|
|
10
|
+
} from "./codec.js";
|
|
11
|
+
export { Character } from "./character.js";
|
|
12
|
+
export type {
|
|
13
|
+
CharacterOptions,
|
|
14
|
+
CreateHelper,
|
|
15
|
+
Skill,
|
|
16
|
+
SkillKind,
|
|
17
|
+
SkillOptions,
|
|
18
|
+
SkillSummary,
|
|
19
|
+
} from "./character.js";
|
|
20
|
+
export { dumps, describe } from "./tools.js";
|
|
21
|
+
export type { DescribeResult, SkillInfo } from "./tools.js";
|
|
22
|
+
export { Animations } from "./types.js";
|
|
23
|
+
export type {
|
|
24
|
+
AnimationRef,
|
|
25
|
+
AttackTypeName,
|
|
26
|
+
BodyPartName,
|
|
27
|
+
EasingDirectionName,
|
|
28
|
+
EasingStyleName,
|
|
29
|
+
EffectName,
|
|
30
|
+
SkillName,
|
|
31
|
+
SpecialName,
|
|
32
|
+
StateName,
|
|
33
|
+
} from "./types.js";
|
|
34
|
+
export { Branch, Properties } from "./utils.js";
|
|
35
|
+
export type { BranchDefinition, PropertiesOptions } from "./utils.js";
|
|
36
|
+
|
|
37
|
+
import * as codec from "./codec.js";
|
|
38
|
+
import * as conditions from "./conditions.js";
|
|
39
|
+
import * as nodes from "./nodes.js";
|
|
40
|
+
import * as tools from "./tools.js";
|
|
41
|
+
import * as types from "./types.js";
|
|
42
|
+
|
|
43
|
+
export { codec, conditions, nodes, tools, types };
|
|
44
|
+
|
|
45
|
+
/** The library version. */
|
|
46
|
+
export declare const VERSION: string;
|