hytopia 0.1.59 → 0.1.60

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 (38) hide show
  1. package/docs/server.audio._constructor_.md +2 -0
  2. package/docs/server.audio.setattachedtoentity.md +1 -1
  3. package/docs/server.audiomanager.unregisteraudio.md +1 -1
  4. package/docs/server.audiomanager.unregisterentityattachedaudios.md +1 -1
  5. package/docs/server.md +33 -0
  6. package/docs/server.sceneui._constructor_.md +49 -0
  7. package/docs/server.sceneui.attachedtoentity.md +11 -0
  8. package/docs/server.sceneui.id.md +11 -0
  9. package/docs/server.sceneui.isloaded.md +11 -0
  10. package/docs/server.sceneui.load.md +53 -0
  11. package/docs/server.sceneui.md +344 -0
  12. package/docs/server.sceneui.offset.md +11 -0
  13. package/docs/server.sceneui.position.md +11 -0
  14. package/docs/server.sceneui.setattachedtoentity.md +53 -0
  15. package/docs/server.sceneui.setoffset.md +53 -0
  16. package/docs/server.sceneui.setposition.md +53 -0
  17. package/docs/server.sceneui.setstate.md +53 -0
  18. package/docs/server.sceneui.state.md +11 -0
  19. package/docs/server.sceneui.templateid.md +11 -0
  20. package/docs/server.sceneui.unload.md +17 -0
  21. package/docs/server.sceneui.world.md +11 -0
  22. package/docs/server.sceneuimanager.getallentityattachedsceneuis.md +55 -0
  23. package/docs/server.sceneuimanager.getallsceneuis.md +19 -0
  24. package/docs/server.sceneuimanager.md +127 -0
  25. package/docs/server.sceneuimanager.unloadentityattachedsceneuis.md +53 -0
  26. package/docs/server.sceneuimanager.world.md +13 -0
  27. package/docs/server.sceneuioptions.attachedtoentity.md +13 -0
  28. package/docs/server.sceneuioptions.md +133 -0
  29. package/docs/server.sceneuioptions.offset.md +13 -0
  30. package/docs/server.sceneuioptions.position.md +13 -0
  31. package/docs/server.sceneuioptions.state.md +13 -0
  32. package/docs/server.sceneuioptions.templateid.md +13 -0
  33. package/docs/server.world.md +21 -0
  34. package/docs/server.world.sceneuimanager.md +13 -0
  35. package/package.json +1 -1
  36. package/server.api.json +986 -4
  37. package/server.d.ts +140 -4
  38. 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",
@@ -23559,6 +23559,957 @@
23559
23559
  }
23560
23560
  ]
23561
23561
  },
