Skip to content

Commit 5af4067

Browse files
JaylyDevJaylyDev
committed
Added 8 classes into code example
- BeforeChatEvent - BeforeChatEventSignal - Commands (archived) - Dimension - Events - Player - World - Direction - GameMode
1 parent 091f4e3 commit 5af4067

13 files changed

Lines changed: 634 additions & 154 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules/

‎README.md‎

Lines changed: 153 additions & 150 deletions
Large diffs are not rendered by default.

‎mojang-minecraft/classes/BeforeChatEvent.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# BeforeChatEvent
2+
3+
Description:
4+
- BeforeChatEvent: https://docs.microsoft.com/en-us/minecraft/creator/scriptapi/mojang-minecraft/BeforeChatEvent
5+
- BeforeChatEventSignal: https://docs.microsoft.com/en-us/minecraft/creator/scriptapi/mojang-minecraft/BeforeChatEventSignal
6+
7+
## Value
8+
9+
<pre><code class="lang-ts">class <span class="hljs-keyword">BeforeChatEvent </span>{
10+
<span class="hljs-string">"cancel"</span>: <span class="hljs-keyword">boolean;
11+
</span> <span class="hljs-string">"message"</span>: string<span class="hljs-comment">;</span>
12+
<span class="hljs-string">"sender"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/Player.md" class="hljs-type">Player</a><span class="hljs-comment">;</span>
13+
<span class="hljs-string">"sendToTargets"</span>: <span class="hljs-keyword">boolean;
14+
</span> <span class="hljs-string">"targets"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/Player.md" class="hljs-type">Player[]</a><span class="hljs-comment">;</span>
15+
}
16+
</code></pre>
17+
18+
<pre><code class="lang-ts"><span class="hljs-type"><span class="hljs-keyword">class</span> <span class="hljs-title">BeforeChatEventSignal</span> </span>{
19+
subscribe(callback: <span class="hljs-function">(<span class="hljs-params">arg: <a href="#" class="hljs-type">BeforeChatEvent</a></span>) =&gt;</span> <span class="hljs-keyword">void</span>): <span class="hljs-function">(<span class="hljs-params">arg: <a href="#" class="hljs-type">BeforeChatEvent</a></span>) =&gt;</span> <span class="hljs-keyword">void</span>;
20+
unsubscribe(callback: <span class="hljs-function">(<span class="hljs-params">arg: <a href="#" class="hljs-type">BeforeChatEvent</a></span>) =&gt;</span> <span class="hljs-keyword">void</span>): <span class="hljs-keyword">void</span>;
21+
}
22+
</code></pre>
23+
24+
25+
> Credit: [@types/mojang-minecraft/index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/mojang-minecraft/index.d.ts);
26+
27+
## Code examples:
28+
29+
Subscribe to events without unsubscribing:
30+
31+
```js
32+
import { world } from "mojang-minecraft";
33+
34+
world.events.beforeChat.subscribe((data) => {
35+
data.cancel = false;
36+
data.message = "edit original message";
37+
data.sender.name = "Player name";
38+
data.sender.nameTag = "Player nametag";
39+
data.sendToTargets = true;
40+
data.targets = [];
41+
});
42+
```
43+
44+
Subscribe and unsubscribe events:
45+
46+
```js
47+
import { world } from "mojang-minecraft";
48+
49+
let beforeChat = world.events.beforeChat.subscribe(() => {});
50+
world.events.beforeChat.unsubscribe(beforeChat);
51+
```

