bc-minecraft-bedrock-command 1.19.71-0 → 1.19.71-2

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.
@@ -0,0 +1,2 @@
1
+ import { ParameterType } from '../Types/ParameterType';
2
+ export declare const ParameterTypeDocumentation: Partial<Record<ParameterType, string>>;
@@ -0,0 +1,188 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ParameterTypeDocumentation = void 0;
4
+ const bc_minecraft_bedrock_types_1 = require("bc-minecraft-bedrock-types");
5
+ const ParameterType_1 = require("../Types/ParameterType");
6
+ exports.ParameterTypeDocumentation = {
7
+ [ParameterType_1.ParameterType.animation]: `## Animation
8
+ An animation is a set of key frames or mathematical expressions that can be used to animate a model. or execute commands`,
9
+ [ParameterType_1.ParameterType.block]: `## Block
10
+ A block is a single block in the world. It can be placed, removed, and changed.`,
11
+ [ParameterType_1.ParameterType.blockStates]: `## Block States
12
+ Block states are a way to change the appearance of a block. They are used to change the color of a wool block, the direction a door is facing, or the type of a bed.
13
+
14
+ **Format**
15
+ Block states are specified in the following format:
16
+ \`\`\`json
17
+ [property=value]
18
+ \`\`\``,
19
+ [ParameterType_1.ParameterType.boolean]: `## Boolean
20
+ A boolean is a value that can be either \`true\` or \`false\`.`,
21
+ [ParameterType_1.ParameterType.causeType]: `## Cause Type
22
+ A cause type is a way to specify what kind of damage this entity is taking.
23
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.CauseType)}`,
24
+ [ParameterType_1.ParameterType.cameraShakeType]: `## Camera Shake Type
25
+ A camera shake type is a way to specify what kind of camera shake this entity is taking.
26
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.CameraShake)}`,
27
+ [ParameterType_1.ParameterType.cloneMode]: `## Clone Mode
28
+ A clone mode is a way to specify how the clone command should clone the blocks.
29
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.Clone)}`,
30
+ [ParameterType_1.ParameterType.command]: `## Commands
31
+ A command is a way to execute.`,
32
+ [ParameterType_1.ParameterType.coordinate]: `## Coordinate
33
+ A coordinate is a way to specify a location in the world. It can be a relative, absolute, or local coordinate.
34
+
35
+ **Format**
36
+ Coordinates are specified in the following format:
37
+ - \`2.5\` - Absolute coordinate
38
+ - \`~2.5\` - Relative coordinate
39
+ - \`^2.5\` - Local coordinate
40
+
41
+ ### Absolute Coordinate
42
+ An absolute coordinate is a coordinate that is specified from the world origin.
43
+
44
+ ### Relative Coordinate
45
+ A relative coordinate is a coordinate that is relative to the current position of the entity executing the command. but still moves along the world axis.
46
+
47
+ ### Local Coordinate
48
+ A local coordinate is a coordinate that is relative to the current position of the entity executing the command. but moves along the local axis of the entity. (or view point)`,
49
+ [ParameterType_1.ParameterType.difficulty]: `## Difficulty
50
+ A value representing the difficulty of the game.`,
51
+ [ParameterType_1.ParameterType.dimension]: `## Dimension
52
+ A value representing the dimension of the game.`,
53
+ [ParameterType_1.ParameterType.effect]: `## Effect
54
+ A value representing a potion effect.`,
55
+ [ParameterType_1.ParameterType.entity]: `## Entity
56
+ The identifier of an entity.`,
57
+ [ParameterType_1.ParameterType.executeSubcommand]: `## Execute Subcommand
58
+ The next statement to check or use in the execute command.`,
59
+ [ParameterType_1.ParameterType.event]: `## Event
60
+ A value representing an world event.`,
61
+ [ParameterType_1.ParameterType.fillMode]: `## Fill Mode
62
+ What kind of fill mode should be used.
63
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.Fill)}`,
64
+ [ParameterType_1.ParameterType.function]: `## Function
65
+ The path to a function to run.
66
+
67
+ **Format**
68
+ \`\`\`mcfunction
69
+ function <path/to/function/file>
70
+ function "<path/to/function/file>"
71
+ \`\`\``,
72
+ [ParameterType_1.ParameterType.float]: `## Float
73
+ A float is a number with a decimal point.`,
74
+ [ParameterType_1.ParameterType.gamemode]: `## Gamemode
75
+ A value representing the gamemode of a player.
76
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.Gamemode)}`,
77
+ [ParameterType_1.ParameterType.handType]: `## Hand Type
78
+ A value representing the different hand locations of a player.
79
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.HandType)}`,
80
+ [ParameterType_1.ParameterType.integer]: `## Integer
81
+ An integer is a whole number. no decimal point.`,
82
+ [ParameterType_1.ParameterType.integer_range]: `## Integer Range
83
+ An integer range is a syntax to specify a range of integers.
84
+
85
+ **Format**
86
+ \`\`\`mcfunction
87
+ <min>..<max>
88
+ <min>..
89
+ ..<max>
90
+ \`\`\`
91
+
92
+ With this syntax you can specify a range of integers. The first number is the minimum value, the second number is the maximum value.
93
+ If you only specify one number, then that number is the minimum value and the maximum value is unlimited.`,
94
+ [ParameterType_1.ParameterType.item]: `## Item
95
+ The identifier of an item.`,
96
+ [ParameterType_1.ParameterType.jsonItem]: `## Json Item Components
97
+ A json item component is a way to specify the components of an item.`,
98
+ [ParameterType_1.ParameterType.jsonRawText]: `## Raw Text
99
+ A raw text is a way to specify the text of a text component.`,
100
+ //[ParameterType.keyword]:``,
101
+ [ParameterType_1.ParameterType.lootTable]: `## Loot Table
102
+ The identifier of a loot table.`,
103
+ [ParameterType_1.ParameterType.locateFeature]: `## Locate Feature
104
+ A value representing the different world features.\
105
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.LocateFeature)}`,
106
+ [ParameterType_1.ParameterType.message]: `## Message
107
+ A message is a just a bunch of text.`,
108
+ [ParameterType_1.ParameterType.maskMode]: `## Mask Mode
109
+ A value representing the different mask modes for the clone command.
110
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.Mask)}`,
111
+ [ParameterType_1.ParameterType.mirror]: `## Mirror Mode
112
+ A value representing the different mirror modes for the clone command.
113
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.Mirror)}`,
114
+ [ParameterType_1.ParameterType.musicRepeatMode]: `## Music Repeat Mode
115
+ A value representing the different music repeat modes for the music command.
116
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.MusicRepeat)}`,
117
+ [ParameterType_1.ParameterType.objective]: `## Objective
118
+ The identifier of an objective.`,
119
+ [ParameterType_1.ParameterType.oldBlockMode]: `## Old Block Mode
120
+ A value representing the different old block modes for the clone command.
121
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.OldBlock)}`,
122
+ [ParameterType_1.ParameterType.operation]: `## Operation
123
+ A mathematical operation.
124
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.Operation)}`,
125
+ [ParameterType_1.ParameterType.particle]: `## Particle
126
+ The identifier of a particle.`,
127
+ [ParameterType_1.ParameterType.replaceMode]: `## Replace Mode
128
+ A value representing the different replace modes for the clone command.
129
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.Replace)}`,
130
+ [ParameterType_1.ParameterType.rideRules]: `## Ride Rules
131
+ A value representing the different ride rules for the ride command.
132
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.RideRules)}`,
133
+ [ParameterType_1.ParameterType.ridefillMode]: `## Ride Fill Mode
134
+ A value representing the different ride fill modes for the ride command.
135
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.RideFill)}`,
136
+ [ParameterType_1.ParameterType.rotation]: `## Rotation
137
+ A value representing the rotation of an structure.
138
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.Rotation)}`,
139
+ [ParameterType_1.ParameterType.saveMode]: `## Save Mode
140
+ A value representing the different save modes.
141
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.Save)}`,
142
+ [ParameterType_1.ParameterType.scanMode]: `## Scan Mode
143
+ A value representing the different scan modes.
144
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.Scan)}`,
145
+ [ParameterType_1.ParameterType.selector]: `## Selector
146
+ A selector is a way to specify a group of entities.
147
+
148
+ Either starts with \`@\` or a string of a fake player.`,
149
+ [ParameterType_1.ParameterType.slotType]: `## Slot Type
150
+ A value representing the different slot types.
151
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.SlotType)}`,
152
+ [ParameterType_1.ParameterType.slotID]: `## Slot ID
153
+ A value that helps to specify a slot.`,
154
+ [ParameterType_1.ParameterType.sound]: `## Sound
155
+ The identifier of a sound.`,
156
+ [ParameterType_1.ParameterType.string]: `## String
157
+ A string is a text. It needs surrounded by \`"\` or \`'\` if spaces are used.`,
158
+ [ParameterType_1.ParameterType.structure]: `## Structure
159
+ The identifier of a structure.`,
160
+ [ParameterType_1.ParameterType.structureAnimationMode]: `## Structure Animation Mode
161
+ A value representing the different structure animation modes.
162
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.StructureAnimation)}`,
163
+ [ParameterType_1.ParameterType.tag]: `## Tag
164
+ The identifier of a tag.`,
165
+ [ParameterType_1.ParameterType.teleportRules]: `## Teleport Rules
166
+ A value representing the different teleport rules.
167
+ ${sumMode(bc_minecraft_bedrock_types_1.Modes.TeleportRules)}`,
168
+ [ParameterType_1.ParameterType.tickingarea]: `## Ticking Area
169
+ The identifier of a ticking area.`,
170
+ [ParameterType_1.ParameterType.time]: `## Time
171
+ A value representing the time of the game.`,
172
+ //[ParameterType.unknown]:``,
173
+ [ParameterType_1.ParameterType.xp]: `## XP
174
+ XP is a way to track the progress of a player.
175
+ It is used to unlock new features and abilities in the game. XP is gained by various actions.
176
+ XP can also be used as a progress bar / currency in custom commands.
177
+
178
+ ### Format
179
+ XP can be specified in two ways:
180
+ - Levels: \`1L\`
181
+ - Points: \`1000\`
182
+
183
+ Where \`1L\` is 1 level and \`1000\` is 1000 points.`,
184
+ };
185
+ function sumMode(mode) {
186
+ return mode.modes.slice(0, 20).map((m) => ` - \`${m.name}\``).join("\r\n");
187
+ }
188
+ //# sourceMappingURL=ParameterType.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ParameterType.js","sourceRoot":"","sources":["../../../../src/Lib/Documentation/ParameterType.ts"],"names":[],"mappings":";;;AAAA,2EAAmD;AAEnD,0DAAuD;AAG1C,QAAA,0BAA0B,GAA4C;IACjF,CAAC,6BAAa,CAAC,SAAS,CAAC,EAAE;yHAC4F;IAEvH,CAAC,6BAAa,CAAC,KAAK,CAAC,EAAC;gFACwD;IAE9E,CAAC,6BAAa,CAAC,WAAW,CAAC,EAAC;;;;;;;OAOvB;IAEL,CAAC,6BAAa,CAAC,OAAO,CAAC,EAAC;+DACqC;IAE7D,CAAC,6BAAa,CAAC,SAAS,CAAC,EAAC;;EAE1B,OAAO,CAAC,kCAAK,CAAC,SAAS,CAAC,EAAE;IAE1B,CAAC,6BAAa,CAAC,eAAe,CAAC,EAAC;;EAEhC,OAAO,CAAC,kCAAK,CAAC,WAAW,CAAC,EAAE;IAE5B,CAAC,6BAAa,CAAC,SAAS,CAAC,EAAC;;EAE1B,OAAO,CAAC,kCAAK,CAAC,KAAK,CAAC,EAAE;IAEtB,CAAC,6BAAa,CAAC,OAAO,CAAC,EAAC;+BACK;IAE7B,CAAC,6BAAa,CAAC,UAAU,CAAC,EAAC;;;;;;;;;;;;;;;;+KAgBkJ;IAE7K,CAAC,6BAAa,CAAC,UAAU,CAAC,EAAC;iDACoB;IAE/C,CAAC,6BAAa,CAAC,SAAS,CAAC,EAAC;gDACoB;IAE9C,CAAC,6BAAa,CAAC,MAAM,CAAC,EAAC;sCACa;IAEpC,CAAC,6BAAa,CAAC,MAAM,CAAC,EAAC;6BACI;IAE3B,CAAC,6BAAa,CAAC,iBAAiB,CAAC,EAAC;2DACuB;IAEzD,CAAC,6BAAa,CAAC,KAAK,CAAC,EAAC;qCACa;IAEnC,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAC;;EAEzB,OAAO,CAAC,kCAAK,CAAC,IAAI,CAAC,EAAE;IAErB,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAC;;;;;;;OAOpB;IAEL,CAAC,6BAAa,CAAC,KAAK,CAAC,EAAC;0CACkB;IAExC,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAC;;EAEzB,OAAO,CAAC,kCAAK,CAAC,QAAQ,CAAC,EAAE;IAEzB,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAC;;EAEzB,OAAO,CAAC,kCAAK,CAAC,QAAQ,CAAC,EAAE;IAEzB,CAAC,6BAAa,CAAC,OAAO,CAAC,EAAC;gDACsB;IAE9C,CAAC,6BAAa,CAAC,aAAa,CAAC,EAAC;;;;;;;;;;;0GAW0E;IAExG,CAAC,6BAAa,CAAC,IAAI,CAAC,EAAC;2BACI;IAEzB,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAC;qEAC0C;IAEnE,CAAC,6BAAa,CAAC,WAAW,CAAC,EAAC;6DAC+B;IAE3D,6BAA6B;IAE7B,CAAC,6BAAa,CAAC,SAAS,CAAC,EAAC;gCACI;IAE9B,CAAC,6BAAa,CAAC,aAAa,CAAC,EAAC;;EAE9B,OAAO,CAAC,kCAAK,CAAC,aAAa,CAAC,EAAE;IAE9B,CAAC,6BAAa,CAAC,OAAO,CAAC,EAAC;qCACW;IAEnC,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAC;;EAEzB,OAAO,CAAC,kCAAK,CAAC,IAAI,CAAC,EAAE;IAErB,CAAC,6BAAa,CAAC,MAAM,CAAC,EAAC;;EAEvB,OAAO,CAAC,kCAAK,CAAC,MAAM,CAAC,EAAE;IAEvB,CAAC,6BAAa,CAAC,eAAe,CAAC,EAAC;;EAEhC,OAAO,CAAC,kCAAK,CAAC,WAAW,CAAC,EAAE;IAE5B,CAAC,6BAAa,CAAC,SAAS,CAAC,EAAC;gCACI;IAE9B,CAAC,6BAAa,CAAC,YAAY,CAAC,EAAC;;EAE7B,OAAO,CAAC,kCAAK,CAAC,QAAQ,CAAC,EAAE;IAEzB,CAAC,6BAAa,CAAC,SAAS,CAAC,EAAC;;EAE1B,OAAO,CAAC,kCAAK,CAAC,SAAS,CAAC,EAAE;IAE1B,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAC;8BACG;IAE5B,CAAC,6BAAa,CAAC,WAAW,CAAC,EAAC;;EAE5B,OAAO,CAAC,kCAAK,CAAC,OAAO,CAAC,EAAE;IAExB,CAAC,6BAAa,CAAC,SAAS,CAAC,EAAC;;EAE1B,OAAO,CAAC,kCAAK,CAAC,SAAS,CAAC,EAAE;IAE1B,CAAC,6BAAa,CAAC,YAAY,CAAC,EAAC;;EAE7B,OAAO,CAAC,kCAAK,CAAC,QAAQ,CAAC,EAAE;IAEzB,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAC;;EAEzB,OAAO,CAAC,kCAAK,CAAC,QAAQ,CAAC,EAAE;IAEzB,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAC;;EAEzB,OAAO,CAAC,kCAAK,CAAC,IAAI,CAAC,EAAE;IAErB,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAC;;EAEzB,OAAO,CAAC,kCAAK,CAAC,IAAI,CAAC,EAAE;IAErB,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAC;;;uDAG4B;IAErD,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAC;;EAEzB,OAAO,CAAC,kCAAK,CAAC,QAAQ,CAAC,EAAE;IAEzB,CAAC,6BAAa,CAAC,MAAM,CAAC,EAAC;sCACa;IAEpC,CAAC,6BAAa,CAAC,KAAK,CAAC,EAAC;2BACG;IAEzB,CAAC,6BAAa,CAAC,MAAM,CAAC,EAAC;8EACqD;IAE5E,CAAC,6BAAa,CAAC,SAAS,CAAC,EAAC;+BACG;IAE7B,CAAC,6BAAa,CAAC,sBAAsB,CAAC,EAAC;;EAEvC,OAAO,CAAC,kCAAK,CAAC,kBAAkB,CAAC,EAAE;IAEnC,CAAC,6BAAa,CAAC,GAAG,CAAC,EAAC;yBACG;IAEvB,CAAC,6BAAa,CAAC,aAAa,CAAC,EAAC;;EAE9B,OAAO,CAAC,kCAAK,CAAC,aAAa,CAAC,EAAE;IAE9B,CAAC,6BAAa,CAAC,WAAW,CAAC,EAAC;kCACI;IAEhC,CAAC,6BAAa,CAAC,IAAI,CAAC,EAAC;2CACoB;IAEzC,6BAA6B;IAE7B,CAAC,6BAAa,CAAC,EAAE,CAAC,EAAE;;;;;;;;;;uDAUiC;CACtD,CAAC;AAEF,SAAS,OAAO,CAAC,IAAiB;IAChC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC7E,CAAC"}
@@ -0,0 +1 @@
1
+ export * from "./ParameterType";
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ /* Auto generated */
18
+ __exportStar(require("./ParameterType"), exports);
19
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/Lib/Documentation/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oBAAoB;AACpB,kDAAgC"}
package/lib/src/main.d.ts CHANGED
@@ -1,2 +1,3 @@
1
1
  export * from "./Lib/Types";
