@minecraft/server-admin 1.0.0-beta.1.21.94-stable → 1.0.0-beta.1.26.0-preview.24

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.
Files changed (3) hide show
  1. package/README.md +8 -8
  2. package/index.d.ts +25 -2
  3. package/package.json +19 -19
package/README.md CHANGED
@@ -1,9 +1,9 @@
1
- # `@minecraft/server-admin`
2
-
3
- Contains types related to administering a Bedrock Dedicated Server. These types allow for the configuration of variables and secrets in JSON files in the Bedrock Dedicated Server folder. These types cannot be used on Minecraft clients or within Minecraft Realms.
4
-
5
- ## **NOTE: This version of this module is still in pre-release. It may change or it may be removed in future releases.**
6
-
7
- See full documentation for this module here:
8
-
1
+ # `@minecraft/server-admin`
2
+
3
+ Contains types related to administering a Bedrock Dedicated Server. These types allow for the configuration of variables and secrets in JSON files in the Bedrock Dedicated Server folder. These types cannot be used on Minecraft clients or within Minecraft Realms.
4
+
5
+ ## **NOTE: This version of this module is still in pre-release. It may change or it may be removed in future releases.**
6
+
7
+ See full documentation for this module here:
8
+
9
9
  https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-admin/minecraft-server-admin
package/index.d.ts CHANGED
@@ -60,8 +60,31 @@ export class AsyncPlayerJoinBeforeEvent {
60
60
  readonly persistentId: string;
61
61
  /**
62
62
  * @remarks
63
- * Call this to disconnect a player. They will be allowed to
64
- * try to join again.
63
+ * Call this to explicitly allow the player to join the server.
64
+ * This is useful when player joining is disabled
65
+ * (`allow-player-joining` is set to `false` when playing on
66
+ * dedicated server).
67
+ *
68
+ * @throws This function can throw errors.
69
+ *
70
+ * {@link DisconnectedError}
71
+ */
72
+ allowJoin(): void;
73
+ /**
74
+ * @remarks
75
+ * Deprecated - use {@link disallowJoin} instead.Call this to
76
+ * disconnect a player. They will be allowed to try to join
77
+ * again.
78
+ *
79
+ * @throws This function can throw errors.
80
+ *
81
+ * {@link DisconnectedError}
82
+ */
83
+ disallowJoin(reason?: string): void;
84
+ /**
85
+ * @remarks
86
+ * Call this to stop the player from joining the server. They
87
+ * will be allowed to try to join again.
65
88
  *
66
89
  * @throws This function can throw errors.
67
90
  *
package/package.json CHANGED
@@ -1,20 +1,20 @@
1
- {
2
- "name": "@minecraft/server-admin",
3
- "version": "1.0.0-beta.1.21.94-stable",
4
- "description": "",
5
- "contributors": [
6
- {
7
- "name": "Jake Shirley",
8
- "email": "jake@xbox.com"
9
- },
10
- {
11
- "name": "Mike Ammerlaan",
12
- "email": "mikeam@microsoft.com"
13
- }
14
- ],
15
- "dependencies": {
16
- "@minecraft/common": "^1.0.0",
17
- "@minecraft/server": "^1.17.0 || ^2.0.0"
18
- },
19
- "license": "MIT"
1
+ {
2
+ "name": "@minecraft/server-admin",
3
+ "version": "1.0.0-beta.1.26.0-preview.24",
4
+ "description": "",
5
+ "contributors": [
6
+ {
7
+ "name": "Jake Shirley",
8
+ "email": "jake@xbox.com"
9
+ },
10
+ {
11
+ "name": "Mike Ammerlaan",
12
+ "email": "mikeam@microsoft.com"
13
+ }
14
+ ],
15
+ "peerDependencies": {
16
+ "@minecraft/common": "^1.0.0",
17
+ "@minecraft/server": "^1.17.0 || ^2.0.0"
18
+ },
19
+ "license": "MIT"
20
20
  }