hytopia 0.3.11 → 0.3.13

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 (44) hide show
  1. package/docs/server.baseentityoptions.controller.md +13 -0
  2. package/docs/server.baseentityoptions.md +190 -0
  3. package/docs/server.baseentityoptions.name.md +13 -0
  4. package/docs/{server.entityoptions.opacity.md → server.baseentityoptions.opacity.md} +2 -2
  5. package/docs/{server.entityoptions.parent.md → server.baseentityoptions.parent.md} +2 -2
  6. package/docs/{server.entityoptions.parentnodename.md → server.baseentityoptions.parentnodename.md} +2 -2
  7. package/docs/server.baseentityoptions.rigidbodyoptions.md +13 -0
  8. package/docs/{server.entityoptions.tag.md → server.baseentityoptions.tag.md} +2 -2
  9. package/docs/server.baseentityoptions.tintcolor.md +13 -0
  10. package/docs/{server.entityoptions.blockhalfextents.md → server.blockentityoptions.blockhalfextents.md} +2 -2
  11. package/docs/{server.entityoptions.blocktextureuri.md → server.blockentityoptions.blocktextureuri.md} +2 -2
  12. package/docs/server.blockentityoptions.md +77 -0
  13. package/docs/server.entityoptions.md +4 -312
  14. package/docs/server.md +52 -19
  15. package/docs/server.modelentityoptions.md +134 -0
  16. package/docs/server.modelentityoptions.modelanimationsplaybackrate.md +13 -0
  17. package/docs/server.modelentityoptions.modelhiddennodes.md +13 -0
  18. package/docs/server.modelentityoptions.modelloopedanimations.md +13 -0
  19. package/docs/server.modelentityoptions.modelscale.md +13 -0
  20. package/docs/server.modelentityoptions.modeluri.md +13 -0
  21. package/docs/server.playerentityoptions.md +5 -46
  22. package/docs/server.playerui.lockpointer.md +1 -1
  23. package/docs/server.playerui.md +1 -1
  24. package/examples/entity-spawn/index.ts +4 -3
  25. package/examples/hygrounds/classes/ChestEntity.ts +2 -2
  26. package/examples/hygrounds/classes/GunEntity.ts +3 -3
  27. package/examples/hygrounds/classes/ItemEntity.ts +13 -9
  28. package/examples/hygrounds/classes/MeleeWeaponEntity.ts +3 -3
  29. package/examples/zombies-fps/classes/EnemyEntity.ts +2 -2
  30. package/examples/zombies-fps/classes/GunEntity.ts +3 -3
  31. package/package.json +1 -1
  32. package/server.api.json +614 -534
  33. package/server.d.ts +51 -36
  34. package/server.js +1 -1
  35. package/docs/server.entityoptions.controller.md +0 -13
  36. package/docs/server.entityoptions.modelanimationsplaybackrate.md +0 -13
  37. package/docs/server.entityoptions.modelhiddennodes.md +0 -13
  38. package/docs/server.entityoptions.modelloopedanimations.md +0 -13
  39. package/docs/server.entityoptions.modelscale.md +0 -13
  40. package/docs/server.entityoptions.modeluri.md +0 -13
  41. package/docs/server.entityoptions.name.md +0 -13
  42. package/docs/server.entityoptions.rigidbodyoptions.md +0 -13
  43. package/docs/server.entityoptions.tintcolor.md +0 -13
  44. package/docs/server.playerentityoptions.player.md +0 -13
package/server.api.json CHANGED
@@ -3938,6 +3938,244 @@
3938
3938
  ],
3939
3939
  "extendsTokenRanges": []
3940
3940
  },
