@rbxts/types 1.0.885 → 1.0.887
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 +189 -59
- package/include/generated/PluginSecurity.d.ts +19 -19
- package/include/generated/enums.d.ts +515 -16
- package/package.json +1 -1
|
@@ -60,7 +60,6 @@ interface Services {
|
|
|
60
60
|
DraggerService: DraggerService;
|
|
61
61
|
EditableService: EditableService;
|
|
62
62
|
EventIngestService: EventIngestService;
|
|
63
|
-
ExampleService: ExampleService;
|
|
64
63
|
ExampleV2Service: ExampleV2Service;
|
|
65
64
|
ExperienceAuthService: ExperienceAuthService;
|
|
66
65
|
ExperienceNotificationService: ExperienceNotificationService;
|
|
@@ -511,6 +510,7 @@ interface CreatableInstances {
|
|
|
511
510
|
UnionOperation: UnionOperation;
|
|
512
511
|
UniversalConstraint: UniversalConstraint;
|
|
513
512
|
UnreliableRemoteEvent: UnreliableRemoteEvent;
|
|
513
|
+
ValueCurve: ValueCurve;
|
|
514
514
|
Vector3Curve: Vector3Curve;
|
|
515
515
|
Vector3Value: Vector3Value;
|
|
516
516
|
VectorForce: VectorForce;
|
|
@@ -2183,7 +2183,7 @@ interface Instance extends RBXObject {
|
|
|
2183
2183
|
*/
|
|
2184
2184
|
AddTag(this: Instance, tag: string): void;
|
|
2185
2185
|
/**
|
|
2186
|
-
* This
|
|
2186
|
+
* This method destroys all of an instance's children.
|
|
2187
2187
|
*
|
|
2188
2188
|
* - **ThreadSafety**: Unsafe
|
|
2189
2189
|
*
|
|
@@ -2436,14 +2436,14 @@ interface Instance extends RBXObject {
|
|
|
2436
2436
|
*/
|
|
2437
2437
|
IsPredicted(this: Instance): boolean;
|
|
2438
2438
|
/**
|
|
2439
|
-
* Returns `true` if the value stored in the specified property is equal to the code-instantiated default.
|
|
2439
|
+
* Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
|
|
2440
2440
|
*
|
|
2441
2441
|
* - **ThreadSafety**: Unsafe
|
|
2442
2442
|
*
|
|
2443
2443
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#IsPropertyModified)
|
|
2444
2444
|
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
2445
2445
|
* @param property Name of the property to query.
|
|
2446
|
-
* @returns Boolean indicating whether the property is modified.
|
|
2446
|
+
* @returns Boolean indicating whether the property is modified from its code‑instantiated default.
|
|
2447
2447
|
*/
|
|
2448
2448
|
IsPropertyModified(this: Instance, property: string): boolean;
|
|
2449
2449
|
/**
|
|
@@ -7330,6 +7330,13 @@ interface AvatarCreationService extends Instance {
|
|
|
7330
7330
|
* @returns A unique identifier for the generated avatar.
|
|
7331
7331
|
*/
|
|
7332
7332
|
AutoSetupAvatarAsync(this: AvatarCreationService, player: Player, model: Model, progressCallback?: Callback): string;
|
|
7333
|
+
/**
|
|
7334
|
+
* - **ThreadSafety**: Unsafe
|
|
7335
|
+
* - **Tags**: Yields
|
|
7336
|
+
*
|
|
7337
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AutoSetupAvatarNewAsync)
|
|
7338
|
+
*/
|
|
7339
|
+
AutoSetupAvatarNewAsync(this: AvatarCreationService, player: Player, autoSetupParams: object, progressCallback?: Callback): string;
|
|
7333
7340
|
/**
|
|
7334
7341
|
* Creates a 2D avatar preview and returns a previewId.
|
|
7335
7342
|
*
|
|
@@ -8137,6 +8144,12 @@ interface MaterialImportData extends BaseImportData {
|
|
|
8137
8144
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#DiffuseFilePath)
|
|
8138
8145
|
*/
|
|
8139
8146
|
DiffuseFilePath: string;
|
|
8147
|
+
/**
|
|
8148
|
+
* - **ThreadSafety**: ReadSafe
|
|
8149
|
+
*
|
|
8150
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#EmissiveFilePath)
|
|
8151
|
+
*/
|
|
8152
|
+
EmissiveFilePath: string;
|
|
8140
8153
|
/**
|
|
8141
8154
|
* - **ThreadSafety**: ReadSafe
|
|
8142
8155
|
* - **Tags**: NotReplicated
|
|
@@ -9948,6 +9961,20 @@ interface CaptureService extends Instance {
|
|
|
9948
9961
|
* @param captureParams
|
|
9949
9962
|
*/
|
|
9950
9963
|
TakeCapture(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
|
|
9964
|
+
/**
|
|
9965
|
+
* - **ThreadSafety**: Unsafe
|
|
9966
|
+
* - **Tags**: Yields
|
|
9967
|
+
*
|
|
9968
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#InternalCheckPlayabilityAsync)
|
|
9969
|
+
*/
|
|
9970
|
+
InternalCheckPlayabilityAsync(this: CaptureService, universeId: number): boolean;
|
|
9971
|
+
/**
|
|
9972
|
+
* - **ThreadSafety**: Unsafe
|
|
9973
|
+
* - **Tags**: Yields
|
|
9974
|
+
*
|
|
9975
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#InternalGetStartPlaceIdAsync)
|
|
9976
|
+
*/
|
|
9977
|
+
InternalGetStartPlaceIdAsync(this: CaptureService, universeId: number): number;
|
|
9951
9978
|
/**
|
|
9952
9979
|
* - **ThreadSafety**: Unsafe
|
|
9953
9980
|
* - **Tags**: Yields
|
|
@@ -12215,7 +12242,7 @@ interface PlaneConstraint extends Constraint {
|
|
|
12215
12242
|
/**
|
|
12216
12243
|
* **Deprecated:**
|
|
12217
12244
|
*
|
|
12218
|
-
* Constrains Attachment0 and Attachment1 such that both points lie in
|
|
12245
|
+
* Constrains Attachment0 and Attachment1 such that both points lie in a plane with origin at Attachment0's position and unit normal vector equal to Attachment0's primary axis.
|
|
12219
12246
|
*
|
|
12220
12247
|
* - **Tags**:
|
|
12221
12248
|
*
|
|
@@ -15160,21 +15187,6 @@ interface EventIngestService extends Instance {
|
|
|
15160
15187
|
*/
|
|
15161
15188
|
readonly _nominal_EventIngestService: unique symbol;
|
|
15162
15189
|
}
|
|
15163
|
-
/**
|
|
15164
|
-
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
15165
|
-
*
|
|
15166
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExampleService)
|
|
15167
|
-
*/
|
|
15168
|
-
interface ExampleService extends Instance {
|
|
15169
|
-
/**
|
|
15170
|
-
* **DO NOT USE!**
|
|
15171
|
-
*
|
|
15172
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
15173
|
-
* @hidden
|
|
15174
|
-
* @deprecated
|
|
15175
|
-
*/
|
|
15176
|
-
readonly _nominal_ExampleService: unique symbol;
|
|
15177
|
-
}
|
|
15178
15190
|
/**
|
|
15179
15191
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
15180
15192
|
*
|
|
@@ -15630,6 +15642,8 @@ interface Decal extends FaceInstance {
|
|
|
15630
15642
|
*/
|
|
15631
15643
|
Texture: ContentId;
|
|
15632
15644
|
/**
|
|
15645
|
+
* The texture content displayed by the Decal. Supports [asset URIs](../../../projects/assets/index.md#asset-uris) and `EditableImage` objects.
|
|
15646
|
+
*
|
|
15633
15647
|
* - **ThreadSafety**: ReadSafe
|
|
15634
15648
|
*
|
|
15635
15649
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#TextureContent)
|
|
@@ -19564,7 +19578,7 @@ interface GuiBase3d extends GuiBase {
|
|
|
19564
19578
|
*/
|
|
19565
19579
|
readonly _nominal_GuiBase3d: unique symbol;
|
|
19566
19580
|
/**
|
|
19567
|
-
* Sets the color of
|
|
19581
|
+
* Sets the color of this `GuiBase3d` object.
|
|
19568
19582
|
*
|
|
19569
19583
|
* - **ThreadSafety**: ReadSafe
|
|
19570
19584
|
*
|
|
@@ -19572,7 +19586,7 @@ interface GuiBase3d extends GuiBase {
|
|
|
19572
19586
|
*/
|
|
19573
19587
|
Color3: Color3;
|
|
19574
19588
|
/**
|
|
19575
|
-
* Sets the transparency of
|
|
19589
|
+
* Sets the transparency of this `GuiBase3d` object.
|
|
19576
19590
|
*
|
|
19577
19591
|
* - **ThreadSafety**: ReadSafe
|
|
19578
19592
|
*
|
|
@@ -19580,7 +19594,7 @@ interface GuiBase3d extends GuiBase {
|
|
|
19580
19594
|
*/
|
|
19581
19595
|
Transparency: number;
|
|
19582
19596
|
/**
|
|
19583
|
-
* Determines whether
|
|
19597
|
+
* Determines whether this `GuiBase3d` object and its descendants will be displayed.
|
|
19584
19598
|
*
|
|
19585
19599
|
* - **ThreadSafety**: ReadSafe
|
|
19586
19600
|
*
|
|
@@ -19751,7 +19765,7 @@ interface SelectionBox extends InstanceAdornment {
|
|
|
19751
19765
|
SurfaceTransparency: number;
|
|
19752
19766
|
}
|
|
19753
19767
|
/**
|
|
19754
|
-
*
|
|
19768
|
+
* An abstract class of which the inheritors can be adorned to objects of the `PVInstance` class.
|
|
19755
19769
|
*
|
|
19756
19770
|
* - **Tags**: NotCreatable
|
|
19757
19771
|
*
|
|
@@ -19767,7 +19781,7 @@ interface PVAdornment extends GuiBase3d {
|
|
|
19767
19781
|
*/
|
|
19768
19782
|
readonly _nominal_PVAdornment: unique symbol;
|
|
19769
19783
|
/**
|
|
19770
|
-
* The `PVInstance`
|
|
19784
|
+
* The `PVInstance` which this `PVAdornment` is attached to.
|
|
19771
19785
|
*
|
|
19772
19786
|
* - **ThreadSafety**: ReadSafe
|
|
19773
19787
|
*
|
|
@@ -19776,7 +19790,7 @@ interface PVAdornment extends GuiBase3d {
|
|
|
19776
19790
|
Adornee: PVInstance | undefined;
|
|
19777
19791
|
}
|
|
19778
19792
|
/**
|
|
19779
|
-
*
|
|
19793
|
+
* An abstract class inherited by 3D handle adornments.
|
|
19780
19794
|
*
|
|
19781
19795
|
* - **Tags**: NotCreatable
|
|
19782
19796
|
*
|
|
@@ -19800,7 +19814,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
19800
19814
|
*/
|
|
19801
19815
|
AdornCullingMode: Enum.AdornCullingMode;
|
|
19802
19816
|
/**
|
|
19803
|
-
* Forces this
|
|
19817
|
+
* Forces this adornment to render on top of all 3D objects in the workspace.
|
|
19804
19818
|
*
|
|
19805
19819
|
* - **ThreadSafety**: ReadSafe
|
|
19806
19820
|
*
|
|
@@ -19824,7 +19838,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
19824
19838
|
*/
|
|
19825
19839
|
SizeRelativeOffset: Vector3;
|
|
19826
19840
|
/**
|
|
19827
|
-
* Determines the draw order of
|
|
19841
|
+
* Determines the draw order of this `HandleAdornment` when `AlwaysOnTop` is `true`.
|
|
19828
19842
|
*
|
|
19829
19843
|
* - **ThreadSafety**: ReadSafe
|
|
19830
19844
|
*
|
|
@@ -19832,7 +19846,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
19832
19846
|
*/
|
|
19833
19847
|
ZIndex: number;
|
|
19834
19848
|
/**
|
|
19835
|
-
* Fires when a
|
|
19849
|
+
* Fires when a player presses down on their left mouse button while hovering over the adornment.
|
|
19836
19850
|
*
|
|
19837
19851
|
* - **ThreadSafety**: Unsafe
|
|
19838
19852
|
*
|
|
@@ -19840,7 +19854,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
19840
19854
|
*/
|
|
19841
19855
|
readonly MouseButton1Down: RBXScriptSignal<() => void>;
|
|
19842
19856
|
/**
|
|
19843
|
-
* Fires when a
|
|
19857
|
+
* Fires when a player releases their left mouse button while hovering over the adornment.
|
|
19844
19858
|
*
|
|
19845
19859
|
* - **ThreadSafety**: Unsafe
|
|
19846
19860
|
*
|
|
@@ -19848,7 +19862,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
19848
19862
|
*/
|
|
19849
19863
|
readonly MouseButton1Up: RBXScriptSignal<() => void>;
|
|
19850
19864
|
/**
|
|
19851
|
-
* Fires when a
|
|
19865
|
+
* Fires when a player moves their mouse over the adornment.
|
|
19852
19866
|
*
|
|
19853
19867
|
* - **ThreadSafety**: Unsafe
|
|
19854
19868
|
*
|
|
@@ -19856,7 +19870,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
19856
19870
|
*/
|
|
19857
19871
|
readonly MouseEnter: RBXScriptSignal<() => void>;
|
|
19858
19872
|
/**
|
|
19859
|
-
* Fires when a
|
|
19873
|
+
* Fires when a player moves their mouse out of the adornment.
|
|
19860
19874
|
*
|
|
19861
19875
|
* - **ThreadSafety**: Unsafe
|
|
19862
19876
|
*
|
|
@@ -20081,6 +20095,8 @@ interface SphereHandleAdornment extends HandleAdornment {
|
|
|
20081
20095
|
Shading: Enum.AdornShading;
|
|
20082
20096
|
}
|
|
20083
20097
|
/**
|
|
20098
|
+
* Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
20099
|
+
*
|
|
20084
20100
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment)
|
|
20085
20101
|
*/
|
|
20086
20102
|
interface WireframeHandleAdornment extends HandleAdornment {
|
|
@@ -20093,58 +20109,72 @@ interface WireframeHandleAdornment extends HandleAdornment {
|
|
|
20093
20109
|
*/
|
|
20094
20110
|
readonly _nominal_WireframeHandleAdornment: unique symbol;
|
|
20095
20111
|
/**
|
|
20112
|
+
* The **XYZ** scale of the wireframe adornment.
|
|
20113
|
+
*
|
|
20096
20114
|
* - **ThreadSafety**: ReadSafe
|
|
20097
20115
|
*
|
|
20098
20116
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#Scale)
|
|
20099
20117
|
*/
|
|
20100
20118
|
Scale: Vector3;
|
|
20101
20119
|
/**
|
|
20120
|
+
* Thickness of the wireframe adornment's lines in pixels.
|
|
20121
|
+
*
|
|
20102
20122
|
* - **ThreadSafety**: ReadSafe
|
|
20103
20123
|
*
|
|
20104
20124
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#Thickness)
|
|
20105
20125
|
*/
|
|
20106
20126
|
Thickness: number;
|
|
20107
20127
|
/**
|
|
20128
|
+
* Adds a line to the wireframe adornment from a starting point to an ending point relative to the center of the `Adornee`.
|
|
20129
|
+
*
|
|
20108
20130
|
* - **ThreadSafety**: Unsafe
|
|
20109
20131
|
*
|
|
20110
20132
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#AddLine)
|
|
20111
|
-
* @param this
|
|
20112
|
-
* @param from
|
|
20113
|
-
* @param to
|
|
20133
|
+
* @param this Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
20134
|
+
* @param from Starting point of the line.
|
|
20135
|
+
* @param to Ending point of the line.
|
|
20114
20136
|
*/
|
|
20115
20137
|
AddLine(this: WireframeHandleAdornment, from: Vector3, to: Vector3): void;
|
|
20116
20138
|
/**
|
|
20139
|
+
* Adds one or more lines to the wireframe adornment using an array.
|
|
20140
|
+
*
|
|
20117
20141
|
* - **ThreadSafety**: Unsafe
|
|
20118
20142
|
*
|
|
20119
20143
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#AddLines)
|
|
20120
|
-
* @param this
|
|
20121
|
-
* @param points
|
|
20144
|
+
* @param this Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
20145
|
+
* @param points Array of `Vector3` points in which each pair acts as a starting point and ending point for a line.
|
|
20122
20146
|
*/
|
|
20123
20147
|
AddLines(this: WireframeHandleAdornment, points: Array<unknown>): void;
|
|
20124
20148
|
/**
|
|
20149
|
+
* Adds multiple line segments to the wireframe adornment in a sequence from point to point.
|
|
20150
|
+
*
|
|
20125
20151
|
* - **ThreadSafety**: Unsafe
|
|
20126
20152
|
*
|
|
20127
20153
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#AddPath)
|
|
20128
|
-
* @param this
|
|
20129
|
-
* @param points
|
|
20130
|
-
* @param loop
|
|
20154
|
+
* @param this Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
20155
|
+
* @param points Array of `Vector3` points to connect in sequence with line segments.
|
|
20156
|
+
* @param loop Whether the path is closed by connecting its ending point to its starting point with an additional line.
|
|
20131
20157
|
*/
|
|
20132
20158
|
AddPath(this: WireframeHandleAdornment, points: Array<unknown>, loop: boolean): void;
|
|
20133
20159
|
/**
|
|
20160
|
+
* Adds a text label to the wireframe adornment.
|
|
20161
|
+
*
|
|
20134
20162
|
* - **ThreadSafety**: Unsafe
|
|
20135
20163
|
*
|
|
20136
20164
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#AddText)
|
|
20137
|
-
* @param this
|
|
20138
|
-
* @param point
|
|
20139
|
-
* @param text
|
|
20140
|
-
* @param size
|
|
20165
|
+
* @param this Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
20166
|
+
* @param point Position of the text in the adornment.
|
|
20167
|
+
* @param text String to display.
|
|
20168
|
+
* @param size Size of the text.
|
|
20141
20169
|
*/
|
|
20142
20170
|
AddText(this: WireframeHandleAdornment, point: Vector3, text: string, size?: number): void;
|
|
20143
20171
|
/**
|
|
20172
|
+
* Instantly clears all lines and text in the wireframe adornment.
|
|
20173
|
+
*
|
|
20144
20174
|
* - **ThreadSafety**: Unsafe
|
|
20145
20175
|
*
|
|
20146
20176
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#Clear)
|
|
20147
|
-
* @param this
|
|
20177
|
+
* @param this Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
20148
20178
|
*/
|
|
20149
20179
|
Clear(this: WireframeHandleAdornment): void;
|
|
20150
20180
|
}
|
|
@@ -22390,8 +22420,8 @@ interface Humanoid extends Instance {
|
|
|
22390
22420
|
*
|
|
22391
22421
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescription)
|
|
22392
22422
|
* @param this A special object that gives models the functionality of a character.
|
|
22393
|
-
* @param humanoidDescription The `HumanoidDescription`
|
|
22394
|
-
* @param assetTypeVerification
|
|
22423
|
+
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
22424
|
+
* @param assetTypeVerification ⚠️ The default value for this parameter will change from `ClientOnly` to `Always` after 10/20/2025. See [here](https://devforum.roblox.com/t/potential-action-required-update-for-humanoiddescription-apis/3982903) for details.
|
|
22395
22425
|
*/
|
|
22396
22426
|
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
22397
22427
|
/**
|
|
@@ -22403,7 +22433,7 @@ interface Humanoid extends Instance {
|
|
|
22403
22433
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionReset)
|
|
22404
22434
|
* @param this A special object that gives models the functionality of a character.
|
|
22405
22435
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
22406
|
-
* @param assetTypeVerification
|
|
22436
|
+
* @param assetTypeVerification ⚠️ The default value for this parameter will change from `ClientOnly` to `Always` after 10/20/2025. See [here](https://devforum.roblox.com/t/potential-action-required-update-for-humanoiddescription-apis/3982903) for details.
|
|
22407
22437
|
*/
|
|
22408
22438
|
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
22409
22439
|
/**
|
|
@@ -27532,12 +27562,25 @@ interface ModerationService extends Instance {
|
|
|
27532
27562
|
* @deprecated
|
|
27533
27563
|
*/
|
|
27534
27564
|
readonly _nominal_ModerationService: unique symbol;
|
|
27565
|
+
/**
|
|
27566
|
+
* - **ThreadSafety**: Unsafe
|
|
27567
|
+
*
|
|
27568
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#BindReviewableContentEventProcessor)
|
|
27569
|
+
*/
|
|
27570
|
+
BindReviewableContentEventProcessor(this: ModerationService, priority: number, callback: Callback): RBXScriptConnection;
|
|
27535
27571
|
/**
|
|
27536
27572
|
* - **ThreadSafety**: Unsafe
|
|
27537
27573
|
*
|
|
27538
27574
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentKey)
|
|
27539
27575
|
*/
|
|
27540
27576
|
CreateReviewableContentKey(this: ModerationService, content: Content): string;
|
|
27577
|
+
/**
|
|
27578
|
+
* - **ThreadSafety**: Unsafe
|
|
27579
|
+
* - **Tags**: Yields
|
|
27580
|
+
*
|
|
27581
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentAsync)
|
|
27582
|
+
*/
|
|
27583
|
+
CreateReviewableContentAsync(this: ModerationService, config: object): string;
|
|
27541
27584
|
/**
|
|
27542
27585
|
* - **ThreadSafety**: Unsafe
|
|
27543
27586
|
* - **Tags**: Yields
|
|
@@ -30644,12 +30687,14 @@ interface Camera extends PVInstance {
|
|
|
30644
30687
|
boolean
|
|
30645
30688
|
]>;
|
|
30646
30689
|
/**
|
|
30690
|
+
* Adjusts the `CFrame` so that the specified bounding box is fully visible within the camera's viewport.
|
|
30691
|
+
*
|
|
30647
30692
|
* - **ThreadSafety**: Unsafe
|
|
30648
30693
|
*
|
|
30649
30694
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ZoomToExtents)
|
|
30650
30695
|
* @param this A class which defines a view of the 3D world.
|
|
30651
|
-
* @param boundingBoxCFrame
|
|
30652
|
-
* @param boundingBoxSize
|
|
30696
|
+
* @param boundingBoxCFrame The `CFrame` representing the center and orientation of the bounding box to fit into the viewport.
|
|
30697
|
+
* @param boundingBoxSize The `Vector3` size of the bounding box to fit into the viewport.
|
|
30653
30698
|
*/
|
|
30654
30699
|
ZoomToExtents(this: Camera, boundingBoxCFrame: CFrame, boundingBoxSize: Vector3): void;
|
|
30655
30700
|
/**
|
|
@@ -33234,6 +33279,7 @@ interface Player extends Instance {
|
|
|
33234
33279
|
* Whether player client-side gameplay is currently paused.
|
|
33235
33280
|
*
|
|
33236
33281
|
* - **ThreadSafety**: ReadSafe
|
|
33282
|
+
* - **Tags**: Hidden
|
|
33237
33283
|
*
|
|
33238
33284
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GameplayPaused)
|
|
33239
33285
|
*/
|
|
@@ -34282,7 +34328,7 @@ interface Players extends Instance {
|
|
|
34282
34328
|
*/
|
|
34283
34329
|
BanAsync(this: Players, config: BanAsyncConfig): void;
|
|
34284
34330
|
/**
|
|
34285
|
-
* Returns a character Model equipped with everything specified in the passed in HumanoidDescription
|
|
34331
|
+
* Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
|
|
34286
34332
|
*
|
|
34287
34333
|
* - **ThreadSafety**: Unsafe
|
|
34288
34334
|
* - **Tags**: Yields
|
|
@@ -34291,8 +34337,8 @@ interface Players extends Instance {
|
|
|
34291
34337
|
* @param this A service that contains presently connected `Player` objects.
|
|
34292
34338
|
* @param description Specifies the appearance of the returned character.
|
|
34293
34339
|
* @param rigType Specifies whether the returned character will be R6 or R15.
|
|
34294
|
-
* @param assetTypeVerification Asset type verification determines if this function will load models or not
|
|
34295
|
-
* @returns A Humanoid character Model
|
|
34340
|
+
* @param assetTypeVerification Asset type verification determines if this function will load models or not. ⚠️ The default value for this parameter will change from `ClientOnly` to `Always` after 10/20/2025. See [here](https://devforum.roblox.com/t/potential-action-required-update-for-humanoiddescription-apis/3982903) for details.
|
|
34341
|
+
* @returns A `Humanoid` character `Model`.
|
|
34296
34342
|
*/
|
|
34297
34343
|
CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
34298
34344
|
/**
|
|
@@ -35874,16 +35920,16 @@ interface RunService extends Instance {
|
|
|
35874
35920
|
* - **ThreadSafety**: ReadSafe
|
|
35875
35921
|
* - **Tags**: NotReplicated
|
|
35876
35922
|
*
|
|
35877
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#
|
|
35923
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#FrameNumber)
|
|
35878
35924
|
*/
|
|
35879
|
-
readonly
|
|
35925
|
+
readonly FrameNumber: number;
|
|
35880
35926
|
/**
|
|
35881
35927
|
* - **ThreadSafety**: ReadSafe
|
|
35882
35928
|
* - **Tags**: NotReplicated
|
|
35883
35929
|
*
|
|
35884
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#
|
|
35930
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#PredictionState)
|
|
35885
35931
|
*/
|
|
35886
|
-
readonly
|
|
35932
|
+
readonly PredictionState: Enum.PredictionState;
|
|
35887
35933
|
/**
|
|
35888
35934
|
* Given a string name of a function and a priority, this method binds the function to `RunService.PreRender`.
|
|
35889
35935
|
*
|
|
@@ -37557,9 +37603,12 @@ interface SocialService extends Instance {
|
|
|
37557
37603
|
* @param options `Dictionary` that specifies the configuration for the generated link. It includes the following optional key-value pairs: - `FallbackLinkId` (string). Determines how this share link will direct player to once expired. Default to experience join link.
|
|
37558
37604
|
* - `ExpirationSeconds` (number). Determines time to expiration once the share link is created. Truncates to nearest integer. Defaults to 86,400.
|
|
37559
37605
|
* - `PreviewTitle` (string) Preview title of the share link.
|
|
37560
|
-
* - `
|
|
37561
|
-
* - `
|
|
37606
|
+
* - `PreviewDescription` (string) Preview description of the share link.
|
|
37607
|
+
* - `PreviewAssetId` (number) Image asset ID used for share link preview.
|
|
37562
37608
|
* - `LaunchData` (string). Used to set a parameter in `Player:GetJoinData()` when a player joined using the generated share link.
|
|
37609
|
+
*
|
|
37610
|
+
*
|
|
37611
|
+
* @returns A tuple containing an `PromptLinkSharingResult` indicating the result of the link sharing prompt.
|
|
37563
37612
|
*/
|
|
37564
37613
|
PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
|
|
37565
37614
|
/**
|
|
@@ -45401,6 +45450,81 @@ interface Vector3Value extends ValueBase {
|
|
|
45401
45450
|
*/
|
|
45402
45451
|
readonly Changed: RBXScriptSignal<(value: Vector3) => void>;
|
|
45403
45452
|
}
|
|
45453
|
+
/**
|
|
45454
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve)
|
|
45455
|
+
*/
|
|
45456
|
+
interface ValueCurve extends Instance {
|
|
45457
|
+
/**
|
|
45458
|
+
* **DO NOT USE!**
|
|
45459
|
+
*
|
|
45460
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
45461
|
+
* @hidden
|
|
45462
|
+
* @deprecated
|
|
45463
|
+
*/
|
|
45464
|
+
readonly _nominal_ValueCurve: unique symbol;
|
|
45465
|
+
/**
|
|
45466
|
+
* - **ThreadSafety**: ReadSafe
|
|
45467
|
+
* - **Tags**: NotReplicated
|
|
45468
|
+
*
|
|
45469
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#Length)
|
|
45470
|
+
*/
|
|
45471
|
+
readonly Length: number;
|
|
45472
|
+
/**
|
|
45473
|
+
* - **ThreadSafety**: ReadSafe
|
|
45474
|
+
* - **Tags**: NotReplicated
|
|
45475
|
+
*
|
|
45476
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#ValueType)
|
|
45477
|
+
*/
|
|
45478
|
+
readonly ValueType: string;
|
|
45479
|
+
/**
|
|
45480
|
+
* - **ThreadSafety**: Unsafe
|
|
45481
|
+
*
|
|
45482
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeyAtIndex)
|
|
45483
|
+
*/
|
|
45484
|
+
GetKeyAtIndex(this: ValueCurve, index: number): ValueCurveKey;
|
|
45485
|
+
/**
|
|
45486
|
+
* - **ThreadSafety**: Unsafe
|
|
45487
|
+
*
|
|
45488
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeyIndicesAtTime)
|
|
45489
|
+
*/
|
|
45490
|
+
GetKeyIndicesAtTime(this: ValueCurve, time: number): Array<unknown>;
|
|
45491
|
+
/**
|
|
45492
|
+
* - **ThreadSafety**: Unsafe
|
|
45493
|
+
*
|
|
45494
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeys)
|
|
45495
|
+
*/
|
|
45496
|
+
GetKeys(this: ValueCurve): Array<unknown>;
|
|
45497
|
+
/**
|
|
45498
|
+
* - **ThreadSafety**: Unsafe
|
|
45499
|
+
*
|
|
45500
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetValueAtTime)
|
|
45501
|
+
*/
|
|
45502
|
+
GetValueAtTime(this: ValueCurve, time: number): unknown | undefined;
|
|
45503
|
+
/**
|
|
45504
|
+
* - **ThreadSafety**: Unsafe
|
|
45505
|
+
*
|
|
45506
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#InsertKey)
|
|
45507
|
+
*/
|
|
45508
|
+
InsertKey(this: ValueCurve, key: ValueCurveKey): Array<unknown>;
|
|
45509
|
+
/**
|
|
45510
|
+
* - **ThreadSafety**: Unsafe
|
|
45511
|
+
*
|
|
45512
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#InsertKeyValue)
|
|
45513
|
+
*/
|
|
45514
|
+
InsertKeyValue(this: ValueCurve, time: number, value: unknown, keyInterpolationMode?: CastsToEnum<Enum.KeyInterpolationMode>): Array<unknown>;
|
|
45515
|
+
/**
|
|
45516
|
+
* - **ThreadSafety**: Unsafe
|
|
45517
|
+
*
|
|
45518
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#RemoveKeyAtIndex)
|
|
45519
|
+
*/
|
|
45520
|
+
RemoveKeyAtIndex(this: ValueCurve, startingIndex: number, count?: number): number;
|
|
45521
|
+
/**
|
|
45522
|
+
* - **ThreadSafety**: Unsafe
|
|
45523
|
+
*
|
|
45524
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#SetKeys)
|
|
45525
|
+
*/
|
|
45526
|
+
SetKeys(this: ValueCurve, keys: Array<unknown>): number;
|
|
45527
|
+
}
|
|
45404
45528
|
/**
|
|
45405
45529
|
* Represents a 3D vector curve, grouping three `FloatCurve` instances.
|
|
45406
45530
|
*
|
|
@@ -46383,6 +46507,12 @@ interface WebStreamClient extends RBXObject {
|
|
|
46383
46507
|
* @param this Maintains a streaming connection.
|
|
46384
46508
|
*/
|
|
46385
46509
|
Close(this: WebStreamClient): void;
|
|
46510
|
+
/**
|
|
46511
|
+
* - **ThreadSafety**: Unsafe
|
|
46512
|
+
*
|
|
46513
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Send)
|
|
46514
|
+
*/
|
|
46515
|
+
Send(this: WebStreamClient, data: string): void;
|
|
46386
46516
|
/**
|
|
46387
46517
|
* - **ThreadSafety**: Unsafe
|
|
46388
46518
|
*
|
|
@@ -63,7 +63,6 @@ interface Services {
|
|
|
63
63
|
DraggerService: DraggerService;
|
|
64
64
|
EditableService: EditableService;
|
|
65
65
|
EventIngestService: EventIngestService;
|
|
66
|
-
ExampleService: ExampleService;
|
|
67
66
|
ExampleV2Service: ExampleV2Service;
|
|
68
67
|
ExperienceAuthService: ExperienceAuthService;
|
|
69
68
|
ExperienceNotificationService: ExperienceNotificationService;
|
|
@@ -531,6 +530,7 @@ interface CreatableInstances {
|
|
|
531
530
|
UnionOperation: UnionOperation;
|
|
532
531
|
UniversalConstraint: UniversalConstraint;
|
|
533
532
|
UnreliableRemoteEvent: UnreliableRemoteEvent;
|
|
533
|
+
ValueCurve: ValueCurve;
|
|
534
534
|
Vector3Curve: Vector3Curve;
|
|
535
535
|
Vector3Value: Vector3Value;
|
|
536
536
|
VectorForce: VectorForce;
|
|
@@ -3509,7 +3509,7 @@ interface PlaneConstraint extends Constraint {
|
|
|
3509
3509
|
/**
|
|
3510
3510
|
* **Deprecated:**
|
|
3511
3511
|
*
|
|
3512
|
-
* Constrains Attachment0 and Attachment1 such that both points lie in
|
|
3512
|
+
* Constrains Attachment0 and Attachment1 such that both points lie in a plane with origin at Attachment0's position and unit normal vector equal to Attachment0's primary axis.
|
|
3513
3513
|
*
|
|
3514
3514
|
* - **Tags**:
|
|
3515
3515
|
*
|
|
@@ -4562,21 +4562,6 @@ interface EventIngestService extends Instance {
|
|
|
4562
4562
|
*/
|
|
4563
4563
|
readonly _nominal_EventIngestService: unique symbol;
|
|
4564
4564
|
}
|
|
4565
|
-
/**
|
|
4566
|
-
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
4567
|
-
*
|
|
4568
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExampleService)
|
|
4569
|
-
*/
|
|
4570
|
-
interface ExampleService extends Instance {
|
|
4571
|
-
/**
|
|
4572
|
-
* **DO NOT USE!**
|
|
4573
|
-
*
|
|
4574
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
4575
|
-
* @hidden
|
|
4576
|
-
* @deprecated
|
|
4577
|
-
*/
|
|
4578
|
-
readonly _nominal_ExampleService: unique symbol;
|
|
4579
|
-
}
|
|
4580
4565
|
/**
|
|
4581
4566
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
4582
4567
|
*
|
|
@@ -6301,7 +6286,7 @@ interface SelectionBox extends InstanceAdornment {
|
|
|
6301
6286
|
readonly _nominal_SelectionBox: unique symbol;
|
|
6302
6287
|
}
|
|
6303
6288
|
/**
|
|
6304
|
-
*
|
|
6289
|
+
* An abstract class of which the inheritors can be adorned to objects of the `PVInstance` class.
|
|
6305
6290
|
*
|
|
6306
6291
|
* - **Tags**: NotCreatable
|
|
6307
6292
|
*
|
|
@@ -6318,7 +6303,7 @@ interface PVAdornment extends GuiBase3d {
|
|
|
6318
6303
|
readonly _nominal_PVAdornment: unique symbol;
|
|
6319
6304
|
}
|
|
6320
6305
|
/**
|
|
6321
|
-
*
|
|
6306
|
+
* An abstract class inherited by 3D handle adornments.
|
|
6322
6307
|
*
|
|
6323
6308
|
* - **Tags**: NotCreatable
|
|
6324
6309
|
*
|
|
@@ -6425,6 +6410,8 @@ interface SphereHandleAdornment extends HandleAdornment {
|
|
|
6425
6410
|
readonly _nominal_SphereHandleAdornment: unique symbol;
|
|
6426
6411
|
}
|
|
6427
6412
|
/**
|
|
6413
|
+
* Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
6414
|
+
*
|
|
6428
6415
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment)
|
|
6429
6416
|
*/
|
|
6430
6417
|
interface WireframeHandleAdornment extends HandleAdornment {
|
|
@@ -14944,6 +14931,19 @@ interface Vector3Value extends ValueBase {
|
|
|
14944
14931
|
*/
|
|
14945
14932
|
readonly _nominal_Vector3Value: unique symbol;
|
|
14946
14933
|
}
|
|
14934
|
+
/**
|
|
14935
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve)
|
|
14936
|
+
*/
|
|
14937
|
+
interface ValueCurve extends Instance {
|
|
14938
|
+
/**
|
|
14939
|
+
* **DO NOT USE!**
|
|
14940
|
+
*
|
|
14941
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
14942
|
+
* @hidden
|
|
14943
|
+
* @deprecated
|
|
14944
|
+
*/
|
|
14945
|
+
readonly _nominal_ValueCurve: unique symbol;
|
|
14946
|
+
}
|
|
14947
14947
|
/**
|
|
14948
14948
|
* Represents a 3D vector curve, grouping three `FloatCurve` instances.
|
|
14949
14949
|
*
|