hytopia 0.10.16 → 0.10.18

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.
@@ -19,5 +19,5 @@ The persisted data for the player.
19
19
 
20
20
  ## Remarks
21
21
 
22
- This method returns the player persisted data. If it returns undefined, the player data failed to load and your game logic should handle this case appropriately. If it returns an empty object {<!-- -->}<!-- -->, the player data loaded successfully but no prior data has been set.
22
+ This method returns the player persisted data. If it returns undefined, the player data failed to load and your game logic should handle this case appropriately. If it returns an empty object, the player data loaded successfully but no prior data has been set.
23
23
 
@@ -262,27 +262,6 @@ The effective angular inertia of the rigid body.
262
262
  The effective inverse mass of the rigid body.
263
263
 
264
264
 
265
- </td></tr>
266
- <tr><td>
267
-
268
- [effectiveWorldInversePrincipalAngularInertiaSqrt](./server.rigidbody.effectiveworldinverseprincipalangularinertiasqrt.md)
269
-
270
-
271
- </td><td>
272
-
273
- `readonly`
274
-
275
-
276
- </td><td>
277
-
278
- [SpdMatrix3](./server.spdmatrix3.md) \| undefined
279
-
280
-
281
- </td><td>
282
-
283
- The effective world inverse principal angular inertia square root of the rigid body.
284
-
285
-
286
265
  </td></tr>
287
266
  <tr><td>
288
267
 
@@ -367,27 +346,6 @@ number \| undefined
367
346
  The inverse mass of the rigid body.
368
347
 
369
348
 
370
- </td></tr>
371
- <tr><td>
372
-
373
- [inversePrincipalAngularInertiaSqrt](./server.rigidbody.inverseprincipalangularinertiasqrt.md)
374
-
375
-
376
- </td><td>
377
-
378
- `readonly`
379
-
380
-
381
- </td><td>
382
-
383
- [Vector3Like](./server.vector3like.md) \| undefined
384
-
385
-
386
- </td><td>
387
-
388
- The inverse principal angular inertia square root of the rigid body.
389
-
390
-
391
349
  </td></tr>
392
350
  <tr><td>
393
351
 
@@ -733,6 +733,20 @@ Sets the minimum distance from the camera to start applying fog.
733
733
  Sets the intensity of the world's skybox brightness.
734
734
 
735
735
 
736
+ </td></tr>
737
+ <tr><td>
738
+
739
+ [setSkyboxUri(skyboxUri)](./server.world.setskyboxuri.md)
740
+
741
+
742
+ </td><td>
743
+
744
+
745
+ </td><td>
746
+
747
+ Sets the cubemap URI of the world's skybox.
748
+
749
+
736
750
  </td></tr>
737
751
  <tr><td>
738
752
 
@@ -0,0 +1,54 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [World](./server.world.md) &gt; [setSkyboxUri](./server.world.setskyboxuri.md)
4
+
5
+ ## World.setSkyboxUri() method
6
+
7
+ Sets the cubemap URI of the world's skybox.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setSkyboxUri(skyboxUri: string): 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
+ skyboxUri
36
+
37
+
38
+ </td><td>
39
+
40
+ string
41
+
42
+
43
+ </td><td>
44
+
45
+ The cubemap URI of the skybox.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+
51
+ **Returns:**
52
+
53
+ void
54
+
@@ -155,6 +155,20 @@ SET\_SKYBOX\_INTENSITY
155
155
  </td><td>
156
156
 
157
157
 
158
+ </td></tr>
159
+ <tr><td>
160
+
161
+ SET\_SKYBOX\_URI
162
+
163
+
164
+ </td><td>
165
+
166
+ `"WORLD.SET_SKYBOX_URI"`
167
+
168
+
169
+ </td><td>
170
+
171
+
158
172
  </td></tr>
159
173
  <tr><td>
160
174
 