3941
+ {
3942
+ "kind": "Interface",
3943
+ "canonicalReference": "server!BaseEntityOptions:interface",
3944
+ "docComment": "/**\n * The base options for an entity.\n *\n * @public\n */\n",
3945
+ "excerptTokens": [
3946
+ {
3947
+ "kind": "Content",
3948
+ "text": "export interface BaseEntityOptions "
3949
+ }
3950
+ ],
3951
+ "fileUrlPath": "src/world/entities/Entity.ts",
3952
+ "releaseTag": "Public",
3953
+ "name": "BaseEntityOptions",
3954
+ "preserveMemberOrder": false,
3955
+ "members": [
3956
+ {
3957
+ "kind": "PropertySignature",
3958
+ "canonicalReference": "server!BaseEntityOptions#controller:member",
3959
+ "docComment": "/**\n * The entity controller to use for the entity.\n */\n",
3960
+ "excerptTokens": [
3961
+ {
3962
+ "kind": "Content",
3963
+ "text": "controller?: "
3964
+ },
3965
+ {
3966
+ "kind": "Reference",
3967
+ "text": "BaseEntityController",
3968
+ "canonicalReference": "server!BaseEntityController:class"
3969
+ },
3970
+ {
3971
+ "kind": "Content",
3972
+ "text": ";"
3973
+ }
3974
+ ],
3975
+ "isReadonly": false,
3976
+ "isOptional": true,
3977
+ "releaseTag": "Public",
3978
+ "name": "controller",
3979
+ "propertyTypeTokenRange": {
3980
+ "startIndex": 1,
3981
+ "endIndex": 2
3982
+ }
3983
+ },
3984
+ {
3985
+ "kind": "PropertySignature",
3986
+ "canonicalReference": "server!BaseEntityOptions#name:member",
3987
+ "docComment": "/**\n * The name of the entity.\n */\n",
3988
+ "excerptTokens": [
3989
+ {
3990
+ "kind": "Content",
3991
+ "text": "name?: "
3992
+ },
3993
+ {
3994
+ "kind": "Content",
3995
+ "text": "string"
3996
+ },
3997
+ {
3998
+ "kind": "Content",
3999
+ "text": ";"
4000
+ }
4001
+ ],
4002
+ "isReadonly": false,
4003
+ "isOptional": true,
4004
+ "releaseTag": "Public",
4005
+ "name": "name",
4006
+ "propertyTypeTokenRange": {
4007
+ "startIndex": 1,
4008
+ "endIndex": 2
4009
+ }
4010
+ },
4011
+ {
4012
+ "kind": "PropertySignature",
4013
+ "canonicalReference": "server!BaseEntityOptions#opacity:member",
4014
+ "docComment": "/**\n * The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.\n */\n",
4015
+ "excerptTokens": [
4016
+ {
4017
+ "kind": "Content",
4018
+ "text": "opacity?: "
4019
+ },
4020
+ {
4021
+ "kind": "Content",
4022
+ "text": "number"
4023
+ },
4024
+ {
4025
+ "kind": "Content",
4026
+ "text": ";"
4027
+ }
4028
+ ],
4029
+ "isReadonly": false,
4030
+ "isOptional": true,
4031
+ "releaseTag": "Public",
4032
+ "name": "opacity",
4033
+ "propertyTypeTokenRange": {
4034
+ "startIndex": 1,
4035
+ "endIndex": 2
4036
+ }
4037
+ },
4038
+ {
4039
+ "kind": "PropertySignature",
4040
+ "canonicalReference": "server!BaseEntityOptions#parent:member",
4041
+ "docComment": "/**\n * The parent entity of the entity, entities with a parent will ignore creating their own colliders.\n */\n",
4042
+ "excerptTokens": [
4043
+ {
4044
+ "kind": "Content",
4045
+ "text": "parent?: "
4046
+ },
4047
+ {
4048
+ "kind": "Reference",
4049
+ "text": "Entity",
4050
+ "canonicalReference": "server!Entity:class"
4051
+ },
4052
+ {
4053
+ "kind": "Content",
4054
+ "text": ";"
4055
+ }
4056
+ ],
4057
+ "isReadonly": false,
4058
+ "isOptional": true,
4059
+ "releaseTag": "Public",
4060
+ "name": "parent",
4061
+ "propertyTypeTokenRange": {
4062
+ "startIndex": 1,
4063
+ "endIndex": 2
4064
+ }
4065
+ },
4066
+ {
4067
+ "kind": "PropertySignature",
4068
+ "canonicalReference": "server!BaseEntityOptions#parentNodeName:member",
4069
+ "docComment": "/**\n * The name of the parent's node (if parent is a model entity) to attach the entity to.\n */\n",
4070
+ "excerptTokens": [
4071
+ {
4072
+ "kind": "Content",
4073
+ "text": "parentNodeName?: "
4074
+ },
4075
+ {
4076
+ "kind": "Content",
4077
+ "text": "string"
4078
+ },
4079
+ {
4080
+ "kind": "Content",
4081
+ "text": ";"
4082
+ }
4083
+ ],
4084
+ "isReadonly": false,
4085
+ "isOptional": true,
4086
+ "releaseTag": "Public",
4087
+ "name": "parentNodeName",
4088
+ "propertyTypeTokenRange": {
4089
+ "startIndex": 1,
4090
+ "endIndex": 2
4091
+ }
4092
+ },
4093
+ {
4094
+ "kind": "PropertySignature",
4095
+ "canonicalReference": "server!BaseEntityOptions#rigidBodyOptions:member",
4096
+ "docComment": "/**\n * The rigid body options for the entity.\n */\n",
4097
+ "excerptTokens": [
4098
+ {
4099
+ "kind": "Content",
4100
+ "text": "rigidBodyOptions?: "
4101
+ },
4102
+ {
4103
+ "kind": "Reference",
4104
+ "text": "RigidBodyOptions",
4105
+ "canonicalReference": "server!RigidBodyOptions:type"
4106
+ },
4107
+ {
4108
+ "kind": "Content",
4109
+ "text": ";"
4110
+ }
4111
+ ],
4112
+ "isReadonly": false,
4113
+ "isOptional": true,
4114
+ "releaseTag": "Public",
4115
+ "name": "rigidBodyOptions",
4116
+ "propertyTypeTokenRange": {
4117
+ "startIndex": 1,
4118
+ "endIndex": 2
4119
+ }
4120
+ },
4121
+ {
4122
+ "kind": "PropertySignature",
4123
+ "canonicalReference": "server!BaseEntityOptions#tag:member",
4124
+ "docComment": "/**\n * An arbitrary identifier tag of the entity. Useful for your own logic.\n */\n",
4125
+ "excerptTokens": [
4126
+ {
4127
+ "kind": "Content",
4128
+ "text": "tag?: "
4129
+ },
4130
+ {
4131
+ "kind": "Content",
4132
+ "text": "string"
4133
+ },
4134
+ {
4135
+ "kind": "Content",
4136
+ "text": ";"
4137
+ }
4138
+ ],
4139
+ "isReadonly": false,
4140
+ "isOptional": true,
4141
+ "releaseTag": "Public",
4142
+ "name": "tag",
4143
+ "propertyTypeTokenRange": {
4144
+ "startIndex": 1,
4145
+ "endIndex": 2
4146
+ }
4147
+ },
4148
+ {
4149
+ "kind": "PropertySignature",
4150
+ "canonicalReference": "server!BaseEntityOptions#tintColor:member",
4151
+ "docComment": "/**\n * The tint color of the entity as a hex code.\n */\n",
4152
+ "excerptTokens": [
4153
+ {
4154
+ "kind": "Content",
4155
+ "text": "tintColor?: "
4156
+ },
4157
+ {
4158
+ "kind": "Reference",
4159
+ "text": "RgbColor",
4160
+ "canonicalReference": "server!RgbColor:interface"
4161
+ },
4162
+ {
4163
+ "kind": "Content",
4164
+ "text": ";"
4165
+ }
4166
+ ],
4167
+ "isReadonly": false,
4168
+ "isOptional": true,
4169
+ "releaseTag": "Public",
4170
+ "name": "tintColor",
4171
+ "propertyTypeTokenRange": {
4172
+ "startIndex": 1,
4173
+ "endIndex": 2
4174
+ }
4175
+ }
4176
+ ],
4177
+ "extendsTokenRanges": []
4178
+ },
3941
4179
  {
3942
4180
  "kind": "Interface",
3943
4181
  "canonicalReference": "server!BaseRigidBodyOptions:interface",
@@ -4346,6 +4584,93 @@
4346
4584
  }
4347
4585
  ]
4348
4586
  },