23562
+ {
23563
+ "kind": "Class",
23564
+ "canonicalReference": "server!SceneUI:class",
23565
+ "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
+ "excerptTokens": [
23567
+ {
23568
+ "kind": "Content",
23569
+ "text": "export default class SceneUI implements "
23570
+ },
23571
+ {
23572
+ "kind": "Reference",
23573
+ "text": "protocol.Serializable",
23574
+ "canonicalReference": "@hytopia.com/server-protocol!Serializable:interface"
23575
+ },
23576
+ {
23577
+ "kind": "Content",
23578
+ "text": " "
23579
+ }
23580
+ ],
23581
+ "fileUrlPath": "src/world/ui/SceneUI.ts",
23582
+ "releaseTag": "Public",
23583
+ "isAbstract": false,
23584
+ "name": "SceneUI",
23585
+ "preserveMemberOrder": false,
23586
+ "members": [
23587
+ {
23588
+ "kind": "Constructor",
23589
+ "canonicalReference": "server!SceneUI:constructor(1)",
23590
+ "docComment": "/**\n * Constructs a new instance of the `SceneUI` class\n *\n * @param options - The options for the SceneUI instance.\n */\n",
23591
+ "excerptTokens": [
23592
+ {
23593
+ "kind": "Content",
23594
+ "text": "constructor(options: "
23595
+ },
23596
+ {
23597
+ "kind": "Reference",
23598
+ "text": "SceneUIOptions",
23599
+ "canonicalReference": "server!SceneUIOptions:interface"
23600
+ },
23601
+ {
23602
+ "kind": "Content",
23603
+ "text": ");"
23604
+ }
23605
+ ],
23606
+ "releaseTag": "Public",
23607
+ "isProtected": false,
23608
+ "overloadIndex": 1,
23609
+ "parameters": [
23610
+ {
23611
+ "parameterName": "options",
23612
+ "parameterTypeTokenRange": {
23613
+ "startIndex": 1,
23614
+ "endIndex": 2
23615
+ },
23616
+ "isOptional": false
23617
+ }
23618
+ ]
23619
+ },
23620
+ {
23621
+ "kind": "Property",
23622
+ "canonicalReference": "server!SceneUI#attachedToEntity:member",
23623
+ "docComment": "",
23624
+ "excerptTokens": [
23625
+ {
23626
+ "kind": "Content",
23627
+ "text": "get attachedToEntity(): "
23628
+ },
23629
+ {
23630
+ "kind": "Reference",
23631
+ "text": "Entity",
23632
+ "canonicalReference": "server!Entity:class"
23633
+ },
23634
+ {
23635
+ "kind": "Content",
23636
+ "text": " | undefined"
23637
+ },
23638
+ {
23639
+ "kind": "Content",
23640
+ "text": ";"
23641
+ }
23642
+ ],
23643
+ "isReadonly": true,
23644
+ "isOptional": false,
23645
+ "releaseTag": "Public",
23646
+ "name": "attachedToEntity",
23647
+ "propertyTypeTokenRange": {
23648
+ "startIndex": 1,
23649
+ "endIndex": 3
23650
+ },
23651
+ "isStatic": false,
23652
+ "isProtected": false,
23653
+ "isAbstract": false
23654
+ },
23655
+ {
23656
+ "kind": "Property",
23657
+ "canonicalReference": "server!SceneUI#id:member",
23658
+ "docComment": "",
23659
+ "excerptTokens": [
23660
+ {
23661
+ "kind": "Content",
23662
+ "text": "get id(): "
23663
+ },
23664
+ {
23665
+ "kind": "Content",
23666
+ "text": "number | undefined"
23667
+ },
23668
+ {
23669
+ "kind": "Content",
23670
+ "text": ";"
23671
+ }
23672
+ ],
23673
+ "isReadonly": true,
23674
+ "isOptional": false,
23675
+ "releaseTag": "Public",
23676
+ "name": "id",
23677
+ "propertyTypeTokenRange": {
23678
+ "startIndex": 1,
23679
+ "endIndex": 2
23680
+ },
23681
+ "isStatic": false,
23682
+ "isProtected": false,
23683
+ "isAbstract": false
23684
+ },
23685
+ {
23686
+ "kind": "Property",
23687
+ "canonicalReference": "server!SceneUI#isLoaded:member",
23688
+ "docComment": "",
23689
+ "excerptTokens": [
23690
+ {
23691
+ "kind": "Content",
23692
+ "text": "get isLoaded(): "
23693
+ },
23694
+ {
23695
+ "kind": "Content",
23696
+ "text": "boolean"
23697
+ },
23698
+ {
23699
+ "kind": "Content",
23700
+ "text": ";"
23701
+ }
23702
+ ],
23703
+ "isReadonly": true,
23704
+ "isOptional": false,
23705
+ "releaseTag": "Public",
23706
+ "name": "isLoaded",
23707
+ "propertyTypeTokenRange": {
23708
+ "startIndex": 1,
23709
+ "endIndex": 2
23710
+ },
23711
+ "isStatic": false,
23712
+ "isProtected": false,
23713
+ "isAbstract": false
23714
+ },
23715
+ {
23716
+ "kind": "Method",
23717
+ "canonicalReference": "server!SceneUI#load:member(1)",
23718
+ "docComment": "/**\n * Loads the SceneUI into the world.\n *\n * @param world - The world to load the SceneUI into.\n */\n",
23719
+ "excerptTokens": [
23720
+ {
23721
+ "kind": "Content",
23722
+ "text": "load(world: "
23723
+ },
23724
+ {
23725
+ "kind": "Reference",
23726
+ "text": "World",
23727
+ "canonicalReference": "server!World:class"
23728
+ },
23729
+ {
23730
+ "kind": "Content",
23731
+ "text": "): "
23732
+ },
23733
+ {
23734
+ "kind": "Content",
23735
+ "text": "void"
23736
+ },
23737
+ {
23738
+ "kind": "Content",
23739
+ "text": ";"
23740
+ }
23741
+ ],
23742
+ "isStatic": false,
23743
+ "returnTypeTokenRange": {
23744
+ "startIndex": 3,
23745
+ "endIndex": 4
23746
+ },
23747
+ "releaseTag": "Public",
23748
+ "isProtected": false,
23749
+ "overloadIndex": 1,
23750
+ "parameters": [
23751
+ {
23752
+ "parameterName": "world",
23753
+ "parameterTypeTokenRange": {
23754
+ "startIndex": 1,
23755
+ "endIndex": 2
23756
+ },
23757
+ "isOptional": false
23758
+ }
23759
+ ],
23760
+ "isOptional": false,
23761
+ "isAbstract": false,
23762
+ "name": "load"
23763
+ },
23764
+ {
23765
+ "kind": "Property",
23766
+ "canonicalReference": "server!SceneUI#offset:member",
23767
+ "docComment": "",
23768
+ "excerptTokens": [
23769
+ {
23770
+ "kind": "Content",
23771
+ "text": "get offset(): "
23772
+ },
23773
+ {
23774
+ "kind": "Reference",
23775
+ "text": "Vector3Like",
23776
+ "canonicalReference": "server!Vector3Like:interface"
23777
+ },
23778
+ {
23779
+ "kind": "Content",
23780
+ "text": " | undefined"
23781
+ },
23782
+ {
23783
+ "kind": "Content",
23784
+ "text": ";"
23785
+ }
23786
+ ],
23787
+ "isReadonly": true,
23788
+ "isOptional": false,
23789
+ "releaseTag": "Public",
23790
+ "name": "offset",
23791
+ "propertyTypeTokenRange": {
23792
+ "startIndex": 1,
23793
+ "endIndex": 3
23794
+ },
23795
+ "isStatic": false,
23796
+ "isProtected": false,
23797
+ "isAbstract": false
23798
+ },
23799
+ {
23800
+ "kind": "Property",
23801
+ "canonicalReference": "server!SceneUI#position:member",
23802
+ "docComment": "",
23803
+ "excerptTokens": [
23804
+ {
23805
+ "kind": "Content",
23806
+ "text": "get position(): "
23807
+ },
23808
+ {
23809
+ "kind": "Reference",
23810
+ "text": "Vector3Like",
23811
+ "canonicalReference": "server!Vector3Like:interface"
23812
+ },
23813
+ {
23814
+ "kind": "Content",
23815
+ "text": " | undefined"
23816
+ },
23817
+ {
23818
+ "kind": "Content",
23819
+ "text": ";"
23820
+ }
23821
+ ],
23822
+ "isReadonly": true,
23823
+ "isOptional": false,
23824
+ "releaseTag": "Public",
23825
+ "name": "position",
23826
+ "propertyTypeTokenRange": {
23827
+ "startIndex": 1,
23828
+ "endIndex": 3
23829
+ },
23830
+ "isStatic": false,
23831
+ "isProtected": false,
23832
+ "isAbstract": false
23833
+ },
23834
+ {
23835
+ "kind": "Method",
23836
+ "canonicalReference": "server!SceneUI#setAttachedToEntity:member(1)",
23837
+ "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",
23838
+ "excerptTokens": [
23839
+ {
23840
+ "kind": "Content",
23841
+ "text": "setAttachedToEntity(entity: "
23842
+ },
23843
+ {
23844
+ "kind": "Reference",
23845
+ "text": "Entity",
23846
+ "canonicalReference": "server!Entity:class"
23847
+ },
23848
+ {
23849
+ "kind": "Content",
23850
+ "text": "): "
23851
+ },
23852
+ {
23853
+ "kind": "Content",
23854
+ "text": "void"
23855
+ },
23856
+ {
23857
+ "kind": "Content",
23858
+ "text": ";"
23859
+ }
23860
+ ],
23861
+ "isStatic": false,
23862
+ "returnTypeTokenRange": {
23863
+ "startIndex": 3,
23864
+ "endIndex": 4
23865
+ },
23866
+ "releaseTag": "Public",
23867
+ "isProtected": false,
23868
+ "overloadIndex": 1,
23869
+ "parameters": [
23870
+ {
23871
+ "parameterName": "entity",
23872
+ "parameterTypeTokenRange": {
23873
+ "startIndex": 1,
23874
+ "endIndex": 2
23875
+ },
23876
+ "isOptional": false
23877
+ }
23878
+ ],
23879
+ "isOptional": false,
23880
+ "isAbstract": false,
23881
+ "name": "setAttachedToEntity"
23882
+ },
23883
+ {
23884
+ "kind": "Method",
23885
+ "canonicalReference": "server!SceneUI#setOffset:member(1)",
23886
+ "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",
23887
+ "excerptTokens": [
23888
+ {
23889
+ "kind": "Content",
23890
+ "text": "setOffset(offset: "
23891
+ },
23892
+ {
23893
+ "kind": "Reference",
23894
+ "text": "Vector3Like",
23895
+ "canonicalReference": "server!Vector3Like:interface"
23896
+ },
23897
+ {
23898
+ "kind": "Content",
23899
+ "text": "): "
23900
+ },
23901
+ {
23902
+ "kind": "Content",
23903
+ "text": "void"
23904
+ },
23905
+ {
23906
+ "kind": "Content",
23907
+ "text": ";"
23908
+ }
23909
+ ],
23910
+ "isStatic": false,
23911
+ "returnTypeTokenRange": {
23912
+ "startIndex": 3,
23913
+ "endIndex": 4
23914
+ },
23915
+ "releaseTag": "Public",
23916
+ "isProtected": false,
23917
+ "overloadIndex": 1,
23918
+ "parameters": [
23919
+ {
23920
+ "parameterName": "offset",
23921
+ "parameterTypeTokenRange": {
23922
+ "startIndex": 1,
23923
+ "endIndex": 2
23924
+ },
23925
+ "isOptional": false
23926
+ }
23927
+ ],
23928
+ "isOptional": false,
23929
+ "isAbstract": false,
23930
+ "name": "setOffset"
23931
+ },
23932
+ {
23933
+ "kind": "Method",
23934
+ "canonicalReference": "server!SceneUI#setPosition:member(1)",
23935
+ "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",
23936
+ "excerptTokens": [
23937
+ {
23938
+ "kind": "Content",
23939
+ "text": "setPosition(position: "
23940
+ },
23941
+ {
23942
+ "kind": "Reference",
23943
+ "text": "Vector3Like",
23944
+ "canonicalReference": "server!Vector3Like:interface"
23945
+ },
23946
+ {
23947
+ "kind": "Content",
23948
+ "text": "): "
23949
+ },
23950
+ {
23951
+ "kind": "Content",
23952
+ "text": "void"
23953
+ },
23954
+ {
23955
+ "kind": "Content",
23956
+ "text": ";"
23957
+ }
23958
+ ],
23959
+ "isStatic": false,
23960
+ "returnTypeTokenRange": {
23961
+ "startIndex": 3,
23962
+ "endIndex": 4
23963
+ },
23964
+ "releaseTag": "Public",
23965
+ "isProtected": false,
23966
+ "overloadIndex": 1,
23967
+ "parameters": [
23968
+ {
23969
+ "parameterName": "position",
23970
+ "parameterTypeTokenRange": {
23971
+ "startIndex": 1,
23972
+ "endIndex": 2
23973
+ },
23974
+ "isOptional": false
23975
+ }
23976
+ ],
23977
+ "isOptional": false,
23978
+ "isAbstract": false,
23979
+ "name": "setPosition"
23980
+ },
23981
+ {
23982
+ "kind": "Method",
23983
+ "canonicalReference": "server!SceneUI#setState:member(1)",
23984
+ "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",
23985
+ "excerptTokens": [
23986
+ {
23987
+ "kind": "Content",
23988
+ "text": "setState(state: "
23989
+ },
23990
+ {
23991
+ "kind": "Content",
23992
+ "text": "object"
23993
+ },
23994
+ {
23995
+ "kind": "Content",
23996
+ "text": "): "
23997
+ },
23998
+ {
23999
+ "kind": "Content",
24000
+ "text": "void"
24001
+ },
24002
+ {
24003
+ "kind": "Content",
24004
+ "text": ";"
24005
+ }
24006
+ ],
24007
+ "isStatic": false,
24008
+ "returnTypeTokenRange": {
24009
+ "startIndex": 3,
24010
+ "endIndex": 4
24011
+ },
24012
+ "releaseTag": "Public",
24013
+ "isProtected": false,
24014
+ "overloadIndex": 1,
24015
+ "parameters": [
24016
+ {
24017
+ "parameterName": "state",
24018
+ "parameterTypeTokenRange": {
24019
+ "startIndex": 1,
24020
+ "endIndex": 2
24021
+ },
24022
+ "isOptional": false
24023
+ }
24024
+ ],
24025
+ "isOptional": false,
24026
+ "isAbstract": false,
24027
+ "name": "setState"
24028
+ },
24029
+ {
24030
+ "kind": "Property",
24031
+ "canonicalReference": "server!SceneUI#state:member",
24032
+ "docComment": "",
24033
+ "excerptTokens": [
24034
+ {
24035
+ "kind": "Content",
24036
+ "text": "get state(): "
24037
+ },
24038
+ {
24039
+ "kind": "Reference",
24040
+ "text": "Readonly",
24041
+ "canonicalReference": "!Readonly:type"
24042
+ },
24043
+ {
24044
+ "kind": "Content",
24045
+ "text": "<object>"
24046
+ },
24047
+ {
24048
+ "kind": "Content",
24049
+ "text": ";"
24050
+ }
24051
+ ],
24052
+ "isReadonly": true,
24053
+ "isOptional": false,
24054
+ "releaseTag": "Public",
24055
+ "name": "state",
24056
+ "propertyTypeTokenRange": {
24057
+ "startIndex": 1,
24058
+ "endIndex": 3
24059
+ },
24060
+ "isStatic": false,
24061
+ "isProtected": false,
24062
+ "isAbstract": false
24063
+ },
24064
+ {
24065
+ "kind": "Property",
24066
+ "canonicalReference": "server!SceneUI#templateId:member",
24067
+ "docComment": "",
24068
+ "excerptTokens": [
24069
+ {
24070
+ "kind": "Content",
24071
+ "text": "get templateId(): "
24072
+ },
24073
+ {
24074
+ "kind": "Content",
24075
+ "text": "string"
24076
+ },
24077
+ {
24078
+ "kind": "Content",
24079
+ "text": ";"
24080
+ }
24081
+ ],
24082
+ "isReadonly": true,
24083
+ "isOptional": false,
24084
+ "releaseTag": "Public",
24085
+ "name": "templateId",
24086
+ "propertyTypeTokenRange": {
24087
+ "startIndex": 1,
24088
+ "endIndex": 2
24089
+ },
24090
+ "isStatic": false,
24091
+ "isProtected": false,
24092
+ "isAbstract": false
24093
+ },
24094
+ {
24095
+ "kind": "Method",
24096
+ "canonicalReference": "server!SceneUI#unload:member(1)",
24097
+ "docComment": "/**\n * Unloads the SceneUI from the world.\n */\n",
24098
+ "excerptTokens": [
24099
+ {
24100
+ "kind": "Content",
24101
+ "text": "unload(): "
24102
+ },
24103
+ {
24104
+ "kind": "Content",
24105
+ "text": "void"
24106
+ },
24107
+ {
24108
+ "kind": "Content",
24109
+ "text": ";"
24110
+ }
24111
+ ],
24112
+ "isStatic": false,
24113
+ "returnTypeTokenRange": {
24114
+ "startIndex": 1,
24115
+ "endIndex": 2
24116
+ },
24117
+ "releaseTag": "Public",
24118
+ "isProtected": false,
24119
+ "overloadIndex": 1,
24120
+ "parameters": [],
24121
+ "isOptional": false,
24122
+ "isAbstract": false,
24123
+ "name": "unload"
24124
+ },
24125
+ {
24126
+ "kind": "Property",
24127
+ "canonicalReference": "server!SceneUI#world:member",
24128
+ "docComment": "",
24129
+ "excerptTokens": [
24130
+ {
24131
+ "kind": "Content",
24132
+ "text": "get world(): "
24133
+ },
24134
+ {
24135
+ "kind": "Reference",
24136
+ "text": "World",
24137
+ "canonicalReference": "server!World:class"
24138
+ },
24139
+ {
24140
+ "kind": "Content",
24141
+ "text": " | undefined"
24142
+ },
24143
+ {
24144
+ "kind": "Content",
24145
+ "text": ";"
24146
+ }
24147
+ ],
24148
+ "isReadonly": true,
24149
+ "isOptional": false,
24150
+ "releaseTag": "Public",
24151
+ "name": "world",
24152
+ "propertyTypeTokenRange": {
24153
+ "startIndex": 1,
24154
+ "endIndex": 3
24155
+ },
24156
+ "isStatic": false,
24157
+ "isProtected": false,
24158
+ "isAbstract": false
24159
+ }
24160
+ ],
24161
+ "implementsTokenRanges": [
24162
+ {
24163
+ "startIndex": 1,
24164
+ "endIndex": 2
24165
+ }
24166
+ ]
24167
+ },
24168
+ {
24169
+ "kind": "Class",
24170
+ "canonicalReference": "server!SceneUIManager:class",
24171
+ "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",
24172
+ "excerptTokens": [
24173
+ {
24174
+ "kind": "Content",
24175
+ "text": "export default class SceneUIManager "
24176
+ }
24177
+ ],
24178
+ "fileUrlPath": "src/world/ui/SceneUIManager.ts",
24179
+ "releaseTag": "Public",
24180
+ "isAbstract": false,
24181
+ "name": "SceneUIManager",
24182
+ "preserveMemberOrder": false,
24183
+ "members": [
24184
+ {
24185
+ "kind": "Method",
24186
+ "canonicalReference": "server!SceneUIManager#getAllEntityAttachedSceneUIs:member(1)",
24187
+ "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",
24188
+ "excerptTokens": [
24189
+ {
24190
+ "kind": "Content",
24191
+ "text": "getAllEntityAttachedSceneUIs(entity: "
24192
+ },
24193
+ {
24194
+ "kind": "Reference",
24195
+ "text": "Entity",
24196
+ "canonicalReference": "server!Entity:class"
24197
+ },
24198
+ {
24199
+ "kind": "Content",
24200
+ "text": "): "
24201
+ },
24202
+ {
24203
+ "kind": "Reference",
24204
+ "text": "SceneUI",
24205
+ "canonicalReference": "server!SceneUI:class"
24206
+ },
24207
+ {
24208
+ "kind": "Content",
24209
+ "text": "[]"
24210
+ },
24211
+ {
24212
+ "kind": "Content",
24213
+ "text": ";"
24214
+ }
24215
+ ],
24216
+ "isStatic": false,
24217
+ "returnTypeTokenRange": {
24218
+ "startIndex": 3,
24219
+ "endIndex": 5
24220
+ },
24221
+ "releaseTag": "Public",
24222
+ "isProtected": false,
24223
+ "overloadIndex": 1,
24224
+ "parameters": [
24225
+ {
24226
+ "parameterName": "entity",
24227
+ "parameterTypeTokenRange": {
24228
+ "startIndex": 1,
24229
+ "endIndex": 2
24230
+ },
24231
+ "isOptional": false
24232
+ }
24233
+ ],
24234
+ "isOptional": false,
24235
+ "isAbstract": false,
24236
+ "name": "getAllEntityAttachedSceneUIs"
24237
+ },
24238
+ {
24239
+ "kind": "Method",
24240
+ "canonicalReference": "server!SceneUIManager#getAllSceneUIs:member(1)",
24241
+ "docComment": "/**\n * Retrieves all loaded SceneUI instances for the world.\n *\n * @returns An array of SceneUI instances.\n */\n",
24242
+ "excerptTokens": [
24243
+ {
24244
+ "kind": "Content",
24245
+ "text": "getAllSceneUIs(): "
24246
+ },
24247
+ {
24248
+ "kind": "Reference",
24249
+ "text": "SceneUI",
24250
+ "canonicalReference": "server!SceneUI:class"
24251
+ },
24252
+ {
24253
+ "kind": "Content",
24254
+ "text": "[]"
24255
+ },
24256
+ {
24257
+ "kind": "Content",
24258
+ "text": ";"
24259
+ }
24260
+ ],
24261
+ "isStatic": false,
24262
+ "returnTypeTokenRange": {
24263
+ "startIndex": 1,
24264
+ "endIndex": 3
24265
+ },
24266
+ "releaseTag": "Public",
24267
+ "isProtected": false,
24268
+ "overloadIndex": 1,
24269
+ "parameters": [],
24270
+ "isOptional": false,
24271
+ "isAbstract": false,
24272
+ "name": "getAllSceneUIs"
24273
+ },
24274
+ {
24275
+ "kind": "Method",
24276
+ "canonicalReference": "server!SceneUIManager#unloadEntityAttachedSceneUIs:member(1)",
24277
+ "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",
24278
+ "excerptTokens": [
24279
+ {
24280
+ "kind": "Content",
24281
+ "text": "unloadEntityAttachedSceneUIs(entity: "
24282
+ },
24283
+ {
24284
+ "kind": "Reference",
24285
+ "text": "Entity",
24286
+ "canonicalReference": "server!Entity:class"
24287
+ },
24288
+ {
24289
+ "kind": "Content",
24290
+ "text": "): "
24291
+ },
24292
+ {
24293
+ "kind": "Content",
24294
+ "text": "void"
24295
+ },
24296
+ {
24297
+ "kind": "Content",
24298
+ "text": ";"
24299
+ }
24300
+ ],
24301
+ "isStatic": false,
24302
+ "returnTypeTokenRange": {
24303
+ "startIndex": 3,
24304
+ "endIndex": 4
24305
+ },
24306
+ "releaseTag": "Public",
24307
+ "isProtected": false,
24308
+ "overloadIndex": 1,
24309
+ "parameters": [
24310
+ {
24311
+ "parameterName": "entity",
24312
+ "parameterTypeTokenRange": {
24313
+ "startIndex": 1,
24314
+ "endIndex": 2
24315
+ },
24316
+ "isOptional": false
24317
+ }
24318
+ ],
24319
+ "isOptional": false,
24320
+ "isAbstract": false,
24321
+ "name": "unloadEntityAttachedSceneUIs"
24322
+ },
24323
+ {
24324
+ "kind": "Property",
24325
+ "canonicalReference": "server!SceneUIManager#world:member",
24326
+ "docComment": "/**\n * The world the SceneUIManager is for.\n */\n",
24327
+ "excerptTokens": [
24328
+ {
24329
+ "kind": "Content",
24330
+ "text": "get world(): "
24331
+ },
24332
+ {
24333
+ "kind": "Reference",
24334
+ "text": "World",
24335
+ "canonicalReference": "server!World:class"
24336
+ },
24337
+ {
24338
+ "kind": "Content",
24339
+ "text": ";"
24340
+ }
24341
+ ],
24342
+ "isReadonly": true,
24343
+ "isOptional": false,
24344
+ "releaseTag": "Public",
24345
+ "name": "world",
24346
+ "propertyTypeTokenRange": {
24347
+ "startIndex": 1,
24348
+ "endIndex": 2
24349
+ },
24350
+ "isStatic": false,
24351
+ "isProtected": false,
24352
+ "isAbstract": false
24353
+ }
24354
+ ],
24355
+ "implementsTokenRanges": []
24356
+ },
24357
+ {
24358
+ "kind": "Interface",
24359
+ "canonicalReference": "server!SceneUIOptions:interface",
24360
+ "docComment": "/**\n * Options for creating a SceneUI instance.\n *\n * @public\n */\n",
24361
+ "excerptTokens": [
24362
+ {
24363
+ "kind": "Content",
24364
+ "text": "export interface SceneUIOptions "
24365
+ }
24366
+ ],
24367
+ "fileUrlPath": "src/world/ui/SceneUI.ts",
24368
+ "releaseTag": "Public",
24369
+ "name": "SceneUIOptions",
24370
+ "preserveMemberOrder": false,
24371
+ "members": [
24372
+ {
24373
+ "kind": "PropertySignature",
24374
+ "canonicalReference": "server!SceneUIOptions#attachedToEntity:member",
24375
+ "docComment": "/**\n * If set, SceneUI will follow the entity's position\n */\n",
24376
+ "excerptTokens": [
24377
+ {
24378
+ "kind": "Content",
24379
+ "text": "attachedToEntity?: "
24380
+ },
24381
+ {
24382
+ "kind": "Reference",
24383
+ "text": "Entity",
24384
+ "canonicalReference": "server!Entity:class"
24385
+ },
24386
+ {
24387
+ "kind": "Content",
24388
+ "text": ";"
24389
+ }
24390
+ ],
24391
+ "isReadonly": false,
24392
+ "isOptional": true,
24393
+ "releaseTag": "Public",
24394
+ "name": "attachedToEntity",
24395
+ "propertyTypeTokenRange": {
24396
+ "startIndex": 1,
24397
+ "endIndex": 2
24398
+ }
24399
+ },
24400
+ {
24401
+ "kind": "PropertySignature",
24402
+ "canonicalReference": "server!SceneUIOptions#offset:member",
24403
+ "docComment": "/**\n * The offset of the SceneUI from the attached entity or position\n */\n",
24404
+ "excerptTokens": [
24405
+ {
24406
+ "kind": "Content",
24407
+ "text": "offset?: "
24408
+ },
24409
+ {
24410
+ "kind": "Reference",
24411
+ "text": "Vector3Like",
24412
+ "canonicalReference": "server!Vector3Like:interface"
24413
+ },
24414
+ {
24415
+ "kind": "Content",
24416
+ "text": ";"
24417
+ }
24418
+ ],
24419
+ "isReadonly": false,
24420
+ "isOptional": true,
24421
+ "releaseTag": "Public",
24422
+ "name": "offset",
24423
+ "propertyTypeTokenRange": {
24424
+ "startIndex": 1,
24425
+ "endIndex": 2
24426
+ }
24427
+ },
24428
+ {
24429
+ "kind": "PropertySignature",
24430
+ "canonicalReference": "server!SceneUIOptions#position:member",
24431
+ "docComment": "/**\n * If set, SceneUI will be attached at this position\n */\n",
24432
+ "excerptTokens": [
24433
+ {
24434
+ "kind": "Content",
24435
+ "text": "position?: "
24436
+ },
24437
+ {
24438
+ "kind": "Reference",
24439
+ "text": "Vector3Like",
24440
+ "canonicalReference": "server!Vector3Like:interface"
24441
+ },
24442
+ {
24443
+ "kind": "Content",
24444
+ "text": ";"
24445
+ }
24446
+ ],
24447
+ "isReadonly": false,
24448
+ "isOptional": true,
24449
+ "releaseTag": "Public",
24450
+ "name": "position",
24451
+ "propertyTypeTokenRange": {
24452
+ "startIndex": 1,
24453
+ "endIndex": 2
24454
+ }
24455
+ },
24456
+ {
24457
+ "kind": "PropertySignature",
24458
+ "canonicalReference": "server!SceneUIOptions#state:member",
24459
+ "docComment": "/**\n * The state of the SceneUI\n */\n",
24460
+ "excerptTokens": [
24461
+ {
24462
+ "kind": "Content",
24463
+ "text": "state?: "
24464
+ },
24465
+ {
24466
+ "kind": "Content",
24467
+ "text": "object"
24468
+ },
24469
+ {
24470
+ "kind": "Content",
24471
+ "text": ";"
24472
+ }
24473
+ ],
24474
+ "isReadonly": false,
24475
+ "isOptional": true,
24476
+ "releaseTag": "Public",
24477
+ "name": "state",
24478
+ "propertyTypeTokenRange": {
24479
+ "startIndex": 1,
24480
+ "endIndex": 2
24481
+ }
24482
+ },
24483
+ {
24484
+ "kind": "PropertySignature",
24485
+ "canonicalReference": "server!SceneUIOptions#templateId:member",
24486
+ "docComment": "/**\n * The template ID to use for this SceneUI\n */\n",
24487
+ "excerptTokens": [
24488
+ {
24489
+ "kind": "Content",
24490
+ "text": "templateId: "
24491
+ },
24492
+ {
24493
+ "kind": "Content",
24494
+ "text": "string"
24495
+ },
24496
+ {
24497
+ "kind": "Content",
24498
+ "text": ";"
24499
+ }
24500
+ ],
24501
+ "isReadonly": false,
24502
+ "isOptional": false,
24503
+ "releaseTag": "Public",
24504
+ "name": "templateId",
24505
+ "propertyTypeTokenRange": {
24506
+ "startIndex": 1,
24507
+ "endIndex": 2
24508
+ }
24509
+ }
24510
+ ],
24511
+ "extendsTokenRanges": []
24512
+ },
23562
24513
  {
23563
24514
  "kind": "Class",
23564
24515
  "canonicalReference": "server!SimpleEntityController:class",
@@ -26439,6 +27390,37 @@
26439
27390
  "isProtected": false,
26440
27391
  "isAbstract": false
26441
27392
  },
27393
+ {
27394
+ "kind": "Property",
27395
+ "canonicalReference": "server!World#sceneUIManager:member",
27396
+ "docComment": "/**\n * The scene UI manager for the world.\n */\n",
27397
+ "excerptTokens": [
27398
+ {
27399
+ "kind": "Content",
27400
+ "text": "get sceneUIManager(): "
27401
+ },
27402
+ {
27403
+ "kind": "Reference",
27404
+ "text": "SceneUIManager",
27405
+ "canonicalReference": "server!SceneUIManager:class"
27406
+ },
27407
+ {
27408
+ "kind": "Content",
27409
+ "text": ";"
27410
+ }
27411
+ ],
27412
+ "isReadonly": true,
27413
+ "isOptional": false,
27414
+ "releaseTag": "Public",
27415
+ "name": "sceneUIManager",
27416
+ "propertyTypeTokenRange": {
27417
+ "startIndex": 1,
27418
+ "endIndex": 2
27419
+ },
27420
+ "isStatic": false,
27421
+ "isProtected": false,
27422
+ "isAbstract": false
27423
+ },
26442
27424
  {
26443
27425
  "kind": "Property",
26444
27426
  "canonicalReference": "server!World#simulation:member",