2
2
  export * from "./Lib/Data";
3
+ export * from "./Lib/Documentation";
package/lib/src/main.js CHANGED
@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./Lib/Types"), exports);
18
18
  __exportStar(require("./Lib/Data"), exports);
19
+ __exportStar(require("./Lib/Documentation"), exports);
19
20
  //# sourceMappingURL=main.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"main.js","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,6CAA2B"}
1
+ {"version":3,"file":"main.js","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,6CAA2B;AAC3B,sDAAoC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bc-minecraft-bedrock-command",
3
- "version": "1.19.71-0",
3
+ "version": "1.19.71-2",
4
4
  "description": "A typescript package library that handles commands for minecraft bedrock",
5
5
  "main": "./lib/src/main.js",
6
6
  "types": "./lib/src/main.d.ts",
@@ -44,13 +44,13 @@
44
44
  "devDependencies": {
45
45
  "@types/chai": "^4.3.3",
46
46
  "@types/mocha": "^10.0.0",
47
- "@types/node": "^18.7.16",
47
+ "@types/node": "^18.15.11",
48
48
  "chai": "^4.3.6",
49
49
  "mocha": "^10.0.0",
50
50
  "mocha-junit-reporter": "^2.2.0",
51
- "rimraf": "^4.1.2",
51
+ "rimraf": "^4.4.1",
52
52
  "ts-node": "^10.9.1",
53
- "typescript": "^4.7.4"
53
+ "typescript": "^4.9.5"
54
54
  },
55
55
  "dependencies": {
56
56
  "bc-minecraft-bedrock-types": "^1.19.50-0"