4587
+ {
4588
+ "kind": "Interface",
4589
+ "canonicalReference": "server!BlockEntityOptions:interface",
4590
+ "docComment": "/**\n * The options for creating a block entity.\n *\n * @public\n */\n",
4591
+ "excerptTokens": [
4592
+ {
4593
+ "kind": "Content",
4594
+ "text": "export interface BlockEntityOptions extends "
4595
+ },
4596
+ {
4597
+ "kind": "Reference",
4598
+ "text": "BaseEntityOptions",
4599
+ "canonicalReference": "server!BaseEntityOptions:interface"
4600
+ },
4601
+ {
4602
+ "kind": "Content",
4603
+ "text": " "
4604
+ }
4605
+ ],
4606
+ "fileUrlPath": "src/world/entities/Entity.ts",
4607
+ "releaseTag": "Public",
4608
+ "name": "BlockEntityOptions",
4609
+ "preserveMemberOrder": false,
4610
+ "members": [
4611
+ {
4612
+ "kind": "PropertySignature",
4613
+ "canonicalReference": "server!BlockEntityOptions#blockHalfExtents:member",
4614
+ "docComment": "/**\n * The half extents of the visual size of the block entity when blockTextureUri is set. If no rigidBodyOptions.colliders are provided, a block collider with the size of the half extents will be created.\n */\n",
4615
+ "excerptTokens": [
4616
+ {
4617
+ "kind": "Content",
4618
+ "text": "blockHalfExtents?: "
4619
+ },
4620
+ {
4621
+ "kind": "Reference",
4622
+ "text": "Vector3Like",
4623
+ "canonicalReference": "server!Vector3Like:interface"
4624
+ },
4625
+ {
4626
+ "kind": "Content",
4627
+ "text": ";"
4628
+ }
4629
+ ],
4630
+ "isReadonly": false,
4631
+ "isOptional": true,
4632
+ "releaseTag": "Public",
4633
+ "name": "blockHalfExtents",
4634
+ "propertyTypeTokenRange": {
4635
+ "startIndex": 1,
4636
+ "endIndex": 2
4637
+ }
4638
+ },
4639
+ {
4640
+ "kind": "PropertySignature",
4641
+ "canonicalReference": "server!BlockEntityOptions#blockTextureUri:member",
4642
+ "docComment": "/**\n * The texture uri of a entity if the entity is a block entity, if set rigidBodyOptions collider shape [0] must be a block\n */\n",
4643
+ "excerptTokens": [
4644
+ {
4645
+ "kind": "Content",
4646
+ "text": "blockTextureUri?: "
4647
+ },
4648
+ {
4649
+ "kind": "Content",
4650
+ "text": "string"
4651
+ },
4652
+ {
4653
+ "kind": "Content",
4654
+ "text": ";"
4655
+ }
4656
+ ],
4657
+ "isReadonly": false,
4658
+ "isOptional": true,
4659
+ "releaseTag": "Public",
4660
+ "name": "blockTextureUri",
4661
+ "propertyTypeTokenRange": {
4662
+ "startIndex": 1,
4663
+ "endIndex": 2
4664
+ }
4665
+ }
4666
+ ],
4667
+ "extendsTokenRanges": [
4668
+ {
4669
+ "startIndex": 1,
4670
+ "endIndex": 2
4671
+ }
4672
+ ]
4673
+ },
4349
4674
  {
4350
4675
  "kind": "Class",
4351
4676
  "canonicalReference": "server!BlockType:class",
@@ -10655,7 +10980,7 @@
10655
10980
  {
10656
10981
  "kind": "Reference",
10657
10982
  "text": "EntityOptions",
10658
- "canonicalReference": "server!EntityOptions:interface"
10983
+ "canonicalReference": "server!EntityOptions:type"
10659
10984
  },
10660
10985
  {
10661
10986
  "kind": "Content",
@@ -13624,432 +13949,40 @@
13624
13949
  "implementsTokenRanges": []
13625
13950
  },
13626
13951
  {
13627
- "kind": "Interface",
13628
- "canonicalReference": "server!EntityOptions:interface",
13629
- "docComment": "/**\n * Options for creating an Entity instance.\n *\n * @public\n */\n",
13952
+ "kind": "TypeAlias",
13953
+ "canonicalReference": "server!EntityOptions:type",
13954
+ "docComment": "/**\n * The options for creating an Entity instance.\n *\n * @public\n */\n",
13630
13955
  "excerptTokens": [
13631
13956
  {
13632
13957
  "kind": "Content",
13633
- "text": "export interface EntityOptions "
13634
- }
13635
- ],
13636
- "fileUrlPath": "src/world/entities/Entity.ts",
13637
- "releaseTag": "Public",
13638
- "name": "EntityOptions",
13639
- "preserveMemberOrder": false,
13640
- "members": [
13641
- {
13642
- "kind": "PropertySignature",
13643
- "canonicalReference": "server!EntityOptions#blockHalfExtents:member",
13644
- "docComment": "/**\n * The half extents of the visual size of the block entity when blockTextureUri is set. If no rigidBodyOptions.colliders are provided, a block collider with the size of the half extents will be created.\n */\n",
13645
- "excerptTokens": [
13646
- {
13647
- "kind": "Content",
13648
- "text": "blockHalfExtents?: "
13649
- },
13650
- {
13651
- "kind": "Reference",
13652
- "text": "Vector3Like",
13653
- "canonicalReference": "server!Vector3Like:interface"
13654
- },
13655
- {
13656
- "kind": "Content",
13657
- "text": ";"
13658
- }
13659
- ],
13660
- "isReadonly": false,
13661
- "isOptional": true,
13662
- "releaseTag": "Public",
13663
- "name": "blockHalfExtents",
13664
- "propertyTypeTokenRange": {
13665
- "startIndex": 1,
13666
- "endIndex": 2
13667
- }
13668
- },
13669
- {
13670
- "kind": "PropertySignature",
13671
- "canonicalReference": "server!EntityOptions#blockTextureUri:member",
13672
- "docComment": "/**\n * The texture uri of a entity if the entity is a block entity, if set rigidBodyOptions collider shape [0] must be a block\n */\n",
13673
- "excerptTokens": [
13674
- {
13675
- "kind": "Content",
13676
- "text": "blockTextureUri?: "
13677
- },
13678
- {
13679
- "kind": "Content",
13680
- "text": "string"
13681
- },
13682
- {
13683
- "kind": "Content",
13684
- "text": ";"
13685
- }
13686
- ],
13687
- "isReadonly": false,
13688
- "isOptional": true,
13689
- "releaseTag": "Public",
13690
- "name": "blockTextureUri",
13691
- "propertyTypeTokenRange": {
13692
- "startIndex": 1,
13693
- "endIndex": 2
13694
- }
13695
- },
13696
- {
13697
- "kind": "PropertySignature",
13698
- "canonicalReference": "server!EntityOptions#controller:member",
13699
- "docComment": "/**\n * The entity controller to use for the entity.\n */\n",
13700
- "excerptTokens": [
13701
- {
13702
- "kind": "Content",
13703
- "text": "controller?: "
13704
- },
13705
- {
13706
- "kind": "Reference",
13707
- "text": "BaseEntityController",
13708
- "canonicalReference": "server!BaseEntityController:class"
13709
- },
13710
- {
13711
- "kind": "Content",
13712
- "text": ";"
13713
- }
13714
- ],
13715
- "isReadonly": false,
13716
- "isOptional": true,
13717
- "releaseTag": "Public",
13718
- "name": "controller",
13719
- "propertyTypeTokenRange": {
13720
- "startIndex": 1,
13721
- "endIndex": 2
13722
- }
13723
- },
13724
- {
13725
- "kind": "PropertySignature",
13726
- "canonicalReference": "server!EntityOptions#modelAnimationsPlaybackRate:member",
13727
- "docComment": "/**\n * The playback rate of the entity's model animations.\n */\n",
13728
- "excerptTokens": [
13729
- {
13730
- "kind": "Content",
13731
- "text": "modelAnimationsPlaybackRate?: "
13732
- },
13733
- {
13734
- "kind": "Content",
13735
- "text": "number"
13736
- },
13737
- {
13738
- "kind": "Content",
13739
- "text": ";"
13740
- }
13741
- ],
13742
- "isReadonly": false,
13743
- "isOptional": true,
13744
- "releaseTag": "Public",
13745
- "name": "modelAnimationsPlaybackRate",
13746
- "propertyTypeTokenRange": {
13747
- "startIndex": 1,
13748
- "endIndex": 2
13749
- }
13750
- },
13751
- {
13752
- "kind": "PropertySignature",
13753
- "canonicalReference": "server!EntityOptions#modelHiddenNodes:member",
13754
- "docComment": "/**\n * The nodes to hide on the entity's model.\n */\n",
13755
- "excerptTokens": [
13756
- {
13757
- "kind": "Content",
13758
- "text": "modelHiddenNodes?: "
13759
- },
13760
- {
13761
- "kind": "Content",
13762
- "text": "string[]"
13763
- },
13764
- {
13765
- "kind": "Content",
13766
- "text": ";"
13767
- }
13768
- ],
13769
- "isReadonly": false,
13770
- "isOptional": true,
13771
- "releaseTag": "Public",
13772
- "name": "modelHiddenNodes",
13773
- "propertyTypeTokenRange": {
13774
- "startIndex": 1,
13775
- "endIndex": 2
13776
- }
13777
- },
13778
- {
13779
- "kind": "PropertySignature",
13780
- "canonicalReference": "server!EntityOptions#modelLoopedAnimations:member",
13781
- "docComment": "/**\n * The looped animations to start when the entity is spawned.\n */\n",
13782
- "excerptTokens": [
13783
- {
13784
- "kind": "Content",
13785
- "text": "modelLoopedAnimations?: "
13786
- },
13787
- {
13788
- "kind": "Content",
13789
- "text": "string[]"
13790
- },
13791
- {
13792
- "kind": "Content",
13793
- "text": ";"
13794
- }
13795
- ],
13796
- "isReadonly": false,
13797
- "isOptional": true,
13798
- "releaseTag": "Public",
13799
- "name": "modelLoopedAnimations",
13800
- "propertyTypeTokenRange": {
13801
- "startIndex": 1,
13802
- "endIndex": 2
13803
- }
13804
- },
13805
- {
13806
- "kind": "PropertySignature",
13807
- "canonicalReference": "server!EntityOptions#modelScale:member",
13808
- "docComment": "/**\n * The scale of the entity's model.\n */\n",
13809
- "excerptTokens": [
13810
- {
13811
- "kind": "Content",
13812
- "text": "modelScale?: "
13813
- },
13814
- {
13815
- "kind": "Content",
13816
- "text": "number"
13817
- },
13818
- {
13819
- "kind": "Content",
13820
- "text": ";"
13821
- }
13822
- ],
13823
- "isReadonly": false,
13824
- "isOptional": true,
13825
- "releaseTag": "Public",
13826
- "name": "modelScale",
13827
- "propertyTypeTokenRange": {
13828
- "startIndex": 1,
13829
- "endIndex": 2
13830
- }
13831
- },
13832
- {
13833
- "kind": "PropertySignature",
13834
- "canonicalReference": "server!EntityOptions#modelUri:member",
13835
- "docComment": "/**\n * The URI or path to the .gltf model asset to be used for the entity.\n */\n",
13836
- "excerptTokens": [
13837
- {
13838
- "kind": "Content",
13839
- "text": "modelUri?: "
13840
- },
13841
- {
13842
- "kind": "Content",
13843
- "text": "string"
13844
- },
13845
- {
13846
- "kind": "Content",
13847
- "text": ";"
13848
- }
13849
- ],
13850
- "isReadonly": false,
13851
- "isOptional": true,
13852
- "releaseTag": "Public",
13853
- "name": "modelUri",
13854
- "propertyTypeTokenRange": {
13855
- "startIndex": 1,
13856
- "endIndex": 2
13857
- }
13858
- },
13859
- {
13860
- "kind": "PropertySignature",
13861
- "canonicalReference": "server!EntityOptions#name:member",
13862
- "docComment": "/**\n * The name of the entity.\n */\n",
13863
- "excerptTokens": [
13864
- {
13865
- "kind": "Content",
13866
- "text": "name?: "
13867
- },
13868
- {
13869
- "kind": "Content",
13870
- "text": "string"
13871
- },
13872
- {
13873
- "kind": "Content",
13874
- "text": ";"
13875
- }
13876
- ],
13877
- "isReadonly": false,
13878
- "isOptional": true,
13879
- "releaseTag": "Public",
13880
- "name": "name",
13881
- "propertyTypeTokenRange": {
13882
- "startIndex": 1,
13883
- "endIndex": 2
13884
- }
13885
- },
13886
- {
13887
- "kind": "PropertySignature",
13888
- "canonicalReference": "server!EntityOptions#opacity:member",
13889
- "docComment": "/**\n * The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.\n */\n",
13890
- "excerptTokens": [
13891
- {
13892
- "kind": "Content",
13893
- "text": "opacity?: "
13894
- },
13895
- {
13896
- "kind": "Content",
13897
- "text": "number"
13898
- },
13899
- {
13900
- "kind": "Content",
13901
- "text": ";"
13902
- }
13903
- ],
13904
- "isReadonly": false,
13905
- "isOptional": true,
13906
- "releaseTag": "Public",
13907
- "name": "opacity",
13908
- "propertyTypeTokenRange": {
13909
- "startIndex": 1,
13910
- "endIndex": 2
13911
- }
13912
- },
13913
- {
13914
- "kind": "PropertySignature",
13915
- "canonicalReference": "server!EntityOptions#parent:member",
13916
- "docComment": "/**\n * The parent entity of the entity, entities with a parent will ignore creating their own colliders.\n */\n",
13917
- "excerptTokens": [
13918
- {
13919
- "kind": "Content",
13920
- "text": "parent?: "
13921
- },
13922
- {
13923
- "kind": "Reference",
13924
- "text": "Entity",
13925
- "canonicalReference": "server!Entity:class"
13926
- },
13927
- {
13928
- "kind": "Content",
13929
- "text": ";"
13930
- }
13931
- ],
13932
- "isReadonly": false,
13933
- "isOptional": true,
13934
- "releaseTag": "Public",
13935
- "name": "parent",
13936
- "propertyTypeTokenRange": {
13937
- "startIndex": 1,
13938
- "endIndex": 2
13939
- }
13958
+ "text": "export type EntityOptions = "
13940
13959
  },
13941
13960
  {
13942
- "kind": "PropertySignature",
13943
- "canonicalReference": "server!EntityOptions#parentNodeName:member",
13944
- "docComment": "/**\n * The name of the parent's node (if parent is a model entity) to attach the entity to.\n */\n",
13945
- "excerptTokens": [
13946
- {
13947
- "kind": "Content",
13948
- "text": "parentNodeName?: "
13949
- },
13950
- {
13951
- "kind": "Content",
13952
- "text": "string"
13953
- },
13954
- {
13955
- "kind": "Content",
13956
- "text": ";"
13957
- }
13958
- ],
13959
- "isReadonly": false,
13960
- "isOptional": true,
13961
- "releaseTag": "Public",
13962
- "name": "parentNodeName",
13963
- "propertyTypeTokenRange": {
13964
- "startIndex": 1,
13965
- "endIndex": 2
13966
- }
13961
+ "kind": "Reference",
13962
+ "text": "BlockEntityOptions",
13963
+ "canonicalReference": "server!BlockEntityOptions:interface"
13967
13964
  },
13968
13965
  {
13969
- "kind": "PropertySignature",
13970
- "canonicalReference": "server!EntityOptions#rigidBodyOptions:member",
13971
- "docComment": "/**\n * The rigid body options for the entity.\n */\n",
13972
- "excerptTokens": [
13973
- {
13974
- "kind": "Content",
13975
- "text": "rigidBodyOptions?: "
13976
- },
13977
- {
13978
- "kind": "Reference",
13979
- "text": "RigidBodyOptions",
13980
- "canonicalReference": "server!RigidBodyOptions:type"
13981
- },
13982
- {
13983
- "kind": "Content",
13984
- "text": ";"
13985
- }
13986
- ],
13987
- "isReadonly": false,
13988
- "isOptional": true,
13989
- "releaseTag": "Public",
13990
- "name": "rigidBodyOptions",
13991
- "propertyTypeTokenRange": {
13992
- "startIndex": 1,
13993
- "endIndex": 2
13994
- }
13966
+ "kind": "Content",
13967
+ "text": " | "
13995
13968
  },
13996
13969
  {
13997
- "kind": "PropertySignature",
13998
- "canonicalReference": "server!EntityOptions#tag:member",
13999
- "docComment": "/**\n * An arbitrary identifier tag of the entity. Useful for your own logic.\n */\n",
14000
- "excerptTokens": [
14001
- {
14002
- "kind": "Content",
14003
- "text": "tag?: "
14004
- },
14005
- {
14006
- "kind": "Content",
14007
- "text": "string"
14008
- },
14009
- {
14010
- "kind": "Content",
14011
- "text": ";"
14012
- }
14013
- ],
14014
- "isReadonly": false,
14015
- "isOptional": true,
14016
- "releaseTag": "Public",
14017
- "name": "tag",
14018
- "propertyTypeTokenRange": {
14019
- "startIndex": 1,
14020
- "endIndex": 2
14021
- }
13970
+ "kind": "Reference",
13971
+ "text": "ModelEntityOptions",
13972
+ "canonicalReference": "server!ModelEntityOptions:interface"
14022
13973
  },
14023
13974
  {
14024
- "kind": "PropertySignature",
14025
- "canonicalReference": "server!EntityOptions#tintColor:member",
14026
- "docComment": "/**\n * The tint color of the entity as a hex code.\n */\n",
14027
- "excerptTokens": [
14028
- {
14029
- "kind": "Content",
14030
- "text": "tintColor?: "
14031
- },
14032
- {
14033
- "kind": "Reference",
14034
- "text": "RgbColor",
14035
- "canonicalReference": "server!RgbColor:interface"
14036
- },
14037
- {
14038
- "kind": "Content",
14039
- "text": ";"
14040
- }
14041
- ],
14042
- "isReadonly": false,
14043
- "isOptional": true,
14044
- "releaseTag": "Public",
14045
- "name": "tintColor",
14046
- "propertyTypeTokenRange": {
14047
- "startIndex": 1,
14048
- "endIndex": 2
14049
- }
13975
+ "kind": "Content",
13976
+ "text": ";"
14050
13977
  }
14051
13978
  ],
14052
- "extendsTokenRanges": []
13979
+ "fileUrlPath": "src/world/entities/Entity.ts",
13980
+ "releaseTag": "Public",
13981
+ "name": "EntityOptions",
13982
+ "typeTokenRange": {
13983
+ "startIndex": 1,
13984
+ "endIndex": 4
13985
+ }
14053
13986
  },
14054
13987
  {
14055
13988
  "kind": "Class",
@@ -23789,54 +23722,136 @@
23789
23722
  ],
23790
23723
  "isStatic": false,
23791
23724
  "returnTypeTokenRange": {
23792
- "startIndex": 7,
23793
- "endIndex": 8
23725
+ "startIndex": 7,
23726
+ "endIndex": 8
23727
+ },
23728
+ "releaseTag": "Public",
23729
+ "isProtected": false,
23730
+ "overloadIndex": 1,
23731
+ "parameters": [
23732
+ {
23733
+ "parameterName": "eye",
23734
+ "parameterTypeTokenRange": {
23735
+ "startIndex": 1,
23736
+ "endIndex": 2
23737
+ },
23738
+ "isOptional": false
23739
+ },
23740
+ {
23741
+ "parameterName": "center",
23742
+ "parameterTypeTokenRange": {
23743
+ "startIndex": 3,
23744
+ "endIndex": 4
23745
+ },
23746
+ "isOptional": false
23747
+ },
23748
+ {
23749
+ "parameterName": "up",
23750
+ "parameterTypeTokenRange": {
23751
+ "startIndex": 5,
23752
+ "endIndex": 6
23753
+ },
23754
+ "isOptional": false
23755
+ }
23756
+ ],
23757
+ "isOptional": false,
23758
+ "isAbstract": false,
23759
+ "name": "targetTo"
23760
+ },
23761
+ {
23762
+ "kind": "Method",
23763
+ "canonicalReference": "server!Matrix4#toString:member(1)",
23764
+ "docComment": "/**\n * Returns a string representation of the current matrix.\n *\n * @returns A string representation of the current matrix.\n */\n",
23765
+ "excerptTokens": [
23766
+ {
23767
+ "kind": "Content",
23768
+ "text": "toString(): "
23769
+ },
23770
+ {
23771
+ "kind": "Content",
23772
+ "text": "string"
23773
+ },
23774
+ {
23775
+ "kind": "Content",
23776
+ "text": ";"
23777
+ }
23778
+ ],
23779
+ "isStatic": false,
23780
+ "returnTypeTokenRange": {
23781
+ "startIndex": 1,
23782
+ "endIndex": 2
23783
+ },
23784
+ "releaseTag": "Public",
23785
+ "isProtected": false,
23786
+ "overloadIndex": 1,
23787
+ "parameters": [],
23788
+ "isOptional": false,
23789
+ "isAbstract": false,
23790
+ "name": "toString"
23791
+ },
23792
+ {
23793
+ "kind": "Method",
23794
+ "canonicalReference": "server!Matrix4#translate:member(1)",
23795
+ "docComment": "/**\n * Translates the current matrix by a vector.\n *\n * @param vector3 - The vector to translate the current matrix by.\n *\n * @returns The current matrix.\n */\n",
23796
+ "excerptTokens": [
23797
+ {
23798
+ "kind": "Content",
23799
+ "text": "translate(vector3: "
23800
+ },
23801
+ {
23802
+ "kind": "Reference",
23803
+ "text": "Vector3",
23804
+ "canonicalReference": "server!Vector3:class"
23805
+ },
23806
+ {
23807
+ "kind": "Content",
23808
+ "text": "): "
23809
+ },
23810
+ {
23811
+ "kind": "Reference",
23812
+ "text": "Matrix4",
23813
+ "canonicalReference": "server!Matrix4:class"
23814
+ },
23815
+ {
23816
+ "kind": "Content",
23817
+ "text": ";"
23818
+ }
23819
+ ],
23820
+ "isStatic": false,
23821
+ "returnTypeTokenRange": {
23822
+ "startIndex": 3,
23823
+ "endIndex": 4
23794
23824
  },
23795
23825
  "releaseTag": "Public",
23796
23826
  "isProtected": false,
23797
23827
  "overloadIndex": 1,
23798
23828
  "parameters": [
23799
23829
  {
23800
- "parameterName": "eye",
23830
+ "parameterName": "vector3",
23801
23831
  "parameterTypeTokenRange": {
23802
23832
  "startIndex": 1,
23803
23833
  "endIndex": 2
23804
23834
  },
23805
23835
  "isOptional": false
23806
- },
23807
- {
23808
- "parameterName": "center",
23809
- "parameterTypeTokenRange": {
23810
- "startIndex": 3,
23811
- "endIndex": 4
23812
- },
23813
- "isOptional": false
23814
- },
23815
- {
23816
- "parameterName": "up",
23817
- "parameterTypeTokenRange": {
23818
- "startIndex": 5,
23819
- "endIndex": 6
23820
- },
23821
- "isOptional": false
23822
23836
  }
23823
23837
  ],
23824
23838
  "isOptional": false,
23825
23839
  "isAbstract": false,
23826
- "name": "targetTo"
23840
+ "name": "translate"
23827
23841
  },
