hytopia 0.1.59 → 0.1.61

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 (65) hide show
  1. package/boilerplate/assets/map.json +2 -1
  2. package/docs/server.audio._constructor_.md +2 -0
  3. package/docs/server.audio.setattachedtoentity.md +1 -1
  4. package/docs/server.audiomanager.unregisteraudio.md +1 -1
  5. package/docs/server.audiomanager.unregisterentityattachedaudios.md +1 -1
  6. package/docs/server.blocktypeoptions.customcollideroptions.md +2 -0
  7. package/docs/server.blocktypeoptions.id.md +2 -0
  8. package/docs/server.blocktypeoptions.isliquid.md +2 -0
  9. package/docs/server.blocktypeoptions.md +8 -2
  10. package/docs/server.blocktypeoptions.name.md +2 -0
  11. package/docs/server.blocktypeoptions.textureuri.md +2 -0
  12. package/docs/server.collisiongroup.md +168 -0
  13. package/docs/server.entity.md +35 -0
  14. package/docs/server.entity.opacity.md +13 -0
  15. package/docs/server.entity.setopacity.md +53 -0
  16. package/docs/server.entityeventpayload.md +9 -0
  17. package/docs/server.entityeventpayload.setopacity.entity.md +11 -0
  18. package/docs/server.entityeventpayload.setopacity.md +70 -0
  19. package/docs/server.entityeventpayload.setopacity.opacity.md +11 -0
  20. package/docs/server.entityeventtype.md +14 -0
  21. package/docs/server.entityoptions.md +19 -0
  22. package/docs/server.entityoptions.opacity.md +13 -0
  23. package/docs/server.md +33 -0
  24. package/docs/server.playerentitycontroller.md +19 -0
  25. package/docs/server.playerentitycontroller.stickstoplatforms.md +13 -0
  26. package/docs/server.playerentitycontrolleroptions.md +19 -0
  27. package/docs/server.playerentitycontrolleroptions.stickstoplatforms.md +13 -0
  28. package/docs/server.sceneui._constructor_.md +49 -0
  29. package/docs/server.sceneui.attachedtoentity.md +11 -0
  30. package/docs/server.sceneui.id.md +11 -0
  31. package/docs/server.sceneui.isloaded.md +11 -0
  32. package/docs/server.sceneui.load.md +53 -0
  33. package/docs/server.sceneui.md +344 -0
  34. package/docs/server.sceneui.offset.md +11 -0
  35. package/docs/server.sceneui.position.md +11 -0
  36. package/docs/server.sceneui.setattachedtoentity.md +53 -0
  37. package/docs/server.sceneui.setoffset.md +53 -0
  38. package/docs/server.sceneui.setposition.md +53 -0
  39. package/docs/server.sceneui.setstate.md +53 -0
  40. package/docs/server.sceneui.state.md +11 -0
  41. package/docs/server.sceneui.templateid.md +11 -0
  42. package/docs/server.sceneui.unload.md +17 -0
  43. package/docs/server.sceneui.world.md +11 -0
  44. package/docs/server.sceneuimanager.getallentityattachedsceneuis.md +55 -0
  45. package/docs/server.sceneuimanager.getallsceneuis.md +19 -0
  46. package/docs/server.sceneuimanager.md +127 -0
  47. package/docs/server.sceneuimanager.unloadentityattachedsceneuis.md +53 -0
  48. package/docs/server.sceneuimanager.world.md +13 -0
  49. package/docs/server.sceneuioptions.attachedtoentity.md +13 -0
  50. package/docs/server.sceneuioptions.md +133 -0
  51. package/docs/server.sceneuioptions.offset.md +13 -0
  52. package/docs/server.sceneuioptions.position.md +13 -0
  53. package/docs/server.sceneuioptions.state.md +13 -0
  54. package/docs/server.sceneuioptions.templateid.md +13 -0
  55. package/docs/server.world.md +21 -0
  56. package/docs/server.world.sceneuimanager.md +13 -0
  57. package/examples/wall-dodge-game/assets/map.json +3995 -0
  58. package/examples/wall-dodge-game/assets/textures/water.png +0 -0
  59. package/examples/wall-dodge-game/assets/ui/index.html +249 -0
  60. package/examples/wall-dodge-game/index.ts +336 -0
  61. package/examples/wall-dodge-game/package.json +15 -0
  62. package/package.json +1 -1
  63. package/server.api.json +1534 -45
  64. package/server.d.ts +188 -16
  65. package/server.js +83 -83
