@rbxts/types 1.0.542 → 1.0.546
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/include/generated/None.d.ts +105 -17
- package/include/generated/enums.d.ts +6 -22
- package/include/lua.d.ts +3 -3
- package/package.json +1 -1
|
@@ -21,6 +21,7 @@ interface Services {
|
|
|
21
21
|
Chat: Chat;
|
|
22
22
|
CollectionService: CollectionService;
|
|
23
23
|
CommandService: CommandService;
|
|
24
|
+
ConfigureServerService: ConfigureServerService;
|
|
24
25
|
ContentProvider: ContentProvider;
|
|
25
26
|
ContextActionService: ContextActionService;
|
|
26
27
|
ControllerService: ControllerService;
|
|
@@ -302,6 +303,7 @@ interface CreatableInstances {
|
|
|
302
303
|
VelocityMotor: VelocityMotor;
|
|
303
304
|
VideoFrame: VideoFrame;
|
|
304
305
|
ViewportFrame: ViewportFrame;
|
|
306
|
+
VoiceChannel: VoiceChannel;
|
|
305
307
|
WedgePart: WedgePart;
|
|
306
308
|
Weld: Weld;
|
|
307
309
|
WeldConstraint: WeldConstraint;
|
|
@@ -699,7 +701,13 @@ interface Instance {
|
|
|
699
701
|
className: T,
|
|
700
702
|
recursive?: boolean,
|
|
701
703
|
): Instances[T] | undefined;
|
|
704
|
+
/**
|
|
705
|
+
* Returns the first descendant found with the given FullName (or partial FullName).
|
|
706
|
+
*/
|
|
702
707
|
FindFirstDescendant(this: Instance, name: string): Instance | undefined;
|
|
708
|
+
/**
|
|
709
|
+
* Returns the Actor associated with the Instance, usually the first Actor ancestor
|
|
710
|
+
*/
|
|
703
711
|
GetActor(this: Instance): Actor;
|
|
704
712
|
/**
|
|
705
713
|
* This function returns the attribute which has been assigned to the given name. If no attribute has been assigned then nil is returned.
|
|
@@ -1095,7 +1103,7 @@ interface Accoutrement extends Instance {
|
|
|
1095
1103
|
AttachmentUp: Vector3;
|
|
1096
1104
|
}
|
|
1097
1105
|
|
|
1098
|
-
/** The Accessory class is
|
|
1106
|
+
/** The Accessory class is the successor to the legacy Hat system.
|
|
1099
1107
|
* It's designed to be cross-compatible with both the legacy R6 character system, and the new R15 character system.
|
|
1100
1108
|
*
|
|
1101
1109
|
* If an [Attachment](https://developer.roblox.com/en-us/api-reference/class/Attachment) is inserted into the Accessory's Handle with the same name as an [Attachment](https://developer.roblox.com/en-us/api-reference/class/Attachment) found in one of the character's limbs, they will connect, and the properties inherited from the [Accoutrement](https://developer.roblox.com/en-us/api-reference/class/Accoutrement) class will be ignored. Otherwise, the Accessory functions identically to a [Hat](https://developer.roblox.com/en-us/api-reference/class/Hat).
|
|
@@ -2338,6 +2346,7 @@ interface AvatarEditorService extends Instance {
|
|
|
2338
2346
|
* This function prompts the [Players.LocalPlayer](https://developer.roblox.com/en-us/api-reference/property/Players/LocalPlayer) to favorite or unfavorite the given asset or bundle.
|
|
2339
2347
|
*/
|
|
2340
2348
|
PromptSetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>, shouldFavorite: boolean): void;
|
|
2349
|
+
PromptUpdateOutfit(this: AvatarEditorService, outfitId: number, updatedOutfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): void;
|
|
2341
2350
|
/**
|
|
2342
2351
|
* Tags: Yields
|
|
2343
2352
|
*/
|
|
@@ -2652,6 +2661,7 @@ interface AvatarEditorService extends Instance {
|
|
|
2652
2661
|
* This event fires when the [AvatarEditorService:PromptSetFavorite](https://developer.roblox.com/en-us/api-reference/function/AvatarEditorService/PromptSetFavorite) operation is completed. It can only return the Success or PermissionDenied [enum](https://developer.roblox.com/en-us/api-reference/enum/AvatarPromptResult) statuses as it does not perform any web requests which could fail.
|
|
2653
2662
|
*/
|
|
2654
2663
|
readonly PromptSetFavoriteCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult) => void>;
|
|
2664
|
+
readonly PromptUpdateOutfitCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult) => void>;
|
|
2655
2665
|
}
|
|
2656
2666
|
|
|
2657
2667
|
interface AvatarImportService extends Instance {
|
|
@@ -6281,6 +6291,17 @@ interface Configuration extends Instance {
|
|
|
6281
6291
|
readonly _nominal_Configuration: unique symbol;
|
|
6282
6292
|
}
|
|
6283
6293
|
|
|
6294
|
+
interface ConfigureServerService extends Instance {
|
|
6295
|
+
/**
|
|
6296
|
+
* **DO NOT USE!**
|
|
6297
|
+
*
|
|
6298
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
6299
|
+
* @hidden
|
|
6300
|
+
* @deprecated
|
|
6301
|
+
*/
|
|
6302
|
+
readonly _nominal_ConfigureServerService: unique symbol;
|
|
6303
|
+
}
|
|
6304
|
+
|
|
6284
6305
|
/** The base class for Constraint-based objects. */
|
|
6285
6306
|
interface Constraint extends Instance {
|
|
6286
6307
|
/**
|
|
@@ -6752,6 +6773,10 @@ interface LineForce extends Constraint {
|
|
|
6752
6773
|
ReactionForceEnabled: boolean;
|
|
6753
6774
|
}
|
|
6754
6775
|
|
|
6776
|
+
/** The **LinearVelocity** constraint applies force on a part/assembly to maintain a linear velocity.
|
|
6777
|
+
*
|
|
6778
|
+
* This object maintains all functionality of [BodyVelocity](https://developer.roblox.com/en-us/api-reference/class/BodyVelocity), a legacy body mover. To instead apply a constant force, use a [VectorForce](https://developer.roblox.com/en-us/api-reference/class/VectorForce) object instead.
|
|
6779
|
+
*/
|
|
6755
6780
|
interface LinearVelocity extends Constraint {
|
|
6756
6781
|
/**
|
|
6757
6782
|
* **DO NOT USE!**
|
|
@@ -6762,28 +6787,48 @@ interface LinearVelocity extends Constraint {
|
|
|
6762
6787
|
*/
|
|
6763
6788
|
readonly _nominal_LinearVelocity: unique symbol;
|
|
6764
6789
|
/**
|
|
6765
|
-
*
|
|
6790
|
+
* The normalized [Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3) direction for constraining the velocity along a line, when `LinearVelocity/VelocityConstraintMode| VelocityConstraintMode` is set to **Line**. Default is \[1, 0, 0\].
|
|
6766
6791
|
*/
|
|
6767
6792
|
LineDirection: Vector3;
|
|
6768
6793
|
/**
|
|
6769
|
-
*
|
|
6794
|
+
* Float value of the velocity when [VelocityConstraintMode](https://developer.roblox.com/en-us/api-reference/property/LinearVelocity/VelocityConstraintMode) is set to **Line**. Default is 0.
|
|
6770
6795
|
*/
|
|
6771
6796
|
LineVelocity: number;
|
|
6772
6797
|
/**
|
|
6773
|
-
* Maximum
|
|
6798
|
+
* Maximum magnitude of the force vector the constraint can apply.
|
|
6774
6799
|
*/
|
|
6775
6800
|
MaxForce: number;
|
|
6776
6801
|
/**
|
|
6777
|
-
*
|
|
6802
|
+
* [Vector2](https://developer.roblox.com/en-us/api-reference/datatype/Vector2) value of the velocity in each tangent direction of the plane, when [VelocityConstraintMode](https://developer.roblox.com/en-us/api-reference/property/LinearVelocity/VelocityConstraintMode) is set to **Plane**. Default is \[0, 0\].
|
|
6778
6803
|
*/
|
|
6779
6804
|
PlaneVelocity: Vector2;
|
|
6805
|
+
/**
|
|
6806
|
+
* The primary axis in the plane, when [VelocityConstraintMode](https://developer.roblox.com/en-us/api-reference/property/LinearVelocity/VelocityConstraintMode) is set to **Plane**. Value depends on the value of `LinearVelocityConstraint/RelativeTo|RelativeTo` as follows:
|
|
6807
|
+
*
|
|
6808
|
+
* * If `LinearVelocityConstraint/RelativeTo|RelativeTo` is set to **Attachment0**, this axis is the [Axis](https://developer.roblox.com/en-us/api-reference/property/Attachment/Axis) of [Attachment0](https://developer.roblox.com/en-us/api-reference/property/Constraint/Attachment0).
|
|
6809
|
+
* * If `LinearVelocityConstraint/RelativeTo|RelativeTo` is set to **Attachment1**, this axis is the [Axis](https://developer.roblox.com/en-us/api-reference/property/Attachment/Axis) of [Attachment1](https://developer.roblox.com/en-us/api-reference/property/Constraint/Attachment1).
|
|
6810
|
+
* * If `LinearVelocityConstraint/RelativeTo|RelativeTo` is set to **World**, this value must be specified in the world space.
|
|
6811
|
+
*/
|
|
6780
6812
|
PrimaryTangentAxis: Vector3;
|
|
6781
6813
|
/**
|
|
6782
|
-
*
|
|
6814
|
+
* Sets the [ActuatorRelativeTo](https://developer.roblox.com/en-us/api-reference/enum/ActuatorRelativeTo) property for the [LinearVelocity](https://developer.roblox.com/en-us/api-reference/class/LinearVelocity) constraint.
|
|
6783
6815
|
*/
|
|
6784
6816
|
RelativeTo: Enum.ActuatorRelativeTo;
|
|
6817
|
+
/**
|
|
6818
|
+
* The secondary axis in the plane, when [VelocityConstraintMode](https://developer.roblox.com/en-us/api-reference/property/LinearVelocity/VelocityConstraintMode) is set to **Plane**. Value depends on the value of `LinearVelocityConstraint/RelativeTo|RelativeTo` as follows:
|
|
6819
|
+
*
|
|
6820
|
+
* * If `LinearVelocityConstraint/RelativeTo|RelativeTo` is set to **Attachment0**, this axis is the [SecondaryAxis](https://developer.roblox.com/en-us/api-reference/property/Attachment/SecondaryAxis) of [Attachment0](https://developer.roblox.com/en-us/api-reference/property/Constraint/Attachment0).
|
|
6821
|
+
* * If `LinearVelocityConstraint/RelativeTo|RelativeTo` is set to **Attachment1**, this axis is the [SecondaryAxis](https://developer.roblox.com/en-us/api-reference/property/Attachment/SecondaryAxis) of [Attachment1](https://developer.roblox.com/en-us/api-reference/property/Constraint/Attachment1).
|
|
6822
|
+
* * If `LinearVelocityConstraint/RelativeTo|RelativeTo` is set to **World**, this value must be specified in the world space.
|
|
6823
|
+
*/
|
|
6785
6824
|
SecondaryTangentAxis: Vector3;
|
|
6825
|
+
/**
|
|
6826
|
+
* [Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3) velocity value when [VelocityConstraintMode](https://developer.roblox.com/en-us/api-reference/property/LinearVelocity/VelocityConstraintMode) is set to **Vector**. Default is \[0, 0, 0\].
|
|
6827
|
+
*/
|
|
6786
6828
|
VectorVelocity: Vector3;
|
|
6829
|
+
/**
|
|
6830
|
+
* The mode of the [LinearVelocity](https://developer.roblox.com/en-us/api-reference/class/LinearVelocity) constraint: **Line**, **Plane**, or **Vector**. Default is **Vector**.
|
|
6831
|
+
*/
|
|
6787
6832
|
VelocityConstraintMode: Enum.VelocityConstraintMode;
|
|
6788
6833
|
}
|
|
6789
6834
|
|
|
@@ -9378,9 +9423,9 @@ interface Fire extends Instance {
|
|
|
9378
9423
|
Size: number;
|
|
9379
9424
|
}
|
|
9380
9425
|
|
|
9381
|
-
/** An instance representing a 1D float curve encoded via a sorted list of [FloatCurveKeys](https://developer.roblox.com/en-us/api-reference/
|
|
9426
|
+
/** An instance representing a 1D float curve encoded via a sorted list of [FloatCurveKeys](https://developer.roblox.com/en-us/api-reference/datatype/FloatCurveKey).
|
|
9382
9427
|
*
|
|
9383
|
-
*
|
|
9428
|
+
* [FloatCurveKeys](https://developer.roblox.com/en-us/api-reference/datatype/FloatCurveKey) are value-time points that represent the changes in value over time. The changes of a single value over time are represented by a curve. Animators can edit keys to modify a curve. The shape of the curve is dictated by the [KeyInterpolationMode](https://developer.roblox.com/en-us/api-reference/enum/KeyInterpolationMode) chosen at each key.
|
|
9384
9429
|
*/
|
|
9385
9430
|
interface FloatCurve extends Instance {
|
|
9386
9431
|
/**
|
|
@@ -10986,6 +11031,10 @@ interface TextButton extends GuiButton {
|
|
|
10986
11031
|
* @deprecated
|
|
10987
11032
|
*/
|
|
10988
11033
|
readonly _nominal_TextButton: unique symbol;
|
|
11034
|
+
/**
|
|
11035
|
+
* Tags: ReadOnly, NotReplicated
|
|
11036
|
+
*/
|
|
11037
|
+
readonly ContentText: string;
|
|
10989
11038
|
/**
|
|
10990
11039
|
* The Font property selects one of several pre-defined fonts with which the UI element will render its text. Some fonts have bold, italic and/or light variants (as there is no font-weight or font-style properties).
|
|
10991
11040
|
*
|
|
@@ -11243,7 +11292,7 @@ interface ImageLabel extends GuiLabel {
|
|
|
11243
11292
|
*
|
|
11244
11293
|
* [TextService:GetTextSize](https://developer.roblox.com/en-us/api-reference/function/TextService/GetTextSize) can be used to get the size (bounds) of text that would be rendered in a TextLabel given a font size, font, and frame size.
|
|
11245
11294
|
*
|
|
11246
|
-
* A [UITextSizeConstraint](https://developer.roblox.com/en-us/api-reference/class/UITextSizeConstraint) object can be used to constrain the size of text with [TextLabel.TextScaled](https://developer.roblox.com/en-us/api-reference/property/TextLabel/TextScaled) enabled.
|
|
11295
|
+
* A [UITextSizeConstraint](https://developer.roblox.com/en-us/api-reference/class/UITextSizeConstraint) object can be used to constrain the size of text with [TextLabel.TextScaled](https://developer.roblox.com/en-us/api-reference/property/TextLabel/TextScaled) enabled. It is recommended that the size of text is no lower than 9 pixels, otherwise it may not be visible to most users. See `articles/Accessibility Best Practices` for more information.
|
|
11247
11296
|
*/
|
|
11248
11297
|
interface TextLabel extends GuiLabel {
|
|
11249
11298
|
/**
|
|
@@ -11254,6 +11303,10 @@ interface TextLabel extends GuiLabel {
|
|
|
11254
11303
|
* @deprecated
|
|
11255
11304
|
*/
|
|
11256
11305
|
readonly _nominal_TextLabel: unique symbol;
|
|
11306
|
+
/**
|
|
11307
|
+
* Tags: ReadOnly, NotReplicated
|
|
11308
|
+
*/
|
|
11309
|
+
readonly ContentText: string;
|
|
11257
11310
|
/**
|
|
11258
11311
|
* The Font property selects one of several pre-defined fonts with which the UI element will render its text. Some fonts have bold, italic and/or light variants (as there is no font-weight or font-style properties).
|
|
11259
11312
|
*
|
|
@@ -11620,6 +11673,10 @@ interface TextBox extends GuiObject {
|
|
|
11620
11673
|
* Determines whether clicking on the TextBox will clear its [TextBox.Text](https://developer.roblox.com/en-us/api-reference/property/TextBox/Text) property
|
|
11621
11674
|
*/
|
|
11622
11675
|
ClearTextOnFocus: boolean;
|
|
11676
|
+
/**
|
|
11677
|
+
* Tags: ReadOnly, NotReplicated
|
|
11678
|
+
*/
|
|
11679
|
+
readonly ContentText: string;
|
|
11623
11680
|
/**
|
|
11624
11681
|
* **CursorPosition** determines the offset of the text cursor in bytes, or -1 if the TextBox is not currently being edited. A value of 1 represents the beginning, the position before the first byte in the [Text](https://developer.roblox.com/en-us/api-reference/property/TextBox/Text) property. When used in conjunction with the [SelectionStart](https://developer.roblox.com/en-us/api-reference/property/TextBox/SelectionStart) property, it is possible to both get and set selected text within a TextBox.
|
|
11625
11682
|
*
|
|
@@ -13181,6 +13238,7 @@ interface Highlight extends Instance {
|
|
|
13181
13238
|
* Considerations
|
|
13182
13239
|
* --------------
|
|
13183
13240
|
*
|
|
13241
|
+
* * There are port restrictions. You cannot use port 1194 or any port below 1024, except 80 and 443.
|
|
13184
13242
|
* * For each Roblox game server, there is a limit of 500 HTTP requests per minute. Exceeding this may cause request-sending functions to stall entirely for about 30 seconds.
|
|
13185
13243
|
* * Requests cannot be made to any Roblox website, such as [www.roblox.com](http://www.roblox.com).
|
|
13186
13244
|
* * Web requests can fail for many reasons, so it is important to “code defensively” (use `pcall`) and have a plan for when requests fail.
|
|
@@ -15221,6 +15279,7 @@ interface ImporterGroupSettings extends ImporterBaseSettings {
|
|
|
15221
15279
|
*/
|
|
15222
15280
|
readonly _nominal_ImporterGroupSettings: unique symbol;
|
|
15223
15281
|
ImportAsModelAsset: boolean;
|
|
15282
|
+
InsertInWorkspace: boolean;
|
|
15224
15283
|
}
|
|
15225
15284
|
|
|
15226
15285
|
interface ImporterJointSettings extends ImporterBaseSettings {
|
|
@@ -15270,6 +15329,7 @@ interface ImporterRootSettings extends ImporterBaseSettings {
|
|
|
15270
15329
|
*/
|
|
15271
15330
|
readonly FileDimensions: Vector3;
|
|
15272
15331
|
ImportAsModelAsset: boolean;
|
|
15332
|
+
InsertInWorkspace: boolean;
|
|
15273
15333
|
InvertNegativeFaces: boolean;
|
|
15274
15334
|
MergeMeshes: boolean;
|
|
15275
15335
|
/**
|
|
@@ -15280,7 +15340,6 @@ interface ImporterRootSettings extends ImporterBaseSettings {
|
|
|
15280
15340
|
ScaleUnit: Enum.MeshScaleUnit;
|
|
15281
15341
|
WorldForward: Enum.NormalId;
|
|
15282
15342
|
WorldUp: Enum.NormalId;
|
|
15283
|
-
ZeroOrigin: boolean;
|
|
15284
15343
|
}
|
|
15285
15344
|
|
|
15286
15345
|
interface ImporterTextureSettings extends ImporterBaseSettings {
|
|
@@ -23151,7 +23210,25 @@ interface WorldRoot extends Model {
|
|
|
23151
23210
|
whitelistDescendantsTable: Array<Instance>,
|
|
23152
23211
|
maxParts?: number,
|
|
23153
23212
|
): Array<BasePart>;
|
|
23213
|
+
/**
|
|
23214
|
+
* **GetPartBoundsInBox** returns an array of parts whose _bounding boxes_ overlap a box whose volume is described using the given center (CFrame) and size (Vector3).
|
|
23215
|
+
*
|
|
23216
|
+
* Beware that this spatial query function efficiently considers the volume of parts' bounding boxes rather than their actual occupied volume. This may be important when considering cylinders, spheres, unions, and [MeshPart](https://developer.roblox.com/en-us/api-reference/class/MeshPart), which have non-block shapes. For cases where accuracy particularly matters, use [GetPartsInPart](https://developer.roblox.com/en-us/api-reference/function/WorldRoot/GetPartsInPart) instead or further filter the results of this function yourself.
|
|
23217
|
+
*
|
|
23218
|
+
* This function uses an [OverlapParams](https://developer.roblox.com/en-us/api-reference/datatype/OverlapParams) object to describe reusable portions of the spatial query, such as an instance whitelist/blacklist, the maximum number of parts to query, and what `articles/Collision Filtering|collision group` to use. When making repeated spatial queries using functions like this, you should construct just one of these objects and reuse it.
|
|
23219
|
+
*
|
|
23220
|
+
* This and other spatial query functions do not consider parts' [CanCollide](https://developer.roblox.com/en-us/api-reference/property/BasePart/CanCollide) or [CanTouch](https://developer.roblox.com/en-us/api-reference/property/BasePart/CanTouch) properties. However, it will consider parts' collision group if specified by the given OverlapParams.
|
|
23221
|
+
*/
|
|
23154
23222
|
GetPartBoundsInBox(this: WorldRoot, cframe: CFrame, size: Vector3, overlapParams?: OverlapParams): Array<Instance>;
|
|
23223
|
+
/**
|
|
23224
|
+
* **GetPartBoundsInRadius** returns an array of parts whose _bounding boxes_ overlap a sphere whose volume is described using the given center (Vector3) and radius (number).
|
|
23225
|
+
*
|
|
23226
|
+
* Beware that this spatial query function efficiently considers the volume of parts' bounding boxes rather than their actual occupied volume. This may be important when considering cylinders, spheres, unions, and [MeshPart](https://developer.roblox.com/en-us/api-reference/class/MeshPart), which have non-block shapes. For cases where accuracy particularly matters, use [GetPartsInPart](https://developer.roblox.com/en-us/api-reference/function/WorldRoot/GetPartsInPart) instead or further filter the results of this function yourself.
|
|
23227
|
+
*
|
|
23228
|
+
* This function uses an [OverlapParams](https://developer.roblox.com/en-us/api-reference/datatype/OverlapParams) object to describe reusable portions of the spatial query, such as an instance whitelist/blacklist, the maximum number of parts to query, and what `articles/Collision Filtering|collision group` to use. When making repeated spatial queries using functions like this, you should construct just one of these objects and reuse it.
|
|
23229
|
+
*
|
|
23230
|
+
* This and other spatial query functions do not consider parts' [CanCollide](https://developer.roblox.com/en-us/api-reference/property/BasePart/CanCollide) or [CanTouch](https://developer.roblox.com/en-us/api-reference/property/BasePart/CanTouch) properties. However, it will consider parts' collision group if specified by the given OverlapParams.
|
|
23231
|
+
*/
|
|
23155
23232
|
GetPartBoundsInRadius(this: WorldRoot, position: Vector3, radius: number, overlapParams?: OverlapParams): Array<Instance>;
|
|
23156
23233
|
GetPartsInPart(this: WorldRoot, part: BasePart, overlapParams?: OverlapParams): Array<Instance>;
|
|
23157
23234
|
/**
|
|
@@ -23760,11 +23837,13 @@ interface StandardPages<T = unknown> extends Pages<T> {
|
|
|
23760
23837
|
readonly _nominal_StandardPages: unique symbol;
|
|
23761
23838
|
}
|
|
23762
23839
|
|
|
23763
|
-
/** A ParticleEmitter allows for the creation of [particle systems](https://en.wikipedia.org/wiki/Particle_system). is a special effect object that emits customizable 2D billboard particles into the world. On Roblox, a particle is a 2D image
|
|
23840
|
+
/** A ParticleEmitter allows for the creation of [particle systems](https://en.wikipedia.org/wiki/Particle_system). It is a special effect object that emits customizable 2D billboard particles into the world. On Roblox, a particle is a square 2D image, like a [BillboardGui](https://developer.roblox.com/en-us/api-reference/class/BillboardGui) or [SurfaceGui](https://developer.roblox.com/en-us/api-reference/class/SurfaceGui) with an [ImageLabel](https://developer.roblox.com/en-us/api-reference/class/ImageLabel).
|
|
23764
23841
|
*
|
|
23765
|
-
* ParticleEmitter must be 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 part. Particles
|
|
23842
|
+
* To emit and render particles, a ParticleEmitter must be 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 part. Particles are emit automatically when the emitter is [Enabled](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Enabled) with a non-zero [Rate](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Rate), or manually when the [Emit](https://developer.roblox.com/en-us/api-reference/function/ParticleEmitter/Emit) method is called. The starting positions of particles are determined by the [Shape](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Shape) and [ShapePartial](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/ShapePartial) properties as well as the parent [BasePart.Size](https://developer.roblox.com/en-us/api-reference/property/BasePart/Size). By default, particles spawn randomly in the **bounding box** of the parent part, although this can be configured to be on a specific surface by the emitter's [ShapeStyle](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/ShapeStyle) and [EmissionDirection](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/EmissionDirection). With a non-zero [Speed](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Speed), particles are set in motion outwards and/or inwards, depending on the [ShapeInOut](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/ShapeInOut) property. The direction can be randomized with [SpreadAngle](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/SpreadAngle). By default, particles face the camera, but the [Orientation](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Orientation) can be modified to respect the particle velocity instead.
|
|
23766
23843
|
*
|
|
23767
|
-
*
|
|
23844
|
+
* During the [Lifetime](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Lifetime) of the particles, they can change appearance according to the [Color](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Color) and [Size](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Size). Their motion can change over time according to the [Drag](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Drag) and [Acceleration](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Acceleration) properties, and they can also move as their parent moves when they are [LockedToPart](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/LockedToPart) or have a non-zero [VelocityInheritance](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/VelocityInheritance).
|
|
23845
|
+
*
|
|
23846
|
+
* Roblox provides several pre-made particle effect objects - [Fire](https://developer.roblox.com/en-us/api-reference/class/Fire), [Smoke](https://developer.roblox.com/en-us/api-reference/class/Smoke) and [Sparkles](https://developer.roblox.com/en-us/api-reference/class/Sparkles). They behave similarly to a ParticleEmitter, but they are not as customizable. They also lack the particle-controlling methods ([Emit](https://developer.roblox.com/en-us/api-reference/function/ParticleEmitter/Emit) and [Clear](https://developer.roblox.com/en-us/api-reference/function/ParticleEmitter/Clear)). An [Explosion](https://developer.roblox.com/en-us/api-reference/class/Explosion) also creates particles, but provides little-to-no control with regards to how the effect looks.
|
|
23768
23847
|
*
|
|
23769
23848
|
* See also
|
|
23770
23849
|
* --------
|
|
@@ -30983,13 +31062,11 @@ interface UISizeConstraint extends UIConstraint {
|
|
|
30983
31062
|
MinSize: Vector2;
|
|
30984
31063
|
}
|
|
30985
31064
|
|
|
30986
|
-
/**
|
|
31065
|
+
/** A **UITextSizeConstraint** ensures that the size of text rendered by certain [GuiObject](https://developer.roblox.com/en-us/api-reference/class/GuiObject) classes ([TextLabel](https://developer.roblox.com/en-us/api-reference/class/TextLabel), [TextButton](https://developer.roblox.com/en-us/api-reference/class/TextButton), or [TextBox](https://developer.roblox.com/en-us/api-reference/class/TextBox)) lies within the range described by [MaxTextSize](https://developer.roblox.com/en-us/api-reference/property/UITextSizeConstraint/MaxTextSize) and [MinTextSize](https://developer.roblox.com/en-us/api-reference/property/UITextSizeConstraint/MinTextSize). It is meant to be used alongside [TextLabel.TextScaled](https://developer.roblox.com/en-us/api-reference/property/TextLabel/TextScaled), which automatically scales text to fill its containing object. Like other UI constraints, it is applied when parented to the object to be constrained.
|
|
30987
31066
|
*
|
|
30988
31067
|
* 
|
|
30989
31068
|
*
|
|
30990
|
-
*
|
|
30991
|
-
*
|
|
30992
|
-
* A UITextSizeConstraint can be applied to a GuiObject by parenting it to that object.
|
|
31069
|
+
* It's recommended that no values lower than 9 be used for [MinTextSize](https://developer.roblox.com/en-us/api-reference/property/UITextSizeConstraint/MinTextSize) property, otherwise text may not be readable to most users. See `articles/Accessibility Best Practices` for more information.
|
|
30993
31070
|
*/
|
|
30994
31071
|
interface UITextSizeConstraint extends UIConstraint {
|
|
30995
31072
|
/**
|
|
@@ -33892,6 +33969,17 @@ interface Vector3Curve extends Instance {
|
|
|
33892
33969
|
Z(this: Vector3Curve): FloatCurve;
|
|
33893
33970
|
}
|
|
33894
33971
|
|
|
33972
|
+
interface VoiceChannel extends Instance {
|
|
33973
|
+
/**
|
|
33974
|
+
* **DO NOT USE!**
|
|
33975
|
+
*
|
|
33976
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
33977
|
+
* @hidden
|
|
33978
|
+
* @deprecated
|
|
33979
|
+
*/
|
|
33980
|
+
readonly _nominal_VoiceChannel: unique symbol;
|
|
33981
|
+
}
|
|
33982
|
+
|
|
33895
33983
|
interface VoiceChatInternal extends Instance {
|
|
33896
33984
|
/**
|
|
33897
33985
|
* **DO NOT USE!**
|
|
@@ -11666,17 +11666,9 @@ declare namespace Enum {
|
|
|
11666
11666
|
}
|
|
11667
11667
|
export type RibbonTool = RibbonTool.Select | RibbonTool.Scale | RibbonTool.Rotate | RibbonTool.Move | RibbonTool.Transform | RibbonTool.ColorPicker | RibbonTool.MaterialPicker | RibbonTool.Group | RibbonTool.Ungroup | RibbonTool.None;
|
|
11668
11668
|
export namespace RigType {
|
|
11669
|
-
export interface R6 {
|
|
11670
|
-
Name: "R6";
|
|
11671
|
-
Value: 0;
|
|
11672
|
-
EnumType: EnumType<RigType>;
|
|
11673
|
-
}
|
|
11674
|
-
|
|
11675
|
-
export const R6: R6;
|
|
11676
|
-
|
|
11677
11669
|
export interface R15 {
|
|
11678
11670
|
Name: "R15";
|
|
11679
|
-
Value:
|
|
11671
|
+
Value: 0;
|
|
11680
11672
|
EnumType: EnumType<RigType>;
|
|
11681
11673
|
}
|
|
11682
11674
|
|
|
@@ -11684,7 +11676,7 @@ declare namespace Enum {
|
|
|
11684
11676
|
|
|
11685
11677
|
export interface Rthro {
|
|
11686
11678
|
Name: "Rthro";
|
|
11687
|
-
Value:
|
|
11679
|
+
Value: 1;
|
|
11688
11680
|
EnumType: EnumType<RigType>;
|
|
11689
11681
|
}
|
|
11690
11682
|
|
|
@@ -11692,23 +11684,15 @@ declare namespace Enum {
|
|
|
11692
11684
|
|
|
11693
11685
|
export interface RthroNarrow {
|
|
11694
11686
|
Name: "RthroNarrow";
|
|
11695
|
-
Value:
|
|
11687
|
+
Value: 2;
|
|
11696
11688
|
EnumType: EnumType<RigType>;
|
|
11697
11689
|
}
|
|
11698
11690
|
|
|
11699
11691
|
export const RthroNarrow: RthroNarrow;
|
|
11700
11692
|
|
|
11701
|
-
export interface S15 {
|
|
11702
|
-
Name: "S15";
|
|
11703
|
-
Value: 4;
|
|
11704
|
-
EnumType: EnumType<RigType>;
|
|
11705
|
-
}
|
|
11706
|
-
|
|
11707
|
-
export const S15: S15;
|
|
11708
|
-
|
|
11709
11693
|
export interface Custom {
|
|
11710
11694
|
Name: "Custom";
|
|
11711
|
-
Value:
|
|
11695
|
+
Value: 3;
|
|
11712
11696
|
EnumType: EnumType<RigType>;
|
|
11713
11697
|
}
|
|
11714
11698
|
|
|
@@ -11716,7 +11700,7 @@ declare namespace Enum {
|
|
|
11716
11700
|
|
|
11717
11701
|
export interface None {
|
|
11718
11702
|
Name: "None";
|
|
11719
|
-
Value:
|
|
11703
|
+
Value: 4;
|
|
11720
11704
|
EnumType: EnumType<RigType>;
|
|
11721
11705
|
}
|
|
11722
11706
|
|
|
@@ -11724,7 +11708,7 @@ declare namespace Enum {
|
|
|
11724
11708
|
|
|
11725
11709
|
export function GetEnumItems(this: defined): Array<RigType>
|
|
11726
11710
|
}
|
|
11727
|
-
export type RigType = RigType.
|
|
11711
|
+
export type RigType = RigType.R15 | RigType.Rthro | RigType.RthroNarrow | RigType.Custom | RigType.None;
|
|
11728
11712
|
export namespace RollOffMode {
|
|
11729
11713
|
export interface Inverse {
|
|
11730
11714
|
Name: "Inverse";
|
package/include/lua.d.ts
CHANGED
|
@@ -36,7 +36,7 @@ declare function rawget(t: unknown, index: unknown): unknown;
|
|
|
36
36
|
declare function rawset(t: unknown, index: unknown, value: unknown): void;
|
|
37
37
|
|
|
38
38
|
/** Returns all arguments after argument number index. */
|
|
39
|
-
declare function select(index: number, ...args: Array<unknown>): Array<unknown
|
|
39
|
+
declare function select(index: number, ...args: Array<unknown>): LuaTuple<Array<unknown>>;
|
|
40
40
|
|
|
41
41
|
/** Returns the total number of arguments that were passed after the cmd argument. */
|
|
42
42
|
declare function select(cmd: "#", ...args: Array<unknown>): number;
|
|
@@ -726,7 +726,7 @@ declare function next<T extends ReadonlyArray<any>>(
|
|
|
726
726
|
: T extends readonly [infer A, infer B, infer C, infer D, infer E, infer F]
|
|
727
727
|
? LuaTuple<[number, A | B | C | D | E | F]>
|
|
728
728
|
: T extends ReadonlyArray<infer U>
|
|
729
|
-
? LuaTuple<
|
|
729
|
+
? LuaTuple<[number, U]>
|
|
730
730
|
: LuaTuple<[unknown, unknown]>;
|
|
731
731
|
declare function next<T extends ReadonlyArray<any>>(
|
|
732
732
|
object: T,
|
|
@@ -744,7 +744,7 @@ declare function next<T extends ReadonlyArray<any>>(
|
|
|
744
744
|
: T extends [infer A, infer B, infer C, infer D, infer E, infer F]
|
|
745
745
|
? LuaTuple<[number, A | B | C | D | E | F]>
|
|
746
746
|
: T extends ReadonlyArray<infer U>
|
|
747
|
-
? LuaTuple<
|
|
747
|
+
? LuaTuple<[number, U]>
|
|
748
748
|
: LuaTuple<[unknown, unknown]>;
|
|
749
749
|
declare function next<T>(object: ReadonlyArray<T>, index?: number): LuaTuple<[number, T]>;
|
|
750
750
|
declare function next<T>(object: ReadonlySet<T>, index?: T): LuaTuple<[T, true]>;
|