‎mojang-minecraft/classes/Commands.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Commands (Discontinued)
2+
3+
# IMPORTANT
4+
5+
Commands class do not work in version 1.17.30 or abov
6+
It has been replaced with
7+
8+
```js
9+
/**
10+
* @requires
11+
* Minecraft version 1.17.30
12+
*/
13+
import { World } from "mojang-minecraft";
14+
15+
World.getDimension().runCommand();
16+
```
17+
18+
```js
19+
/**
20+
* @requires
21+
* Minecraft version 1.18.10
22+
*/
23+
import { world } from "mojang-minecraft";
24+
25+
world.getDimension().runCommand();
26+
```
27+
28+
# Archives
29+
30+
Description: https://github.com/MicrosoftDocs/minecraft-creator/blob/c1a0f314a7ecc3c380591859f84f113a7362abf3/creator/ScriptAPI/mojang-minecraft/Commands.md
31+
32+
## Value
33+
34+
```ts
35+
class Commands {
36+
static run(commandString: string, dimension: Dimension): any;
37+
}
38+
```
39+
40+
> Credit: [@types/mojang-minecraft/index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/mojang-minecraft/index.d.ts)
41+
42+
## Code examples:
43+
44+
<!--
45+
Direction variable is available to:
46+
BeforeItemUseOnEventSignal: BeforeItemUseOnEvent,
47+
ItemUseOnEventSignal: ItemUseOnEvent,
48+
BlockProperties
49+
-->
50+
51+
```js
52+
/**
53+
* @requires
54+
* Below Minecraft version 1.17.30
55+
* or
56+
* NPM @types/[email protected]
57+
*/
58+
import { World, Commands } from "mojang-minecraft";
59+
60+
Commands.run("say You got a new high score!", World.getDimension("overworld"));
61+
```
62+
> Credit: [@types/mojang-minecraft@0.1.1/index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/35960c602bd5661bb8461b221cad75bfb5a91fc5/types/mojang-minecraft/index.d.ts)
63+
64+
```js
65+
/**
66+
* @requires
67+
* NPM @types/[email protected]
68+
*/
69+
import { Commands } from "Minecraft";
70+
71+
Commands.run("say You got a new high score");
72+
```
73+
> Credit: [@types/mojang-minecraft@0.1.0/index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/f3c14c3ee3063f5d21a03aae1aa18491e57add31/types/mojang-minecraft/index.d.ts)

‎mojang-minecraft/classes/Dimension.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Dimension
2+
3+
Description: https://docs.microsoft.com/en-us/minecraft/creator/scriptapi/mojang-minecraft/Dimension
4+
5+
## Value
6+
7+
<pre><code class="lang-ts"><span class="hljs-type"><span class="hljs-keyword">class</span> <span class="hljs-type">Dimension</span> {
8+
createExplosion(
9+
<span class="hljs-title">location</span>: <span class="hljs-type">Location</span>,
10+
<span class="hljs-title">radius</span>: <span class="hljs-title">number</span>,
11+
<span class="hljs-title">explosionOptions</span>: <span class="hljs-type">ExplosionOptions</span>
12+
): void;
13+
getBlock(<span class="hljs-title">location</span>: <span class="hljs-type">BlockLocation</span>): <span class="hljs-type">Block</span>;
14+
getBlockFromRay(
15+
<span class="hljs-title">location</span>: <span class="hljs-type">Location</span>,
16+
<span class="hljs-title">direction</span>: <span class="hljs-type">Vector</span>,
17+
<span class="hljs-title">options</span>?: <span class="hljs-type">BlockRaycastOptions</span>
18+
): <span class="hljs-type">Block</span>;
19+
getEntities(<span class="hljs-title">getEntities</span>?: <span class="hljs-type">EntityQueryOptions</span>): <span class="hljs-type">EntityIterator</span>;
20+
getEntitiesAtBlockLocation(<span class="hljs-title">location</span>: <span class="hljs-type">BlockLocation</span>): <span class="hljs-type">Entity</span>[];
21+
getEntitiesFromRay(
22+
<span class="hljs-title">location</span>: <span class="hljs-type">Location</span>,
23+
<span class="hljs-title">direction</span>: <span class="hljs-type">Vector</span>,
24+
<span class="hljs-title">options</span>?: <span class="hljs-type">EntityRaycastOptions</span>
25+
): <span class="hljs-type">Entity</span>[];
26+
getPlayers(<span class="hljs-title">getPlayers</span>?: <span class="hljs-type">EntityQueryOptions</span>): <span class="hljs-type">EntityIterator</span>;
27+
isEmpty(<span class="hljs-title">location</span>: <span class="hljs-type">BlockLocation</span>): boolean;
28+
runCommand(<span class="hljs-title">commandString</span>: <span class="hljs-title">string</span>): any;
29+
spawnEntity(
30+
<span class="hljs-title">identifier</span>: <span class="hljs-title">string</span>,
31+
<span class="hljs-title">location</span>: <span class="hljs-type">BlockLocation</span> | <span class="hljs-type">Location</span>
32+
): <span class="hljs-type">Entity</span>;
33+
}</span>
34+
</code></pre>
35+
36+
37+
> Credit: [@types/mojang-minecraft/index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/mojang-minecraft/index.d.ts);
38+
39+
## Code examples:
40+
```js
41+
for (let entity of world.getDimension('overworld').getEntities()) {
42+
entity.runCommand(`Coords: ${entity.location.x}, ${entity.location.y}, ${entity.location.z}`);
43+
}
44+
```

