@rbxts/types 1.0.884 → 1.0.886
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 +333 -72
- package/include/generated/PluginSecurity.d.ts +55 -25
- package/include/generated/enums.d.ts +573 -7
- 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;
|
|
@@ -89,6 +88,7 @@ interface Services {
|
|
|
89
88
|
ILegacyStudioBridge: ILegacyStudioBridge;
|
|
90
89
|
IncrementalPatchBuilder: IncrementalPatchBuilder;
|
|
91
90
|
InsertService: InsertService;
|
|
91
|
+
InstanceExtensionsService: InstanceExtensionsService;
|
|
92
92
|
InternalSyncService: InternalSyncService;
|
|
93
93
|
IXPService: IXPService;
|
|
94
94
|
JointsService: JointsService;
|
|
@@ -153,6 +153,7 @@ interface Services {
|
|
|
153
153
|
RomarkService: RomarkService;
|
|
154
154
|
RtMessagingService: RtMessagingService;
|
|
155
155
|
RunService: RunService;
|
|
156
|
+
RuntimeContentService: RuntimeContentService;
|
|
156
157
|
SafetyService: SafetyService;
|
|
157
158
|
ScriptChangeService: ScriptChangeService;
|
|
158
159
|
ScriptCloneWatcher: ScriptCloneWatcher;
|
|
@@ -509,6 +510,7 @@ interface CreatableInstances {
|
|
|
509
510
|
UnionOperation: UnionOperation;
|
|
510
511
|
UniversalConstraint: UniversalConstraint;
|
|
511
512
|
UnreliableRemoteEvent: UnreliableRemoteEvent;
|
|
513
|
+
ValueCurve: ValueCurve;
|
|
512
514
|
Vector3Curve: Vector3Curve;
|
|
513
515
|
Vector3Value: Vector3Value;
|
|
514
516
|
VectorForce: VectorForce;
|
|
@@ -3964,10 +3966,15 @@ interface AssetService extends Instance {
|
|
|
3964
3966
|
*/
|
|
3965
3967
|
CreateEditableMesh(this: AssetService, editableMeshOptions?: object): EditableMesh;
|
|
3966
3968
|
/**
|
|
3969
|
+
* Creates a Decal instance that uses composite PBR textures created by layering the provided textures in the order they are provided in the `layers` array. Textures layer based on the alpha value of the ColorMap.
|
|
3970
|
+
*
|
|
3967
3971
|
* - **ThreadSafety**: Unsafe
|
|
3968
3972
|
* - **Tags**: Yields
|
|
3969
3973
|
*
|
|
3970
3974
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#ComposeDecalAsync)
|
|
3975
|
+
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
3976
|
+
* @param layers An array of `Dictionary` tables that maps PBR names to ContentID.
|
|
3977
|
+
* @returns A new `Decal` containing the composed texture set.
|
|
3971
3978
|
*/
|
|
3972
3979
|
ComposeDecalAsync(this: AssetService, layers: Array<unknown>): Decal;
|
|
3973
3980
|
/**
|
|
@@ -5276,6 +5283,8 @@ interface AudioEmitter extends Instance {
|
|
|
5276
5283
|
*/
|
|
5277
5284
|
AudioInteractionGroup: string;
|
|
5278
5285
|
/**
|
|
5286
|
+
* **Deprecated:**
|
|
5287
|
+
*
|
|
5279
5288
|
* Controls how detailed the audio simulation should be for this `AudioEmitter`.
|
|
5280
5289
|
*
|
|
5281
5290
|
* - **ThreadSafety**: ReadSafe
|
|
@@ -5888,6 +5897,8 @@ interface AudioListener extends Instance {
|
|
|
5888
5897
|
*/
|
|
5889
5898
|
AudioInteractionGroup: string;
|
|
5890
5899
|
/**
|
|
5900
|
+
* **Deprecated:**
|
|
5901
|
+
*
|
|
5891
5902
|
* Controls how detailed the audio simulation should be for this `AudioListener`.
|
|
5892
5903
|
*
|
|
5893
5904
|
* - **ThreadSafety**: ReadSafe
|
|
@@ -6857,8 +6868,6 @@ interface AudioTextToSpeech extends Instance {
|
|
|
6857
6868
|
/**
|
|
6858
6869
|
* Creates a trembling effect on a sound by varying the volume of the sound up and down.
|
|
6859
6870
|
*
|
|
6860
|
-
* - **Tags**: NotBrowsable
|
|
6861
|
-
*
|
|
6862
6871
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo)
|
|
6863
6872
|
*/
|
|
6864
6873
|
interface AudioTremolo extends Instance {
|
|
@@ -8128,6 +8137,12 @@ interface MaterialImportData extends BaseImportData {
|
|
|
8128
8137
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#DiffuseFilePath)
|
|
8129
8138
|
*/
|
|
8130
8139
|
DiffuseFilePath: string;
|
|
8140
|
+
/**
|
|
8141
|
+
* - **ThreadSafety**: ReadSafe
|
|
8142
|
+
*
|
|
8143
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#EmissiveFilePath)
|
|
8144
|
+
*/
|
|
8145
|
+
EmissiveFilePath: string;
|
|
8131
8146
|
/**
|
|
8132
8147
|
* - **ThreadSafety**: ReadSafe
|
|
8133
8148
|
* - **Tags**: NotReplicated
|
|
@@ -9939,6 +9954,20 @@ interface CaptureService extends Instance {
|
|
|
9939
9954
|
* @param captureParams
|
|
9940
9955
|
*/
|
|
9941
9956
|
TakeCapture(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
|
|
9957
|
+
/**
|
|
9958
|
+
* - **ThreadSafety**: Unsafe
|
|
9959
|
+
* - **Tags**: Yields
|
|
9960
|
+
*
|
|
9961
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#InternalCheckPlayabilityAsync)
|
|
9962
|
+
*/
|
|
9963
|
+
InternalCheckPlayabilityAsync(this: CaptureService, universeId: number): boolean;
|
|
9964
|
+
/**
|
|
9965
|
+
* - **ThreadSafety**: Unsafe
|
|
9966
|
+
* - **Tags**: Yields
|
|
9967
|
+
*
|
|
9968
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#InternalGetStartPlaceIdAsync)
|
|
9969
|
+
*/
|
|
9970
|
+
InternalGetStartPlaceIdAsync(this: CaptureService, universeId: number): number;
|
|
9942
9971
|
/**
|
|
9943
9972
|
* - **ThreadSafety**: Unsafe
|
|
9944
9973
|
* - **Tags**: Yields
|
|
@@ -12206,7 +12235,7 @@ interface PlaneConstraint extends Constraint {
|
|
|
12206
12235
|
/**
|
|
12207
12236
|
* **Deprecated:**
|
|
12208
12237
|
*
|
|
12209
|
-
* Constrains Attachment0 and Attachment1 such that both points lie in
|
|
12238
|
+
* 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.
|
|
12210
12239
|
*
|
|
12211
12240
|
* - **Tags**:
|
|
12212
12241
|
*
|
|
@@ -15151,21 +15180,6 @@ interface EventIngestService extends Instance {
|
|
|
15151
15180
|
*/
|
|
15152
15181
|
readonly _nominal_EventIngestService: unique symbol;
|
|
15153
15182
|
}
|
|
15154
|
-
/**
|
|
15155
|
-
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
15156
|
-
*
|
|
15157
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExampleService)
|
|
15158
|
-
*/
|
|
15159
|
-
interface ExampleService extends Instance {
|
|
15160
|
-
/**
|
|
15161
|
-
* **DO NOT USE!**
|
|
15162
|
-
*
|
|
15163
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
15164
|
-
* @hidden
|
|
15165
|
-
* @deprecated
|
|
15166
|
-
*/
|
|
15167
|
-
readonly _nominal_ExampleService: unique symbol;
|
|
15168
|
-
}
|
|
15169
15183
|
/**
|
|
15170
15184
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
15171
15185
|
*
|
|
@@ -15621,6 +15635,8 @@ interface Decal extends FaceInstance {
|
|
|
15621
15635
|
*/
|
|
15622
15636
|
Texture: ContentId;
|
|
15623
15637
|
/**
|
|
15638
|
+
* The texture content displayed by the Decal. Supports [asset URIs](../../../projects/assets/index.md#asset-uris) and `EditableImage` objects.
|
|
15639
|
+
*
|
|
15624
15640
|
* - **ThreadSafety**: ReadSafe
|
|
15625
15641
|
*
|
|
15626
15642
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#TextureContent)
|
|
@@ -18773,7 +18789,7 @@ interface TextBox extends GuiObject {
|
|
|
18773
18789
|
readonly ReturnPressedFromOnScreenKeyboard: RBXScriptSignal<() => void>;
|
|
18774
18790
|
}
|
|
18775
18791
|
/**
|
|
18776
|
-
*
|
|
18792
|
+
* A GUI object that displays video content from a connected `VideoPlayer`.
|
|
18777
18793
|
*
|
|
18778
18794
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay)
|
|
18779
18795
|
*/
|
|
@@ -18787,12 +18803,16 @@ interface VideoDisplay extends GuiObject {
|
|
|
18787
18803
|
*/
|
|
18788
18804
|
readonly _nominal_VideoDisplay: unique symbol;
|
|
18789
18805
|
/**
|
|
18806
|
+
* Selects the texture resampling mode for the `VideoDisplay`.
|
|
18807
|
+
*
|
|
18790
18808
|
* - **ThreadSafety**: ReadSafe
|
|
18791
18809
|
*
|
|
18792
18810
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#ResampleMode)
|
|
18793
18811
|
*/
|
|
18794
18812
|
ResampleMode: Enum.ResamplerMode;
|
|
18795
18813
|
/**
|
|
18814
|
+
* Determines how a video will scale if displayed in a UI element whose aspect ratio differs from the source video.
|
|
18815
|
+
*
|
|
18796
18816
|
* - **ThreadSafety**: ReadSafe
|
|
18797
18817
|
*
|
|
18798
18818
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#ScaleType)
|
|
@@ -18805,34 +18825,44 @@ interface VideoDisplay extends GuiObject {
|
|
|
18805
18825
|
*/
|
|
18806
18826
|
TileSize: UDim2;
|
|
18807
18827
|
/**
|
|
18828
|
+
* Determines how a rendered video will be colorized.
|
|
18829
|
+
*
|
|
18808
18830
|
* - **ThreadSafety**: ReadSafe
|
|
18809
18831
|
*
|
|
18810
18832
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#VideoColor3)
|
|
18811
18833
|
*/
|
|
18812
18834
|
VideoColor3: Color3;
|
|
18813
18835
|
/**
|
|
18836
|
+
* The offset in pixels of the sub-area of a video to be displayed.
|
|
18837
|
+
*
|
|
18814
18838
|
* - **ThreadSafety**: ReadSafe
|
|
18815
18839
|
*
|
|
18816
18840
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#VideoRectOffset)
|
|
18817
18841
|
*/
|
|
18818
18842
|
VideoRectOffset: Vector2;
|
|
18819
18843
|
/**
|
|
18844
|
+
* Determines the size in pixels of the sub-area of a video to be displayed.
|
|
18845
|
+
*
|
|
18820
18846
|
* - **ThreadSafety**: ReadSafe
|
|
18821
18847
|
*
|
|
18822
18848
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#VideoRectSize)
|
|
18823
18849
|
*/
|
|
18824
18850
|
VideoRectSize: Vector2;
|
|
18825
18851
|
/**
|
|
18852
|
+
* Determines the transparency of the rendered video.
|
|
18853
|
+
*
|
|
18826
18854
|
* - **ThreadSafety**: ReadSafe
|
|
18827
18855
|
*
|
|
18828
18856
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#VideoTransparency)
|
|
18829
18857
|
*/
|
|
18830
18858
|
VideoTransparency: number;
|
|
18831
18859
|
/**
|
|
18860
|
+
* Returns an array of `Wires` that are connected to the specified pin.
|
|
18861
|
+
*
|
|
18832
18862
|
* - **ThreadSafety**: Unsafe
|
|
18833
18863
|
*
|
|
18834
18864
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetConnectedWires)
|
|
18835
|
-
* @param this
|
|
18865
|
+
* @param this A GUI object that displays video content from a connected `VideoPlayer`.
|
|
18836
18866
|
* @param pin
|
|
18837
18867
|
*/
|
|
18838
18868
|
GetConnectedWires(this: VideoDisplay, pin: string): Array<Instance>;
|
|
@@ -18840,17 +18870,19 @@ interface VideoDisplay extends GuiObject {
|
|
|
18840
18870
|
* - **ThreadSafety**: Unsafe
|
|
18841
18871
|
*
|
|
18842
18872
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetInputPins)
|
|
18843
|
-
* @param this
|
|
18873
|
+
* @param this A GUI object that displays video content from a connected `VideoPlayer`.
|
|
18844
18874
|
*/
|
|
18845
18875
|
GetInputPins(this: VideoDisplay): Array<unknown>;
|
|
18846
18876
|
/**
|
|
18847
18877
|
* - **ThreadSafety**: Unsafe
|
|
18848
18878
|
*
|
|
18849
18879
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetOutputPins)
|
|
18850
|
-
* @param this
|
|
18880
|
+
* @param this A GUI object that displays video content from a connected `VideoPlayer`.
|
|
18851
18881
|
*/
|
|
18852
18882
|
GetOutputPins(this: VideoDisplay): Array<unknown>;
|
|
18853
18883
|
/**
|
|
18884
|
+
* Fires when another instance is connected to or disconnected from the `VideoDisplay` via a `Wire`.
|
|
18885
|
+
*
|
|
18854
18886
|
* - **ThreadSafety**: Unsafe
|
|
18855
18887
|
*
|
|
18856
18888
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#WiringChanged)
|
|
@@ -19174,6 +19206,8 @@ interface BillboardGui extends LayerCollector {
|
|
|
19174
19206
|
*/
|
|
19175
19207
|
readonly CurrentDistance: number;
|
|
19176
19208
|
/**
|
|
19209
|
+
* **Deprecated:**
|
|
19210
|
+
*
|
|
19177
19211
|
* Determines the distance in studs at which the `BillboardGui` will stop scaling larger in size.
|
|
19178
19212
|
*
|
|
19179
19213
|
* - **ThreadSafety**: ReadSafe
|
|
@@ -19194,6 +19228,8 @@ interface BillboardGui extends LayerCollector {
|
|
|
19194
19228
|
*/
|
|
19195
19229
|
DistanceStep: number;
|
|
19196
19230
|
/**
|
|
19231
|
+
* **Deprecated:**
|
|
19232
|
+
*
|
|
19197
19233
|
* Determines the distance in studs at which the `BillboardGui` will stop scaling smaller in size.
|
|
19198
19234
|
*
|
|
19199
19235
|
* - **ThreadSafety**: ReadSafe
|
|
@@ -19535,7 +19571,7 @@ interface GuiBase3d extends GuiBase {
|
|
|
19535
19571
|
*/
|
|
19536
19572
|
readonly _nominal_GuiBase3d: unique symbol;
|
|
19537
19573
|
/**
|
|
19538
|
-
* Sets the color of
|
|
19574
|
+
* Sets the color of this `GuiBase3d` object.
|
|
19539
19575
|
*
|
|
19540
19576
|
* - **ThreadSafety**: ReadSafe
|
|
19541
19577
|
*
|
|
@@ -19543,7 +19579,7 @@ interface GuiBase3d extends GuiBase {
|
|
|
19543
19579
|
*/
|
|
19544
19580
|
Color3: Color3;
|
|
19545
19581
|
/**
|
|
19546
|
-
* Sets the transparency of
|
|
19582
|
+
* Sets the transparency of this `GuiBase3d` object.
|
|
19547
19583
|
*
|
|
19548
19584
|
* - **ThreadSafety**: ReadSafe
|
|
19549
19585
|
*
|
|
@@ -19551,7 +19587,7 @@ interface GuiBase3d extends GuiBase {
|
|
|
19551
19587
|
*/
|
|
19552
19588
|
Transparency: number;
|
|
19553
19589
|
/**
|
|
19554
|
-
* Determines whether
|
|
19590
|
+
* Determines whether this `GuiBase3d` object and its descendants will be displayed.
|
|
19555
19591
|
*
|
|
19556
19592
|
* - **ThreadSafety**: ReadSafe
|
|
19557
19593
|
*
|
|
@@ -19722,7 +19758,7 @@ interface SelectionBox extends InstanceAdornment {
|
|
|
19722
19758
|
SurfaceTransparency: number;
|
|
19723
19759
|
}
|
|
19724
19760
|
/**
|
|
19725
|
-
*
|
|
19761
|
+
* An abstract class of which the inheritors can be adorned to objects of the `PVInstance` class.
|
|
19726
19762
|
*
|
|
19727
19763
|
* - **Tags**: NotCreatable
|
|
19728
19764
|
*
|
|
@@ -19738,7 +19774,7 @@ interface PVAdornment extends GuiBase3d {
|
|
|
19738
19774
|
*/
|
|
19739
19775
|
readonly _nominal_PVAdornment: unique symbol;
|
|
19740
19776
|
/**
|
|
19741
|
-
* The `PVInstance`
|
|
19777
|
+
* The `PVInstance` which this `PVAdornment` is attached to.
|
|
19742
19778
|
*
|
|
19743
19779
|
* - **ThreadSafety**: ReadSafe
|
|
19744
19780
|
*
|
|
@@ -19747,7 +19783,7 @@ interface PVAdornment extends GuiBase3d {
|
|
|
19747
19783
|
Adornee: PVInstance | undefined;
|
|
19748
19784
|
}
|
|
19749
19785
|
/**
|
|
19750
|
-
*
|
|
19786
|
+
* An abstract class inherited by 3D handle adornments.
|
|
19751
19787
|
*
|
|
19752
19788
|
* - **Tags**: NotCreatable
|
|
19753
19789
|
*
|
|
@@ -19771,7 +19807,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
19771
19807
|
*/
|
|
19772
19808
|
AdornCullingMode: Enum.AdornCullingMode;
|
|
19773
19809
|
/**
|
|
19774
|
-
* Forces this
|
|
19810
|
+
* Forces this adornment to render on top of all 3D objects in the workspace.
|
|
19775
19811
|
*
|
|
19776
19812
|
* - **ThreadSafety**: ReadSafe
|
|
19777
19813
|
*
|
|
@@ -19795,7 +19831,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
19795
19831
|
*/
|
|
19796
19832
|
SizeRelativeOffset: Vector3;
|
|
19797
19833
|
/**
|
|
19798
|
-
* Determines the draw order of
|
|
19834
|
+
* Determines the draw order of this `HandleAdornment` when `AlwaysOnTop` is `true`.
|
|
19799
19835
|
*
|
|
19800
19836
|
* - **ThreadSafety**: ReadSafe
|
|
19801
19837
|
*
|
|
@@ -19803,7 +19839,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
19803
19839
|
*/
|
|
19804
19840
|
ZIndex: number;
|
|
19805
19841
|
/**
|
|
19806
|
-
* Fires when a
|
|
19842
|
+
* Fires when a player presses down on their left mouse button while hovering over the adornment.
|
|
19807
19843
|
*
|
|
19808
19844
|
* - **ThreadSafety**: Unsafe
|
|
19809
19845
|
*
|
|
@@ -19811,7 +19847,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
19811
19847
|
*/
|
|
19812
19848
|
readonly MouseButton1Down: RBXScriptSignal<() => void>;
|
|
19813
19849
|
/**
|
|
19814
|
-
* Fires when a
|
|
19850
|
+
* Fires when a player releases their left mouse button while hovering over the adornment.
|
|
19815
19851
|
*
|
|
19816
19852
|
* - **ThreadSafety**: Unsafe
|
|
19817
19853
|
*
|
|
@@ -19819,7 +19855,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
19819
19855
|
*/
|
|
19820
19856
|
readonly MouseButton1Up: RBXScriptSignal<() => void>;
|
|
19821
19857
|
/**
|
|
19822
|
-
* Fires when a
|
|
19858
|
+
* Fires when a player moves their mouse over the adornment.
|
|
19823
19859
|
*
|
|
19824
19860
|
* - **ThreadSafety**: Unsafe
|
|
19825
19861
|
*
|
|
@@ -19827,7 +19863,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
19827
19863
|
*/
|
|
19828
19864
|
readonly MouseEnter: RBXScriptSignal<() => void>;
|
|
19829
19865
|
/**
|
|
19830
|
-
* Fires when a
|
|
19866
|
+
* Fires when a player moves their mouse out of the adornment.
|
|
19831
19867
|
*
|
|
19832
19868
|
* - **ThreadSafety**: Unsafe
|
|
19833
19869
|
*
|
|
@@ -20052,6 +20088,8 @@ interface SphereHandleAdornment extends HandleAdornment {
|
|
|
20052
20088
|
Shading: Enum.AdornShading;
|
|
20053
20089
|
}
|
|
20054
20090
|
/**
|
|
20091
|
+
* Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
20092
|
+
*
|
|
20055
20093
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment)
|
|
20056
20094
|
*/
|
|
20057
20095
|
interface WireframeHandleAdornment extends HandleAdornment {
|
|
@@ -20064,58 +20102,72 @@ interface WireframeHandleAdornment extends HandleAdornment {
|
|
|
20064
20102
|
*/
|
|
20065
20103
|
readonly _nominal_WireframeHandleAdornment: unique symbol;
|
|
20066
20104
|
/**
|
|
20105
|
+
* The **XYZ** scale of the wireframe adornment.
|
|
20106
|
+
*
|
|
20067
20107
|
* - **ThreadSafety**: ReadSafe
|
|
20068
20108
|
*
|
|
20069
20109
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#Scale)
|
|
20070
20110
|
*/
|
|
20071
20111
|
Scale: Vector3;
|
|
20072
20112
|
/**
|
|
20113
|
+
* Thickness of the wireframe adornment's lines in pixels.
|
|
20114
|
+
*
|
|
20073
20115
|
* - **ThreadSafety**: ReadSafe
|
|
20074
20116
|
*
|
|
20075
20117
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#Thickness)
|
|
20076
20118
|
*/
|
|
20077
20119
|
Thickness: number;
|
|
20078
20120
|
/**
|
|
20121
|
+
* Adds a line to the wireframe adornment from a starting point to an ending point relative to the center of the `Adornee`.
|
|
20122
|
+
*
|
|
20079
20123
|
* - **ThreadSafety**: Unsafe
|
|
20080
20124
|
*
|
|
20081
20125
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#AddLine)
|
|
20082
|
-
* @param this
|
|
20083
|
-
* @param from
|
|
20084
|
-
* @param to
|
|
20126
|
+
* @param this Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
20127
|
+
* @param from Starting point of the line.
|
|
20128
|
+
* @param to Ending point of the line.
|
|
20085
20129
|
*/
|
|
20086
20130
|
AddLine(this: WireframeHandleAdornment, from: Vector3, to: Vector3): void;
|
|
20087
20131
|
/**
|
|
20132
|
+
* Adds one or more lines to the wireframe adornment using an array.
|
|
20133
|
+
*
|
|
20088
20134
|
* - **ThreadSafety**: Unsafe
|
|
20089
20135
|
*
|
|
20090
20136
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#AddLines)
|
|
20091
|
-
* @param this
|
|
20092
|
-
* @param points
|
|
20137
|
+
* @param this Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
20138
|
+
* @param points Array of `Vector3` points in which each pair acts as a starting point and ending point for a line.
|
|
20093
20139
|
*/
|
|
20094
20140
|
AddLines(this: WireframeHandleAdornment, points: Array<unknown>): void;
|
|
20095
20141
|
/**
|
|
20142
|
+
* Adds multiple line segments to the wireframe adornment in a sequence from point to point.
|
|
20143
|
+
*
|
|
20096
20144
|
* - **ThreadSafety**: Unsafe
|
|
20097
20145
|
*
|
|
20098
20146
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#AddPath)
|
|
20099
|
-
* @param this
|
|
20100
|
-
* @param points
|
|
20101
|
-
* @param loop
|
|
20147
|
+
* @param this Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
20148
|
+
* @param points Array of `Vector3` points to connect in sequence with line segments.
|
|
20149
|
+
* @param loop Whether the path is closed by connecting its ending point to its starting point with an additional line.
|
|
20102
20150
|
*/
|
|
20103
20151
|
AddPath(this: WireframeHandleAdornment, points: Array<unknown>, loop: boolean): void;
|
|
20104
20152
|
/**
|
|
20153
|
+
* Adds a text label to the wireframe adornment.
|
|
20154
|
+
*
|
|
20105
20155
|
* - **ThreadSafety**: Unsafe
|
|
20106
20156
|
*
|
|
20107
20157
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#AddText)
|
|
20108
|
-
* @param this
|
|
20109
|
-
* @param point
|
|
20110
|
-
* @param text
|
|
20111
|
-
* @param size
|
|
20158
|
+
* @param this Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
20159
|
+
* @param point Position of the text in the adornment.
|
|
20160
|
+
* @param text String to display.
|
|
20161
|
+
* @param size Size of the text.
|
|
20112
20162
|
*/
|
|
20113
20163
|
AddText(this: WireframeHandleAdornment, point: Vector3, text: string, size?: number): void;
|
|
20114
20164
|
/**
|
|
20165
|
+
* Instantly clears all lines and text in the wireframe adornment.
|
|
20166
|
+
*
|
|
20115
20167
|
* - **ThreadSafety**: Unsafe
|
|
20116
20168
|
*
|
|
20117
20169
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#Clear)
|
|
20118
|
-
* @param this
|
|
20170
|
+
* @param this Renders a wireframe adornment consisting of one or more lines onto a `BasePart` (including `Terrain`) or into the `Workspace`.
|
|
20119
20171
|
*/
|
|
20120
20172
|
Clear(this: WireframeHandleAdornment): void;
|
|
20121
20173
|
}
|
|
@@ -22361,8 +22413,8 @@ interface Humanoid extends Instance {
|
|
|
22361
22413
|
*
|
|
22362
22414
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescription)
|
|
22363
22415
|
* @param this A special object that gives models the functionality of a character.
|
|
22364
|
-
* @param humanoidDescription The `HumanoidDescription`
|
|
22365
|
-
* @param assetTypeVerification
|
|
22416
|
+
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
22417
|
+
* @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.
|
|
22366
22418
|
*/
|
|
22367
22419
|
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
22368
22420
|
/**
|
|
@@ -22374,7 +22426,7 @@ interface Humanoid extends Instance {
|
|
|
22374
22426
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionReset)
|
|
22375
22427
|
* @param this A special object that gives models the functionality of a character.
|
|
22376
22428
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
22377
|
-
* @param assetTypeVerification
|
|
22429
|
+
* @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.
|
|
22378
22430
|
*/
|
|
22379
22431
|
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
22380
22432
|
/**
|
|
@@ -24570,6 +24622,21 @@ interface InsertService extends Instance {
|
|
|
24570
24622
|
*/
|
|
24571
24623
|
readonly InternalDelete: RBXScriptSignal<(instance: Instance) => void>;
|
|
24572
24624
|
}
|
|
24625
|
+
/**
|
|
24626
|
+
* - **Tags**: NotCreatable, Service
|
|
24627
|
+
*
|
|
24628
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceExtensionsService)
|
|
24629
|
+
*/
|
|
24630
|
+
interface InstanceExtensionsService extends Instance {
|
|
24631
|
+
/**
|
|
24632
|
+
* **DO NOT USE!**
|
|
24633
|
+
*
|
|
24634
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
24635
|
+
* @hidden
|
|
24636
|
+
* @deprecated
|
|
24637
|
+
*/
|
|
24638
|
+
readonly _nominal_InstanceExtensionsService: unique symbol;
|
|
24639
|
+
}
|
|
24573
24640
|
/**
|
|
24574
24641
|
* - **Tags**: NotReplicated
|
|
24575
24642
|
*
|
|
@@ -26733,12 +26800,15 @@ interface MarketplaceService extends Instance {
|
|
|
26733
26800
|
*/
|
|
26734
26801
|
GetUserSubscriptionStatusAsync(this: MarketplaceService, user: Player, subscriptionId: string): UserSubscriptionStatus;
|
|
26735
26802
|
/**
|
|
26803
|
+
* Returns the regionalized price level of a user, representing the recommended price for an item in their regional market.
|
|
26804
|
+
*
|
|
26736
26805
|
* - **ThreadSafety**: Unsafe
|
|
26737
26806
|
* - **Tags**: Yields
|
|
26738
26807
|
*
|
|
26739
26808
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetUsersPriceLevelsAsync)
|
|
26740
26809
|
* @param this The service responsible for in-experience transactions.
|
|
26741
|
-
* @param userIds
|
|
26810
|
+
* @param userIds An array of user IDs.
|
|
26811
|
+
* @returns Returns an array of `PriceLevelInfo` objects with a dictionary where the keys are user IDs (strings) and their values are the corresponding price levels (integers between 1 and 1000).
|
|
26742
26812
|
*/
|
|
26743
26813
|
GetUsersPriceLevelsAsync(this: MarketplaceService, userIds: Array<unknown>): Array<unknown>;
|
|
26744
26814
|
/**
|
|
@@ -27485,12 +27555,25 @@ interface ModerationService extends Instance {
|
|
|
27485
27555
|
* @deprecated
|
|
27486
27556
|
*/
|
|
27487
27557
|
readonly _nominal_ModerationService: unique symbol;
|
|
27558
|
+
/**
|
|
27559
|
+
* - **ThreadSafety**: Unsafe
|
|
27560
|
+
*
|
|
27561
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#BindReviewableContentEventProcessor)
|
|
27562
|
+
*/
|
|
27563
|
+
BindReviewableContentEventProcessor(this: ModerationService, priority: number, callback: Callback): RBXScriptConnection;
|
|
27488
27564
|
/**
|
|
27489
27565
|
* - **ThreadSafety**: Unsafe
|
|
27490
27566
|
*
|
|
27491
27567
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentKey)
|
|
27492
27568
|
*/
|
|
27493
27569
|
CreateReviewableContentKey(this: ModerationService, content: Content): string;
|
|
27570
|
+
/**
|
|
27571
|
+
* - **ThreadSafety**: Unsafe
|
|
27572
|
+
* - **Tags**: Yields
|
|
27573
|
+
*
|
|
27574
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentAsync)
|
|
27575
|
+
*/
|
|
27576
|
+
CreateReviewableContentAsync(this: ModerationService, config: object): string;
|
|
27494
27577
|
/**
|
|
27495
27578
|
* - **ThreadSafety**: Unsafe
|
|
27496
27579
|
* - **Tags**: Yields
|
|
@@ -29916,6 +29999,8 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
29916
29999
|
*/
|
|
29917
30000
|
get DoubleSided(): boolean;
|
|
29918
30001
|
/**
|
|
30002
|
+
* **Deprecated:**
|
|
30003
|
+
*
|
|
29919
30004
|
* - **ThreadSafety**: ReadSafe
|
|
29920
30005
|
* - **Tags**: Hidden
|
|
29921
30006
|
*
|
|
@@ -29932,6 +30017,8 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
29932
30017
|
*/
|
|
29933
30018
|
get HasSkinnedMesh(): boolean;
|
|
29934
30019
|
/**
|
|
30020
|
+
* **Deprecated:**
|
|
30021
|
+
*
|
|
29935
30022
|
* - **ThreadSafety**: ReadSafe
|
|
29936
30023
|
* - **Tags**: Hidden
|
|
29937
30024
|
*
|
|
@@ -30593,12 +30680,14 @@ interface Camera extends PVInstance {
|
|
|
30593
30680
|
boolean
|
|
30594
30681
|
]>;
|
|
30595
30682
|
/**
|
|
30683
|
+
* Adjusts the `CFrame` so that the specified bounding box is fully visible within the camera's viewport.
|
|
30684
|
+
*
|
|
30596
30685
|
* - **ThreadSafety**: Unsafe
|
|
30597
30686
|
*
|
|
30598
30687
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ZoomToExtents)
|
|
30599
30688
|
* @param this A class which defines a view of the 3D world.
|
|
30600
|
-
* @param boundingBoxCFrame
|
|
30601
|
-
* @param boundingBoxSize
|
|
30689
|
+
* @param boundingBoxCFrame The `CFrame` representing the center and orientation of the bounding box to fit into the viewport.
|
|
30690
|
+
* @param boundingBoxSize The `Vector3` size of the bounding box to fit into the viewport.
|
|
30602
30691
|
*/
|
|
30603
30692
|
ZoomToExtents(this: Camera, boundingBoxCFrame: CFrame, boundingBoxSize: Vector3): void;
|
|
30604
30693
|
/**
|
|
@@ -31605,7 +31694,7 @@ interface Workspace extends WorldRoot {
|
|
|
31605
31694
|
readonly PersistentLoaded: RBXScriptSignal<(player: Player) => void>;
|
|
31606
31695
|
}
|
|
31607
31696
|
/**
|
|
31608
|
-
*
|
|
31697
|
+
* Extends limited physics for its children on to a parent `ViewportFrame`.
|
|
31609
31698
|
*
|
|
31610
31699
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldModel)
|
|
31611
31700
|
*/
|
|
@@ -34231,7 +34320,7 @@ interface Players extends Instance {
|
|
|
34231
34320
|
*/
|
|
34232
34321
|
BanAsync(this: Players, config: BanAsyncConfig): void;
|
|
34233
34322
|
/**
|
|
34234
|
-
* Returns a character Model equipped with everything specified in the passed in HumanoidDescription
|
|
34323
|
+
* Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
|
|
34235
34324
|
*
|
|
34236
34325
|
* - **ThreadSafety**: Unsafe
|
|
34237
34326
|
* - **Tags**: Yields
|
|
@@ -34240,8 +34329,8 @@ interface Players extends Instance {
|
|
|
34240
34329
|
* @param this A service that contains presently connected `Player` objects.
|
|
34241
34330
|
* @param description Specifies the appearance of the returned character.
|
|
34242
34331
|
* @param rigType Specifies whether the returned character will be R6 or R15.
|
|
34243
|
-
* @param assetTypeVerification Asset type verification determines if this function will load models or not
|
|
34244
|
-
* @returns A Humanoid character Model
|
|
34332
|
+
* @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.
|
|
34333
|
+
* @returns A `Humanoid` character `Model`.
|
|
34245
34334
|
*/
|
|
34246
34335
|
CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
34247
34336
|
/**
|
|
@@ -34412,7 +34501,7 @@ interface Players extends Instance {
|
|
|
34412
34501
|
*
|
|
34413
34502
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#PlayerRemoving)
|
|
34414
34503
|
*/
|
|
34415
|
-
readonly PlayerRemoving: RBXScriptSignal<(player: Player) => void>;
|
|
34504
|
+
readonly PlayerRemoving: RBXScriptSignal<(player: Player, reason: Enum.PlayerExitReason) => void>;
|
|
34416
34505
|
/**
|
|
34417
34506
|
* Fires when the game server recognizes that the user's status for a certain subscription has changed.
|
|
34418
34507
|
*
|
|
@@ -35823,9 +35912,16 @@ interface RunService extends Instance {
|
|
|
35823
35912
|
* - **ThreadSafety**: ReadSafe
|
|
35824
35913
|
* - **Tags**: NotReplicated
|
|
35825
35914
|
*
|
|
35826
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#
|
|
35915
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#FrameNumber)
|
|
35827
35916
|
*/
|
|
35828
|
-
readonly
|
|
35917
|
+
readonly FrameNumber: number;
|
|
35918
|
+
/**
|
|
35919
|
+
* - **ThreadSafety**: ReadSafe
|
|
35920
|
+
* - **Tags**: NotReplicated
|
|
35921
|
+
*
|
|
35922
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#PredictionState)
|
|
35923
|
+
*/
|
|
35924
|
+
readonly PredictionState: Enum.PredictionState;
|
|
35829
35925
|
/**
|
|
35830
35926
|
* Given a string name of a function and a priority, this method binds the function to `RunService.PreRender`.
|
|
35831
35927
|
*
|
|
@@ -35912,6 +36008,12 @@ interface RunService extends Instance {
|
|
|
35912
36008
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#Heartbeat)
|
|
35913
36009
|
*/
|
|
35914
36010
|
readonly Heartbeat: RBXScriptSignal<(deltaTime: number) => void>;
|
|
36011
|
+
/**
|
|
36012
|
+
* - **ThreadSafety**: Unsafe
|
|
36013
|
+
*
|
|
36014
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#Misprediction)
|
|
36015
|
+
*/
|
|
36016
|
+
readonly Misprediction: RBXScriptSignal<(remoteWorldStepId: number, mispredictedInstances: Array<unknown>) => void>;
|
|
35915
36017
|
/**
|
|
35916
36018
|
* Fires every frame, after the physics simulation has completed.
|
|
35917
36019
|
*
|
|
@@ -35961,6 +36063,39 @@ interface RunService extends Instance {
|
|
|
35961
36063
|
*/
|
|
35962
36064
|
readonly Stepped: RBXScriptSignal<(time: number, deltaTime: number) => void>;
|
|
35963
36065
|
}
|
|
36066
|
+
/**
|
|
36067
|
+
* - **Tags**: NotCreatable, Service
|
|
36068
|
+
*
|
|
36069
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService)
|
|
36070
|
+
*/
|
|
36071
|
+
interface RuntimeContentService extends Instance {
|
|
36072
|
+
/**
|
|
36073
|
+
* **DO NOT USE!**
|
|
36074
|
+
*
|
|
36075
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
36076
|
+
* @hidden
|
|
36077
|
+
* @deprecated
|
|
36078
|
+
*/
|
|
36079
|
+
readonly _nominal_RuntimeContentService: unique symbol;
|
|
36080
|
+
/**
|
|
36081
|
+
* - **ThreadSafety**: Unsafe
|
|
36082
|
+
*
|
|
36083
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentFail)
|
|
36084
|
+
*/
|
|
36085
|
+
readonly RuntimeContentFail: RBXScriptSignal<(id: string) => void>;
|
|
36086
|
+
/**
|
|
36087
|
+
* - **ThreadSafety**: Unsafe
|
|
36088
|
+
*
|
|
36089
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentQuery)
|
|
36090
|
+
*/
|
|
36091
|
+
readonly RuntimeContentQuery: RBXScriptSignal<(id: string, content: string) => void>;
|
|
36092
|
+
/**
|
|
36093
|
+
* - **ThreadSafety**: Unsafe
|
|
36094
|
+
*
|
|
36095
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentShare)
|
|
36096
|
+
*/
|
|
36097
|
+
readonly RuntimeContentShare: RBXScriptSignal<(id: string, content: string) => void>;
|
|
36098
|
+
}
|
|
35964
36099
|
/**
|
|
35965
36100
|
* - **Tags**: NotCreatable, Service
|
|
35966
36101
|
*
|
|
@@ -37441,10 +37576,13 @@ interface SocialService extends Instance {
|
|
|
37441
37576
|
*/
|
|
37442
37577
|
GetPartyAsync(this: SocialService, partyId: string): Array<unknown>;
|
|
37443
37578
|
/**
|
|
37579
|
+
* Prompts the player to submit feedback about the current experience.
|
|
37580
|
+
*
|
|
37444
37581
|
* - **ThreadSafety**: Unsafe
|
|
37445
37582
|
* - **Tags**: Yields
|
|
37446
37583
|
*
|
|
37447
37584
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptFeedbackSubmissionAsync)
|
|
37585
|
+
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
37448
37586
|
*/
|
|
37449
37587
|
PromptFeedbackSubmissionAsync(this: SocialService): void;
|
|
37450
37588
|
/**
|
|
@@ -37453,8 +37591,16 @@ interface SocialService extends Instance {
|
|
|
37453
37591
|
*
|
|
37454
37592
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptLinkSharing)
|
|
37455
37593
|
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
37456
|
-
* @param player
|
|
37457
|
-
* @param options
|
|
37594
|
+
* @param player Prompts the given `Player` with a Roblox platform-level share sheet with a generated share link.
|
|
37595
|
+
* @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.
|
|
37596
|
+
* - `ExpirationSeconds` (number). Determines time to expiration once the share link is created. Truncates to nearest integer. Defaults to 86,400.
|
|
37597
|
+
* - `PreviewTitle` (string) Preview title of the share link.
|
|
37598
|
+
* - `PreviewDescription` (string) Preview description of the share link.
|
|
37599
|
+
* - `PreviewAssetId` (number) Image asset ID used for share link preview.
|
|
37600
|
+
* - `LaunchData` (string). Used to set a parameter in `Player:GetJoinData()` when a player joined using the generated share link.
|
|
37601
|
+
*
|
|
37602
|
+
*
|
|
37603
|
+
* @returns A tuple containing an `PromptLinkSharingResult` indicating the result of the link sharing prompt.
|
|
37458
37604
|
*/
|
|
37459
37605
|
PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
|
|
37460
37606
|
/**
|
|
@@ -45296,6 +45442,81 @@ interface Vector3Value extends ValueBase {
|
|
|
45296
45442
|
*/
|
|
45297
45443
|
readonly Changed: RBXScriptSignal<(value: Vector3) => void>;
|
|
45298
45444
|
}
|
|
45445
|
+
/**
|
|
45446
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve)
|
|
45447
|
+
*/
|
|
45448
|
+
interface ValueCurve extends Instance {
|
|
45449
|
+
/**
|
|
45450
|
+
* **DO NOT USE!**
|
|
45451
|
+
*
|
|
45452
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
45453
|
+
* @hidden
|
|
45454
|
+
* @deprecated
|
|
45455
|
+
*/
|
|
45456
|
+
readonly _nominal_ValueCurve: unique symbol;
|
|
45457
|
+
/**
|
|
45458
|
+
* - **ThreadSafety**: ReadSafe
|
|
45459
|
+
* - **Tags**: NotReplicated
|
|
45460
|
+
*
|
|
45461
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#Length)
|
|
45462
|
+
*/
|
|
45463
|
+
readonly Length: number;
|
|
45464
|
+
/**
|
|
45465
|
+
* - **ThreadSafety**: ReadSafe
|
|
45466
|
+
* - **Tags**: NotReplicated
|
|
45467
|
+
*
|
|
45468
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#ValueType)
|
|
45469
|
+
*/
|
|
45470
|
+
readonly ValueType: string;
|
|
45471
|
+
/**
|
|
45472
|
+
* - **ThreadSafety**: Unsafe
|
|
45473
|
+
*
|
|
45474
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeyAtIndex)
|
|
45475
|
+
*/
|
|
45476
|
+
GetKeyAtIndex(this: ValueCurve, index: number): ValueCurveKey;
|
|
45477
|
+
/**
|
|
45478
|
+
* - **ThreadSafety**: Unsafe
|
|
45479
|
+
*
|
|
45480
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeyIndicesAtTime)
|
|
45481
|
+
*/
|
|
45482
|
+
GetKeyIndicesAtTime(this: ValueCurve, time: number): Array<unknown>;
|
|
45483
|
+
/**
|
|
45484
|
+
* - **ThreadSafety**: Unsafe
|
|
45485
|
+
*
|
|
45486
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeys)
|
|
45487
|
+
*/
|
|
45488
|
+
GetKeys(this: ValueCurve): Array<unknown>;
|
|
45489
|
+
/**
|
|
45490
|
+
* - **ThreadSafety**: Unsafe
|
|
45491
|
+
*
|
|
45492
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetValueAtTime)
|
|
45493
|
+
*/
|
|
45494
|
+
GetValueAtTime(this: ValueCurve, time: number): unknown | undefined;
|
|
45495
|
+
/**
|
|
45496
|
+
* - **ThreadSafety**: Unsafe
|
|
45497
|
+
*
|
|
45498
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#InsertKey)
|
|
45499
|
+
*/
|
|
45500
|
+
InsertKey(this: ValueCurve, key: ValueCurveKey): Array<unknown>;
|
|
45501
|
+
/**
|
|
45502
|
+
* - **ThreadSafety**: Unsafe
|
|
45503
|
+
*
|
|
45504
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#InsertKeyValue)
|
|
45505
|
+
*/
|
|
45506
|
+
InsertKeyValue(this: ValueCurve, time: number, value: unknown, keyInterpolationMode?: CastsToEnum<Enum.KeyInterpolationMode>): Array<unknown>;
|
|
45507
|
+
/**
|
|
45508
|
+
* - **ThreadSafety**: Unsafe
|
|
45509
|
+
*
|
|
45510
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#RemoveKeyAtIndex)
|
|
45511
|
+
*/
|
|
45512
|
+
RemoveKeyAtIndex(this: ValueCurve, startingIndex: number, count?: number): number;
|
|
45513
|
+
/**
|
|
45514
|
+
* - **ThreadSafety**: Unsafe
|
|
45515
|
+
*
|
|
45516
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#SetKeys)
|
|
45517
|
+
*/
|
|
45518
|
+
SetKeys(this: ValueCurve, keys: Array<unknown>): number;
|
|
45519
|
+
}
|
|
45299
45520
|
/**
|
|
45300
45521
|
* Represents a 3D vector curve, grouping three `FloatCurve` instances.
|
|
45301
45522
|
*
|
|
@@ -45409,7 +45630,7 @@ interface VideoDeviceInput extends Instance {
|
|
|
45409
45630
|
readonly IsReady: boolean;
|
|
45410
45631
|
}
|
|
45411
45632
|
/**
|
|
45412
|
-
*
|
|
45633
|
+
* Used to play video assets.
|
|
45413
45634
|
*
|
|
45414
45635
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer)
|
|
45415
45636
|
*/
|
|
@@ -45423,6 +45644,8 @@ interface VideoPlayer extends Instance {
|
|
|
45423
45644
|
*/
|
|
45424
45645
|
readonly _nominal_VideoPlayer: unique symbol;
|
|
45425
45646
|
/**
|
|
45647
|
+
* Indicates when the `VideoContent` has loaded and is ready to play.
|
|
45648
|
+
*
|
|
45426
45649
|
* - **ThreadSafety**: ReadSafe
|
|
45427
45650
|
* - **Tags**: NotReplicated
|
|
45428
45651
|
*
|
|
@@ -45430,6 +45653,8 @@ interface VideoPlayer extends Instance {
|
|
|
45430
45653
|
*/
|
|
45431
45654
|
readonly IsLoaded: boolean;
|
|
45432
45655
|
/**
|
|
45656
|
+
* Denotes whether this `VideoPlayer` is currently playing.
|
|
45657
|
+
*
|
|
45433
45658
|
* - **ThreadSafety**: ReadSafe
|
|
45434
45659
|
* - **Tags**: NotReplicated
|
|
45435
45660
|
*
|
|
@@ -45437,18 +45662,24 @@ interface VideoPlayer extends Instance {
|
|
|
45437
45662
|
*/
|
|
45438
45663
|
readonly IsPlaying: boolean;
|
|
45439
45664
|
/**
|
|
45665
|
+
* Controls whether this `VideoPlayer` loops.
|
|
45666
|
+
*
|
|
45440
45667
|
* - **ThreadSafety**: ReadSafe
|
|
45441
45668
|
*
|
|
45442
45669
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Looping)
|
|
45443
45670
|
*/
|
|
45444
45671
|
Looping: boolean;
|
|
45445
45672
|
/**
|
|
45673
|
+
* Controls the speed at which the video is played.
|
|
45674
|
+
*
|
|
45446
45675
|
* - **ThreadSafety**: ReadSafe
|
|
45447
45676
|
*
|
|
45448
45677
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#PlaybackSpeed)
|
|
45449
45678
|
*/
|
|
45450
45679
|
PlaybackSpeed: number;
|
|
45451
45680
|
/**
|
|
45681
|
+
* Gets the original source resolution of the `VideoContent` file.
|
|
45682
|
+
*
|
|
45452
45683
|
* - **ThreadSafety**: ReadSafe
|
|
45453
45684
|
* - **Tags**: NotReplicated
|
|
45454
45685
|
*
|
|
@@ -45456,6 +45687,8 @@ interface VideoPlayer extends Instance {
|
|
|
45456
45687
|
*/
|
|
45457
45688
|
readonly Resolution: Vector2;
|
|
45458
45689
|
/**
|
|
45690
|
+
* Indicates the length of the `VideoContent` in seconds.
|
|
45691
|
+
*
|
|
45459
45692
|
* - **ThreadSafety**: ReadSafe
|
|
45460
45693
|
* - **Tags**: NotReplicated
|
|
45461
45694
|
*
|
|
@@ -45463,28 +45696,36 @@ interface VideoPlayer extends Instance {
|
|
|
45463
45696
|
*/
|
|
45464
45697
|
readonly TimeLength: number;
|
|
45465
45698
|
/**
|
|
45699
|
+
* Indicates the progress in seconds of the `VideoContent`.
|
|
45700
|
+
*
|
|
45466
45701
|
* - **ThreadSafety**: ReadSafe
|
|
45467
45702
|
*
|
|
45468
45703
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#TimePosition)
|
|
45469
45704
|
*/
|
|
45470
45705
|
TimePosition: number;
|
|
45471
45706
|
/**
|
|
45707
|
+
* The asset to be loaded into the `VideoPlayer`.
|
|
45708
|
+
*
|
|
45472
45709
|
* - **ThreadSafety**: ReadSafe
|
|
45473
45710
|
*
|
|
45474
45711
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#VideoContent)
|
|
45475
45712
|
*/
|
|
45476
45713
|
VideoContent: Content;
|
|
45477
45714
|
/**
|
|
45715
|
+
* Controls how loudly the audio track will be played.
|
|
45716
|
+
*
|
|
45478
45717
|
* - **ThreadSafety**: ReadSafe
|
|
45479
45718
|
*
|
|
45480
45719
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Volume)
|
|
45481
45720
|
*/
|
|
45482
45721
|
Volume: number;
|
|
45483
45722
|
/**
|
|
45723
|
+
* Returns an array of `Wires` that are connected to the specified pin.
|
|
45724
|
+
*
|
|
45484
45725
|
* - **ThreadSafety**: Unsafe
|
|
45485
45726
|
*
|
|
45486
45727
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetConnectedWires)
|
|
45487
|
-
* @param this
|
|
45728
|
+
* @param this Used to play video assets.
|
|
45488
45729
|
* @param pin
|
|
45489
45730
|
*/
|
|
45490
45731
|
GetConnectedWires(this: VideoPlayer, pin: string): Array<Instance>;
|
|
@@ -45492,52 +45733,64 @@ interface VideoPlayer extends Instance {
|
|
|
45492
45733
|
* - **ThreadSafety**: Unsafe
|
|
45493
45734
|
*
|
|
45494
45735
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetInputPins)
|
|
45495
|
-
* @param this
|
|
45736
|
+
* @param this Used to play video assets.
|
|
45496
45737
|
*/
|
|
45497
45738
|
GetInputPins(this: VideoPlayer): Array<unknown>;
|
|
45498
45739
|
/**
|
|
45499
45740
|
* - **ThreadSafety**: Unsafe
|
|
45500
45741
|
*
|
|
45501
45742
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetOutputPins)
|
|
45502
|
-
* @param this
|
|
45743
|
+
* @param this Used to play video assets.
|
|
45503
45744
|
*/
|
|
45504
45745
|
GetOutputPins(this: VideoPlayer): Array<unknown>;
|
|
45505
45746
|
/**
|
|
45747
|
+
* Pauses the `VideoPlayer` wherever its `TimePosition` is.
|
|
45748
|
+
*
|
|
45506
45749
|
* - **ThreadSafety**: Unsafe
|
|
45507
45750
|
*
|
|
45508
45751
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Pause)
|
|
45509
|
-
* @param this
|
|
45752
|
+
* @param this Used to play video assets.
|
|
45510
45753
|
*/
|
|
45511
45754
|
Pause(this: VideoPlayer): void;
|
|
45512
45755
|
/**
|
|
45756
|
+
* Plays the `VideoPlayer` from wherever its `TimePosition` is.
|
|
45757
|
+
*
|
|
45513
45758
|
* - **ThreadSafety**: Unsafe
|
|
45514
45759
|
*
|
|
45515
45760
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Play)
|
|
45516
|
-
* @param this
|
|
45761
|
+
* @param this Used to play video assets.
|
|
45517
45762
|
*/
|
|
45518
45763
|
Play(this: VideoPlayer): void;
|
|
45519
45764
|
/**
|
|
45765
|
+
* Unloads the `VideoPlayer.VideoContent` to save resources.
|
|
45766
|
+
*
|
|
45520
45767
|
* - **ThreadSafety**: Unsafe
|
|
45521
45768
|
*
|
|
45522
45769
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Unload)
|
|
45523
|
-
* @param this
|
|
45770
|
+
* @param this Used to play video assets.
|
|
45524
45771
|
*/
|
|
45525
45772
|
Unload(this: VideoPlayer): void;
|
|
45526
45773
|
/**
|
|
45774
|
+
* Loads the `VideoContent` before it is played.
|
|
45775
|
+
*
|
|
45527
45776
|
* - **ThreadSafety**: Unsafe
|
|
45528
45777
|
* - **Tags**: Yields
|
|
45529
45778
|
*
|
|
45530
45779
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#LoadAsync)
|
|
45531
|
-
* @param this
|
|
45780
|
+
* @param this Used to play video assets.
|
|
45532
45781
|
*/
|
|
45533
45782
|
LoadAsync(this: VideoPlayer): Enum.AssetFetchStatus;
|
|
45534
45783
|
/**
|
|
45784
|
+
* Fires when the `VideoContent` has completed playback and stopped.
|
|
45785
|
+
*
|
|
45535
45786
|
* - **ThreadSafety**: Unsafe
|
|
45536
45787
|
*
|
|
45537
45788
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#DidEnd)
|
|
45538
45789
|
*/
|
|
45539
45790
|
readonly DidEnd: RBXScriptSignal<() => void>;
|
|
45540
45791
|
/**
|
|
45792
|
+
* Fires when the `VideoContent` loops.
|
|
45793
|
+
*
|
|
45541
45794
|
* - **ThreadSafety**: Unsafe
|
|
45542
45795
|
*
|
|
45543
45796
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#DidLoop)
|
|
@@ -45550,6 +45803,8 @@ interface VideoPlayer extends Instance {
|
|
|
45550
45803
|
*/
|
|
45551
45804
|
readonly PlayFailed: RBXScriptSignal<(error: Enum.AssetFetchStatus) => void>;
|
|
45552
45805
|
/**
|
|
45806
|
+
* Fires when another instance is connected to or disconnected from the `VideoPlayer` via a `Wire`.
|
|
45807
|
+
*
|
|
45553
45808
|
* - **ThreadSafety**: Unsafe
|
|
45554
45809
|
*
|
|
45555
45810
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#WiringChanged)
|
|
@@ -46038,7 +46293,7 @@ interface Wire extends Instance {
|
|
|
46038
46293
|
TargetName: string;
|
|
46039
46294
|
}
|
|
46040
46295
|
/**
|
|
46041
|
-
*
|
|
46296
|
+
* `WrapTextureTransfer` allows a parent `Decal` to be wrapped around its parent `MeshPart` based on the cage of its `WrapTarget`.
|
|
46042
46297
|
*
|
|
46043
46298
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer)
|
|
46044
46299
|
*/
|
|
@@ -46052,18 +46307,24 @@ interface WrapTextureTransfer extends Instance {
|
|
|
46052
46307
|
*/
|
|
46053
46308
|
readonly _nominal_WrapTextureTransfer: unique symbol;
|
|
46054
46309
|
/**
|
|
46310
|
+
* An optional reference mesh used for pruning and validating the target cage.
|
|
46311
|
+
*
|
|
46055
46312
|
* - **ThreadSafety**: ReadSafe
|
|
46056
46313
|
*
|
|
46057
46314
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#ReferenceCageMeshContent)
|
|
46058
46315
|
*/
|
|
46059
46316
|
ReferenceCageMeshContent: Content;
|
|
46060
46317
|
/**
|
|
46318
|
+
* Determines the maximum bound of the UV space to include in the transfer.
|
|
46319
|
+
*
|
|
46061
46320
|
* - **ThreadSafety**: ReadSafe
|
|
46062
46321
|
*
|
|
46063
46322
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#UVMaxBound)
|
|
46064
46323
|
*/
|
|
46065
46324
|
UVMaxBound: Vector2;
|
|
46066
46325
|
/**
|
|
46326
|
+
* Determines the minimum bound of the UV space to include in the transfer.
|
|
46327
|
+
*
|
|
46067
46328
|
* - **ThreadSafety**: ReadSafe
|
|
46068
46329
|
*
|
|
46069
46330
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#UVMinBound)
|