@rbxts/types 1.0.910 → 1.0.911
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/include/generated/None.d.ts +309 -118
- package/include/generated/PluginSecurity.d.ts +58 -2
- package/include/generated/enums.d.ts +120 -14
- package/package.json +1 -1
|
@@ -12,6 +12,7 @@ interface Services {
|
|
|
12
12
|
AnimationFromVideoCreatorService: AnimationFromVideoCreatorService;
|
|
13
13
|
AnimationFromVideoCreatorStudioService: AnimationFromVideoCreatorStudioService;
|
|
14
14
|
AnnotationsService: AnnotationsService;
|
|
15
|
+
AppAgeSignalsService: AppAgeSignalsService;
|
|
15
16
|
AppLifecycleObserverService: AppLifecycleObserverService;
|
|
16
17
|
AppRatingPromptService: AppRatingPromptService;
|
|
17
18
|
AppUpdateService: AppUpdateService;
|
|
@@ -82,6 +83,7 @@ interface Services {
|
|
|
82
83
|
GenerationService: GenerationService;
|
|
83
84
|
GenericChallengeService: GenericChallengeService;
|
|
84
85
|
GeometryService: GeometryService;
|
|
86
|
+
GongService: GongService;
|
|
85
87
|
GroupService: GroupService;
|
|
86
88
|
GuiService: GuiService;
|
|
87
89
|
HapticService: HapticService;
|
|
@@ -706,6 +708,7 @@ interface Instances extends Services, CreatableInstances {
|
|
|
706
708
|
SyncScriptBuilder: SyncScriptBuilder;
|
|
707
709
|
TeleportAsyncResult: TeleportAsyncResult;
|
|
708
710
|
Terrain: Terrain;
|
|
711
|
+
TestCase: TestCase;
|
|
709
712
|
TextChatConfigurations: TextChatConfigurations;
|
|
710
713
|
TextChatMessage: TextChatMessage;
|
|
711
714
|
TextFilterResult: TextFilterResult;
|
|
@@ -2939,6 +2942,12 @@ interface AdService extends Instance {
|
|
|
2939
2942
|
* @param devProductId The ID of the developer product you want to grant as a reward.
|
|
2940
2943
|
*/
|
|
2941
2944
|
CreateAdRewardFromDevProductId(this: AdService, devProductId: number): AdReward;
|
|
2945
|
+
/**
|
|
2946
|
+
* - **ThreadSafety**: Unsafe
|
|
2947
|
+
*
|
|
2948
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterDisclosureButton)
|
|
2949
|
+
*/
|
|
2950
|
+
RegisterDisclosureButton(this: AdService, disclosureButton: GuiButton, immersiveBrandedAdId: string): void;
|
|
2942
2951
|
/**
|
|
2943
2952
|
* **Deprecated:** `ShowVideoAd` has been decommissioned and is no longer operational.
|
|
2944
2953
|
*
|
|
@@ -2971,7 +2980,14 @@ interface AdService extends Instance {
|
|
|
2971
2980
|
* @param this A class that allows the display of mobile video ads.
|
|
2972
2981
|
* @param adFormat The format of the requested ad. For example, `RewardedVideo`.
|
|
2973
2982
|
*/
|
|
2974
|
-
GetAdAvailabilityNowAsync(this: AdService, adFormat: CastsToEnum<Enum.AdFormat>):
|
|
2983
|
+
GetAdAvailabilityNowAsync(this: AdService, adFormat: CastsToEnum<Enum.AdFormat>): object;
|
|
2984
|
+
/**
|
|
2985
|
+
* - **ThreadSafety**: Unsafe
|
|
2986
|
+
* - **Tags**: Yields
|
|
2987
|
+
*
|
|
2988
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#GetCampaignEligibilityAsync)
|
|
2989
|
+
*/
|
|
2990
|
+
GetCampaignEligibilityAsync(this: AdService, campaignId: string, player?: Player): object;
|
|
2975
2991
|
/**
|
|
2976
2992
|
* Tracks how many times a user had the chance to watch a video ad and the rate at which they actually watched the ad.
|
|
2977
2993
|
*
|
|
@@ -3028,7 +3044,7 @@ interface AnalyticsService extends Instance {
|
|
|
3028
3044
|
*/
|
|
3029
3045
|
readonly _nominal_AnalyticsService: unique symbol;
|
|
3030
3046
|
/**
|
|
3031
|
-
* **Deprecated:**
|
|
3047
|
+
* **Deprecated:** This deprecated function is a variant of `AnalyticsService:LogCustomEvent()` which should be used instead.
|
|
3032
3048
|
*
|
|
3033
3049
|
* Fires a custom event with a custom event name and data.
|
|
3034
3050
|
*
|
|
@@ -3045,15 +3061,10 @@ interface AnalyticsService extends Instance {
|
|
|
3045
3061
|
*/
|
|
3046
3062
|
FireCustomEvent(this: AnalyticsService, player: Player | undefined, eventCategory: string, customData?: unknown): void;
|
|
3047
3063
|
/**
|
|
3048
|
-
* **Deprecated:** This function has been deprecated in favor of more descriptive methods, including:
|
|
3049
|
-
* - `AnalyticsService:FireInGameEconomyEvent()`
|
|
3050
|
-
* - `AnalyticsService:FireLogEvent()`
|
|
3051
|
-
* - `AnalyticsService:FirePlayerProgressionEvent()`
|
|
3064
|
+
* **Deprecated:** This function has been deprecated in favor of more descriptive methods, including `AnalyticsService:LogCustomEvent()`, `AnalyticsService:LogEconomyEvent()`, and `AnalyticsService:LogProgressionEvent()`.
|
|
3052
3065
|
*
|
|
3053
3066
|
* Report a custom event to PlayFab.
|
|
3054
3067
|
*
|
|
3055
|
-
*
|
|
3056
|
-
*
|
|
3057
3068
|
* - **ThreadSafety**: Unsafe
|
|
3058
3069
|
* - **Tags**:
|
|
3059
3070
|
*
|
|
@@ -3066,7 +3077,7 @@ interface AnalyticsService extends Instance {
|
|
|
3066
3077
|
*/
|
|
3067
3078
|
FireEvent(this: AnalyticsService, category: string, value: unknown): void;
|
|
3068
3079
|
/**
|
|
3069
|
-
* **Deprecated:**
|
|
3080
|
+
* **Deprecated:** This deprecated function is a variant of `AnalyticsService:LogEconomyEvent()` which should be used instead.
|
|
3070
3081
|
*
|
|
3071
3082
|
* Fire an event used to track player actions pertaining to the in-game economy.
|
|
3072
3083
|
*
|
|
@@ -3106,9 +3117,6 @@ interface AnalyticsService extends Instance {
|
|
|
3106
3117
|
* @param logLevel The specified log level (e.g. Debug, Error).
|
|
3107
3118
|
* @param message User defined message.
|
|
3108
3119
|
* @param debugInfo Optional. A dictionary which contains predefined keys including "errorCode" and "stackTrace". Both keys values are strings. stackTrace is a traceback of the current function call stack.
|
|
3109
|
-
* ```lua
|
|
3110
|
-
* local debugInfo = { errorCode = '123', stackTrace = debug.traceback() }
|
|
3111
|
-
* ```
|
|
3112
3120
|
* @param customData Optional. User defined data, could be a string, a number or a table.
|
|
3113
3121
|
*
|
|
3114
3122
|
* @deprecated
|
|
@@ -3118,7 +3126,7 @@ interface AnalyticsService extends Instance {
|
|
|
3118
3126
|
stackTrace?: string;
|
|
3119
3127
|
}, customData?: unknown): void;
|
|
3120
3128
|
/**
|
|
3121
|
-
* **Deprecated:**
|
|
3129
|
+
* **Deprecated:** This deprecated function is a variant of `AnalyticsService:LogProgressionEvent()` which should be used instead.
|
|
3122
3130
|
*
|
|
3123
3131
|
* Fire an event used to track player progression through the game.
|
|
3124
3132
|
*
|
|
@@ -3131,13 +3139,7 @@ interface AnalyticsService extends Instance {
|
|
|
3131
3139
|
* @param category A user defined category for progression.
|
|
3132
3140
|
* @param progressionStatus Indicates the status of the progression.
|
|
3133
3141
|
* @param location The event location. A dictionary that each key-value represents an entry of location data. The key-value is a string-string pair. With this developers can query where is the most frequent location for a specific progression event category. For example, the category could be "LevelUp".
|
|
3134
|
-
* ```lua
|
|
3135
|
-
* local location = { ["placeDesc"] = "Dungeon1", ["levelDesc"] = "level2", ["mapDesc"] = "LeftChamberMap", ["ProgresionType"] = "LevelUp", ["userDefinedKey5"] = "0005" }
|
|
3136
|
-
* ```
|
|
3137
3142
|
* @param statistics Optional. A dictionary that each key-value represents an entry of statistics data that allows developers to track any specific data that they want to collect as players progress through their game. Key-Value is a string-number pair.
|
|
3138
|
-
* ```lua
|
|
3139
|
-
* local statistics = { ["numberOfKills"] = 111, ["numberOfExp"] = 222, ["userDefinedKey3"] = number, ["userDefinedKey4"] = number, ["userDefinedKey5"] = number }
|
|
3140
|
-
* ```
|
|
3141
3143
|
* @param customData Optional. User defined data, could be a string, a number or a table.
|
|
3142
3144
|
*
|
|
3143
3145
|
* @deprecated
|
|
@@ -4038,6 +4040,21 @@ interface AnnotationsService extends Instance {
|
|
|
4038
4040
|
*/
|
|
4039
4041
|
readonly _nominal_AnnotationsService: unique symbol;
|
|
4040
4042
|
}
|
|
4043
|
+
/**
|
|
4044
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
4045
|
+
*
|
|
4046
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AppAgeSignalsService)
|
|
4047
|
+
*/
|
|
4048
|
+
interface AppAgeSignalsService extends Instance {
|
|
4049
|
+
/**
|
|
4050
|
+
* **DO NOT USE!**
|
|
4051
|
+
*
|
|
4052
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
4053
|
+
* @hidden
|
|
4054
|
+
* @deprecated
|
|
4055
|
+
*/
|
|
4056
|
+
readonly _nominal_AppAgeSignalsService: unique symbol;
|
|
4057
|
+
}
|
|
4041
4058
|
/**
|
|
4042
4059
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
4043
4060
|
*
|
|
@@ -4914,6 +4931,8 @@ interface AudioAnalyzer extends Instance {
|
|
|
4914
4931
|
*/
|
|
4915
4932
|
SpectrumEnabled: boolean;
|
|
4916
4933
|
/**
|
|
4934
|
+
* Controls the resolution and timeliness of `GetSpectrum`.
|
|
4935
|
+
*
|
|
4917
4936
|
* - **ThreadSafety**: ReadSafe
|
|
4918
4937
|
*
|
|
4919
4938
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#WindowSize)
|
|
@@ -4958,6 +4977,7 @@ interface AudioAnalyzer extends Instance {
|
|
|
4958
4977
|
*
|
|
4959
4978
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetSpectrum)
|
|
4960
4979
|
* @param this Takes measurements from audio streams that are connected to it via one or more `Wires`.
|
|
4980
|
+
* @returns A table of numbers representing the amplitude levels of various frequencies of audio within the last buffer, or an empty table if a spectrum cannot be obtained.
|
|
4961
4981
|
*/
|
|
4962
4982
|
GetSpectrum(this: AudioAnalyzer): Array<number>;
|
|
4963
4983
|
/**
|
|
@@ -5573,6 +5593,8 @@ interface AudioEcho extends Instance {
|
|
|
5573
5593
|
*/
|
|
5574
5594
|
Feedback: number;
|
|
5575
5595
|
/**
|
|
5596
|
+
* The time taken to interpolate between `DelayTime` values.
|
|
5597
|
+
*
|
|
5576
5598
|
* - **ThreadSafety**: ReadSafe
|
|
5577
5599
|
*
|
|
5578
5600
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEcho#RampTime)
|
|
@@ -5641,6 +5663,8 @@ interface AudioEmitter extends Instance {
|
|
|
5641
5663
|
*/
|
|
5642
5664
|
readonly _nominal_AudioEmitter: unique symbol;
|
|
5643
5665
|
/**
|
|
5666
|
+
* Determines whether acoustic simulation should be used for this `AudioEmitter`.
|
|
5667
|
+
*
|
|
5644
5668
|
* - **ThreadSafety**: ReadSafe
|
|
5645
5669
|
*
|
|
5646
5670
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#AcousticSimulationEnabled)
|
|
@@ -6140,6 +6164,8 @@ interface AudioFocusService extends Instance {
|
|
|
6140
6164
|
readonly _nominal_AudioFocusService: unique symbol;
|
|
6141
6165
|
}
|
|
6142
6166
|
/**
|
|
6167
|
+
* Mutes audio streams that fall below a certain volume threshold.
|
|
6168
|
+
*
|
|
6143
6169
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate)
|
|
6144
6170
|
*/
|
|
6145
6171
|
interface AudioGate extends Instance {
|
|
@@ -6152,24 +6178,32 @@ interface AudioGate extends Instance {
|
|
|
6152
6178
|
*/
|
|
6153
6179
|
readonly _nominal_AudioGate: unique symbol;
|
|
6154
6180
|
/**
|
|
6181
|
+
* Controls how long it takes for the gate to open when the signal level rises above the `Threshold`.
|
|
6182
|
+
*
|
|
6155
6183
|
* - **ThreadSafety**: ReadSafe
|
|
6156
6184
|
*
|
|
6157
6185
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Attack)
|
|
6158
6186
|
*/
|
|
6159
6187
|
Attack: number;
|
|
6160
6188
|
/**
|
|
6189
|
+
* Whether audio streams are passed-through unaffected by this effect.
|
|
6190
|
+
*
|
|
6161
6191
|
* - **ThreadSafety**: ReadSafe
|
|
6162
6192
|
*
|
|
6163
6193
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Bypass)
|
|
6164
6194
|
*/
|
|
6165
6195
|
Bypass: boolean;
|
|
6166
6196
|
/**
|
|
6197
|
+
* Controls how long it takes for the gate to close when the signal level drops below the `Threshold`.
|
|
6198
|
+
*
|
|
6167
6199
|
* - **ThreadSafety**: ReadSafe
|
|
6168
6200
|
*
|
|
6169
6201
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Release)
|
|
6170
6202
|
*/
|
|
6171
6203
|
Release: number;
|
|
6172
6204
|
/**
|
|
6205
|
+
* The gain value(s) around which the gate opens and closes.
|
|
6206
|
+
*
|
|
6173
6207
|
* - **ThreadSafety**: ReadSafe
|
|
6174
6208
|
*
|
|
6175
6209
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Threshold)
|
|
@@ -6181,7 +6215,7 @@ interface AudioGate extends Instance {
|
|
|
6181
6215
|
* - **ThreadSafety**: Unsafe
|
|
6182
6216
|
*
|
|
6183
6217
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetConnectedWires)
|
|
6184
|
-
* @param this
|
|
6218
|
+
* @param this Mutes audio streams that fall below a certain volume threshold.
|
|
6185
6219
|
* @param pin An input or output pin on this instance
|
|
6186
6220
|
* @returns An array of `Wires`
|
|
6187
6221
|
*/
|
|
@@ -6192,7 +6226,7 @@ interface AudioGate extends Instance {
|
|
|
6192
6226
|
* - **ThreadSafety**: Unsafe
|
|
6193
6227
|
*
|
|
6194
6228
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetInputPins)
|
|
6195
|
-
* @param this
|
|
6229
|
+
* @param this Mutes audio streams that fall below a certain volume threshold.
|
|
6196
6230
|
* @returns An array of strings representing valid pin names.
|
|
6197
6231
|
*/
|
|
6198
6232
|
GetInputPins(this: AudioGate): Array<unknown>;
|
|
@@ -6202,12 +6236,12 @@ interface AudioGate extends Instance {
|
|
|
6202
6236
|
* - **ThreadSafety**: Unsafe
|
|
6203
6237
|
*
|
|
6204
6238
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetOutputPins)
|
|
6205
|
-
* @param this
|
|
6239
|
+
* @param this Mutes audio streams that fall below a certain volume threshold.
|
|
6206
6240
|
* @returns An array of strings representing valid pin names.
|
|
6207
6241
|
*/
|
|
6208
6242
|
GetOutputPins(this: AudioGate): Array<unknown>;
|
|
6209
6243
|
/**
|
|
6210
|
-
* Fires when another instance is connected to or disconnected from the `
|
|
6244
|
+
* Fires when another instance is connected to or disconnected from the `AudioGate` via a `Wire`.
|
|
6211
6245
|
*
|
|
6212
6246
|
* - **ThreadSafety**: Unsafe
|
|
6213
6247
|
*
|
|
@@ -6308,6 +6342,8 @@ interface AudioListener extends Instance {
|
|
|
6308
6342
|
*/
|
|
6309
6343
|
readonly _nominal_AudioListener: unique symbol;
|
|
6310
6344
|
/**
|
|
6345
|
+
* Determines whether acoustic simulation should be used for this `AudioListener`.
|
|
6346
|
+
*
|
|
6311
6347
|
* - **ThreadSafety**: ReadSafe
|
|
6312
6348
|
*
|
|
6313
6349
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#AcousticSimulationEnabled)
|
|
@@ -6467,6 +6503,8 @@ interface AudioPitchShifter extends Instance {
|
|
|
6467
6503
|
*/
|
|
6468
6504
|
Pitch: number;
|
|
6469
6505
|
/**
|
|
6506
|
+
* Controls how much audio will be buffered and shifted at once.
|
|
6507
|
+
*
|
|
6470
6508
|
* - **ThreadSafety**: ReadSafe
|
|
6471
6509
|
*
|
|
6472
6510
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#WindowSize)
|
|
@@ -6548,6 +6586,8 @@ interface AudioPlayer extends Instance {
|
|
|
6548
6586
|
*/
|
|
6549
6587
|
AssetId: string;
|
|
6550
6588
|
/**
|
|
6589
|
+
* The audio content to be loaded into the `AudioPlayer`.
|
|
6590
|
+
*
|
|
6551
6591
|
* - **ThreadSafety**: ReadSafe
|
|
6552
6592
|
* - **Tags**: Hidden
|
|
6553
6593
|
*
|
|
@@ -6694,13 +6734,16 @@ interface AudioPlayer extends Instance {
|
|
|
6694
6734
|
*/
|
|
6695
6735
|
Stop(this: AudioPlayer): void;
|
|
6696
6736
|
/**
|
|
6737
|
+
* Returns a sampling of the waveform data for the loaded `Asset`.
|
|
6738
|
+
*
|
|
6697
6739
|
* - **ThreadSafety**: Unsafe
|
|
6698
6740
|
* - **Tags**: Yields
|
|
6699
6741
|
*
|
|
6700
6742
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetWaveformAsync)
|
|
6701
6743
|
* @param this Used to play audio assets.
|
|
6702
|
-
* @param timeRange
|
|
6703
|
-
* @param samples
|
|
6744
|
+
* @param timeRange The start and end time (in seconds) of the segment to read.
|
|
6745
|
+
* @param samples The number of samples to return for the specified range.
|
|
6746
|
+
* @returns A table of `samples` numbers ranging between -1 and 1 representing the sampled waveform, or an empty table if a waveform could not be read.
|
|
6704
6747
|
*/
|
|
6705
6748
|
GetWaveformAsync(this: AudioPlayer, timeRange: NumberRange, samples: number): Array<unknown>;
|
|
6706
6749
|
/**
|
|
@@ -6745,12 +6788,16 @@ interface AudioRecorder extends Instance {
|
|
|
6745
6788
|
*/
|
|
6746
6789
|
readonly _nominal_AudioRecorder: unique symbol;
|
|
6747
6790
|
/**
|
|
6791
|
+
* Whether the `AudioRecorder` is currently recording.
|
|
6792
|
+
*
|
|
6748
6793
|
* - **ThreadSafety**: ReadSafe
|
|
6749
6794
|
*
|
|
6750
6795
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#IsRecording)
|
|
6751
6796
|
*/
|
|
6752
6797
|
get IsRecording(): boolean;
|
|
6753
6798
|
/**
|
|
6799
|
+
* The current length of the recording in seconds.
|
|
6800
|
+
*
|
|
6754
6801
|
* - **ThreadSafety**: ReadSafe
|
|
6755
6802
|
* - **Tags**: NotReplicated
|
|
6756
6803
|
*
|
|
@@ -6758,6 +6805,8 @@ interface AudioRecorder extends Instance {
|
|
|
6758
6805
|
*/
|
|
6759
6806
|
readonly TimeLength: number;
|
|
6760
6807
|
/**
|
|
6808
|
+
* Clears out the recording from the `AudioRecorder`.
|
|
6809
|
+
*
|
|
6761
6810
|
* - **ThreadSafety**: Unsafe
|
|
6762
6811
|
*
|
|
6763
6812
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#Clear)
|
|
@@ -6796,13 +6845,18 @@ interface AudioRecorder extends Instance {
|
|
|
6796
6845
|
*/
|
|
6797
6846
|
GetOutputPins(this: AudioRecorder): Array<unknown>;
|
|
6798
6847
|
/**
|
|
6848
|
+
* Returns a `Content` object representing the current audio recording.
|
|
6849
|
+
*
|
|
6799
6850
|
* - **ThreadSafety**: Unsafe
|
|
6800
6851
|
*
|
|
6801
6852
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetTemporaryContent)
|
|
6802
6853
|
* @param this Records audio streams in-experience.
|
|
6854
|
+
* @returns A temporary `Content` ID that can be used with `AudioPlayer`.
|
|
6803
6855
|
*/
|
|
6804
6856
|
GetTemporaryContent(this: AudioRecorder): Content;
|
|
6805
6857
|
/**
|
|
6858
|
+
* Stops recording audio.
|
|
6859
|
+
*
|
|
6806
6860
|
* - **ThreadSafety**: Unsafe
|
|
6807
6861
|
*
|
|
6808
6862
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#Stop)
|
|
@@ -6810,22 +6864,30 @@ interface AudioRecorder extends Instance {
|
|
|
6810
6864
|
*/
|
|
6811
6865
|
Stop(this: AudioRecorder): void;
|
|
6812
6866
|
/**
|
|
6867
|
+
* Returns whether the `AudioRecorder` can currently record.
|
|
6868
|
+
*
|
|
6813
6869
|
* - **ThreadSafety**: Unsafe
|
|
6814
6870
|
* - **Tags**: Yields
|
|
6815
6871
|
*
|
|
6816
6872
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#CanRecordAsync)
|
|
6817
6873
|
* @param this Records audio streams in-experience.
|
|
6874
|
+
* @returns `true` if recording is possible, `false` otherwise.
|
|
6818
6875
|
*/
|
|
6819
6876
|
CanRecordAsync(this: AudioRecorder): boolean;
|
|
6820
6877
|
/**
|
|
6878
|
+
* Returns any instances which cannot be recorded.
|
|
6879
|
+
*
|
|
6821
6880
|
* - **ThreadSafety**: Unsafe
|
|
6822
6881
|
* - **Tags**: Yields
|
|
6823
6882
|
*
|
|
6824
6883
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetUnrecordableInstancesAsync)
|
|
6825
6884
|
* @param this Records audio streams in-experience.
|
|
6885
|
+
* @returns A table of `Instances` that are not recordable.
|
|
6826
6886
|
*/
|
|
6827
6887
|
GetUnrecordableInstancesAsync(this: AudioRecorder): Array<Instance>;
|
|
6828
6888
|
/**
|
|
6889
|
+
* Starts recording audio.
|
|
6890
|
+
*
|
|
6829
6891
|
* - **ThreadSafety**: Unsafe
|
|
6830
6892
|
* - **Tags**: Yields
|
|
6831
6893
|
*
|
|
@@ -6834,7 +6896,7 @@ interface AudioRecorder extends Instance {
|
|
|
6834
6896
|
*/
|
|
6835
6897
|
RecordAsync(this: AudioRecorder): void;
|
|
6836
6898
|
/**
|
|
6837
|
-
* Fires when another instance is connected to or disconnected from the `
|
|
6899
|
+
* Fires when another instance is connected to or disconnected from the `AudioRecorder` via a `Wire`.
|
|
6838
6900
|
*
|
|
6839
6901
|
* - **ThreadSafety**: Unsafe
|
|
6840
6902
|
*
|
|
@@ -7033,6 +7095,8 @@ interface AudioSearchParams extends Instance {
|
|
|
7033
7095
|
*/
|
|
7034
7096
|
Artist: string;
|
|
7035
7097
|
/**
|
|
7098
|
+
* The subtype of the audio asset.
|
|
7099
|
+
*
|
|
7036
7100
|
* - **ThreadSafety**: ReadSafe
|
|
7037
7101
|
*
|
|
7038
7102
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#AudioSubType)
|
|
@@ -7294,13 +7358,16 @@ interface AudioTextToSpeech extends Instance {
|
|
|
7294
7358
|
*/
|
|
7295
7359
|
Unload(this: AudioTextToSpeech): void;
|
|
7296
7360
|
/**
|
|
7361
|
+
* Returns a sampling of the waveform data for the generated audio.
|
|
7362
|
+
*
|
|
7297
7363
|
* - **ThreadSafety**: Unsafe
|
|
7298
7364
|
* - **Tags**: Yields
|
|
7299
7365
|
*
|
|
7300
7366
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetWaveformAsync)
|
|
7301
7367
|
* @param this Plays text as speech audio.
|
|
7302
|
-
* @param timeRange
|
|
7303
|
-
* @param samples
|
|
7368
|
+
* @param timeRange The start and end time (in seconds) of the segment to read.
|
|
7369
|
+
* @param samples The number of samples to return for the specified range.
|
|
7370
|
+
* @returns A table of `samples` numbers ranging between -1 and 1 representing the sampled waveform,
|
|
7304
7371
|
*/
|
|
7305
7372
|
GetWaveformAsync(this: AudioTextToSpeech, timeRange: NumberRange, samples: number): Array<unknown>;
|
|
7306
7373
|
/**
|
|
@@ -7353,6 +7420,8 @@ interface AudioTremolo extends Instance {
|
|
|
7353
7420
|
*/
|
|
7354
7421
|
readonly _nominal_AudioTremolo: unique symbol;
|
|
7355
7422
|
/**
|
|
7423
|
+
* Whether audio streams are passed-through unaffected by this effect.
|
|
7424
|
+
*
|
|
7356
7425
|
* - **ThreadSafety**: ReadSafe
|
|
7357
7426
|
*
|
|
7358
7427
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Bypass)
|
|
@@ -7438,7 +7507,7 @@ interface AudioTremolo extends Instance {
|
|
|
7438
7507
|
*/
|
|
7439
7508
|
GetOutputPins(this: AudioTremolo): Array<unknown>;
|
|
7440
7509
|
/**
|
|
7441
|
-
* Fires when another instance is connected to or disconnected from the `
|
|
7510
|
+
* Fires when another instance is connected to or disconnected from the `AudioTremolo` via a `Wire`.
|
|
7442
7511
|
*
|
|
7443
7512
|
* - **ThreadSafety**: Unsafe
|
|
7444
7513
|
*
|
|
@@ -8023,7 +8092,7 @@ interface AvatarCreationService extends Instance {
|
|
|
8023
8092
|
/**
|
|
8024
8093
|
* A service to support developer Avatar Editors.
|
|
8025
8094
|
*
|
|
8026
|
-
* - **Tags**: NotCreatable, Service
|
|
8095
|
+
* - **Tags**: NotCreatable, Service
|
|
8027
8096
|
*
|
|
8028
8097
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService)
|
|
8029
8098
|
*/
|
|
@@ -16126,24 +16195,34 @@ interface DigitsRigDescription extends Instance {
|
|
|
16126
16195
|
* - **ThreadSafety**: Unsafe
|
|
16127
16196
|
*
|
|
16128
16197
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#GetFingerControl)
|
|
16198
|
+
* @param this
|
|
16199
|
+
* @param fingerIndex
|
|
16129
16200
|
*/
|
|
16130
16201
|
GetFingerControl(this: DigitsRigDescription, fingerIndex: number): Vector3;
|
|
16131
16202
|
/**
|
|
16132
16203
|
* - **ThreadSafety**: Unsafe
|
|
16133
16204
|
*
|
|
16134
16205
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#GetFingerTip)
|
|
16206
|
+
* @param this
|
|
16207
|
+
* @param fingerIndex
|
|
16135
16208
|
*/
|
|
16136
16209
|
GetFingerTip(this: DigitsRigDescription, fingerIndex: number): Vector3;
|
|
16137
16210
|
/**
|
|
16138
16211
|
* - **ThreadSafety**: Unsafe
|
|
16139
16212
|
*
|
|
16140
16213
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#SetFingerControl)
|
|
16214
|
+
* @param this
|
|
16215
|
+
* @param fingerIndex
|
|
16216
|
+
* @param control
|
|
16141
16217
|
*/
|
|
16142
16218
|
SetFingerControl(this: DigitsRigDescription, fingerIndex: number, control: Vector3): void;
|
|
16143
16219
|
/**
|
|
16144
16220
|
* - **ThreadSafety**: Unsafe
|
|
16145
16221
|
*
|
|
16146
16222
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#SetFingerTip)
|
|
16223
|
+
* @param this
|
|
16224
|
+
* @param fingerIndex
|
|
16225
|
+
* @param point
|
|
16147
16226
|
*/
|
|
16148
16227
|
SetFingerTip(this: DigitsRigDescription, fingerIndex: number, point: Vector3): void;
|
|
16149
16228
|
}
|
|
@@ -17684,97 +17763,113 @@ interface GeometryService extends Instance {
|
|
|
17684
17763
|
*/
|
|
17685
17764
|
CreateSolidPrimitive(this: GeometryService, type: CastsToEnum<Enum.SolidPrimitiveType>, options?: object): MeshPart;
|
|
17686
17765
|
/**
|
|
17687
|
-
*
|
|
17766
|
+
* Provides an array of positions which can easily be passed into `FragmentAsync` to perform simple types of destruction.
|
|
17688
17767
|
*
|
|
17689
17768
|
* - **ThreadSafety**: Unsafe
|
|
17690
17769
|
*
|
|
17691
17770
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeometryService#GenerateFragmentSites)
|
|
17692
17771
|
* @param this Service containing geometric operations.
|
|
17693
|
-
* @param part
|
|
17694
|
-
* @param options
|
|
17772
|
+
* @param part The `Part`, `PartOperation`, or `MeshPart` which you are planning to pass into `FragmentAsync()`. This is necessary to make the fragment site generation and the subsequent `FragmentAsync()` call efficient.
|
|
17773
|
+
* @param options Options table containing all the controls for the method: - `SiteSpacing` — The approximate distance between sites, which directly corresponds to the diameter of the resulting fragments. If not specified, a reasonable value will be chosen.
|
|
17774
|
+
* - `Origin` — If provided, this will be the center of the area to be fragmented. If not provided, the entire object will be fragmented.
|
|
17775
|
+
* - `Radius` — If provided, this will be the center of the area to be fragmented. Either `Origin` and `Radius` should both be provided, or neither.
|
|
17776
|
+
*
|
|
17777
|
+
*
|
|
17778
|
+
* @returns An array of `Vector3` which is typically passed into `FragmentAsync()`. The output depends on the options provided. If `Origin` and `Radius` are provided, then the output array will contain several `Vector3` elements which will all be located within the radius, but the last element of the array will be an inner array containing many `Vector3` sites which are outside the radius. If `Origin` and `Radius` are not provided, the output will simply be an array of `Vector3` positions within the extents of the input `part`.
|
|
17695
17779
|
*/
|
|
17696
17780
|
GenerateFragmentSites(this: GeometryService, part: BasePart, options?: object): Array<unknown>;
|
|
17697
17781
|
/**
|
|
17698
|
-
*
|
|
17782
|
+
* Breaks a `BasePart` into multiple `MeshPart` instances, according to the pattern of points passed in, by using voronoi decomposition.
|
|
17699
17783
|
*
|
|
17700
17784
|
* - **ThreadSafety**: Unsafe
|
|
17701
17785
|
* - **Tags**: Yields
|
|
17702
17786
|
*
|
|
17703
17787
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeometryService#FragmentAsync)
|
|
17704
17788
|
* @param this Service containing geometric operations.
|
|
17705
|
-
* @param part
|
|
17706
|
-
* @param sites
|
|
17707
|
-
* @param options
|
|
17789
|
+
* @param part A `Part`, `PartOperation`, or `MeshPart` to operate on.
|
|
17790
|
+
* @param sites Array of `Vector3` defining the site positions. Each site will become a separate part. You can also provide a jagged 2D array of `Vector3` by including inner arrays of `Vector3` as elements of the outer array. Each inner array will have all of its voronoi cells merged into a single part. `GeometryService:GenerateFragmentSites` can be used to easily create this input.
|
|
17791
|
+
* @param options Options table containing all the controls for the method: - `CollisionFidelity` — The value of `CollisionFidelity` in the resulting parts, with one caveat: If a 2D array of sites is provided, this collision fidelity will only be applied to parts which came from more than one site. The others will be given `Hull` precision.
|
|
17792
|
+
* - `RenderFidelity` — The value of `RenderFidelity` in the resulting parts.
|
|
17793
|
+
* - `FluidFidelity` — The value of `FluidFidelity` in the resulting parts.
|
|
17794
|
+
* - `SplitApart` — Boolean controlling whether a part should be split into multiple parts if it contains multiple connected components. Default is `true` (split).
|
|
17795
|
+
*
|
|
17796
|
+
*
|
|
17797
|
+
* @returns Array of `MeshPart` along with mapping info. Each array element is a Dictionary with two elements: `{ “Instance”: instance, “Index”: index }`. `Index` is the index in the outer array of sites; in other words, it tells you which group of sites this instance came from. Note that it is possible for multiple instances to have the same index, if SplitApart is `true`.
|
|
17708
17798
|
*/
|
|
17709
17799
|
FragmentAsync(this: GeometryService, part: BasePart, sites: Array<unknown>, options?: object): Array<unknown>;
|
|
17710
17800
|
/**
|
|
17711
|
-
* Creates one or more `PartOperations` from the intersecting geometry of
|
|
17801
|
+
* Creates one or more `PartOperations` or `MeshParts` from the intersecting geometry of multiple parts.
|
|
17712
17802
|
*
|
|
17713
17803
|
* - **ThreadSafety**: Unsafe
|
|
17714
17804
|
* - **Tags**: Yields
|
|
17715
17805
|
*
|
|
17716
17806
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeometryService#IntersectAsync)
|
|
17717
17807
|
* @param this Service containing geometric operations.
|
|
17718
|
-
* @param part Main `Part` or `
|
|
17719
|
-
* @param parts Array of parts to intersect with the main part.
|
|
17808
|
+
* @param part Main `Part`, `PartOperation`, or `MeshPart` to operate on.
|
|
17809
|
+
* @param parts Array of other parts to intersect with the main part.
|
|
17720
17810
|
* @param options Options table containing all the controls for the method: - `CollisionFidelity` — The value of `CollisionFidelity` in the resulting parts.
|
|
17721
|
-
* - `RenderFidelity` — The value of `RenderFidelity` in the resulting parts.
|
|
17722
|
-
* - `FluidFidelity` — The value of `FluidFidelity` in the
|
|
17811
|
+
* - `RenderFidelity` — The value of `RenderFidelity` or `RenderFidelity` in the resulting parts.
|
|
17812
|
+
* - `FluidFidelity` — The value of `FluidFidelity` in the resulting parts.
|
|
17723
17813
|
* - `SplitApart` — Boolean controlling whether the objects should all be kept together or properly split apart. Default is `true` (split).
|
|
17724
17814
|
*
|
|
17725
17815
|
*
|
|
17726
|
-
* @returns One or more `PartOperations`
|
|
17816
|
+
* @returns One or more `PartOperations` or `MeshParts`. If the input contained any `MeshParts`, then the results will always be `MeshParts`.
|
|
17727
17817
|
*/
|
|
17728
17818
|
IntersectAsync(this: GeometryService, part: Part | PartOperation, parts: ReadonlyArray<Part | PartOperation>, options?: GeometryServiceAsyncMethodConfig): Array<PartOperation>;
|
|
17729
17819
|
/**
|
|
17730
|
-
* Creates one or more `PartOperations` from one part minus the
|
|
17820
|
+
* Creates one or more `PartOperations` or `MeshParts` from one part minus the space occupied by other parts.
|
|
17731
17821
|
*
|
|
17732
17822
|
* - **ThreadSafety**: Unsafe
|
|
17733
17823
|
* - **Tags**: Yields
|
|
17734
17824
|
*
|
|
17735
17825
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeometryService#SubtractAsync)
|
|
17736
17826
|
* @param this Service containing geometric operations.
|
|
17737
|
-
* @param part Main `Part` or `
|
|
17827
|
+
* @param part Main `Part`, `PartOperation`, or `MeshPart` to operate on.
|
|
17738
17828
|
* @param parts Array of parts to subtract from the main part.
|
|
17739
17829
|
* @param options Options table containing all the controls for the method: - `CollisionFidelity` — The value of `CollisionFidelity` in the resulting parts.
|
|
17740
|
-
* - `RenderFidelity` — The value of `RenderFidelity` in the resulting parts.
|
|
17741
|
-
* - `FluidFidelity` — The value of `FluidFidelity` in the
|
|
17830
|
+
* - `RenderFidelity` — The value of `RenderFidelity` or `RenderFidelity` in the resulting parts.
|
|
17831
|
+
* - `FluidFidelity` — The value of `FluidFidelity` in the resulting parts.
|
|
17742
17832
|
* - `SplitApart` — Boolean controlling whether the objects should all be kept together or properly split apart. Default is `true` (split).
|
|
17743
17833
|
*
|
|
17744
17834
|
*
|
|
17745
|
-
* @returns One or more `PartOperations`
|
|
17835
|
+
* @returns One or more `PartOperations` or `MeshParts`. If the input contained any `MeshParts`, then the results will always be `MeshParts`.
|
|
17746
17836
|
*/
|
|
17747
17837
|
SubtractAsync(this: GeometryService, part: Part | PartOperation, parts: ReadonlyArray<Part | PartOperation>, options?: GeometryServiceAsyncMethodConfig): Array<PartOperation>;
|
|
17748
17838
|
/**
|
|
17749
|
-
*
|
|
17839
|
+
* Creates a `MeshPart` which has the shape of the input part stretched/dragged through the given set of `CFrame` positions.
|
|
17750
17840
|
*
|
|
17751
17841
|
* - **ThreadSafety**: Unsafe
|
|
17752
17842
|
* - **Tags**: Yields
|
|
17753
17843
|
*
|
|
17754
17844
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeometryService#SweepPartAsync)
|
|
17755
17845
|
* @param this Service containing geometric operations.
|
|
17756
|
-
* @param part
|
|
17757
|
-
* @param cframes
|
|
17758
|
-
* @param options
|
|
17846
|
+
* @param part A `Part`, `PartOperation`, or `MeshPart` to operate on.
|
|
17847
|
+
* @param cframes Array of coordinate frames to sweep parts through.
|
|
17848
|
+
* @param options Options table containing all the controls for the method: - `CollisionFidelity` — The value of `CollisionFidelity` in the resulting parts.
|
|
17849
|
+
* - `RenderFidelity` — The value of `RenderFidelity` in the resulting parts.
|
|
17850
|
+
* - `FluidFidelity` — The value of `FluidFidelity` in the resulting parts.
|
|
17851
|
+
*
|
|
17852
|
+
*
|
|
17853
|
+
* @returns A new `MeshPart` with the swept geometry.
|
|
17759
17854
|
*/
|
|
17760
17855
|
SweepPartAsync(this: GeometryService, part: BasePart, cframes: Array<unknown>, options?: object): MeshPart;
|
|
17761
17856
|
/**
|
|
17762
|
-
* Creates one or more `PartOperations` from one part plus the
|
|
17857
|
+
* Creates one or more `PartOperations` or `MeshParts` from one part plus the space occupied by other parts.
|
|
17763
17858
|
*
|
|
17764
17859
|
* - **ThreadSafety**: Unsafe
|
|
17765
17860
|
* - **Tags**: Yields
|
|
17766
17861
|
*
|
|
17767
17862
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeometryService#UnionAsync)
|
|
17768
17863
|
* @param this Service containing geometric operations.
|
|
17769
|
-
* @param part Main `Part` or `
|
|
17864
|
+
* @param part Main `Part`, `PartOperation`, or `MeshPart` to operate on.
|
|
17770
17865
|
* @param parts Array of parts to union with the main part.
|
|
17771
17866
|
* @param options Options table containing all the controls for the method: - `CollisionFidelity` — The value of `CollisionFidelity` in the resulting parts.
|
|
17772
|
-
* - `RenderFidelity` — The value of `RenderFidelity` in the resulting parts.
|
|
17773
|
-
* - `FluidFidelity` — The value of `FluidFidelity` in the
|
|
17867
|
+
* - `RenderFidelity` — The value of `RenderFidelity` or `RenderFidelity` in the resulting parts.
|
|
17868
|
+
* - `FluidFidelity` — The value of `FluidFidelity` in the resulting parts.
|
|
17774
17869
|
* - `SplitApart` — Boolean controlling whether the objects should all be kept together or properly split apart. Default is `true` (split).
|
|
17775
17870
|
*
|
|
17776
17871
|
*
|
|
17777
|
-
* @returns One or more `PartOperations`
|
|
17872
|
+
* @returns One or more `PartOperations` or `MeshParts`. If the input contained any `MeshParts`, then the results will always be `MeshParts`.
|
|
17778
17873
|
*/
|
|
17779
17874
|
UnionAsync(this: GeometryService, part: Part | PartOperation, parts: ReadonlyArray<Part | PartOperation>, options?: GeometryServiceAsyncMethodConfig): Array<PartOperation>;
|
|
17780
17875
|
}
|
|
@@ -18019,6 +18114,8 @@ interface DataStore extends GlobalDataStore {
|
|
|
18019
18114
|
* @param this
|
|
18020
18115
|
* @param key Key name for which a version is to be removed. If `DataStoreOptions.AllScopes` was set to true when accessing the data store through `DataStoreService:GetDataStore()`, this key name must be prepended with the original scope as in "scope/key".
|
|
18021
18116
|
* @param version Version number of the key to remove.
|
|
18117
|
+
*
|
|
18118
|
+
* @deprecated
|
|
18022
18119
|
*/
|
|
18023
18120
|
RemoveVersionAsync(this: DataStore, key: string, version: string): void;
|
|
18024
18121
|
GetAsync<T>(this: DataStore, key: string, options?: DataStoreGetOptions): LuaTuple<[
|
|
@@ -18080,6 +18177,21 @@ interface OrderedDataStore extends GlobalDataStore {
|
|
|
18080
18177
|
SetAsync(this: OrderedDataStore, key: string, value?: unknown): void;
|
|
18081
18178
|
UpdateAsync(this: OrderedDataStore, key: string, transformFunction: (oldValue: number | undefined) => number | undefined): number | undefined;
|
|
18082
18179
|
}
|
|
18180
|
+
/**
|
|
18181
|
+
* - **Tags**: NotCreatable, Service
|
|
18182
|
+
*
|
|
18183
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GongService)
|
|
18184
|
+
*/
|
|
18185
|
+
interface GongService extends Instance {
|
|
18186
|
+
/**
|
|
18187
|
+
* **DO NOT USE!**
|
|
18188
|
+
*
|
|
18189
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
18190
|
+
* @hidden
|
|
18191
|
+
* @deprecated
|
|
18192
|
+
*/
|
|
18193
|
+
readonly _nominal_GongService: unique symbol;
|
|
18194
|
+
}
|
|
18083
18195
|
/**
|
|
18084
18196
|
* GroupService is a service that allows developers to fetch information about a Roblox group from within a game.
|
|
18085
18197
|
*
|
|
@@ -23443,6 +23555,12 @@ interface Humanoid extends Instance {
|
|
|
23443
23555
|
* @deprecated
|
|
23444
23556
|
*/
|
|
23445
23557
|
GetPlayingAnimationTracks(this: Humanoid): Array<AnimationTrack>;
|
|
23558
|
+
/**
|
|
23559
|
+
* - **ThreadSafety**: Unsafe
|
|
23560
|
+
*
|
|
23561
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetRelativeVelocityAtFloor)
|
|
23562
|
+
*/
|
|
23563
|
+
GetRelativeVelocityAtFloor(this: Humanoid): Vector3;
|
|
23446
23564
|
/**
|
|
23447
23565
|
* Returns the humanoid's current `HumanoidStateType`.
|
|
23448
23566
|
*
|
|
@@ -24636,33 +24754,33 @@ interface HumanoidRigDescription extends Instance {
|
|
|
24636
24754
|
/**
|
|
24637
24755
|
* - **ThreadSafety**: ReadSafe
|
|
24638
24756
|
*
|
|
24639
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
24757
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToeBase)
|
|
24640
24758
|
*/
|
|
24641
|
-
|
|
24759
|
+
LeftToeBase: Instance | undefined;
|
|
24642
24760
|
/**
|
|
24643
24761
|
* - **ThreadSafety**: ReadSafe
|
|
24644
24762
|
*
|
|
24645
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
24763
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToeBaseRangeMax)
|
|
24646
24764
|
*/
|
|
24647
|
-
|
|
24765
|
+
LeftToeBaseRangeMax: Vector3;
|
|
24648
24766
|
/**
|
|
24649
24767
|
* - **ThreadSafety**: ReadSafe
|
|
24650
24768
|
*
|
|
24651
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
24769
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToeBaseRangeMin)
|
|
24652
24770
|
*/
|
|
24653
|
-
|
|
24771
|
+
LeftToeBaseRangeMin: Vector3;
|
|
24654
24772
|
/**
|
|
24655
24773
|
* - **ThreadSafety**: ReadSafe
|
|
24656
24774
|
*
|
|
24657
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
24775
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToeBaseSize)
|
|
24658
24776
|
*/
|
|
24659
|
-
|
|
24777
|
+
LeftToeBaseSize: number;
|
|
24660
24778
|
/**
|
|
24661
24779
|
* - **ThreadSafety**: ReadSafe
|
|
24662
24780
|
*
|
|
24663
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
24781
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToeBaseTposeAdjustment)
|
|
24664
24782
|
*/
|
|
24665
|
-
|
|
24783
|
+
LeftToeBaseTposeAdjustment: CFrame;
|
|
24666
24784
|
/**
|
|
24667
24785
|
* - **ThreadSafety**: ReadSafe
|
|
24668
24786
|
*
|
|
@@ -24723,36 +24841,6 @@ interface HumanoidRigDescription extends Instance {
|
|
|
24723
24841
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#NeckTposeAdjustment)
|
|
24724
24842
|
*/
|
|
24725
24843
|
NeckTposeAdjustment: CFrame;
|
|
24726
|
-
/**
|
|
24727
|
-
* - **ThreadSafety**: ReadSafe
|
|
24728
|
-
*
|
|
24729
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Pelvis)
|
|
24730
|
-
*/
|
|
24731
|
-
Pelvis: Instance | undefined;
|
|
24732
|
-
/**
|
|
24733
|
-
* - **ThreadSafety**: ReadSafe
|
|
24734
|
-
*
|
|
24735
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#PelvisRangeMax)
|
|
24736
|
-
*/
|
|
24737
|
-
PelvisRangeMax: Vector3;
|
|
24738
|
-
/**
|
|
24739
|
-
* - **ThreadSafety**: ReadSafe
|
|
24740
|
-
*
|
|
24741
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#PelvisRangeMin)
|
|
24742
|
-
*/
|
|
24743
|
-
PelvisRangeMin: Vector3;
|
|
24744
|
-
/**
|
|
24745
|
-
* - **ThreadSafety**: ReadSafe
|
|
24746
|
-
*
|
|
24747
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#PelvisSize)
|
|
24748
|
-
*/
|
|
24749
|
-
PelvisSize: number;
|
|
24750
|
-
/**
|
|
24751
|
-
* - **ThreadSafety**: ReadSafe
|
|
24752
|
-
*
|
|
24753
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#PelvisTposeAdjustment)
|
|
24754
|
-
*/
|
|
24755
|
-
PelvisTposeAdjustment: CFrame;
|
|
24756
24844
|
/**
|
|
24757
24845
|
* - **ThreadSafety**: ReadSafe
|
|
24758
24846
|
*
|
|
@@ -24936,33 +25024,33 @@ interface HumanoidRigDescription extends Instance {
|
|
|
24936
25024
|
/**
|
|
24937
25025
|
* - **ThreadSafety**: ReadSafe
|
|
24938
25026
|
*
|
|
24939
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
25027
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToeBase)
|
|
24940
25028
|
*/
|
|
24941
|
-
|
|
25029
|
+
RightToeBase: Instance | undefined;
|
|
24942
25030
|
/**
|
|
24943
25031
|
* - **ThreadSafety**: ReadSafe
|
|
24944
25032
|
*
|
|
24945
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
25033
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToeBaseRangeMax)
|
|
24946
25034
|
*/
|
|
24947
|
-
|
|
25035
|
+
RightToeBaseRangeMax: Vector3;
|
|
24948
25036
|
/**
|
|
24949
25037
|
* - **ThreadSafety**: ReadSafe
|
|
24950
25038
|
*
|
|
24951
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
25039
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToeBaseRangeMin)
|
|
24952
25040
|
*/
|
|
24953
|
-
|
|
25041
|
+
RightToeBaseRangeMin: Vector3;
|
|
24954
25042
|
/**
|
|
24955
25043
|
* - **ThreadSafety**: ReadSafe
|
|
24956
25044
|
*
|
|
24957
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
25045
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToeBaseSize)
|
|
24958
25046
|
*/
|
|
24959
|
-
|
|
25047
|
+
RightToeBaseSize: number;
|
|
24960
25048
|
/**
|
|
24961
25049
|
* - **ThreadSafety**: ReadSafe
|
|
24962
25050
|
*
|
|
24963
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
25051
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToeBaseTposeAdjustment)
|
|
24964
25052
|
*/
|
|
24965
|
-
|
|
25053
|
+
RightToeBaseTposeAdjustment: CFrame;
|
|
24966
25054
|
/**
|
|
24967
25055
|
* - **ThreadSafety**: ReadSafe
|
|
24968
25056
|
*
|
|
@@ -25023,6 +25111,36 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25023
25111
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RootTposeAdjustment)
|
|
25024
25112
|
*/
|
|
25025
25113
|
RootTposeAdjustment: CFrame;
|
|
25114
|
+
/**
|
|
25115
|
+
* - **ThreadSafety**: ReadSafe
|
|
25116
|
+
*
|
|
25117
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Spine)
|
|
25118
|
+
*/
|
|
25119
|
+
Spine: Instance | undefined;
|
|
25120
|
+
/**
|
|
25121
|
+
* - **ThreadSafety**: ReadSafe
|
|
25122
|
+
*
|
|
25123
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#SpineRangeMax)
|
|
25124
|
+
*/
|
|
25125
|
+
SpineRangeMax: Vector3;
|
|
25126
|
+
/**
|
|
25127
|
+
* - **ThreadSafety**: ReadSafe
|
|
25128
|
+
*
|
|
25129
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#SpineRangeMin)
|
|
25130
|
+
*/
|
|
25131
|
+
SpineRangeMin: Vector3;
|
|
25132
|
+
/**
|
|
25133
|
+
* - **ThreadSafety**: ReadSafe
|
|
25134
|
+
*
|
|
25135
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#SpineSize)
|
|
25136
|
+
*/
|
|
25137
|
+
SpineSize: number;
|
|
25138
|
+
/**
|
|
25139
|
+
* - **ThreadSafety**: ReadSafe
|
|
25140
|
+
*
|
|
25141
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#SpineTposeAdjustment)
|
|
25142
|
+
*/
|
|
25143
|
+
SpineTposeAdjustment: CFrame;
|
|
25026
25144
|
/**
|
|
25027
25145
|
* - **ThreadSafety**: ReadSafe
|
|
25028
25146
|
*
|
|
@@ -25870,7 +25988,7 @@ interface InsertService extends Instance {
|
|
|
25870
25988
|
*
|
|
25871
25989
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetFreeModels)
|
|
25872
25990
|
* @param this Used to insert assets from the Roblox website.
|
|
25873
|
-
* @param searchText String used to search for free
|
|
25991
|
+
* @param searchText String used to search for free models in the Catalog.
|
|
25874
25992
|
* @param pageNum The page number in the Catalog to return.
|
|
25875
25993
|
* @returns A single table (of returned free models) wrapped in a table.
|
|
25876
25994
|
*
|
|
@@ -28194,6 +28312,8 @@ interface MarketplaceService extends Instance {
|
|
|
28194
28312
|
* - **Tags**: Yields
|
|
28195
28313
|
*
|
|
28196
28314
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetRobloxSubscriptionDetailsAsync)
|
|
28315
|
+
* @param this The service responsible for in-experience transactions.
|
|
28316
|
+
* @param user
|
|
28197
28317
|
*/
|
|
28198
28318
|
GetRobloxSubscriptionDetailsAsync(this: MarketplaceService, user: Player): object;
|
|
28199
28319
|
/**
|
|
@@ -30543,7 +30663,12 @@ interface BasePart extends PVInstance {
|
|
|
30543
30663
|
*/
|
|
30544
30664
|
TorqueToAngularAcceleration(this: BasePart, torque: Vector3, angVelocity?: Vector3): Vector3;
|
|
30545
30665
|
/**
|
|
30546
|
-
*
|
|
30666
|
+
* Note: It is highly recommended to use the newer `GeometryService:IntersectAsync` instead of this function. As well as having better performance and more features, the new function differs as follows: - The output is an array of instances rather than a single instance.
|
|
30667
|
+
* - The input parts do not need to be parented to the scene, allowing for background operations.
|
|
30668
|
+
* - When the `SplitApart` option is set to `true` (default), each distinct body will be returned in its own `PartOperation`.
|
|
30669
|
+
* - All the returned parts are in the coordinate space of the main part, so their `PVInstance.Origin` positions are the same as the main part's. This keeps the vertices of the mesh in the same position relative to the object as before the operation, but it does also mean the `(0, 0, 0)` of a returned part is not necessarily at the center of its body.
|
|
30670
|
+
*
|
|
30671
|
+
* Creates a new `IntersectOperation` from the overlapping geometry of the part and the other parts in the given array.
|
|
30547
30672
|
*
|
|
30548
30673
|
* - **ThreadSafety**: Unsafe
|
|
30549
30674
|
* - **Tags**: Yields
|
|
@@ -30557,7 +30682,12 @@ interface BasePart extends PVInstance {
|
|
|
30557
30682
|
*/
|
|
30558
30683
|
IntersectAsync(this: BasePart, parts: Array<Instance>, collisionfidelity?: CastsToEnum<Enum.CollisionFidelity>, renderFidelity?: CastsToEnum<Enum.RenderFidelity>): Instance | undefined;
|
|
30559
30684
|
/**
|
|
30560
|
-
*
|
|
30685
|
+
* Note: It is highly recommended to use the newer `GeometryService:UnionAsync` instead of this function. As well as having better performance and more features, the new function differs as follows: - The output is an array of instances rather than a single instance.
|
|
30686
|
+
* - The input parts do not need to be parented to the scene, allowing for background operations.
|
|
30687
|
+
* - When the `SplitApart` option is set to `true` (default), each distinct body will be returned in its own `PartOperation`.
|
|
30688
|
+
* - All the returned parts are in the coordinate space of the main part, so their `PVInstance.Origin` positions are the same as the main part's. This keeps the vertices of the mesh in the same position relative to the object as before the operation, but it does also mean the `(0, 0, 0)` of a returned part is not necessarily at the center of its body.
|
|
30689
|
+
*
|
|
30690
|
+
* Creates a new `UnionOperation` from the part, minus the geometry occupied by the parts in the given array.
|
|
30561
30691
|
*
|
|
30562
30692
|
* - **ThreadSafety**: Unsafe
|
|
30563
30693
|
* - **Tags**: Yields
|
|
@@ -30571,7 +30701,7 @@ interface BasePart extends PVInstance {
|
|
|
30571
30701
|
*/
|
|
30572
30702
|
SubtractAsync(this: BasePart, parts: Array<BasePart>, collisionfidelity?: CastsToEnum<Enum.CollisionFidelity>): UnionOperation | undefined;
|
|
30573
30703
|
/**
|
|
30574
|
-
* Creates a new `UnionOperation` from the part, plus the geometry occupied by the parts in the given array.
|
|
30704
|
+
* Note: It is highly recommended to use the newer <code>GeometryService:UnionAsync</code> instead of this function. As well as having better performance and more features, the new function differs as follows: <ul> <li>The output is an array of instances rather than a single instance.</li> <li>The input parts do not need to be parented to the scene, allowing for background operations.</li> <li>When the <code>SplitApart</code> option is set to <code>true</code> (default), each distinct body will be returned in its own <code>PartOperation</code>.</li> <li>All the returned parts are in the coordinate space of the main part, so their <code>PVInstance.Origin</code> positions are the same as the main part's. This keeps the vertices of the mesh in the same position relative to the object as before the operation, but it does also mean the <code>(0, 0, 0)</code> of a returned part is not necessarily at the center of its body.<pre><code>Creates a new `UnionOperation` from the part, plus the geometry </code></pre> </li> </ul> occupied by the parts in the given array.
|
|
30575
30705
|
*
|
|
30576
30706
|
* - **ThreadSafety**: Unsafe
|
|
30577
30707
|
* - **Tags**: Yields
|
|
@@ -33684,6 +33814,8 @@ interface ParticleEmitter extends Instance {
|
|
|
33684
33814
|
*/
|
|
33685
33815
|
Enabled: boolean;
|
|
33686
33816
|
/**
|
|
33817
|
+
* Determines whether the flipbook frames are blended between.
|
|
33818
|
+
*
|
|
33687
33819
|
* - **ThreadSafety**: ReadSafe
|
|
33688
33820
|
*
|
|
33689
33821
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#FlipbookBlendFrames)
|
|
@@ -34840,6 +34972,12 @@ interface Player extends Instance {
|
|
|
34840
34972
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GameplayPaused)
|
|
34841
34973
|
*/
|
|
34842
34974
|
get GameplayPaused(): boolean;
|
|
34975
|
+
/**
|
|
34976
|
+
* - **ThreadSafety**: ReadSafe
|
|
34977
|
+
*
|
|
34978
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#HasRobloxSubscription)
|
|
34979
|
+
*/
|
|
34980
|
+
get HasRobloxSubscription(): boolean;
|
|
34843
34981
|
/**
|
|
34844
34982
|
* Indicates if a player has a **Verified** badge.
|
|
34845
34983
|
*
|
|
@@ -38791,7 +38929,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
38791
38929
|
*
|
|
38792
38930
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#RunService)
|
|
38793
38931
|
*/
|
|
38794
|
-
readonly RunService:
|
|
38932
|
+
readonly RunService: RunService | undefined;
|
|
38795
38933
|
/**
|
|
38796
38934
|
* **Deprecated:** This property has been deprecated. Use `DataModel.PrivateServerId` instead.
|
|
38797
38935
|
*
|
|
@@ -41789,24 +41927,32 @@ interface StyleQuery extends Instance {
|
|
|
41789
41927
|
* - **ThreadSafety**: Unsafe
|
|
41790
41928
|
*
|
|
41791
41929
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#GetCondition)
|
|
41930
|
+
* @param this
|
|
41931
|
+
* @param name
|
|
41792
41932
|
*/
|
|
41793
41933
|
GetCondition(this: StyleQuery, name: string): unknown;
|
|
41794
41934
|
/**
|
|
41795
41935
|
* - **ThreadSafety**: Unsafe
|
|
41796
41936
|
*
|
|
41797
41937
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#GetConditions)
|
|
41938
|
+
* @param this
|
|
41798
41939
|
*/
|
|
41799
41940
|
GetConditions(this: StyleQuery): object;
|
|
41800
41941
|
/**
|
|
41801
41942
|
* - **ThreadSafety**: Unsafe
|
|
41802
41943
|
*
|
|
41803
41944
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#SetCondition)
|
|
41945
|
+
* @param this
|
|
41946
|
+
* @param name
|
|
41947
|
+
* @param value
|
|
41804
41948
|
*/
|
|
41805
41949
|
SetCondition(this: StyleQuery, name: string, value: unknown): void;
|
|
41806
41950
|
/**
|
|
41807
41951
|
* - **ThreadSafety**: Unsafe
|
|
41808
41952
|
*
|
|
41809
41953
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#SetConditions)
|
|
41954
|
+
* @param this
|
|
41955
|
+
* @param conditions
|
|
41810
41956
|
*/
|
|
41811
41957
|
SetConditions(this: StyleQuery, conditions: object): void;
|
|
41812
41958
|
}
|
|
@@ -42565,6 +42711,45 @@ interface TerrainRegion extends Instance {
|
|
|
42565
42711
|
*/
|
|
42566
42712
|
readonly SizeInCells: Vector3;
|
|
42567
42713
|
}
|
|
42714
|
+
/**
|
|
42715
|
+
* - **Tags**: NotCreatable
|
|
42716
|
+
*
|
|
42717
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase)
|
|
42718
|
+
*/
|
|
42719
|
+
interface TestCase extends Instance {
|
|
42720
|
+
/**
|
|
42721
|
+
* **DO NOT USE!**
|
|
42722
|
+
*
|
|
42723
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
42724
|
+
* @hidden
|
|
42725
|
+
* @deprecated
|
|
42726
|
+
*/
|
|
42727
|
+
readonly _nominal_TestCase: unique symbol;
|
|
42728
|
+
/**
|
|
42729
|
+
* - **ThreadSafety**: Unsafe
|
|
42730
|
+
*
|
|
42731
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#Assert)
|
|
42732
|
+
*/
|
|
42733
|
+
Assert(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
42734
|
+
/**
|
|
42735
|
+
* - **ThreadSafety**: Unsafe
|
|
42736
|
+
*
|
|
42737
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#EndTest)
|
|
42738
|
+
*/
|
|
42739
|
+
EndTest(this: TestCase, message?: string, source?: Instance, line?: number): void;
|
|
42740
|
+
/**
|
|
42741
|
+
* - **ThreadSafety**: Unsafe
|
|
42742
|
+
*
|
|
42743
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#Message)
|
|
42744
|
+
*/
|
|
42745
|
+
Message(this: TestCase, text: string, source?: Instance, line?: number): void;
|
|
42746
|
+
/**
|
|
42747
|
+
* - **ThreadSafety**: Unsafe
|
|
42748
|
+
*
|
|
42749
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#Require)
|
|
42750
|
+
*/
|
|
42751
|
+
Require(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
42752
|
+
}
|
|
42568
42753
|
/**
|
|
42569
42754
|
* A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
42570
42755
|
*
|
|
@@ -42763,6 +42948,12 @@ interface TestService extends Instance {
|
|
|
42763
42948
|
* @param line
|
|
42764
42949
|
*/
|
|
42765
42950
|
Message(this: TestService, text: string, source?: Instance, line?: number): void;
|
|
42951
|
+
/**
|
|
42952
|
+
* - **ThreadSafety**: Unsafe
|
|
42953
|
+
*
|
|
42954
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RegisterTest)
|
|
42955
|
+
*/
|
|
42956
|
+
RegisterTest(this: TestService, testOptions: object): TestCase;
|
|
42766
42957
|
/**
|
|
42767
42958
|
* Prints whether a condition is true along with a description string.
|
|
42768
42959
|
*
|
|
@@ -43924,15 +44115,15 @@ interface TextChatService extends Instance {
|
|
|
43924
44115
|
*/
|
|
43925
44116
|
CanUserChatAsync(this: TextChatService, userId: number): boolean;
|
|
43926
44117
|
/**
|
|
43927
|
-
* Determines whether or not two users
|
|
44118
|
+
* Determines whether or not two users can receive messages from each other.
|
|
43928
44119
|
*
|
|
43929
44120
|
* - **ThreadSafety**: Unsafe
|
|
43930
44121
|
* - **Tags**: Yields
|
|
43931
44122
|
*
|
|
43932
44123
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChatService#CanUsersChatAsync)
|
|
43933
44124
|
* @param this A service handling in-experience text chat.
|
|
43934
|
-
* @param userIdFrom
|
|
43935
|
-
* @param userIdTo
|
|
44125
|
+
* @param userIdFrom
|
|
44126
|
+
* @param userIdTo
|
|
43936
44127
|
*/
|
|
43937
44128
|
CanUsersChatAsync(this: TextChatService, userIdFrom: number, userIdTo: number): boolean;
|
|
43938
44129
|
/**
|
|
@@ -43943,9 +44134,9 @@ interface TextChatService extends Instance {
|
|
|
43943
44134
|
*
|
|
43944
44135
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChatService#CanUsersDirectChatAsync)
|
|
43945
44136
|
* @param this A service handling in-experience text chat.
|
|
43946
|
-
* @param requesterUserId The user who would have initiated the direct chat request. If the
|
|
43947
|
-
* @param userIds A list of users who the requesterUserId would like to chat with directly. Users not in the current server are ignored.
|
|
43948
|
-
* @returns A list of users who could participate in the direct chat request. If none of the users can direct chat with the requesterUserId
|
|
44137
|
+
* @param requesterUserId The user who would have initiated the direct chat request. If the user is not in the current server, this method will error.
|
|
44138
|
+
* @param userIds A list of users who the `requesterUserId` would like to chat with directly. Users not in the current server are ignored.
|
|
44139
|
+
* @returns A list of users who could participate in the direct chat request. If none of the users can direct chat with the `requesterUserId`, the result is an empty array.
|
|
43949
44140
|
*/
|
|
43950
44141
|
CanUsersDirectChatAsync(this: TextChatService, requesterUserId: number, userIds: Array<unknown>): Array<unknown>;
|
|
43951
44142
|
/**
|