package/server.api.json CHANGED
@@ -201,7 +201,7 @@
201
201
  {
202
202
  "kind": "Constructor",
203
203
  "canonicalReference": "server!Audio:constructor(1)",
204
- "docComment": "/**\n * Constructs a new instance of the `Audio` class\n *\n * @param audioData - The options for the audio instance.\n */\n",
204
+ "docComment": "/**\n * Constructs a new instance of the `Audio` class\n *\n * @param options - The options for the Audio instance.\n */\n",
205
205
  "excerptTokens": [
206
206
  {
207
207
  "kind": "Content",
@@ -730,7 +730,7 @@
730
730
  {
731
731
  "kind": "Method",
732
732
  "canonicalReference": "server!Audio#setAttachedToEntity:member(1)",
733
- "docComment": "/**\n * Sets the entity to which the audio is attached, following its position.\n *\n * @param entity - The entity to attach the audio to.\n */\n",
733
+ "docComment": "/**\n * Sets the entity to which the audio is attached, following its position.\n *\n * @param entity - The entity to attach the Audio to.\n */\n",
734
734
  "excerptTokens": [
735
735
  {
736
736
  "kind": "Content",
@@ -2268,7 +2268,7 @@
2268
2268
  {
2269
2269
  "kind": "Method",
2270
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",
2271
+ "docComment": "/**\n * Unregisters and stops an audio instance from the audio manager.\n *\n * @param audio - The audio instance to pause and unregister.\n */\n",
2272
2272
  "excerptTokens": [
2273
2273
  {
2274
2274
  "kind": "Content",
@@ -2317,7 +2317,7 @@
2317
2317
  {
2318
2318
  "kind": "Method",
2319
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",
2320
+ "docComment": "/**\n * Unregisters and stops all audio instances attached to a specific entity.\n *\n * @param entity - The entity to pause and unregister audio instances for.\n */\n",
2321
2321
  "excerptTokens": [
2322
2322
  {
2323
2323
  "kind": "Content",
@@ -3864,7 +3864,7 @@
3864
3864
  {
3865
3865
  "kind": "PropertySignature",
3866
3866
  "canonicalReference": "server!BlockTypeOptions#customColliderOptions:member",
3867
- "docComment": "",
3867
+ "docComment": "/**\n * The custom collider options for the block type.\n */\n",
3868
3868
  "excerptTokens": [
3869
3869
  {
3870
3870
  "kind": "Content",
@@ -3892,7 +3892,7 @@
3892
3892
  {
3893
3893
  "kind": "PropertySignature",
3894
3894
  "canonicalReference": "server!BlockTypeOptions#id:member",
3895
- "docComment": "",
3895
+ "docComment": "/**\n * The unique numeric identifier for the block type.\n */\n",
3896
3896
  "excerptTokens": [
3897
3897
  {
3898
3898
  "kind": "Content",
@@ -3919,7 +3919,7 @@
3919
3919
  {
3920
3920
  "kind": "PropertySignature",
3921
3921
  "canonicalReference": "server!BlockTypeOptions#isLiquid:member",
3922
- "docComment": "",
3922
+ "docComment": "/**\n * Whether the block type is a liquid.\n */\n",
3923
3923
  "excerptTokens": [
3924
3924
  {
3925
3925
  "kind": "Content",
@@ -3946,7 +3946,7 @@
3946
3946
  {
3947
3947
  "kind": "PropertySignature",
3948
3948
  "canonicalReference": "server!BlockTypeOptions#name:member",
3949
- "docComment": "",
3949
+ "docComment": "/**\n * The name of the block type.\n */\n",
3950
3950
  "excerptTokens": [
3951
3951
  {
3952
3952
  "kind": "Content",
@@ -3973,7 +3973,7 @@
3973
3973
  {
3974
3974
  "kind": "PropertySignature",
3975
3975
  "canonicalReference": "server!BlockTypeOptions#textureUri:member",
3976
- "docComment": "",
3976
+ "docComment": "/**\n * The URI of the texture asset for the block type.\n */\n",
3977
3977
  "excerptTokens": [
3978
3978
  {
3979
3979
  "kind": "Content",
@@ -8649,6 +8649,258 @@
8649
8649
  "releaseTag": "Public",
8650
8650
  "name": "ENTITY_SENSOR"
8651
8651
  },
8652
+ {
8653
+ "kind": "EnumMember",
8654
+ "canonicalReference": "server!CollisionGroup.GROUP_1:member",
8655
+ "docComment": "",
8656
+ "excerptTokens": [
8657
+ {
8658
+ "kind": "Content",
8659
+ "text": "GROUP_1 = "
8660
+ },
8661
+ {
8662
+ "kind": "Content",
8663
+ "text": "16"
8664
+ }
8665
+ ],
8666
+ "initializerTokenRange": {
8667
+ "startIndex": 1,
8668
+ "endIndex": 2
8669
+ },
8670
+ "releaseTag": "Public",
8671
+ "name": "GROUP_1"
8672
+ },
8673
+ {
8674
+ "kind": "EnumMember",
8675
+ "canonicalReference": "server!CollisionGroup.GROUP_10:member",
8676
+ "docComment": "",
8677
+ "excerptTokens": [
8678
+ {
8679
+ "kind": "Content",
8680
+ "text": "GROUP_10 = "
8681
+ },
8682
+ {
8683
+ "kind": "Content",
8684
+ "text": "8192"
8685
+ }
8686
+ ],
8687
+ "initializerTokenRange": {
8688
+ "startIndex": 1,
8689
+ "endIndex": 2
8690
+ },
8691
+ "releaseTag": "Public",
8692
+ "name": "GROUP_10"
8693
+ },
8694
+ {
8695
+ "kind": "EnumMember",
8696
+ "canonicalReference": "server!CollisionGroup.GROUP_11:member",
8697
+ "docComment": "",
8698
+ "excerptTokens": [
8699
+ {
8700
+ "kind": "Content",
8701
+ "text": "GROUP_11 = "
8702
+ },
8703
+ {
8704
+ "kind": "Content",
8705
+ "text": "16384"
8706
+ }
8707
+ ],
8708
+ "initializerTokenRange": {
8709
+ "startIndex": 1,
8710
+ "endIndex": 2
8711
+ },
8712
+ "releaseTag": "Public",
8713
+ "name": "GROUP_11"
8714
+ },
8715
+ {
8716
+ "kind": "EnumMember",
8717
+ "canonicalReference": "server!CollisionGroup.GROUP_12:member",
8718
+ "docComment": "",
8719
+ "excerptTokens": [
8720
+ {
8721
+ "kind": "Content",
8722
+ "text": "GROUP_12 = "
8723
+ },
8724
+ {
8725
+ "kind": "Content",
8726
+ "text": "32768"
8727
+ }
8728
+ ],
8729
+ "initializerTokenRange": {
8730
+ "startIndex": 1,
8731
+ "endIndex": 2
8732
+ },
8733
+ "releaseTag": "Public",
8734
+ "name": "GROUP_12"
8735
+ },
8736
+ {
8737
+ "kind": "EnumMember",
8738
+ "canonicalReference": "server!CollisionGroup.GROUP_2:member",
8739
+ "docComment": "",
8740
+ "excerptTokens": [
8741
+ {
8742
+ "kind": "Content",
8743
+ "text": "GROUP_2 = "
8744
+ },
8745
+ {
8746
+ "kind": "Content",
8747
+ "text": "32"
8748
+ }
8749
+ ],
8750
+ "initializerTokenRange": {
8751
+ "startIndex": 1,
8752
+ "endIndex": 2
8753
+ },
8754
+ "releaseTag": "Public",
8755
+ "name": "GROUP_2"
8756
+ },
8757
+ {
8758
+ "kind": "EnumMember",
8759
+ "canonicalReference": "server!CollisionGroup.GROUP_3:member",
8760
+ "docComment": "",
8761
+ "excerptTokens": [
8762
+ {
8763
+ "kind": "Content",
8764
+ "text": "GROUP_3 = "
8765
+ },
8766
+ {
8767
+ "kind": "Content",
8768
+ "text": "64"
8769
+ }
8770
+ ],
8771
+ "initializerTokenRange": {
8772
+ "startIndex": 1,
8773
+ "endIndex": 2
8774
+ },
8775
+ "releaseTag": "Public",
8776
+ "name": "GROUP_3"
8777
+ },
8778
+ {
8779
+ "kind": "EnumMember",
8780
+ "canonicalReference": "server!CollisionGroup.GROUP_4:member",
8781
+ "docComment": "",
8782
+ "excerptTokens": [
8783
+ {
8784
+ "kind": "Content",
8785
+ "text": "GROUP_4 = "
8786
+ },
8787
+ {
8788
+ "kind": "Content",
8789
+ "text": "128"
8790
+ }
8791
+ ],
8792
+ "initializerTokenRange": {
8793
+ "startIndex": 1,
8794
+ "endIndex": 2
8795
+ },
8796
+ "releaseTag": "Public",
8797
+ "name": "GROUP_4"
8798
+ },
8799
+ {
8800
+ "kind": "EnumMember",
8801
+ "canonicalReference": "server!CollisionGroup.GROUP_5:member",
8802
+ "docComment": "",
8803
+ "excerptTokens": [
8804
+ {
8805
+ "kind": "Content",
8806
+ "text": "GROUP_5 = "
8807
+ },
8808
+ {
8809
+ "kind": "Content",
8810
+ "text": "256"
8811
+ }
8812
+ ],
8813
+ "initializerTokenRange": {
8814
+ "startIndex": 1,
8815
+ "endIndex": 2
8816
+ },
8817
+ "releaseTag": "Public",
8818
+ "name": "GROUP_5"
8819
+ },
8820
+ {
8821
+ "kind": "EnumMember",
8822
+ "canonicalReference": "server!CollisionGroup.GROUP_6:member",
8823
+ "docComment": "",
8824
+ "excerptTokens": [
8825
+ {
8826
+ "kind": "Content",
8827
+ "text": "GROUP_6 = "
8828
+ },
8829
+ {
8830
+ "kind": "Content",
8831
+ "text": "512"
8832
+ }
8833
+ ],
8834
+ "initializerTokenRange": {
8835
+ "startIndex": 1,
8836
+ "endIndex": 2
8837
+ },
8838
+ "releaseTag": "Public",
8839
+ "name": "GROUP_6"
8840
+ },
8841
+ {
8842
+ "kind": "EnumMember",
8843
+ "canonicalReference": "server!CollisionGroup.GROUP_7:member",
8844
+ "docComment": "",
8845
+ "excerptTokens": [
8846
+ {
8847
+ "kind": "Content",
8848
+ "text": "GROUP_7 = "
8849
+ },
8850
+ {
8851
+ "kind": "Content",
8852
+ "text": "1024"
8853
+ }
8854
+ ],
8855
+ "initializerTokenRange": {
8856
+ "startIndex": 1,
8857
+ "endIndex": 2
8858
+ },
8859
+ "releaseTag": "Public",
8860
+ "name": "GROUP_7"
8861
+ },
8862
+ {
8863
+ "kind": "EnumMember",
8864
+ "canonicalReference": "server!CollisionGroup.GROUP_8:member",
8865
+ "docComment": "",
8866
+ "excerptTokens": [
8867
+ {
8868
+ "kind": "Content",
8869
+ "text": "GROUP_8 = "
8870
+ },
8871
+ {
8872
+ "kind": "Content",
8873
+ "text": "2048"
8874
+ }
8875
+ ],
8876
+ "initializerTokenRange": {
8877
+ "startIndex": 1,
8878
+ "endIndex": 2
8879
+ },
8880
+ "releaseTag": "Public",
8881
+ "name": "GROUP_8"
8882
+ },
8883
+ {
8884
+ "kind": "EnumMember",
8885
+ "canonicalReference": "server!CollisionGroup.GROUP_9:member",
8886
+ "docComment": "",
8887
+ "excerptTokens": [
8888
+ {
8889
+ "kind": "Content",
8890
+ "text": "GROUP_9 = "
8891
+ },
8892
+ {
8893
+ "kind": "Content",
8894
+ "text": "4096"
8895
+ }
8896
+ ],
8897
+ "initializerTokenRange": {
8898
+ "startIndex": 1,
8899
+ "endIndex": 2
8900
+ },
8901
+ "releaseTag": "Public",
8902
+ "name": "GROUP_9"
8903
+ },
8652
8904
  {
8653
8905
  "kind": "EnumMember",
8654
8906
  "canonicalReference": "server!CollisionGroup.PLAYER:member",
@@ -10011,6 +10263,36 @@
10011
10263
  "isProtected": false,
10012
10264
  "isAbstract": false
10013
10265
  },
10266
+ {
10267
+ "kind": "Property",
10268
+ "canonicalReference": "server!Entity#opacity:member",
10269
+ "docComment": "/**\n * The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.\n */\n",
10270
+ "excerptTokens": [
10271
+ {
10272
+ "kind": "Content",
10273
+ "text": "get opacity(): "
10274
+ },
10275
+ {
10276
+ "kind": "Content",
10277
+ "text": "number | undefined"
10278
+ },
10279
+ {
10280
+ "kind": "Content",
10281
+ "text": ";"
10282
+ }
10283
+ ],
10284
+ "isReadonly": true,
10285
+ "isOptional": false,
10286
+ "releaseTag": "Public",
10287
+ "name": "opacity",
10288
+ "propertyTypeTokenRange": {
10289
+ "startIndex": 1,
10290
+ "endIndex": 2
10291
+ },
10292
+ "isStatic": false,
10293
+ "isProtected": false,
10294
+ "isAbstract": false
10295
+ },
10014
10296
  {
10015
10297
  "kind": "Method",
10016
10298
  "canonicalReference": "server!Entity#setController:member(1)",
@@ -10162,21 +10444,16 @@
10162
10444
  },
10163
10445
  {
10164
10446
  "kind": "Method",
10165
- "canonicalReference": "server!Entity#setTintColor:member(1)",
10166
- "docComment": "/**\n * Sets the tint color of the entity.\n *\n * @param tintColor - The tint color of the entity.\n */\n",
10447
+ "canonicalReference": "server!Entity#setOpacity:member(1)",
10448
+ "docComment": "/**\n * Sets the opacity of the entity.\n *\n * @param opacity - The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.\n */\n",
10167
10449
  "excerptTokens": [
10168
10450
  {
10169
10451
  "kind": "Content",
10170
- "text": "setTintColor(tintColor: "
10171
- },
10172
- {
10173
- "kind": "Reference",
10174
- "text": "RgbColor",
10175
- "canonicalReference": "server!RgbColor:interface"
10452
+ "text": "setOpacity(opacity: "
10176
10453
  },
10177
10454
  {
10178
10455
  "kind": "Content",
10179
- "text": " | undefined"
10456
+ "text": "number"
10180
10457
  },
10181
10458
  {
10182
10459
  "kind": "Content",
@@ -10193,29 +10470,82 @@
10193
10470
  ],
10194
10471
  "isStatic": false,
10195
10472
  "returnTypeTokenRange": {
10196
- "startIndex": 4,
10197
- "endIndex": 5
10473
+ "startIndex": 3,
10474
+ "endIndex": 4
10198
10475
  },
10199
10476
  "releaseTag": "Public",
10200
10477
  "isProtected": false,
10201
10478
  "overloadIndex": 1,
10202
10479
  "parameters": [
10203
10480
  {
10204
- "parameterName": "tintColor",
10481
+ "parameterName": "opacity",
10205
10482
  "parameterTypeTokenRange": {
10206
10483
  "startIndex": 1,
10207
- "endIndex": 3
10484
+ "endIndex": 2
10208
10485
  },
10209
10486
  "isOptional": false
10210
10487
  }
10211
10488
  ],
10212
10489
  "isOptional": false,
10213
10490
  "isAbstract": false,
10214
- "name": "setTintColor"
10491
+ "name": "setOpacity"
10215
10492
  },
10216
10493
  {
10217
10494
  "kind": "Method",
10218
- "canonicalReference": "server!Entity#spawn:member(1)",
10495
+ "canonicalReference": "server!Entity#setTintColor:member(1)",
10496
+ "docComment": "/**\n * Sets the tint color of the entity.\n *\n * @param tintColor - The tint color of the entity.\n */\n",
10497
+ "excerptTokens": [
10498
+ {
10499
+ "kind": "Content",
10500
+ "text": "setTintColor(tintColor: "
10501
+ },
10502
+ {
10503
+ "kind": "Reference",
10504
+ "text": "RgbColor",
10505
+ "canonicalReference": "server!RgbColor:interface"
10506
+ },
10507
+ {
10508
+ "kind": "Content",
10509
+ "text": " | undefined"
10510
+ },
10511
+ {
10512
+ "kind": "Content",
10513
+ "text": "): "
10514
+ },
10515
+ {
10516
+ "kind": "Content",
10517
+ "text": "void"
10518
+ },
10519
+ {
10520
+ "kind": "Content",
10521
+ "text": ";"
10522
+ }
10523
+ ],
10524
+ "isStatic": false,
10525
+ "returnTypeTokenRange": {
10526
+ "startIndex": 4,
10527
+ "endIndex": 5
10528
+ },
10529
+ "releaseTag": "Public",
10530
+ "isProtected": false,
10531
+ "overloadIndex": 1,
10532
+ "parameters": [
10533
+ {
10534
+ "parameterName": "tintColor",
10535
+ "parameterTypeTokenRange": {
10536
+ "startIndex": 1,
10537
+ "endIndex": 3
10538
+ },
10539
+ "isOptional": false
10540
+ }
10541
+ ],
10542
+ "isOptional": false,
10543
+ "isAbstract": false,
10544
+ "name": "setTintColor"
10545
+ },
10546
+ {
10547
+ "kind": "Method",
10548
+ "canonicalReference": "server!Entity#spawn:member(1)",
10219
10549
  "docComment": "/**\n * Spawns the entity in the world.\n *\n * @param world - The world to spawn the entity in.\n *\n * @param coordinate - The coordinate to spawn the entity at.\n */\n",
10220
10550
  "excerptTokens": [
10221
10551
  {
@@ -10744,6 +11074,78 @@
10744
11074
  ],
10745
11075
  "extendsTokenRanges": []
10746
11076
  },
11077
+ {
11078
+ "kind": "Interface",
11079
+ "canonicalReference": "server!EntityEventPayload.SetOpacity:interface",
11080
+ "docComment": "",
11081
+ "excerptTokens": [
11082
+ {
11083
+ "kind": "Content",
11084
+ "text": "interface SetOpacity "
11085
+ }
11086
+ ],
11087
+ "releaseTag": "Public",
11088
+ "name": "SetOpacity",
11089
+ "preserveMemberOrder": false,
11090
+ "members": [
11091
+ {
11092
+ "kind": "PropertySignature",
11093
+ "canonicalReference": "server!EntityEventPayload.SetOpacity#entity:member",
11094
+ "docComment": "",
11095
+ "excerptTokens": [
11096
+ {
11097
+ "kind": "Content",
11098
+ "text": "entity: "
11099
+ },
11100
+ {
11101
+ "kind": "Reference",
11102
+ "text": "Entity",
11103
+ "canonicalReference": "server!Entity:class"
11104
+ },
11105
+ {
11106
+ "kind": "Content",
11107
+ "text": ";"
11108
+ }
11109
+ ],
11110
+ "isReadonly": false,
11111
+ "isOptional": false,
11112
+ "releaseTag": "Public",
11113
+ "name": "entity",
11114
+ "propertyTypeTokenRange": {
11115
+ "startIndex": 1,
11116
+ "endIndex": 2
11117
+ }
11118
+ },
11119
+ {
11120
+ "kind": "PropertySignature",
11121
+ "canonicalReference": "server!EntityEventPayload.SetOpacity#opacity:member",
11122
+ "docComment": "",
11123
+ "excerptTokens": [
11124
+ {
11125
+ "kind": "Content",
11126
+ "text": "opacity: "
11127
+ },
11128
+ {
11129
+ "kind": "Content",
11130
+ "text": "number"
11131
+ },
11132
+ {
11133
+ "kind": "Content",
11134
+ "text": ";"
11135
+ }
11136
+ ],
11137
+ "isReadonly": false,
11138
+ "isOptional": false,
11139
+ "releaseTag": "Public",
11140
+ "name": "opacity",
11141
+ "propertyTypeTokenRange": {
11142
+ "startIndex": 1,
11143
+ "endIndex": 2
11144
+ }
11145
+ }
11146
+ ],
11147
+ "extendsTokenRanges": []
11148
+ },
10747
11149
  {
10748
11150
  "kind": "Interface",
10749
11151
  "canonicalReference": "server!EntityEventPayload.SetTintColor:interface",
@@ -11323,6 +11725,27 @@
11323
11725
  "releaseTag": "Public",
11324
11726
  "name": "SET_MODEL_HIDDEN_NODES"
11325
11727
  },
11728
+ {
11729
+ "kind": "EnumMember",
11730
+ "canonicalReference": "server!EntityEventType.SET_OPACITY:member",
11731
+ "docComment": "",
11732
+ "excerptTokens": [
11733
+ {
11734
+ "kind": "Content",
11735
+ "text": "SET_OPACITY = "
11736
+ },
11737
+ {
11738
+ "kind": "Content",
11739
+ "text": "\"ENTITY.SET_OPACITY\""
11740
+ }
11741
+ ],
11742
+ "initializerTokenRange": {
11743
+ "startIndex": 1,
11744
+ "endIndex": 2
11745
+ },
11746
+ "releaseTag": "Public",
11747
+ "name": "SET_OPACITY"
11748
+ },
11326
11749
  {
11327
11750
  "kind": "EnumMember",
11328
11751
  "canonicalReference": "server!EntityEventType.SET_TINT_COLOR:member",
@@ -12048,6 +12471,33 @@
12048
12471
  "endIndex": 2
12049
12472
  }
12050
12473
  },
12474
+ {
12475
+ "kind": "PropertySignature",
12476
+ "canonicalReference": "server!EntityOptions#opacity:member",
12477
+ "docComment": "/**\n * The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.\n */\n",
12478
+ "excerptTokens": [
12479
+ {
12480
+ "kind": "Content",
12481
+ "text": "opacity?: "
12482
+ },
12483
+ {
12484
+ "kind": "Content",
12485
+ "text": "number"
12486
+ },
12487
+ {
12488
+ "kind": "Content",
12489
+ "text": ";"
12490
+ }
12491
+ ],
12492
+ "isReadonly": false,
12493
+ "isOptional": true,
12494
+ "releaseTag": "Public",
12495
+ "name": "opacity",
12496
+ "propertyTypeTokenRange": {
12497
+ "startIndex": 1,
12498
+ "endIndex": 2
12499
+ }
12500
+ },
12051
12501
  {
12052
12502
  "kind": "PropertySignature",
12053
12503
  "canonicalReference": "server!EntityOptions#rigidBodyOptions:member",
@@ -16607,6 +17057,36 @@
16607
17057
  "isAbstract": false,
16608
17058
  "name": "spawn"
16609
17059
  },
17060
+ {
17061
+ "kind": "Property",
17062
+ "canonicalReference": "server!PlayerEntityController#sticksToPlatforms:member",
17063
+ "docComment": "/**\n * Whether the entity sticks to platforms.\n */\n",
17064
+ "excerptTokens": [
17065
+ {
17066
+ "kind": "Content",
17067
+ "text": "sticksToPlatforms: "
17068
+ },
17069
+ {
17070
+ "kind": "Content",
17071
+ "text": "boolean"
17072
+ },
17073
+ {
17074
+ "kind": "Content",
17075
+ "text": ";"
17076
+ }
17077
+ ],
17078
+ "isReadonly": false,
17079
+ "isOptional": false,
17080
+ "releaseTag": "Public",
17081
+ "name": "sticksToPlatforms",
17082
+ "propertyTypeTokenRange": {
17083
+ "startIndex": 1,
17084
+ "endIndex": 2
17085
+ },
17086
+ "isStatic": false,
17087
+ "isProtected": false,
17088
+ "isAbstract": false
17089
+ },
16610
17090
  {
16611
17091
  "kind": "Method",
16612
17092
  "canonicalReference": "server!PlayerEntityController#tickWithPlayerInput:member(1)",
@@ -16893,6 +17373,33 @@
16893
17373
  "endIndex": 2
16894
17374
  }
16895
17375
  },
17376
+ {
17377
+ "kind": "PropertySignature",
17378
+ "canonicalReference": "server!PlayerEntityControllerOptions#sticksToPlatforms:member",
17379
+ "docComment": "/**\n * Whether the entity sticks to platforms, defaults to true.\n */\n",
17380
+ "excerptTokens": [
17381
+ {
17382
+ "kind": "Content",
17383
+ "text": "sticksToPlatforms?: "
17384
+ },
17385
+ {
17386
+ "kind": "Content",
17387
+ "text": "boolean"
17388
+ },
17389
+ {
17390
+ "kind": "Content",
17391
+ "text": ";"
17392
+ }
17393
+ ],
17394
+ "isReadonly": false,
17395
+ "isOptional": true,
17396
+ "releaseTag": "Public",
17397
+ "name": "sticksToPlatforms",
17398
+ "propertyTypeTokenRange": {
17399
+ "startIndex": 1,
17400
+ "endIndex": 2
17401
+ }
17402
+ },
16896
17403
  {
16897
17404
  "kind": "PropertySignature",
16898
17405
  "canonicalReference": "server!PlayerEntityControllerOptions#walkVelocity:member",
@@ -23561,59 +24068,1010 @@
23561
24068
  },
23562
24069
  {
23563
24070
  "kind": "Class",
23564
- "canonicalReference": "server!SimpleEntityController:class",
23565
- "docComment": "/**\n * A simple entity controller with basic movement functions.\n *\n * @remarks\n *\n * This class implements simple movement methods that serve as a way to add realistic movement and rotational facing functionality to an entity. This is also a great base to extend for your own more complex entity controller that implements things like pathfinding. Compatible with entities that have kinematic or dynamic rigid body types.\n *\n * @example\n * ```typescript\n * // Create a custom entity controller for myEntity, prior to spawning it.\n * myEntity.setController(new SimpleEntityController());\n *\n * // Spawn the entity in the world.\n * myEntity.spawn(world, { x: 53, y: 10, z: 23 });\n *\n * // Move the entity at a speed of 4 blocks\n * // per second to the coordinate (10, 1, 10).\n * // console.log when we reach the target.\n * myEntity.controller.move({ x: 10, y: 1, z: 10 }, 4, {\n * moveCompleteCallback: endPosition => {\n * console.log('Finished moving to', endPosition);\n * },\n * });\n * ```\n *\n * @public\n */\n",
24071
+ "canonicalReference": "server!SceneUI:class",
24072
+ "docComment": "/**\n * UI rendered within the 3D space of a world's game scene.\n *\n * @remarks\n *\n * SceneUI instances are created directly as instances. They support a variety of configuration options through the {@link SceneUIOptions} constructor argument.\n *\n * @example\n * ```typescript\n * const sceneUI = new SceneUI({\n * templateId: 'player-health-bar',\n * attachedToEntity: playerEntity,\n * offset: { x: 0, y: 1, z: 0 },\n * });\n * ```\n *\n * @public\n */\n",
23566
24073
  "excerptTokens": [
23567
24074
  {
23568
24075
  "kind": "Content",
23569
- "text": "export default class SimpleEntityController extends "
24076
+ "text": "export default class SceneUI implements "
23570
24077
  },
23571
24078
  {
23572
24079
  "kind": "Reference",
23573
- "text": "BaseEntityController",
23574
- "canonicalReference": "server!BaseEntityController:class"
24080
+ "text": "protocol.Serializable",
24081
+ "canonicalReference": "@hytopia.com/server-protocol!Serializable:interface"
23575
24082
  },
23576
24083
  {
23577
24084
  "kind": "Content",
23578
24085
  "text": " "
23579
24086
  }
23580
24087
  ],
23581
- "fileUrlPath": "src/world/entities/controllers/SimpleEntityController.ts",
24088
+ "fileUrlPath": "src/world/ui/SceneUI.ts",
23582
24089
  "releaseTag": "Public",
23583
24090
  "isAbstract": false,
23584
- "name": "SimpleEntityController",
24091
+ "name": "SceneUI",
23585
24092
  "preserveMemberOrder": false,
23586
24093
  "members": [
23587
24094
  {
23588
- "kind": "Method",
23589
- "canonicalReference": "server!SimpleEntityController#face:member(1)",
23590
- "docComment": "/**\n * Rotates the entity at a given speed to face a target coordinate.\n *\n * @remarks\n *\n * If this method is called while the entity is already attempting to face another target, the previous target will be ignored and the entity will start attempting to face the new target.\n *\n * @param target - The target coordinate to face.\n *\n * @param speed - The speed at which to rotate to the target coordinate.\n *\n * @param options - Additional options for the face operation, such as callbacks.\n */\n",
24095
+ "kind": "Constructor",
24096
+ "canonicalReference": "server!SceneUI:constructor(1)",
24097
+ "docComment": "/**\n * Constructs a new instance of the `SceneUI` class\n *\n * @param options - The options for the SceneUI instance.\n */\n",
23591
24098
  "excerptTokens": [
23592
24099
  {
23593
24100
  "kind": "Content",
23594
- "text": "face(target: "
24101
+ "text": "constructor(options: "
23595
24102
  },
23596
24103
  {
23597
24104
  "kind": "Reference",
23598
- "text": "Vector3Like",
23599
- "canonicalReference": "server!Vector3Like:interface"
24105
+ "text": "SceneUIOptions",
24106
+ "canonicalReference": "server!SceneUIOptions:interface"
23600
24107
  },
23601
24108
  {
23602
24109
  "kind": "Content",
23603
- "text": ", speed: "
23604
- },
24110
+ "text": ");"
24111
+ }
24112
+ ],
24113
+ "releaseTag": "Public",
24114
+ "isProtected": false,
24115
+ "overloadIndex": 1,
24116
+ "parameters": [
23605
24117
  {
23606
- "kind": "Content",
23607
- "text": "number"
23608
- },
24118
+ "parameterName": "options",
24119
+ "parameterTypeTokenRange": {
24120
+ "startIndex": 1,
24121
+ "endIndex": 2
24122
+ },
24123
+ "isOptional": false
24124
+ }
24125
+ ]
24126
+ },
24127
+ {
24128
+ "kind": "Property",
24129
+ "canonicalReference": "server!SceneUI#attachedToEntity:member",
24130
+ "docComment": "",
24131
+ "excerptTokens": [
23609
24132
  {
23610
24133
  "kind": "Content",
23611
- "text": ", options?: "
24134
+ "text": "get attachedToEntity(): "
23612
24135
  },
23613
24136
  {
23614
24137
  "kind": "Reference",
23615
- "text": "FaceOptions",
23616
- "canonicalReference": "server!FaceOptions:type"
24138
+ "text": "Entity",
24139
+ "canonicalReference": "server!Entity:class"
24140
+ },
24141
+ {
24142
+ "kind": "Content",
24143
+ "text": " | undefined"
24144
+ },
24145
+ {
24146
+ "kind": "Content",
24147
+ "text": ";"
24148
+ }
24149
+ ],
24150
+ "isReadonly": true,
24151
+ "isOptional": false,
24152
+ "releaseTag": "Public",
24153
+ "name": "attachedToEntity",
24154
+ "propertyTypeTokenRange": {
24155
+ "startIndex": 1,
24156
+ "endIndex": 3
24157
+ },
24158
+ "isStatic": false,
24159
+ "isProtected": false,
24160
+ "isAbstract": false
24161
+ },
24162
+ {
24163
+ "kind": "Property",
24164
+ "canonicalReference": "server!SceneUI#id:member",
24165
+ "docComment": "",
24166
+ "excerptTokens": [
24167
+ {
24168
+ "kind": "Content",
24169
+ "text": "get id(): "
24170
+ },
24171
+ {
24172
+ "kind": "Content",
24173
+ "text": "number | undefined"
24174
+ },
24175
+ {
24176
+ "kind": "Content",
24177
+ "text": ";"
24178
+ }
24179
+ ],
24180
+ "isReadonly": true,
24181
+ "isOptional": false,
24182
+ "releaseTag": "Public",
24183
+ "name": "id",
24184
+ "propertyTypeTokenRange": {
24185
+ "startIndex": 1,
24186
+ "endIndex": 2
24187
+ },
24188
+ "isStatic": false,
24189
+ "isProtected": false,
24190
+ "isAbstract": false
24191
+ },
24192
+ {
24193
+ "kind": "Property",
24194
+ "canonicalReference": "server!SceneUI#isLoaded:member",
24195
+ "docComment": "",
24196
+ "excerptTokens": [
24197
+ {
24198
+ "kind": "Content",
24199
+ "text": "get isLoaded(): "
24200
+ },
24201
+ {
24202
+ "kind": "Content",
24203
+ "text": "boolean"
24204
+ },
24205
+ {
24206
+ "kind": "Content",
24207
+ "text": ";"
24208
+ }
24209
+ ],
24210
+ "isReadonly": true,
24211
+ "isOptional": false,
24212
+ "releaseTag": "Public",
24213
+ "name": "isLoaded",
24214
+ "propertyTypeTokenRange": {
24215
+ "startIndex": 1,
24216
+ "endIndex": 2
24217
+ },
24218
+ "isStatic": false,
24219
+ "isProtected": false,
24220
+ "isAbstract": false
24221
+ },
24222
+ {
24223
+ "kind": "Method",
24224
+ "canonicalReference": "server!SceneUI#load:member(1)",
24225
+ "docComment": "/**\n * Loads the SceneUI into the world.\n *\n * @param world - The world to load the SceneUI into.\n */\n",
24226
+ "excerptTokens": [
24227
+ {
24228
+ "kind": "Content",
24229
+ "text": "load(world: "
24230
+ },
24231
+ {
24232
+ "kind": "Reference",
24233
+ "text": "World",
24234
+ "canonicalReference": "server!World:class"
24235
+ },
24236
+ {
24237
+ "kind": "Content",
24238
+ "text": "): "
24239
+ },
24240
+ {
24241
+ "kind": "Content",
24242
+ "text": "void"
24243
+ },
24244
+ {
24245
+ "kind": "Content",
24246
+ "text": ";"
24247
+ }
24248
+ ],
24249
+ "isStatic": false,
24250
+ "returnTypeTokenRange": {
24251
+ "startIndex": 3,
24252
+ "endIndex": 4
24253
+ },
24254
+ "releaseTag": "Public",
24255
+ "isProtected": false,
24256
+ "overloadIndex": 1,
24257
+ "parameters": [
24258
+ {
24259
+ "parameterName": "world",
24260
+ "parameterTypeTokenRange": {
24261
+ "startIndex": 1,
24262
+ "endIndex": 2
24263
+ },
24264
+ "isOptional": false
24265
+ }
24266
+ ],
24267
+ "isOptional": false,
24268
+ "isAbstract": false,
24269
+ "name": "load"
24270
+ },
24271
+ {
24272
+ "kind": "Property",
24273
+ "canonicalReference": "server!SceneUI#offset:member",
24274
+ "docComment": "",
24275
+ "excerptTokens": [
24276
+ {
24277
+ "kind": "Content",
24278
+ "text": "get offset(): "
24279
+ },
24280
+ {
24281
+ "kind": "Reference",
24282
+ "text": "Vector3Like",
24283
+ "canonicalReference": "server!Vector3Like:interface"
24284
+ },
24285
+ {
24286
+ "kind": "Content",
24287
+ "text": " | undefined"
24288
+ },
24289
+ {
24290
+ "kind": "Content",
24291
+ "text": ";"
24292
+ }
24293
+ ],
24294
+ "isReadonly": true,
24295
+ "isOptional": false,
24296
+ "releaseTag": "Public",
24297
+ "name": "offset",
24298
+ "propertyTypeTokenRange": {
24299
+ "startIndex": 1,
24300
+ "endIndex": 3
24301
+ },
24302
+ "isStatic": false,
24303
+ "isProtected": false,
24304
+ "isAbstract": false
24305
+ },
24306
+ {
24307
+ "kind": "Property",
24308
+ "canonicalReference": "server!SceneUI#position:member",
24309
+ "docComment": "",
24310
+ "excerptTokens": [
24311
+ {
24312
+ "kind": "Content",
24313
+ "text": "get position(): "
24314
+ },
24315
+ {
24316
+ "kind": "Reference",
24317
+ "text": "Vector3Like",
24318
+ "canonicalReference": "server!Vector3Like:interface"
24319
+ },
24320
+ {
24321
+ "kind": "Content",
24322
+ "text": " | undefined"
24323
+ },
24324
+ {
24325
+ "kind": "Content",
24326
+ "text": ";"
24327
+ }
24328
+ ],
24329
+ "isReadonly": true,
24330
+ "isOptional": false,
24331
+ "releaseTag": "Public",
24332
+ "name": "position",
24333
+ "propertyTypeTokenRange": {
24334
+ "startIndex": 1,
24335
+ "endIndex": 3
24336
+ },
24337
+ "isStatic": false,
24338
+ "isProtected": false,
24339
+ "isAbstract": false
24340
+ },
24341
+ {
24342
+ "kind": "Method",
24343
+ "canonicalReference": "server!SceneUI#setAttachedToEntity:member(1)",
24344
+ "docComment": "/**\n * Sets the entity to which the SceneUI is attached, following its position.\n *\n * @param entity - The entity to attach the SceneUI to.\n */\n",
24345
+ "excerptTokens": [
24346
+ {
24347
+ "kind": "Content",
24348
+ "text": "setAttachedToEntity(entity: "
24349
+ },
24350
+ {
24351
+ "kind": "Reference",
24352
+ "text": "Entity",
24353
+ "canonicalReference": "server!Entity:class"
24354
+ },
24355
+ {
24356
+ "kind": "Content",
24357
+ "text": "): "
24358
+ },
24359
+ {
24360
+ "kind": "Content",
24361
+ "text": "void"
24362
+ },
24363
+ {
24364
+ "kind": "Content",
24365
+ "text": ";"
24366
+ }
24367
+ ],
24368
+ "isStatic": false,
24369
+ "returnTypeTokenRange": {
24370
+ "startIndex": 3,
24371
+ "endIndex": 4
24372
+ },
24373
+ "releaseTag": "Public",
24374
+ "isProtected": false,
24375
+ "overloadIndex": 1,
24376
+ "parameters": [
24377
+ {
24378
+ "parameterName": "entity",
24379
+ "parameterTypeTokenRange": {
24380
+ "startIndex": 1,
24381
+ "endIndex": 2
24382
+ },
24383
+ "isOptional": false
24384
+ }
24385
+ ],
24386
+ "isOptional": false,
24387
+ "isAbstract": false,
24388
+ "name": "setAttachedToEntity"
24389
+ },
24390
+ {
24391
+ "kind": "Method",
24392
+ "canonicalReference": "server!SceneUI#setOffset:member(1)",
24393
+ "docComment": "/**\n * Sets the spatial offset of the SceneUI relative to the attached entity or position.\n *\n * @param offset - The offset in the world.\n */\n",
24394
+ "excerptTokens": [
24395
+ {
24396
+ "kind": "Content",
24397
+ "text": "setOffset(offset: "
24398
+ },
24399
+ {
24400
+ "kind": "Reference",
24401
+ "text": "Vector3Like",
24402
+ "canonicalReference": "server!Vector3Like:interface"
24403
+ },
24404
+ {
24405
+ "kind": "Content",
24406
+ "text": "): "
24407
+ },
24408
+ {
24409
+ "kind": "Content",
24410
+ "text": "void"
24411
+ },
24412
+ {
24413
+ "kind": "Content",
24414
+ "text": ";"
24415
+ }
24416
+ ],
24417
+ "isStatic": false,
24418
+ "returnTypeTokenRange": {
24419
+ "startIndex": 3,
24420
+ "endIndex": 4
24421
+ },
24422
+ "releaseTag": "Public",
24423
+ "isProtected": false,
24424
+ "overloadIndex": 1,
24425
+ "parameters": [
24426
+ {
24427
+ "parameterName": "offset",
24428
+ "parameterTypeTokenRange": {
24429
+ "startIndex": 1,
24430
+ "endIndex": 2
24431
+ },
24432
+ "isOptional": false
24433
+ }
24434
+ ],
24435
+ "isOptional": false,
24436
+ "isAbstract": false,
24437
+ "name": "setOffset"
24438
+ },
24439
+ {
24440
+ "kind": "Method",
24441
+ "canonicalReference": "server!SceneUI#setPosition:member(1)",
24442
+ "docComment": "/**\n * Sets the position of the SceneUI. Will detach from entity if attached.\n *\n * @param position - The position in the world.\n */\n",
24443
+ "excerptTokens": [
24444
+ {
24445
+ "kind": "Content",
24446
+ "text": "setPosition(position: "
24447
+ },
24448
+ {
24449
+ "kind": "Reference",
24450
+ "text": "Vector3Like",
24451
+ "canonicalReference": "server!Vector3Like:interface"
24452
+ },
24453
+ {
24454
+ "kind": "Content",
24455
+ "text": "): "
24456
+ },
24457
+ {
24458
+ "kind": "Content",
24459
+ "text": "void"
24460
+ },
24461
+ {
24462
+ "kind": "Content",
24463
+ "text": ";"
24464
+ }
24465
+ ],
24466
+ "isStatic": false,
24467
+ "returnTypeTokenRange": {
24468
+ "startIndex": 3,
24469
+ "endIndex": 4
24470
+ },
24471
+ "releaseTag": "Public",
24472
+ "isProtected": false,
24473
+ "overloadIndex": 1,
24474
+ "parameters": [
24475
+ {
24476
+ "parameterName": "position",
24477
+ "parameterTypeTokenRange": {
24478
+ "startIndex": 1,
24479
+ "endIndex": 2
24480
+ },
24481
+ "isOptional": false
24482
+ }
24483
+ ],
24484
+ "isOptional": false,
24485
+ "isAbstract": false,
24486
+ "name": "setPosition"
24487
+ },
24488
+ {
24489
+ "kind": "Method",
24490
+ "canonicalReference": "server!SceneUI#setState:member(1)",
24491
+ "docComment": "/**\n * Sets the state of the SceneUI by performing a shallow merge with existing state.\n *\n * @param state - The state to set.\n */\n",
24492
+ "excerptTokens": [
24493
+ {
24494
+ "kind": "Content",
24495
+ "text": "setState(state: "
24496
+ },
24497
+ {
24498
+ "kind": "Content",
24499
+ "text": "object"
24500
+ },
24501
+ {
24502
+ "kind": "Content",
24503
+ "text": "): "
24504
+ },
24505
+ {
24506
+ "kind": "Content",
24507
+ "text": "void"
24508
+ },
24509
+ {
24510
+ "kind": "Content",
24511
+ "text": ";"
24512
+ }
24513
+ ],
24514
+ "isStatic": false,
24515
+ "returnTypeTokenRange": {
24516
+ "startIndex": 3,
24517
+ "endIndex": 4
24518
+ },
24519
+ "releaseTag": "Public",
24520
+ "isProtected": false,
24521
+ "overloadIndex": 1,
24522
+ "parameters": [
24523
+ {
24524
+ "parameterName": "state",
24525
+ "parameterTypeTokenRange": {
24526
+ "startIndex": 1,
24527
+ "endIndex": 2
24528
+ },
24529
+ "isOptional": false
24530
+ }
24531
+ ],
24532
+ "isOptional": false,
24533
+ "isAbstract": false,
24534
+ "name": "setState"
24535
+ },
24536
+ {
24537
+ "kind": "Property",
24538
+ "canonicalReference": "server!SceneUI#state:member",
24539
+ "docComment": "",
24540
+ "excerptTokens": [
24541
+ {
24542
+ "kind": "Content",
24543
+ "text": "get state(): "
24544
+ },
24545
+ {
24546
+ "kind": "Reference",
24547
+ "text": "Readonly",
24548
+ "canonicalReference": "!Readonly:type"
24549
+ },
24550
+ {
24551
+ "kind": "Content",
24552
+ "text": "<object>"
24553
+ },
24554
+ {
24555
+ "kind": "Content",
24556
+ "text": ";"
24557
+ }
24558
+ ],
24559
+ "isReadonly": true,
24560
+ "isOptional": false,
24561
+ "releaseTag": "Public",
24562
+ "name": "state",
24563
+ "propertyTypeTokenRange": {
24564
+ "startIndex": 1,
24565
+ "endIndex": 3
24566
+ },
24567
+ "isStatic": false,
24568
+ "isProtected": false,
24569
+ "isAbstract": false
24570
+ },
24571
+ {
24572
+ "kind": "Property",
24573
+ "canonicalReference": "server!SceneUI#templateId:member",
24574
+ "docComment": "",
24575
+ "excerptTokens": [
24576
+ {
24577
+ "kind": "Content",
24578
+ "text": "get templateId(): "
24579
+ },
24580
+ {
24581
+ "kind": "Content",
24582
+ "text": "string"
24583
+ },
24584
+ {
24585
+ "kind": "Content",
24586
+ "text": ";"
24587
+ }
24588
+ ],
24589
+ "isReadonly": true,
24590
+ "isOptional": false,
24591
+ "releaseTag": "Public",
24592
+ "name": "templateId",
24593
+ "propertyTypeTokenRange": {
24594
+ "startIndex": 1,
24595
+ "endIndex": 2
24596
+ },
24597
+ "isStatic": false,
24598
+ "isProtected": false,
24599
+ "isAbstract": false
24600
+ },
24601
+ {
24602
+ "kind": "Method",
24603
+ "canonicalReference": "server!SceneUI#unload:member(1)",
24604
+ "docComment": "/**\n * Unloads the SceneUI from the world.\n */\n",
24605
+ "excerptTokens": [
24606
+ {
24607
+ "kind": "Content",
24608
+ "text": "unload(): "
24609
+ },
24610
+ {
24611
+ "kind": "Content",
24612
+ "text": "void"
24613
+ },
24614
+ {
24615
+ "kind": "Content",
24616
+ "text": ";"
24617
+ }
24618
+ ],
24619
+ "isStatic": false,
24620
+ "returnTypeTokenRange": {
24621
+ "startIndex": 1,
24622
+ "endIndex": 2
24623
+ },
24624
+ "releaseTag": "Public",
24625
+ "isProtected": false,
24626
+ "overloadIndex": 1,
24627
+ "parameters": [],
24628
+ "isOptional": false,
24629
+ "isAbstract": false,
24630
+ "name": "unload"
24631
+ },
24632
+ {
24633
+ "kind": "Property",
24634
+ "canonicalReference": "server!SceneUI#world:member",
24635
+ "docComment": "",
24636
+ "excerptTokens": [
24637
+ {
24638
+ "kind": "Content",
24639
+ "text": "get world(): "
24640
+ },
24641
+ {
24642
+ "kind": "Reference",
24643
+ "text": "World",
24644
+ "canonicalReference": "server!World:class"
24645
+ },
24646
+ {
24647
+ "kind": "Content",
24648
+ "text": " | undefined"
24649
+ },
24650
+ {
24651
+ "kind": "Content",
24652
+ "text": ";"
24653
+ }
24654
+ ],
24655
+ "isReadonly": true,
24656
+ "isOptional": false,
24657
+ "releaseTag": "Public",
24658
+ "name": "world",
24659
+ "propertyTypeTokenRange": {
24660
+ "startIndex": 1,
24661
+ "endIndex": 3
24662
+ },
24663
+ "isStatic": false,
24664
+ "isProtected": false,
24665
+ "isAbstract": false
24666
+ }
24667
+ ],
24668
+ "implementsTokenRanges": [
24669
+ {
24670
+ "startIndex": 1,
24671
+ "endIndex": 2
24672
+ }
24673
+ ]
24674
+ },
24675
+ {
24676
+ "kind": "Class",
24677
+ "canonicalReference": "server!SceneUIManager:class",
24678
+ "docComment": "/**\n * Manages SceneUI instances in a world.\n *\n * @remarks\n *\n * The SceneUIManager is created internally as a singleton for each {@link World} instance in a game server. It allows retrieval of all loaded SceneUI instances, entity attached SceneUI instances, and more.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SceneUIManager` class.\n *\n * @public\n */\n",
24679
+ "excerptTokens": [
24680
+ {
24681
+ "kind": "Content",
24682
+ "text": "export default class SceneUIManager "
24683
+ }
24684
+ ],
24685
+ "fileUrlPath": "src/world/ui/SceneUIManager.ts",
24686
+ "releaseTag": "Public",
24687
+ "isAbstract": false,
24688
+ "name": "SceneUIManager",
24689
+ "preserveMemberOrder": false,
24690
+ "members": [
24691
+ {
24692
+ "kind": "Method",
24693
+ "canonicalReference": "server!SceneUIManager#getAllEntityAttachedSceneUIs:member(1)",
24694
+ "docComment": "/**\n * Retrieves all loaded SceneUI instances attached to a specific entity.\n *\n * @param entity - The entity to get attached SceneUI instances for.\n *\n * @returns An array of SceneUI instances.\n */\n",
24695
+ "excerptTokens": [
24696
+ {
24697
+ "kind": "Content",
24698
+ "text": "getAllEntityAttachedSceneUIs(entity: "
24699
+ },
24700
+ {
24701
+ "kind": "Reference",
24702
+ "text": "Entity",
24703
+ "canonicalReference": "server!Entity:class"
24704
+ },
24705
+ {
24706
+ "kind": "Content",
24707
+ "text": "): "
24708
+ },
24709
+ {
24710
+ "kind": "Reference",
24711
+ "text": "SceneUI",
24712
+ "canonicalReference": "server!SceneUI:class"
24713
+ },
24714
+ {
24715
+ "kind": "Content",
24716
+ "text": "[]"
24717
+ },
24718
+ {
24719
+ "kind": "Content",
24720
+ "text": ";"
24721
+ }
24722
+ ],
24723
+ "isStatic": false,
24724
+ "returnTypeTokenRange": {
24725
+ "startIndex": 3,
24726
+ "endIndex": 5
24727
+ },
24728
+ "releaseTag": "Public",
24729
+ "isProtected": false,
24730
+ "overloadIndex": 1,
24731
+ "parameters": [
24732
+ {
24733
+ "parameterName": "entity",
24734
+ "parameterTypeTokenRange": {
24735
+ "startIndex": 1,
24736
+ "endIndex": 2
24737
+ },
24738
+ "isOptional": false
24739
+ }
24740
+ ],
24741
+ "isOptional": false,
24742
+ "isAbstract": false,
24743
+ "name": "getAllEntityAttachedSceneUIs"
24744
+ },
24745
+ {
24746
+ "kind": "Method",
24747
+ "canonicalReference": "server!SceneUIManager#getAllSceneUIs:member(1)",
24748
+ "docComment": "/**\n * Retrieves all loaded SceneUI instances for the world.\n *\n * @returns An array of SceneUI instances.\n */\n",
24749
+ "excerptTokens": [
24750
+ {
24751
+ "kind": "Content",
24752
+ "text": "getAllSceneUIs(): "
24753
+ },
24754
+ {
24755
+ "kind": "Reference",
24756
+ "text": "SceneUI",
24757
+ "canonicalReference": "server!SceneUI:class"
24758
+ },
24759
+ {
24760
+ "kind": "Content",
24761
+ "text": "[]"
24762
+ },
24763
+ {
24764
+ "kind": "Content",
24765
+ "text": ";"
24766
+ }
24767
+ ],
24768
+ "isStatic": false,
24769
+ "returnTypeTokenRange": {
24770
+ "startIndex": 1,
24771
+ "endIndex": 3
24772
+ },
24773
+ "releaseTag": "Public",
24774
+ "isProtected": false,
24775
+ "overloadIndex": 1,
24776
+ "parameters": [],
24777
+ "isOptional": false,
24778
+ "isAbstract": false,
24779
+ "name": "getAllSceneUIs"
24780
+ },
24781
+ {
24782
+ "kind": "Method",
24783
+ "canonicalReference": "server!SceneUIManager#unloadEntityAttachedSceneUIs:member(1)",
24784
+ "docComment": "/**\n * Unloads and unregisters all SceneUI instances attached to a specific entity.\n *\n * @param entity - The entity to unload and unregister SceneUI instances for.\n */\n",
24785
+ "excerptTokens": [
24786
+ {
24787
+ "kind": "Content",
24788
+ "text": "unloadEntityAttachedSceneUIs(entity: "
24789
+ },
24790
+ {
24791
+ "kind": "Reference",
24792
+ "text": "Entity",
24793
+ "canonicalReference": "server!Entity:class"
24794
+ },
24795
+ {
24796
+ "kind": "Content",
24797
+ "text": "): "
24798
+ },
24799
+ {
24800
+ "kind": "Content",
24801
+ "text": "void"
24802
+ },
24803
+ {
24804
+ "kind": "Content",
24805
+ "text": ";"
24806
+ }
24807
+ ],
24808
+ "isStatic": false,
24809
+ "returnTypeTokenRange": {
24810
+ "startIndex": 3,
24811
+ "endIndex": 4
24812
+ },
24813
+ "releaseTag": "Public",
24814
+ "isProtected": false,
24815
+ "overloadIndex": 1,
24816
+ "parameters": [
24817
+ {
24818
+ "parameterName": "entity",
24819
+ "parameterTypeTokenRange": {
24820
+ "startIndex": 1,
24821
+ "endIndex": 2
24822
+ },
24823
+ "isOptional": false
24824
+ }
24825
+ ],
24826
+ "isOptional": false,
24827
+ "isAbstract": false,
24828
+ "name": "unloadEntityAttachedSceneUIs"
24829
+ },
24830
+ {
24831
+ "kind": "Property",
24832
+ "canonicalReference": "server!SceneUIManager#world:member",
24833
+ "docComment": "/**\n * The world the SceneUIManager is for.\n */\n",
24834
+ "excerptTokens": [
24835
+ {
24836
+ "kind": "Content",
24837
+ "text": "get world(): "
24838
+ },
24839
+ {
24840
+ "kind": "Reference",
24841
+ "text": "World",
24842
+ "canonicalReference": "server!World:class"
24843
+ },
24844
+ {
24845
+ "kind": "Content",
24846
+ "text": ";"
24847
+ }
24848
+ ],
24849
+ "isReadonly": true,
24850
+ "isOptional": false,
24851
+ "releaseTag": "Public",
24852
+ "name": "world",
24853
+ "propertyTypeTokenRange": {
24854
+ "startIndex": 1,
24855
+ "endIndex": 2
24856
+ },
24857
+ "isStatic": false,
24858
+ "isProtected": false,
24859
+ "isAbstract": false
24860
+ }
24861
+ ],
24862
+ "implementsTokenRanges": []
24863
+ },
24864
+ {
24865
+ "kind": "Interface",
24866
+ "canonicalReference": "server!SceneUIOptions:interface",
24867
+ "docComment": "/**\n * Options for creating a SceneUI instance.\n *\n * @public\n */\n",
24868
+ "excerptTokens": [
24869
+ {
24870
+ "kind": "Content",
24871
+ "text": "export interface SceneUIOptions "
24872
+ }
24873
+ ],
24874
+ "fileUrlPath": "src/world/ui/SceneUI.ts",
24875
+ "releaseTag": "Public",
24876
+ "name": "SceneUIOptions",
24877
+ "preserveMemberOrder": false,
24878
+ "members": [
24879
+ {
24880
+ "kind": "PropertySignature",
24881
+ "canonicalReference": "server!SceneUIOptions#attachedToEntity:member",
24882
+ "docComment": "/**\n * If set, SceneUI will follow the entity's position\n */\n",
24883
+ "excerptTokens": [
24884
+ {
24885
+ "kind": "Content",
24886
+ "text": "attachedToEntity?: "
24887
+ },
24888
+ {
24889
+ "kind": "Reference",
24890
+ "text": "Entity",
24891
+ "canonicalReference": "server!Entity:class"
24892
+ },
24893
+ {
24894
+ "kind": "Content",
24895
+ "text": ";"
24896
+ }
24897
+ ],
24898
+ "isReadonly": false,
24899
+ "isOptional": true,
24900
+ "releaseTag": "Public",
24901
+ "name": "attachedToEntity",
24902
+ "propertyTypeTokenRange": {
24903
+ "startIndex": 1,
24904
+ "endIndex": 2
24905
+ }
24906
+ },
24907
+ {
24908
+ "kind": "PropertySignature",
24909
+ "canonicalReference": "server!SceneUIOptions#offset:member",
24910
+ "docComment": "/**\n * The offset of the SceneUI from the attached entity or position\n */\n",
24911
+ "excerptTokens": [
24912
+ {
24913
+ "kind": "Content",
24914
+ "text": "offset?: "
24915
+ },
24916
+ {
24917
+ "kind": "Reference",
24918
+ "text": "Vector3Like",
24919
+ "canonicalReference": "server!Vector3Like:interface"
24920
+ },
24921
+ {
24922
+ "kind": "Content",
24923
+ "text": ";"
24924
+ }
24925
+ ],
24926
+ "isReadonly": false,
24927
+ "isOptional": true,
24928
+ "releaseTag": "Public",
24929
+ "name": "offset",
24930
+ "propertyTypeTokenRange": {
24931
+ "startIndex": 1,
24932
+ "endIndex": 2
24933
+ }
24934
+ },
24935
+ {
24936
+ "kind": "PropertySignature",
24937
+ "canonicalReference": "server!SceneUIOptions#position:member",
24938
+ "docComment": "/**\n * If set, SceneUI will be attached at this position\n */\n",
24939
+ "excerptTokens": [
24940
+ {
24941
+ "kind": "Content",
24942
+ "text": "position?: "
24943
+ },
24944
+ {
24945
+ "kind": "Reference",
24946
+ "text": "Vector3Like",
24947
+ "canonicalReference": "server!Vector3Like:interface"
24948
+ },
24949
+ {
24950
+ "kind": "Content",
24951
+ "text": ";"
24952
+ }
24953
+ ],
24954
+ "isReadonly": false,
24955
+ "isOptional": true,
24956
+ "releaseTag": "Public",
24957
+ "name": "position",
24958
+ "propertyTypeTokenRange": {
24959
+ "startIndex": 1,
24960
+ "endIndex": 2
24961
+ }
24962
+ },
24963
+ {
24964
+ "kind": "PropertySignature",
24965
+ "canonicalReference": "server!SceneUIOptions#state:member",
24966
+ "docComment": "/**\n * The state of the SceneUI\n */\n",
24967
+ "excerptTokens": [
24968
+ {
24969
+ "kind": "Content",
24970
+ "text": "state?: "
24971
+ },
24972
+ {
24973
+ "kind": "Content",
24974
+ "text": "object"
24975
+ },
24976
+ {
24977
+ "kind": "Content",
24978
+ "text": ";"
24979
+ }
24980
+ ],
24981
+ "isReadonly": false,
24982
+ "isOptional": true,
24983
+ "releaseTag": "Public",
24984
+ "name": "state",
24985
+ "propertyTypeTokenRange": {
24986
+ "startIndex": 1,
24987
+ "endIndex": 2
24988
+ }
24989
+ },
24990
+ {
24991
+ "kind": "PropertySignature",
24992
+ "canonicalReference": "server!SceneUIOptions#templateId:member",
24993
+ "docComment": "/**\n * The template ID to use for this SceneUI\n */\n",
24994
+ "excerptTokens": [
24995
+ {
24996
+ "kind": "Content",
24997
+ "text": "templateId: "
24998
+ },
24999
+ {
25000
+ "kind": "Content",
25001
+ "text": "string"
25002
+ },
25003
+ {
25004
+ "kind": "Content",
25005
+ "text": ";"
25006
+ }
25007
+ ],
25008
+ "isReadonly": false,
25009
+ "isOptional": false,
25010
+ "releaseTag": "Public",
25011
+ "name": "templateId",
25012
+ "propertyTypeTokenRange": {
25013
+ "startIndex": 1,
25014
+ "endIndex": 2
25015
+ }
25016
+ }
25017
+ ],
25018
+ "extendsTokenRanges": []
25019
+ },
25020
+ {
25021
+ "kind": "Class",
25022
+ "canonicalReference": "server!SimpleEntityController:class",
25023
+ "docComment": "/**\n * A simple entity controller with basic movement functions.\n *\n * @remarks\n *\n * This class implements simple movement methods that serve as a way to add realistic movement and rotational facing functionality to an entity. This is also a great base to extend for your own more complex entity controller that implements things like pathfinding. Compatible with entities that have kinematic or dynamic rigid body types.\n *\n * @example\n * ```typescript\n * // Create a custom entity controller for myEntity, prior to spawning it.\n * myEntity.setController(new SimpleEntityController());\n *\n * // Spawn the entity in the world.\n * myEntity.spawn(world, { x: 53, y: 10, z: 23 });\n *\n * // Move the entity at a speed of 4 blocks\n * // per second to the coordinate (10, 1, 10).\n * // console.log when we reach the target.\n * myEntity.controller.move({ x: 10, y: 1, z: 10 }, 4, {\n * moveCompleteCallback: endPosition => {\n * console.log('Finished moving to', endPosition);\n * },\n * });\n * ```\n *\n * @public\n */\n",
25024
+ "excerptTokens": [
25025
+ {
25026
+ "kind": "Content",
25027
+ "text": "export default class SimpleEntityController extends "
25028
+ },
25029
+ {
25030
+ "kind": "Reference",
25031
+ "text": "BaseEntityController",
25032
+ "canonicalReference": "server!BaseEntityController:class"
25033
+ },
25034
+ {
25035
+ "kind": "Content",
25036
+ "text": " "
25037
+ }
25038
+ ],
25039
+ "fileUrlPath": "src/world/entities/controllers/SimpleEntityController.ts",
25040
+ "releaseTag": "Public",
25041
+ "isAbstract": false,
25042
+ "name": "SimpleEntityController",
25043
+ "preserveMemberOrder": false,
25044
+ "members": [
25045
+ {
25046
+ "kind": "Method",
25047
+ "canonicalReference": "server!SimpleEntityController#face:member(1)",
25048
+ "docComment": "/**\n * Rotates the entity at a given speed to face a target coordinate.\n *\n * @remarks\n *\n * If this method is called while the entity is already attempting to face another target, the previous target will be ignored and the entity will start attempting to face the new target.\n *\n * @param target - The target coordinate to face.\n *\n * @param speed - The speed at which to rotate to the target coordinate.\n *\n * @param options - Additional options for the face operation, such as callbacks.\n */\n",
25049
+ "excerptTokens": [
25050
+ {
25051
+ "kind": "Content",
25052
+ "text": "face(target: "
25053
+ },
25054
+ {
25055
+ "kind": "Reference",
25056
+ "text": "Vector3Like",
25057
+ "canonicalReference": "server!Vector3Like:interface"
25058
+ },
25059
+ {
25060
+ "kind": "Content",
25061
+ "text": ", speed: "
25062
+ },
25063
+ {
25064
+ "kind": "Content",
25065
+ "text": "number"
25066
+ },
25067
+ {
25068
+ "kind": "Content",
25069
+ "text": ", options?: "
25070
+ },
25071
+ {
25072
+ "kind": "Reference",
25073
+ "text": "FaceOptions",
25074
+ "canonicalReference": "server!FaceOptions:type"
23617
25075
  },
23618
25076
  {
23619
25077
  "kind": "Content",
@@ -26439,6 +27897,37 @@
26439
27897
  "isProtected": false,
26440
27898
  "isAbstract": false
26441
27899
  },
27900
+ {
27901
+ "kind": "Property",
27902
+ "canonicalReference": "server!World#sceneUIManager:member",
27903
+ "docComment": "/**\n * The scene UI manager for the world.\n */\n",
27904
+ "excerptTokens": [
27905
+ {
27906
+ "kind": "Content",
27907
+ "text": "get sceneUIManager(): "
27908
+ },
27909
+ {
27910
+ "kind": "Reference",
27911
+ "text": "SceneUIManager",
27912
+ "canonicalReference": "server!SceneUIManager:class"
27913
+ },
27914
+ {
27915
+ "kind": "Content",
27916
+ "text": ";"
27917
+ }
27918
+ ],
27919
+ "isReadonly": true,
27920
+ "isOptional": false,
27921
+ "releaseTag": "Public",
27922
+ "name": "sceneUIManager",
27923
+ "propertyTypeTokenRange": {
27924
+ "startIndex": 1,
27925
+ "endIndex": 2
27926
+ },
27927
+ "isStatic": false,
27928
+ "isProtected": false,
27929
+ "isAbstract": false
27930
+ },
26442
27931
  {
26443
27932
  "kind": "Property",
26444
27933
  "canonicalReference": "server!World#simulation:member",