23828
23842
  {
23829
23843
  "kind": "Method",
23830
- "canonicalReference": "server!Matrix4#toString:member(1)",
23831
- "docComment": "/**\n * Returns a string representation of the current matrix.\n *\n * @returns A string representation of the current matrix.\n */\n",
23844
+ "canonicalReference": "server!Matrix4#transpose:member(1)",
23845
+ "docComment": "/**\n * Transposes the current matrix.\n *\n * @returns The current matrix.\n */\n",
23832
23846
  "excerptTokens": [
23833
23847
  {
23834
23848
  "kind": "Content",
23835
- "text": "toString(): "
23849
+ "text": "transpose(): "
23836
23850
  },
23837
23851
  {
23838
- "kind": "Content",
23839
- "text": "string"
23852
+ "kind": "Reference",
23853
+ "text": "Matrix4",
23854
+ "canonicalReference": "server!Matrix4:class"
23840
23855
  },
23841
23856
  {
23842
23857
  "kind": "Content",
@@ -23854,96 +23869,181 @@
23854
23869
  "parameters": [],
23855
23870
  "isOptional": false,
23856
23871
  "isAbstract": false,
23857
- "name": "toString"
23872
+ "name": "transpose"
23873
+ }
23874
+ ],
23875
+ "extendsTokenRange": {
23876
+ "startIndex": 1,
23877
+ "endIndex": 2
23878
+ },
23879
+ "implementsTokenRanges": []
23880
+ },
23881
+ {
23882
+ "kind": "Interface",
23883
+ "canonicalReference": "server!ModelEntityOptions:interface",
23884
+ "docComment": "/**\n * The options for creating a model entity.\n *\n * @public\n */\n",
23885
+ "excerptTokens": [
23886
+ {
23887
+ "kind": "Content",
23888
+ "text": "export interface ModelEntityOptions extends "
23858
23889
  },
23859
23890
  {
23860
- "kind": "Method",
23861
- "canonicalReference": "server!Matrix4#translate:member(1)",
23862
- "docComment": "/**\n * Translates the current matrix by a vector.\n *\n * @param vector3 - The vector to translate the current matrix by.\n *\n * @returns The current matrix.\n */\n",
23891
+ "kind": "Reference",
23892
+ "text": "BaseEntityOptions",
23893
+ "canonicalReference": "server!BaseEntityOptions:interface"
23894
+ },
23895
+ {
23896
+ "kind": "Content",
23897
+ "text": " "
23898
+ }
23899
+ ],
23900
+ "fileUrlPath": "src/world/entities/Entity.ts",
23901
+ "releaseTag": "Public",
23902
+ "name": "ModelEntityOptions",
23903
+ "preserveMemberOrder": false,
23904
+ "members": [
23905
+ {
23906
+ "kind": "PropertySignature",
23907
+ "canonicalReference": "server!ModelEntityOptions#modelAnimationsPlaybackRate:member",
23908
+ "docComment": "/**\n * The playback rate of the entity's model animations.\n */\n",
23863
23909
  "excerptTokens": [
23864
23910
  {
23865
23911
  "kind": "Content",
23866
- "text": "translate(vector3: "
23912
+ "text": "modelAnimationsPlaybackRate?: "
23867
23913
  },
23868
23914
  {
23869
- "kind": "Reference",
23870
- "text": "Vector3",
23871
- "canonicalReference": "server!Vector3:class"
23915
+ "kind": "Content",
23916
+ "text": "number"
23872
23917
  },
23873
23918
  {
23874
23919
  "kind": "Content",
23875
- "text": "): "
23920
+ "text": ";"
23921
+ }
23922
+ ],
23923
+ "isReadonly": false,
23924
+ "isOptional": true,
23925
+ "releaseTag": "Public",
23926
+ "name": "modelAnimationsPlaybackRate",
23927
+ "propertyTypeTokenRange": {
23928
+ "startIndex": 1,
23929
+ "endIndex": 2
23930
+ }
23931
+ },
23932
+ {
23933
+ "kind": "PropertySignature",
23934
+ "canonicalReference": "server!ModelEntityOptions#modelHiddenNodes:member",
23935
+ "docComment": "/**\n * The nodes to hide on the entity's model.\n */\n",
23936
+ "excerptTokens": [
23937
+ {
23938
+ "kind": "Content",
23939
+ "text": "modelHiddenNodes?: "
23876
23940
  },
23877
23941
  {
23878
- "kind": "Reference",
23879
- "text": "Matrix4",
23880
- "canonicalReference": "server!Matrix4:class"
23942
+ "kind": "Content",
23943
+ "text": "string[]"
23881
23944
  },
23882
23945
  {
23883
23946
  "kind": "Content",
23884
23947
  "text": ";"
23885
23948
  }
23886
23949
  ],
23887
- "isStatic": false,
23888
- "returnTypeTokenRange": {
23889
- "startIndex": 3,
23890
- "endIndex": 4
23891
- },
23950
+ "isReadonly": false,
23951
+ "isOptional": true,
23892
23952
  "releaseTag": "Public",
23893
- "isProtected": false,
23894
- "overloadIndex": 1,
23895
- "parameters": [
23953
+ "name": "modelHiddenNodes",
23954
+ "propertyTypeTokenRange": {
23955
+ "startIndex": 1,
23956
+ "endIndex": 2
23957
+ }
23958
+ },
23959
+ {
23960
+ "kind": "PropertySignature",
23961
+ "canonicalReference": "server!ModelEntityOptions#modelLoopedAnimations:member",
23962
+ "docComment": "/**\n * The looped animations to start when the entity is spawned.\n */\n",
23963
+ "excerptTokens": [
23896
23964
  {
23897
- "parameterName": "vector3",
23898
- "parameterTypeTokenRange": {
23899
- "startIndex": 1,
23900
- "endIndex": 2
23901
- },
23902
- "isOptional": false
23965
+ "kind": "Content",
23966
+ "text": "modelLoopedAnimations?: "
23967
+ },
23968
+ {
23969
+ "kind": "Content",
23970
+ "text": "string[]"
23971
+ },
23972
+ {
23973
+ "kind": "Content",
23974
+ "text": ";"
23903
23975
  }
23904
23976
  ],
23905
- "isOptional": false,
23906
- "isAbstract": false,
23907
- "name": "translate"
23977
+ "isReadonly": false,
23978
+ "isOptional": true,
23979
+ "releaseTag": "Public",
23980
+ "name": "modelLoopedAnimations",
23981
+ "propertyTypeTokenRange": {
23982
+ "startIndex": 1,
23983
+ "endIndex": 2
23984
+ }
23908
23985
  },
23909
23986
  {
23910
- "kind": "Method",
23911
- "canonicalReference": "server!Matrix4#transpose:member(1)",
23912
- "docComment": "/**\n * Transposes the current matrix.\n *\n * @returns The current matrix.\n */\n",
23987
+ "kind": "PropertySignature",
23988
+ "canonicalReference": "server!ModelEntityOptions#modelScale:member",
23989
+ "docComment": "/**\n * The scale of the entity's model.\n */\n",
23913
23990
  "excerptTokens": [
23914
23991
  {
23915
23992
  "kind": "Content",
23916
- "text": "transpose(): "
23993
+ "text": "modelScale?: "
23917
23994
  },
23918
23995
  {
23919
- "kind": "Reference",
23920
- "text": "Matrix4",
23921
- "canonicalReference": "server!Matrix4:class"
23996
+ "kind": "Content",
23997
+ "text": "number"
23922
23998
  },
23923
23999
  {
23924
24000
  "kind": "Content",
23925
24001
  "text": ";"
23926
24002
  }
23927
24003
  ],
23928
- "isStatic": false,
23929
- "returnTypeTokenRange": {
24004
+ "isReadonly": false,
24005
+ "isOptional": true,
24006
+ "releaseTag": "Public",
24007
+ "name": "modelScale",
24008
+ "propertyTypeTokenRange": {
23930
24009
  "startIndex": 1,
23931
24010
  "endIndex": 2
23932
- },
24011
+ }
24012
+ },
24013
+ {
24014
+ "kind": "PropertySignature",
24015
+ "canonicalReference": "server!ModelEntityOptions#modelUri:member",
24016
+ "docComment": "/**\n * The URI or path to the .gltf model asset to be used for the entity.\n */\n",
24017
+ "excerptTokens": [
24018
+ {
24019
+ "kind": "Content",
24020
+ "text": "modelUri?: "
24021
+ },
24022
+ {
24023
+ "kind": "Content",
24024
+ "text": "string"
24025
+ },
24026
+ {
24027
+ "kind": "Content",
24028
+ "text": ";"
24029
+ }
24030
+ ],
24031
+ "isReadonly": false,
24032
+ "isOptional": true,
23933
24033
  "releaseTag": "Public",
23934
- "isProtected": false,
23935
- "overloadIndex": 1,
23936
- "parameters": [],
23937
- "isOptional": false,
23938
- "isAbstract": false,
23939
- "name": "transpose"
24034
+ "name": "modelUri",
24035
+ "propertyTypeTokenRange": {
24036
+ "startIndex": 1,
24037
+ "endIndex": 2
24038
+ }
23940
24039
  }
23941
24040
  ],
23942
- "extendsTokenRange": {
23943
- "startIndex": 1,
23944
- "endIndex": 2
23945
- },
23946
- "implementsTokenRanges": []
24041
+ "extendsTokenRanges": [
24042
+ {
24043
+ "startIndex": 1,
24044
+ "endIndex": 2
24045
+ }
24046
+ ]
23947
24047
  },
23948
24048
  {
23949
24049
  "kind": "Class",
@@ -28067,7 +28167,7 @@
28067
28167
  {
28068
28168
  "kind": "Reference",
28069
28169
  "text": "PlayerEntityOptions",
28070
- "canonicalReference": "server!PlayerEntityOptions:interface"
28170
+ "canonicalReference": "server!PlayerEntityOptions:type"
28071
28171
  },
28072
28172
  {
28073
28173
  "kind": "Content",
@@ -29301,64 +29401,44 @@
29301
29401
  "extendsTokenRanges": []
29302
29402
  },
29303
29403
  {
29304
- "kind": "Interface",
29305
- "canonicalReference": "server!PlayerEntityOptions:interface",
29404
+ "kind": "TypeAlias",
29405
+ "canonicalReference": "server!PlayerEntityOptions:type",
29306
29406
  "docComment": "/**\n * Options for creating a PlayerEntity instance.\n *\n * @public\n */\n",
29307
29407
  "excerptTokens": [
29308
29408
  {
29309
29409
  "kind": "Content",
29310
- "text": "export interface PlayerEntityOptions extends "
29410
+ "text": "export type PlayerEntityOptions = "
29411
+ },
29412
+ {
29413
+ "kind": "Content",
29414
+ "text": "{\n player: "
29415
+ },
29416
+ {
29417
+ "kind": "Reference",
29418
+ "text": "Player",
29419
+ "canonicalReference": "server!Player:class"
29420
+ },
29421
+ {
29422
+ "kind": "Content",
29423
+ "text": ";\n} & "
29311
29424
  },
29312
29425
  {
29313
29426
  "kind": "Reference",
29314
29427
  "text": "EntityOptions",
29315
- "canonicalReference": "server!EntityOptions:interface"
29428
+ "canonicalReference": "server!EntityOptions:type"
29316
29429
  },
29317
29430
  {
29318
29431
  "kind": "Content",
29319
- "text": " "
29432
+ "text": ";"
29320
29433
  }
29321
29434
  ],
29322
29435
  "fileUrlPath": "src/world/entities/PlayerEntity.ts",
29323
29436
  "releaseTag": "Public",
29324
29437
  "name": "PlayerEntityOptions",
29325
- "preserveMemberOrder": false,
29326
- "members": [
29327
- {
29328
- "kind": "PropertySignature",
29329
- "canonicalReference": "server!PlayerEntityOptions#player:member",
29330
- "docComment": "/**\n * The player the player entity is assigned to.\n */\n",
29331
- "excerptTokens": [
29332
- {
29333
- "kind": "Content",
29334
- "text": "player: "
29335
- },
29336
- {
29337
- "kind": "Reference",
29338
- "text": "Player",
29339
- "canonicalReference": "server!Player:class"
29340
- },
29341
- {
29342
- "kind": "Content",
29343
- "text": ";"
29344
- }
29345
- ],
29346
- "isReadonly": false,
29347
- "isOptional": false,
29348
- "releaseTag": "Public",
29349
- "name": "player",
29350
- "propertyTypeTokenRange": {
29351
- "startIndex": 1,
29352
- "endIndex": 2
29353
- }
29354
- }
29355
- ],
29356
- "extendsTokenRanges": [
29357
- {
29358
- "startIndex": 1,
29359
- "endIndex": 2
29360
- }
29361
- ]
29438
+ "typeTokenRange": {
29439
+ "startIndex": 1,
29440
+ "endIndex": 5
29441
+ }
29362
29442
  },
29363
29443
  {
29364
29444
  "kind": "Enum",
@@ -30103,7 +30183,7 @@
30103
30183
  {
30104
30184
  "kind": "Method",
30105
30185
  "canonicalReference": "server!PlayerUI#lockPointer:member(1)",
30106
- "docComment": "/**\n * Locks or unlocks the player's mouse pointer.\n *\n * @param lock - Set true to lock the pointer, false to unlock it.\n */\n",
30186
+ "docComment": "/**\n * Locks or unlocks the player's mouse pointer. If the pointer is unlocked with lockPointer(false), the player will not be able to use in-game inputs or camera controls from the mouse pointer until `player.ui.lockPointer(true)`, or in your game's client UI html with `hytopia.lockPointer(true)`.\n *\n * @param lock - Set true to lock the pointer, false to unlock it.\n */\n",
30107
30187
  "excerptTokens": [
30108
30188
  {
30109
30189
  "kind": "Content",
@@ -45049,7 +45129,7 @@
45049
45129
  {
45050
45130
  "kind": "Reference",
45051
45131
  "text": "EntityOptions",
45052
- "canonicalReference": "server!EntityOptions:interface"
45132
+ "canonicalReference": "server!EntityOptions:type"
45053
45133
  },
45054
45134
  {
45055
45135
  "kind": "Content",