@rbxts/types 1.0.809 → 1.0.811

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.
@@ -159,6 +159,7 @@ interface Services {
159
159
  StudioPublishService: StudioPublishService;
160
160
  StudioScriptDebugEventListener: StudioScriptDebugEventListener;
161
161
  StudioSdkService: StudioSdkService;
162
+ StudioUserService: StudioUserService;
162
163
  StudioWidgetsService: StudioWidgetsService;
163
164
  StylingService: StylingService;
164
165
  TeamCreateData: TeamCreateData;
@@ -225,6 +226,7 @@ interface CreatableInstances {
225
226
  AudioFader: AudioFader;
226
227
  AudioFilter: AudioFilter;
227
228
  AudioFlanger: AudioFlanger;
229
+ AudioLimiter: AudioLimiter;
228
230
  AudioListener: AudioListener;
229
231
  AudioPitchShifter: AudioPitchShifter;
230
232
  AudioPlayer: AudioPlayer;
@@ -1712,7 +1714,7 @@ interface Animation extends Instance {
1712
1714
  *
1713
1715
  * Note, the animation will need to be loaded onto an [AnimationTrack](https://developer.roblox.com/en-us/api-reference/class/AnimationTrack) in order to play it.
1714
1716
  */
1715
- AnimationId: string;
1717
+ AnimationId: ContentId;
1716
1718
  }
1717
1719
 
1718
1720
  interface AnimationClip extends Instance {
@@ -1816,12 +1818,12 @@ interface AnimationClipProvider extends Instance {
1816
1818
  * @deprecated
1817
1819
  */
1818
1820
  readonly _nominal_AnimationClipProvider: unique symbol;
1819
- RegisterActiveAnimationClip(this: AnimationClipProvider, animationClip: AnimationClip): string;
1820
- RegisterAnimationClip(this: AnimationClipProvider, animationClip: AnimationClip): string;
1821
+ RegisterActiveAnimationClip(this: AnimationClipProvider, animationClip: AnimationClip): ContentId;
1822
+ RegisterAnimationClip(this: AnimationClipProvider, animationClip: AnimationClip): ContentId;
1821
1823
  /**
1822
1824
  * Tags: Yields
1823
1825
  */
1824
- GetAnimationClipAsync(this: AnimationClipProvider, assetId: string): AnimationClip;
1826
+ GetAnimationClipAsync(this: AnimationClipProvider, assetId: ContentId): AnimationClip;
1825
1827
  /**
1826
1828
  * Tags: Yields
1827
1829
  */
@@ -1829,7 +1831,7 @@ interface AnimationClipProvider extends Instance {
1829
1831
  /**
1830
1832
  * Tags: Yields
1831
1833
  */
1832
- GetClipEvaluatorAsync(this: AnimationClipProvider, assetId: string): ClipEvaluator;
1834
+ GetClipEvaluatorAsync(this: AnimationClipProvider, assetId: ContentId): ClipEvaluator;
1833
1835
  }
1834
1836
 
1835
1837
  /** An object which allows animations to be loaded and applied to a character or model in place of a [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) when a Humanoid is not needed. Creates an [Animator](https://developer.roblox.com/en-us/api-reference/class/Animator) and loads animations to update [Motor6Ds](https://developer.roblox.com/en-us/api-reference/class/Motor6D) of said character to react in the way that is described within the animation asset referenced by an [Animation](https://developer.roblox.com/en-us/api-reference/class/Animation) object.
@@ -2430,11 +2432,11 @@ interface AssetService extends Instance {
2430
2432
  /**
2431
2433
  * Tags: Yields
2432
2434
  */
2433
- CreateEditableImageAsync(this: AssetService, textureId: string): EditableImage;
2435
+ CreateEditableImageAsync(this: AssetService, textureId: ContentId): EditableImage;
2434
2436
  /**
2435
2437
  * Tags: Yields
2436
2438
  */
2437
- CreateEditableMeshAsync(this: AssetService, meshId: string): EditableMesh;
2439
+ CreateEditableMeshAsync(this: AssetService, meshId: ContentId): EditableMesh;
2438
2440
  /**
2439
2441
  * Tags: Yields
2440
2442
  */
@@ -3064,6 +3066,21 @@ interface AudioFocusService extends Instance {
3064
3066
  readonly _nominal_AudioFocusService: unique symbol;
3065
3067
  }
3066
3068
 
3069
+ interface AudioLimiter extends Instance {
3070
+ /**
3071
+ * **DO NOT USE!**
3072
+ *
3073
+ * This field exists to force TypeScript to recognize this as a nominal type
3074
+ * @hidden
3075
+ * @deprecated
3076
+ */
3077
+ readonly _nominal_AudioLimiter: unique symbol;
3078
+ Bypass: boolean;
3079
+ MaxLevel: number;
3080
+ Release: number;
3081
+ GetConnectedWires(this: AudioLimiter, pin: string): Array<Instance>;
3082
+ }
3083
+
3067
3084
  interface AudioListener extends Instance {
3068
3085
  /**
3069
3086
  * **DO NOT USE!**
@@ -3222,11 +3239,15 @@ interface AvatarCreationService extends Instance {
3222
3239
  /**
3223
3240
  * Tags: Yields
3224
3241
  */
3225
- GenerateAvatarPreviewAsync2(this: AvatarCreationService, sessionId: string, fileId: string, textPrompt: string): string;
3242
+ GenerateAvatarPreviewAsync2(this: AvatarCreationService, sessionId: string, fileId: string, textPrompt: string, options: object): string;
3226
3243
  /**
3227
3244
  * Tags: Yields
3228
3245
  */
3229
3246
  GetAvatarGenerationConfig(this: AvatarCreationService): object;
3247
+ /**
3248
+ * Tags: Yields
3249
+ */
3250
+ GetBatchTokenDetailsAsync(this: AvatarCreationService, tokenIds: Array<any>): unknown;
3230
3251
  /**
3231
3252
  * Tags: Yields
3232
3253
  */
@@ -3243,6 +3264,10 @@ interface AvatarCreationService extends Instance {
3243
3264
  * Tags: Yields
3244
3265
  */
3245
3266
  PromptCreateAvatarAsync(this: AvatarCreationService, player: Player, humanoidDescription: HumanoidDescription): unknown;
3267
+ /**
3268
+ * Tags: Yields
3269
+ */
3270
+ PromptSelectAvatarGenerationImageAsync(this: AvatarCreationService, player: Player): string;
3246
3271
  /**
3247
3272
  * Tags: Yields
3248
3273
  */
@@ -5054,7 +5079,7 @@ interface BaseWrap extends Instance {
5054
5079
  *
5055
5080
  * Asset ID for cage mesh.
5056
5081
  */
5057
- CageMeshId: string;
5082
+ CageMeshId: ContentId;
5058
5083
  /**
5059
5084
  * This property is set up automatically by the Avatar Importer plugin.
5060
5085
  *
@@ -5122,9 +5147,11 @@ interface WrapDeformer extends BaseWrap {
5122
5147
  * @deprecated
5123
5148
  */
5124
5149
  readonly _nominal_WrapDeformer: unique symbol;
5125
- Amount: number;
5126
- Enabled: boolean;
5127
- RenderMeshID: string;
5150
+ GetDeformedCFrame(this: WrapDeformer, originalCFrame: CFrame): CFrame;
5151
+ /**
5152
+ * Tags: Yields
5153
+ */
5154
+ CreateEditableMeshAsync(this: WrapDeformer): EditableMesh;
5128
5155
  }
5129
5156
 
5130
5157
  /** The WrapLayer object defines a 3D accessory's inner and outer surfaces and other properties related to layering accessories. These surfaces, or the Inner Cage and Outer Cage, are similar to collision boxes, and describe the surfaces of which other 3D accessories can be placed without clipping or breaking.
@@ -5168,7 +5195,7 @@ interface WrapLayer extends BaseWrap {
5168
5195
  *
5169
5196
  * Note: this property is set up automatically by the FBX importer
5170
5197
  */
5171
- ReferenceMeshId: string;
5198
+ ReferenceMeshId: ContentId;
5172
5199
  /**
5173
5200
  * Reference mesh offset relative to parent MeshPart (in the parent MeshPart space)
5174
5201
  *
@@ -5425,7 +5452,7 @@ interface Beam extends Instance {
5425
5452
  *
5426
5453
  * The scaling of the texture is determined by the [Beam.TextureMode](https://developer.roblox.com/en-us/api-reference/property/Beam/TextureMode), [Beam.TextureLength](https://developer.roblox.com/en-us/api-reference/property/Beam/TextureLength), [Beam.Width0](https://developer.roblox.com/en-us/api-reference/property/Beam/Width0) and [Beam.Width1](https://developer.roblox.com/en-us/api-reference/property/Beam/Width1) properties.
5427
5454
  */
5428
- Texture: string;
5455
+ Texture: ContentId;
5429
5456
  /**
5430
5457
  * Sets the length of the [Beam](https://developer.roblox.com/en-us/api-reference/class/Beam)s texture if [Beam.TextureMode](https://developer.roblox.com/en-us/api-reference/property/Beam/TextureMode) is 'Wrap' or 'Static'. If [Beam.TextureMode](https://developer.roblox.com/en-us/api-reference/property/Beam/TextureMode) is 'Stretch' then it determines the size of the texture relative to the [Beam](https://developer.roblox.com/en-us/api-reference/class/Beam)'s length.
5431
5458
  *
@@ -6297,23 +6324,6 @@ interface Breakpoint extends Instance {
6297
6324
  readonly _nominal_Breakpoint: unique symbol;
6298
6325
  }
6299
6326
 
6300
- interface BubbleChatMessageProperties extends Instance {
6301
- /**
6302
- * **DO NOT USE!**
6303
- *
6304
- * This field exists to force TypeScript to recognize this as a nominal type
6305
- * @hidden
6306
- * @deprecated
6307
- */
6308
- readonly _nominal_BubbleChatMessageProperties: unique symbol;
6309
- BackgroundColor3: Color3;
6310
- BackgroundTransparency: number;
6311
- FontFace: Font;
6312
- TailVisible: boolean;
6313
- TextColor3: Color3;
6314
- TextSize: number;
6315
- }
6316
-
6317
6327
  interface BulkImportService extends Instance {
6318
6328
  /**
6319
6329
  * **DO NOT USE!**
@@ -6929,7 +6939,7 @@ interface CaptureService extends Instance {
6929
6939
  * @deprecated Use `UserCaptureSaved` instead
6930
6940
  */
6931
6941
  readonly CaptureSaved: RBXScriptSignal<(captureInfo: Record<string, unknown>) => void>;
6932
- readonly UserCaptureSaved: RBXScriptSignal<(captureContentId: string) => void>;
6942
+ readonly UserCaptureSaved: RBXScriptSignal<(captureContentId: ContentId) => void>;
6933
6943
  }
6934
6944
 
6935
6945
  /** Base class for objects that change a character's appearance. */
@@ -7111,7 +7121,7 @@ interface Pants extends Clothing {
7111
7121
  *
7112
7122
  * For a [Shirt](https://developer.roblox.com/en-us/api-reference/class/Shirt) object's template, see [Shirt.ShirtTemplate](https://developer.roblox.com/en-us/api-reference/property/Shirt/ShirtTemplate).
7113
7123
  */
7114
- PantsTemplate: string;
7124
+ PantsTemplate: ContentId;
7115
7125
  }
7116
7126
 
7117
7127
  /** ![A default rig wearing a very dapper Shirt (rbxassetid://86896487)](https://developer.roblox.com/assets/bltc8da647cb0295112/Shirt.jpg) The **Shirt** object displays a Shirt texture from the Roblox website on a [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) rig. Shirts cover the torso and arms, and will take priority over a [Pants](https://developer.roblox.com/en-us/api-reference/class/Pants) on the torso. To be visible, a Shirt must be a sibling of a Humanoid and have its [ShirtTemplate](https://developer.roblox.com/en-us/api-reference/property/Shirt/ShirtTemplate) property set to an appropriate texture (such as `rbxassetid://86896487`, pictured to the right). The shirt texture may be colorized using the [Clothing.Color3](https://developer.roblox.com/en-us/api-reference/property/Clothing/Color3) property.
@@ -7152,7 +7162,7 @@ interface Shirt extends Clothing {
7152
7162
  * model.Parent = workspace
7153
7163
  * end
7154
7164
  */
7155
- ShirtTemplate: string;
7165
+ ShirtTemplate: ContentId;
7156
7166
  }
7157
7167
 
7158
7168
  /** The **ShirtGraphic** object applies a texture to the front surface of a character's torso. It is used to display t-shirts. */
@@ -7193,7 +7203,7 @@ interface ShirtGraphic extends CharacterAppearance {
7193
7203
  * model.Parent = workspace
7194
7204
  * end
7195
7205
  */
7196
- Graphic: string;
7206
+ Graphic: ContentId;
7197
7207
  }
7198
7208
 
7199
7209
  /** The **Chat** service houses the Lua code responsible for running the [Lua Chat System](https://developer.roblox.com/en-us/articles/lua-chat-system). Similar to [StarterPlayerScripts](https://developer.roblox.com/en-us/api-reference/class/StarterPlayerScripts), default objects like [Scripts](https://developer.roblox.com/en-us/api-reference/class/Script) and [ModuleScripts](https://developer.roblox.com/en-us/api-reference/class/ModuleScript) are inserted into the service.
@@ -7396,7 +7406,7 @@ interface ClickDetector extends Instance {
7396
7406
  *
7397
7407
  * ![Custom cursor icon](https://developer.roblox.com/assets/blt59eec7aa0c76851a/InterestCursorIcon.png)
7398
7408
  */
7399
- CursorIcon: string;
7409
+ CursorIcon: ContentId;
7400
7410
  /**
7401
7411
  * The MaxActivationDistance property controls the maximum distance, in studs, between a [Character](https://developer.roblox.com/en-us/api-reference/property/Player/Character) and the [ClickDetector](https://developer.roblox.com/en-us/api-reference/class/ClickDetector) for the character to be able to click it. This is used to limit from how far a player can interact with a ClickDetector.
7402
7412
  *
@@ -7456,7 +7466,7 @@ interface DragDetector extends ClickDetector {
7456
7466
  * @deprecated
7457
7467
  */
7458
7468
  readonly _nominal_DragDetector: unique symbol;
7459
- ActivatedCursorIcon: string;
7469
+ ActivatedCursorIcon: ContentId;
7460
7470
  ApplyAtCenterOfMass: boolean;
7461
7471
  /**
7462
7472
  * Tags: NotReplicated
@@ -9263,20 +9273,20 @@ interface ContentProvider extends Instance {
9263
9273
  * Tags: NotReplicated
9264
9274
  */
9265
9275
  readonly RequestQueueSize: number;
9266
- GetAssetFetchStatus(this: ContentProvider, contentId: string): Enum.AssetFetchStatus;
9267
- GetAssetFetchStatusChangedSignal(this: ContentProvider, contentId: string): RBXScriptSignal;
9276
+ GetAssetFetchStatus(this: ContentProvider, contentId: ContentId): Enum.AssetFetchStatus;
9277
+ GetAssetFetchStatusChangedSignal(this: ContentProvider, contentId: ContentId): RBXScriptSignal;
9268
9278
  ListEncryptedAssets(this: ContentProvider): unknown;
9269
9279
  /**
9270
9280
  * Usually, content is loaded only when it starts being used. That explains why it often takes a moment for an image to appear in a [GUI](https://developer.roblox.com/en-us/api-reference/class/GuiObject), or a [mesh](https://developer.roblox.com/en-us/api-reference/class/Mesh) to appear in a [part](https://developer.roblox.com/en-us/api-reference/class/BasePart), or why a [sound](https://developer.roblox.com/en-us/api-reference/class/Sound) doesn't play for the first time. All because the asset has not yet finished loading. Preload is used to load this content beforehand, so that it works instantly.
9271
9281
  * @deprecated Use `PreloadAsync` instead
9272
9282
  */
9273
- Preload(this: ContentProvider, contentId: string): void;
9283
+ Preload(this: ContentProvider, contentId: ContentId): void;
9274
9284
  RegisterDefaultEncryptionKey(this: ContentProvider, encryptionKey: string): void;
9275
9285
  RegisterDefaultSessionKey(this: ContentProvider, sessionKey: string): void;
9276
- RegisterEncryptedAsset(this: ContentProvider, assetId: string, encryptionKey: string): void;
9277
- RegisterSessionEncryptedAsset(this: ContentProvider, contentId: string, sessionKey: string): void;
9286
+ RegisterEncryptedAsset(this: ContentProvider, assetId: ContentId, encryptionKey: string): void;
9287
+ RegisterSessionEncryptedAsset(this: ContentProvider, contentId: ContentId, sessionKey: string): void;
9278
9288
  UnregisterDefaultEncryptionKey(this: ContentProvider): void;
9279
- UnregisterEncryptedAsset(this: ContentProvider, assetId: string): void;
9289
+ UnregisterEncryptedAsset(this: ContentProvider, assetId: ContentId): void;
9280
9290
  /**
9281
9291
  * Yields until all of the assets associated with the given [Instances](https://developer.roblox.com/en-us/api-reference/class/Instance) have loaded and takes an array of [Instances](https://developer.roblox.com/en-us/api-reference/class/Instance) as a parameter.
9282
9292
  *
@@ -9291,7 +9301,7 @@ interface ContentProvider extends Instance {
9291
9301
  contentIdList: Array<Instance | string>,
9292
9302
  callback?: (contentId: string, status: Enum.AssetFetchStatus) => void,
9293
9303
  ): void;
9294
- readonly AssetFetchFailed: RBXScriptSignal<(assetId: string) => void>;
9304
+ readonly AssetFetchFailed: RBXScriptSignal<(assetId: ContentId) => void>;
9295
9305
  }
9296
9306
 
9297
9307
  /** ContextActionService is a game service that allows a game to bind user input to contextual actions, or actions that are only enabled under some condition or period of time. For example, allowing a player to open a door only while close by. In code, an action is simply a string (the name of the action) used by the service to differentiate between unique actions. The action string is provided to [BindAction](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/BindAction) and [UnbindAction](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/UnbindAction), among other member functions. If two actions are bound to the same input, the most recently bound will take priority. When the most recent action is unbound, the one bound before that takes control again. Since ContextActionService deals with user input, you can only use it in [LocalScripts](https://developer.roblox.com/en-us/api-reference/class/LocalScript) which run on the client.
@@ -10158,7 +10168,7 @@ interface FileMesh extends DataModelMesh {
10158
10168
  *
10159
10169
  * Meshes can currently only be be uploaded using [MeshPart](https://developer.roblox.com/en-us/api-reference/class/MeshPart)s or the game explorer. Once uploaded however, the content ID for the mesh can be used for the MeshId property. For more information on how to do this please see [this tutorial](https://developer.roblox.com/en-us/articles/mesh-parts).
10160
10170
  */
10161
- MeshId: string;
10171
+ MeshId: ContentId;
10162
10172
  /**
10163
10173
  * The TextureId is the content ID of the image that is to be applied to used for the meshes texture. When the TextureId property is set to an empty string, no texture will be applied to the mesh.
10164
10174
  *
@@ -10174,7 +10184,7 @@ interface FileMesh extends DataModelMesh {
10174
10184
  *
10175
10185
  * A mesh can only be textured if the mesh has been UV mapped. UV mapping refers to the practice of projecting a texture map onto a mesh. This cannot be done using Roblox Studio and has to be done using an external 3D modelling application such as [Blender](https://www.blender.org/).
10176
10186
  */
10177
- TextureId: string;
10187
+ TextureId: ContentId;
10178
10188
  }
10179
10189
 
10180
10190
  /** The SpecialMesh is an object that allows developers to provide a standard template or user uploaded mesh to a [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart).
@@ -11454,7 +11464,7 @@ interface Decal extends FaceInstance {
11454
11464
  * * Paste the URL into the Texture property in Roblox Studio. Roblox will automatically update the property to the correct Content ID. Note this only works in Roblox Studio and cannot be done from Scripts or whilst the game is running.
11455
11465
  * * Insert the Decal into the game, this is generally done through the Toolbox under 'My Decals'. The Content ID can be found in the decal that is inserted. Note, [InsertService:LoadAsset](https://developer.roblox.com/en-us/api-reference/function/InsertService/LoadAsset) can also be used if developers wish to automate this method.
11456
11466
  */
11457
- Texture: string;
11467
+ Texture: ContentId;
11458
11468
  /**
11459
11469
  * Determines the transparency of the [Decal](https://developer.roblox.com/en-us/api-reference/class/Decal) with 0 being completely opaque and 1 completely transparent.
11460
11470
  *
@@ -13451,11 +13461,11 @@ interface ImageButton extends GuiButton {
13451
13461
  /**
13452
13462
  * A textureId that could be set on the [ImageButton's](https://developer.roblox.com/en-us/api-reference/class/ImageButton) properties. When the button is hovered, it will render HoverImage if specified.
13453
13463
  */
13454
- HoverImage: string;
13464
+ HoverImage: ContentId;
13455
13465
  /**
13456
13466
  * The Image property is a content-type property that should hold the asset ID of a Decal or Image on the Roblox website. It functions identically to [Decal.Texture](https://developer.roblox.com/en-us/api-reference/property/Decal/Texture) with regards to loading the image from the Roblox website. The rendered image will be colorized using [ImageButton.ImageColor3](https://developer.roblox.com/en-us/api-reference/property/ImageButton/ImageColor3). It is possible to make the image render as tiled, scaled to fit, or 9-sliced, by adjusting the [ImageButton.ScaleType](https://developer.roblox.com/en-us/api-reference/property/ImageButton/ScaleType) property.
13457
13467
  */
13458
- Image: string;
13468
+ Image: ContentId;
13459
13469
  /**
13460
13470
  * The ImageColor3 property determines how an image is colorized. When set to white, no colorization occurs. This property is very useful for reusing image assets: If the source image is completely white with transparency, you can set the entire color of the image at once with this property.
13461
13471
  */
@@ -13485,7 +13495,7 @@ interface ImageButton extends GuiButton {
13485
13495
  /**
13486
13496
  * A texture ID that can be set as an [ImageButton](https://developer.roblox.com/en-us/api-reference/class/ImageButton) property. When the button is pressed, it will render this image.
13487
13497
  */
13488
- PressedImage: string;
13498
+ PressedImage: ContentId;
13489
13499
  /**
13490
13500
  * Determines how the image looks when it is scaled.
13491
13501
  *
@@ -13784,7 +13794,7 @@ interface ImageLabel extends GuiLabel {
13784
13794
  /**
13785
13795
  * The Image property is a content-type property that should hold the asset ID of a Decal or Image on the Roblox website. It functions identically to [Decal.Texture](https://developer.roblox.com/en-us/api-reference/property/Decal/Texture) with regards to loading the image from the Roblox website. The rendered image will be colorized using [ImageLabel.ImageColor3](https://developer.roblox.com/en-us/api-reference/property/ImageLabel/ImageColor3). It is possible to make the image render as tiled, scaled to fit, or 9-sliced, by adjusting the [ImageLabel.ScaleType](https://developer.roblox.com/en-us/api-reference/property/ImageLabel/ScaleType) property.
13786
13796
  */
13787
- Image: string;
13797
+ Image: ContentId;
13788
13798
  /**
13789
13799
  * The ImageColor3 property determines how an image is colorized. When set to white, no colorization occurs. This property is very useful for reusing image assets: If the source image is completely white with transparency, you can set the entire color of the image at once with this property.
13790
13800
  */
@@ -14111,7 +14121,7 @@ interface ScrollingFrame extends GuiObject {
14111
14121
  /**
14112
14122
  * The Down image on the vertical scrollbar. Size of this is always ScrollBarThickness by ScrollBarThickness. This is also used as the image on the horizontal scroll bar.
14113
14123
  */
14114
- BottomImage: string;
14124
+ BottomImage: ContentId;
14115
14125
  /**
14116
14126
  * The location within the canvas, in pixels, that should be drawn at the top left of the scroll frame
14117
14127
  */
@@ -14170,7 +14180,7 @@ interface ScrollingFrame extends GuiObject {
14170
14180
  /**
14171
14181
  * The middle image on the vertical scrollbar. The size of this can vary in the y direction, but is always set as [ScrollingFrame.ScrollBarThickness](https://developer.roblox.com/en-us/api-reference/property/ScrollingFrame/ScrollBarThickness) in the x direction. This is also used as the middle image on the horizontal scroll bar.
14172
14182
  */
14173
- MidImage: string;
14183
+ MidImage: ContentId;
14174
14184
  /**
14175
14185
  * Determines how a scrolling bar image is colorized. When set to white, no colorization occurs. This property is very useful for reusing image assets: If the source image is completely white with transparency, you can set the entire color of the image at once with this property.
14176
14186
  */
@@ -14238,7 +14248,7 @@ interface ScrollingFrame extends GuiObject {
14238
14248
  /**
14239
14249
  * The Up image on the vertical scrollbar. The size of this is always ScrollBarThickness by ScrollBarThickness. This is also used as the left image on the horizontal scroll bar.
14240
14250
  */
14241
- TopImage: string;
14251
+ TopImage: ContentId;
14242
14252
  /**
14243
14253
  * Indicates the inset behavior of the vertical scrolling bar.
14244
14254
  */
@@ -14608,7 +14618,7 @@ interface VideoFrame extends GuiObject {
14608
14618
  /**
14609
14619
  * The content ID of the video file a [VideoFrame](https://developer.roblox.com/en-us/api-reference/class/VideoFrame) object is associated with.
14610
14620
  */
14611
- Video: string;
14621
+ Video: ContentId;
14612
14622
  /**
14613
14623
  * This property determines how loud the [VideoFrame.Video](https://developer.roblox.com/en-us/api-reference/property/VideoFrame/Video) plays back. It can be set to a number between 0 and 100.
14614
14624
  */
@@ -15116,7 +15126,7 @@ interface AdGui extends SurfaceGuiBase {
15116
15126
  readonly _nominal_AdGui: unique symbol;
15117
15127
  AdShape: Enum.AdShape;
15118
15128
  EnableVideoAds: boolean;
15119
- FallbackImage: string;
15129
+ FallbackImage: ContentId;
15120
15130
  /**
15121
15131
  * Tags: NotReplicated
15122
15132
  */
@@ -15261,7 +15271,7 @@ interface FloorWire extends GuiBase3d {
15261
15271
  /**
15262
15272
  * Sets the texture to be displayed on the FloorWire.
15263
15273
  */
15264
- Texture: string;
15274
+ Texture: ContentId;
15265
15275
  /**
15266
15276
  * Sets the size of the texture used with the FloorWire.
15267
15277
  */
@@ -15523,7 +15533,7 @@ interface ImageHandleAdornment extends HandleAdornment {
15523
15533
  /**
15524
15534
  * The image to draw for the adornment.
15525
15535
  */
15526
- Image: string;
15536
+ Image: ContentId;
15527
15537
  /**
15528
15538
  * The size in studs of the image.
15529
15539
  */
@@ -19985,7 +19995,7 @@ interface InsertService extends Instance {
19985
19995
  /**
19986
19996
  * Tags: Yields
19987
19997
  */
19988
- CreateMeshPartAsync(this: InsertService, meshId: string, collisionFidelity: CastsToEnum<Enum.CollisionFidelity>, renderFidelity: CastsToEnum<Enum.RenderFidelity>): MeshPart;
19998
+ CreateMeshPartAsync(this: InsertService, meshId: ContentId, collisionFidelity: CastsToEnum<Enum.CollisionFidelity>, renderFidelity: CastsToEnum<Enum.RenderFidelity>): MeshPart;
19989
19999
  /**
19990
20000
  * Tags: Yields
19991
20001
  * @deprecated Use `GetBaseSets` instead
@@ -20775,7 +20785,7 @@ interface KeyframeSequenceProvider extends Instance {
20775
20785
  *
20776
20786
  * The asset ID generated by this function is temporary and cannot be used outside of Studio. Developers wishing to generate an asset ID that can be used online should upload the [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) to Roblox.
20777
20787
  */
20778
- RegisterActiveKeyframeSequence(this: KeyframeSequenceProvider, keyframeSequence: KeyframeSequence): string;
20788
+ RegisterActiveKeyframeSequence(this: KeyframeSequenceProvider, keyframeSequence: KeyframeSequence): ContentId;
20779
20789
  /**
20780
20790
  * Generates a temporary asset ID from a [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) that can be used for localized testing of an animation.
20781
20791
  *
@@ -20785,7 +20795,7 @@ interface KeyframeSequenceProvider extends Instance {
20785
20795
  *
20786
20796
  * The asset ID generated by this function is temporary and cannot be used outside of Studio. Developers wishing to generate an asset ID that can be used online should upload the [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) to Roblox.
20787
20797
  */
20788
- RegisterKeyframeSequence(this: KeyframeSequenceProvider, keyframeSequence: KeyframeSequence): string;
20798
+ RegisterKeyframeSequence(this: KeyframeSequenceProvider, keyframeSequence: KeyframeSequence): ContentId;
20789
20799
  /**
20790
20800
  * This function returns an [InventoryPages](https://developer.roblox.com/en-us/api-reference/class/InventoryPages) object which can be used to iterate over animations owned by a specific user.
20791
20801
  *
@@ -22836,7 +22846,7 @@ interface BaseScript extends LuaSourceContainer {
22836
22846
  * For the LinkedSource property for [ModuleScript](https://developer.roblox.com/en-us/api-reference/class/ModuleScript)s, please see [ModuleScript.LinkedSource](https://developer.roblox.com/en-us/api-reference/property/ModuleScript/LinkedSource).
22837
22847
  * @deprecated
22838
22848
  */
22839
- LinkedSource: string;
22849
+ LinkedSource: ContentId;
22840
22850
  RunContext: Enum.RunContext;
22841
22851
  }
22842
22852
 
@@ -22859,6 +22869,18 @@ interface Script extends BaseScript {
22859
22869
  * @deprecated
22860
22870
  */
22861
22871
  readonly _nominal_Script: unique symbol;
22872
+ /**
22873
+ * A script's Source is the code to be executed. Modifying the code within a script modifies the source code executes when the script runs.
22874
+ *
22875
+ * For instance, given a script containing the line:
22876
+ *
22877
+ * print("Hello world!")
22878
+ *
22879
+ * The script's source is the “print(“Hello world”)” command because it is what will be executed when the script runs, leading to “Hello world” being printed in the command line.
22880
+ *
22881
+ * This item is protected. Attempting to use it in a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) or [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript) will cause an error.
22882
+ */
22883
+ Source: string;
22862
22884
  }
22863
22885
 
22864
22886
  /** A LocalScript is a Lua source container that runs Lua code on a client connected to a Roblox server. They are used to access client-only objects, such as the player's [Camera](https://developer.roblox.com/en-us/api-reference/class/Camera). For code run through LocalScripts, the LocalPlayer property of the [Players](https://developer.roblox.com/en-us/api-reference/class/Players) service will return the player whose client is running the script.
@@ -22905,7 +22927,11 @@ interface ModuleScript extends LuaSourceContainer {
22905
22927
  * Used to store a URL that points to an online script source. Binds the online code to the script's [Script.Source](https://developer.roblox.com/en-us/api-reference/property/Script/Source).
22906
22928
  * @deprecated
22907
22929
  */
22908
- LinkedSource: string;
22930
+ LinkedSource: ContentId;
22931
+ /**
22932
+ * The code to be executed.
22933
+ */
22934
+ Source: string;
22909
22935
  }
22910
22936
 
22911
22937
  interface LuauScriptAnalyzerService extends Instance {
@@ -23939,7 +23965,7 @@ interface Mouse extends Instance {
23939
23965
  *
23940
23966
  * \* These appearances are approximations – the actual look is dependent on your operating system.
23941
23967
  */
23942
- Icon: string;
23968
+ Icon: ContentId;
23943
23969
  /**
23944
23970
  * The origin [Mouse](https://developer.roblox.com/en-us/api-reference/class/Mouse) property is a [CFrame](https://developer.roblox.com/en-us/api-reference/datatype/CFrame) indicating where the mouse originated from. It is positioned at the [Workspace.CurrentCamera](https://developer.roblox.com/en-us/api-reference/property/Workspace/CurrentCamera) and oriented toward the [Mouse](https://developer.roblox.com/en-us/api-reference/class/Mouse)'s 3D position.
23945
23971
  *
@@ -26048,7 +26074,7 @@ interface MeshPart extends TriangleMeshPart {
26048
26074
  *
26049
26075
  * Note that this property currently cannot be changed by scripts as the collision model of the mesh cannot be recomputed during runtime. Developers should not rely on this behavior as it may change in the future. Those looking for a custom mesh object that can be updated during runtime should use [SpecialMesh](https://developer.roblox.com/en-us/api-reference/class/SpecialMesh).
26050
26076
  */
26051
- readonly MeshId: string;
26077
+ readonly MeshId: ContentId;
26052
26078
  /**
26053
26079
  * This property determines the level of detail that solid-modeled and mesh parts will be shown in and can be set to the possible values of the [RenderFidelity](https://developer.roblox.com/en-us/api-reference/enum/RenderFidelity) enum.
26054
26080
  *
@@ -26097,7 +26123,7 @@ interface MeshPart extends TriangleMeshPart {
26097
26123
  *
26098
26124
  * A mesh can only be textured if the mesh has been UV mapped. UV mapping refers to the practice of projecting a texture map onto a mesh. This cannot be done using Roblox Studio and has to be done using an external 3D modelling application such as [Blender](https://www.blender.org/).
26099
26125
  */
26100
- TextureID: string;
26126
+ TextureID: ContentId;
26101
26127
  ApplyMesh(this: MeshPart, meshPart: MeshPart): void;
26102
26128
  }
26103
26129
 
@@ -26524,7 +26550,7 @@ interface BackpackItem extends Model {
26524
26550
  *
26525
26551
  * If this property is left blank, the [Backpack](https://developer.roblox.com/en-us/api-reference/class/Backpack) GUI will display the name of the tool instead.
26526
26552
  */
26527
- TextureId: string;
26553
+ TextureId: ContentId;
26528
26554
  }
26529
26555
 
26530
26556
  /** Tools are objects that a [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) object can equip. For players, they are stored in a [Backpack](https://developer.roblox.com/en-us/api-reference/class/Backpack) object parented to a [Player](https://developer.roblox.com/en-us/api-reference/class/Player) object. In-game, players may have multiple tools which appear as icons at the bottom of the screen. Equipping a tool moves it from the Backpack and into a player's [character](https://developer.roblox.com/en-us/api-reference/class/Character) model in the [Workspace](https://developer.roblox.com/en-us/api-reference/class/Workspace). By default, tools are held in the right hand and have a handle in them, which is a [Part](https://developer.roblox.com/en-us/api-reference/class/BasePart) named “Handle” inside (though one is not required if [Tool.RequiresHandle](https://developer.roblox.com/en-us/api-reference/property/Tool/RequiresHandle) is off). Tools that are to be provided to (re)spawning players ought to be stored in the [StarterPack](https://developer.roblox.com/en-us/api-reference/class/StarterPack).
@@ -27418,7 +27444,7 @@ interface PackageLink extends Instance {
27418
27444
  *
27419
27445
  * Tags: NotReplicated
27420
27446
  */
27421
- readonly PackageId: string;
27447
+ readonly PackageId: ContentId;
27422
27448
  /**
27423
27449
  * This property refers to a revision of a specific package
27424
27450
  *
@@ -27909,7 +27935,7 @@ interface ParticleEmitter extends Instance {
27909
27935
  * Below is an opaque gray-scale Texture that works nicely for particles with [ParticleEmitter.LightEmission](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/LightEmission) set to 1.
27910
27936
  * ![An example particle texture](https://developer.roblox.com/assets/bltf793b94e42b0b6bf/aura.png)
27911
27937
  */
27912
- Texture: string;
27938
+ Texture: ContentId;
27913
27939
  TimeScale: number;
27914
27940
  /**
27915
27941
  * The Transparency property determines the transparency of all active particles over their individual lifetimes. It works similar to [ParticleEmitter.Size](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Size) in how it affects particles over time. In terms of rendering, it works like the [BasePart.Transparency](https://developer.roblox.com/en-us/api-reference/property/BasePart/Transparency) of a part on a scale of 0 to 1, where 0 is completely visible (opaque), and a value of 1 is completely invisible (not rendered at all).
@@ -31136,7 +31162,7 @@ interface ScreenshotHud extends Instance {
31136
31162
  * @deprecated
31137
31163
  */
31138
31164
  readonly _nominal_ScreenshotHud: unique symbol;
31139
- CameraButtonIcon: string;
31165
+ CameraButtonIcon: ContentId;
31140
31166
  CameraButtonPosition: UDim2;
31141
31167
  CloseButtonPosition: UDim2;
31142
31168
  CloseWhenScreenshotTaken: boolean;
@@ -31924,31 +31950,31 @@ interface Sky extends Instance {
31924
31950
  /**
31925
31951
  * The texture of the moon while using this skybox.
31926
31952
  */
31927
- MoonTextureId: string;
31953
+ MoonTextureId: ContentId;
31928
31954
  /**
31929
31955
  * The URL link to a picture for the back surface of the sky.
31930
31956
  */
31931
- SkyboxBk: string;
31957
+ SkyboxBk: ContentId;
31932
31958
  /**
31933
31959
  * The URL asset link to a picture for the Bottom surface of the sky.
31934
31960
  */
31935
- SkyboxDn: string;
31961
+ SkyboxDn: ContentId;
31936
31962
  /**
31937
31963
  * The URL link to a picture for the front surface of the skybox.
31938
31964
  */
31939
- SkyboxFt: string;
31965
+ SkyboxFt: ContentId;
31940
31966
  /**
31941
31967
  * The URL link to a picture for the left surface of the sky.
31942
31968
  */
31943
- SkyboxLf: string;
31969
+ SkyboxLf: ContentId;
31944
31970
  /**
31945
31971
  * The URL link to a picture for the right surface of the sky.
31946
31972
  */
31947
- SkyboxRt: string;
31973
+ SkyboxRt: ContentId;
31948
31974
  /**
31949
31975
  * The URL link to a picture for the top surface of the sky.
31950
31976
  */
31951
- SkyboxUp: string;
31977
+ SkyboxUp: ContentId;
31952
31978
  /**
31953
31979
  * How many stars are shown in the skybox. Note that too many stars may cause severe lag. Only works if [Sky.CelestialBodiesShown](https://developer.roblox.com/en-us/api-reference/property/Sky/CelestialBodiesShown) is true.
31954
31980
  */
@@ -31960,7 +31986,7 @@ interface Sky extends Instance {
31960
31986
  /**
31961
31987
  * The texture of the sun while using this skybox.
31962
31988
  */
31963
- SunTextureId: string;
31989
+ SunTextureId: ContentId;
31964
31990
  }
31965
31991
 
31966
31992
  /** Smoke is one of several particle-emitting classes. Like other particle emitters of its kind, Smoke objects emit particles when parented to a [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) (such as a [Part](https://developer.roblox.com/en-us/api-reference/class/Part)) or an [Attachment](https://developer.roblox.com/en-us/api-reference/class/Attachment) within such a [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart). Compared to the [ParticleEmitter](https://developer.roblox.com/en-us/api-reference/class/ParticleEmitter) class, Smoke lacks many different customization properties and special methods, such as [ParticleEmitter.Lifetime](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Lifetime) or [ParticleEmitter:Emit](https://developer.roblox.com/en-us/api-reference/function/ParticleEmitter/Emit). It is useful to create a quick special effect in a pinch; for more detailed work it is preferable to use a [ParticleEmitter](https://developer.roblox.com/en-us/api-reference/class/ParticleEmitter) instead.
@@ -32348,7 +32374,7 @@ interface Sound extends Instance {
32348
32374
  * "http://www.roblox.com/asset/?id=12222216" -- Content ID (will work)
32349
32375
  * "rbxassetid://12222216" -- Content ID (alternative version, will work)
32350
32376
  */
32351
- SoundId: string;
32377
+ SoundId: ContentId;
32352
32378
  /**
32353
32379
  * The length of the [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) in seconds. If the [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) is not loaded, this value will be 0.
32354
32380
  *
@@ -33836,6 +33862,17 @@ interface StudioSdkService extends Instance {
33836
33862
  readonly _nominal_StudioSdkService: unique symbol;
33837
33863
  }
33838
33864
 
33865
+ interface StudioUserService extends Instance {
33866
+ /**
33867
+ * **DO NOT USE!**
33868
+ *
33869
+ * This field exists to force TypeScript to recognize this as a nominal type
33870
+ * @hidden
33871
+ * @deprecated
33872
+ */
33873
+ readonly _nominal_StudioUserService: unique symbol;
33874
+ }
33875
+
33839
33876
  interface StudioWidgetsService extends Instance {
33840
33877
  /**
33841
33878
  * **DO NOT USE!**
@@ -35265,6 +35302,7 @@ interface ChatWindowConfiguration extends TextChatConfigurations {
35265
35302
  TextStrokeTransparency: number;
35266
35303
  VerticalAlignment: Enum.VerticalAlignment;
35267
35304
  WidthScale: number;
35305
+ DeriveNewMessageProperties(this: ChatWindowConfiguration): ChatWindowMessageProperties;
35268
35306
  }
35269
35307
 
35270
35308
  interface TextChatMessage extends Instance {
@@ -35303,6 +35341,23 @@ interface TextChatMessageProperties extends Instance {
35303
35341
  Translation: string;
35304
35342
  }
35305
35343
 
35344
+ interface BubbleChatMessageProperties extends TextChatMessageProperties {
35345
+ /**
35346
+ * **DO NOT USE!**
35347
+ *
35348
+ * This field exists to force TypeScript to recognize this as a nominal type
35349
+ * @hidden
35350
+ * @deprecated
35351
+ */
35352
+ readonly _nominal_BubbleChatMessageProperties: unique symbol;
35353
+ BackgroundColor3: Color3;
35354
+ BackgroundTransparency: number;
35355
+ FontFace: Font;
35356
+ TailVisible: boolean;
35357
+ TextColor3: Color3;
35358
+ TextSize: number;
35359
+ }
35360
+
35306
35361
  interface ChatWindowMessageProperties extends TextChatMessageProperties {
35307
35362
  /**
35308
35363
  * **DO NOT USE!**
@@ -35349,6 +35404,7 @@ interface TextChatService extends Instance {
35349
35404
  readonly MessageReceived: RBXScriptSignal<(textChatMessage: TextChatMessage) => void>;
35350
35405
  readonly SendingMessage: RBXScriptSignal<(textChatMessage: TextChatMessage) => void>;
35351
35406
  OnBubbleAdded: (message: TextChatMessage, adornee: Instance) => TextChatMessageProperties | undefined;
35407
+ OnChatWindowAdded: (message: TextChatMessage) => Array<any>;
35352
35408
  OnIncomingMessage: (message: TextChatMessage) => TextChatMessageProperties | undefined;
35353
35409
  }
35354
35410
 
@@ -35482,7 +35538,7 @@ interface TextService extends Instance {
35482
35538
  /**
35483
35539
  * Tags: Yields
35484
35540
  */
35485
- GetFamilyInfoAsync(this: TextService, assetId: string): object;
35541
+ GetFamilyInfoAsync(this: TextService, assetId: ContentId): object;
35486
35542
  /**
35487
35543
  * Tags: Yields
35488
35544
  */
@@ -35787,7 +35843,7 @@ interface Trail extends Instance {
35787
35843
  *
35788
35844
  * Textures can be displayed in a variety of different ways based on the trail's [Trail.TextureMode](https://developer.roblox.com/en-us/api-reference/property/Trail/TextureMode) and [Trail.TextureLength](https://developer.roblox.com/en-us/api-reference/property/Trail/TextureLength) properties.
35789
35845
  */
35790
- Texture: string;
35846
+ Texture: ContentId;
35791
35847
  /**
35792
35848
  * This property determines how [Trail.Texture](https://developer.roblox.com/en-us/api-reference/property/Trail/Texture)s are drawn by [Trail](https://developer.roblox.com/en-us/api-reference/class/Trail). The behavior of TextureLength is determined by the [Trail.TextureMode](https://developer.roblox.com/en-us/api-reference/property/Trail/TextureMode) of its trail.
35793
35849
  *
@@ -36362,10 +36418,10 @@ interface UIDragDetector extends UIComponent {
36362
36418
  * @deprecated
36363
36419
  */
36364
36420
  readonly _nominal_UIDragDetector: unique symbol;
36365
- ActivatedCursorIcon: string;
36421
+ ActivatedCursorIcon: ContentId;
36366
36422
  BoundingBehavior: Enum.UIDragDetectorBoundingBehavior;
36367
36423
  BoundingUI: GuiBase2d | undefined;
36368
- CursorIcon: string;
36424
+ CursorIcon: ContentId;
36369
36425
  DragAxis: Vector2;
36370
36426
  DragRelativity: Enum.UIDragDetectorDragRelativity;
36371
36427
  DragRotation: number;
@@ -36379,6 +36435,9 @@ interface UIDragDetector extends UIComponent {
36379
36435
  MinDragTranslation: UDim2;
36380
36436
  ReferenceUIInstance: GuiObject | undefined;
36381
36437
  ResponseStyle: Enum.UIDragDetectorResponseStyle;
36438
+ SelectionModeDragSpeed: UDim2;
36439
+ SelectionModeRotateSpeed: number;
36440
+ UIDragSpeedAxisMapping: Enum.UIDragSpeedAxisMapping;
36382
36441
  AddConstraintFunction(
36383
36442
  this: UIDragDetector,
36384
36443
  priority: number,
@@ -37329,7 +37388,7 @@ interface UserInputService extends Instance {
37329
37388
  * Tags: NotReplicated
37330
37389
  */
37331
37390
  readonly MouseEnabled: boolean;
37332
- MouseIcon: string;
37391
+ MouseIcon: ContentId;
37333
37392
  /**
37334
37393
  * This property determines whether the [Mouse's](https://developer.roblox.com/en-us/api-reference/class/Mouse) icon is visible When _true_ the mouse's icon is visible, when _false_ it is not.
37335
37394
  *
@@ -37639,7 +37698,7 @@ interface UserInputService extends Instance {
37639
37698
  * * [UserInputService.GamepadEnabled](https://developer.roblox.com/en-us/api-reference/property/UserInputService/GamepadEnabled)
37640
37699
  */
37641
37700
  GetGamepadState(this: UserInputService, gamepadNum: CastsToEnum<Enum.UserInputType>): Array<InputObject>;
37642
- GetImageForKeyCode(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>): string;
37701
+ GetImageForKeyCode(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>): ContentId;
37643
37702
  /**
37644
37703
  * This function returns an array of [InputObjects](https://developer.roblox.com/en-us/api-reference/class/InputObject) associated with the keys currently being pressed down.
37645
37704
  *
@@ -124,7 +124,7 @@ interface AnimationClipProvider extends Instance {
124
124
  /**
125
125
  * @deprecated Use `GetAnimationClipAsync` instead
126
126
  */
127
- GetAnimationClip(this: AnimationClipProvider, assetId: string): AnimationClip;
127
+ GetAnimationClip(this: AnimationClipProvider, assetId: ContentId): AnimationClip;
128
128
  /**
129
129
  * @deprecated Use `GetAnimationClipAsync` instead
130
130
  */
@@ -166,7 +166,7 @@ interface AssetService extends Instance {
166
166
  /**
167
167
  * Tags: Yields
168
168
  */
169
- CreateMeshPartAsync(this: AssetService, meshId: string, options?: object): MeshPart;
169
+ CreateMeshPartAsync(this: AssetService, meshId: ContentId, options?: object): MeshPart;
170
170
  }
171
171
 
172
172
  /** The CoreGui is a service used to store Guis created in-game by Roblox for the core user interface found in every game (such as the game menu, the playerlist, the backpack, etc.). It can also be used by [Plugins](https://developer.roblox.com/en-us/api-reference/class/Plugin) in Roblox Studio.
@@ -225,7 +225,7 @@ interface BaseWrap extends Instance {
225
225
  *
226
226
  * Asset ID for cage mesh.
227
227
  */
228
- CageMeshId: string;
228
+ CageMeshId: ContentId;
229
229
  /**
230
230
  * This property is set up automatically by the Avatar Importer plugin.
231
231
  *
@@ -272,19 +272,6 @@ interface BaseWrap extends Instance {
272
272
  ImportOrigin: CFrame;
273
273
  }
274
274
 
275
- interface WrapDeformer extends BaseWrap {
276
- /**
277
- * **DO NOT USE!**
278
- *
279
- * This field exists to force TypeScript to recognize this as a nominal type
280
- * @hidden
281
- * @deprecated
282
- */
283
- readonly _nominal_WrapDeformer: unique symbol;
284
- Amount: number;
285
- RenderMeshID: string;
286
- }
287
-
288
275
  interface WrapLayer extends BaseWrap {
289
276
  /**
290
277
  * **DO NOT USE!**
@@ -307,7 +294,7 @@ interface WrapLayer extends BaseWrap {
307
294
  *
308
295
  * Note: this property is set up automatically by the FBX importer
309
296
  */
310
- ReferenceMeshId: string;
297
+ ReferenceMeshId: ContentId;
311
298
  /**
312
299
  * Reference mesh offset relative to parent MeshPart (in the parent MeshPart space)
313
300
  *
@@ -914,7 +901,7 @@ interface File extends Instance {
914
901
  *
915
902
  * Throws an error if the file does not exist on disk.
916
903
  */
917
- GetTemporaryId(this: File): string;
904
+ GetTemporaryId(this: File): ContentId;
918
905
  }
919
906
 
920
907
  /** Various miscellaneous options for in-game. Can be accessed from Roblox Studio's settings menu under the _Game_ tab. */
@@ -1148,7 +1135,7 @@ interface KeyframeSequenceProvider extends Instance {
1148
1135
  * Returns a [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) from a given asset URL.
1149
1136
  * @deprecated Use `GetKeyframeSequenceAsync` instead
1150
1137
  */
1151
- GetKeyframeSequence(this: KeyframeSequenceProvider, assetId: string): Instance | undefined;
1138
+ GetKeyframeSequence(this: KeyframeSequenceProvider, assetId: ContentId): Instance | undefined;
1152
1139
  /**
1153
1140
  * Returns a [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) from the supplied assetId. Can optionally cache to reduce unnecessary loading freezes.
1154
1141
  * @deprecated Use `GetKeyframeSequenceAsync` instead
@@ -1182,44 +1169,6 @@ interface BaseScript extends LuaSourceContainer {
1182
1169
  RunContext: Enum.RunContext;
1183
1170
  }
1184
1171
 
1185
- interface Script extends BaseScript {
1186
- /**
1187
- * **DO NOT USE!**
1188
- *
1189
- * This field exists to force TypeScript to recognize this as a nominal type
1190
- * @hidden
1191
- * @deprecated
1192
- */
1193
- readonly _nominal_Script: unique symbol;
1194
- /**
1195
- * A script's Source is the code to be executed. Modifying the code within a script modifies the source code executes when the script runs.
1196
- *
1197
- * For instance, given a script containing the line:
1198
- *
1199
- * print("Hello world!")
1200
- *
1201
- * The script's source is the “print(“Hello world”)” command because it is what will be executed when the script runs, leading to “Hello world” being printed in the command line.
1202
- *
1203
- * This item is protected. Attempting to use it in a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) or [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript) will cause an error.
1204
- */
1205
- Source: string;
1206
- }
1207
-
1208
- interface ModuleScript extends LuaSourceContainer {
1209
- /**
1210
- * **DO NOT USE!**
1211
- *
1212
- * This field exists to force TypeScript to recognize this as a nominal type
1213
- * @hidden
1214
- * @deprecated
1215
- */
1216
- readonly _nominal_ModuleScript: unique symbol;
1217
- /**
1218
- * The code to be executed.
1219
- */
1220
- Source: string;
1221
- }
1222
-
1223
1172
  interface MaterialVariant extends Instance {
1224
1173
  /**
1225
1174
  * **DO NOT USE!**
@@ -1230,10 +1179,10 @@ interface MaterialVariant extends Instance {
1230
1179
  */
1231
1180
  readonly _nominal_MaterialVariant: unique symbol;
1232
1181
  BaseMaterial: Enum.Material;
1233
- ColorMap: string;
1234
- MetalnessMap: string;
1235
- NormalMap: string;
1236
- RoughnessMap: string;
1182
+ ColorMap: ContentId;
1183
+ MetalnessMap: ContentId;
1184
+ NormalMap: ContentId;
1185
+ RoughnessMap: ContentId;
1237
1186
  }
1238
1187
 
1239
1188
  interface MemStorageConnection extends Instance {
@@ -2744,7 +2693,7 @@ interface PluginToolbarButton extends Instance {
2744
2693
  /**
2745
2694
  * Tags: NotReplicated
2746
2695
  */
2747
- Icon: string;
2696
+ Icon: ContentId;
2748
2697
  SetActive(this: PluginToolbarButton, active: boolean): void;
2749
2698
  /**
2750
2699
  * **Click** fires when the PluginToolbarButton is pressed and released by the user.
@@ -3309,7 +3258,7 @@ interface DataModel extends ServiceProvider<Services> {
3309
3258
  *
3310
3259
  * Due to this function's security context it can only be used by plugins or the command bar. For an alternative that can be used in [Scripts](https://developer.roblox.com/en-us/api-reference/class/Script) and [LocalScripts](https://developer.roblox.com/en-us/api-reference/class/LocalScript), see [InsertService:LoadAsset](https://developer.roblox.com/en-us/api-reference/function/InsertService/LoadAsset).
3311
3260
  */
3312
- GetObjects(this: DataModel, url: string): Array<Instance>;
3261
+ GetObjects(this: DataModel, url: ContentId): Array<Instance>;
3313
3262
  /**
3314
3263
  * This function sets the [DataModel.PlaceId](https://developer.roblox.com/en-us/api-reference/property/DataModel/PlaceId) of the game instance to the given _placeId_.
3315
3264
  *
@@ -3374,6 +3323,7 @@ interface SoundService extends Instance {
3374
3323
  * @deprecated
3375
3324
  */
3376
3325
  readonly _nominal_SoundService: unique symbol;
3326
+ DefaultListenerLocation: Enum.ListenerLocation;
3377
3327
  OpenAttenuationCurveEditor(this: SoundService, selectedCurveObjects: Array<Instance>): void;
3378
3328
  }
3379
3329
 
@@ -3980,7 +3930,7 @@ interface SurfaceAppearance extends Instance {
3980
3930
  /**
3981
3931
  * This property determines the color and opacity of the surface. This texture is sometimes called the albedo texture. The alpha channel of this texture controls its opacity, which behaves differently based on the [SurfaceAppearance.AlphaMode](https://developer.roblox.com/en-us/api-reference/property/SurfaceAppearance/AlphaMode) setting.
3982
3932
  */
3983
- ColorMap: string;
3933
+ ColorMap: ContentId;
3984
3934
  /**
3985
3935
  * This property determines which parts of the surface are metal and are non-metal. A metalness map is a grayscale image where black pixels correspond to non-metals and white pixels correspond to metals.
3986
3936
  *
@@ -3997,7 +3947,7 @@ interface SurfaceAppearance extends Instance {
3997
3947
  *
3998
3948
  * * When [Lighting.EnvironmentSpecularScale](https://developer.roblox.com/en-us/api-reference/property/Lighting/EnvironmentSpecularScale) is 0, metalness has no effect. For the most realistic reflections, setting EnvironmentSpecularScale and [Lighting.EnvironmentDiffuseScale](https://developer.roblox.com/en-us/api-reference/property/Lighting/EnvironmentDiffuseScale) to 1, and [Lighting.Ambient](https://developer.roblox.com/en-us/api-reference/property/Lighting/Ambient) and [Lighting.OutdoorAmbient](https://developer.roblox.com/en-us/api-reference/property/Lighting/OutdoorAmbient) to (0,0,0) is recommended.
3999
3949
  */
4000
- MetalnessMap: string;
3950
+ MetalnessMap: ContentId;
4001
3951
  /**
4002
3952
  * This property modifies the lighting of the surface by adding bumps, dents, cracks, and curves without adding more polygons.
4003
3953
  *
@@ -4014,13 +3964,13 @@ interface SurfaceAppearance extends Instance {
4014
3964
  *
4015
3965
  * Roblox expects imported meshes to include tangents. Modeling software may also refer to this as “tangent space” information. If you apply a normal map and it does not seem to make any visual difference, you may need to re-export your mesh along with its tangent information from modeling software.
4016
3966
  */
4017
- NormalMap: string;
3967
+ NormalMap: ContentId;
4018
3968
  /**
4019
3969
  * This property determines the apparent roughness across the surface. A roughness map is a grayscale image where black pixels correspond to a maximally smooth surface, and white pixels correspond to a maximally rough surface.
4020
3970
  *
4021
3971
  * Roughness refers to how much variation the surface has on a very small scale. Reflections on smooth surfaces are sharp and concentrated. Reflections on rough surfaces are more blurry and dispersed.
4022
3972
  */
4023
- RoughnessMap: string;
3973
+ RoughnessMap: ContentId;
4024
3974
  }
4025
3975
 
4026
3976
  /** TaskScheduler is a read-only settings class responsible for the Task Scheduler feature.
@@ -4068,10 +4018,10 @@ interface TerrainDetail extends Instance {
4068
4018
  * @deprecated
4069
4019
  */
4070
4020
  readonly _nominal_TerrainDetail: unique symbol;
4071
- ColorMap: string;
4072
- MetalnessMap: string;
4073
- NormalMap: string;
4074
- RoughnessMap: string;
4021
+ ColorMap: ContentId;
4022
+ MetalnessMap: ContentId;
4023
+ NormalMap: ContentId;
4024
+ RoughnessMap: ContentId;
4075
4025
  }
4076
4026
 
4077
4027
  interface TerrainRegion extends Instance {
@@ -5481,6 +5481,35 @@ declare namespace Enum {
5481
5481
  }
5482
5482
  export type ConnectionState = ConnectionState.Connected | ConnectionState.Disconnected;
5483
5483
 
5484
+ export namespace ContentSourceType {
5485
+ export interface None extends globalThis.EnumItem {
5486
+ Name: "None";
5487
+ Value: 0;
5488
+ EnumType: typeof globalThis.Enum.ContentSourceType;
5489
+ }
5490
+
5491
+ export const None: None;
5492
+
5493
+ export interface Uri extends globalThis.EnumItem {
5494
+ Name: "Uri";
5495
+ Value: 1;
5496
+ EnumType: typeof globalThis.Enum.ContentSourceType;
5497
+ }
5498
+
5499
+ export const Uri: Uri;
5500
+
5501
+ export interface Object extends globalThis.EnumItem {
5502
+ Name: "Object";
5503
+ Value: 2;
5504
+ EnumType: typeof globalThis.Enum.ContentSourceType;
5505
+ }
5506
+
5507
+ export const Object: Object;
5508
+
5509
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ContentSourceType>;
5510
+ }
5511
+ export type ContentSourceType = ContentSourceType.None | ContentSourceType.Uri | ContentSourceType.Object;
5512
+
5484
5513
  export namespace ContextActionPriority {
5485
5514
  export interface Low extends globalThis.EnumItem {
5486
5515
  Name: "Low";
@@ -12642,6 +12671,43 @@ declare namespace Enum {
12642
12671
  }
12643
12672
  export type ListDisplayMode = ListDisplayMode.Horizontal | ListDisplayMode.Vertical;
12644
12673
 
12674
+ export namespace ListenerLocation {
12675
+ export interface Default extends globalThis.EnumItem {
12676
+ Name: "Default";
12677
+ Value: 0;
12678
+ EnumType: typeof globalThis.Enum.ListenerLocation;
12679
+ }
12680
+
12681
+ export const Default: Default;
12682
+
12683
+ export interface None extends globalThis.EnumItem {
12684
+ Name: "None";
12685
+ Value: 1;
12686
+ EnumType: typeof globalThis.Enum.ListenerLocation;
12687
+ }
12688
+
12689
+ export const None: None;
12690
+
12691
+ export interface Character extends globalThis.EnumItem {
12692
+ Name: "Character";
12693
+ Value: 2;
12694
+ EnumType: typeof globalThis.Enum.ListenerLocation;
12695
+ }
12696
+
12697
+ export const Character: Character;
12698
+
12699
+ export interface Camera extends globalThis.EnumItem {
12700
+ Name: "Camera";
12701
+ Value: 3;
12702
+ EnumType: typeof globalThis.Enum.ListenerLocation;
12703
+ }
12704
+
12705
+ export const Camera: Camera;
12706
+
12707
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ListenerLocation>;
12708
+ }
12709
+ export type ListenerLocation = ListenerLocation.Default | ListenerLocation.None | ListenerLocation.Character | ListenerLocation.Camera;
12710
+
12645
12711
  export namespace ListenerType {
12646
12712
  export interface Camera extends globalThis.EnumItem {
12647
12713
  Name: "Camera";
@@ -15321,9 +15387,17 @@ declare namespace Enum {
15321
15387
 
15322
15388
  export const Bounce: Bounce;
15323
15389
 
15390
+ export interface CubicV2 extends globalThis.EnumItem {
15391
+ Name: "CubicV2";
15392
+ Value: 5;
15393
+ EnumType: typeof globalThis.Enum.PoseEasingStyle;
15394
+ }
15395
+
15396
+ export const CubicV2: CubicV2;
15397
+
15324
15398
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PoseEasingStyle>;
15325
15399
  }
15326
- export type PoseEasingStyle = PoseEasingStyle.Linear | PoseEasingStyle.Constant | PoseEasingStyle.Elastic | PoseEasingStyle.Cubic | PoseEasingStyle.Bounce;
15400
+ export type PoseEasingStyle = PoseEasingStyle.Linear | PoseEasingStyle.Constant | PoseEasingStyle.Elastic | PoseEasingStyle.Cubic | PoseEasingStyle.Bounce | PoseEasingStyle.CubicV2;
15327
15401
 
15328
15402
  export namespace PositionAlignmentMode {
15329
15403
  export interface OneAttachment extends globalThis.EnumItem {
@@ -16814,6 +16888,35 @@ declare namespace Enum {
16814
16888
  }
16815
16889
  export type RollOffMode = RollOffMode.Inverse | RollOffMode.Linear | RollOffMode.LinearSquare | RollOffMode.InverseTapered;
16816
16890
 
16891
+ export namespace RolloutState {
16892
+ export interface Default extends globalThis.EnumItem {
16893
+ Name: "Default";
16894
+ Value: 0;
16895
+ EnumType: typeof globalThis.Enum.RolloutState;
16896
+ }
16897
+
16898
+ export const Default: Default;
16899
+
16900
+ export interface Disabled extends globalThis.EnumItem {
16901
+ Name: "Disabled";
16902
+ Value: 1;
16903
+ EnumType: typeof globalThis.Enum.RolloutState;
16904
+ }
16905
+
16906
+ export const Disabled: Disabled;
16907
+
16908
+ export interface Enabled extends globalThis.EnumItem {
16909
+ Name: "Enabled";
16910
+ Value: 2;
16911
+ EnumType: typeof globalThis.Enum.RolloutState;
16912
+ }
16913
+
16914
+ export const Enabled: Enabled;
16915
+
16916
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.RolloutState>;
16917
+ }
16918
+ export type RolloutState = RolloutState.Default | RolloutState.Disabled | RolloutState.Enabled;
16919
+
16817
16920
  export namespace RotationOrder {
16818
16921
  export interface XYZ extends globalThis.EnumItem {
16819
16922
  Name: "XYZ";
@@ -21918,6 +22021,35 @@ declare namespace Enum {
21918
22021
  }
21919
22022
  export type UIDragDetectorResponseStyle = UIDragDetectorResponseStyle.Offset | UIDragDetectorResponseStyle.Scale | UIDragDetectorResponseStyle.CustomOffset | UIDragDetectorResponseStyle.CustomScale;
21920
22023
 
22024
+ export namespace UIDragSpeedAxisMapping {
22025
+ export interface XY extends globalThis.EnumItem {
22026
+ Name: "XY";
22027
+ Value: 0;
22028
+ EnumType: typeof globalThis.Enum.UIDragSpeedAxisMapping;
22029
+ }
22030
+
22031
+ export const XY: XY;
22032
+
22033
+ export interface XX extends globalThis.EnumItem {
22034
+ Name: "XX";
22035
+ Value: 1;
22036
+ EnumType: typeof globalThis.Enum.UIDragSpeedAxisMapping;
22037
+ }
22038
+
22039
+ export const XX: XX;
22040
+
22041
+ export interface YY extends globalThis.EnumItem {
22042
+ Name: "YY";
22043
+ Value: 2;
22044
+ EnumType: typeof globalThis.Enum.UIDragSpeedAxisMapping;
22045
+ }
22046
+
22047
+ export const YY: YY;
22048
+
22049
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.UIDragSpeedAxisMapping>;
22050
+ }
22051
+ export type UIDragSpeedAxisMapping = UIDragSpeedAxisMapping.XY | UIDragSpeedAxisMapping.XX | UIDragSpeedAxisMapping.YY;
22052
+
21921
22053
  export namespace UIFlexAlignment {
21922
22054
  export interface None extends globalThis.EnumItem {
21923
22055
  Name: "None";
@@ -23270,6 +23402,27 @@ declare namespace Enum {
23270
23402
  }
23271
23403
  export type WeldConstraintPreserve = WeldConstraintPreserve.All | WeldConstraintPreserve.None | WeldConstraintPreserve.Touching;
23272
23404
 
23405
+ export namespace WhisperChatPrivacyMode {
23406
+ export interface AllUsers extends globalThis.EnumItem {
23407
+ Name: "AllUsers";
23408
+ Value: 0;
23409
+ EnumType: typeof globalThis.Enum.WhisperChatPrivacyMode;
23410
+ }
23411
+
23412
+ export const AllUsers: AllUsers;
23413
+
23414
+ export interface NoOne extends globalThis.EnumItem {
23415
+ Name: "NoOne";
23416
+ Value: 1;
23417
+ EnumType: typeof globalThis.Enum.WhisperChatPrivacyMode;
23418
+ }
23419
+
23420
+ export const NoOne: NoOne;
23421
+
23422
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.WhisperChatPrivacyMode>;
23423
+ }
23424
+ export type WhisperChatPrivacyMode = WhisperChatPrivacyMode.AllUsers | WhisperChatPrivacyMode.NoOne;
23425
+
23273
23426
  export namespace WrapLayerAutoSkin {
23274
23427
  export interface Disabled extends globalThis.EnumItem {
23275
23428
  Name: "Disabled";
@@ -31,6 +31,8 @@ type ChangedSignal = {
31
31
 
32
32
  type Tweenable = number | boolean | CFrame | Rect | Color3 | UDim | UDim2 | Vector2 | Vector2int16 | Vector3;
33
33
 
34
+ type ContentId = string;
35
+
34
36
  interface EmoteDictionary {
35
37
  /** When these arrays have more than one emote id in them, it will randomly select one of the emotes to play from the list. */
36
38
  [emoteName: string]: Array<number>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.809",
3
+ "version": "1.0.811",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },