@rbxts/types 1.0.809 → 1.0.810
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.
|
@@ -1712,7 +1712,7 @@ interface Animation extends Instance {
|
|
|
1712
1712
|
*
|
|
1713
1713
|
* 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
1714
|
*/
|
|
1715
|
-
AnimationId:
|
|
1715
|
+
AnimationId: ContentId;
|
|
1716
1716
|
}
|
|
1717
1717
|
|
|
1718
1718
|
interface AnimationClip extends Instance {
|
|
@@ -1816,12 +1816,12 @@ interface AnimationClipProvider extends Instance {
|
|
|
1816
1816
|
* @deprecated
|
|
1817
1817
|
*/
|
|
1818
1818
|
readonly _nominal_AnimationClipProvider: unique symbol;
|
|
1819
|
-
RegisterActiveAnimationClip(this: AnimationClipProvider, animationClip: AnimationClip):
|
|
1820
|
-
RegisterAnimationClip(this: AnimationClipProvider, animationClip: AnimationClip):
|
|
1819
|
+
RegisterActiveAnimationClip(this: AnimationClipProvider, animationClip: AnimationClip): ContentId;
|
|
1820
|
+
RegisterAnimationClip(this: AnimationClipProvider, animationClip: AnimationClip): ContentId;
|
|
1821
1821
|
/**
|
|
1822
1822
|
* Tags: Yields
|
|
1823
1823
|
*/
|
|
1824
|
-
GetAnimationClipAsync(this: AnimationClipProvider, assetId:
|
|
1824
|
+
GetAnimationClipAsync(this: AnimationClipProvider, assetId: ContentId): AnimationClip;
|
|
1825
1825
|
/**
|
|
1826
1826
|
* Tags: Yields
|
|
1827
1827
|
*/
|
|
@@ -1829,7 +1829,7 @@ interface AnimationClipProvider extends Instance {
|
|
|
1829
1829
|
/**
|
|
1830
1830
|
* Tags: Yields
|
|
1831
1831
|
*/
|
|
1832
|
-
GetClipEvaluatorAsync(this: AnimationClipProvider, assetId:
|
|
1832
|
+
GetClipEvaluatorAsync(this: AnimationClipProvider, assetId: ContentId): ClipEvaluator;
|
|
1833
1833
|
}
|
|
1834
1834
|
|
|
1835
1835
|
/** 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 +2430,11 @@ interface AssetService extends Instance {
|
|
|
2430
2430
|
/**
|
|
2431
2431
|
* Tags: Yields
|
|
2432
2432
|
*/
|
|
2433
|
-
CreateEditableImageAsync(this: AssetService, textureId:
|
|
2433
|
+
CreateEditableImageAsync(this: AssetService, textureId: ContentId): EditableImage;
|
|
2434
2434
|
/**
|
|
2435
2435
|
* Tags: Yields
|
|
2436
2436
|
*/
|
|
2437
|
-
CreateEditableMeshAsync(this: AssetService, meshId:
|
|
2437
|
+
CreateEditableMeshAsync(this: AssetService, meshId: ContentId): EditableMesh;
|
|
2438
2438
|
/**
|
|
2439
2439
|
* Tags: Yields
|
|
2440
2440
|
*/
|
|
@@ -3243,6 +3243,10 @@ interface AvatarCreationService extends Instance {
|
|
|
3243
3243
|
* Tags: Yields
|
|
3244
3244
|
*/
|
|
3245
3245
|
PromptCreateAvatarAsync(this: AvatarCreationService, player: Player, humanoidDescription: HumanoidDescription): unknown;
|
|
3246
|
+
/**
|
|
3247
|
+
* Tags: Yields
|
|
3248
|
+
*/
|
|
3249
|
+
PromptSelectAvatarGenerationImageAsync(this: AvatarCreationService, player: Player): string;
|
|
3246
3250
|
/**
|
|
3247
3251
|
* Tags: Yields
|
|
3248
3252
|
*/
|
|
@@ -5054,7 +5058,7 @@ interface BaseWrap extends Instance {
|
|
|
5054
5058
|
*
|
|
5055
5059
|
* Asset ID for cage mesh.
|
|
5056
5060
|
*/
|
|
5057
|
-
CageMeshId:
|
|
5061
|
+
CageMeshId: ContentId;
|
|
5058
5062
|
/**
|
|
5059
5063
|
* This property is set up automatically by the Avatar Importer plugin.
|
|
5060
5064
|
*
|
|
@@ -5124,7 +5128,7 @@ interface WrapDeformer extends BaseWrap {
|
|
|
5124
5128
|
readonly _nominal_WrapDeformer: unique symbol;
|
|
5125
5129
|
Amount: number;
|
|
5126
5130
|
Enabled: boolean;
|
|
5127
|
-
RenderMeshID:
|
|
5131
|
+
RenderMeshID: ContentId;
|
|
5128
5132
|
}
|
|
5129
5133
|
|
|
5130
5134
|
/** 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 +5172,7 @@ interface WrapLayer extends BaseWrap {
|
|
|
5168
5172
|
*
|
|
5169
5173
|
* Note: this property is set up automatically by the FBX importer
|
|
5170
5174
|
*/
|
|
5171
|
-
ReferenceMeshId:
|
|
5175
|
+
ReferenceMeshId: ContentId;
|
|
5172
5176
|
/**
|
|
5173
5177
|
* Reference mesh offset relative to parent MeshPart (in the parent MeshPart space)
|
|
5174
5178
|
*
|
|
@@ -5425,7 +5429,7 @@ interface Beam extends Instance {
|
|
|
5425
5429
|
*
|
|
5426
5430
|
* 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
5431
|
*/
|
|
5428
|
-
Texture:
|
|
5432
|
+
Texture: ContentId;
|
|
5429
5433
|
/**
|
|
5430
5434
|
* 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
5435
|
*
|
|
@@ -6929,7 +6933,7 @@ interface CaptureService extends Instance {
|
|
|
6929
6933
|
* @deprecated Use `UserCaptureSaved` instead
|
|
6930
6934
|
*/
|
|
6931
6935
|
readonly CaptureSaved: RBXScriptSignal<(captureInfo: Record<string, unknown>) => void>;
|
|
6932
|
-
readonly UserCaptureSaved: RBXScriptSignal<(captureContentId:
|
|
6936
|
+
readonly UserCaptureSaved: RBXScriptSignal<(captureContentId: ContentId) => void>;
|
|
6933
6937
|
}
|
|
6934
6938
|
|
|
6935
6939
|
/** Base class for objects that change a character's appearance. */
|
|
@@ -7111,7 +7115,7 @@ interface Pants extends Clothing {
|
|
|
7111
7115
|
*
|
|
7112
7116
|
* 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
7117
|
*/
|
|
7114
|
-
PantsTemplate:
|
|
7118
|
+
PantsTemplate: ContentId;
|
|
7115
7119
|
}
|
|
7116
7120
|
|
|
7117
7121
|
/**  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 +7156,7 @@ interface Shirt extends Clothing {
|
|
|
7152
7156
|
* model.Parent = workspace
|
|
7153
7157
|
* end
|
|
7154
7158
|
*/
|
|
7155
|
-
ShirtTemplate:
|
|
7159
|
+
ShirtTemplate: ContentId;
|
|
7156
7160
|
}
|
|
7157
7161
|
|
|
7158
7162
|
/** The **ShirtGraphic** object applies a texture to the front surface of a character's torso. It is used to display t-shirts. */
|
|
@@ -7193,7 +7197,7 @@ interface ShirtGraphic extends CharacterAppearance {
|
|
|
7193
7197
|
* model.Parent = workspace
|
|
7194
7198
|
* end
|
|
7195
7199
|
*/
|
|
7196
|
-
Graphic:
|
|
7200
|
+
Graphic: ContentId;
|
|
7197
7201
|
}
|
|
7198
7202
|
|
|
7199
7203
|
/** 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 +7400,7 @@ interface ClickDetector extends Instance {
|
|
|
7396
7400
|
*
|
|
7397
7401
|
* 
|
|
7398
7402
|
*/
|
|
7399
|
-
CursorIcon:
|
|
7403
|
+
CursorIcon: ContentId;
|
|
7400
7404
|
/**
|
|
7401
7405
|
* 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
7406
|
*
|
|
@@ -7456,7 +7460,7 @@ interface DragDetector extends ClickDetector {
|
|
|
7456
7460
|
* @deprecated
|
|
7457
7461
|
*/
|
|
7458
7462
|
readonly _nominal_DragDetector: unique symbol;
|
|
7459
|
-
ActivatedCursorIcon:
|
|
7463
|
+
ActivatedCursorIcon: ContentId;
|
|
7460
7464
|
ApplyAtCenterOfMass: boolean;
|
|
7461
7465
|
/**
|
|
7462
7466
|
* Tags: NotReplicated
|
|
@@ -9263,20 +9267,20 @@ interface ContentProvider extends Instance {
|
|
|
9263
9267
|
* Tags: NotReplicated
|
|
9264
9268
|
*/
|
|
9265
9269
|
readonly RequestQueueSize: number;
|
|
9266
|
-
GetAssetFetchStatus(this: ContentProvider, contentId:
|
|
9267
|
-
GetAssetFetchStatusChangedSignal(this: ContentProvider, contentId:
|
|
9270
|
+
GetAssetFetchStatus(this: ContentProvider, contentId: ContentId): Enum.AssetFetchStatus;
|
|
9271
|
+
GetAssetFetchStatusChangedSignal(this: ContentProvider, contentId: ContentId): RBXScriptSignal;
|
|
9268
9272
|
ListEncryptedAssets(this: ContentProvider): unknown;
|
|
9269
9273
|
/**
|
|
9270
9274
|
* 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
9275
|
* @deprecated Use `PreloadAsync` instead
|
|
9272
9276
|
*/
|
|
9273
|
-
Preload(this: ContentProvider, contentId:
|
|
9277
|
+
Preload(this: ContentProvider, contentId: ContentId): void;
|
|
9274
9278
|
RegisterDefaultEncryptionKey(this: ContentProvider, encryptionKey: string): void;
|
|
9275
9279
|
RegisterDefaultSessionKey(this: ContentProvider, sessionKey: string): void;
|
|
9276
|
-
RegisterEncryptedAsset(this: ContentProvider, assetId:
|
|
9277
|
-
RegisterSessionEncryptedAsset(this: ContentProvider, contentId:
|
|
9280
|
+
RegisterEncryptedAsset(this: ContentProvider, assetId: ContentId, encryptionKey: string): void;
|
|
9281
|
+
RegisterSessionEncryptedAsset(this: ContentProvider, contentId: ContentId, sessionKey: string): void;
|
|
9278
9282
|
UnregisterDefaultEncryptionKey(this: ContentProvider): void;
|
|
9279
|
-
UnregisterEncryptedAsset(this: ContentProvider, assetId:
|
|
9283
|
+
UnregisterEncryptedAsset(this: ContentProvider, assetId: ContentId): void;
|
|
9280
9284
|
/**
|
|
9281
9285
|
* 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
9286
|
*
|
|
@@ -9291,7 +9295,7 @@ interface ContentProvider extends Instance {
|
|
|
9291
9295
|
contentIdList: Array<Instance | string>,
|
|
9292
9296
|
callback?: (contentId: string, status: Enum.AssetFetchStatus) => void,
|
|
9293
9297
|
): void;
|
|
9294
|
-
readonly AssetFetchFailed: RBXScriptSignal<(assetId:
|
|
9298
|
+
readonly AssetFetchFailed: RBXScriptSignal<(assetId: ContentId) => void>;
|
|
9295
9299
|
}
|
|
9296
9300
|
|
|
9297
9301
|
/** 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 +10162,7 @@ interface FileMesh extends DataModelMesh {
|
|
|
10158
10162
|
*
|
|
10159
10163
|
* 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
10164
|
*/
|
|
10161
|
-
MeshId:
|
|
10165
|
+
MeshId: ContentId;
|
|
10162
10166
|
/**
|
|
10163
10167
|
* 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
10168
|
*
|
|
@@ -10174,7 +10178,7 @@ interface FileMesh extends DataModelMesh {
|
|
|
10174
10178
|
*
|
|
10175
10179
|
* 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
10180
|
*/
|
|
10177
|
-
TextureId:
|
|
10181
|
+
TextureId: ContentId;
|
|
10178
10182
|
}
|
|
10179
10183
|
|
|
10180
10184
|
/** 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 +11458,7 @@ interface Decal extends FaceInstance {
|
|
|
11454
11458
|
* * 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
11459
|
* * 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
11460
|
*/
|
|
11457
|
-
Texture:
|
|
11461
|
+
Texture: ContentId;
|
|
11458
11462
|
/**
|
|
11459
11463
|
* 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
11464
|
*
|
|
@@ -13451,11 +13455,11 @@ interface ImageButton extends GuiButton {
|
|
|
13451
13455
|
/**
|
|
13452
13456
|
* 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
13457
|
*/
|
|
13454
|
-
HoverImage:
|
|
13458
|
+
HoverImage: ContentId;
|
|
13455
13459
|
/**
|
|
13456
13460
|
* 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
13461
|
*/
|
|
13458
|
-
Image:
|
|
13462
|
+
Image: ContentId;
|
|
13459
13463
|
/**
|
|
13460
13464
|
* 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
13465
|
*/
|
|
@@ -13485,7 +13489,7 @@ interface ImageButton extends GuiButton {
|
|
|
13485
13489
|
/**
|
|
13486
13490
|
* 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
13491
|
*/
|
|
13488
|
-
PressedImage:
|
|
13492
|
+
PressedImage: ContentId;
|
|
13489
13493
|
/**
|
|
13490
13494
|
* Determines how the image looks when it is scaled.
|
|
13491
13495
|
*
|
|
@@ -13784,7 +13788,7 @@ interface ImageLabel extends GuiLabel {
|
|
|
13784
13788
|
/**
|
|
13785
13789
|
* 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
13790
|
*/
|
|
13787
|
-
Image:
|
|
13791
|
+
Image: ContentId;
|
|
13788
13792
|
/**
|
|
13789
13793
|
* 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
13794
|
*/
|
|
@@ -14111,7 +14115,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
14111
14115
|
/**
|
|
14112
14116
|
* 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
14117
|
*/
|
|
14114
|
-
BottomImage:
|
|
14118
|
+
BottomImage: ContentId;
|
|
14115
14119
|
/**
|
|
14116
14120
|
* The location within the canvas, in pixels, that should be drawn at the top left of the scroll frame
|
|
14117
14121
|
*/
|
|
@@ -14170,7 +14174,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
14170
14174
|
/**
|
|
14171
14175
|
* 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
14176
|
*/
|
|
14173
|
-
MidImage:
|
|
14177
|
+
MidImage: ContentId;
|
|
14174
14178
|
/**
|
|
14175
14179
|
* 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
14180
|
*/
|
|
@@ -14238,7 +14242,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
14238
14242
|
/**
|
|
14239
14243
|
* 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
14244
|
*/
|
|
14241
|
-
TopImage:
|
|
14245
|
+
TopImage: ContentId;
|
|
14242
14246
|
/**
|
|
14243
14247
|
* Indicates the inset behavior of the vertical scrolling bar.
|
|
14244
14248
|
*/
|
|
@@ -14608,7 +14612,7 @@ interface VideoFrame extends GuiObject {
|
|
|
14608
14612
|
/**
|
|
14609
14613
|
* The content ID of the video file a [VideoFrame](https://developer.roblox.com/en-us/api-reference/class/VideoFrame) object is associated with.
|
|
14610
14614
|
*/
|
|
14611
|
-
Video:
|
|
14615
|
+
Video: ContentId;
|
|
14612
14616
|
/**
|
|
14613
14617
|
* 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
14618
|
*/
|
|
@@ -15116,7 +15120,7 @@ interface AdGui extends SurfaceGuiBase {
|
|
|
15116
15120
|
readonly _nominal_AdGui: unique symbol;
|
|
15117
15121
|
AdShape: Enum.AdShape;
|
|
15118
15122
|
EnableVideoAds: boolean;
|
|
15119
|
-
FallbackImage:
|
|
15123
|
+
FallbackImage: ContentId;
|
|
15120
15124
|
/**
|
|
15121
15125
|
* Tags: NotReplicated
|
|
15122
15126
|
*/
|
|
@@ -15261,7 +15265,7 @@ interface FloorWire extends GuiBase3d {
|
|
|
15261
15265
|
/**
|
|
15262
15266
|
* Sets the texture to be displayed on the FloorWire.
|
|
15263
15267
|
*/
|
|
15264
|
-
Texture:
|
|
15268
|
+
Texture: ContentId;
|
|
15265
15269
|
/**
|
|
15266
15270
|
* Sets the size of the texture used with the FloorWire.
|
|
15267
15271
|
*/
|
|
@@ -15523,7 +15527,7 @@ interface ImageHandleAdornment extends HandleAdornment {
|
|
|
15523
15527
|
/**
|
|
15524
15528
|
* The image to draw for the adornment.
|
|
15525
15529
|
*/
|
|
15526
|
-
Image:
|
|
15530
|
+
Image: ContentId;
|
|
15527
15531
|
/**
|
|
15528
15532
|
* The size in studs of the image.
|
|
15529
15533
|
*/
|
|
@@ -19985,7 +19989,7 @@ interface InsertService extends Instance {
|
|
|
19985
19989
|
/**
|
|
19986
19990
|
* Tags: Yields
|
|
19987
19991
|
*/
|
|
19988
|
-
CreateMeshPartAsync(this: InsertService, meshId:
|
|
19992
|
+
CreateMeshPartAsync(this: InsertService, meshId: ContentId, collisionFidelity: CastsToEnum<Enum.CollisionFidelity>, renderFidelity: CastsToEnum<Enum.RenderFidelity>): MeshPart;
|
|
19989
19993
|
/**
|
|
19990
19994
|
* Tags: Yields
|
|
19991
19995
|
* @deprecated Use `GetBaseSets` instead
|
|
@@ -20775,7 +20779,7 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
20775
20779
|
*
|
|
20776
20780
|
* 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
20781
|
*/
|
|
20778
|
-
RegisterActiveKeyframeSequence(this: KeyframeSequenceProvider, keyframeSequence: KeyframeSequence):
|
|
20782
|
+
RegisterActiveKeyframeSequence(this: KeyframeSequenceProvider, keyframeSequence: KeyframeSequence): ContentId;
|
|
20779
20783
|
/**
|
|
20780
20784
|
* 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
20785
|
*
|
|
@@ -20785,7 +20789,7 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
20785
20789
|
*
|
|
20786
20790
|
* 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
20791
|
*/
|
|
20788
|
-
RegisterKeyframeSequence(this: KeyframeSequenceProvider, keyframeSequence: KeyframeSequence):
|
|
20792
|
+
RegisterKeyframeSequence(this: KeyframeSequenceProvider, keyframeSequence: KeyframeSequence): ContentId;
|
|
20789
20793
|
/**
|
|
20790
20794
|
* 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
20795
|
*
|
|
@@ -22836,7 +22840,7 @@ interface BaseScript extends LuaSourceContainer {
|
|
|
22836
22840
|
* 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
22841
|
* @deprecated
|
|
22838
22842
|
*/
|
|
22839
|
-
LinkedSource:
|
|
22843
|
+
LinkedSource: ContentId;
|
|
22840
22844
|
RunContext: Enum.RunContext;
|
|
22841
22845
|
}
|
|
22842
22846
|
|
|
@@ -22859,6 +22863,18 @@ interface Script extends BaseScript {
|
|
|
22859
22863
|
* @deprecated
|
|
22860
22864
|
*/
|
|
22861
22865
|
readonly _nominal_Script: unique symbol;
|
|
22866
|
+
/**
|
|
22867
|
+
* 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.
|
|
22868
|
+
*
|
|
22869
|
+
* For instance, given a script containing the line:
|
|
22870
|
+
*
|
|
22871
|
+
* print("Hello world!")
|
|
22872
|
+
*
|
|
22873
|
+
* 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.
|
|
22874
|
+
*
|
|
22875
|
+
* 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.
|
|
22876
|
+
*/
|
|
22877
|
+
Source: string;
|
|
22862
22878
|
}
|
|
22863
22879
|
|
|
22864
22880
|
/** 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 +22921,7 @@ interface ModuleScript extends LuaSourceContainer {
|
|
|
22905
22921
|
* 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
22922
|
* @deprecated
|
|
22907
22923
|
*/
|
|
22908
|
-
LinkedSource:
|
|
22924
|
+
LinkedSource: ContentId;
|
|
22909
22925
|
}
|
|
22910
22926
|
|
|
22911
22927
|
interface LuauScriptAnalyzerService extends Instance {
|
|
@@ -23939,7 +23955,7 @@ interface Mouse extends Instance {
|
|
|
23939
23955
|
*
|
|
23940
23956
|
* \* These appearances are approximations – the actual look is dependent on your operating system.
|
|
23941
23957
|
*/
|
|
23942
|
-
Icon:
|
|
23958
|
+
Icon: ContentId;
|
|
23943
23959
|
/**
|
|
23944
23960
|
* 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
23961
|
*
|
|
@@ -26048,7 +26064,7 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
26048
26064
|
*
|
|
26049
26065
|
* 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
26066
|
*/
|
|
26051
|
-
readonly MeshId:
|
|
26067
|
+
readonly MeshId: ContentId;
|
|
26052
26068
|
/**
|
|
26053
26069
|
* 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
26070
|
*
|
|
@@ -26097,7 +26113,7 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
26097
26113
|
*
|
|
26098
26114
|
* 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
26115
|
*/
|
|
26100
|
-
TextureID:
|
|
26116
|
+
TextureID: ContentId;
|
|
26101
26117
|
ApplyMesh(this: MeshPart, meshPart: MeshPart): void;
|
|
26102
26118
|
}
|
|
26103
26119
|
|
|
@@ -26524,7 +26540,7 @@ interface BackpackItem extends Model {
|
|
|
26524
26540
|
*
|
|
26525
26541
|
* 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
26542
|
*/
|
|
26527
|
-
TextureId:
|
|
26543
|
+
TextureId: ContentId;
|
|
26528
26544
|
}
|
|
26529
26545
|
|
|
26530
26546
|
/** 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 +27434,7 @@ interface PackageLink extends Instance {
|
|
|
27418
27434
|
*
|
|
27419
27435
|
* Tags: NotReplicated
|
|
27420
27436
|
*/
|
|
27421
|
-
readonly PackageId:
|
|
27437
|
+
readonly PackageId: ContentId;
|
|
27422
27438
|
/**
|
|
27423
27439
|
* This property refers to a revision of a specific package
|
|
27424
27440
|
*
|
|
@@ -27909,7 +27925,7 @@ interface ParticleEmitter extends Instance {
|
|
|
27909
27925
|
* 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
27926
|
* 
|
|
27911
27927
|
*/
|
|
27912
|
-
Texture:
|
|
27928
|
+
Texture: ContentId;
|
|
27913
27929
|
TimeScale: number;
|
|
27914
27930
|
/**
|
|
27915
27931
|
* 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 +31152,7 @@ interface ScreenshotHud extends Instance {
|
|
|
31136
31152
|
* @deprecated
|
|
31137
31153
|
*/
|
|
31138
31154
|
readonly _nominal_ScreenshotHud: unique symbol;
|
|
31139
|
-
CameraButtonIcon:
|
|
31155
|
+
CameraButtonIcon: ContentId;
|
|
31140
31156
|
CameraButtonPosition: UDim2;
|
|
31141
31157
|
CloseButtonPosition: UDim2;
|
|
31142
31158
|
CloseWhenScreenshotTaken: boolean;
|
|
@@ -31924,31 +31940,31 @@ interface Sky extends Instance {
|
|
|
31924
31940
|
/**
|
|
31925
31941
|
* The texture of the moon while using this skybox.
|
|
31926
31942
|
*/
|
|
31927
|
-
MoonTextureId:
|
|
31943
|
+
MoonTextureId: ContentId;
|
|
31928
31944
|
/**
|
|
31929
31945
|
* The URL link to a picture for the back surface of the sky.
|
|
31930
31946
|
*/
|
|
31931
|
-
SkyboxBk:
|
|
31947
|
+
SkyboxBk: ContentId;
|
|
31932
31948
|
/**
|
|
31933
31949
|
* The URL asset link to a picture for the Bottom surface of the sky.
|
|
31934
31950
|
*/
|
|
31935
|
-
SkyboxDn:
|
|
31951
|
+
SkyboxDn: ContentId;
|
|
31936
31952
|
/**
|
|
31937
31953
|
* The URL link to a picture for the front surface of the skybox.
|
|
31938
31954
|
*/
|
|
31939
|
-
SkyboxFt:
|
|
31955
|
+
SkyboxFt: ContentId;
|
|
31940
31956
|
/**
|
|
31941
31957
|
* The URL link to a picture for the left surface of the sky.
|
|
31942
31958
|
*/
|
|
31943
|
-
SkyboxLf:
|
|
31959
|
+
SkyboxLf: ContentId;
|
|
31944
31960
|
/**
|
|
31945
31961
|
* The URL link to a picture for the right surface of the sky.
|
|
31946
31962
|
*/
|
|
31947
|
-
SkyboxRt:
|
|
31963
|
+
SkyboxRt: ContentId;
|
|
31948
31964
|
/**
|
|
31949
31965
|
* The URL link to a picture for the top surface of the sky.
|
|
31950
31966
|
*/
|
|
31951
|
-
SkyboxUp:
|
|
31967
|
+
SkyboxUp: ContentId;
|
|
31952
31968
|
/**
|
|
31953
31969
|
* 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
31970
|
*/
|
|
@@ -31960,7 +31976,7 @@ interface Sky extends Instance {
|
|
|
31960
31976
|
/**
|
|
31961
31977
|
* The texture of the sun while using this skybox.
|
|
31962
31978
|
*/
|
|
31963
|
-
SunTextureId:
|
|
31979
|
+
SunTextureId: ContentId;
|
|
31964
31980
|
}
|
|
31965
31981
|
|
|
31966
31982
|
/** 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 +32364,7 @@ interface Sound extends Instance {
|
|
|
32348
32364
|
* "http://www.roblox.com/asset/?id=12222216" -- Content ID (will work)
|
|
32349
32365
|
* "rbxassetid://12222216" -- Content ID (alternative version, will work)
|
|
32350
32366
|
*/
|
|
32351
|
-
SoundId:
|
|
32367
|
+
SoundId: ContentId;
|
|
32352
32368
|
/**
|
|
32353
32369
|
* 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
32370
|
*
|
|
@@ -35265,6 +35281,7 @@ interface ChatWindowConfiguration extends TextChatConfigurations {
|
|
|
35265
35281
|
TextStrokeTransparency: number;
|
|
35266
35282
|
VerticalAlignment: Enum.VerticalAlignment;
|
|
35267
35283
|
WidthScale: number;
|
|
35284
|
+
DeriveNewMessageProperties(this: ChatWindowConfiguration): ChatWindowMessageProperties;
|
|
35268
35285
|
}
|
|
35269
35286
|
|
|
35270
35287
|
interface TextChatMessage extends Instance {
|
|
@@ -35349,6 +35366,7 @@ interface TextChatService extends Instance {
|
|
|
35349
35366
|
readonly MessageReceived: RBXScriptSignal<(textChatMessage: TextChatMessage) => void>;
|
|
35350
35367
|
readonly SendingMessage: RBXScriptSignal<(textChatMessage: TextChatMessage) => void>;
|
|
35351
35368
|
OnBubbleAdded: (message: TextChatMessage, adornee: Instance) => TextChatMessageProperties | undefined;
|
|
35369
|
+
OnChatWindowAdded: (message: TextChatMessage) => Array<any>;
|
|
35352
35370
|
OnIncomingMessage: (message: TextChatMessage) => TextChatMessageProperties | undefined;
|
|
35353
35371
|
}
|
|
35354
35372
|
|
|
@@ -35482,7 +35500,7 @@ interface TextService extends Instance {
|
|
|
35482
35500
|
/**
|
|
35483
35501
|
* Tags: Yields
|
|
35484
35502
|
*/
|
|
35485
|
-
GetFamilyInfoAsync(this: TextService, assetId:
|
|
35503
|
+
GetFamilyInfoAsync(this: TextService, assetId: ContentId): object;
|
|
35486
35504
|
/**
|
|
35487
35505
|
* Tags: Yields
|
|
35488
35506
|
*/
|
|
@@ -35787,7 +35805,7 @@ interface Trail extends Instance {
|
|
|
35787
35805
|
*
|
|
35788
35806
|
* 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
35807
|
*/
|
|
35790
|
-
Texture:
|
|
35808
|
+
Texture: ContentId;
|
|
35791
35809
|
/**
|
|
35792
35810
|
* 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
35811
|
*
|
|
@@ -36362,10 +36380,10 @@ interface UIDragDetector extends UIComponent {
|
|
|
36362
36380
|
* @deprecated
|
|
36363
36381
|
*/
|
|
36364
36382
|
readonly _nominal_UIDragDetector: unique symbol;
|
|
36365
|
-
ActivatedCursorIcon:
|
|
36383
|
+
ActivatedCursorIcon: ContentId;
|
|
36366
36384
|
BoundingBehavior: Enum.UIDragDetectorBoundingBehavior;
|
|
36367
36385
|
BoundingUI: GuiBase2d | undefined;
|
|
36368
|
-
CursorIcon:
|
|
36386
|
+
CursorIcon: ContentId;
|
|
36369
36387
|
DragAxis: Vector2;
|
|
36370
36388
|
DragRelativity: Enum.UIDragDetectorDragRelativity;
|
|
36371
36389
|
DragRotation: number;
|
|
@@ -36379,6 +36397,9 @@ interface UIDragDetector extends UIComponent {
|
|
|
36379
36397
|
MinDragTranslation: UDim2;
|
|
36380
36398
|
ReferenceUIInstance: GuiObject | undefined;
|
|
36381
36399
|
ResponseStyle: Enum.UIDragDetectorResponseStyle;
|
|
36400
|
+
SelectionModeDragSpeed: UDim2;
|
|
36401
|
+
SelectionModeRotateSpeed: number;
|
|
36402
|
+
UIDragSpeedAxisMapping: Enum.UIDragSpeedAxisMapping;
|
|
36382
36403
|
AddConstraintFunction(
|
|
36383
36404
|
this: UIDragDetector,
|
|
36384
36405
|
priority: number,
|
|
@@ -37329,7 +37350,7 @@ interface UserInputService extends Instance {
|
|
|
37329
37350
|
* Tags: NotReplicated
|
|
37330
37351
|
*/
|
|
37331
37352
|
readonly MouseEnabled: boolean;
|
|
37332
|
-
MouseIcon:
|
|
37353
|
+
MouseIcon: ContentId;
|
|
37333
37354
|
/**
|
|
37334
37355
|
* 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
37356
|
*
|
|
@@ -37639,7 +37660,7 @@ interface UserInputService extends Instance {
|
|
|
37639
37660
|
* * [UserInputService.GamepadEnabled](https://developer.roblox.com/en-us/api-reference/property/UserInputService/GamepadEnabled)
|
|
37640
37661
|
*/
|
|
37641
37662
|
GetGamepadState(this: UserInputService, gamepadNum: CastsToEnum<Enum.UserInputType>): Array<InputObject>;
|
|
37642
|
-
GetImageForKeyCode(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>):
|
|
37663
|
+
GetImageForKeyCode(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>): ContentId;
|
|
37643
37664
|
/**
|
|
37644
37665
|
* 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
37666
|
*
|
|
@@ -124,7 +124,7 @@ interface AnimationClipProvider extends Instance {
|
|
|
124
124
|
/**
|
|
125
125
|
* @deprecated Use `GetAnimationClipAsync` instead
|
|
126
126
|
*/
|
|
127
|
-
GetAnimationClip(this: AnimationClipProvider, assetId:
|
|
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:
|
|
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:
|
|
228
|
+
CageMeshId: ContentId;
|
|
229
229
|
/**
|
|
230
230
|
* This property is set up automatically by the Avatar Importer plugin.
|
|
231
231
|
*
|
|
@@ -282,7 +282,7 @@ interface WrapDeformer extends BaseWrap {
|
|
|
282
282
|
*/
|
|
283
283
|
readonly _nominal_WrapDeformer: unique symbol;
|
|
284
284
|
Amount: number;
|
|
285
|
-
RenderMeshID:
|
|
285
|
+
RenderMeshID: ContentId;
|
|
286
286
|
}
|
|
287
287
|
|
|
288
288
|
interface WrapLayer extends BaseWrap {
|
|
@@ -307,7 +307,7 @@ interface WrapLayer extends BaseWrap {
|
|
|
307
307
|
*
|
|
308
308
|
* Note: this property is set up automatically by the FBX importer
|
|
309
309
|
*/
|
|
310
|
-
ReferenceMeshId:
|
|
310
|
+
ReferenceMeshId: ContentId;
|
|
311
311
|
/**
|
|
312
312
|
* Reference mesh offset relative to parent MeshPart (in the parent MeshPart space)
|
|
313
313
|
*
|
|
@@ -914,7 +914,7 @@ interface File extends Instance {
|
|
|
914
914
|
*
|
|
915
915
|
* Throws an error if the file does not exist on disk.
|
|
916
916
|
*/
|
|
917
|
-
GetTemporaryId(this: File):
|
|
917
|
+
GetTemporaryId(this: File): ContentId;
|
|
918
918
|
}
|
|
919
919
|
|
|
920
920
|
/** Various miscellaneous options for in-game. Can be accessed from Roblox Studio's settings menu under the _Game_ tab. */
|
|
@@ -1148,7 +1148,7 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
1148
1148
|
* Returns a [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) from a given asset URL.
|
|
1149
1149
|
* @deprecated Use `GetKeyframeSequenceAsync` instead
|
|
1150
1150
|
*/
|
|
1151
|
-
GetKeyframeSequence(this: KeyframeSequenceProvider, assetId:
|
|
1151
|
+
GetKeyframeSequence(this: KeyframeSequenceProvider, assetId: ContentId): Instance | undefined;
|
|
1152
1152
|
/**
|
|
1153
1153
|
* 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
1154
|
* @deprecated Use `GetKeyframeSequenceAsync` instead
|
|
@@ -1182,29 +1182,6 @@ interface BaseScript extends LuaSourceContainer {
|
|
|
1182
1182
|
RunContext: Enum.RunContext;
|
|
1183
1183
|
}
|
|
1184
1184
|
|
|
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
1185
|
interface ModuleScript extends LuaSourceContainer {
|
|
1209
1186
|
/**
|
|
1210
1187
|
* **DO NOT USE!**
|
|
@@ -1230,10 +1207,10 @@ interface MaterialVariant extends Instance {
|
|
|
1230
1207
|
*/
|
|
1231
1208
|
readonly _nominal_MaterialVariant: unique symbol;
|
|
1232
1209
|
BaseMaterial: Enum.Material;
|
|
1233
|
-
ColorMap:
|
|
1234
|
-
MetalnessMap:
|
|
1235
|
-
NormalMap:
|
|
1236
|
-
RoughnessMap:
|
|
1210
|
+
ColorMap: ContentId;
|
|
1211
|
+
MetalnessMap: ContentId;
|
|
1212
|
+
NormalMap: ContentId;
|
|
1213
|
+
RoughnessMap: ContentId;
|
|
1237
1214
|
}
|
|
1238
1215
|
|
|
1239
1216
|
interface MemStorageConnection extends Instance {
|
|
@@ -2744,7 +2721,7 @@ interface PluginToolbarButton extends Instance {
|
|
|
2744
2721
|
/**
|
|
2745
2722
|
* Tags: NotReplicated
|
|
2746
2723
|
*/
|
|
2747
|
-
Icon:
|
|
2724
|
+
Icon: ContentId;
|
|
2748
2725
|
SetActive(this: PluginToolbarButton, active: boolean): void;
|
|
2749
2726
|
/**
|
|
2750
2727
|
* **Click** fires when the PluginToolbarButton is pressed and released by the user.
|
|
@@ -3309,7 +3286,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
3309
3286
|
*
|
|
3310
3287
|
* 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
3288
|
*/
|
|
3312
|
-
GetObjects(this: DataModel, url:
|
|
3289
|
+
GetObjects(this: DataModel, url: ContentId): Array<Instance>;
|
|
3313
3290
|
/**
|
|
3314
3291
|
* 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
3292
|
*
|
|
@@ -3374,6 +3351,7 @@ interface SoundService extends Instance {
|
|
|
3374
3351
|
* @deprecated
|
|
3375
3352
|
*/
|
|
3376
3353
|
readonly _nominal_SoundService: unique symbol;
|
|
3354
|
+
DefaultListenerLocation: Enum.ListenerLocation;
|
|
3377
3355
|
OpenAttenuationCurveEditor(this: SoundService, selectedCurveObjects: Array<Instance>): void;
|
|
3378
3356
|
}
|
|
3379
3357
|
|
|
@@ -3980,7 +3958,7 @@ interface SurfaceAppearance extends Instance {
|
|
|
3980
3958
|
/**
|
|
3981
3959
|
* 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
3960
|
*/
|
|
3983
|
-
ColorMap:
|
|
3961
|
+
ColorMap: ContentId;
|
|
3984
3962
|
/**
|
|
3985
3963
|
* 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
3964
|
*
|
|
@@ -3997,7 +3975,7 @@ interface SurfaceAppearance extends Instance {
|
|
|
3997
3975
|
*
|
|
3998
3976
|
* * 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
3977
|
*/
|
|
4000
|
-
MetalnessMap:
|
|
3978
|
+
MetalnessMap: ContentId;
|
|
4001
3979
|
/**
|
|
4002
3980
|
* This property modifies the lighting of the surface by adding bumps, dents, cracks, and curves without adding more polygons.
|
|
4003
3981
|
*
|
|
@@ -4014,13 +3992,13 @@ interface SurfaceAppearance extends Instance {
|
|
|
4014
3992
|
*
|
|
4015
3993
|
* 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
3994
|
*/
|
|
4017
|
-
NormalMap:
|
|
3995
|
+
NormalMap: ContentId;
|
|
4018
3996
|
/**
|
|
4019
3997
|
* 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
3998
|
*
|
|
4021
3999
|
* 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
4000
|
*/
|
|
4023
|
-
RoughnessMap:
|
|
4001
|
+
RoughnessMap: ContentId;
|
|
4024
4002
|
}
|
|
4025
4003
|
|
|
4026
4004
|
/** TaskScheduler is a read-only settings class responsible for the Task Scheduler feature.
|
|
@@ -4068,10 +4046,10 @@ interface TerrainDetail extends Instance {
|
|
|
4068
4046
|
* @deprecated
|
|
4069
4047
|
*/
|
|
4070
4048
|
readonly _nominal_TerrainDetail: unique symbol;
|
|
4071
|
-
ColorMap:
|
|
4072
|
-
MetalnessMap:
|
|
4073
|
-
NormalMap:
|
|
4074
|
-
RoughnessMap:
|
|
4049
|
+
ColorMap: ContentId;
|
|
4050
|
+
MetalnessMap: ContentId;
|
|
4051
|
+
NormalMap: ContentId;
|
|
4052
|
+
RoughnessMap: ContentId;
|
|
4075
4053
|
}
|
|
4076
4054
|
|
|
4077
4055
|
interface TerrainRegion extends Instance {
|
|
@@ -12642,6 +12642,43 @@ declare namespace Enum {
|
|
|
12642
12642
|
}
|
|
12643
12643
|
export type ListDisplayMode = ListDisplayMode.Horizontal | ListDisplayMode.Vertical;
|
|
12644
12644
|
|
|
12645
|
+
export namespace ListenerLocation {
|
|
12646
|
+
export interface Default extends globalThis.EnumItem {
|
|
12647
|
+
Name: "Default";
|
|
12648
|
+
Value: 0;
|
|
12649
|
+
EnumType: typeof globalThis.Enum.ListenerLocation;
|
|
12650
|
+
}
|
|
12651
|
+
|
|
12652
|
+
export const Default: Default;
|
|
12653
|
+
|
|
12654
|
+
export interface None extends globalThis.EnumItem {
|
|
12655
|
+
Name: "None";
|
|
12656
|
+
Value: 1;
|
|
12657
|
+
EnumType: typeof globalThis.Enum.ListenerLocation;
|
|
12658
|
+
}
|
|
12659
|
+
|
|
12660
|
+
export const None: None;
|
|
12661
|
+
|
|
12662
|
+
export interface Character extends globalThis.EnumItem {
|
|
12663
|
+
Name: "Character";
|
|
12664
|
+
Value: 2;
|
|
12665
|
+
EnumType: typeof globalThis.Enum.ListenerLocation;
|
|
12666
|
+
}
|
|
12667
|
+
|
|
12668
|
+
export const Character: Character;
|
|
12669
|
+
|
|
12670
|
+
export interface Camera extends globalThis.EnumItem {
|
|
12671
|
+
Name: "Camera";
|
|
12672
|
+
Value: 3;
|
|
12673
|
+
EnumType: typeof globalThis.Enum.ListenerLocation;
|
|
12674
|
+
}
|
|
12675
|
+
|
|
12676
|
+
export const Camera: Camera;
|
|
12677
|
+
|
|
12678
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ListenerLocation>;
|
|
12679
|
+
}
|
|
12680
|
+
export type ListenerLocation = ListenerLocation.Default | ListenerLocation.None | ListenerLocation.Character | ListenerLocation.Camera;
|
|
12681
|
+
|
|
12645
12682
|
export namespace ListenerType {
|
|
12646
12683
|
export interface Camera extends globalThis.EnumItem {
|
|
12647
12684
|
Name: "Camera";
|
|
@@ -21918,6 +21955,35 @@ declare namespace Enum {
|
|
|
21918
21955
|
}
|
|
21919
21956
|
export type UIDragDetectorResponseStyle = UIDragDetectorResponseStyle.Offset | UIDragDetectorResponseStyle.Scale | UIDragDetectorResponseStyle.CustomOffset | UIDragDetectorResponseStyle.CustomScale;
|
|
21920
21957
|
|
|
21958
|
+
export namespace UIDragSpeedAxisMapping {
|
|
21959
|
+
export interface XY extends globalThis.EnumItem {
|
|
21960
|
+
Name: "XY";
|
|
21961
|
+
Value: 0;
|
|
21962
|
+
EnumType: typeof globalThis.Enum.UIDragSpeedAxisMapping;
|
|
21963
|
+
}
|
|
21964
|
+
|
|
21965
|
+
export const XY: XY;
|
|
21966
|
+
|
|
21967
|
+
export interface XX extends globalThis.EnumItem {
|
|
21968
|
+
Name: "XX";
|
|
21969
|
+
Value: 1;
|
|
21970
|
+
EnumType: typeof globalThis.Enum.UIDragSpeedAxisMapping;
|
|
21971
|
+
}
|
|
21972
|
+
|
|
21973
|
+
export const XX: XX;
|
|
21974
|
+
|
|
21975
|
+
export interface YY extends globalThis.EnumItem {
|
|
21976
|
+
Name: "YY";
|
|
21977
|
+
Value: 2;
|
|
21978
|
+
EnumType: typeof globalThis.Enum.UIDragSpeedAxisMapping;
|
|
21979
|
+
}
|
|
21980
|
+
|
|
21981
|
+
export const YY: YY;
|
|
21982
|
+
|
|
21983
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.UIDragSpeedAxisMapping>;
|
|
21984
|
+
}
|
|
21985
|
+
export type UIDragSpeedAxisMapping = UIDragSpeedAxisMapping.XY | UIDragSpeedAxisMapping.XX | UIDragSpeedAxisMapping.YY;
|
|
21986
|
+
|
|
21921
21987
|
export namespace UIFlexAlignment {
|
|
21922
21988
|
export interface None extends globalThis.EnumItem {
|
|
21923
21989
|
Name: "None";
|
|
@@ -23270,6 +23336,27 @@ declare namespace Enum {
|
|
|
23270
23336
|
}
|
|
23271
23337
|
export type WeldConstraintPreserve = WeldConstraintPreserve.All | WeldConstraintPreserve.None | WeldConstraintPreserve.Touching;
|
|
23272
23338
|
|
|
23339
|
+
export namespace WhisperChatPrivacyMode {
|
|
23340
|
+
export interface AllUsers extends globalThis.EnumItem {
|
|
23341
|
+
Name: "AllUsers";
|
|
23342
|
+
Value: 0;
|
|
23343
|
+
EnumType: typeof globalThis.Enum.WhisperChatPrivacyMode;
|
|
23344
|
+
}
|
|
23345
|
+
|
|
23346
|
+
export const AllUsers: AllUsers;
|
|
23347
|
+
|
|
23348
|
+
export interface NoOne extends globalThis.EnumItem {
|
|
23349
|
+
Name: "NoOne";
|
|
23350
|
+
Value: 1;
|
|
23351
|
+
EnumType: typeof globalThis.Enum.WhisperChatPrivacyMode;
|
|
23352
|
+
}
|
|
23353
|
+
|
|
23354
|
+
export const NoOne: NoOne;
|
|
23355
|
+
|
|
23356
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.WhisperChatPrivacyMode>;
|
|
23357
|
+
}
|
|
23358
|
+
export type WhisperChatPrivacyMode = WhisperChatPrivacyMode.AllUsers | WhisperChatPrivacyMode.NoOne;
|
|
23359
|
+
|
|
23273
23360
|
export namespace WrapLayerAutoSkin {
|
|
23274
23361
|
export interface Disabled extends globalThis.EnumItem {
|
|
23275
23362
|
Name: "Disabled";
|
package/include/roblox.d.ts
CHANGED
|
@@ -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>;
|