hytopia 0.1.48 → 0.1.50
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.
- package/bin/scripts.js +1 -1
- package/docs/server.basecharactercontroller.md +4 -4
- package/docs/server.basecharactercontroller.ontickwithplayerinput.md +13 -0
- package/docs/{server.basecharactercontroller.tickplayermovement.md → server.basecharactercontroller.tickwithplayerinput.md} +8 -8
- package/docs/server.defaultcharactercontroller.md +1 -1
- package/docs/{server.defaultcharactercontroller.tickplayermovement.md → server.defaultcharactercontroller.tickwithplayerinput.md} +8 -8
- package/docs/server.md +38 -5
- package/docs/server.player.cameraorientation.md +13 -0
- package/docs/server.player.input.md +13 -0
- package/docs/server.player.md +10 -10
- package/docs/server.playercameraorientation.md +16 -0
- package/docs/server.playerinput.md +13 -0
- package/docs/server.playerui.load.md +53 -0
- package/docs/server.playerui.md +132 -0
- package/docs/server.playerui.ondata.md +18 -0
- package/docs/server.playerui.player.md +13 -0
- package/docs/server.playerui.senddata.md +53 -0
- package/docs/server.playeruieventpayload.load.htmluri.md +11 -0
- package/docs/server.playeruieventpayload.load.md +70 -0
- package/docs/server.playeruieventpayload.load.playerui.md +11 -0
- package/docs/server.playeruieventpayload.md +46 -0
- package/docs/server.playeruieventpayload.senddata.data.md +11 -0
- package/docs/server.playeruieventpayload.senddata.md +70 -0
- package/docs/server.playeruieventpayload.senddata.playerui.md +11 -0
- package/docs/server.playeruieventtype.md +61 -0
- package/docs/server.supported_input_keys.md +1 -1
- package/examples/big-world/README.md +4 -0
- package/examples/big-world/package.json +14 -0
- package/examples/block-entity/README.md +3 -0
- package/examples/block-entity/assets/map.json +2623 -0
- package/examples/block-entity/package.json +15 -0
- package/examples/character-controller/MyCharacterController.ts +8 -8
- package/examples/character-controller/README.md +4 -0
- package/examples/character-controller/assets/map.json +2623 -0
- package/examples/character-controller/package.json +15 -0
- package/examples/custom-ui/README.md +4 -0
- package/examples/custom-ui/assets/map.json +2623 -0
- package/examples/custom-ui/package.json +15 -0
- package/examples/entity-spawn/README.md +3 -0
- package/examples/entity-spawn/assets/map.json +2623 -0
- package/examples/entity-spawn/package.json +15 -0
- package/examples/payload-game/README.md +8 -0
- package/examples/payload-game/assets/ui/index.html +42 -0
- package/examples/payload-game/index.ts +24 -18
- package/examples/payload-game/package.json +15 -0
- package/package.json +1 -1
- package/server.api.json +504 -99
- package/server.d.ts +42 -23
- package/server.js +80 -80
- package/docs/server.basecharactercontroller.ontickplayermovement.md +0 -13
- package/docs/server.player.inputstate.md +0 -13
- package/docs/server.player.orientationstate.md +0 -13
- package/docs/server.playerinputstate.md +0 -13
- package/docs/server.playerorientationstate.md +0 -16
package/server.api.json
CHANGED
@@ -2785,30 +2785,30 @@
|
|
2785
2785
|
},
|
2786
2786
|
{
|
2787
2787
|
"kind": "Property",
|
2788
|
-
"canonicalReference": "server!BaseCharacterController#
|
2789
|
-
"docComment": "/**\n * A callback function for when the controller ticks player movement.\n *\n * @param
|
2788
|
+
"canonicalReference": "server!BaseCharacterController#onTickWithPlayerInput:member",
|
2789
|
+
"docComment": "/**\n * A callback function for when the controller ticks player movement. This is called every tick by a PlayerEntity with a character controller.\n *\n * @param input - The current input state of the player.\n *\n * @param cameraOrientation - The current camera orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
|
2790
2790
|
"excerptTokens": [
|
2791
2791
|
{
|
2792
2792
|
"kind": "Content",
|
2793
|
-
"text": "
|
2793
|
+
"text": "onTickWithPlayerInput?: "
|
2794
2794
|
},
|
2795
2795
|
{
|
2796
2796
|
"kind": "Content",
|
2797
|
-
"text": "(
|
2797
|
+
"text": "(input: "
|
2798
2798
|
},
|
2799
2799
|
{
|
2800
2800
|
"kind": "Reference",
|
2801
|
-
"text": "
|
2802
|
-
"canonicalReference": "server!
|
2801
|
+
"text": "PlayerInput",
|
2802
|
+
"canonicalReference": "server!PlayerInput:type"
|
2803
2803
|
},
|
2804
2804
|
{
|
2805
2805
|
"kind": "Content",
|
2806
|
-
"text": ",
|
2806
|
+
"text": ", cameraOrientation: "
|
2807
2807
|
},
|
2808
2808
|
{
|
2809
2809
|
"kind": "Reference",
|
2810
|
-
"text": "
|
2811
|
-
"canonicalReference": "server!
|
2810
|
+
"text": "PlayerCameraOrientation",
|
2811
|
+
"canonicalReference": "server!PlayerCameraOrientation:type"
|
2812
2812
|
},
|
2813
2813
|
{
|
2814
2814
|
"kind": "Content",
|
@@ -2822,7 +2822,7 @@
|
|
2822
2822
|
"isReadonly": false,
|
2823
2823
|
"isOptional": true,
|
2824
2824
|
"releaseTag": "Public",
|
2825
|
-
"name": "
|
2825
|
+
"name": "onTickWithPlayerInput",
|
2826
2826
|
"propertyTypeTokenRange": {
|
2827
2827
|
"startIndex": 1,
|
2828
2828
|
"endIndex": 6
|
@@ -2881,26 +2881,26 @@
|
|
2881
2881
|
},
|
2882
2882
|
{
|
2883
2883
|
"kind": "Method",
|
2884
|
-
"canonicalReference": "server!BaseCharacterController#
|
2885
|
-
"docComment": "/**\n * Override this method to handle entity movements based on player input for your character controller.\n *\n * @param
|
2884
|
+
"canonicalReference": "server!BaseCharacterController#tickWithPlayerInput:member(1)",
|
2885
|
+
"docComment": "/**\n * Override this method to handle entity movements based on player input for your character controller.\n *\n * @param input - The current input state of the player.\n *\n * @param cameraOrientation - The current camera orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
|
2886
2886
|
"excerptTokens": [
|
2887
2887
|
{
|
2888
2888
|
"kind": "Content",
|
2889
|
-
"text": "
|
2889
|
+
"text": "tickWithPlayerInput(input: "
|
2890
2890
|
},
|
2891
2891
|
{
|
2892
2892
|
"kind": "Reference",
|
2893
|
-
"text": "
|
2894
|
-
"canonicalReference": "server!
|
2893
|
+
"text": "PlayerInput",
|
2894
|
+
"canonicalReference": "server!PlayerInput:type"
|
2895
2895
|
},
|
2896
2896
|
{
|
2897
2897
|
"kind": "Content",
|
2898
|
-
"text": ",
|
2898
|
+
"text": ", cameraOrientation: "
|
2899
2899
|
},
|
2900
2900
|
{
|
2901
2901
|
"kind": "Reference",
|
2902
|
-
"text": "
|
2903
|
-
"canonicalReference": "server!
|
2902
|
+
"text": "PlayerCameraOrientation",
|
2903
|
+
"canonicalReference": "server!PlayerCameraOrientation:type"
|
2904
2904
|
},
|
2905
2905
|
{
|
2906
2906
|
"kind": "Content",
|
@@ -2933,7 +2933,7 @@
|
|
2933
2933
|
"overloadIndex": 1,
|
2934
2934
|
"parameters": [
|
2935
2935
|
{
|
2936
|
-
"parameterName": "
|
2936
|
+
"parameterName": "input",
|
2937
2937
|
"parameterTypeTokenRange": {
|
2938
2938
|
"startIndex": 1,
|
2939
2939
|
"endIndex": 2
|
@@ -2941,7 +2941,7 @@
|
|
2941
2941
|
"isOptional": false
|
2942
2942
|
},
|
2943
2943
|
{
|
2944
|
-
"parameterName": "
|
2944
|
+
"parameterName": "cameraOrientation",
|
2945
2945
|
"parameterTypeTokenRange": {
|
2946
2946
|
"startIndex": 3,
|
2947
2947
|
"endIndex": 4
|
@@ -2959,7 +2959,7 @@
|
|
2959
2959
|
],
|
2960
2960
|
"isOptional": false,
|
2961
2961
|
"isAbstract": false,
|
2962
|
-
"name": "
|
2962
|
+
"name": "tickWithPlayerInput"
|
2963
2963
|
}
|
2964
2964
|
],
|
2965
2965
|
"implementsTokenRanges": []
|
@@ -8893,26 +8893,26 @@
|
|
8893
8893
|
},
|
8894
8894
|
{
|
8895
8895
|
"kind": "Method",
|
8896
|
-
"canonicalReference": "server!DefaultCharacterController#
|
8897
|
-
"docComment": "/**\n * Ticks the player movement for the character controller, overriding the default implementation.\n *\n * @param
|
8896
|
+
"canonicalReference": "server!DefaultCharacterController#tickWithPlayerInput:member(1)",
|
8897
|
+
"docComment": "/**\n * Ticks the player movement for the character controller, overriding the default implementation.\n *\n * @param input - The current input state of the player.\n *\n * @param cameraOrientation - The current camera orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
|
8898
8898
|
"excerptTokens": [
|
8899
8899
|
{
|
8900
8900
|
"kind": "Content",
|
8901
|
-
"text": "
|
8901
|
+
"text": "tickWithPlayerInput(input: "
|
8902
8902
|
},
|
8903
8903
|
{
|
8904
8904
|
"kind": "Reference",
|
8905
|
-
"text": "
|
8906
|
-
"canonicalReference": "server!
|
8905
|
+
"text": "PlayerInput",
|
8906
|
+
"canonicalReference": "server!PlayerInput:type"
|
8907
8907
|
},
|
8908
8908
|
{
|
8909
8909
|
"kind": "Content",
|
8910
|
-
"text": ",
|
8910
|
+
"text": ", cameraOrientation: "
|
8911
8911
|
},
|
8912
8912
|
{
|
8913
8913
|
"kind": "Reference",
|
8914
|
-
"text": "
|
8915
|
-
"canonicalReference": "server!
|
8914
|
+
"text": "PlayerCameraOrientation",
|
8915
|
+
"canonicalReference": "server!PlayerCameraOrientation:type"
|
8916
8916
|
},
|
8917
8917
|
{
|
8918
8918
|
"kind": "Content",
|
@@ -8945,7 +8945,7 @@
|
|
8945
8945
|
"overloadIndex": 1,
|
8946
8946
|
"parameters": [
|
8947
8947
|
{
|
8948
|
-
"parameterName": "
|
8948
|
+
"parameterName": "input",
|
8949
8949
|
"parameterTypeTokenRange": {
|
8950
8950
|
"startIndex": 1,
|
8951
8951
|
"endIndex": 2
|
@@ -8953,7 +8953,7 @@
|
|
8953
8953
|
"isOptional": false
|
8954
8954
|
},
|
8955
8955
|
{
|
8956
|
-
"parameterName": "
|
8956
|
+
"parameterName": "cameraOrientation",
|
8957
8957
|
"parameterTypeTokenRange": {
|
8958
8958
|
"startIndex": 3,
|
8959
8959
|
"endIndex": 4
|
@@ -8971,7 +8971,7 @@
|
|
8971
8971
|
],
|
8972
8972
|
"isOptional": false,
|
8973
8973
|
"isAbstract": false,
|
8974
|
-
"name": "
|
8974
|
+
"name": "tickWithPlayerInput"
|
8975
8975
|
},
|
8976
8976
|
{
|
8977
8977
|
"kind": "Property",
|
@@ -13232,6 +13232,50 @@
|
|
13232
13232
|
"isProtected": false,
|
13233
13233
|
"isAbstract": false
|
13234
13234
|
},
|
13235
|
+
{
|
13236
|
+
"kind": "Property",
|
13237
|
+
"canonicalReference": "server!Player#cameraOrientation:member",
|
13238
|
+
"docComment": "/**\n * The current {@link PlayerCameraOrientation} of the player.\n */\n",
|
13239
|
+
"excerptTokens": [
|
13240
|
+
{
|
13241
|
+
"kind": "Content",
|
13242
|
+
"text": "get cameraOrientation(): "
|
13243
|
+
},
|
13244
|
+
{
|
13245
|
+
"kind": "Reference",
|
13246
|
+
"text": "Readonly",
|
13247
|
+
"canonicalReference": "!Readonly:type"
|
13248
|
+
},
|
13249
|
+
{
|
13250
|
+
"kind": "Content",
|
13251
|
+
"text": "<"
|
13252
|
+
},
|
13253
|
+
{
|
13254
|
+
"kind": "Reference",
|
13255
|
+
"text": "PlayerCameraOrientation",
|
13256
|
+
"canonicalReference": "server!PlayerCameraOrientation:type"
|
13257
|
+
},
|
13258
|
+
{
|
13259
|
+
"kind": "Content",
|
13260
|
+
"text": ">"
|
13261
|
+
},
|
13262
|
+
{
|
13263
|
+
"kind": "Content",
|
13264
|
+
"text": ";"
|
13265
|
+
}
|
13266
|
+
],
|
13267
|
+
"isReadonly": true,
|
13268
|
+
"isOptional": false,
|
13269
|
+
"releaseTag": "Public",
|
13270
|
+
"name": "cameraOrientation",
|
13271
|
+
"propertyTypeTokenRange": {
|
13272
|
+
"startIndex": 1,
|
13273
|
+
"endIndex": 5
|
13274
|
+
},
|
13275
|
+
"isStatic": false,
|
13276
|
+
"isProtected": false,
|
13277
|
+
"isAbstract": false
|
13278
|
+
},
|
13235
13279
|
{
|
13236
13280
|
"kind": "Method",
|
13237
13281
|
"canonicalReference": "server!Player#disconnect:member(1)",
|
@@ -13295,12 +13339,12 @@
|
|
13295
13339
|
},
|
13296
13340
|
{
|
13297
13341
|
"kind": "Property",
|
13298
|
-
"canonicalReference": "server!Player#
|
13299
|
-
"docComment": "/**\n * The current {@link
|
13342
|
+
"canonicalReference": "server!Player#input:member",
|
13343
|
+
"docComment": "/**\n * The current {@link PlayerInput} of the player.\n */\n",
|
13300
13344
|
"excerptTokens": [
|
13301
13345
|
{
|
13302
13346
|
"kind": "Content",
|
13303
|
-
"text": "get
|
13347
|
+
"text": "get input(): "
|
13304
13348
|
},
|
13305
13349
|
{
|
13306
13350
|
"kind": "Reference",
|
@@ -13313,8 +13357,8 @@
|
|
13313
13357
|
},
|
13314
13358
|
{
|
13315
13359
|
"kind": "Reference",
|
13316
|
-
"text": "
|
13317
|
-
"canonicalReference": "server!
|
13360
|
+
"text": "PlayerInput",
|
13361
|
+
"canonicalReference": "server!PlayerInput:type"
|
13318
13362
|
},
|
13319
13363
|
{
|
13320
13364
|
"kind": "Content",
|
@@ -13328,7 +13372,7 @@
|
|
13328
13372
|
"isReadonly": true,
|
13329
13373
|
"isOptional": false,
|
13330
13374
|
"releaseTag": "Public",
|
13331
|
-
"name": "
|
13375
|
+
"name": "input",
|
13332
13376
|
"propertyTypeTokenRange": {
|
13333
13377
|
"startIndex": 1,
|
13334
13378
|
"endIndex": 5
|
@@ -13417,50 +13461,6 @@
|
|
13417
13461
|
"isAbstract": false,
|
13418
13462
|
"name": "leaveWorld"
|
13419
13463
|
},
|
13420
|
-
{
|
13421
|
-
"kind": "Property",
|
13422
|
-
"canonicalReference": "server!Player#orientationState:member",
|
13423
|
-
"docComment": "/**\n * The current {@link PlayerOrientationState} of the player.\n */\n",
|
13424
|
-
"excerptTokens": [
|
13425
|
-
{
|
13426
|
-
"kind": "Content",
|
13427
|
-
"text": "get orientationState(): "
|
13428
|
-
},
|
13429
|
-
{
|
13430
|
-
"kind": "Reference",
|
13431
|
-
"text": "Readonly",
|
13432
|
-
"canonicalReference": "!Readonly:type"
|
13433
|
-
},
|
13434
|
-
{
|
13435
|
-
"kind": "Content",
|
13436
|
-
"text": "<"
|
13437
|
-
},
|
13438
|
-
{
|
13439
|
-
"kind": "Reference",
|
13440
|
-
"text": "PlayerOrientationState",
|
13441
|
-
"canonicalReference": "server!PlayerOrientationState:type"
|
13442
|
-
},
|
13443
|
-
{
|
13444
|
-
"kind": "Content",
|
13445
|
-
"text": ">"
|
13446
|
-
},
|
13447
|
-
{
|
13448
|
-
"kind": "Content",
|
13449
|
-
"text": ";"
|
13450
|
-
}
|
13451
|
-
],
|
13452
|
-
"isReadonly": true,
|
13453
|
-
"isOptional": false,
|
13454
|
-
"releaseTag": "Public",
|
13455
|
-
"name": "orientationState",
|
13456
|
-
"propertyTypeTokenRange": {
|
13457
|
-
"startIndex": 1,
|
13458
|
-
"endIndex": 5
|
13459
|
-
},
|
13460
|
-
"isStatic": false,
|
13461
|
-
"isProtected": false,
|
13462
|
-
"isAbstract": false
|
13463
|
-
},
|
13464
13464
|
{
|
13465
13465
|
"kind": "Property",
|
13466
13466
|
"canonicalReference": "server!Player#ui:member",
|
@@ -13473,7 +13473,7 @@
|
|
13473
13473
|
{
|
13474
13474
|
"kind": "Reference",
|
13475
13475
|
"text": "PlayerUI",
|
13476
|
-
"canonicalReference": "server
|
13476
|
+
"canonicalReference": "server!PlayerUI:class"
|
13477
13477
|
},
|
13478
13478
|
{
|
13479
13479
|
"kind": "Content",
|
@@ -15944,6 +15944,32 @@
|
|
15944
15944
|
}
|
15945
15945
|
]
|
15946
15946
|
},
|
15947
|
+
{
|
15948
|
+
"kind": "TypeAlias",
|
15949
|
+
"canonicalReference": "server!PlayerCameraOrientation:type",
|
15950
|
+
"docComment": "/**\n * The camera orientation state of a Player.\n *\n * @public\n */\n",
|
15951
|
+
"excerptTokens": [
|
15952
|
+
{
|
15953
|
+
"kind": "Content",
|
15954
|
+
"text": "export type PlayerCameraOrientation = "
|
15955
|
+
},
|
15956
|
+
{
|
15957
|
+
"kind": "Content",
|
15958
|
+
"text": "{\n pitch: number;\n yaw: number;\n}"
|
15959
|
+
},
|
15960
|
+
{
|
15961
|
+
"kind": "Content",
|
15962
|
+
"text": ";"
|
15963
|
+
}
|
15964
|
+
],
|
15965
|
+
"fileUrlPath": "src/networking/players/Player.ts",
|
15966
|
+
"releaseTag": "Public",
|
15967
|
+
"name": "PlayerCameraOrientation",
|
15968
|
+
"typeTokenRange": {
|
15969
|
+
"startIndex": 1,
|
15970
|
+
"endIndex": 2
|
15971
|
+
}
|
15972
|
+
},
|
15947
15973
|
{
|
15948
15974
|
"kind": "Class",
|
15949
15975
|
"canonicalReference": "server!PlayerEntity:class",
|
@@ -16538,12 +16564,12 @@
|
|
16538
16564
|
},
|
16539
16565
|
{
|
16540
16566
|
"kind": "TypeAlias",
|
16541
|
-
"canonicalReference": "server!
|
16567
|
+
"canonicalReference": "server!PlayerInput:type",
|
16542
16568
|
"docComment": "/**\n * The input state of a Player; keys from SUPPORTED_INPUT_KEYS.\n *\n * @public\n */\n",
|
16543
16569
|
"excerptTokens": [
|
16544
16570
|
{
|
16545
16571
|
"kind": "Content",
|
16546
|
-
"text": "export type
|
16572
|
+
"text": "export type PlayerInput = "
|
16547
16573
|
},
|
16548
16574
|
{
|
16549
16575
|
"kind": "Reference",
|
@@ -16579,7 +16605,7 @@
|
|
16579
16605
|
],
|
16580
16606
|
"fileUrlPath": "src/networking/players/Player.ts",
|
16581
16607
|
"releaseTag": "Public",
|
16582
|
-
"name": "
|
16608
|
+
"name": "PlayerInput",
|
16583
16609
|
"typeTokenRange": {
|
16584
16610
|
"startIndex": 1,
|
16585
16611
|
"endIndex": 7
|
@@ -16725,30 +16751,409 @@
|
|
16725
16751
|
"implementsTokenRanges": []
|
16726
16752
|
},
|
16727
16753
|
{
|
16728
|
-
"kind": "
|
16729
|
-
"canonicalReference": "server!
|
16730
|
-
"docComment": "/**\n * The
|
16754
|
+
"kind": "Class",
|
16755
|
+
"canonicalReference": "server!PlayerUI:class",
|
16756
|
+
"docComment": "/**\n * The UI for a player.\n *\n * @remarks\n *\n * UI allows control of all in-game overlays a player sees. UI is controlled by HTML, CSS and JavaScript files you provide in your `assets` folder.\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 `PlayerUI` class.\n *\n * @public\n */\n",
|
16731
16757
|
"excerptTokens": [
|
16732
16758
|
{
|
16733
16759
|
"kind": "Content",
|
16734
|
-
"text": "export
|
16760
|
+
"text": "export default class PlayerUI "
|
16761
|
+
}
|
16762
|
+
],
|
16763
|
+
"fileUrlPath": "src/networking/players/PlayerUI.ts",
|
16764
|
+
"releaseTag": "Public",
|
16765
|
+
"isAbstract": false,
|
16766
|
+
"name": "PlayerUI",
|
16767
|
+
"preserveMemberOrder": false,
|
16768
|
+
"members": [
|
16769
|
+
{
|
16770
|
+
"kind": "Method",
|
16771
|
+
"canonicalReference": "server!PlayerUI#load:member(1)",
|
16772
|
+
"docComment": "/**\n * Loads client UI for the player.\n *\n * @param htmlUri - The ui html uri to load.\n */\n",
|
16773
|
+
"excerptTokens": [
|
16774
|
+
{
|
16775
|
+
"kind": "Content",
|
16776
|
+
"text": "load(htmlUri: "
|
16777
|
+
},
|
16778
|
+
{
|
16779
|
+
"kind": "Content",
|
16780
|
+
"text": "string"
|
16781
|
+
},
|
16782
|
+
{
|
16783
|
+
"kind": "Content",
|
16784
|
+
"text": "): "
|
16785
|
+
},
|
16786
|
+
{
|
16787
|
+
"kind": "Content",
|
16788
|
+
"text": "void"
|
16789
|
+
},
|
16790
|
+
{
|
16791
|
+
"kind": "Content",
|
16792
|
+
"text": ";"
|
16793
|
+
}
|
16794
|
+
],
|
16795
|
+
"isStatic": false,
|
16796
|
+
"returnTypeTokenRange": {
|
16797
|
+
"startIndex": 3,
|
16798
|
+
"endIndex": 4
|
16799
|
+
},
|
16800
|
+
"releaseTag": "Public",
|
16801
|
+
"isProtected": false,
|
16802
|
+
"overloadIndex": 1,
|
16803
|
+
"parameters": [
|
16804
|
+
{
|
16805
|
+
"parameterName": "htmlUri",
|
16806
|
+
"parameterTypeTokenRange": {
|
16807
|
+
"startIndex": 1,
|
16808
|
+
"endIndex": 2
|
16809
|
+
},
|
16810
|
+
"isOptional": false
|
16811
|
+
}
|
16812
|
+
],
|
16813
|
+
"isOptional": false,
|
16814
|
+
"isAbstract": false,
|
16815
|
+
"name": "load"
|
16816
|
+
},
|
16817
|
+
{
|
16818
|
+
"kind": "Property",
|
16819
|
+
"canonicalReference": "server!PlayerUI#onData:member",
|
16820
|
+
"docComment": "/**\n * A function that is called when the player's client UI sends data to the server.\n *\n * @remarks\n *\n * Data sent is an object of any shape defined by you and controlled with invocations of `hytopia.ui.sendData()` from your loaded client UI files.\n *\n * @param playerUI - The PlayerUI instance that the data is from.\n *\n * @param data - The data sent from the client UI.\n */\n",
|
16821
|
+
"excerptTokens": [
|
16822
|
+
{
|
16823
|
+
"kind": "Content",
|
16824
|
+
"text": "onData?: "
|
16825
|
+
},
|
16826
|
+
{
|
16827
|
+
"kind": "Content",
|
16828
|
+
"text": "(playerUI: "
|
16829
|
+
},
|
16830
|
+
{
|
16831
|
+
"kind": "Reference",
|
16832
|
+
"text": "PlayerUI",
|
16833
|
+
"canonicalReference": "server!PlayerUI:class"
|
16834
|
+
},
|
16835
|
+
{
|
16836
|
+
"kind": "Content",
|
16837
|
+
"text": ", data: object) => void"
|
16838
|
+
},
|
16839
|
+
{
|
16840
|
+
"kind": "Content",
|
16841
|
+
"text": ";"
|
16842
|
+
}
|
16843
|
+
],
|
16844
|
+
"isReadonly": false,
|
16845
|
+
"isOptional": true,
|
16846
|
+
"releaseTag": "Public",
|
16847
|
+
"name": "onData",
|
16848
|
+
"propertyTypeTokenRange": {
|
16849
|
+
"startIndex": 1,
|
16850
|
+
"endIndex": 4
|
16851
|
+
},
|
16852
|
+
"isStatic": false,
|
16853
|
+
"isProtected": false,
|
16854
|
+
"isAbstract": false
|
16855
|
+
},
|
16856
|
+
{
|
16857
|
+
"kind": "Property",
|
16858
|
+
"canonicalReference": "server!PlayerUI#player:member",
|
16859
|
+
"docComment": "/**\n * The player that the UI belongs to.\n *\n * @readonly\n */\n",
|
16860
|
+
"excerptTokens": [
|
16861
|
+
{
|
16862
|
+
"kind": "Content",
|
16863
|
+
"text": "readonly player: "
|
16864
|
+
},
|
16865
|
+
{
|
16866
|
+
"kind": "Reference",
|
16867
|
+
"text": "Player",
|
16868
|
+
"canonicalReference": "server!Player:class"
|
16869
|
+
},
|
16870
|
+
{
|
16871
|
+
"kind": "Content",
|
16872
|
+
"text": ";"
|
16873
|
+
}
|
16874
|
+
],
|
16875
|
+
"isReadonly": true,
|
16876
|
+
"isOptional": false,
|
16877
|
+
"releaseTag": "Public",
|
16878
|
+
"name": "player",
|
16879
|
+
"propertyTypeTokenRange": {
|
16880
|
+
"startIndex": 1,
|
16881
|
+
"endIndex": 2
|
16882
|
+
},
|
16883
|
+
"isStatic": false,
|
16884
|
+
"isProtected": false,
|
16885
|
+
"isAbstract": false
|
16735
16886
|
},
|
16887
|
+
{
|
16888
|
+
"kind": "Method",
|
16889
|
+
"canonicalReference": "server!PlayerUI#sendData:member(1)",
|
16890
|
+
"docComment": "/**\n * Sends data to the player's client UI.\n *\n * @param data - The data to send to the client UI.\n */\n",
|
16891
|
+
"excerptTokens": [
|
16892
|
+
{
|
16893
|
+
"kind": "Content",
|
16894
|
+
"text": "sendData(data: "
|
16895
|
+
},
|
16896
|
+
{
|
16897
|
+
"kind": "Content",
|
16898
|
+
"text": "object"
|
16899
|
+
},
|
16900
|
+
{
|
16901
|
+
"kind": "Content",
|
16902
|
+
"text": "): "
|
16903
|
+
},
|
16904
|
+
{
|
16905
|
+
"kind": "Content",
|
16906
|
+
"text": "void"
|
16907
|
+
},
|
16908
|
+
{
|
16909
|
+
"kind": "Content",
|
16910
|
+
"text": ";"
|
16911
|
+
}
|
16912
|
+
],
|
16913
|
+
"isStatic": false,
|
16914
|
+
"returnTypeTokenRange": {
|
16915
|
+
"startIndex": 3,
|
16916
|
+
"endIndex": 4
|
16917
|
+
},
|
16918
|
+
"releaseTag": "Public",
|
16919
|
+
"isProtected": false,
|
16920
|
+
"overloadIndex": 1,
|
16921
|
+
"parameters": [
|
16922
|
+
{
|
16923
|
+
"parameterName": "data",
|
16924
|
+
"parameterTypeTokenRange": {
|
16925
|
+
"startIndex": 1,
|
16926
|
+
"endIndex": 2
|
16927
|
+
},
|
16928
|
+
"isOptional": false
|
16929
|
+
}
|
16930
|
+
],
|
16931
|
+
"isOptional": false,
|
16932
|
+
"isAbstract": false,
|
16933
|
+
"name": "sendData"
|
16934
|
+
}
|
16935
|
+
],
|
16936
|
+
"implementsTokenRanges": []
|
16937
|
+
},
|
16938
|
+
{
|
16939
|
+
"kind": "Namespace",
|
16940
|
+
"canonicalReference": "server!PlayerUIEventPayload:namespace",
|
16941
|
+
"docComment": "/**\n * Payloads for events a PlayerUI instance can emit.\n *\n * @public\n */\n",
|
16942
|
+
"excerptTokens": [
|
16736
16943
|
{
|
16737
16944
|
"kind": "Content",
|
16738
|
-
"text": "
|
16945
|
+
"text": "export declare namespace PlayerUIEventPayload "
|
16946
|
+
}
|
16947
|
+
],
|
16948
|
+
"fileUrlPath": "src/networking/players/PlayerUI.ts",
|
16949
|
+
"releaseTag": "Public",
|
16950
|
+
"name": "PlayerUIEventPayload",
|
16951
|
+
"preserveMemberOrder": false,
|
16952
|
+
"members": [
|
16953
|
+
{
|
16954
|
+
"kind": "Interface",
|
16955
|
+
"canonicalReference": "server!PlayerUIEventPayload.Load:interface",
|
16956
|
+
"docComment": "",
|
16957
|
+
"excerptTokens": [
|
16958
|
+
{
|
16959
|
+
"kind": "Content",
|
16960
|
+
"text": "interface Load "
|
16961
|
+
}
|
16962
|
+
],
|
16963
|
+
"releaseTag": "Public",
|
16964
|
+
"name": "Load",
|
16965
|
+
"preserveMemberOrder": false,
|
16966
|
+
"members": [
|
16967
|
+
{
|
16968
|
+
"kind": "PropertySignature",
|
16969
|
+
"canonicalReference": "server!PlayerUIEventPayload.Load#htmlUri:member",
|
16970
|
+
"docComment": "",
|
16971
|
+
"excerptTokens": [
|
16972
|
+
{
|
16973
|
+
"kind": "Content",
|
16974
|
+
"text": "htmlUri: "
|
16975
|
+
},
|
16976
|
+
{
|
16977
|
+
"kind": "Content",
|
16978
|
+
"text": "string"
|
16979
|
+
},
|
16980
|
+
{
|
16981
|
+
"kind": "Content",
|
16982
|
+
"text": ";"
|
16983
|
+
}
|
16984
|
+
],
|
16985
|
+
"isReadonly": false,
|
16986
|
+
"isOptional": false,
|
16987
|
+
"releaseTag": "Public",
|
16988
|
+
"name": "htmlUri",
|
16989
|
+
"propertyTypeTokenRange": {
|
16990
|
+
"startIndex": 1,
|
16991
|
+
"endIndex": 2
|
16992
|
+
}
|
16993
|
+
},
|
16994
|
+
{
|
16995
|
+
"kind": "PropertySignature",
|
16996
|
+
"canonicalReference": "server!PlayerUIEventPayload.Load#playerUI:member",
|
16997
|
+
"docComment": "",
|
16998
|
+
"excerptTokens": [
|
16999
|
+
{
|
17000
|
+
"kind": "Content",
|
17001
|
+
"text": "playerUI: "
|
17002
|
+
},
|
17003
|
+
{
|
17004
|
+
"kind": "Reference",
|
17005
|
+
"text": "PlayerUI",
|
17006
|
+
"canonicalReference": "server!PlayerUI:class"
|
17007
|
+
},
|
17008
|
+
{
|
17009
|
+
"kind": "Content",
|
17010
|
+
"text": ";"
|
17011
|
+
}
|
17012
|
+
],
|
17013
|
+
"isReadonly": false,
|
17014
|
+
"isOptional": false,
|
17015
|
+
"releaseTag": "Public",
|
17016
|
+
"name": "playerUI",
|
17017
|
+
"propertyTypeTokenRange": {
|
17018
|
+
"startIndex": 1,
|
17019
|
+
"endIndex": 2
|
17020
|
+
}
|
17021
|
+
}
|
17022
|
+
],
|
17023
|
+
"extendsTokenRanges": []
|
16739
17024
|
},
|
17025
|
+
{
|
17026
|
+
"kind": "Interface",
|
17027
|
+
"canonicalReference": "server!PlayerUIEventPayload.SendData:interface",
|
17028
|
+
"docComment": "",
|
17029
|
+
"excerptTokens": [
|
17030
|
+
{
|
17031
|
+
"kind": "Content",
|
17032
|
+
"text": "interface SendData "
|
17033
|
+
}
|
17034
|
+
],
|
17035
|
+
"releaseTag": "Public",
|
17036
|
+
"name": "SendData",
|
17037
|
+
"preserveMemberOrder": false,
|
17038
|
+
"members": [
|
17039
|
+
{
|
17040
|
+
"kind": "PropertySignature",
|
17041
|
+
"canonicalReference": "server!PlayerUIEventPayload.SendData#data:member",
|
17042
|
+
"docComment": "",
|
17043
|
+
"excerptTokens": [
|
17044
|
+
{
|
17045
|
+
"kind": "Content",
|
17046
|
+
"text": "data: "
|
17047
|
+
},
|
17048
|
+
{
|
17049
|
+
"kind": "Content",
|
17050
|
+
"text": "object"
|
17051
|
+
},
|
17052
|
+
{
|
17053
|
+
"kind": "Content",
|
17054
|
+
"text": ";"
|
17055
|
+
}
|
17056
|
+
],
|
17057
|
+
"isReadonly": false,
|
17058
|
+
"isOptional": false,
|
17059
|
+
"releaseTag": "Public",
|
17060
|
+
"name": "data",
|
17061
|
+
"propertyTypeTokenRange": {
|
17062
|
+
"startIndex": 1,
|
17063
|
+
"endIndex": 2
|
17064
|
+
}
|
17065
|
+
},
|
17066
|
+
{
|
17067
|
+
"kind": "PropertySignature",
|
17068
|
+
"canonicalReference": "server!PlayerUIEventPayload.SendData#playerUI:member",
|
17069
|
+
"docComment": "",
|
17070
|
+
"excerptTokens": [
|
17071
|
+
{
|
17072
|
+
"kind": "Content",
|
17073
|
+
"text": "playerUI: "
|
17074
|
+
},
|
17075
|
+
{
|
17076
|
+
"kind": "Reference",
|
17077
|
+
"text": "PlayerUI",
|
17078
|
+
"canonicalReference": "server!PlayerUI:class"
|
17079
|
+
},
|
17080
|
+
{
|
17081
|
+
"kind": "Content",
|
17082
|
+
"text": ";"
|
17083
|
+
}
|
17084
|
+
],
|
17085
|
+
"isReadonly": false,
|
17086
|
+
"isOptional": false,
|
17087
|
+
"releaseTag": "Public",
|
17088
|
+
"name": "playerUI",
|
17089
|
+
"propertyTypeTokenRange": {
|
17090
|
+
"startIndex": 1,
|
17091
|
+
"endIndex": 2
|
17092
|
+
}
|
17093
|
+
}
|
17094
|
+
],
|
17095
|
+
"extendsTokenRanges": []
|
17096
|
+
}
|
17097
|
+
]
|
17098
|
+
},
|
17099
|
+
{
|
17100
|
+
"kind": "Enum",
|
17101
|
+
"canonicalReference": "server!PlayerUIEventType:enum",
|
17102
|
+
"docComment": "/**\n * Event types a\n */\n",
|
17103
|
+
"excerptTokens": [
|
16740
17104
|
{
|
16741
17105
|
"kind": "Content",
|
16742
|
-
"text": "
|
17106
|
+
"text": "export declare enum PlayerUIEventType "
|
16743
17107
|
}
|
16744
17108
|
],
|
16745
|
-
"fileUrlPath": "src/networking/players/
|
17109
|
+
"fileUrlPath": "src/networking/players/PlayerUI.ts",
|
16746
17110
|
"releaseTag": "Public",
|
16747
|
-
"name": "
|
16748
|
-
"
|
16749
|
-
|
16750
|
-
|
16751
|
-
|
17111
|
+
"name": "PlayerUIEventType",
|
17112
|
+
"preserveMemberOrder": false,
|
17113
|
+
"members": [
|
17114
|
+
{
|
17115
|
+
"kind": "EnumMember",
|
17116
|
+
"canonicalReference": "server!PlayerUIEventType.LOAD:member",
|
17117
|
+
"docComment": "",
|
17118
|
+
"excerptTokens": [
|
17119
|
+
{
|
17120
|
+
"kind": "Content",
|
17121
|
+
"text": "LOAD = "
|
17122
|
+
},
|
17123
|
+
{
|
17124
|
+
"kind": "Content",
|
17125
|
+
"text": "\"PLAYER_UI.LOAD\""
|
17126
|
+
}
|
17127
|
+
],
|
17128
|
+
"initializerTokenRange": {
|
17129
|
+
"startIndex": 1,
|
17130
|
+
"endIndex": 2
|
17131
|
+
},
|
17132
|
+
"releaseTag": "Public",
|
17133
|
+
"name": "LOAD"
|
17134
|
+
},
|
17135
|
+
{
|
17136
|
+
"kind": "EnumMember",
|
17137
|
+
"canonicalReference": "server!PlayerUIEventType.SEND_DATA:member",
|
17138
|
+
"docComment": "",
|
17139
|
+
"excerptTokens": [
|
17140
|
+
{
|
17141
|
+
"kind": "Content",
|
17142
|
+
"text": "SEND_DATA = "
|
17143
|
+
},
|
17144
|
+
{
|
17145
|
+
"kind": "Content",
|
17146
|
+
"text": "\"PLAYER_UI.SEND_DATA\""
|
17147
|
+
}
|
17148
|
+
],
|
17149
|
+
"initializerTokenRange": {
|
17150
|
+
"startIndex": 1,
|
17151
|
+
"endIndex": 2
|
17152
|
+
},
|
17153
|
+
"releaseTag": "Public",
|
17154
|
+
"name": "SEND_DATA"
|
17155
|
+
}
|
17156
|
+
]
|
16752
17157
|
},
|
16753
17158
|
{
|
16754
17159
|
"kind": "Variable",
|
@@ -22852,7 +23257,7 @@
|
|
22852
23257
|
{
|
22853
23258
|
"kind": "Variable",
|
22854
23259
|
"canonicalReference": "server!SUPPORTED_INPUT_KEYS:var",
|
22855
|
-
"docComment": "/**\n * The input keys that
|
23260
|
+
"docComment": "/**\n * The input keys that are included in the PlayerInput.\n *\n * @public\n */\n",
|
22856
23261
|
"excerptTokens": [
|
22857
23262
|
{
|
22858
23263
|
"kind": "Content",
|