@@ -0,0 +1,16 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.SET\_SKYBOX\_URI"](./server.worldeventpayloads._world.set_skybox_uri_.md)
4
+
5
+ ## WorldEventPayloads."WORLD.SET\_SKYBOX\_URI" property
6
+
7
+ Emitted when the URI of the world's skybox is set.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ [WorldEvent.SET_SKYBOX_URI]: {
13
+ world: World;
14
+ uri: string;
15
+ };
16
+ ```
@@ -205,6 +205,25 @@ Emitted when the density of the world's fog is set.
205
205
  Emitted when the intensity of the world's skybox brightness is set.
206
206
 
207
207
 
208
+ </td></tr>
209
+ <tr><td>
210
+
211
+ ["WORLD.SET\_SKYBOX\_URI"](./server.worldeventpayloads._world.set_skybox_uri_.md)
212
+
213
+
214
+ </td><td>
215
+
216
+
217
+ </td><td>
218
+
219
+ { world: [World](./server.world.md)<!-- -->; uri: string; }
220
+
221
+
222
+ </td><td>
223
+
224
+ Emitted when the URI of the world's skybox is set.
225
+
226
+
208
227
  </td></tr>
209
228
  <tr><td>
210
229
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hytopia",
3
- "version": "0.10.16",
3
+ "version": "0.10.18",
4
4
  "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
5
5
  "type": "module",
6
6
  "main": "./server.mjs",
package/server.api.json CHANGED
@@ -35578,7 +35578,7 @@
35578
35578
  {
35579
35579
  "kind": "Method",
35580
35580
  "canonicalReference": "server!Player#getPersistedData:member(1)",
35581
- "docComment": "/**\n * Get the persisted data for the player.\n *\n * @remarks\n *\n * This method returns the player persisted data. If it returns undefined, the player data failed to load and your game logic should handle this case appropriately. If it returns an empty object {}, the player data loaded successfully but no prior data has been set.\n *\n * @returns The persisted data for the player.\n */\n",
35581
+ "docComment": "/**\n * Get the persisted data for the player.\n *\n * @remarks\n *\n * This method returns the player persisted data. If it returns undefined, the player data failed to load and your game logic should handle this case appropriately. If it returns an empty object, the player data loaded successfully but no prior data has been set.\n *\n * @returns The persisted data for the player.\n */\n",
35582
35582
  "excerptTokens": [
35583
35583
  {
35584
35584
  "kind": "Content",
@@ -43046,41 +43046,6 @@
43046
43046
  "isProtected": false,
43047
43047
  "isAbstract": false
43048
43048
  },
43049
- {
43050
- "kind": "Property",
43051
- "canonicalReference": "server!RigidBody#effectiveWorldInversePrincipalAngularInertiaSqrt:member",
43052
- "docComment": "/**\n * The effective world inverse principal angular inertia square root of the rigid body.\n */\n",
43053
- "excerptTokens": [
43054
- {
43055
- "kind": "Content",
43056
- "text": "get effectiveWorldInversePrincipalAngularInertiaSqrt(): "
43057
- },
43058
- {
43059
- "kind": "Reference",
43060
- "text": "SpdMatrix3",
43061
- "canonicalReference": "server!SpdMatrix3:interface"
43062
- },
43063
- {
43064
- "kind": "Content",
43065
- "text": " | undefined"
43066
- },
43067
- {
43068
- "kind": "Content",
43069
- "text": ";"
43070
- }
43071
- ],
43072
- "isReadonly": true,
43073
- "isOptional": false,
43074
- "releaseTag": "Public",
43075
- "name": "effectiveWorldInversePrincipalAngularInertiaSqrt",
43076
- "propertyTypeTokenRange": {
43077
- "startIndex": 1,
43078
- "endIndex": 3
43079
- },
43080
- "isStatic": false,
43081
- "isProtected": false,
43082
- "isAbstract": false
43083
- },
43084
43049
  {
43085
43050
  "kind": "Property",
43086
43051
  "canonicalReference": "server!RigidBody#enabledPositions:member",
@@ -43256,41 +43221,6 @@
43256
43221
  "isProtected": false,
43257
43222
  "isAbstract": false
43258
43223
  },
43259
- {
43260
- "kind": "Property",
43261
- "canonicalReference": "server!RigidBody#inversePrincipalAngularInertiaSqrt:member",
43262
- "docComment": "/**\n * The inverse principal angular inertia square root of the rigid body.\n */\n",
43263
- "excerptTokens": [
43264
- {
43265
- "kind": "Content",
43266
- "text": "get inversePrincipalAngularInertiaSqrt(): "
43267
- },
43268
- {
43269
- "kind": "Reference",
43270
- "text": "Vector3Like",
43271
- "canonicalReference": "server!Vector3Like:interface"
43272
- },
43273
- {
43274
- "kind": "Content",
43275
- "text": " | undefined"
43276
- },
43277
- {
43278
- "kind": "Content",
43279
- "text": ";"
43280
- }
43281
- ],
43282
- "isReadonly": true,
43283
- "isOptional": false,
43284
- "releaseTag": "Public",
43285
- "name": "inversePrincipalAngularInertiaSqrt",
43286
- "propertyTypeTokenRange": {
43287
- "startIndex": 1,
43288
- "endIndex": 3
43289
- },
43290
- "isStatic": false,
43291
- "isProtected": false,
43292
- "isAbstract": false
43293
- },
43294
43224
  {
43295
43225
  "kind": "Property",
43296
43226
  "canonicalReference": "server!RigidBody#isCcdEnabled:member",
@@ -55091,6 +55021,54 @@
55091
55021
  "isAbstract": false,
55092
55022
  "name": "setSkyboxIntensity"
55093
55023
  },
55024
+ {
55025
+ "kind": "Method",
55026
+ "canonicalReference": "server!World#setSkyboxUri:member(1)",
55027
+ "docComment": "/**\n * Sets the cubemap URI of the world's skybox.\n *\n * @param skyboxUri - The cubemap URI of the skybox.\n */\n",
55028
+ "excerptTokens": [
55029
+ {
55030
+ "kind": "Content",
55031
+ "text": "setSkyboxUri(skyboxUri: "
55032
+ },
55033
+ {
55034
+ "kind": "Content",
55035
+ "text": "string"
55036
+ },
55037
+ {
55038
+ "kind": "Content",
55039
+ "text": "): "
55040
+ },
55041
+ {
55042
+ "kind": "Content",
55043
+ "text": "void"
55044
+ },
55045
+ {
55046
+ "kind": "Content",
55047
+ "text": ";"
55048
+ }
55049
+ ],
55050
+ "isStatic": false,
55051
+ "returnTypeTokenRange": {
55052
+ "startIndex": 3,
55053
+ "endIndex": 4
55054
+ },
55055
+ "releaseTag": "Public",
55056
+ "isProtected": false,
55057
+ "overloadIndex": 1,
55058
+ "parameters": [
55059
+ {
55060
+ "parameterName": "skyboxUri",
55061
+ "parameterTypeTokenRange": {
55062
+ "startIndex": 1,
55063
+ "endIndex": 2
55064
+ },
55065
+ "isOptional": false
55066
+ }
55067
+ ],
55068
+ "isOptional": false,
55069
+ "isAbstract": false,
55070
+ "name": "setSkyboxUri"
55071
+ },
55094
55072
  {
55095
55073
  "kind": "Property",
55096
55074
  "canonicalReference": "server!World#simulation:member",
@@ -55490,6 +55468,27 @@
55490
55468
  "releaseTag": "Public",
55491
55469
  "name": "SET_SKYBOX_INTENSITY"
55492
55470
  },
55471
+ {
55472
+ "kind": "EnumMember",
55473
+ "canonicalReference": "server!WorldEvent.SET_SKYBOX_URI:member",
55474
+ "docComment": "",
55475
+ "excerptTokens": [
55476
+ {
55477
+ "kind": "Content",
55478
+ "text": "SET_SKYBOX_URI = "
55479
+ },
55480
+ {
55481
+ "kind": "Content",
55482
+ "text": "\"WORLD.SET_SKYBOX_URI\""
55483
+ }
55484
+ ],
55485
+ "initializerTokenRange": {
55486
+ "startIndex": 1,
55487
+ "endIndex": 2
55488
+ },
55489
+ "releaseTag": "Public",
55490
+ "name": "SET_SKYBOX_URI"
55491
+ },
55493
55492
  {
55494
55493
  "kind": "EnumMember",
55495
55494
  "canonicalReference": "server!WorldEvent.START:member",
@@ -55990,6 +55989,51 @@
55990
55989
  "endIndex": 6
55991
55990
  }
55992
55991
  },
55992
+ {
55993
+ "kind": "PropertySignature",
55994
+ "canonicalReference": "server!WorldEventPayloads#\"WORLD.SET_SKYBOX_URI\":member",
55995
+ "docComment": "/**\n * Emitted when the URI of the world's skybox is set.\n */\n",
55996
+ "excerptTokens": [
55997
+ {
55998
+ "kind": "Content",
55999
+ "text": "["
56000
+ },
56001
+ {
56002
+ "kind": "Reference",
56003
+ "text": "WorldEvent.SET_SKYBOX_URI",
56004
+ "canonicalReference": "server!WorldEvent.SET_SKYBOX_URI:member"
56005
+ },
56006
+ {
56007
+ "kind": "Content",
56008
+ "text": "]: "
56009
+ },
56010
+ {
56011
+ "kind": "Content",
56012
+ "text": "{\n world: "
56013
+ },
56014
+ {
56015
+ "kind": "Reference",
56016
+ "text": "World",
56017
+ "canonicalReference": "server!World:class"
56018
+ },
56019
+ {
56020
+ "kind": "Content",
56021
+ "text": ";\n uri: string;\n }"
56022
+ },
56023
+ {
56024
+ "kind": "Content",
56025
+ "text": ";"
56026
+ }
56027
+ ],
56028
+ "isReadonly": false,
56029
+ "isOptional": false,
56030
+ "releaseTag": "Public",
56031
+ "name": "\"WORLD.SET_SKYBOX_URI\"",
56032
+ "propertyTypeTokenRange": {
56033
+ "startIndex": 3,
56034
+ "endIndex": 6
56035
+ }
56036
+ },
55993
56037
  {
55994
56038
  "kind": "PropertySignature",
55995
56039
  "canonicalReference": "server!WorldEventPayloads#\"WORLD.START\":member",
package/server.d.ts CHANGED
@@ -4407,7 +4407,7 @@ export declare class Player extends EventRouter implements protocol.Serializable
4407
4407
  * This method returns the player persisted data. If it returns
4408
4408
  * undefined, the player data failed to load and your game
4409
4409
  * logic should handle this case appropriately. If it returns
4410
- * an empty object {}, the player data loaded successfully but
4410
+ * an empty object, the player data loaded successfully but
4411
4411
  * no prior data has been set.
4412
4412
  *
4413
4413
  * @returns The persisted data for the player.
@@ -5310,8 +5310,6 @@ export declare class RigidBody extends EventRouter {
5310
5310
  get effectiveAngularInertia(): SpdMatrix3 | undefined;
5311
5311
  /** The effective inverse mass of the rigid body. */
5312
5312
  get effectiveInverseMass(): Vector3Like | undefined;
5313
- /** The effective world inverse principal angular inertia square root of the rigid body. */
5314
- get effectiveWorldInversePrincipalAngularInertiaSqrt(): SpdMatrix3 | undefined;
5315
5313
  /** The enabled axes of rotational movement of the rigid body. */
5316
5314
  get enabledRotations(): Vector3Boolean;
5317
5315
  /** The enabled axes of positional movement of the rigid body. */
@@ -5320,8 +5318,6 @@ export declare class RigidBody extends EventRouter {
5320
5318
  get gravityScale(): number;
5321
5319
  /** The inverse mass of the rigid body. */
5322
5320
  get inverseMass(): number | undefined;
5323
- /** The inverse principal angular inertia square root of the rigid body. */
5324
- get inversePrincipalAngularInertiaSqrt(): Vector3Like | undefined;
5325
5321
  /** Whether the rigid body has continuous collision detection enabled. */
5326
5322
  get isCcdEnabled(): boolean;
5327
5323
  /** Whether the rigid body is dynamic. */
@@ -6982,6 +6978,11 @@ export declare class World extends EventRouter implements protocol.Serializable
6982
6978
  * @param intensity - The intensity.
6983
6979
  */
6984
6980
  setSkyboxIntensity(intensity: number): void;
6981
+ /**
6982
+ * Sets the cubemap URI of the world's skybox.
6983
+ * @param skyboxUri - The cubemap URI of the skybox.
6984
+ */
6985
+ setSkyboxUri(skyboxUri: string): void;
6985
6986
  /**
6986
6987
  * Starts the world loop, which begins ticking physics, entities, etc.
6987
6988
  */
@@ -7004,6 +7005,7 @@ export declare enum WorldEvent {
7004
7005
  SET_FOG_FAR = "WORLD.SET_FOG_FAR",
7005
7006
  SET_FOG_NEAR = "WORLD.SET_FOG_NEAR",
7006
7007
  SET_SKYBOX_INTENSITY = "WORLD.SET_SKYBOX_INTENSITY",
7008
+ SET_SKYBOX_URI = "WORLD.SET_SKYBOX_URI",
7007
7009
  START = "WORLD.START",
7008
7010
  STOP = "WORLD.STOP"
7009
7011
  }
@@ -7055,6 +7057,11 @@ export declare interface WorldEventPayloads {
7055
7057
  world: World;
7056
7058
  intensity: number;
7057
7059
  };
7060
+ /** Emitted when the URI of the world's skybox is set. */
7061
+ [WorldEvent.SET_SKYBOX_URI]: {
7062
+ world: World;
7063
+ uri: string;
7064
+ };
7058
7065
  /** Emitted when the world starts. */
7059
7066
  [WorldEvent.START]: {
7060
7067
  world: World;