@rbxts/types 1.0.886 → 1.0.888
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 +241 -17
- package/include/generated/PluginSecurity.d.ts +73 -11
- package/include/generated/enums.d.ts +564 -26
- package/package.json +1 -1
|
@@ -59,6 +59,7 @@ interface Services {
|
|
|
59
59
|
DeviceIdService: DeviceIdService;
|
|
60
60
|
DraggerService: DraggerService;
|
|
61
61
|
EditableService: EditableService;
|
|
62
|
+
EncodingService: EncodingService;
|
|
62
63
|
EventIngestService: EventIngestService;
|
|
63
64
|
ExampleV2Service: ExampleV2Service;
|
|
64
65
|
ExperienceAuthService: ExperienceAuthService;
|
|
@@ -215,6 +216,7 @@ interface Services {
|
|
|
215
216
|
UIDragDetectorService: UIDragDetectorService;
|
|
216
217
|
UniqueIdLookupService: UniqueIdLookupService;
|
|
217
218
|
UnvalidatedAssetService: UnvalidatedAssetService;
|
|
219
|
+
UserGameSettings: UserGameSettings;
|
|
218
220
|
UserInputService: UserInputService;
|
|
219
221
|
UserService: UserService;
|
|
220
222
|
VideoCaptureService: VideoCaptureService;
|
|
@@ -243,6 +245,8 @@ interface CreatableInstances {
|
|
|
243
245
|
Animation: Animation;
|
|
244
246
|
AnimationConstraint: AnimationConstraint;
|
|
245
247
|
AnimationController: AnimationController;
|
|
248
|
+
AnimationGraphDefinition: AnimationGraphDefinition;
|
|
249
|
+
AnimationNodeDefinition: AnimationNodeDefinition;
|
|
246
250
|
AnimationRigData: AnimationRigData;
|
|
247
251
|
Animator: Animator;
|
|
248
252
|
Annotation: Annotation;
|
|
@@ -698,13 +702,13 @@ interface Instances extends Services, CreatableInstances {
|
|
|
698
702
|
UIConstraint: UIConstraint;
|
|
699
703
|
UIGridStyleLayout: UIGridStyleLayout;
|
|
700
704
|
UILayout: UILayout;
|
|
701
|
-
UserGameSettings: UserGameSettings;
|
|
702
705
|
UserSettings: UserSettings;
|
|
703
706
|
ValueBase: ValueBase;
|
|
704
707
|
WebSocketClient: WebSocketClient;
|
|
705
708
|
WorldRoot: WorldRoot;
|
|
706
709
|
}
|
|
707
710
|
interface Objects extends Instances {
|
|
711
|
+
AnimationNode: AnimationNode;
|
|
708
712
|
Capture: Capture;
|
|
709
713
|
ConfigSnapshot: ConfigSnapshot;
|
|
710
714
|
EditableImage: EditableImage;
|
|
@@ -778,6 +782,21 @@ interface RBXObject {
|
|
|
778
782
|
*/
|
|
779
783
|
readonly Changed: unknown;
|
|
780
784
|
}
|
|
785
|
+
/**
|
|
786
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
787
|
+
*
|
|
788
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNode)
|
|
789
|
+
*/
|
|
790
|
+
interface AnimationNode extends RBXObject {
|
|
791
|
+
/**
|
|
792
|
+
* **DO NOT USE!**
|
|
793
|
+
*
|
|
794
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
795
|
+
* @hidden
|
|
796
|
+
* @deprecated
|
|
797
|
+
*/
|
|
798
|
+
readonly _nominal_AnimationNode: unique symbol;
|
|
799
|
+
}
|
|
781
800
|
/**
|
|
782
801
|
* - **Tags**: NotCreatable, NotReplicated
|
|
783
802
|
*
|
|
@@ -2183,7 +2202,7 @@ interface Instance extends RBXObject {
|
|
|
2183
2202
|
*/
|
|
2184
2203
|
AddTag(this: Instance, tag: string): void;
|
|
2185
2204
|
/**
|
|
2186
|
-
* This
|
|
2205
|
+
* This method destroys all of an instance's children.
|
|
2187
2206
|
*
|
|
2188
2207
|
* - **ThreadSafety**: Unsafe
|
|
2189
2208
|
*
|
|
@@ -2436,16 +2455,23 @@ interface Instance extends RBXObject {
|
|
|
2436
2455
|
*/
|
|
2437
2456
|
IsPredicted(this: Instance): boolean;
|
|
2438
2457
|
/**
|
|
2439
|
-
* Returns `true` if the value stored in the specified property is equal to the code-instantiated default.
|
|
2458
|
+
* Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
|
|
2440
2459
|
*
|
|
2441
2460
|
* - **ThreadSafety**: Unsafe
|
|
2442
2461
|
*
|
|
2443
2462
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#IsPropertyModified)
|
|
2444
2463
|
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
2445
2464
|
* @param property Name of the property to query.
|
|
2446
|
-
* @returns Boolean indicating whether the property is modified.
|
|
2465
|
+
* @returns Boolean indicating whether the property is modified from its code‑instantiated default.
|
|
2447
2466
|
*/
|
|
2448
2467
|
IsPropertyModified(this: Instance, property: string): boolean;
|
|
2468
|
+
/**
|
|
2469
|
+
* - **ThreadSafety**: Unsafe
|
|
2470
|
+
* - **Tags**: CustomLuaState
|
|
2471
|
+
*
|
|
2472
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#QueryDescendants)
|
|
2473
|
+
*/
|
|
2474
|
+
QueryDescendants(this: Instance, selectorGroup: string): Array<Instance>;
|
|
2449
2475
|
/**
|
|
2450
2476
|
* Removes a tag from the instance.
|
|
2451
2477
|
*
|
|
@@ -3132,6 +3158,19 @@ interface AnimationClip extends Instance {
|
|
|
3132
3158
|
*/
|
|
3133
3159
|
Priority: Enum.AnimationPriority;
|
|
3134
3160
|
}
|
|
3161
|
+
/**
|
|
3162
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationGraphDefinition)
|
|
3163
|
+
*/
|
|
3164
|
+
interface AnimationGraphDefinition extends AnimationClip {
|
|
3165
|
+
/**
|
|
3166
|
+
* **DO NOT USE!**
|
|
3167
|
+
*
|
|
3168
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3169
|
+
* @hidden
|
|
3170
|
+
* @deprecated
|
|
3171
|
+
*/
|
|
3172
|
+
readonly _nominal_AnimationGraphDefinition: unique symbol;
|
|
3173
|
+
}
|
|
3135
3174
|
/**
|
|
3136
3175
|
* Stores animation data in the form of curves for each individual channel to animate.
|
|
3137
3176
|
*
|
|
@@ -3352,6 +3391,43 @@ interface AnimationFromVideoCreatorStudioService extends Instance {
|
|
|
3352
3391
|
*/
|
|
3353
3392
|
readonly _nominal_AnimationFromVideoCreatorStudioService: unique symbol;
|
|
3354
3393
|
}
|
|
3394
|
+
/**
|
|
3395
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition)
|
|
3396
|
+
*/
|
|
3397
|
+
interface AnimationNodeDefinition extends Instance {
|
|
3398
|
+
/**
|
|
3399
|
+
* **DO NOT USE!**
|
|
3400
|
+
*
|
|
3401
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3402
|
+
* @hidden
|
|
3403
|
+
* @deprecated
|
|
3404
|
+
*/
|
|
3405
|
+
readonly _nominal_AnimationNodeDefinition: unique symbol;
|
|
3406
|
+
/**
|
|
3407
|
+
* - **ThreadSafety**: ReadSafe
|
|
3408
|
+
*
|
|
3409
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#NodeType)
|
|
3410
|
+
*/
|
|
3411
|
+
NodeType: Enum.AnimationNodeType;
|
|
3412
|
+
/**
|
|
3413
|
+
* - **ThreadSafety**: Unsafe
|
|
3414
|
+
*
|
|
3415
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#GetConnectedWires)
|
|
3416
|
+
*/
|
|
3417
|
+
GetConnectedWires(this: AnimationNodeDefinition, pin: string): Array<Instance>;
|
|
3418
|
+
/**
|
|
3419
|
+
* - **ThreadSafety**: Unsafe
|
|
3420
|
+
*
|
|
3421
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#GetInputPins)
|
|
3422
|
+
*/
|
|
3423
|
+
GetInputPins(this: AnimationNodeDefinition): Array<unknown>;
|
|
3424
|
+
/**
|
|
3425
|
+
* - **ThreadSafety**: Unsafe
|
|
3426
|
+
*
|
|
3427
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#GetOutputPins)
|
|
3428
|
+
*/
|
|
3429
|
+
GetOutputPins(this: AnimationNodeDefinition): Array<unknown>;
|
|
3430
|
+
}
|
|
3355
3431
|
/**
|
|
3356
3432
|
* Used to store information regarding the model an animation was authored for.
|
|
3357
3433
|
*
|
|
@@ -4193,10 +4269,15 @@ interface AssetService extends Instance {
|
|
|
4193
4269
|
PlaceId: number;
|
|
4194
4270
|
}>;
|
|
4195
4271
|
/**
|
|
4272
|
+
* Loads a `Model` instance given its asset ID. This is the modern replacement for `InsertService:LoadAsset()` and supports loading third-party assets.
|
|
4273
|
+
*
|
|
4196
4274
|
* - **ThreadSafety**: Unsafe
|
|
4197
4275
|
* - **Tags**: Yields
|
|
4198
4276
|
*
|
|
4199
4277
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#LoadAssetAsync)
|
|
4278
|
+
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4279
|
+
* @param assetId The asset ID number of the asset being loaded.
|
|
4280
|
+
* @returns A `Model` instance containing the loaded asset.
|
|
4200
4281
|
*/
|
|
4201
4282
|
LoadAssetAsync(this: AssetService, assetId: number): Instance | undefined;
|
|
4202
4283
|
/**
|
|
@@ -7330,6 +7411,13 @@ interface AvatarCreationService extends Instance {
|
|
|
7330
7411
|
* @returns A unique identifier for the generated avatar.
|
|
7331
7412
|
*/
|
|
7332
7413
|
AutoSetupAvatarAsync(this: AvatarCreationService, player: Player, model: Model, progressCallback?: Callback): string;
|
|
7414
|
+
/**
|
|
7415
|
+
* - **ThreadSafety**: Unsafe
|
|
7416
|
+
* - **Tags**: Yields
|
|
7417
|
+
*
|
|
7418
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AutoSetupAvatarNewAsync)
|
|
7419
|
+
*/
|
|
7420
|
+
AutoSetupAvatarNewAsync(this: AvatarCreationService, player: Player, autoSetupParams: object, progressCallback?: Callback): string;
|
|
7333
7421
|
/**
|
|
7334
7422
|
* Creates a 2D avatar preview and returns a previewId.
|
|
7335
7423
|
*
|
|
@@ -15095,6 +15183,63 @@ interface EditableService extends Instance {
|
|
|
15095
15183
|
*/
|
|
15096
15184
|
readonly _nominal_EditableService: unique symbol;
|
|
15097
15185
|
}
|
|
15186
|
+
/**
|
|
15187
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
15188
|
+
*
|
|
15189
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService)
|
|
15190
|
+
*/
|
|
15191
|
+
interface EncodingService extends Instance {
|
|
15192
|
+
/**
|
|
15193
|
+
* **DO NOT USE!**
|
|
15194
|
+
*
|
|
15195
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
15196
|
+
* @hidden
|
|
15197
|
+
* @deprecated
|
|
15198
|
+
*/
|
|
15199
|
+
readonly _nominal_EncodingService: unique symbol;
|
|
15200
|
+
/**
|
|
15201
|
+
* - **ThreadSafety**: Safe
|
|
15202
|
+
*
|
|
15203
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#Base64Decode)
|
|
15204
|
+
*/
|
|
15205
|
+
Base64Decode(this: EncodingService, input: buffer): buffer;
|
|
15206
|
+
/**
|
|
15207
|
+
* - **ThreadSafety**: Safe
|
|
15208
|
+
*
|
|
15209
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#Base64Encode)
|
|
15210
|
+
*/
|
|
15211
|
+
Base64Encode(this: EncodingService, input: buffer): buffer;
|
|
15212
|
+
/**
|
|
15213
|
+
* - **ThreadSafety**: Safe
|
|
15214
|
+
*
|
|
15215
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#CompressBuffer)
|
|
15216
|
+
*/
|
|
15217
|
+
CompressBuffer(this: EncodingService, input: buffer, algorithm: CastsToEnum<Enum.CompressionAlgorithm>, compressionLevel?: number): buffer;
|
|
15218
|
+
/**
|
|
15219
|
+
* - **ThreadSafety**: Safe
|
|
15220
|
+
*
|
|
15221
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#ComputeBufferHash)
|
|
15222
|
+
*/
|
|
15223
|
+
ComputeBufferHash(this: EncodingService, input: buffer, algorithm: CastsToEnum<Enum.HashAlgorithm>): buffer;
|
|
15224
|
+
/**
|
|
15225
|
+
* - **ThreadSafety**: Safe
|
|
15226
|
+
*
|
|
15227
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#ComputeStringHash)
|
|
15228
|
+
*/
|
|
15229
|
+
ComputeStringHash(this: EncodingService, input: string, algorithm: CastsToEnum<Enum.HashAlgorithm>): string;
|
|
15230
|
+
/**
|
|
15231
|
+
* - **ThreadSafety**: Safe
|
|
15232
|
+
*
|
|
15233
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#DecompressBuffer)
|
|
15234
|
+
*/
|
|
15235
|
+
DecompressBuffer(this: EncodingService, input: buffer, algorithm: CastsToEnum<Enum.CompressionAlgorithm>): buffer;
|
|
15236
|
+
/**
|
|
15237
|
+
* - **ThreadSafety**: Safe
|
|
15238
|
+
*
|
|
15239
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#GetDecompressedBufferSize)
|
|
15240
|
+
*/
|
|
15241
|
+
GetDecompressedBufferSize(this: EncodingService, input: buffer, algorithm: CastsToEnum<Enum.CompressionAlgorithm>): number | undefined;
|
|
15242
|
+
}
|
|
15098
15243
|
/**
|
|
15099
15244
|
* Represents a 3D rotation curve through a group of three `FloatCurves`.
|
|
15100
15245
|
*
|
|
@@ -15896,7 +16041,7 @@ interface FeatureRestrictionManager extends Instance {
|
|
|
15896
16041
|
readonly _nominal_FeatureRestrictionManager: unique symbol;
|
|
15897
16042
|
}
|
|
15898
16043
|
/**
|
|
15899
|
-
* A particle emitter with the visual aesthetic of fire.
|
|
16044
|
+
* A preconfigured particle emitter with the visual aesthetic of fire.
|
|
15900
16045
|
*
|
|
15901
16046
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Fire)
|
|
15902
16047
|
*/
|
|
@@ -15935,6 +16080,8 @@ interface Fire extends Instance {
|
|
|
15935
16080
|
*/
|
|
15936
16081
|
Heat: number;
|
|
15937
16082
|
/**
|
|
16083
|
+
* A multiplier for the `Fire` object's transparency that is only visible to the local client.
|
|
16084
|
+
*
|
|
15938
16085
|
* - **ThreadSafety**: ReadSafe
|
|
15939
16086
|
* - **Tags**: Hidden, NotReplicated
|
|
15940
16087
|
*
|
|
@@ -15959,7 +16106,7 @@ interface Fire extends Instance {
|
|
|
15959
16106
|
*/
|
|
15960
16107
|
Size: number;
|
|
15961
16108
|
/**
|
|
15962
|
-
*
|
|
16109
|
+
* Controls the speed of the particle effect.
|
|
15963
16110
|
*
|
|
15964
16111
|
* - **ThreadSafety**: ReadSafe
|
|
15965
16112
|
*
|
|
@@ -33272,6 +33419,7 @@ interface Player extends Instance {
|
|
|
33272
33419
|
* Whether player client-side gameplay is currently paused.
|
|
33273
33420
|
*
|
|
33274
33421
|
* - **ThreadSafety**: ReadSafe
|
|
33422
|
+
* - **Tags**: Hidden
|
|
33275
33423
|
*
|
|
33276
33424
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GameplayPaused)
|
|
33277
33425
|
*/
|
|
@@ -36083,12 +36231,18 @@ interface RuntimeContentService extends Instance {
|
|
|
36083
36231
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentFail)
|
|
36084
36232
|
*/
|
|
36085
36233
|
readonly RuntimeContentFail: RBXScriptSignal<(id: string) => void>;
|
|
36234
|
+
/**
|
|
36235
|
+
* - **ThreadSafety**: Unsafe
|
|
36236
|
+
*
|
|
36237
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentLRCleanup)
|
|
36238
|
+
*/
|
|
36239
|
+
readonly RuntimeContentLRCleanup: RBXScriptSignal<(id: string, priorityList: string) => void>;
|
|
36086
36240
|
/**
|
|
36087
36241
|
* - **ThreadSafety**: Unsafe
|
|
36088
36242
|
*
|
|
36089
36243
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentQuery)
|
|
36090
36244
|
*/
|
|
36091
|
-
readonly RuntimeContentQuery: RBXScriptSignal<(id: string,
|
|
36245
|
+
readonly RuntimeContentQuery: RBXScriptSignal<(id: string, expectedType: string, priorityList: string) => void>;
|
|
36092
36246
|
/**
|
|
36093
36247
|
* - **ThreadSafety**: Unsafe
|
|
36094
36248
|
*
|
|
@@ -37563,6 +37717,13 @@ interface SocialService extends Instance {
|
|
|
37563
37717
|
* @returns Returns an `RsvpStatus` indicating the player's current RSVP status for the event. If the player has not RSVP'd to the event, this will return `RsvpStatus.None`.
|
|
37564
37718
|
*/
|
|
37565
37719
|
GetEventRsvpStatusAsync(this: SocialService, eventId: string): Enum.RsvpStatus;
|
|
37720
|
+
/**
|
|
37721
|
+
* - **ThreadSafety**: Unsafe
|
|
37722
|
+
* - **Tags**: Yields
|
|
37723
|
+
*
|
|
37724
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#GetExperienceEventAsync)
|
|
37725
|
+
*/
|
|
37726
|
+
GetExperienceEventAsync(this: SocialService, eventId: string): object | undefined;
|
|
37566
37727
|
/**
|
|
37567
37728
|
* Returns an array of dictionaries containing data for all members of the specified party who are currently in the experience.
|
|
37568
37729
|
*
|
|
@@ -37575,6 +37736,13 @@ interface SocialService extends Instance {
|
|
|
37575
37736
|
* @returns An array of dictionaries representing the members of the specified party who are currently in the experience.
|
|
37576
37737
|
*/
|
|
37577
37738
|
GetPartyAsync(this: SocialService, partyId: string): Array<unknown>;
|
|
37739
|
+
/**
|
|
37740
|
+
* - **ThreadSafety**: Unsafe
|
|
37741
|
+
* - **Tags**: Yields
|
|
37742
|
+
*
|
|
37743
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#GetUpcomingExperienceEventsAsync)
|
|
37744
|
+
*/
|
|
37745
|
+
GetUpcomingExperienceEventsAsync(this: SocialService): Array<unknown>;
|
|
37578
37746
|
/**
|
|
37579
37747
|
* Prompts the player to submit feedback about the current experience.
|
|
37580
37748
|
*
|
|
@@ -38069,7 +38237,7 @@ interface CompressorSoundEffect extends SoundEffect {
|
|
|
38069
38237
|
*/
|
|
38070
38238
|
readonly _nominal_CompressorSoundEffect: unique symbol;
|
|
38071
38239
|
/**
|
|
38072
|
-
* The time the effect takes to become active after its Threshold has
|
|
38240
|
+
* The time the effect takes to become active after its `Threshold` has been reached.
|
|
38073
38241
|
*
|
|
38074
38242
|
* - **ThreadSafety**: ReadSafe
|
|
38075
38243
|
*
|
|
@@ -38077,7 +38245,7 @@ interface CompressorSoundEffect extends SoundEffect {
|
|
|
38077
38245
|
*/
|
|
38078
38246
|
Attack: number;
|
|
38079
38247
|
/**
|
|
38080
|
-
* The overall amplification applied to the effect's Sound or SoundGroup after attenuation of sounds above the threshold.
|
|
38248
|
+
* The overall amplification applied to the effect's `Sound` or `SoundGroup` after attenuation of sounds above the threshold.
|
|
38081
38249
|
*
|
|
38082
38250
|
* - **ThreadSafety**: ReadSafe
|
|
38083
38251
|
*
|
|
@@ -38085,7 +38253,7 @@ interface CompressorSoundEffect extends SoundEffect {
|
|
|
38085
38253
|
*/
|
|
38086
38254
|
GainMakeup: number;
|
|
38087
38255
|
/**
|
|
38088
|
-
* The ratio between the `
|
|
38256
|
+
* The ratio between the `SideChain` sound effect, and this sound effect.
|
|
38089
38257
|
*
|
|
38090
38258
|
* - **ThreadSafety**: ReadSafe
|
|
38091
38259
|
*
|
|
@@ -38093,7 +38261,7 @@ interface CompressorSoundEffect extends SoundEffect {
|
|
|
38093
38261
|
*/
|
|
38094
38262
|
Ratio: number;
|
|
38095
38263
|
/**
|
|
38096
|
-
* The time the effect takes to become inactive after its sound is below the Threshold
|
|
38264
|
+
* The time the effect takes to become inactive after its sound is below the `Threshold`.
|
|
38097
38265
|
*
|
|
38098
38266
|
* - **ThreadSafety**: ReadSafe
|
|
38099
38267
|
*
|
|
@@ -39000,7 +39168,7 @@ interface Stats extends Instance {
|
|
|
39000
39168
|
*/
|
|
39001
39169
|
readonly FrameTime: number;
|
|
39002
39170
|
/**
|
|
39003
|
-
* A measurement of the total amount of time it takes for the server to update its
|
|
39171
|
+
* A measurement of the total amount of time it takes for the server to update its task scheduler jobs in seconds.
|
|
39004
39172
|
*
|
|
39005
39173
|
* - **ThreadSafety**: ReadSafe
|
|
39006
39174
|
* - **Tags**: NotReplicated
|
|
@@ -39011,7 +39179,7 @@ interface Stats extends Instance {
|
|
|
39011
39179
|
/**
|
|
39012
39180
|
* **Deprecated:**
|
|
39013
39181
|
*
|
|
39014
|
-
* A measurement of the total amount of time it takes long it takes for Roblox to update all of its
|
|
39182
|
+
* 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.
|
|
39015
39183
|
*
|
|
39016
39184
|
* - **ThreadSafety**: ReadSafe
|
|
39017
39185
|
* - **Tags**: NotReplicated
|
|
@@ -39202,7 +39370,7 @@ interface Stats extends Instance {
|
|
|
39202
39370
|
*/
|
|
39203
39371
|
GetMemoryCategoryNames(this: Stats): Array<unknown>;
|
|
39204
39372
|
/**
|
|
39205
|
-
* Returns the number of megabytes that are being consumed by all available categories, or an empty array if `MemoryTrackingEnabled` is false
|
|
39373
|
+
* Returns the number of megabytes that are being consumed by all available categories, or an empty array if `MemoryTrackingEnabled` is `false`.
|
|
39206
39374
|
*
|
|
39207
39375
|
* - **ThreadSafety**: Unsafe
|
|
39208
39376
|
*
|
|
@@ -39211,7 +39379,7 @@ interface Stats extends Instance {
|
|
|
39211
39379
|
*/
|
|
39212
39380
|
GetMemoryUsageMbAllCategories(this: Stats): Array<unknown>;
|
|
39213
39381
|
/**
|
|
39214
|
-
* Returns the number of megabytes that are being consumed in the specified `DeveloperMemoryTag` category, or 0 if `MemoryTrackingEnabled` is false
|
|
39382
|
+
* Returns the number of megabytes that are being consumed in the specified `DeveloperMemoryTag` category, or `0` if `MemoryTrackingEnabled` is `false`.
|
|
39215
39383
|
*
|
|
39216
39384
|
* - **ThreadSafety**: Unsafe
|
|
39217
39385
|
*
|
|
@@ -39221,7 +39389,7 @@ interface Stats extends Instance {
|
|
|
39221
39389
|
*/
|
|
39222
39390
|
GetMemoryUsageMbForTag(this: Stats, tag: CastsToEnum<Enum.DeveloperMemoryTag>): number;
|
|
39223
39391
|
/**
|
|
39224
|
-
* Returns the total amount of memory being consumed by the current game session, in megabytes
|
|
39392
|
+
* Returns the total amount of memory being consumed by the current game session, in megabytes.
|
|
39225
39393
|
*
|
|
39226
39394
|
* - **ThreadSafety**: Unsafe
|
|
39227
39395
|
*
|
|
@@ -43919,7 +44087,7 @@ interface UnvalidatedAssetService extends Instance {
|
|
|
43919
44087
|
/**
|
|
43920
44088
|
* The UserGameSettings is a singleton class found inside of the `UserSettings` singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character.
|
|
43921
44089
|
*
|
|
43922
|
-
* - **Tags**: NotCreatable,
|
|
44090
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
43923
44091
|
*
|
|
43924
44092
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserGameSettings)
|
|
43925
44093
|
*/
|
|
@@ -45443,6 +45611,8 @@ interface Vector3Value extends ValueBase {
|
|
|
45443
45611
|
readonly Changed: RBXScriptSignal<(value: Vector3) => void>;
|
|
45444
45612
|
}
|
|
45445
45613
|
/**
|
|
45614
|
+
* A sorted list of time-value pairs that define a curve. Used to animate a any type of value.
|
|
45615
|
+
*
|
|
45446
45616
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve)
|
|
45447
45617
|
*/
|
|
45448
45618
|
interface ValueCurve extends Instance {
|
|
@@ -45455,6 +45625,8 @@ interface ValueCurve extends Instance {
|
|
|
45455
45625
|
*/
|
|
45456
45626
|
readonly _nominal_ValueCurve: unique symbol;
|
|
45457
45627
|
/**
|
|
45628
|
+
* Number of keys in the value curve.
|
|
45629
|
+
*
|
|
45458
45630
|
* - **ThreadSafety**: ReadSafe
|
|
45459
45631
|
* - **Tags**: NotReplicated
|
|
45460
45632
|
*
|
|
@@ -45462,6 +45634,8 @@ interface ValueCurve extends Instance {
|
|
|
45462
45634
|
*/
|
|
45463
45635
|
readonly Length: number;
|
|
45464
45636
|
/**
|
|
45637
|
+
* Read-only value indicating the type held in this curve.
|
|
45638
|
+
*
|
|
45465
45639
|
* - **ThreadSafety**: ReadSafe
|
|
45466
45640
|
* - **Tags**: NotReplicated
|
|
45467
45641
|
*
|
|
@@ -45469,51 +45643,91 @@ interface ValueCurve extends Instance {
|
|
|
45469
45643
|
*/
|
|
45470
45644
|
readonly ValueType: string;
|
|
45471
45645
|
/**
|
|
45646
|
+
* Returns a copy of a key at a given index.
|
|
45647
|
+
*
|
|
45472
45648
|
* - **ThreadSafety**: Unsafe
|
|
45473
45649
|
*
|
|
45474
45650
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeyAtIndex)
|
|
45651
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate a any type of value.
|
|
45652
|
+
* @param index The index in the existing set of keys held by this `ValueCurve`.
|
|
45475
45653
|
*/
|
|
45476
45654
|
GetKeyAtIndex(this: ValueCurve, index: number): ValueCurveKey;
|
|
45477
45655
|
/**
|
|
45656
|
+
* Returns the index of the last and first key of a period of time.
|
|
45657
|
+
*
|
|
45478
45658
|
* - **ThreadSafety**: Unsafe
|
|
45479
45659
|
*
|
|
45480
45660
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeyIndicesAtTime)
|
|
45661
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate a any type of value.
|
|
45662
|
+
* @param time A time during the animation. Inputs will be clamped between `0` and the time of the last key held by this `ValueCurve`.
|
|
45481
45663
|
*/
|
|
45482
45664
|
GetKeyIndicesAtTime(this: ValueCurve, time: number): Array<unknown>;
|
|
45483
45665
|
/**
|
|
45666
|
+
* Returns a copy of all the keys in the ValueCurve as a Luau array of `ValueCurveKeys`.
|
|
45667
|
+
*
|
|
45484
45668
|
* - **ThreadSafety**: Unsafe
|
|
45485
45669
|
*
|
|
45486
45670
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeys)
|
|
45671
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate a any type of value.
|
|
45672
|
+
* @returns Array of `ValueCurveKeys`.
|
|
45487
45673
|
*/
|
|
45488
45674
|
GetKeys(this: ValueCurve): Array<unknown>;
|
|
45489
45675
|
/**
|
|
45676
|
+
* Samples the value curve at a given time passed as argument.
|
|
45677
|
+
*
|
|
45490
45678
|
* - **ThreadSafety**: Unsafe
|
|
45491
45679
|
*
|
|
45492
45680
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetValueAtTime)
|
|
45681
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate a any type of value.
|
|
45682
|
+
* @param time Time at which to sample the curve.
|
|
45683
|
+
* @returns Value of the curve at the requested `time`.
|
|
45493
45684
|
*/
|
|
45494
45685
|
GetValueAtTime(this: ValueCurve, time: number): unknown | undefined;
|
|
45495
45686
|
/**
|
|
45687
|
+
* Adds the key passed as an argument to this curve. If a key at the same time is found, it will be replaced.
|
|
45688
|
+
*
|
|
45496
45689
|
* - **ThreadSafety**: Unsafe
|
|
45497
45690
|
*
|
|
45498
45691
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#InsertKey)
|
|
45692
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate a any type of value.
|
|
45693
|
+
* @param key `ValueCurveKey` to insert.
|
|
45694
|
+
* @returns (see description)
|
|
45499
45695
|
*/
|
|
45500
45696
|
InsertKey(this: ValueCurve, key: ValueCurveKey): Array<unknown>;
|
|
45501
45697
|
/**
|
|
45698
|
+
* Creates a key for the given value and inserts it at the given time. If a key at the same time is found, it will be replaced.
|
|
45699
|
+
*
|
|
45502
45700
|
* - **ThreadSafety**: Unsafe
|
|
45503
45701
|
*
|
|
45504
45702
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#InsertKeyValue)
|
|
45703
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate a any type of value.
|
|
45704
|
+
* @param time Time at which to insert the new `ValueCurveKey`. - type: number
|
|
45705
|
+
* @param value Value of the inserted `ValueCurveKey`. - type: any
|
|
45706
|
+
* @param Interpolation Interpolation mode of the inserted `ValueCurveKey`. - type: KeyInterpolationMode
|
|
45707
|
+
* @returns (see description)
|
|
45505
45708
|
*/
|
|
45506
45709
|
InsertKeyValue(this: ValueCurve, time: number, value: unknown, keyInterpolationMode?: CastsToEnum<Enum.KeyInterpolationMode>): Array<unknown>;
|
|
45507
45710
|
/**
|
|
45711
|
+
* Removes a given number of keys starting from a given index.
|
|
45712
|
+
*
|
|
45508
45713
|
* - **ThreadSafety**: Unsafe
|
|
45509
45714
|
*
|
|
45510
45715
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#RemoveKeyAtIndex)
|
|
45716
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate a any type of value.
|
|
45717
|
+
* @param startingIndex Starting index from which to remove keys.
|
|
45718
|
+
* @param count Number of keys to remove.
|
|
45719
|
+
* @returns Number of keys removed.
|
|
45511
45720
|
*/
|
|
45512
45721
|
RemoveKeyAtIndex(this: ValueCurve, startingIndex: number, count?: number): number;
|
|
45513
45722
|
/**
|
|
45723
|
+
* Resets this curve's keys using the `ValueCurveKey` array passed as an argument.
|
|
45724
|
+
*
|
|
45514
45725
|
* - **ThreadSafety**: Unsafe
|
|
45515
45726
|
*
|
|
45516
45727
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#SetKeys)
|
|
45728
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate a any type of value.
|
|
45729
|
+
* @param keys Array of `ValueCurveKeys`.
|
|
45730
|
+
* @returns Number of keys inserted.
|
|
45517
45731
|
*/
|
|
45518
45732
|
SetKeys(this: ValueCurve, keys: Array<unknown>): number;
|
|
45519
45733
|
}
|
|
@@ -46499,6 +46713,16 @@ interface WebStreamClient extends RBXObject {
|
|
|
46499
46713
|
* @param this Maintains a streaming connection.
|
|
46500
46714
|
*/
|
|
46501
46715
|
Close(this: WebStreamClient): void;
|
|
46716
|
+
/**
|
|
46717
|
+
* Enqueues data to be transmitted to the server over the streaming connection.
|
|
46718
|
+
*
|
|
46719
|
+
* - **ThreadSafety**: Unsafe
|
|
46720
|
+
*
|
|
46721
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Send)
|
|
46722
|
+
* @param this Maintains a streaming connection.
|
|
46723
|
+
* @param data Text string to send to the server.
|
|
46724
|
+
*/
|
|
46725
|
+
Send(this: WebStreamClient, data: string): void;
|
|
46502
46726
|
/**
|
|
46503
46727
|
* - **ThreadSafety**: Unsafe
|
|
46504
46728
|
*
|