@rbxts/types 1.0.938 → 1.0.940
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 +304 -53
- package/include/generated/PluginSecurity.d.ts +126 -9
- package/include/generated/enums.d.ts +587 -29
- package/package.json +1 -1
|
@@ -67,6 +67,7 @@ interface Services {
|
|
|
67
67
|
DeviceIdService: DeviceIdService;
|
|
68
68
|
DraggerService: DraggerService;
|
|
69
69
|
EditableService: EditableService;
|
|
70
|
+
EditorSourceService: EditorSourceService;
|
|
70
71
|
EncodingService: EncodingService;
|
|
71
72
|
EventIngestService: EventIngestService;
|
|
72
73
|
ExampleV2Service: ExampleV2Service;
|
|
@@ -120,6 +121,7 @@ interface Services {
|
|
|
120
121
|
LodDataService: LodDataService;
|
|
121
122
|
LogReporterService: LogReporterService;
|
|
122
123
|
LogService: LogService;
|
|
124
|
+
LuauExpressionService: LuauExpressionService;
|
|
123
125
|
LuauScriptAnalyzerService: LuauScriptAnalyzerService;
|
|
124
126
|
MarketplaceService: MarketplaceService;
|
|
125
127
|
MatchmakingService: MatchmakingService;
|
|
@@ -142,6 +144,7 @@ interface Services {
|
|
|
142
144
|
PathfindingService: PathfindingService;
|
|
143
145
|
PerformanceControlService: PerformanceControlService;
|
|
144
146
|
PhysicsService: PhysicsService;
|
|
147
|
+
PinShortcutService: PinShortcutService;
|
|
145
148
|
PlaceAssetIdsService: PlaceAssetIdsService;
|
|
146
149
|
PlacesService: PlacesService;
|
|
147
150
|
PlaceStatsService: PlaceStatsService;
|
|
@@ -169,6 +172,7 @@ interface Services {
|
|
|
169
172
|
RemoteDebuggerServer: RemoteDebuggerServer;
|
|
170
173
|
ReplicatedFirst: ReplicatedFirst;
|
|
171
174
|
ReplicatedStorage: ReplicatedStorage;
|
|
175
|
+
RequestOrchestratorService: RequestOrchestratorService;
|
|
172
176
|
RibbonNotificationService: RibbonNotificationService;
|
|
173
177
|
RobloxServerStorage: RobloxServerStorage;
|
|
174
178
|
RolloutValidationService: RolloutValidationService;
|
|
@@ -260,6 +264,7 @@ interface Services {
|
|
|
260
264
|
VRStatusService: VRStatusService;
|
|
261
265
|
WebSocketService: WebSocketService;
|
|
262
266
|
WebViewService: WebViewService;
|
|
267
|
+
WindowProtocolService: WindowProtocolService;
|
|
263
268
|
Workspace: Workspace;
|
|
264
269
|
WrapDeformMeshProvider: WrapDeformMeshProvider;
|
|
265
270
|
}
|
|
@@ -452,6 +457,7 @@ interface CreatableInstances {
|
|
|
452
457
|
ParticleEmitter: ParticleEmitter;
|
|
453
458
|
PartOperation: PartOperation;
|
|
454
459
|
Path2D: Path2D;
|
|
460
|
+
Path3D: Path3D;
|
|
455
461
|
PathfindingLink: PathfindingLink;
|
|
456
462
|
PathfindingModifier: PathfindingModifier;
|
|
457
463
|
PitchShiftSoundEffect: PitchShiftSoundEffect;
|
|
@@ -763,6 +769,7 @@ interface Objects extends Instances {
|
|
|
763
769
|
EditableImage: EditableImage;
|
|
764
770
|
EditableMesh: EditableMesh;
|
|
765
771
|
ExecutedRemoteCommand: ExecutedRemoteCommand;
|
|
772
|
+
LuauExpression: LuauExpression;
|
|
766
773
|
MLSession: MLSession;
|
|
767
774
|
Object: RBXObject;
|
|
768
775
|
OutputLink: OutputLink;
|
|
@@ -1518,7 +1525,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1518
1525
|
*/
|
|
1519
1526
|
GetFaces(this: EditableMesh): Array<unknown>;
|
|
1520
1527
|
/**
|
|
1521
|
-
* **Deprecated:**
|
|
1528
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
1522
1529
|
*
|
|
1523
1530
|
* Returns a list of faces that use a given attribute ID.
|
|
1524
1531
|
*
|
|
@@ -1791,7 +1798,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1791
1798
|
*/
|
|
1792
1799
|
GetVertices(this: EditableMesh): Array<number>;
|
|
1793
1800
|
/**
|
|
1794
|
-
* **Deprecated:**
|
|
1801
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
1795
1802
|
*
|
|
1796
1803
|
* Returns a list of vertices that use a given attribute ID.
|
|
1797
1804
|
*
|
|
@@ -3094,7 +3101,7 @@ interface AnalyticsService extends Instance {
|
|
|
3094
3101
|
/**
|
|
3095
3102
|
* **Deprecated:** This deprecated function is a variant of `AnalyticsService:LogEconomyEvent()` which should be used instead.
|
|
3096
3103
|
*
|
|
3097
|
-
* Fire an event used to track player actions pertaining to the in-game
|
|
3104
|
+
* Fire an event used to track player actions pertaining to the in-game
|
|
3098
3105
|
*
|
|
3099
3106
|
* - **ThreadSafety**: Unsafe
|
|
3100
3107
|
* - **Tags**:
|
|
@@ -3119,7 +3126,7 @@ interface AnalyticsService extends Instance {
|
|
|
3119
3126
|
[index: string]: string;
|
|
3120
3127
|
}, customData?: unknown): void;
|
|
3121
3128
|
/**
|
|
3122
|
-
* **Deprecated:**
|
|
3129
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
3123
3130
|
*
|
|
3124
3131
|
* Fire a log event used to track errors and warnings experienced by players.
|
|
3125
3132
|
*
|
|
@@ -3215,6 +3222,12 @@ interface AnalyticsService extends Instance {
|
|
|
3215
3222
|
* @param customFields Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by `AnalyticsCustomFieldKeys`, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience.
|
|
3216
3223
|
*/
|
|
3217
3224
|
LogFunnelStepEvent(this: AnalyticsService, player: Player, funnelName: string, funnelSessionId?: string, step?: number, stepName?: string, customFields?: object): void;
|
|
3225
|
+
/**
|
|
3226
|
+
* - **ThreadSafety**: Unsafe
|
|
3227
|
+
*
|
|
3228
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#LogJourneyEvent)
|
|
3229
|
+
*/
|
|
3230
|
+
LogJourneyEvent(this: AnalyticsService, player: Player, journeyName: string, nodeName: string, journeySessionId?: string, customFields?: object): void;
|
|
3218
3231
|
/**
|
|
3219
3232
|
* Logs an event used to track user actions stepping through an onboarding funnel.
|
|
3220
3233
|
*
|
|
@@ -3839,33 +3852,36 @@ interface AnimationTrack extends Instance {
|
|
|
3839
3852
|
*/
|
|
3840
3853
|
GetMarkerReachedSignal(this: AnimationTrack, name: string): RBXScriptSignal<(param?: string) => void>;
|
|
3841
3854
|
/**
|
|
3855
|
+
* Returns the value of a parameter on the animation graph by key. Returns nil if the parameter has not been set.
|
|
3856
|
+
*
|
|
3842
3857
|
* - **ThreadSafety**: Unsafe
|
|
3843
3858
|
*
|
|
3844
3859
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetParameter)
|
|
3845
3860
|
* @param this Controls the playback of an animation on an `Animator`.
|
|
3846
|
-
* @param key
|
|
3861
|
+
* @param key The name of the parameter to retrieve.
|
|
3862
|
+
* @returns The current value of the parameter, or nil if not set.
|
|
3847
3863
|
*/
|
|
3848
3864
|
GetParameter(this: AnimationTrack, key: string): unknown;
|
|
3849
3865
|
/**
|
|
3866
|
+
* Returns a dictionary of parameter values initially set as instance attributes on the `AnimationGraphDefinition` instance used to build the animation graph inside this track.
|
|
3867
|
+
*
|
|
3850
3868
|
* - **ThreadSafety**: Unsafe
|
|
3851
3869
|
*
|
|
3852
3870
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetParameterDefaults)
|
|
3853
3871
|
* @param this Controls the playback of an animation on an `Animator`.
|
|
3872
|
+
* @returns A dictionary mapping parameter names to their default values. Returns an empty dictionary if the animation is not an animation graph.
|
|
3854
3873
|
*/
|
|
3855
3874
|
GetParameterDefaults(this: AnimationTrack): object;
|
|
3856
3875
|
/**
|
|
3857
3876
|
* - **ThreadSafety**: Unsafe
|
|
3858
3877
|
*
|
|
3859
3878
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetInstance)
|
|
3860
|
-
* @param this Controls the playback of an animation on an `Animator`.
|
|
3861
|
-
* @param name
|
|
3862
3879
|
*/
|
|
3863
3880
|
GetTargetInstance(this: AnimationTrack, name: string): Instance | undefined;
|
|
3864
3881
|
/**
|
|
3865
3882
|
* - **ThreadSafety**: Unsafe
|
|
3866
3883
|
*
|
|
3867
3884
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetNames)
|
|
3868
|
-
* @param this Controls the playback of an animation on an `Animator`.
|
|
3869
3885
|
*/
|
|
3870
3886
|
GetTargetNames(this: AnimationTrack): Array<unknown>;
|
|
3871
3887
|
/**
|
|
@@ -3893,21 +3909,20 @@ interface AnimationTrack extends Instance {
|
|
|
3893
3909
|
*/
|
|
3894
3910
|
Play(this: AnimationTrack, fadeTime?: number, weight?: number, speed?: number): void;
|
|
3895
3911
|
/**
|
|
3912
|
+
* Sets a parameter value on the animation graph, driving animation graph node inputs.
|
|
3913
|
+
*
|
|
3896
3914
|
* - **ThreadSafety**: Unsafe
|
|
3897
3915
|
*
|
|
3898
3916
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetParameter)
|
|
3899
3917
|
* @param this Controls the playback of an animation on an `Animator`.
|
|
3900
|
-
* @param key
|
|
3901
|
-
* @param value
|
|
3918
|
+
* @param key The name of the parameter to set.
|
|
3919
|
+
* @param value The value to assign to the parameter. Non-finite numeric values are sanitized to 0.
|
|
3902
3920
|
*/
|
|
3903
3921
|
SetParameter(this: AnimationTrack, key: string, value: unknown): void;
|
|
3904
3922
|
/**
|
|
3905
3923
|
* - **ThreadSafety**: Unsafe
|
|
3906
3924
|
*
|
|
3907
3925
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetTargetInstance)
|
|
3908
|
-
* @param this Controls the playback of an animation on an `Animator`.
|
|
3909
|
-
* @param name
|
|
3910
|
-
* @param target
|
|
3911
3926
|
*/
|
|
3912
3927
|
SetTargetInstance(this: AnimationTrack, name: string, target: Instance): void;
|
|
3913
3928
|
/**
|
|
@@ -4480,7 +4495,7 @@ interface AssetService extends Instance {
|
|
|
4480
4495
|
*/
|
|
4481
4496
|
CreateSurfaceAppearanceAsync(this: AssetService, content: object): SurfaceAppearance;
|
|
4482
4497
|
/**
|
|
4483
|
-
* **Deprecated:**
|
|
4498
|
+
* **Deprecated:** Use `GetAssetIdsForPackageAsync()` instead.
|
|
4484
4499
|
*
|
|
4485
4500
|
* Returns an array of asset IDs that are contained in a specified package.
|
|
4486
4501
|
*
|
|
@@ -4622,7 +4637,7 @@ interface AssetService extends Instance {
|
|
|
4622
4637
|
*/
|
|
4623
4638
|
SavePlaceAsync(this: AssetService, requestParameters?: object): void;
|
|
4624
4639
|
/**
|
|
4625
|
-
* **Deprecated:**
|
|
4640
|
+
* **Deprecated:** Use `SearchAudioAsync()` instead.
|
|
4626
4641
|
*
|
|
4627
4642
|
* Finds audio assets matching a variety of search criteria.
|
|
4628
4643
|
*
|
|
@@ -5752,6 +5767,18 @@ interface AudioEmitter extends Instance {
|
|
|
5752
5767
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DiffractionEnabled)
|
|
5753
5768
|
*/
|
|
5754
5769
|
DiffractionEnabled: Enum.SimulationMode;
|
|
5770
|
+
/**
|
|
5771
|
+
* - **ThreadSafety**: ReadSafe
|
|
5772
|
+
*
|
|
5773
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DistanceAttenuationBounds)
|
|
5774
|
+
*/
|
|
5775
|
+
DistanceAttenuationBounds: NumberRange;
|
|
5776
|
+
/**
|
|
5777
|
+
* - **ThreadSafety**: ReadSafe
|
|
5778
|
+
*
|
|
5779
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DistanceAttenuationMode)
|
|
5780
|
+
*/
|
|
5781
|
+
DistanceAttenuationMode: Enum.DistanceAttenuationMode;
|
|
5755
5782
|
/**
|
|
5756
5783
|
* - **ThreadSafety**: ReadSafe
|
|
5757
5784
|
*
|
|
@@ -7254,7 +7281,7 @@ interface AudioSearchParams extends Instance {
|
|
|
7254
7281
|
*/
|
|
7255
7282
|
AudioSubType: Enum.AudioSubType;
|
|
7256
7283
|
/**
|
|
7257
|
-
* **Deprecated:**
|
|
7284
|
+
* **Deprecated:** Use `AudioSubType` instead.
|
|
7258
7285
|
*
|
|
7259
7286
|
* The subtype of the audio asset.
|
|
7260
7287
|
*
|
|
@@ -7357,6 +7384,26 @@ interface AudioSpeechToText extends Instance {
|
|
|
7357
7384
|
* @returns An array of `Wires`
|
|
7358
7385
|
*/
|
|
7359
7386
|
GetConnectedWires(this: AudioSpeechToText, pin: string): Array<Instance>;
|
|
7387
|
+
/**
|
|
7388
|
+
* Gets the list of pins that a `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
7389
|
+
*
|
|
7390
|
+
* - **ThreadSafety**: Unsafe
|
|
7391
|
+
*
|
|
7392
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetInputPins)
|
|
7393
|
+
* @param this Converts spoken audio into text.
|
|
7394
|
+
* @returns An array of strings representing valid pin names.
|
|
7395
|
+
*/
|
|
7396
|
+
GetInputPins(this: AudioSpeechToText): Array<unknown>;
|
|
7397
|
+
/**
|
|
7398
|
+
* Gets the list of pins that a `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
7399
|
+
*
|
|
7400
|
+
* - **ThreadSafety**: Unsafe
|
|
7401
|
+
*
|
|
7402
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetOutputPins)
|
|
7403
|
+
* @param this Converts spoken audio into text.
|
|
7404
|
+
* @returns An array of strings representing valid pin names.
|
|
7405
|
+
*/
|
|
7406
|
+
GetOutputPins(this: AudioSpeechToText): Array<unknown>;
|
|
7360
7407
|
/**
|
|
7361
7408
|
* Fires when another instance is connected to or disconnected from the `AudioSpeechToText` via a `Wire`.
|
|
7362
7409
|
*
|
|
@@ -7481,6 +7528,26 @@ interface AudioTextToSpeech extends Instance {
|
|
|
7481
7528
|
* @returns An array of `Wires`
|
|
7482
7529
|
*/
|
|
7483
7530
|
GetConnectedWires(this: AudioTextToSpeech, pin: string): Array<Instance>;
|
|
7531
|
+
/**
|
|
7532
|
+
* Gets the list of pins that a `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
7533
|
+
*
|
|
7534
|
+
* - **ThreadSafety**: Unsafe
|
|
7535
|
+
*
|
|
7536
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetInputPins)
|
|
7537
|
+
* @param this Plays text as speech audio.
|
|
7538
|
+
* @returns An array of strings representing valid pin names.
|
|
7539
|
+
*/
|
|
7540
|
+
GetInputPins(this: AudioTextToSpeech): Array<unknown>;
|
|
7541
|
+
/**
|
|
7542
|
+
* Gets the list of pins that a `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
7543
|
+
*
|
|
7544
|
+
* - **ThreadSafety**: Unsafe
|
|
7545
|
+
*
|
|
7546
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetOutputPins)
|
|
7547
|
+
* @param this Plays text as speech audio.
|
|
7548
|
+
* @returns An array of strings representing valid pin names.
|
|
7549
|
+
*/
|
|
7550
|
+
GetOutputPins(this: AudioTextToSpeech): Array<unknown>;
|
|
7484
7551
|
/**
|
|
7485
7552
|
* Pauses the `AudioTextToSpeech` object wherever its `TimePosition` is.
|
|
7486
7553
|
*
|
|
@@ -8150,6 +8217,13 @@ interface AvatarCreationService extends Instance {
|
|
|
8150
8217
|
* - A secondary optional string result. In the case of `PromptCreateAvatarResult.Success`, this will indicate the outfit ID. In the case of any failure enum, this will be `nil`.
|
|
8151
8218
|
*/
|
|
8152
8219
|
PromptCreateAvatarAsync(this: AvatarCreationService, tokenId: string, player: Player, humanoidDescription: HumanoidDescription): unknown;
|
|
8220
|
+
/**
|
|
8221
|
+
* - **ThreadSafety**: Unsafe
|
|
8222
|
+
* - **Tags**: Yields
|
|
8223
|
+
*
|
|
8224
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PromptCreateMakeupAsync)
|
|
8225
|
+
*/
|
|
8226
|
+
PromptCreateMakeupAsync(this: AvatarCreationService, player: Player, makeupAssetEntries: Array<unknown>, thumbnailHeadColor?: Color3): unknown;
|
|
8153
8227
|
/**
|
|
8154
8228
|
* Prompt the `Player` to take a selfie and return the FileId.
|
|
8155
8229
|
*
|
|
@@ -8185,7 +8259,7 @@ interface AvatarCreationService extends Instance {
|
|
|
8185
8259
|
* @param this A service to support developer avatar creators.
|
|
8186
8260
|
* @param player The `Player` validation is completed for.
|
|
8187
8261
|
* @param accessory The instance validation is run on.
|
|
8188
|
-
* @param accessoryType `AccessoryType` the instance is expected to be.
|
|
8262
|
+
* @param accessoryType The `AccessoryType` the instance is expected to be.
|
|
8189
8263
|
* @returns A tuple containing, in order: - A boolean indicating if validation was successful for the accessory.
|
|
8190
8264
|
* - An optional table of strings. This includes failure reasons if validation was unsuccessful; otherwise `nil` if validation was successful.
|
|
8191
8265
|
*/
|
|
@@ -8499,7 +8573,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8499
8573
|
*
|
|
8500
8574
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetHeadShapesAsync)
|
|
8501
8575
|
* @param this A service to support developer Avatar Editors.
|
|
8502
|
-
* @returns An array of strings, each identifying a head shape owned by `Players.LocalPlayer`. Possible values include: `"
|
|
8576
|
+
* @returns An array of strings, each identifying a head shape owned by `Players.LocalPlayer`. Possible values include: `"Blockhead"`, `"Cheeks"`, `"Chiseled"`, `"ClassicFemaleV2"`, `"ClassicMaleV2"`, `"CoolThing"`, `"Default"`, `"EraserHead"`, `"FatHead"`, `"FlatTop"`, `"GoldenKorbloxGeneral"`, `"GoldenMrRobot"`, `"KnightOfChivalry"`, `"KnightOfCourage"`, `"ManHead"`, `"MercilessNinja"`, `"MrToilet"`, `"Narrow"`, `"NeoClassicFemaleV2"`, `"NeoClassicMaleV2"`, `"Paragon"`, `"Peabrain"`, `"Perfection"`, `"RobloxClassic"`, `"Roll"`, `"Roundy"`, `"RoxBox"`, `"StrongJaw"`, `"TheEngineer"`, `"Trim"`, `"WomanHead"`.
|
|
8503
8577
|
*/
|
|
8504
8578
|
GetHeadShapesAsync(this: AvatarEditorService): Array<unknown>;
|
|
8505
8579
|
/**
|
|
@@ -8838,7 +8912,7 @@ interface BadgeService extends Instance {
|
|
|
8838
8912
|
*/
|
|
8839
8913
|
readonly _nominal_BadgeService: unique symbol;
|
|
8840
8914
|
/**
|
|
8841
|
-
* **Deprecated:**
|
|
8915
|
+
* **Deprecated:** Use `AwardBadgeAsync()` instead.
|
|
8842
8916
|
*
|
|
8843
8917
|
* Award a badge to a player given the ID of each.
|
|
8844
8918
|
*
|
|
@@ -8892,6 +8966,13 @@ interface BadgeService extends Instance {
|
|
|
8892
8966
|
* @returns A dictionary of information about the specified badge.
|
|
8893
8967
|
*/
|
|
8894
8968
|
GetBadgeInfoAsync(this: BadgeService, badgeId: number): BadgeInfo;
|
|
8969
|
+
/**
|
|
8970
|
+
* - **ThreadSafety**: Unsafe
|
|
8971
|
+
* - **Tags**: Yields
|
|
8972
|
+
*
|
|
8973
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BadgeService#GetUserBadgesAsync)
|
|
8974
|
+
*/
|
|
8975
|
+
GetUserBadgesAsync(this: BadgeService, userId: User, badgeIds: Array<unknown>): Array<unknown>;
|
|
8895
8976
|
/**
|
|
8896
8977
|
* **Deprecated:** This function is deprecated. Do not use it for new work. Instead, it can be checked by calling BadgeService:GetBadgeInfoAsync() and checking the IsEnabled field.
|
|
8897
8978
|
*
|
|
@@ -9555,7 +9636,7 @@ interface BasePlayerGui extends Instance {
|
|
|
9555
9636
|
*/
|
|
9556
9637
|
readonly _nominal_BasePlayerGui: unique symbol;
|
|
9557
9638
|
/**
|
|
9558
|
-
* Returns a list of all `GuiObject` instances occupying the given
|
|
9639
|
+
* Returns a list of all `GuiObject` instances occupying the given
|
|
9559
9640
|
*
|
|
9560
9641
|
* - **ThreadSafety**: Unsafe
|
|
9561
9642
|
*
|
|
@@ -10215,6 +10296,8 @@ interface Beam extends Instance {
|
|
|
10215
10296
|
*/
|
|
10216
10297
|
LightInfluence: number;
|
|
10217
10298
|
/**
|
|
10299
|
+
* Determines a multiplier for `Beam.Transparency` that is only visible to the local client.
|
|
10300
|
+
*
|
|
10218
10301
|
* - **ThreadSafety**: ReadSafe
|
|
10219
10302
|
* - **Tags**: Hidden, NotReplicated
|
|
10220
10303
|
*
|
|
@@ -16758,6 +16841,21 @@ interface EditableService extends Instance {
|
|
|
16758
16841
|
*/
|
|
16759
16842
|
readonly _nominal_EditableService: unique symbol;
|
|
16760
16843
|
}
|
|
16844
|
+
/**
|
|
16845
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
16846
|
+
*
|
|
16847
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditorSourceService)
|
|
16848
|
+
*/
|
|
16849
|
+
interface EditorSourceService extends Instance {
|
|
16850
|
+
/**
|
|
16851
|
+
* **DO NOT USE!**
|
|
16852
|
+
*
|
|
16853
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16854
|
+
* @hidden
|
|
16855
|
+
* @deprecated
|
|
16856
|
+
*/
|
|
16857
|
+
readonly _nominal_EditorSourceService: unique symbol;
|
|
16858
|
+
}
|
|
16761
16859
|
/**
|
|
16762
16860
|
* Service providing common encoding, hashing, and compression methods.
|
|
16763
16861
|
*
|
|
@@ -18111,6 +18209,13 @@ interface GenerationService extends Instance {
|
|
|
18111
18209
|
* @returns The generated asset, returned as a `Model` with a single `MeshPart` containing an `EditableMesh`.
|
|
18112
18210
|
*/
|
|
18113
18211
|
LoadGeneratedMeshAsync(this: GenerationService, generationId: string): MeshPart;
|
|
18212
|
+
/**
|
|
18213
|
+
* - **ThreadSafety**: Unsafe
|
|
18214
|
+
* - **Tags**: Yields
|
|
18215
|
+
*
|
|
18216
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#SegmentMeshAsync)
|
|
18217
|
+
*/
|
|
18218
|
+
SegmentMeshAsync(this: GenerationService, meshPart: MeshPart, schema: object, options?: object): unknown;
|
|
18114
18219
|
/**
|
|
18115
18220
|
* - **ThreadSafety**: Unsafe
|
|
18116
18221
|
* - **Tags**: Yields
|
|
@@ -18403,6 +18508,13 @@ interface GlobalDataStore extends Instance {
|
|
|
18403
18508
|
* @deprecated
|
|
18404
18509
|
*/
|
|
18405
18510
|
OnUpdate(this: GlobalDataStore, key: string, callback: Callback): RBXScriptConnection;
|
|
18511
|
+
/**
|
|
18512
|
+
* - **ThreadSafety**: Unsafe
|
|
18513
|
+
* - **Tags**: Yields
|
|
18514
|
+
*
|
|
18515
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GlobalDataStore#BatchGetAsync)
|
|
18516
|
+
*/
|
|
18517
|
+
BatchGetAsync(this: GlobalDataStore, keys: Array<unknown>, options?: object): object;
|
|
18406
18518
|
/**
|
|
18407
18519
|
* Returns the value of a key in a specified data store and a `DataStoreKeyInfo` instance.
|
|
18408
18520
|
*
|
|
@@ -18547,7 +18659,7 @@ interface DataStore extends GlobalDataStore {
|
|
|
18547
18659
|
*/
|
|
18548
18660
|
ListVersionsAsync(this: DataStore, key: string, sortDirection?: CastsToEnum<Enum.SortDirection>, minDate?: number, maxDate?: number, pageSize?: number): DataStoreVersionPages;
|
|
18549
18661
|
/**
|
|
18550
|
-
* **Deprecated:**
|
|
18662
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
18551
18663
|
*
|
|
18552
18664
|
* Permanently deletes the specified version of a key.
|
|
18553
18665
|
*
|
|
@@ -19338,7 +19450,7 @@ interface GuiObject extends GuiBase2d {
|
|
|
19338
19450
|
readonly TouchTap: RBXScriptSignal<(touchPositions: Array<Vector2>) => void>;
|
|
19339
19451
|
}
|
|
19340
19452
|
/**
|
|
19341
|
-
* Blends descendants as a group with color/transparency.
|
|
19453
|
+
* Blends descendants as a flattened group with an optional color/transparency modification.
|
|
19342
19454
|
*
|
|
19343
19455
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CanvasGroup)
|
|
19344
19456
|
*/
|
|
@@ -19352,7 +19464,7 @@ interface CanvasGroup extends GuiObject {
|
|
|
19352
19464
|
*/
|
|
19353
19465
|
readonly _nominal_CanvasGroup: unique symbol;
|
|
19354
19466
|
/**
|
|
19355
|
-
* Color tint that applies to
|
|
19467
|
+
* Color tint that applies to the rendered group.
|
|
19356
19468
|
*
|
|
19357
19469
|
* - **ThreadSafety**: ReadSafe
|
|
19358
19470
|
*
|
|
@@ -19360,7 +19472,7 @@ interface CanvasGroup extends GuiObject {
|
|
|
19360
19472
|
*/
|
|
19361
19473
|
GroupColor3: Color3;
|
|
19362
19474
|
/**
|
|
19363
|
-
* Transparency that applies to
|
|
19475
|
+
* Transparency that applies to the rendered group.
|
|
19364
19476
|
*
|
|
19365
19477
|
* - **ThreadSafety**: ReadSafe
|
|
19366
19478
|
*
|
|
@@ -20141,7 +20253,7 @@ interface TextLabel extends GuiLabel {
|
|
|
20141
20253
|
*/
|
|
20142
20254
|
Text: string;
|
|
20143
20255
|
/**
|
|
20144
|
-
* Read-only property which reflects the absolute size of rendered text in
|
|
20256
|
+
* Read-only property which reflects the absolute size of rendered text in
|
|
20145
20257
|
*
|
|
20146
20258
|
* - **ThreadSafety**: ReadSafe
|
|
20147
20259
|
* - **Tags**: NotReplicated
|
|
@@ -20249,7 +20361,7 @@ interface TextLabel extends GuiLabel {
|
|
|
20249
20361
|
*/
|
|
20250
20362
|
TextWrap: boolean;
|
|
20251
20363
|
/**
|
|
20252
|
-
* Determines if text wraps to multiple lines within the `TextLabel`
|
|
20364
|
+
* Determines if text wraps to multiple lines within the `TextLabel`
|
|
20253
20365
|
*
|
|
20254
20366
|
* - **ThreadSafety**: ReadSafe
|
|
20255
20367
|
*
|
|
@@ -26087,6 +26199,15 @@ interface InputAction extends Instance {
|
|
|
26087
26199
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#Enabled)
|
|
26088
26200
|
*/
|
|
26089
26201
|
Enabled: boolean;
|
|
26202
|
+
/**
|
|
26203
|
+
* The `InputBinding` best matching the player's current input device.
|
|
26204
|
+
*
|
|
26205
|
+
* - **ThreadSafety**: ReadSafe
|
|
26206
|
+
* - **Tags**: NotReplicated
|
|
26207
|
+
*
|
|
26208
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#PreferredBinding)
|
|
26209
|
+
*/
|
|
26210
|
+
readonly PreferredBinding: InputBinding | undefined;
|
|
26090
26211
|
/**
|
|
26091
26212
|
* Specifies what type of input value the action is expecting.
|
|
26092
26213
|
*
|
|
@@ -26175,6 +26296,22 @@ interface InputBinding extends Instance {
|
|
|
26175
26296
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ClampMagnitudeToOne)
|
|
26176
26297
|
*/
|
|
26177
26298
|
ClampMagnitudeToOne: boolean;
|
|
26299
|
+
/**
|
|
26300
|
+
* Custom image asset to display for this binding.
|
|
26301
|
+
*
|
|
26302
|
+
* - **ThreadSafety**: ReadSafe
|
|
26303
|
+
*
|
|
26304
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#DisplayImage)
|
|
26305
|
+
*/
|
|
26306
|
+
DisplayImage: Content;
|
|
26307
|
+
/**
|
|
26308
|
+
* Custom display text for this binding.
|
|
26309
|
+
*
|
|
26310
|
+
* - **ThreadSafety**: ReadSafe
|
|
26311
|
+
*
|
|
26312
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#DisplayName)
|
|
26313
|
+
*/
|
|
26314
|
+
DisplayName: string;
|
|
26178
26315
|
/**
|
|
26179
26316
|
* Specifies an alternate `KeyCode` for dispatching directionally "down" inputs to the parent `InputAction`.
|
|
26180
26317
|
*
|
|
@@ -26561,7 +26698,7 @@ interface InsertService extends Instance {
|
|
|
26561
26698
|
*/
|
|
26562
26699
|
GetCollection(this: InsertService, categoryId: number): Array<CollectionInfo>;
|
|
26563
26700
|
/**
|
|
26564
|
-
* **Deprecated:**
|
|
26701
|
+
* **Deprecated:** Use `GetFreeDecalsAsync()` instead.
|
|
26565
26702
|
*
|
|
26566
26703
|
* Retrieves a list of free Decals from the Catalog.
|
|
26567
26704
|
*
|
|
@@ -26593,7 +26730,7 @@ interface InsertService extends Instance {
|
|
|
26593
26730
|
*/
|
|
26594
26731
|
GetFreeDecalsAsync(this: InsertService, searchText: string, pageNum: number): Array<unknown>;
|
|
26595
26732
|
/**
|
|
26596
|
-
* **Deprecated:**
|
|
26733
|
+
* **Deprecated:** Use `GetFreeModelsAsync()` instead.
|
|
26597
26734
|
*
|
|
26598
26735
|
* Retrieves a list of Free Models from the Catalog.
|
|
26599
26736
|
*
|
|
@@ -28692,6 +28829,21 @@ interface ModuleScript extends LuaSourceContainer {
|
|
|
28692
28829
|
*/
|
|
28693
28830
|
Source: ProtectedString;
|
|
28694
28831
|
}
|
|
28832
|
+
/**
|
|
28833
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
28834
|
+
*
|
|
28835
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LuauExpressionService)
|
|
28836
|
+
*/
|
|
28837
|
+
interface LuauExpressionService extends Instance {
|
|
28838
|
+
/**
|
|
28839
|
+
* **DO NOT USE!**
|
|
28840
|
+
*
|
|
28841
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
28842
|
+
* @hidden
|
|
28843
|
+
* @deprecated
|
|
28844
|
+
*/
|
|
28845
|
+
readonly _nominal_LuauExpressionService: unique symbol;
|
|
28846
|
+
}
|
|
28695
28847
|
/**
|
|
28696
28848
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
28697
28849
|
*
|
|
@@ -30416,7 +30568,7 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
30416
30568
|
*/
|
|
30417
30569
|
readonly _nominal_OpenCloudApiV1: unique symbol;
|
|
30418
30570
|
/**
|
|
30419
|
-
* **Deprecated:**
|
|
30571
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
30420
30572
|
*
|
|
30421
30573
|
* - **ThreadSafety**: Unsafe
|
|
30422
30574
|
* - **Tags**: CustomLuaState
|
|
@@ -30429,7 +30581,7 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
30429
30581
|
*/
|
|
30430
30582
|
CreateModel(this: OpenCloudApiV1, name: string): OpenCloudModel;
|
|
30431
30583
|
/**
|
|
30432
|
-
* **Deprecated:**
|
|
30584
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
30433
30585
|
*
|
|
30434
30586
|
* - **ThreadSafety**: Unsafe
|
|
30435
30587
|
* - **Tags**: Yields
|
|
@@ -30462,7 +30614,7 @@ interface OpenCloudService extends Instance {
|
|
|
30462
30614
|
*/
|
|
30463
30615
|
readonly _nominal_OpenCloudService: unique symbol;
|
|
30464
30616
|
/**
|
|
30465
|
-
* **Deprecated:**
|
|
30617
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
30466
30618
|
*
|
|
30467
30619
|
* - **ThreadSafety**: Unsafe
|
|
30468
30620
|
* - **Tags**:
|
|
@@ -30474,7 +30626,7 @@ interface OpenCloudService extends Instance {
|
|
|
30474
30626
|
*/
|
|
30475
30627
|
GetApiV1(this: OpenCloudService): OpenCloudApiV1;
|
|
30476
30628
|
/**
|
|
30477
|
-
* **Deprecated:**
|
|
30629
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
30478
30630
|
*
|
|
30479
30631
|
* - **ThreadSafety**: Unsafe
|
|
30480
30632
|
* - **Tags**: Yields
|
|
@@ -32997,7 +33149,7 @@ interface Camera extends PVInstance {
|
|
|
32997
33149
|
*/
|
|
32998
33150
|
readonly ViewportSize: Vector2;
|
|
32999
33151
|
/**
|
|
33000
|
-
* **Deprecated:**
|
|
33152
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
33001
33153
|
*
|
|
33002
33154
|
* Returns how much the `Camera` needs to be pushed towards its `Focus` in order to make sure there is no obstructions between the `Focus` and `CFrame`.
|
|
33003
33155
|
*
|
|
@@ -34823,6 +34975,8 @@ interface ParticleEmitter extends Instance {
|
|
|
34823
34975
|
*/
|
|
34824
34976
|
LightInfluence: number;
|
|
34825
34977
|
/**
|
|
34978
|
+
* Determines a multiplier for `ParticleEmitter.Transparency` that is only visible to the local client.
|
|
34979
|
+
*
|
|
34826
34980
|
* - **ThreadSafety**: ReadSafe
|
|
34827
34981
|
* - **Tags**: Hidden, NotReplicated
|
|
34828
34982
|
*
|
|
@@ -35186,6 +35340,19 @@ interface Path extends Instance {
|
|
|
35186
35340
|
*/
|
|
35187
35341
|
readonly Unblocked: RBXScriptSignal<(unblockedWaypointIdx: number) => void>;
|
|
35188
35342
|
}
|
|
35343
|
+
/**
|
|
35344
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path3D)
|
|
35345
|
+
*/
|
|
35346
|
+
interface Path3D extends Instance {
|
|
35347
|
+
/**
|
|
35348
|
+
* **DO NOT USE!**
|
|
35349
|
+
*
|
|
35350
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
35351
|
+
* @hidden
|
|
35352
|
+
* @deprecated
|
|
35353
|
+
*/
|
|
35354
|
+
readonly _nominal_Path3D: unique symbol;
|
|
35355
|
+
}
|
|
35189
35356
|
/**
|
|
35190
35357
|
* Connects two locations which otherwise by default are unconnected.
|
|
35191
35358
|
*
|
|
@@ -35617,6 +35784,21 @@ interface PhysicsService extends Instance {
|
|
|
35617
35784
|
*/
|
|
35618
35785
|
UnregisterCollisionGroup(this: PhysicsService, name: string): void;
|
|
35619
35786
|
}
|
|
35787
|
+
/**
|
|
35788
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
35789
|
+
*
|
|
35790
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PinShortcutService)
|
|
35791
|
+
*/
|
|
35792
|
+
interface PinShortcutService extends Instance {
|
|
35793
|
+
/**
|
|
35794
|
+
* **DO NOT USE!**
|
|
35795
|
+
*
|
|
35796
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
35797
|
+
* @hidden
|
|
35798
|
+
* @deprecated
|
|
35799
|
+
*/
|
|
35800
|
+
readonly _nominal_PinShortcutService: unique symbol;
|
|
35801
|
+
}
|
|
35620
35802
|
/**
|
|
35621
35803
|
* - **Tags**: NotCreatable, Service
|
|
35622
35804
|
*
|
|
@@ -36061,10 +36243,14 @@ interface Player extends Instance {
|
|
|
36061
36243
|
*/
|
|
36062
36244
|
DistanceFromCharacter(this: Player, point: Vector3): number;
|
|
36063
36245
|
/**
|
|
36246
|
+
* Returns a dictionary containing the player's current camera state.
|
|
36247
|
+
*
|
|
36064
36248
|
* - **ThreadSafety**: Safe
|
|
36065
36249
|
* - **Tags**: CustomLuaState
|
|
36066
36250
|
*
|
|
36067
36251
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetCameraState)
|
|
36252
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
36253
|
+
* @returns A dictionary containing `CFrame`, `FieldOfView`, and `ViewportSize` values.
|
|
36068
36254
|
*/
|
|
36069
36255
|
GetCameraState(this: Player): object;
|
|
36070
36256
|
/**
|
|
@@ -36148,7 +36334,7 @@ interface Player extends Instance {
|
|
|
36148
36334
|
*/
|
|
36149
36335
|
LoadBoolean(this: Player, key: string): boolean;
|
|
36150
36336
|
/**
|
|
36151
|
-
* **Deprecated:**
|
|
36337
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
36152
36338
|
*
|
|
36153
36339
|
* Places the given instance either in the player's character, head, or StarterGear based on the instance's class.
|
|
36154
36340
|
*
|
|
@@ -36417,7 +36603,7 @@ interface Player extends Instance {
|
|
|
36417
36603
|
/**
|
|
36418
36604
|
* **Deprecated:** This method has been superseded by the `Player:IsFriendsWithAsync()` method which should be used for new work.
|
|
36419
36605
|
*
|
|
36420
|
-
* Checks whether a player is a friend of the user with the given
|
|
36606
|
+
* Checks whether a player is a friend of the user with the given
|
|
36421
36607
|
*
|
|
36422
36608
|
* - **ThreadSafety**: Unsafe
|
|
36423
36609
|
* - **Tags**: Yields
|
|
@@ -37188,7 +37374,7 @@ interface Players extends Instance {
|
|
|
37188
37374
|
*/
|
|
37189
37375
|
GetBanHistoryAsync(this: Players, userId: User): BanHistoryPages;
|
|
37190
37376
|
/**
|
|
37191
|
-
* **Deprecated:**
|
|
37377
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
37192
37378
|
*
|
|
37193
37379
|
* Returns a `Model` containing the assets which the player is wearing, excluding gear.
|
|
37194
37380
|
*
|
|
@@ -38794,6 +38980,21 @@ interface ReplicatedStorage extends Instance {
|
|
|
38794
38980
|
*/
|
|
38795
38981
|
readonly _nominal_ReplicatedStorage: unique symbol;
|
|
38796
38982
|
}
|
|
38983
|
+
/**
|
|
38984
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
38985
|
+
*
|
|
38986
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RequestOrchestratorService)
|
|
38987
|
+
*/
|
|
38988
|
+
interface RequestOrchestratorService extends Instance {
|
|
38989
|
+
/**
|
|
38990
|
+
* **DO NOT USE!**
|
|
38991
|
+
*
|
|
38992
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
38993
|
+
* @hidden
|
|
38994
|
+
* @deprecated
|
|
38995
|
+
*/
|
|
38996
|
+
readonly _nominal_RequestOrchestratorService: unique symbol;
|
|
38997
|
+
}
|
|
38797
38998
|
/**
|
|
38798
38999
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
38799
39000
|
*
|
|
@@ -39398,7 +39599,7 @@ interface ScreenshotHud extends Instance {
|
|
|
39398
39599
|
*/
|
|
39399
39600
|
CloseWhenScreenshotTaken: boolean;
|
|
39400
39601
|
/**
|
|
39401
|
-
* **Deprecated:**
|
|
39602
|
+
* **Deprecated:** This property is deprecated. Do not use it for new work.
|
|
39402
39603
|
*
|
|
39403
39604
|
* Whether the experience name in the overlay is enabled.
|
|
39404
39605
|
*
|
|
@@ -39423,7 +39624,7 @@ interface ScreenshotHud extends Instance {
|
|
|
39423
39624
|
*/
|
|
39424
39625
|
HidePlayerGuiForCaptures: boolean;
|
|
39425
39626
|
/**
|
|
39426
|
-
* **Deprecated:**
|
|
39627
|
+
* **Deprecated:** This property is deprecated. Do not use it for new work.
|
|
39427
39628
|
*
|
|
39428
39629
|
* `Font` used for the experience name in the overlay.
|
|
39429
39630
|
*
|
|
@@ -39436,7 +39637,7 @@ interface ScreenshotHud extends Instance {
|
|
|
39436
39637
|
*/
|
|
39437
39638
|
OverlayFont: Enum.Font;
|
|
39438
39639
|
/**
|
|
39439
|
-
* **Deprecated:**
|
|
39640
|
+
* **Deprecated:** This property is deprecated. Do not use it for new work.
|
|
39440
39641
|
*
|
|
39441
39642
|
* Currently disabled with no effect.
|
|
39442
39643
|
*
|
|
@@ -40201,13 +40402,6 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
40201
40402
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#PrivateServerOwnerId)
|
|
40202
40403
|
*/
|
|
40203
40404
|
readonly PrivateServerOwnerId: number;
|
|
40204
|
-
/**
|
|
40205
|
-
* - **ThreadSafety**: ReadSafe
|
|
40206
|
-
* - **Tags**: NotReplicated
|
|
40207
|
-
*
|
|
40208
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#RunService)
|
|
40209
|
-
*/
|
|
40210
|
-
readonly RunService: RunService | undefined;
|
|
40211
40405
|
/**
|
|
40212
40406
|
* **Deprecated:** This property has been deprecated. Use `DataModel.PrivateServerId` instead.
|
|
40213
40407
|
*
|
|
@@ -40243,6 +40437,13 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
40243
40437
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#Workspace)
|
|
40244
40438
|
*/
|
|
40245
40439
|
readonly Workspace: Workspace;
|
|
40440
|
+
/**
|
|
40441
|
+
* - **ThreadSafety**: ReadSafe
|
|
40442
|
+
* - **Tags**: NotReplicated
|
|
40443
|
+
*
|
|
40444
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#RunService)
|
|
40445
|
+
*/
|
|
40446
|
+
readonly RunService: RunService | undefined;
|
|
40246
40447
|
/**
|
|
40247
40448
|
* Binds a function to be called before the server shuts down.
|
|
40248
40449
|
*
|
|
@@ -41027,7 +41228,7 @@ interface SocialService extends Instance {
|
|
|
41027
41228
|
*/
|
|
41028
41229
|
PromptFeedbackSubmissionAsync(this: SocialService, options?: object): void;
|
|
41029
41230
|
/**
|
|
41030
|
-
* **Deprecated:**
|
|
41231
|
+
* **Deprecated:** Use `PromptLinkSharingAsync()` instead.
|
|
41031
41232
|
*
|
|
41032
41233
|
* - **ThreadSafety**: Unsafe
|
|
41033
41234
|
* - **Tags**: Yields
|
|
@@ -42553,7 +42754,7 @@ interface Stats extends Instance {
|
|
|
42553
42754
|
*/
|
|
42554
42755
|
readonly HeartbeatTime: number;
|
|
42555
42756
|
/**
|
|
42556
|
-
* **Deprecated:**
|
|
42757
|
+
* **Deprecated:** Use `Stats.HeartbeatTime` instead.
|
|
42557
42758
|
*
|
|
42558
42759
|
* A measurement of the total amount of time it takes long it takes for Roblox to update all of its task scheduler jobs, in milliseconds.
|
|
42559
42760
|
*
|
|
@@ -42620,7 +42821,7 @@ interface Stats extends Instance {
|
|
|
42620
42821
|
*/
|
|
42621
42822
|
readonly PhysicsStepTime: number;
|
|
42622
42823
|
/**
|
|
42623
|
-
* **Deprecated:**
|
|
42824
|
+
* **Deprecated:** Use `Stats.PhysicsStepTime` instead.
|
|
42624
42825
|
*
|
|
42625
42826
|
* A measurement of how long it takes for the physics engine to update its current state, in milliseconds. If this value is high, then it means the game instance is under stress from the physics simulations taking place.
|
|
42626
42827
|
*
|
|
@@ -44006,7 +44207,7 @@ interface TeleportService extends Instance {
|
|
|
44006
44207
|
*/
|
|
44007
44208
|
PromptExperienceDetailsAsync(this: TeleportService, player: Player, universeId: number): Enum.PromptExperienceDetailsResult;
|
|
44008
44209
|
/**
|
|
44009
|
-
* **Deprecated:**
|
|
44210
|
+
* **Deprecated:** Use `ReserveServerAsync()` instead.
|
|
44010
44211
|
*
|
|
44011
44212
|
* Returns an access code that can be used to teleport players to a reserved server, along with the `DataModel.PrivateServerId` for it.
|
|
44012
44213
|
*
|
|
@@ -44222,6 +44423,12 @@ interface TestCase extends Instance {
|
|
|
44222
44423
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#Assert)
|
|
44223
44424
|
*/
|
|
44224
44425
|
Assert(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
44426
|
+
/**
|
|
44427
|
+
* - **ThreadSafety**: Unsafe
|
|
44428
|
+
*
|
|
44429
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#AssertLegacy)
|
|
44430
|
+
*/
|
|
44431
|
+
AssertLegacy(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
44225
44432
|
/**
|
|
44226
44433
|
* - **ThreadSafety**: Unsafe
|
|
44227
44434
|
*
|
|
@@ -44240,6 +44447,12 @@ interface TestCase extends Instance {
|
|
|
44240
44447
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#Require)
|
|
44241
44448
|
*/
|
|
44242
44449
|
Require(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
44450
|
+
/**
|
|
44451
|
+
* - **ThreadSafety**: Unsafe
|
|
44452
|
+
*
|
|
44453
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#RequireLegacy)
|
|
44454
|
+
*/
|
|
44455
|
+
RequireLegacy(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
44243
44456
|
}
|
|
44244
44457
|
/**
|
|
44245
44458
|
* A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
@@ -44459,6 +44672,12 @@ interface TestService extends Instance {
|
|
|
44459
44672
|
* @param testOptions
|
|
44460
44673
|
*/
|
|
44461
44674
|
RegisterTest(this: TestService, testOptions: object): TestCase;
|
|
44675
|
+
/**
|
|
44676
|
+
* - **ThreadSafety**: Unsafe
|
|
44677
|
+
*
|
|
44678
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RegisterTestLegacy)
|
|
44679
|
+
*/
|
|
44680
|
+
RegisterTestLegacy(this: TestService, testOptions: object): TestCase;
|
|
44462
44681
|
/**
|
|
44463
44682
|
* Prints whether a condition is true along with a description string.
|
|
44464
44683
|
*
|
|
@@ -45954,7 +46173,7 @@ interface TextService extends Instance {
|
|
|
45954
46173
|
*/
|
|
45955
46174
|
FilterAndTranslateStringAsync(this: TextService, stringToFilter: string, fromUserId: number, targetLocales: Array<unknown>, textContext?: CastsToEnum<Enum.TextFilterContext>): TextFilterTranslatedResult;
|
|
45956
46175
|
/**
|
|
45957
|
-
* Filters a string being received from a user and returns a
|
|
46176
|
+
* Filters a string being received from a user and returns a
|
|
45958
46177
|
*
|
|
45959
46178
|
* - **ThreadSafety**: Unsafe
|
|
45960
46179
|
* - **Tags**: Yields
|
|
@@ -46300,6 +46519,8 @@ interface Trail extends Instance {
|
|
|
46300
46519
|
*/
|
|
46301
46520
|
LightInfluence: number;
|
|
46302
46521
|
/**
|
|
46522
|
+
* Determines a multiplier for `Trail.Transparency` that is only visible to the local client.
|
|
46523
|
+
*
|
|
46303
46524
|
* - **ThreadSafety**: ReadSafe
|
|
46304
46525
|
* - **Tags**: Hidden, NotReplicated
|
|
46305
46526
|
*
|
|
@@ -48499,7 +48720,7 @@ interface UserInputService extends Instance {
|
|
|
48499
48720
|
*/
|
|
48500
48721
|
GetSupportedGamepadKeyCodes(this: UserInputService, gamepadNum: CastsToEnum<Enum.UserInputType>): Array<Enum.KeyCode>;
|
|
48501
48722
|
/**
|
|
48502
|
-
* **Deprecated:**
|
|
48723
|
+
* **Deprecated:** Use `VRService:GetUserCFrame()` instead.
|
|
48503
48724
|
*
|
|
48504
48725
|
* Returns a `CFrame` describing the position and orientation of a specified virtual reality device.
|
|
48505
48726
|
*
|
|
@@ -48772,7 +48993,7 @@ interface UserInputService extends Instance {
|
|
|
48772
48993
|
*/
|
|
48773
48994
|
readonly TouchTapInWorld: RBXScriptSignal<(position: Vector2, processedByUI: boolean) => void>;
|
|
48774
48995
|
/**
|
|
48775
|
-
* **Deprecated:**
|
|
48996
|
+
* **Deprecated:** Use `VRService.UserCFrameChanged` instead.
|
|
48776
48997
|
*
|
|
48777
48998
|
* Fires when the `CFrame` of a specified Virtual Reality device changes.
|
|
48778
48999
|
*
|
|
@@ -50368,6 +50589,21 @@ interface WeldConstraint extends Instance {
|
|
|
50368
50589
|
*/
|
|
50369
50590
|
Part1: BasePart | undefined;
|
|
50370
50591
|
}
|
|
50592
|
+
/**
|
|
50593
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
50594
|
+
*
|
|
50595
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WindowProtocolService)
|
|
50596
|
+
*/
|
|
50597
|
+
interface WindowProtocolService extends Instance {
|
|
50598
|
+
/**
|
|
50599
|
+
* **DO NOT USE!**
|
|
50600
|
+
*
|
|
50601
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
50602
|
+
* @hidden
|
|
50603
|
+
* @deprecated
|
|
50604
|
+
*/
|
|
50605
|
+
readonly _nominal_WindowProtocolService: unique symbol;
|
|
50606
|
+
}
|
|
50371
50607
|
/**
|
|
50372
50608
|
* Connects one or more `Instances` to form a processing graph of their streams. At the moment, only audio streams are supported, but this may expand in the future.
|
|
50373
50609
|
*
|
|
@@ -50478,6 +50714,21 @@ interface WrapTextureTransfer extends Instance {
|
|
|
50478
50714
|
*/
|
|
50479
50715
|
UVMinBound: Vector2;
|
|
50480
50716
|
}
|
|
50717
|
+
/**
|
|
50718
|
+
* - **Tags**: NotCreatable
|
|
50719
|
+
*
|
|
50720
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LuauExpression)
|
|
50721
|
+
*/
|
|
50722
|
+
interface LuauExpression extends RBXObject {
|
|
50723
|
+
/**
|
|
50724
|
+
* **DO NOT USE!**
|
|
50725
|
+
*
|
|
50726
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
50727
|
+
* @hidden
|
|
50728
|
+
* @deprecated
|
|
50729
|
+
*/
|
|
50730
|
+
readonly _nominal_LuauExpression: unique symbol;
|
|
50731
|
+
}
|
|
50481
50732
|
/**
|
|
50482
50733
|
* - **Tags**: NotCreatable, NotReplicated
|
|
50483
50734
|
*
|