hytopia 0.1.58 → 0.1.59

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.
@@ -146,5 +146,33 @@ Retrieves all looped audio instances for the world.
146
146
  Retrieves all oneshot (non-looped) audio instances for the world.
147
147
 
148
148
 
149
+ </td></tr>
150
+ <tr><td>
151
+
152
+ [unregisterAudio(audio)](./server.audiomanager.unregisteraudio.md)
153
+
154
+
155
+ </td><td>
156
+
157
+
158
+ </td><td>
159
+
160
+ Unregisters and stops an audio instance from the audio manager.
161
+
162
+
163
+ </td></tr>
164
+ <tr><td>
165
+
166
+ [unregisterEntityAttachedAudios(entity)](./server.audiomanager.unregisterentityattachedaudios.md)
167
+
168
+
169
+ </td><td>
170
+
171
+
172
+ </td><td>
173
+
174
+ Unregisters and stops all audio instances attached to a specific entity.
175
+
176
+
149
177
  </td></tr>
150
178
  </tbody></table>
@@ -0,0 +1,53 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [AudioManager](./server.audiomanager.md) &gt; [unregisterAudio](./server.audiomanager.unregisteraudio.md)
4
+
5
+ ## AudioManager.unregisterAudio() method
6
+
7
+ Unregisters and stops an audio instance from the audio manager.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ unregisterAudio(audio: Audio): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ audio
36
+
37
+
38
+ </td><td>
39
+
40
+ [Audio](./server.audio.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The audio instance to unregister.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ void
53
+
@@ -0,0 +1,53 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [AudioManager](./server.audiomanager.md) &gt; [unregisterEntityAttachedAudios](./server.audiomanager.unregisterentityattachedaudios.md)
4
+
5
+ ## AudioManager.unregisterEntityAttachedAudios() method
6
+
7
+ Unregisters and stops all audio instances attached to a specific entity.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ unregisterEntityAttachedAudios(entity: Entity): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ entity
36
+
37
+
38
+ </td><td>
39
+
40
+ [Entity](./server.entity.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The entity to unregister audio instances for.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ void
53
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [BlockType](./server.blocktype.md) &gt; [isLiquid](./server.blocktype.isliquid.md)
4
+
5
+ ## BlockType.isLiquid property
6
+
7
+ Whether the block type is a liquid.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ get isLiquid(): boolean;
13
+ ```
@@ -130,6 +130,27 @@ number
130
130
  The unique identifier for the block type.
131
131
 
132
132
 
133
+ </td></tr>
134
+ <tr><td>
135
+
136
+ [isLiquid](./server.blocktype.isliquid.md)
137
+
138
+
139
+ </td><td>
140
+
141
+ `readonly`
142
+
143
+
144
+ </td><td>
145
+
146
+ boolean
147
+
148
+
149
+ </td><td>
150
+
151
+ Whether the block type is a liquid.
152
+
153
+
133
154
  </td></tr>
134
155
  <tr><td>
135
156
 
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [BlockTypeOptions](./server.blocktypeoptions.md) &gt; [isLiquid](./server.blocktypeoptions.isliquid.md)
4
+
5
+ ## BlockTypeOptions.isLiquid property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ isLiquid?: boolean;
11
+ ```
@@ -70,6 +70,25 @@ number
70
70
  </td><td>
71
71
 
72
72
 
73
+ </td></tr>
74
+ <tr><td>
75
+
76
+ [isLiquid?](./server.blocktypeoptions.isliquid.md)
77
+
78
+
79
+ </td><td>
80
+
81
+
82
+ </td><td>
83
+
84
+ boolean
85
+
86
+
87
+ </td><td>
88
+
89
+ _(Optional)_
90
+
91
+
73
92
  </td></tr>
74
93
  <tr><td>
75
94
 
@@ -1,15 +1,15 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [Chunk](./server.chunk.md) &gt; [getBlock](./server.chunk.getblock.md)
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Chunk](./server.chunk.md) &gt; [getBlockId](./server.chunk.getblockid.md)
4
4
 
5
- ## Chunk.getBlock() method
5
+ ## Chunk.getBlockId() method
6
6
 
7
7
  Get the block type id at a specific local coordinate.
8
8
 
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- getBlock(localCoordinate: Vector3Like): number;
12
+ getBlockId(localCoordinate: Vector3Like): number;
13
13
  ```
14
14
 
15
15
  ## Parameters
@@ -247,7 +247,7 @@ Despawn the chunk from the world.
247
247
  </td></tr>
248
248
  <tr><td>
249
249
 
250
- [getBlock(localCoordinate)](./server.chunk.getblock.md)
250
+ [getBlockId(localCoordinate)](./server.chunk.getblockid.md)
251
251
 
252
252
 
253
253
  </td><td>
@@ -1,15 +1,15 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [ChunkLattice](./server.chunklattice.md) &gt; [getBlock](./server.chunklattice.getblock.md)
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [ChunkLattice](./server.chunklattice.md) &gt; [getBlockId](./server.chunklattice.getblockid.md)
4
4
 
5
- ## ChunkLattice.getBlock() method
5
+ ## ChunkLattice.getBlockId() method
6
6
 
7
7
  Get the block type id at a specific global coordinate.
8
8
 
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- getBlock(globalCoordinate: Vector3Like): number;
12
+ getBlockId(globalCoordinate: Vector3Like): number;
13
13
  ```
14
14
 
15
15
  ## Parameters
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [ChunkLattice](./server.chunklattice.md) &gt; [getBlockType](./server.chunklattice.getblocktype.md)
4
+
5
+ ## ChunkLattice.getBlockType() method
6
+
7
+ Get the block type at a specific global coordinate.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getBlockType(globalCoordinate: Vector3Like): BlockType | null;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ globalCoordinate
36
+
37
+
38
+ </td><td>
39
+
40
+ [Vector3Like](./server.vector3like.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The global coordinate of the block to get.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ [BlockType](./server.blocktype.md) \| null
53
+
54
+ The block type, null if no block is set.
55
+
@@ -84,7 +84,7 @@ Get all chunks in the lattice.
84
84
  </td></tr>
85
85
  <tr><td>
86
86
 
87
- [getBlock(globalCoordinate)](./server.chunklattice.getblock.md)
87
+ [getBlockId(globalCoordinate)](./server.chunklattice.getblockid.md)
88
88
 
89
89
 
90
90
  </td><td>
@@ -95,6 +95,20 @@ Get all chunks in the lattice.
95
95
  Get the block type id at a specific global coordinate.
96
96
 
97
97
 
98
+ </td></tr>
99
+ <tr><td>
100
+
101
+ [getBlockType(globalCoordinate)](./server.chunklattice.getblocktype.md)
102
+
103
+
104
+ </td><td>
105
+
106
+
107
+ </td><td>
108
+
109
+ Get the block type at a specific global coordinate.
110
+
111
+
98
112
  </td></tr>
99
113
  <tr><td>
100
114
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hytopia",
3
- "version": "0.1.58",
3
+ "version": "0.1.59",
4
4
  "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
5
5
  "main": "server.js",
6
6
  "bin": {
package/server.api.json CHANGED
@@ -2265,6 +2265,104 @@
2265
2265
  "isAbstract": false,
2266
2266
  "name": "getAllOneshotAudios"
2267
2267
  },
2268
+ {
2269
+ "kind": "Method",
2270
+ "canonicalReference": "server!AudioManager#unregisterAudio:member(1)",
2271
+ "docComment": "/**\n * Unregisters and stops an audio instance from the audio manager.\n *\n * @param audio - The audio instance to unregister.\n */\n",
2272
+ "excerptTokens": [
2273
+ {
2274
+ "kind": "Content",
2275
+ "text": "unregisterAudio(audio: "
2276
+ },
2277
+ {
2278
+ "kind": "Reference",
2279
+ "text": "Audio",
2280
+ "canonicalReference": "server!Audio:class"
2281
+ },
2282
+ {
2283
+ "kind": "Content",
2284
+ "text": "): "
2285
+ },
2286
+ {
2287
+ "kind": "Content",
2288
+ "text": "void"
2289
+ },
2290
+ {
2291
+ "kind": "Content",
2292
+ "text": ";"
2293
+ }
2294
+ ],
2295
+ "isStatic": false,
2296
+ "returnTypeTokenRange": {
2297
+ "startIndex": 3,
2298
+ "endIndex": 4
2299
+ },
2300
+ "releaseTag": "Public",
2301
+ "isProtected": false,
2302
+ "overloadIndex": 1,
2303
+ "parameters": [
2304
+ {
2305
+ "parameterName": "audio",
2306
+ "parameterTypeTokenRange": {
2307
+ "startIndex": 1,
2308
+ "endIndex": 2
2309
+ },
2310
+ "isOptional": false
2311
+ }
2312
+ ],
2313
+ "isOptional": false,
2314
+ "isAbstract": false,
2315
+ "name": "unregisterAudio"
2316
+ },
2317
+ {
2318
+ "kind": "Method",
2319
+ "canonicalReference": "server!AudioManager#unregisterEntityAttachedAudios:member(1)",
2320
+ "docComment": "/**\n * Unregisters and stops all audio instances attached to a specific entity.\n *\n * @param entity - The entity to unregister audio instances for.\n */\n",
2321
+ "excerptTokens": [
2322
+ {
2323
+ "kind": "Content",
2324
+ "text": "unregisterEntityAttachedAudios(entity: "
2325
+ },
2326
+ {
2327
+ "kind": "Reference",
2328
+ "text": "Entity",
2329
+ "canonicalReference": "server!Entity:class"
2330
+ },
2331
+ {
2332
+ "kind": "Content",
2333
+ "text": "): "
2334
+ },
2335
+ {
2336
+ "kind": "Content",
2337
+ "text": "void"
2338
+ },
2339
+ {
2340
+ "kind": "Content",
2341
+ "text": ";"
2342
+ }
2343
+ ],
2344
+ "isStatic": false,
2345
+ "returnTypeTokenRange": {
2346
+ "startIndex": 3,
2347
+ "endIndex": 4
2348
+ },
2349
+ "releaseTag": "Public",
2350
+ "isProtected": false,
2351
+ "overloadIndex": 1,
2352
+ "parameters": [
2353
+ {
2354
+ "parameterName": "entity",
2355
+ "parameterTypeTokenRange": {
2356
+ "startIndex": 1,
2357
+ "endIndex": 2
2358
+ },
2359
+ "isOptional": false
2360
+ }
2361
+ ],
2362
+ "isOptional": false,
2363
+ "isAbstract": false,
2364
+ "name": "unregisterEntityAttachedAudios"
2365
+ },
2268
2366
  {
2269
2367
  "kind": "Property",
2270
2368
  "canonicalReference": "server!AudioManager#world:member",
@@ -3497,6 +3595,36 @@
3497
3595
  "isProtected": false,
3498
3596
  "isAbstract": false
3499
3597
  },
3598
+ {
3599
+ "kind": "Property",
3600
+ "canonicalReference": "server!BlockType#isLiquid:member",
3601
+ "docComment": "/**\n * Whether the block type is a liquid.\n */\n",
3602
+ "excerptTokens": [
3603
+ {
3604
+ "kind": "Content",
3605
+ "text": "get isLiquid(): "
3606
+ },
3607
+ {
3608
+ "kind": "Content",
3609
+ "text": "boolean"
3610
+ },
3611
+ {
3612
+ "kind": "Content",
3613
+ "text": ";"
3614
+ }
3615
+ ],
3616
+ "isReadonly": true,
3617
+ "isOptional": false,
3618
+ "releaseTag": "Public",
3619
+ "name": "isLiquid",
3620
+ "propertyTypeTokenRange": {
3621
+ "startIndex": 1,
3622
+ "endIndex": 2
3623
+ },
3624
+ "isStatic": false,
3625
+ "isProtected": false,
3626
+ "isAbstract": false
3627
+ },
3500
3628
  {
3501
3629
  "kind": "Property",
3502
3630
  "canonicalReference": "server!BlockType#isMeshable:member",
@@ -3788,6 +3916,33 @@
3788
3916
  "endIndex": 2
3789
3917
  }
3790
3918
  },
3919
+ {
3920
+ "kind": "PropertySignature",
3921
+ "canonicalReference": "server!BlockTypeOptions#isLiquid:member",
3922
+ "docComment": "",
3923
+ "excerptTokens": [
3924
+ {
3925
+ "kind": "Content",
3926
+ "text": "isLiquid?: "
3927
+ },
3928
+ {
3929
+ "kind": "Content",
3930
+ "text": "boolean"
3931
+ },
3932
+ {
3933
+ "kind": "Content",
3934
+ "text": ";"
3935
+ }
3936
+ ],
3937
+ "isReadonly": false,
3938
+ "isOptional": true,
3939
+ "releaseTag": "Public",
3940
+ "name": "isLiquid",
3941
+ "propertyTypeTokenRange": {
3942
+ "startIndex": 1,
3943
+ "endIndex": 2
3944
+ }
3945
+ },
3791
3946
  {
3792
3947
  "kind": "PropertySignature",
3793
3948
  "canonicalReference": "server!BlockTypeOptions#name:member",
@@ -4937,12 +5092,12 @@
4937
5092
  },
4938
5093
  {
4939
5094
  "kind": "Method",
4940
- "canonicalReference": "server!Chunk#getBlock:member(1)",
5095
+ "canonicalReference": "server!Chunk#getBlockId:member(1)",
4941
5096
  "docComment": "/**\n * Get the block type id at a specific local coordinate.\n *\n * @param localCoordinate - The local coordinate of the block to get.\n *\n * @returns The block type id.\n */\n",
4942
5097
  "excerptTokens": [
4943
5098
  {
4944
5099
  "kind": "Content",
4945
- "text": "getBlock(localCoordinate: "
5100
+ "text": "getBlockId(localCoordinate: "
4946
5101
  },
4947
5102
  {
4948
5103
  "kind": "Reference",
@@ -4982,7 +5137,7 @@
4982
5137
  ],
4983
5138
  "isOptional": false,
4984
5139
  "isAbstract": false,
4985
- "name": "getBlock"
5140
+ "name": "getBlockId"
4986
5141
  },
4987
5142
  {
4988
5143
  "kind": "Method",
@@ -5853,12 +6008,12 @@
5853
6008
  },
5854
6009
  {
5855
6010
  "kind": "Method",
5856
- "canonicalReference": "server!ChunkLattice#getBlock:member(1)",
6011
+ "canonicalReference": "server!ChunkLattice#getBlockId:member(1)",
5857
6012
  "docComment": "/**\n * Get the block type id at a specific global coordinate.\n *\n * @param globalCoordinate - The global coordinate of the block to get.\n *\n * @returns The block type id, 0 if no block is set.\n */\n",
5858
6013
  "excerptTokens": [
5859
6014
  {
5860
6015
  "kind": "Content",
5861
- "text": "getBlock(globalCoordinate: "
6016
+ "text": "getBlockId(globalCoordinate: "
5862
6017
  },
5863
6018
  {
5864
6019
  "kind": "Reference",
@@ -5898,7 +6053,61 @@
5898
6053
  ],
5899
6054
  "isOptional": false,
5900
6055
  "isAbstract": false,
5901
- "name": "getBlock"
6056
+ "name": "getBlockId"
6057
+ },
6058
+ {
6059
+ "kind": "Method",
6060
+ "canonicalReference": "server!ChunkLattice#getBlockType:member(1)",
6061
+ "docComment": "/**\n * Get the block type at a specific global coordinate.\n *\n * @param globalCoordinate - The global coordinate of the block to get.\n *\n * @returns The block type, null if no block is set.\n */\n",
6062
+ "excerptTokens": [
6063
+ {
6064
+ "kind": "Content",
6065
+ "text": "getBlockType(globalCoordinate: "
6066
+ },
6067
+ {
6068
+ "kind": "Reference",
6069
+ "text": "Vector3Like",
6070
+ "canonicalReference": "server!Vector3Like:interface"
6071
+ },
6072
+ {
6073
+ "kind": "Content",
6074
+ "text": "): "
6075
+ },
6076
+ {
6077
+ "kind": "Reference",
6078
+ "text": "BlockType",
6079
+ "canonicalReference": "server!BlockType:class"
6080
+ },
6081
+ {
6082
+ "kind": "Content",
6083
+ "text": " | null"
6084
+ },
6085
+ {
6086
+ "kind": "Content",
6087
+ "text": ";"
6088
+ }
6089
+ ],
6090
+ "isStatic": false,
6091
+ "returnTypeTokenRange": {
6092
+ "startIndex": 3,
6093
+ "endIndex": 5
6094
+ },
6095
+ "releaseTag": "Public",
6096
+ "isProtected": false,
6097
+ "overloadIndex": 1,
6098
+ "parameters": [
6099
+ {
6100
+ "parameterName": "globalCoordinate",
6101
+ "parameterTypeTokenRange": {
6102
+ "startIndex": 1,
6103
+ "endIndex": 2
6104
+ },
6105
+ "isOptional": false
6106
+ }
6107
+ ],
6108
+ "isOptional": false,
6109
+ "isAbstract": false,
6110
+ "name": "getBlockType"
5902
6111
  },
5903
6112
  {
5904
6113
  "kind": "Method",