‎mojang-minecraft/classes/Events.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# Events
2+
3+
Description: https://docs.microsoft.com/en-us/minecraft/creator/scriptapi/mojang-minecraft/Events
4+
5+
## Value
6+
7+
<pre><code class="lang-ts">class Events {
8+
<span class="hljs-string">"beforeChat"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/BeforeChatEventSignal.md" class="hljs-type">BeforeChatEventSignal</a>;</span>
9+
<span class="hljs-string">"beforeExplosion"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/BeforeExplosionEventSignal.md" class="hljs-type">BeforeExplosionEventSignal</a>;</span>
10+
<span class="hljs-string">"beforeItemDefinitionEvent"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/BeforeItemDefinitionEventSignal.md" class="hljs-type">BeforeItemDefinitionEventSignal</a>;</span>
11+
<span class="hljs-string">"beforeItemUse"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/BeforeItemUseEventSignal.md" class="hljs-type">BeforeItemUseEventSignal</a>;</span>
12+
<span class="hljs-string">"beforeItemUseOn"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/BeforeItemUseOnEventSignal.md" class="hljs-type">BeforeItemUseOnEventSignal</a>;</span>
13+
<span class="hljs-string">"beforePistonActivate"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/BeforePistonActivateEventSignal.md" class="hljs-type">BeforePistonActivateEventSignal</a>;</span>
14+
<span class="hljs-string">"blockBreak"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/BlockBreakEventSignal.md" class="hljs-type">BlockBreakEventSignal</a>;</span>
15+
<span class="hljs-string">"blockExplode"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/BlockExplodeEventSignal.md" class="hljs-type">BlockExplodeEventSignal</a>;</span>
16+
<span class="hljs-string">"blockPlace"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/BlockPlaceEventSignal.md" class="hljs-type">BlockPlaceEventSignal</a>;</span>
17+
<span class="hljs-string">"chat"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/ChatEventSignal.md" class="hljs-type">ChatEventSignal</a><span class="hljs-comment">;</span>
18+
<span class="hljs-string">"effectAdd"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/EffectAddEventSignal.md" class="hljs-type">EffectAddEventSignal</a><span class="hljs-comment">;</span>
19+
<span class="hljs-string">"entityCreate"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/EntityCreateEventSignal.md" class="hljs-type">EntityCreateEventSignal</a><span class="hljs-comment">;</span>
20+
<span class="hljs-string">"explosion"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/ExplosionEventSignal.md" class="hljs-type">ExplosionEventSignal</a><span class="hljs-comment">;</span>
21+
<span class="hljs-string">"itemDefinitionEvent"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/ItemDefinitionEventSignal.md" class="hljs-type">ItemDefinitionEventSignal</a><span class="hljs-comment">;</span>
22+
<span class="hljs-string">"itemUse"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/ItemUseEventSignal.md" class="hljs-type">ItemUseEventSignal</a><span class="hljs-comment">;</span>
23+
<span class="hljs-string">"itemUseOn"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/ItemUseOnEventSignal.md" class="hljs-type">ItemUseOnEventSignal</a><span class="hljs-comment">;</span>
24+
<span class="hljs-string">"pistonActivate"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/PistonActivateEventSignal.md" class="hljs-type">PistonActivateEventSignal</a><span class="hljs-comment">;</span>
25+
<span class="hljs-string">"playerJoin"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/PlayerJoinEventSignal.md" class="hljs-type">PlayerJoinEventSignal</a><span class="hljs-comment">;</span>
26+
<span class="hljs-string">"playerLeave"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/PlayerLeaveEventSignal.md" class="hljs-type">PlayerLeaveEventSignal</a><span class="hljs-comment">;</span>
27+
<span class="hljs-string">"tick"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/TickEventSignal.md" class="hljs-type">TickEventSignal</a><span class="hljs-comment">;</span>
28+
<span class="hljs-string">"weatherChange"</span>: <a href="https://github.com/jaylydev/gametest-example/tree/main/mojang-minecraft/classes/WeatherChangeEventSignal.md" class="hljs-type">WeatherChangeEventSignal</a><span class="hljs-comment">;</span>
29+
}
30+
</code></pre>
31+
32+
> Credit: [@types/mojang-minecraft/index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/mojang-minecraft/index.d.ts);
33+
34+
## Code examples:
35+
36+
Subscribe to events without unsubscribing:
37+
38+
```js
39+
import { world } from "mojang-minecraft";
40+
41+
world.events.beforeChat.subscribe(() => {});
42+
world.events.beforeExplosion.subscribe(() => {});
43+
world.events.beforeItemDefinitionEvent.subscribe(() => {});
44+
world.events.beforeItemUse.subscribe(() => {});
45+
world.events.beforeItemUseOn.subscribe(() => {});
46+
world.events.beforePistonActivate.subscribe(() => {});
47+
world.events.blockBreak.subscribe(() => {});
48+
world.events.blockExplode.subscribe(() => {});
49+
world.events.blockPlace.subscribe(() => {});
50+
world.events.chat.subscribe(() => {});
51+
world.events.effectAdd.subscribe(() => {});
52+
world.events.entityCreate.subscribe(() => {});
53+
world.events.explosion.subscribe(() => {});
54+
world.events.itemDefinitionEvent.subscribe(() => {});
55+
world.events.itemUse.subscribe(() => {});
56+
world.events.itemUseOn.subscribe(() => {});
57+
world.events.pistonActivate.subscribe(() => {});
58+
world.events.playerJoin.subscribe(() => {});
59+
world.events.playerLeave.subscribe(() => {});
60+
world.events.tick.subscribe(() => {});
61+
world.events.weatherChange.subscribe(() => {});
62+
```
63+
64+
Subscribe and unsubscribe events:
65+
66+
```js
67+
import { world } from "mojang-minecraft";
68+
69+
let beforeChat = world.events.beforeChat.subscribe(() => {});
70+
world.events.beforeChat.unsubscribe(beforeChat);
71+
72+
let beforeExplosion = world.events.beforeExplosion.subscribe(() => {});
73+
world.events.beforeExplosion.unsubscribe(beforeExplosion);
74+
75+
let beforeItemDefinitionEvent =
76+
world.events.beforeItemDefinitionEvent.subscribe(() => {});
77+
world.events.beforeItemDefinitionEvent.unsubscribe(beforeItemDefinitionEvent);
78+
79+
let beforeItemUse = world.events.beforeItemUse.subscribe(() => {});
80+
world.events.beforeItemUse.unsubscribe(beforeItemUse);
81+
82+
let beforeItemUseOn = world.events.beforeItemUseOn.subscribe(() => {});
83+
world.events.beforeItemUseOn.unsubscribe(beforeItemUseOn);
84+
85+
let beforePistonActivate = world.events.beforePistonActivate.subscribe(
86+
() => {}
87+
);
88+
world.events.beforePistonActivate.unsubscribe(beforePistonActivate);
89+
90+
let blockBreak = world.events.blockBreak.subscribe(() => {});
91+
world.events.blockBreak.unsubscribe(blockBreak);
92+
93+
let blockExplode = world.events.blockExplode.subscribe(() => {});
94+
world.events.blockExplode.unsubscribe(blockExplode);
95+
96+
let blockPlace = world.events.blockPlace.subscribe(() => {});
97+
world.events.blockPlace.unsubscribe(blockPlace);
98+
99+
let chat = world.events.chat.subscribe(() => {});
100+
world.events.chat.unsubscribe(chat);
101+
102+
let effectAdd = world.events.effectAdd.subscribe(() => {});
103+
world.events.effectAdd.unsubscribe(effectAdd);
104+
105+
let entityCreate = world.events.entityCreate.subscribe(() => {});
106+
world.events.entityCreate.unsubscribe(entityCreate);
107+
108+
let explosion = world.events.explosion.subscribe(() => {});
109+
world.events.explosion.unsubscribe(explosion);
110+
111+
let itemDefinitionEvent = world.events.itemDefinitionEvent.subscribe(() => {});
112+
world.events.itemDefinitionEvent.unsubscribe(itemDefinitionEvent);
113+
114+
let itemUse = world.events.itemUse.subscribe(() => {});
115+
world.events.itemUse.unsubscribe(itemUse);
116+
117+
let itemUseOn = world.events.itemUseOn.subscribe(() => {});
118+
world.events.itemUseOn.unsubscribe(itemUseOn);
119+
120+
let pistonActivate = world.events.pistonActivate.subscribe(() => {});
121+
world.events.pistonActivate.unsubscribe(pistonActivate);
122+
123+
let playerJoin = world.events.playerJoin.subscribe(() => {});
124+
world.events.playerJoin.unsubscribe(playerJoin);
125+
126+
let playerLeave = world.events.playerLeave.subscribe(() => {});
127+
world.events.playerLeave.unsubscribe(playerLeave);
128+
129+
let tick = world.events.tick.subscribe(() => {});
130+
world.events.tick.unsubscribe(tick);
131+
132+
let weatherChange = world.events.weatherChange.subscribe(() => {});
133+
world.events.weatherChange.unsubscribe(weatherChange);
134+
```

