hytopia 0.1.55 → 0.1.56
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/docs/server.basecharactercontroller.attach.md +53 -0
- package/docs/server.basecharactercontroller.despawn.md +53 -0
- package/docs/server.basecharactercontroller.detach.md +53 -0
- package/docs/server.basecharactercontroller.md +91 -28
- package/docs/server.basecharactercontroller.onattach.md +13 -0
- package/docs/server.basecharactercontroller.ondespawn.md +13 -0
- package/docs/server.basecharactercontroller.ondetach.md +13 -0
- package/docs/server.basecharactercontroller.onspawn.md +13 -0
- package/docs/server.basecharactercontroller.ontick.md +2 -2
- package/docs/server.basecharactercontroller.ontickwithplayerinput.md +2 -2
- package/docs/server.basecharactercontroller.spawn.md +53 -0
- package/docs/server.basecharactercontroller.tick.md +15 -1
- package/docs/server.basecharactercontroller.tickwithplayerinput.md +17 -1
- package/docs/server.defaultcharactercontroller._constructor_.md +1 -17
- package/docs/server.defaultcharactercontroller.attach.md +53 -0
- package/docs/server.defaultcharactercontroller.md +18 -4
- package/docs/server.defaultcharactercontroller.spawn.md +53 -0
- package/docs/server.defaultcharactercontroller.tickwithplayerinput.md +17 -1
- package/docs/server.entity.md +0 -19
- package/docs/server.entity.setcharactercontroller.md +2 -2
- package/docs/server.entityoptions.charactercontroller.md +13 -0
- package/docs/server.entityoptions.md +3 -3
- package/examples/block-entity/index.ts +1 -1
- package/examples/character-controller/MyCharacterController.ts +190 -119
- package/examples/character-controller/index.ts +5 -10
- package/examples/custom-ui/index.ts +1 -1
- package/examples/payload-game/index.ts +6 -7
- package/package.json +1 -1
- package/server.api.json +468 -176
- package/server.d.ts +71 -40
- package/server.js +81 -81
- package/docs/server.basecharactercontroller._constructor_.md +0 -65
- package/docs/server.basecharactercontroller.createcolliders.md +0 -19
- package/docs/server.basecharactercontroller.entity.md +0 -13
- package/docs/server.defaultcharactercontroller.createcolliders.md +0 -19
- package/docs/server.entity.createcustomcharactercontroller.md +0 -13
- package/docs/server.entityoptions.createcustomcharactercontroller.md +0 -13
package/server.api.json
CHANGED
@@ -2633,13 +2633,13 @@
|
|
2633
2633
|
"preserveMemberOrder": false,
|
2634
2634
|
"members": [
|
2635
2635
|
{
|
2636
|
-
"kind": "
|
2637
|
-
"canonicalReference": "server!BaseCharacterController:
|
2638
|
-
"docComment": "/**\n *
|
2636
|
+
"kind": "Method",
|
2637
|
+
"canonicalReference": "server!BaseCharacterController#attach:member(1)",
|
2638
|
+
"docComment": "/**\n * Override this method to handle the attachment of an entity to your character controller.\n *\n * @param entity - The entity to attach the controller to.\n */\n",
|
2639
2639
|
"excerptTokens": [
|
2640
2640
|
{
|
2641
2641
|
"kind": "Content",
|
2642
|
-
"text": "
|
2642
|
+
"text": "attach(entity: "
|
2643
2643
|
},
|
2644
2644
|
{
|
2645
2645
|
"kind": "Reference",
|
@@ -2648,22 +2648,22 @@
|
|
2648
2648
|
},
|
2649
2649
|
{
|
2650
2650
|
"kind": "Content",
|
2651
|
-
"text": "
|
2652
|
-
},
|
2653
|
-
{
|
2654
|
-
"kind": "Reference",
|
2655
|
-
"text": "Record",
|
2656
|
-
"canonicalReference": "!Record:type"
|
2651
|
+
"text": "): "
|
2657
2652
|
},
|
2658
2653
|
{
|
2659
2654
|
"kind": "Content",
|
2660
|
-
"text": "
|
2655
|
+
"text": "void"
|
2661
2656
|
},
|
2662
2657
|
{
|
2663
2658
|
"kind": "Content",
|
2664
|
-
"text": "
|
2659
|
+
"text": ";"
|
2665
2660
|
}
|
2666
2661
|
],
|
2662
|
+
"isStatic": false,
|
2663
|
+
"returnTypeTokenRange": {
|
2664
|
+
"startIndex": 3,
|
2665
|
+
"endIndex": 4
|
2666
|
+
},
|
2667
2667
|
"releaseTag": "Public",
|
2668
2668
|
"isProtected": false,
|
2669
2669
|
"overloadIndex": 1,
|
@@ -2675,34 +2675,82 @@
|
|
2675
2675
|
"endIndex": 2
|
2676
2676
|
},
|
2677
2677
|
"isOptional": false
|
2678
|
+
}
|
2679
|
+
],
|
2680
|
+
"isOptional": false,
|
2681
|
+
"isAbstract": false,
|
2682
|
+
"name": "attach"
|
2683
|
+
},
|
2684
|
+
{
|
2685
|
+
"kind": "Method",
|
2686
|
+
"canonicalReference": "server!BaseCharacterController#despawn:member(1)",
|
2687
|
+
"docComment": "/**\n * Override this method to handle the despawn of an entity from your character controller.\n *\n * @param entity - The entity to despawn.\n */\n",
|
2688
|
+
"excerptTokens": [
|
2689
|
+
{
|
2690
|
+
"kind": "Content",
|
2691
|
+
"text": "despawn(entity: "
|
2692
|
+
},
|
2693
|
+
{
|
2694
|
+
"kind": "Reference",
|
2695
|
+
"text": "Entity",
|
2696
|
+
"canonicalReference": "server!Entity:class"
|
2678
2697
|
},
|
2679
2698
|
{
|
2680
|
-
"
|
2699
|
+
"kind": "Content",
|
2700
|
+
"text": "): "
|
2701
|
+
},
|
2702
|
+
{
|
2703
|
+
"kind": "Content",
|
2704
|
+
"text": "void"
|
2705
|
+
},
|
2706
|
+
{
|
2707
|
+
"kind": "Content",
|
2708
|
+
"text": ";"
|
2709
|
+
}
|
2710
|
+
],
|
2711
|
+
"isStatic": false,
|
2712
|
+
"returnTypeTokenRange": {
|
2713
|
+
"startIndex": 3,
|
2714
|
+
"endIndex": 4
|
2715
|
+
},
|
2716
|
+
"releaseTag": "Public",
|
2717
|
+
"isProtected": false,
|
2718
|
+
"overloadIndex": 1,
|
2719
|
+
"parameters": [
|
2720
|
+
{
|
2721
|
+
"parameterName": "entity",
|
2681
2722
|
"parameterTypeTokenRange": {
|
2682
|
-
"startIndex":
|
2683
|
-
"endIndex":
|
2723
|
+
"startIndex": 1,
|
2724
|
+
"endIndex": 2
|
2684
2725
|
},
|
2685
|
-
"isOptional":
|
2726
|
+
"isOptional": false
|
2686
2727
|
}
|
2687
|
-
]
|
2728
|
+
],
|
2729
|
+
"isOptional": false,
|
2730
|
+
"isAbstract": false,
|
2731
|
+
"name": "despawn"
|
2688
2732
|
},
|
2689
2733
|
{
|
2690
2734
|
"kind": "Method",
|
2691
|
-
"canonicalReference": "server!BaseCharacterController#
|
2692
|
-
"docComment": "/**\n * Override this method to
|
2735
|
+
"canonicalReference": "server!BaseCharacterController#detach:member(1)",
|
2736
|
+
"docComment": "/**\n * Override this method to handle the detachment of an entity from your character controller.\n *\n * @param entity - The entity to detach.\n */\n",
|
2693
2737
|
"excerptTokens": [
|
2694
2738
|
{
|
2695
2739
|
"kind": "Content",
|
2696
|
-
"text": "
|
2740
|
+
"text": "detach(entity: "
|
2697
2741
|
},
|
2698
2742
|
{
|
2699
2743
|
"kind": "Reference",
|
2700
|
-
"text": "
|
2701
|
-
"canonicalReference": "server!
|
2744
|
+
"text": "Entity",
|
2745
|
+
"canonicalReference": "server!Entity:class"
|
2702
2746
|
},
|
2703
2747
|
{
|
2704
2748
|
"kind": "Content",
|
2705
|
-
"text": "
|
2749
|
+
"text": "): "
|
2750
|
+
},
|
2751
|
+
{
|
2752
|
+
"kind": "Content",
|
2753
|
+
"text": "void"
|
2706
2754
|
},
|
2707
2755
|
{
|
2708
2756
|
"kind": "Content",
|
@@ -2711,43 +2759,177 @@
|
|
2711
2759
|
],
|
2712
2760
|
"isStatic": false,
|
2713
2761
|
"returnTypeTokenRange": {
|
2714
|
-
"startIndex":
|
2715
|
-
"endIndex":
|
2762
|
+
"startIndex": 3,
|
2763
|
+
"endIndex": 4
|
2716
2764
|
},
|
2717
2765
|
"releaseTag": "Public",
|
2718
2766
|
"isProtected": false,
|
2719
2767
|
"overloadIndex": 1,
|
2720
|
-
"parameters": [
|
2768
|
+
"parameters": [
|
2769
|
+
{
|
2770
|
+
"parameterName": "entity",
|
2771
|
+
"parameterTypeTokenRange": {
|
2772
|
+
"startIndex": 1,
|
2773
|
+
"endIndex": 2
|
2774
|
+
},
|
2775
|
+
"isOptional": false
|
2776
|
+
}
|
2777
|
+
],
|
2721
2778
|
"isOptional": false,
|
2722
2779
|
"isAbstract": false,
|
2723
|
-
"name": "
|
2780
|
+
"name": "detach"
|
2724
2781
|
},
|
2725
2782
|
{
|
2726
2783
|
"kind": "Property",
|
2727
|
-
"canonicalReference": "server!BaseCharacterController#
|
2728
|
-
"docComment": "/**\n *
|
2784
|
+
"canonicalReference": "server!BaseCharacterController#onAttach:member",
|
2785
|
+
"docComment": "/**\n * A function that is called when the controller is attached to an entity. Useful for implementing attach logic without writing a new character controller class.\n */\n",
|
2729
2786
|
"excerptTokens": [
|
2730
2787
|
{
|
2731
2788
|
"kind": "Content",
|
2732
|
-
"text": "
|
2789
|
+
"text": "onAttach?: "
|
2790
|
+
},
|
2791
|
+
{
|
2792
|
+
"kind": "Content",
|
2793
|
+
"text": "(entity: "
|
2733
2794
|
},
|
2734
2795
|
{
|
2735
2796
|
"kind": "Reference",
|
2736
2797
|
"text": "Entity",
|
2737
2798
|
"canonicalReference": "server!Entity:class"
|
2738
2799
|
},
|
2800
|
+
{
|
2801
|
+
"kind": "Content",
|
2802
|
+
"text": ") => void"
|
2803
|
+
},
|
2739
2804
|
{
|
2740
2805
|
"kind": "Content",
|
2741
2806
|
"text": ";"
|
2742
2807
|
}
|
2743
2808
|
],
|
2744
|
-
"isReadonly":
|
2745
|
-
"isOptional":
|
2809
|
+
"isReadonly": false,
|
2810
|
+
"isOptional": true,
|
2746
2811
|
"releaseTag": "Public",
|
2747
|
-
"name": "
|
2812
|
+
"name": "onAttach",
|
2748
2813
|
"propertyTypeTokenRange": {
|
2749
2814
|
"startIndex": 1,
|
2750
|
-
"endIndex":
|
2815
|
+
"endIndex": 4
|
2816
|
+
},
|
2817
|
+
"isStatic": false,
|
2818
|
+
"isProtected": false,
|
2819
|
+
"isAbstract": false
|
2820
|
+
},
|
2821
|
+
{
|
2822
|
+
"kind": "Property",
|
2823
|
+
"canonicalReference": "server!BaseCharacterController#onDespawn:member",
|
2824
|
+
"docComment": "/**\n * A function that is called when the controlled entity is despawned. Useful for implementing despawn logic without writing a new character controller class.\n */\n",
|
2825
|
+
"excerptTokens": [
|
2826
|
+
{
|
2827
|
+
"kind": "Content",
|
2828
|
+
"text": "onDespawn?: "
|
2829
|
+
},
|
2830
|
+
{
|
2831
|
+
"kind": "Content",
|
2832
|
+
"text": "(entity: "
|
2833
|
+
},
|
2834
|
+
{
|
2835
|
+
"kind": "Reference",
|
2836
|
+
"text": "Entity",
|
2837
|
+
"canonicalReference": "server!Entity:class"
|
2838
|
+
},
|
2839
|
+
{
|
2840
|
+
"kind": "Content",
|
2841
|
+
"text": ") => void"
|
2842
|
+
},
|
2843
|
+
{
|
2844
|
+
"kind": "Content",
|
2845
|
+
"text": ";"
|
2846
|
+
}
|
2847
|
+
],
|
2848
|
+
"isReadonly": false,
|
2849
|
+
"isOptional": true,
|
2850
|
+
"releaseTag": "Public",
|
2851
|
+
"name": "onDespawn",
|
2852
|
+
"propertyTypeTokenRange": {
|
2853
|
+
"startIndex": 1,
|
2854
|
+
"endIndex": 4
|
2855
|
+
},
|
2856
|
+
"isStatic": false,
|
2857
|
+
"isProtected": false,
|
2858
|
+
"isAbstract": false
|
2859
|
+
},
|
2860
|
+
{
|
2861
|
+
"kind": "Property",
|
2862
|
+
"canonicalReference": "server!BaseCharacterController#onDetach:member",
|
2863
|
+
"docComment": "/**\n * A function that is called when the controller is detached from an entity. Useful for implementing detach logic without writing a new character controller class.\n */\n",
|
2864
|
+
"excerptTokens": [
|
2865
|
+
{
|
2866
|
+
"kind": "Content",
|
2867
|
+
"text": "onDetach?: "
|
2868
|
+
},
|
2869
|
+
{
|
2870
|
+
"kind": "Content",
|
2871
|
+
"text": "(entity: "
|
2872
|
+
},
|
2873
|
+
{
|
2874
|
+
"kind": "Reference",
|
2875
|
+
"text": "Entity",
|
2876
|
+
"canonicalReference": "server!Entity:class"
|
2877
|
+
},
|
2878
|
+
{
|
2879
|
+
"kind": "Content",
|
2880
|
+
"text": ") => void"
|
2881
|
+
},
|
2882
|
+
{
|
2883
|
+
"kind": "Content",
|
2884
|
+
"text": ";"
|
2885
|
+
}
|
2886
|
+
],
|
2887
|
+
"isReadonly": false,
|
2888
|
+
"isOptional": true,
|
2889
|
+
"releaseTag": "Public",
|
2890
|
+
"name": "onDetach",
|
2891
|
+
"propertyTypeTokenRange": {
|
2892
|
+
"startIndex": 1,
|
2893
|
+
"endIndex": 4
|
2894
|
+
},
|
2895
|
+
"isStatic": false,
|
2896
|
+
"isProtected": false,
|
2897
|
+
"isAbstract": false
|
2898
|
+
},
|
2899
|
+
{
|
2900
|
+
"kind": "Property",
|
2901
|
+
"canonicalReference": "server!BaseCharacterController#onSpawn:member",
|
2902
|
+
"docComment": "/**\n * A function that is called when the controlled entity is spawned. Useful for implementing spawn logic without writing a new character controller class.\n */\n",
|
2903
|
+
"excerptTokens": [
|
2904
|
+
{
|
2905
|
+
"kind": "Content",
|
2906
|
+
"text": "onSpawn?: "
|
2907
|
+
},
|
2908
|
+
{
|
2909
|
+
"kind": "Content",
|
2910
|
+
"text": "(entity: "
|
2911
|
+
},
|
2912
|
+
{
|
2913
|
+
"kind": "Reference",
|
2914
|
+
"text": "Entity",
|
2915
|
+
"canonicalReference": "server!Entity:class"
|
2916
|
+
},
|
2917
|
+
{
|
2918
|
+
"kind": "Content",
|
2919
|
+
"text": ") => void"
|
2920
|
+
},
|
2921
|
+
{
|
2922
|
+
"kind": "Content",
|
2923
|
+
"text": ";"
|
2924
|
+
}
|
2925
|
+
],
|
2926
|
+
"isReadonly": false,
|
2927
|
+
"isOptional": true,
|
2928
|
+
"releaseTag": "Public",
|
2929
|
+
"name": "onSpawn",
|
2930
|
+
"propertyTypeTokenRange": {
|
2931
|
+
"startIndex": 1,
|
2932
|
+
"endIndex": 4
|
2751
2933
|
},
|
2752
2934
|
"isStatic": false,
|
2753
2935
|
"isProtected": false,
|
@@ -2756,7 +2938,7 @@
|
|
2756
2938
|
{
|
2757
2939
|
"kind": "Property",
|
2758
2940
|
"canonicalReference": "server!BaseCharacterController#onTick:member",
|
2759
|
-
"docComment": "/**\n * A
|
2941
|
+
"docComment": "/**\n * A function that is called every tick. Useful for implementing tick logic without writing a new character controller class.\n */\n",
|
2760
2942
|
"excerptTokens": [
|
2761
2943
|
{
|
2762
2944
|
"kind": "Content",
|
@@ -2764,7 +2946,16 @@
|
|
2764
2946
|
},
|
2765
2947
|
{
|
2766
2948
|
"kind": "Content",
|
2767
|
-
"text": "(
|
2949
|
+
"text": "(entity: "
|
2950
|
+
},
|
2951
|
+
{
|
2952
|
+
"kind": "Reference",
|
2953
|
+
"text": "Entity",
|
2954
|
+
"canonicalReference": "server!Entity:class"
|
2955
|
+
},
|
2956
|
+
{
|
2957
|
+
"kind": "Content",
|
2958
|
+
"text": ", deltaTimeMs: number) => void"
|
2768
2959
|
},
|
2769
2960
|
{
|
2770
2961
|
"kind": "Content",
|
@@ -2777,7 +2968,7 @@
|
|
2777
2968
|
"name": "onTick",
|
2778
2969
|
"propertyTypeTokenRange": {
|
2779
2970
|
"startIndex": 1,
|
2780
|
-
"endIndex":
|
2971
|
+
"endIndex": 4
|
2781
2972
|
},
|
2782
2973
|
"isStatic": false,
|
2783
2974
|
"isProtected": false,
|
@@ -2786,7 +2977,7 @@
|
|
2786
2977
|
{
|
2787
2978
|
"kind": "Property",
|
2788
2979
|
"canonicalReference": "server!BaseCharacterController#onTickWithPlayerInput:member",
|
2789
|
-
"docComment": "/**\n * A
|
2980
|
+
"docComment": "/**\n * A function that is called every tick with player input by a PlayerEntity with this controller attached. Useful for implementing tick logic without writing a new character controller class.\n */\n",
|
2790
2981
|
"excerptTokens": [
|
2791
2982
|
{
|
2792
2983
|
"kind": "Content",
|
@@ -2794,7 +2985,16 @@
|
|
2794
2985
|
},
|
2795
2986
|
{
|
2796
2987
|
"kind": "Content",
|
2797
|
-
"text": "(
|
2988
|
+
"text": "(entity: "
|
2989
|
+
},
|
2990
|
+
{
|
2991
|
+
"kind": "Reference",
|
2992
|
+
"text": "PlayerEntity",
|
2993
|
+
"canonicalReference": "server!PlayerEntity:class"
|
2994
|
+
},
|
2995
|
+
{
|
2996
|
+
"kind": "Content",
|
2997
|
+
"text": ", input: "
|
2798
2998
|
},
|
2799
2999
|
{
|
2800
3000
|
"kind": "Reference",
|
@@ -2825,12 +3025,61 @@
|
|
2825
3025
|
"name": "onTickWithPlayerInput",
|
2826
3026
|
"propertyTypeTokenRange": {
|
2827
3027
|
"startIndex": 1,
|
2828
|
-
"endIndex":
|
3028
|
+
"endIndex": 8
|
2829
3029
|
},
|
2830
3030
|
"isStatic": false,
|
2831
3031
|
"isProtected": false,
|
2832
3032
|
"isAbstract": false
|
2833
3033
|
},
|
3034
|
+
{
|
3035
|
+
"kind": "Method",
|
3036
|
+
"canonicalReference": "server!BaseCharacterController#spawn:member(1)",
|
3037
|
+
"docComment": "/**\n * Override this method to handle the spawning of an entity to your character controller.\n *\n * @param entity - The entity to spawn.\n */\n",
|
3038
|
+
"excerptTokens": [
|
3039
|
+
{
|
3040
|
+
"kind": "Content",
|
3041
|
+
"text": "spawn(entity: "
|
3042
|
+
},
|
3043
|
+
{
|
3044
|
+
"kind": "Reference",
|
3045
|
+
"text": "Entity",
|
3046
|
+
"canonicalReference": "server!Entity:class"
|
3047
|
+
},
|
3048
|
+
{
|
3049
|
+
"kind": "Content",
|
3050
|
+
"text": "): "
|
3051
|
+
},
|
3052
|
+
{
|
3053
|
+
"kind": "Content",
|
3054
|
+
"text": "void"
|
3055
|
+
},
|
3056
|
+
{
|
3057
|
+
"kind": "Content",
|
3058
|
+
"text": ";"
|
3059
|
+
}
|
3060
|
+
],
|
3061
|
+
"isStatic": false,
|
3062
|
+
"returnTypeTokenRange": {
|
3063
|
+
"startIndex": 3,
|
3064
|
+
"endIndex": 4
|
3065
|
+
},
|
3066
|
+
"releaseTag": "Public",
|
3067
|
+
"isProtected": false,
|
3068
|
+
"overloadIndex": 1,
|
3069
|
+
"parameters": [
|
3070
|
+
{
|
3071
|
+
"parameterName": "entity",
|
3072
|
+
"parameterTypeTokenRange": {
|
3073
|
+
"startIndex": 1,
|
3074
|
+
"endIndex": 2
|
3075
|
+
},
|
3076
|
+
"isOptional": false
|
3077
|
+
}
|
3078
|
+
],
|
3079
|
+
"isOptional": false,
|
3080
|
+
"isAbstract": false,
|
3081
|
+
"name": "spawn"
|
3082
|
+
},
|
2834
3083
|
{
|
2835
3084
|
"kind": "Method",
|
2836
3085
|
"canonicalReference": "server!BaseCharacterController#tick:member(1)",
|
@@ -2838,7 +3087,16 @@
|
|
2838
3087
|
"excerptTokens": [
|
2839
3088
|
{
|
2840
3089
|
"kind": "Content",
|
2841
|
-
"text": "tick(
|
3090
|
+
"text": "tick(entity: "
|
3091
|
+
},
|
3092
|
+
{
|
3093
|
+
"kind": "Reference",
|
3094
|
+
"text": "Entity",
|
3095
|
+
"canonicalReference": "server!Entity:class"
|
3096
|
+
},
|
3097
|
+
{
|
3098
|
+
"kind": "Content",
|
3099
|
+
"text": ", deltaTimeMs: "
|
2842
3100
|
},
|
2843
3101
|
{
|
2844
3102
|
"kind": "Content",
|
@@ -2859,18 +3117,26 @@
|
|
2859
3117
|
],
|
2860
3118
|
"isStatic": false,
|
2861
3119
|
"returnTypeTokenRange": {
|
2862
|
-
"startIndex":
|
2863
|
-
"endIndex":
|
3120
|
+
"startIndex": 5,
|
3121
|
+
"endIndex": 6
|
2864
3122
|
},
|
2865
3123
|
"releaseTag": "Public",
|
2866
3124
|
"isProtected": false,
|
2867
3125
|
"overloadIndex": 1,
|
2868
3126
|
"parameters": [
|
3127
|
+
{
|
3128
|
+
"parameterName": "entity",
|
3129
|
+
"parameterTypeTokenRange": {
|
3130
|
+
"startIndex": 1,
|
3131
|
+
"endIndex": 2
|
3132
|
+
},
|
3133
|
+
"isOptional": false
|
3134
|
+
},
|
2869
3135
|
{
|
2870
3136
|
"parameterName": "deltaTimeMs",
|
2871
3137
|
"parameterTypeTokenRange": {
|
2872
|
-
"startIndex":
|
2873
|
-
"endIndex":
|
3138
|
+
"startIndex": 3,
|
3139
|
+
"endIndex": 4
|
2874
3140
|
},
|
2875
3141
|
"isOptional": false
|
2876
3142
|
}
|
@@ -2882,11 +3148,20 @@
|
|
2882
3148
|
{
|
2883
3149
|
"kind": "Method",
|
2884
3150
|
"canonicalReference": "server!BaseCharacterController#tickWithPlayerInput:member(1)",
|
2885
|
-
"docComment": "/**\n * Override this method to handle entity movements based on player input for your character controller. 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",
|
3151
|
+
"docComment": "/**\n * Override this method to handle entity movements based on player input for your character controller. This is called every tick by a PlayerEntity with a character controller.\n *\n * @param entity - The entity to tick.\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
3152
|
"excerptTokens": [
|
2887
3153
|
{
|
2888
3154
|
"kind": "Content",
|
2889
|
-
"text": "tickWithPlayerInput(
|
3155
|
+
"text": "tickWithPlayerInput(entity: "
|
3156
|
+
},
|
3157
|
+
{
|
3158
|
+
"kind": "Reference",
|
3159
|
+
"text": "PlayerEntity",
|
3160
|
+
"canonicalReference": "server!PlayerEntity:class"
|
3161
|
+
},
|
3162
|
+
{
|
3163
|
+
"kind": "Content",
|
3164
|
+
"text": ", input: "
|
2890
3165
|
},
|
2891
3166
|
{
|
2892
3167
|
"kind": "Reference",
|
@@ -2925,15 +3200,15 @@
|
|
2925
3200
|
],
|
2926
3201
|
"isStatic": false,
|
2927
3202
|
"returnTypeTokenRange": {
|
2928
|
-
"startIndex":
|
2929
|
-
"endIndex":
|
3203
|
+
"startIndex": 9,
|
3204
|
+
"endIndex": 10
|
2930
3205
|
},
|
2931
3206
|
"releaseTag": "Public",
|
2932
3207
|
"isProtected": false,
|
2933
3208
|
"overloadIndex": 1,
|
2934
3209
|
"parameters": [
|
2935
3210
|
{
|
2936
|
-
"parameterName": "
|
3211
|
+
"parameterName": "entity",
|
2937
3212
|
"parameterTypeTokenRange": {
|
2938
3213
|
"startIndex": 1,
|
2939
3214
|
"endIndex": 2
|
@@ -2941,7 +3216,7 @@
|
|
2941
3216
|
"isOptional": false
|
2942
3217
|
},
|
2943
3218
|
{
|
2944
|
-
"parameterName": "
|
3219
|
+
"parameterName": "input",
|
2945
3220
|
"parameterTypeTokenRange": {
|
2946
3221
|
"startIndex": 3,
|
2947
3222
|
"endIndex": 4
|
@@ -2949,12 +3224,20 @@
|
|
2949
3224
|
"isOptional": false
|
2950
3225
|
},
|
2951
3226
|
{
|
2952
|
-
"parameterName": "
|
3227
|
+
"parameterName": "cameraOrientation",
|
2953
3228
|
"parameterTypeTokenRange": {
|
2954
3229
|
"startIndex": 5,
|
2955
3230
|
"endIndex": 6
|
2956
3231
|
},
|
2957
3232
|
"isOptional": false
|
3233
|
+
},
|
3234
|
+
{
|
3235
|
+
"parameterName": "deltaTimeMs",
|
3236
|
+
"parameterTypeTokenRange": {
|
3237
|
+
"startIndex": 7,
|
3238
|
+
"endIndex": 8
|
3239
|
+
},
|
3240
|
+
"isOptional": false
|
2958
3241
|
}
|
2959
3242
|
],
|
2960
3243
|
"isOptional": false,
|
@@ -8676,11 +8959,44 @@
|
|
8676
8959
|
{
|
8677
8960
|
"kind": "Constructor",
|
8678
8961
|
"canonicalReference": "server!DefaultCharacterController:constructor(1)",
|
8679
|
-
"docComment": "/**\n * Constructs a new instance of the `DefaultCharacterController` class\n *\n * @param
|
8962
|
+
"docComment": "/**\n * Constructs a new instance of the `DefaultCharacterController` class\n *\n * @param options - Options for the controller.\n */\n",
|
8963
|
+
"excerptTokens": [
|
8964
|
+
{
|
8965
|
+
"kind": "Content",
|
8966
|
+
"text": "constructor(options?: "
|
8967
|
+
},
|
8968
|
+
{
|
8969
|
+
"kind": "Reference",
|
8970
|
+
"text": "DefaultCharacterControllerOptions",
|
8971
|
+
"canonicalReference": "server!DefaultCharacterControllerOptions:interface"
|
8972
|
+
},
|
8973
|
+
{
|
8974
|
+
"kind": "Content",
|
8975
|
+
"text": ");"
|
8976
|
+
}
|
8977
|
+
],
|
8978
|
+
"releaseTag": "Public",
|
8979
|
+
"isProtected": false,
|
8980
|
+
"overloadIndex": 1,
|
8981
|
+
"parameters": [
|
8982
|
+
{
|
8983
|
+
"parameterName": "options",
|
8984
|
+
"parameterTypeTokenRange": {
|
8985
|
+
"startIndex": 1,
|
8986
|
+
"endIndex": 2
|
8987
|
+
},
|
8988
|
+
"isOptional": true
|
8989
|
+
}
|
8990
|
+
]
|
8991
|
+
},
|
8992
|
+
{
|
8993
|
+
"kind": "Method",
|
8994
|
+
"canonicalReference": "server!DefaultCharacterController#attach:member(1)",
|
8995
|
+
"docComment": "/**\n * Called when the controller is attached to an entity.\n *\n * @param entity - The entity to attach the controller to.\n */\n",
|
8680
8996
|
"excerptTokens": [
|
8681
8997
|
{
|
8682
8998
|
"kind": "Content",
|
8683
|
-
"text": "
|
8999
|
+
"text": "attach(entity: "
|
8684
9000
|
},
|
8685
9001
|
{
|
8686
9002
|
"kind": "Reference",
|
@@ -8689,18 +9005,22 @@
|
|
8689
9005
|
},
|
8690
9006
|
{
|
8691
9007
|
"kind": "Content",
|
8692
|
-
"text": "
|
9008
|
+
"text": "): "
|
8693
9009
|
},
|
8694
9010
|
{
|
8695
|
-
"kind": "
|
8696
|
-
"text": "
|
8697
|
-
"canonicalReference": "server!DefaultCharacterControllerOptions:interface"
|
9011
|
+
"kind": "Content",
|
9012
|
+
"text": "void"
|
8698
9013
|
},
|
8699
9014
|
{
|
8700
9015
|
"kind": "Content",
|
8701
|
-
"text": "
|
9016
|
+
"text": ";"
|
8702
9017
|
}
|
8703
9018
|
],
|
9019
|
+
"isStatic": false,
|
9020
|
+
"returnTypeTokenRange": {
|
9021
|
+
"startIndex": 3,
|
9022
|
+
"endIndex": 4
|
9023
|
+
},
|
8704
9024
|
"releaseTag": "Public",
|
8705
9025
|
"isProtected": false,
|
8706
9026
|
"overloadIndex": 1,
|
@@ -8712,16 +9032,11 @@
|
|
8712
9032
|
"endIndex": 2
|
8713
9033
|
},
|
8714
9034
|
"isOptional": false
|
8715
|
-
},
|
8716
|
-
{
|
8717
|
-
"parameterName": "options",
|
8718
|
-
"parameterTypeTokenRange": {
|
8719
|
-
"startIndex": 3,
|
8720
|
-
"endIndex": 4
|
8721
|
-
},
|
8722
|
-
"isOptional": true
|
8723
9035
|
}
|
8724
|
-
]
|
9036
|
+
],
|
9037
|
+
"isOptional": false,
|
9038
|
+
"isAbstract": false,
|
9039
|
+
"name": "attach"
|
8725
9040
|
},
|
8726
9041
|
{
|
8727
9042
|
"kind": "Property",
|
@@ -8840,42 +9155,6 @@
|
|
8840
9155
|
"isProtected": false,
|
8841
9156
|
"isAbstract": false
|
8842
9157
|
},
|
8843
|
-
{
|
8844
|
-
"kind": "Method",
|
8845
|
-
"canonicalReference": "server!DefaultCharacterController#createColliders:member(1)",
|
8846
|
-
"docComment": "/**\n * Creates the colliders for the character controller, overriding the default implementation.\n *\n * @returns An array of colliders.\n */\n",
|
8847
|
-
"excerptTokens": [
|
8848
|
-
{
|
8849
|
-
"kind": "Content",
|
8850
|
-
"text": "createColliders(): "
|
8851
|
-
},
|
8852
|
-
{
|
8853
|
-
"kind": "Reference",
|
8854
|
-
"text": "Collider",
|
8855
|
-
"canonicalReference": "server!Collider:class"
|
8856
|
-
},
|
8857
|
-
{
|
8858
|
-
"kind": "Content",
|
8859
|
-
"text": "[]"
|
8860
|
-
},
|
8861
|
-
{
|
8862
|
-
"kind": "Content",
|
8863
|
-
"text": ";"
|
8864
|
-
}
|
8865
|
-
],
|
8866
|
-
"isStatic": false,
|
8867
|
-
"returnTypeTokenRange": {
|
8868
|
-
"startIndex": 1,
|
8869
|
-
"endIndex": 3
|
8870
|
-
},
|
8871
|
-
"releaseTag": "Public",
|
8872
|
-
"isProtected": false,
|
8873
|
-
"overloadIndex": 1,
|
8874
|
-
"parameters": [],
|
8875
|
-
"isOptional": false,
|
8876
|
-
"isAbstract": false,
|
8877
|
-
"name": "createColliders"
|
8878
|
-
},
|
8879
9158
|
{
|
8880
9159
|
"kind": "Property",
|
8881
9160
|
"canonicalReference": "server!DefaultCharacterController#isGrounded:member",
|
@@ -9031,14 +9310,72 @@
|
|
9031
9310
|
"isProtected": false,
|
9032
9311
|
"isAbstract": false
|
9033
9312
|
},
|
9313
|
+
{
|
9314
|
+
"kind": "Method",
|
9315
|
+
"canonicalReference": "server!DefaultCharacterController#spawn:member(1)",
|
9316
|
+
"docComment": "/**\n * Called when the controlled entity is spawned. In DefaultCharacterController, this function is used to create the colliders for the entity for wall and ground detection.\n *\n * @param entity - The entity that is spawned.\n */\n",
|
9317
|
+
"excerptTokens": [
|
9318
|
+
{
|
9319
|
+
"kind": "Content",
|
9320
|
+
"text": "spawn(entity: "
|
9321
|
+
},
|
9322
|
+
{
|
9323
|
+
"kind": "Reference",
|
9324
|
+
"text": "Entity",
|
9325
|
+
"canonicalReference": "server!Entity:class"
|
9326
|
+
},
|
9327
|
+
{
|
9328
|
+
"kind": "Content",
|
9329
|
+
"text": "): "
|
9330
|
+
},
|
9331
|
+
{
|
9332
|
+
"kind": "Content",
|
9333
|
+
"text": "void"
|
9334
|
+
},
|
9335
|
+
{
|
9336
|
+
"kind": "Content",
|
9337
|
+
"text": ";"
|
9338
|
+
}
|
9339
|
+
],
|
9340
|
+
"isStatic": false,
|
9341
|
+
"returnTypeTokenRange": {
|
9342
|
+
"startIndex": 3,
|
9343
|
+
"endIndex": 4
|
9344
|
+
},
|
9345
|
+
"releaseTag": "Public",
|
9346
|
+
"isProtected": false,
|
9347
|
+
"overloadIndex": 1,
|
9348
|
+
"parameters": [
|
9349
|
+
{
|
9350
|
+
"parameterName": "entity",
|
9351
|
+
"parameterTypeTokenRange": {
|
9352
|
+
"startIndex": 1,
|
9353
|
+
"endIndex": 2
|
9354
|
+
},
|
9355
|
+
"isOptional": false
|
9356
|
+
}
|
9357
|
+
],
|
9358
|
+
"isOptional": false,
|
9359
|
+
"isAbstract": false,
|
9360
|
+
"name": "spawn"
|
9361
|
+
},
|
9034
9362
|
{
|
9035
9363
|
"kind": "Method",
|
9036
9364
|
"canonicalReference": "server!DefaultCharacterController#tickWithPlayerInput:member(1)",
|
9037
|
-
"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",
|
9365
|
+
"docComment": "/**\n * Ticks the player movement for the character controller, overriding the default implementation.\n *\n * @param entity - The entity to tick.\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",
|
9038
9366
|
"excerptTokens": [
|
9039
9367
|
{
|
9040
9368
|
"kind": "Content",
|
9041
|
-
"text": "tickWithPlayerInput(
|
9369
|
+
"text": "tickWithPlayerInput(entity: "
|
9370
|
+
},
|
9371
|
+
{
|
9372
|
+
"kind": "Reference",
|
9373
|
+
"text": "PlayerEntity",
|
9374
|
+
"canonicalReference": "server!PlayerEntity:class"
|
9375
|
+
},
|
9376
|
+
{
|
9377
|
+
"kind": "Content",
|
9378
|
+
"text": ", input: "
|
9042
9379
|
},
|
9043
9380
|
{
|
9044
9381
|
"kind": "Reference",
|
@@ -9077,15 +9414,15 @@
|
|
9077
9414
|
],
|
9078
9415
|
"isStatic": false,
|
9079
9416
|
"returnTypeTokenRange": {
|
9080
|
-
"startIndex":
|
9081
|
-
"endIndex":
|
9417
|
+
"startIndex": 9,
|
9418
|
+
"endIndex": 10
|
9082
9419
|
},
|
9083
9420
|
"releaseTag": "Public",
|
9084
9421
|
"isProtected": false,
|
9085
9422
|
"overloadIndex": 1,
|
9086
9423
|
"parameters": [
|
9087
9424
|
{
|
9088
|
-
"parameterName": "
|
9425
|
+
"parameterName": "entity",
|
9089
9426
|
"parameterTypeTokenRange": {
|
9090
9427
|
"startIndex": 1,
|
9091
9428
|
"endIndex": 2
|
@@ -9093,7 +9430,7 @@
|
|
9093
9430
|
"isOptional": false
|
9094
9431
|
},
|
9095
9432
|
{
|
9096
|
-
"parameterName": "
|
9433
|
+
"parameterName": "input",
|
9097
9434
|
"parameterTypeTokenRange": {
|
9098
9435
|
"startIndex": 3,
|
9099
9436
|
"endIndex": 4
|
@@ -9101,12 +9438,20 @@
|
|
9101
9438
|
"isOptional": false
|
9102
9439
|
},
|
9103
9440
|
{
|
9104
|
-
"parameterName": "
|
9441
|
+
"parameterName": "cameraOrientation",
|
9105
9442
|
"parameterTypeTokenRange": {
|
9106
9443
|
"startIndex": 5,
|
9107
9444
|
"endIndex": 6
|
9108
9445
|
},
|
9109
9446
|
"isOptional": false
|
9447
|
+
},
|
9448
|
+
{
|
9449
|
+
"parameterName": "deltaTimeMs",
|
9450
|
+
"parameterTypeTokenRange": {
|
9451
|
+
"startIndex": 7,
|
9452
|
+
"endIndex": 8
|
9453
|
+
},
|
9454
|
+
"isOptional": false
|
9110
9455
|
}
|
9111
9456
|
],
|
9112
9457
|
"isOptional": false,
|
@@ -9497,50 +9842,6 @@
|
|
9497
9842
|
"isProtected": false,
|
9498
9843
|
"isAbstract": false
|
9499
9844
|
},
|
9500
|
-
{
|
9501
|
-
"kind": "Property",
|
9502
|
-
"canonicalReference": "server!Entity#createCustomCharacterController:member",
|
9503
|
-
"docComment": "/**\n * A function that creates a custom character controller for the entity when it spawns.\n *\n * @param entity - The Entity instance the character controller is created for.\n *\n * @returns A character controller that extends {@link BaseCharacterController}.\n */\n",
|
9504
|
-
"excerptTokens": [
|
9505
|
-
{
|
9506
|
-
"kind": "Content",
|
9507
|
-
"text": "createCustomCharacterController?: "
|
9508
|
-
},
|
9509
|
-
{
|
9510
|
-
"kind": "Content",
|
9511
|
-
"text": "(entity: "
|
9512
|
-
},
|
9513
|
-
{
|
9514
|
-
"kind": "Reference",
|
9515
|
-
"text": "Entity",
|
9516
|
-
"canonicalReference": "server!Entity:class"
|
9517
|
-
},
|
9518
|
-
{
|
9519
|
-
"kind": "Content",
|
9520
|
-
"text": ") => "
|
9521
|
-
},
|
9522
|
-
{
|
9523
|
-
"kind": "Reference",
|
9524
|
-
"text": "BaseCharacterController",
|
9525
|
-
"canonicalReference": "server!BaseCharacterController:class"
|
9526
|
-
},
|
9527
|
-
{
|
9528
|
-
"kind": "Content",
|
9529
|
-
"text": ";"
|
9530
|
-
}
|
9531
|
-
],
|
9532
|
-
"isReadonly": false,
|
9533
|
-
"isOptional": true,
|
9534
|
-
"releaseTag": "Public",
|
9535
|
-
"name": "createCustomCharacterController",
|
9536
|
-
"propertyTypeTokenRange": {
|
9537
|
-
"startIndex": 1,
|
9538
|
-
"endIndex": 5
|
9539
|
-
},
|
9540
|
-
"isStatic": false,
|
9541
|
-
"isProtected": false,
|
9542
|
-
"isAbstract": false
|
9543
|
-
},
|
9544
9845
|
{
|
9545
9846
|
"kind": "Method",
|
9546
9847
|
"canonicalReference": "server!Entity#despawn:member(1)",
|
@@ -10229,6 +10530,10 @@
|
|
10229
10530
|
"text": "BaseCharacterController",
|
10230
10531
|
"canonicalReference": "server!BaseCharacterController:class"
|
10231
10532
|
},
|
10533
|
+
{
|
10534
|
+
"kind": "Content",
|
10535
|
+
"text": " | undefined"
|
10536
|
+
},
|
10232
10537
|
{
|
10233
10538
|
"kind": "Content",
|
10234
10539
|
"text": "): "
|
@@ -10244,8 +10549,8 @@
|
|
10244
10549
|
],
|
10245
10550
|
"isStatic": false,
|
10246
10551
|
"returnTypeTokenRange": {
|
10247
|
-
"startIndex":
|
10248
|
-
"endIndex":
|
10552
|
+
"startIndex": 4,
|
10553
|
+
"endIndex": 5
|
10249
10554
|
},
|
10250
10555
|
"releaseTag": "Public",
|
10251
10556
|
"isProtected": false,
|
@@ -10255,7 +10560,7 @@
|
|
10255
10560
|
"parameterName": "characterController",
|
10256
10561
|
"parameterTypeTokenRange": {
|
10257
10562
|
"startIndex": 1,
|
10258
|
-
"endIndex":
|
10563
|
+
"endIndex": 3
|
10259
10564
|
},
|
10260
10565
|
"isOptional": false
|
10261
10566
|
}
|
@@ -11919,25 +12224,12 @@
|
|
11919
12224
|
},
|
11920
12225
|
{
|
11921
12226
|
"kind": "PropertySignature",
|
11922
|
-
"canonicalReference": "server!EntityOptions#
|
11923
|
-
"docComment": "/**\n *
|
12227
|
+
"canonicalReference": "server!EntityOptions#characterController:member",
|
12228
|
+
"docComment": "/**\n * The character controller to use for the entity.\n */\n",
|
11924
12229
|
"excerptTokens": [
|
11925
12230
|
{
|
11926
12231
|
"kind": "Content",
|
11927
|
-
"text": "
|
11928
|
-
},
|
11929
|
-
{
|
11930
|
-
"kind": "Content",
|
11931
|
-
"text": "(entity: "
|
11932
|
-
},
|
11933
|
-
{
|
11934
|
-
"kind": "Reference",
|
11935
|
-
"text": "Entity",
|
11936
|
-
"canonicalReference": "server!Entity:class"
|
11937
|
-
},
|
11938
|
-
{
|
11939
|
-
"kind": "Content",
|
11940
|
-
"text": ") => "
|
12232
|
+
"text": "characterController?: "
|
11941
12233
|
},
|
11942
12234
|
{
|
11943
12235
|
"kind": "Reference",
|
@@ -11952,10 +12244,10 @@
|
|
11952
12244
|
"isReadonly": false,
|
11953
12245
|
"isOptional": true,
|
11954
12246
|
"releaseTag": "Public",
|
11955
|
-
"name": "
|
12247
|
+
"name": "characterController",
|
11956
12248
|
"propertyTypeTokenRange": {
|
11957
12249
|
"startIndex": 1,
|
11958
|
-
"endIndex":
|
12250
|
+
"endIndex": 2
|
11959
12251
|
}
|
11960
12252
|
},
|
11961
12253
|
{
|