‎mojang-minecraft/classes/Player.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Player
2+
3+
Description: https://docs.microsoft.com/en-us/minecraft/creator/scriptapi/mojang-minecraft/Player
4+
5+
## Value
6+
7+
<pre><code class="lang-ts"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-type">Dimension</span> {
8+
createExplosion(
9+
<span class="hljs-title">location</span>: <span class="hljs-type">Location</span>,
10+
<span class="hljs-title">radius</span>: <span class="hljs-title">number</span>,
11+
<span class="hljs-title">explosionOptions</span>: <span class="hljs-type">ExplosionOptions</span>
12+
): void;
13+
getBlock(<span class="hljs-title">location</span>: <span class="hljs-type">BlockLocation</span>): <span class="hljs-type">Block</span>;
14+
getBlockFromRay(
15+
<span class="hljs-title">location</span>: <span class="hljs-type">Location</span>,
16+
<span class="hljs-title">direction</span>: <span class="hljs-type">Vector</span>,
17+
<span class="hljs-title">options</span>?: <span class="hljs-type">BlockRaycastOptions</span>
18+
): <span class="hljs-type">Block</span>;
19+
getEntities(<span class="hljs-title">getEntities</span>?: <span class="hljs-type">EntityQueryOptions</span>): <span class="hljs-type">EntityIterator</span>;
20+
getEntitiesAtBlockLocation(<span class="hljs-title">location</span>: <span class="hljs-type">BlockLocation</span>): <span class="hljs-type">Entity</span>[];
21+
getEntitiesFromRay(
22+
<span class="hljs-title">location</span>: <span class="hljs-type">Location</span>,
23+
<span class="hljs-title">direction</span>: <span class="hljs-type">Vector</span>,
24+
<span class="hljs-title">options</span>?: <span class="hljs-type">EntityRaycastOptions</span>
25+
): <span class="hljs-type">Entity</span>[];
26+
getPlayers(<span class="hljs-title">getPlayers</span>?: <span class="hljs-type">EntityQueryOptions</span>): <span class="hljs-type">EntityIterator</span>;
27+
isEmpty(<span class="hljs-title">location</span>: <span class="hljs-type">BlockLocation</span>): boolean;
28+
runCommand(<span class="hljs-title">commandString</span>: <span class="hljs-title">string</span>): any;
29+
spawnEntity(
30+
<span class="hljs-title">identifier</span>: <span class="hljs-title">string</span>,
31+
<span class="hljs-title">location</span>: <span class="hljs-type">BlockLocation</span> | <span class="hljs-type">Location</span>
32+
): <span class="hljs-type">Entity</span>;
33+
}</span>
34+
</code></pre>
35+
36+
> Credit: [@types/mojang-minecraft/index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/mojang-minecraft/index.d.ts);
37+
38+
## Code examples:
39+
40+
```js
41+
for (let player of world.getPlayers()) {
42+
player.nameTag = "pizza";
43+
player.runCommand("say pizza");
44+
}
45+
```

0 commit comments

Comments
 (0)