@rbxts/types 1.0.864 → 1.0.866
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 +301 -59
- package/include/generated/PluginSecurity.d.ts +90 -11
- package/include/generated/enums.d.ts +280 -14
- package/package.json +1 -1
|
@@ -60,6 +60,7 @@ interface Services {
|
|
|
60
60
|
EditableService: EditableService;
|
|
61
61
|
EventIngestService: EventIngestService;
|
|
62
62
|
ExampleService: ExampleService;
|
|
63
|
+
ExampleV2Service: ExampleV2Service;
|
|
63
64
|
ExperienceAuthService: ExperienceAuthService;
|
|
64
65
|
ExperienceNotificationService: ExperienceNotificationService;
|
|
65
66
|
ExperienceService: ExperienceService;
|
|
@@ -547,6 +548,7 @@ interface Instances extends Services, CreatableInstances {
|
|
|
547
548
|
BevelMesh: BevelMesh;
|
|
548
549
|
BodyMover: BodyMover;
|
|
549
550
|
BubbleChatConfiguration: BubbleChatConfiguration;
|
|
551
|
+
CapturesPages: CapturesPages;
|
|
550
552
|
CatalogPages: CatalogPages;
|
|
551
553
|
ChannelSelectorSoundEffect: ChannelSelectorSoundEffect;
|
|
552
554
|
ChannelTabsConfiguration: ChannelTabsConfiguration;
|
|
@@ -779,6 +781,41 @@ interface Capture extends RBXObject {
|
|
|
779
781
|
* @deprecated
|
|
780
782
|
*/
|
|
781
783
|
readonly _nominal_Capture: unique symbol;
|
|
784
|
+
/**
|
|
785
|
+
* - **ThreadSafety**: ReadSafe
|
|
786
|
+
* - **Tags**: NotReplicated
|
|
787
|
+
*
|
|
788
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Capture#CaptureTime)
|
|
789
|
+
*/
|
|
790
|
+
readonly CaptureTime: DateTime;
|
|
791
|
+
/**
|
|
792
|
+
* - **ThreadSafety**: ReadSafe
|
|
793
|
+
* - **Tags**: NotReplicated
|
|
794
|
+
*
|
|
795
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Capture#CaptureType)
|
|
796
|
+
*/
|
|
797
|
+
readonly CaptureType: Enum.CaptureType;
|
|
798
|
+
/**
|
|
799
|
+
* - **ThreadSafety**: ReadSafe
|
|
800
|
+
* - **Tags**: NotReplicated
|
|
801
|
+
*
|
|
802
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Capture#LocalId)
|
|
803
|
+
*/
|
|
804
|
+
readonly LocalId: string;
|
|
805
|
+
/**
|
|
806
|
+
* - **ThreadSafety**: ReadSafe
|
|
807
|
+
* - **Tags**: NotReplicated
|
|
808
|
+
*
|
|
809
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Capture#SourcePlaceId)
|
|
810
|
+
*/
|
|
811
|
+
readonly SourcePlaceId: number;
|
|
812
|
+
/**
|
|
813
|
+
* - **ThreadSafety**: ReadSafe
|
|
814
|
+
* - **Tags**: NotReplicated
|
|
815
|
+
*
|
|
816
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Capture#SourceUniverseId)
|
|
817
|
+
*/
|
|
818
|
+
readonly SourceUniverseId: number;
|
|
782
819
|
}
|
|
783
820
|
/**
|
|
784
821
|
* - **Tags**: NotCreatable, NotReplicated
|
|
@@ -809,6 +846,13 @@ interface VideoCapture extends Capture {
|
|
|
809
846
|
* @deprecated
|
|
810
847
|
*/
|
|
811
848
|
readonly _nominal_VideoCapture: unique symbol;
|
|
849
|
+
/**
|
|
850
|
+
* - **ThreadSafety**: ReadSafe
|
|
851
|
+
* - **Tags**: NotReplicated
|
|
852
|
+
*
|
|
853
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoCapture#TimeLength)
|
|
854
|
+
*/
|
|
855
|
+
readonly TimeLength: number;
|
|
812
856
|
}
|
|
813
857
|
/**
|
|
814
858
|
* - **Tags**: NotCreatable, NotReplicated
|
|
@@ -1384,6 +1428,8 @@ interface EditableMesh extends RBXObject {
|
|
|
1384
1428
|
* - **Tags**: CustomLuaState
|
|
1385
1429
|
*
|
|
1386
1430
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithColor)
|
|
1431
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1432
|
+
* @param colorId
|
|
1387
1433
|
*/
|
|
1388
1434
|
GetFacesWithColor(this: EditableMesh, colorId: number): Array<unknown>;
|
|
1389
1435
|
/**
|
|
@@ -1391,6 +1437,8 @@ interface EditableMesh extends RBXObject {
|
|
|
1391
1437
|
* - **Tags**: CustomLuaState
|
|
1392
1438
|
*
|
|
1393
1439
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithNormal)
|
|
1440
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1441
|
+
* @param normalId
|
|
1394
1442
|
*/
|
|
1395
1443
|
GetFacesWithNormal(this: EditableMesh, normalId: number): Array<unknown>;
|
|
1396
1444
|
/**
|
|
@@ -1398,6 +1446,8 @@ interface EditableMesh extends RBXObject {
|
|
|
1398
1446
|
* - **Tags**: CustomLuaState
|
|
1399
1447
|
*
|
|
1400
1448
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithUV)
|
|
1449
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1450
|
+
* @param uvId
|
|
1401
1451
|
*/
|
|
1402
1452
|
GetFacesWithUV(this: EditableMesh, uvId: number): Array<unknown>;
|
|
1403
1453
|
/**
|
|
@@ -1532,24 +1582,35 @@ interface EditableMesh extends RBXObject {
|
|
|
1532
1582
|
* - **Tags**: CustomLuaState
|
|
1533
1583
|
*
|
|
1534
1584
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexColors)
|
|
1585
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1586
|
+
* @param vertexId
|
|
1535
1587
|
*/
|
|
1536
1588
|
GetVertexColors(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1537
1589
|
/**
|
|
1538
1590
|
* - **ThreadSafety**: Unsafe
|
|
1539
1591
|
*
|
|
1540
1592
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceColor)
|
|
1593
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1594
|
+
* @param vertexId
|
|
1595
|
+
* @param faceId
|
|
1541
1596
|
*/
|
|
1542
1597
|
GetVertexFaceColor(this: EditableMesh, vertexId: number, faceId: number): number;
|
|
1543
1598
|
/**
|
|
1544
1599
|
* - **ThreadSafety**: Unsafe
|
|
1545
1600
|
*
|
|
1546
1601
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceNormal)
|
|
1602
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1603
|
+
* @param vertexId
|
|
1604
|
+
* @param faceId
|
|
1547
1605
|
*/
|
|
1548
1606
|
GetVertexFaceNormal(this: EditableMesh, vertexId: number, faceId: number): number;
|
|
1549
1607
|
/**
|
|
1550
1608
|
* - **ThreadSafety**: Unsafe
|
|
1551
1609
|
*
|
|
1552
1610
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceUV)
|
|
1611
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1612
|
+
* @param vertexId
|
|
1613
|
+
* @param faceId
|
|
1553
1614
|
*/
|
|
1554
1615
|
GetVertexFaceUV(this: EditableMesh, vertexId: number, faceId: number): number;
|
|
1555
1616
|
/**
|
|
@@ -1557,6 +1618,8 @@ interface EditableMesh extends RBXObject {
|
|
|
1557
1618
|
* - **Tags**: CustomLuaState
|
|
1558
1619
|
*
|
|
1559
1620
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaces)
|
|
1621
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1622
|
+
* @param vertexId
|
|
1560
1623
|
*/
|
|
1561
1624
|
GetVertexFaces(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1562
1625
|
/**
|
|
@@ -1564,6 +1627,8 @@ interface EditableMesh extends RBXObject {
|
|
|
1564
1627
|
* - **Tags**: CustomLuaState
|
|
1565
1628
|
*
|
|
1566
1629
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexNormals)
|
|
1630
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1631
|
+
* @param vertexId
|
|
1567
1632
|
*/
|
|
1568
1633
|
GetVertexNormals(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1569
1634
|
/**
|
|
@@ -1571,6 +1636,8 @@ interface EditableMesh extends RBXObject {
|
|
|
1571
1636
|
* - **Tags**: CustomLuaState
|
|
1572
1637
|
*
|
|
1573
1638
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexUVs)
|
|
1639
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1640
|
+
* @param vertexId
|
|
1574
1641
|
*/
|
|
1575
1642
|
GetVertexUVs(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1576
1643
|
/**
|
|
@@ -1604,6 +1671,8 @@ interface EditableMesh extends RBXObject {
|
|
|
1604
1671
|
* - **Tags**: CustomLuaState
|
|
1605
1672
|
*
|
|
1606
1673
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithColor)
|
|
1674
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1675
|
+
* @param colorId
|
|
1607
1676
|
*/
|
|
1608
1677
|
GetVerticesWithColor(this: EditableMesh, colorId: number): Array<unknown>;
|
|
1609
1678
|
/**
|
|
@@ -1611,6 +1680,8 @@ interface EditableMesh extends RBXObject {
|
|
|
1611
1680
|
* - **Tags**: CustomLuaState
|
|
1612
1681
|
*
|
|
1613
1682
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithNormal)
|
|
1683
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1684
|
+
* @param normalId
|
|
1614
1685
|
*/
|
|
1615
1686
|
GetVerticesWithNormal(this: EditableMesh, normalId: number): Array<unknown>;
|
|
1616
1687
|
/**
|
|
@@ -1618,6 +1689,8 @@ interface EditableMesh extends RBXObject {
|
|
|
1618
1689
|
* - **Tags**: CustomLuaState
|
|
1619
1690
|
*
|
|
1620
1691
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithUV)
|
|
1692
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1693
|
+
* @param uvId
|
|
1621
1694
|
*/
|
|
1622
1695
|
GetVerticesWithUV(this: EditableMesh, uvId: number): Array<unknown>;
|
|
1623
1696
|
/**
|
|
@@ -1905,18 +1978,30 @@ interface EditableMesh extends RBXObject {
|
|
|
1905
1978
|
* - **ThreadSafety**: Unsafe
|
|
1906
1979
|
*
|
|
1907
1980
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceColor)
|
|
1981
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1982
|
+
* @param vertexId
|
|
1983
|
+
* @param faceId
|
|
1984
|
+
* @param colorId
|
|
1908
1985
|
*/
|
|
1909
1986
|
SetVertexFaceColor(this: EditableMesh, vertexId: number, faceId: number, colorId: number): void;
|
|
1910
1987
|
/**
|
|
1911
1988
|
* - **ThreadSafety**: Unsafe
|
|
1912
1989
|
*
|
|
1913
1990
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceNormal)
|
|
1991
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1992
|
+
* @param vertexId
|
|
1993
|
+
* @param faceId
|
|
1994
|
+
* @param normalId
|
|
1914
1995
|
*/
|
|
1915
1996
|
SetVertexFaceNormal(this: EditableMesh, vertexId: number, faceId: number, normalId: number): void;
|
|
1916
1997
|
/**
|
|
1917
1998
|
* - **ThreadSafety**: Unsafe
|
|
1918
1999
|
*
|
|
1919
2000
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceUV)
|
|
2001
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
2002
|
+
* @param vertexId
|
|
2003
|
+
* @param faceId
|
|
2004
|
+
* @param uvId
|
|
1920
2005
|
*/
|
|
1921
2006
|
SetVertexFaceUV(this: EditableMesh, vertexId: number, faceId: number, uvId: number): void;
|
|
1922
2007
|
/**
|
|
@@ -3747,14 +3832,6 @@ interface AssetService extends Instance {
|
|
|
3747
3832
|
* @param editableMeshOptions Table containing options for the created `EditableMesh`. Currently no options are available since `FixedSize` will always be `false` for empty editable meshes.
|
|
3748
3833
|
*/
|
|
3749
3834
|
CreateEditableMesh(this: AssetService, editableMeshOptions?: object): EditableMesh;
|
|
3750
|
-
/**
|
|
3751
|
-
* - **ThreadSafety**: Unsafe
|
|
3752
|
-
*
|
|
3753
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateSurfaceAppearance)
|
|
3754
|
-
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
3755
|
-
* @param content
|
|
3756
|
-
*/
|
|
3757
|
-
CreateSurfaceAppearance(this: AssetService, content: object): SurfaceAppearance;
|
|
3758
3835
|
/**
|
|
3759
3836
|
* Uploads a new asset to Roblox from the given object.
|
|
3760
3837
|
*
|
|
@@ -3876,6 +3953,13 @@ interface AssetService extends Instance {
|
|
|
3876
3953
|
* @param description
|
|
3877
3954
|
*/
|
|
3878
3955
|
CreatePlaceInPlayerInventoryAsync(this: AssetService, player: Player, placeName: string, templatePlaceID: number, description: string): number;
|
|
3956
|
+
/**
|
|
3957
|
+
* - **ThreadSafety**: Unsafe
|
|
3958
|
+
* - **Tags**: Yields
|
|
3959
|
+
*
|
|
3960
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateSurfaceAppearanceAsync)
|
|
3961
|
+
*/
|
|
3962
|
+
CreateSurfaceAppearanceAsync(this: AssetService, content: object): SurfaceAppearance;
|
|
3879
3963
|
/**
|
|
3880
3964
|
* Returns an array of asset IDs that are contained in a specified package.
|
|
3881
3965
|
*
|
|
@@ -5514,18 +5598,22 @@ interface AudioGate extends Instance {
|
|
|
5514
5598
|
* - **ThreadSafety**: Unsafe
|
|
5515
5599
|
*
|
|
5516
5600
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetConnectedWires)
|
|
5601
|
+
* @param this
|
|
5602
|
+
* @param pin
|
|
5517
5603
|
*/
|
|
5518
5604
|
GetConnectedWires(this: AudioGate, pin: string): Array<Instance>;
|
|
5519
5605
|
/**
|
|
5520
5606
|
* - **ThreadSafety**: Unsafe
|
|
5521
5607
|
*
|
|
5522
5608
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetInputPins)
|
|
5609
|
+
* @param this
|
|
5523
5610
|
*/
|
|
5524
5611
|
GetInputPins(this: AudioGate): Array<unknown>;
|
|
5525
5612
|
/**
|
|
5526
5613
|
* - **ThreadSafety**: Unsafe
|
|
5527
5614
|
*
|
|
5528
5615
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetOutputPins)
|
|
5616
|
+
* @param this
|
|
5529
5617
|
*/
|
|
5530
5618
|
GetOutputPins(this: AudioGate): Array<unknown>;
|
|
5531
5619
|
/**
|
|
@@ -6666,6 +6754,12 @@ interface AuroraService extends Instance {
|
|
|
6666
6754
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IgnoreRotation)
|
|
6667
6755
|
*/
|
|
6668
6756
|
IgnoreRotation: boolean;
|
|
6757
|
+
/**
|
|
6758
|
+
* - **ThreadSafety**: ReadSafe
|
|
6759
|
+
*
|
|
6760
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#LockStepIdOffset)
|
|
6761
|
+
*/
|
|
6762
|
+
LockStepIdOffset: boolean;
|
|
6669
6763
|
/**
|
|
6670
6764
|
* - **ThreadSafety**: ReadSafe
|
|
6671
6765
|
*
|
|
@@ -6895,17 +6989,25 @@ interface AvatarCreationService extends Instance {
|
|
|
6895
6989
|
*/
|
|
6896
6990
|
GetValidationRules(this: AvatarCreationService): object;
|
|
6897
6991
|
/**
|
|
6992
|
+
* Automatically sets up a custom `Model` as an avatar asset.
|
|
6993
|
+
*
|
|
6898
6994
|
* - **ThreadSafety**: Unsafe
|
|
6899
6995
|
* - **Tags**: Yields
|
|
6900
6996
|
*
|
|
6901
6997
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AutoSetupAvatarAsync)
|
|
6998
|
+
* @param this A service to support developer avatar creators.
|
|
6999
|
+
* @param player The `Player` that the avatar is being set up for.
|
|
7000
|
+
* @param model The humanoid `Model` that will be set up as an avatar.
|
|
7001
|
+
* @returns A unique identifier for the generated avatar.
|
|
6902
7002
|
*/
|
|
6903
|
-
AutoSetupAvatarAsync(this: AvatarCreationService, player: Player, model: Model): string;
|
|
7003
|
+
AutoSetupAvatarAsync(this: AvatarCreationService, player: Player, model: Model, progressCallback?: Callback): string;
|
|
6904
7004
|
/**
|
|
6905
7005
|
* - **ThreadSafety**: Unsafe
|
|
6906
7006
|
* - **Tags**: Yields
|
|
6907
7007
|
*
|
|
6908
7008
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#GenerateAvatar2DPreviewAsync)
|
|
7009
|
+
* @param this A service to support developer avatar creators.
|
|
7010
|
+
* @param avatarGeneration2dPreviewParams
|
|
6909
7011
|
*/
|
|
6910
7012
|
GenerateAvatar2DPreviewAsync(this: AvatarCreationService, avatarGeneration2dPreviewParams: object): string;
|
|
6911
7013
|
/**
|
|
@@ -6913,6 +7015,8 @@ interface AvatarCreationService extends Instance {
|
|
|
6913
7015
|
* - **Tags**: Yields
|
|
6914
7016
|
*
|
|
6915
7017
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#GenerateAvatarAsync)
|
|
7018
|
+
* @param this A service to support developer avatar creators.
|
|
7019
|
+
* @param avatarGenerationParams
|
|
6916
7020
|
*/
|
|
6917
7021
|
GenerateAvatarAsync(this: AvatarCreationService, avatarGenerationParams: object): string;
|
|
6918
7022
|
/**
|
|
@@ -6932,13 +7036,20 @@ interface AvatarCreationService extends Instance {
|
|
|
6932
7036
|
* - **Tags**: Yields
|
|
6933
7037
|
*
|
|
6934
7038
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#LoadAvatar2DPreviewAsync)
|
|
7039
|
+
* @param this A service to support developer avatar creators.
|
|
7040
|
+
* @param previewId
|
|
6935
7041
|
*/
|
|
6936
7042
|
LoadAvatar2DPreviewAsync(this: AvatarCreationService, previewId: string): EditableImage;
|
|
6937
7043
|
/**
|
|
7044
|
+
* Loads a generated avatar using an avatar generation ID.
|
|
7045
|
+
*
|
|
6938
7046
|
* - **ThreadSafety**: Unsafe
|
|
6939
7047
|
* - **Tags**: Yields
|
|
6940
7048
|
*
|
|
6941
7049
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#LoadGeneratedAvatarAsync)
|
|
7050
|
+
* @param this A service to support developer avatar creators.
|
|
7051
|
+
* @param generationId A unique string that identifies the generated avatar, as returned by `AutoSetupAvatarAsync()`.
|
|
7052
|
+
* @returns The `HumanoidDescription` of the generated avatar, which includes all the generated instances and properties.
|
|
6942
7053
|
*/
|
|
6943
7054
|
LoadGeneratedAvatarAsync(this: AvatarCreationService, generationId: string): HumanoidDescription;
|
|
6944
7055
|
/**
|
|
@@ -6973,6 +7084,8 @@ interface AvatarCreationService extends Instance {
|
|
|
6973
7084
|
* - **Tags**: Yields
|
|
6974
7085
|
*
|
|
6975
7086
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PromptSelectAvatarGenerationImageAsync)
|
|
7087
|
+
* @param this A service to support developer avatar creators.
|
|
7088
|
+
* @param player
|
|
6976
7089
|
*/
|
|
6977
7090
|
PromptSelectAvatarGenerationImageAsync(this: AvatarCreationService, player: Player): string;
|
|
6978
7091
|
/**
|
|
@@ -6980,6 +7093,9 @@ interface AvatarCreationService extends Instance {
|
|
|
6980
7093
|
* - **Tags**: Yields
|
|
6981
7094
|
*
|
|
6982
7095
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#RequestAvatarGenerationSessionAsync)
|
|
7096
|
+
* @param this A service to support developer avatar creators.
|
|
7097
|
+
* @param player
|
|
7098
|
+
* @param callback
|
|
6983
7099
|
*/
|
|
6984
7100
|
RequestAvatarGenerationSessionAsync(this: AvatarCreationService, player: Player, callback: Callback): unknown;
|
|
6985
7101
|
/**
|
|
@@ -8305,7 +8421,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
|
|
|
8305
8421
|
*/
|
|
8306
8422
|
readonly _nominal_UnreliableRemoteEvent: unique symbol;
|
|
8307
8423
|
/**
|
|
8308
|
-
* Fires the `OnClientEvent` event for each client connected to the same `UnreliableRemoteEvent`. Has a
|
|
8424
|
+
* Fires the `OnClientEvent` event for each client connected to the same `UnreliableRemoteEvent`. Has a 1000 byte limit to the payload of the event. Otherwise, the event is dropped.
|
|
8309
8425
|
*
|
|
8310
8426
|
* - **ThreadSafety**: Unsafe
|
|
8311
8427
|
*
|
|
@@ -8315,7 +8431,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
|
|
|
8315
8431
|
*/
|
|
8316
8432
|
FireAllClients(this: UnreliableRemoteEvent, ...args: Parameters<T>): void;
|
|
8317
8433
|
/**
|
|
8318
|
-
* Fires the `OnClientEvent` event for a specific client connected to the same `UnreliableRemoteEvent`. Has a
|
|
8434
|
+
* Fires the `OnClientEvent` event for a specific client connected to the same `UnreliableRemoteEvent`. Has a 1000 byte limit to the payload of the event. Otherwise, the event is dropped.
|
|
8319
8435
|
*
|
|
8320
8436
|
* - **ThreadSafety**: Unsafe
|
|
8321
8437
|
*
|
|
@@ -8326,7 +8442,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
|
|
|
8326
8442
|
*/
|
|
8327
8443
|
FireClient(this: UnreliableRemoteEvent, player: Player, ...args: Parameters<T>): void;
|
|
8328
8444
|
/**
|
|
8329
|
-
* Fires the `OnServerEvent` event on the server from one client connected to the same `UnreliableRemoteEvent`. Has a
|
|
8445
|
+
* Fires the `OnServerEvent` event on the server from one client connected to the same `UnreliableRemoteEvent`. Has a 1000 byte limit to the payload of the event, otherwise event is dropped.
|
|
8330
8446
|
*
|
|
8331
8447
|
* - **ThreadSafety**: Unsafe
|
|
8332
8448
|
*
|
|
@@ -9417,7 +9533,7 @@ interface CalloutService extends Instance {
|
|
|
9417
9533
|
readonly _nominal_CalloutService: unique symbol;
|
|
9418
9534
|
}
|
|
9419
9535
|
/**
|
|
9420
|
-
* A service which provides control over screenshot capture features.
|
|
9536
|
+
* A service which provides control over screenshot and video capture features.
|
|
9421
9537
|
*
|
|
9422
9538
|
* - **Tags**: NotCreatable, Service
|
|
9423
9539
|
*
|
|
@@ -9438,28 +9554,40 @@ interface CaptureService extends Instance {
|
|
|
9438
9554
|
* - **ThreadSafety**: Unsafe
|
|
9439
9555
|
*
|
|
9440
9556
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureScreenshot)
|
|
9441
|
-
* @param this A service which provides control over screenshot capture features.
|
|
9557
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
9442
9558
|
* @param onCaptureReady A callback function that is called with the `contentId` of the new capture once it is ready.
|
|
9443
9559
|
*/
|
|
9444
9560
|
CaptureScreenshot(this: CaptureService, onCaptureReady: (captureContentId: string) => void): void;
|
|
9561
|
+
/**
|
|
9562
|
+
* - **ThreadSafety**: Unsafe
|
|
9563
|
+
*
|
|
9564
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#GetDeviceInfo)
|
|
9565
|
+
*/
|
|
9566
|
+
GetDeviceInfo(this: CaptureService): object;
|
|
9567
|
+
/**
|
|
9568
|
+
* - **ThreadSafety**: Unsafe
|
|
9569
|
+
*
|
|
9570
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptCaptureGalleryPermission)
|
|
9571
|
+
*/
|
|
9572
|
+
PromptCaptureGalleryPermission(this: CaptureService, captureGalleryPermission: CastsToEnum<Enum.CaptureGalleryPermission>, onAcceptedCallback: Callback, onDeniedCallback: Callback): void;
|
|
9445
9573
|
/**
|
|
9446
9574
|
* Prompts the user to save specified captures to their gallery.
|
|
9447
9575
|
*
|
|
9448
9576
|
* - **ThreadSafety**: Unsafe
|
|
9449
9577
|
*
|
|
9450
9578
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptSaveCapturesToGallery)
|
|
9451
|
-
* @param this A service which provides control over screenshot capture features.
|
|
9579
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
9452
9580
|
* @param captures
|
|
9453
9581
|
* @param resultCallback A callback function that will be invoked with a dictionary mapping each `contentId` to a boolean indicating if the user accepted saving that capture.
|
|
9454
9582
|
*/
|
|
9455
9583
|
PromptSaveCapturesToGallery<T extends string>(this: CaptureService, contentIds: Array<T>, resultCallback: (results: Record<T, boolean>) => void): void;
|
|
9456
9584
|
/**
|
|
9457
|
-
* Prompts the user to share a specified
|
|
9585
|
+
* Prompts the user to share a specified capture.
|
|
9458
9586
|
*
|
|
9459
9587
|
* - **ThreadSafety**: Unsafe
|
|
9460
9588
|
*
|
|
9461
9589
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptShareCapture)
|
|
9462
|
-
* @param this A service which provides control over screenshot capture features.
|
|
9590
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
9463
9591
|
* @param captureContent
|
|
9464
9592
|
* @param launchData An optional string to include as launch data in the invite link.
|
|
9465
9593
|
* @param onAcceptedCallback An optional callback function invoked if the user accepts sharing.
|
|
@@ -9467,31 +9595,49 @@ interface CaptureService extends Instance {
|
|
|
9467
9595
|
*/
|
|
9468
9596
|
PromptShareCapture(this: CaptureService, contentId: string, launchData: string, onAcceptedCallback: () => void, onDeniedCallback: () => void): void;
|
|
9469
9597
|
/**
|
|
9598
|
+
* Ends a video capture initiated by `StartVideoCaptureAsync()`.
|
|
9599
|
+
*
|
|
9470
9600
|
* - **ThreadSafety**: Unsafe
|
|
9471
9601
|
*
|
|
9472
9602
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StopVideoCapture)
|
|
9473
|
-
* @param this A service which provides control over screenshot capture features.
|
|
9603
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
9474
9604
|
*/
|
|
9475
9605
|
StopVideoCapture(this: CaptureService): void;
|
|
9476
9606
|
/**
|
|
9477
9607
|
* - **ThreadSafety**: Unsafe
|
|
9478
9608
|
*
|
|
9479
9609
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#TakeCapture)
|
|
9480
|
-
* @param this A service which provides control over screenshot capture features.
|
|
9610
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
9481
9611
|
* @param onCaptureReady
|
|
9482
9612
|
* @param captureParams
|
|
9483
9613
|
*/
|
|
9484
9614
|
TakeCapture(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
|
|
9485
9615
|
/**
|
|
9616
|
+
* - **ThreadSafety**: Unsafe
|
|
9617
|
+
* - **Tags**: Yields
|
|
9618
|
+
*
|
|
9619
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#ReadCapturesFromGalleryAsync)
|
|
9620
|
+
*/
|
|
9621
|
+
ReadCapturesFromGalleryAsync(this: CaptureService, captureTypeFilters?: Array<unknown>): unknown;
|
|
9622
|
+
/**
|
|
9623
|
+
* Initiates a video capture recording.
|
|
9624
|
+
*
|
|
9486
9625
|
* - **ThreadSafety**: Unsafe
|
|
9487
9626
|
* - **Tags**: Yields
|
|
9488
9627
|
*
|
|
9489
9628
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StartVideoCaptureAsync)
|
|
9490
|
-
* @param this A service which provides control over screenshot capture features.
|
|
9629
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
9491
9630
|
* @param onCaptureReady
|
|
9492
9631
|
* @param captureParams
|
|
9493
9632
|
*/
|
|
9494
9633
|
StartVideoCaptureAsync(this: CaptureService, onCaptureReady: Callback, captureParams?: object): Enum.VideoCaptureStartedResult;
|
|
9634
|
+
/**
|
|
9635
|
+
* - **ThreadSafety**: Unsafe
|
|
9636
|
+
* - **Tags**: Yields
|
|
9637
|
+
*
|
|
9638
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#UploadCaptureAsync)
|
|
9639
|
+
*/
|
|
9640
|
+
UploadCaptureAsync(this: CaptureService, capture: Capture): unknown;
|
|
9495
9641
|
/**
|
|
9496
9642
|
* Fires immediately before a capture begins.
|
|
9497
9643
|
*
|
|
@@ -14440,98 +14586,98 @@ interface DraggerService extends Instance {
|
|
|
14440
14586
|
*
|
|
14441
14587
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#AlignDraggedObjects)
|
|
14442
14588
|
*/
|
|
14443
|
-
|
|
14589
|
+
AlignDraggedObjects: boolean;
|
|
14444
14590
|
/**
|
|
14445
14591
|
* - **ThreadSafety**: ReadSafe
|
|
14446
14592
|
* - **Tags**: NotReplicated
|
|
14447
14593
|
*
|
|
14448
14594
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#AngleSnapEnabled)
|
|
14449
14595
|
*/
|
|
14450
|
-
|
|
14596
|
+
AngleSnapEnabled: boolean;
|
|
14451
14597
|
/**
|
|
14452
14598
|
* - **ThreadSafety**: ReadSafe
|
|
14453
14599
|
* - **Tags**: NotReplicated
|
|
14454
14600
|
*
|
|
14455
14601
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#AngleSnapIncrement)
|
|
14456
14602
|
*/
|
|
14457
|
-
|
|
14603
|
+
AngleSnapIncrement: number;
|
|
14458
14604
|
/**
|
|
14459
14605
|
* - **ThreadSafety**: ReadSafe
|
|
14460
14606
|
* - **Tags**: NotReplicated
|
|
14461
14607
|
*
|
|
14462
14608
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#AnimateHover)
|
|
14463
14609
|
*/
|
|
14464
|
-
|
|
14610
|
+
AnimateHover: boolean;
|
|
14465
14611
|
/**
|
|
14466
14612
|
* - **ThreadSafety**: ReadSafe
|
|
14467
14613
|
* - **Tags**: NotReplicated
|
|
14468
14614
|
*
|
|
14469
14615
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#CollisionsEnabled)
|
|
14470
14616
|
*/
|
|
14471
|
-
|
|
14617
|
+
CollisionsEnabled: boolean;
|
|
14472
14618
|
/**
|
|
14473
14619
|
* - **ThreadSafety**: ReadSafe
|
|
14474
14620
|
* - **Tags**: NotReplicated
|
|
14475
14621
|
*
|
|
14476
14622
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#DraggerCoordinateSpace)
|
|
14477
14623
|
*/
|
|
14478
|
-
|
|
14624
|
+
DraggerCoordinateSpace: Enum.DraggerCoordinateSpace;
|
|
14479
14625
|
/**
|
|
14480
14626
|
* - **ThreadSafety**: ReadSafe
|
|
14481
14627
|
* - **Tags**: NotReplicated
|
|
14482
14628
|
*
|
|
14483
14629
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#DraggerMovementMode)
|
|
14484
14630
|
*/
|
|
14485
|
-
|
|
14631
|
+
DraggerMovementMode: Enum.DraggerMovementMode;
|
|
14486
14632
|
/**
|
|
14487
14633
|
* - **ThreadSafety**: ReadSafe
|
|
14488
14634
|
* - **Tags**: NotReplicated
|
|
14489
14635
|
*
|
|
14490
14636
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#GeometrySnapColor)
|
|
14491
14637
|
*/
|
|
14492
|
-
|
|
14638
|
+
GeometrySnapColor: Color3;
|
|
14493
14639
|
/**
|
|
14494
14640
|
* - **ThreadSafety**: ReadSafe
|
|
14495
14641
|
* - **Tags**: NotReplicated
|
|
14496
14642
|
*
|
|
14497
14643
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#HoverAnimateFrequency)
|
|
14498
14644
|
*/
|
|
14499
|
-
|
|
14645
|
+
HoverAnimateFrequency: number;
|
|
14500
14646
|
/**
|
|
14501
14647
|
* - **ThreadSafety**: ReadSafe
|
|
14502
14648
|
* - **Tags**: NotReplicated
|
|
14503
14649
|
*
|
|
14504
14650
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#HoverThickness)
|
|
14505
14651
|
*/
|
|
14506
|
-
|
|
14652
|
+
HoverThickness: number;
|
|
14507
14653
|
/**
|
|
14508
14654
|
* - **ThreadSafety**: ReadSafe
|
|
14509
14655
|
* - **Tags**: NotReplicated
|
|
14510
14656
|
*
|
|
14511
14657
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#JointsEnabled)
|
|
14512
14658
|
*/
|
|
14513
|
-
|
|
14659
|
+
JointsEnabled: boolean;
|
|
14514
14660
|
/**
|
|
14515
14661
|
* - **ThreadSafety**: ReadSafe
|
|
14516
14662
|
* - **Tags**: NotReplicated
|
|
14517
14663
|
*
|
|
14518
14664
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#LinearSnapEnabled)
|
|
14519
14665
|
*/
|
|
14520
|
-
|
|
14666
|
+
LinearSnapEnabled: boolean;
|
|
14521
14667
|
/**
|
|
14522
14668
|
* - **ThreadSafety**: ReadSafe
|
|
14523
14669
|
* - **Tags**: NotReplicated
|
|
14524
14670
|
*
|
|
14525
14671
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#LinearSnapIncrement)
|
|
14526
14672
|
*/
|
|
14527
|
-
|
|
14673
|
+
LinearSnapIncrement: number;
|
|
14528
14674
|
/**
|
|
14529
14675
|
* - **ThreadSafety**: ReadSafe
|
|
14530
14676
|
* - **Tags**: NotReplicated
|
|
14531
14677
|
*
|
|
14532
14678
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService#ShowHover)
|
|
14533
14679
|
*/
|
|
14534
|
-
|
|
14680
|
+
ShowHover: boolean;
|
|
14535
14681
|
/**
|
|
14536
14682
|
* - **ThreadSafety**: ReadSafe
|
|
14537
14683
|
* - **Tags**: NotReplicated
|
|
@@ -14655,6 +14801,21 @@ interface ExampleService extends Instance {
|
|
|
14655
14801
|
*/
|
|
14656
14802
|
readonly _nominal_ExampleService: unique symbol;
|
|
14657
14803
|
}
|
|
14804
|
+
/**
|
|
14805
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
14806
|
+
*
|
|
14807
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExampleV2Service)
|
|
14808
|
+
*/
|
|
14809
|
+
interface ExampleV2Service extends Instance {
|
|
14810
|
+
/**
|
|
14811
|
+
* **DO NOT USE!**
|
|
14812
|
+
*
|
|
14813
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
14814
|
+
* @hidden
|
|
14815
|
+
* @deprecated
|
|
14816
|
+
*/
|
|
14817
|
+
readonly _nominal_ExampleV2Service: unique symbol;
|
|
14818
|
+
}
|
|
14658
14819
|
/**
|
|
14659
14820
|
* - **Tags**: NotCreatable, Service
|
|
14660
14821
|
*
|
|
@@ -14695,7 +14856,7 @@ interface ExperienceInviteOptions extends Instance {
|
|
|
14695
14856
|
*/
|
|
14696
14857
|
InviteMessageId: string;
|
|
14697
14858
|
/**
|
|
14698
|
-
* Roblox `UserId` of the specific
|
|
14859
|
+
* Roblox `UserId` of the specific connection to invite.
|
|
14699
14860
|
*
|
|
14700
14861
|
* - **ThreadSafety**: ReadSafe
|
|
14701
14862
|
*
|
|
@@ -14703,7 +14864,7 @@ interface ExperienceInviteOptions extends Instance {
|
|
|
14703
14864
|
*/
|
|
14704
14865
|
InviteUser: number;
|
|
14705
14866
|
/**
|
|
14706
|
-
* Used to set a parameter in `Player:GetJoinData()` when a
|
|
14867
|
+
* Used to set a parameter in `Player:GetJoinData()` when a connection joins from the invite notification.
|
|
14707
14868
|
*
|
|
14708
14869
|
* - **ThreadSafety**: ReadSafe
|
|
14709
14870
|
*
|
|
@@ -15032,6 +15193,24 @@ interface Decal extends FaceInstance {
|
|
|
15032
15193
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#LocalTransparencyModifier)
|
|
15033
15194
|
*/
|
|
15034
15195
|
LocalTransparencyModifier: number;
|
|
15196
|
+
/**
|
|
15197
|
+
* - **ThreadSafety**: ReadSafe
|
|
15198
|
+
*
|
|
15199
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#MetalnessMapContent)
|
|
15200
|
+
*/
|
|
15201
|
+
get MetalnessMapContent(): Content;
|
|
15202
|
+
/**
|
|
15203
|
+
* - **ThreadSafety**: ReadSafe
|
|
15204
|
+
*
|
|
15205
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#NormalMapContent)
|
|
15206
|
+
*/
|
|
15207
|
+
get NormalMapContent(): Content;
|
|
15208
|
+
/**
|
|
15209
|
+
* - **ThreadSafety**: ReadSafe
|
|
15210
|
+
*
|
|
15211
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#RoughnessMapContent)
|
|
15212
|
+
*/
|
|
15213
|
+
get RoughnessMapContent(): Content;
|
|
15035
15214
|
/**
|
|
15036
15215
|
* **Deprecated:** This non-functional property is deprecated and should not be used in new work.
|
|
15037
15216
|
*
|
|
@@ -15076,6 +15255,18 @@ interface Decal extends FaceInstance {
|
|
|
15076
15255
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#Transparency)
|
|
15077
15256
|
*/
|
|
15078
15257
|
Transparency: number;
|
|
15258
|
+
/**
|
|
15259
|
+
* - **ThreadSafety**: ReadSafe
|
|
15260
|
+
*
|
|
15261
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#UVOffset)
|
|
15262
|
+
*/
|
|
15263
|
+
UVOffset: Vector2;
|
|
15264
|
+
/**
|
|
15265
|
+
* - **ThreadSafety**: ReadSafe
|
|
15266
|
+
*
|
|
15267
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#UVScale)
|
|
15268
|
+
*/
|
|
15269
|
+
UVScale: Vector2;
|
|
15079
15270
|
/**
|
|
15080
15271
|
* Determines the rendering order when multiple Decals are assigned the same face.
|
|
15081
15272
|
*
|
|
@@ -15603,7 +15794,7 @@ interface GamepadService extends Instance {
|
|
|
15603
15794
|
EnableGamepadCursor(this: GamepadService, guiObject: GuiObject | undefined): void;
|
|
15604
15795
|
}
|
|
15605
15796
|
/**
|
|
15606
|
-
*
|
|
15797
|
+
* Service that allows developers to generate 3D objects from text prompts.
|
|
15607
15798
|
*
|
|
15608
15799
|
* - **Tags**: NotCreatable, Service
|
|
15609
15800
|
*
|
|
@@ -15619,31 +15810,32 @@ interface GenerationService extends Instance {
|
|
|
15619
15810
|
*/
|
|
15620
15811
|
readonly _nominal_GenerationService: unique symbol;
|
|
15621
15812
|
/**
|
|
15622
|
-
* Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result.
|
|
15813
|
+
* Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result.
|
|
15623
15814
|
*
|
|
15624
15815
|
* - **ThreadSafety**: Unsafe
|
|
15625
15816
|
* - **Tags**: Yields
|
|
15626
15817
|
*
|
|
15627
15818
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateMeshAsync)
|
|
15628
|
-
* @param this
|
|
15819
|
+
* @param this Service that allows developers to generate 3D objects from text prompts.
|
|
15629
15820
|
* @param inputs A dictionary containing the mesh generation prompts. Currently, the only supported key is the `Prompt` (string) that describes the mesh to generate.
|
|
15630
15821
|
* @param player The `Player` requesting the generation.
|
|
15631
|
-
* @param options
|
|
15632
|
-
*
|
|
15633
|
-
*
|
|
15634
|
-
*
|
|
15822
|
+
* @param options A dictionary for additional generation options to influence the result. The following key is supported: - `SuggestedSize` — Optional `Vector3` representing a size guide for the generated asset. The service will attempt to create a model with a size and proportion similar to the provided `Vector3`. This does not guarantee the final output size.
|
|
15823
|
+
*
|
|
15824
|
+
*
|
|
15825
|
+
* @param intermediateResultCallback A callback function triggered with intermediate generation results. Useful for retrieving early mesh versions before textures are applied.
|
|
15826
|
+
* @returns A tuple of the generation ID (a unique ID returned for each invocation of `GenerateMeshAsync()`) and context ID (not currently used).
|
|
15635
15827
|
*/
|
|
15636
15828
|
GenerateMeshAsync(this: GenerationService, inputs: object, player: Player, options: object, intermediateResultCallback?: Callback): unknown;
|
|
15637
15829
|
/**
|
|
15638
|
-
* Retrieves and loads a mesh generated by `GenerationService:GenerateMeshAsync()` using the provided `generationId`.
|
|
15830
|
+
* Retrieves and loads a mesh generated by `GenerationService:GenerateMeshAsync()` using the provided `generationId`.
|
|
15639
15831
|
*
|
|
15640
15832
|
* - **ThreadSafety**: Unsafe
|
|
15641
15833
|
* - **Tags**: Yields
|
|
15642
15834
|
*
|
|
15643
15835
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#LoadGeneratedMeshAsync)
|
|
15644
|
-
* @param this
|
|
15836
|
+
* @param this Service that allows developers to generate 3D objects from text prompts.
|
|
15645
15837
|
* @param generationId The unique ID returned by `GenerateMeshAsync()`. Identifies the mesh to load.
|
|
15646
|
-
* @returns The generated
|
|
15838
|
+
* @returns The generated asset, returned as a `Model` with a single `MeshPart` containing an `EditableMesh`.
|
|
15647
15839
|
*/
|
|
15648
15840
|
LoadGeneratedMeshAsync(this: GenerationService, generationId: string): MeshPart;
|
|
15649
15841
|
}
|
|
@@ -16940,6 +17132,8 @@ interface ImageButton extends GuiButton {
|
|
|
16940
17132
|
*/
|
|
16941
17133
|
HoverImage: ContentId;
|
|
16942
17134
|
/**
|
|
17135
|
+
* The image content that will be used when the `ImageButton` is being hovered. Only supports asset URIs.
|
|
17136
|
+
*
|
|
16943
17137
|
* - **ThreadSafety**: ReadSafe
|
|
16944
17138
|
*
|
|
16945
17139
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImageButton#HoverImageContent)
|
|
@@ -17011,6 +17205,8 @@ interface ImageButton extends GuiButton {
|
|
|
17011
17205
|
*/
|
|
17012
17206
|
PressedImage: ContentId;
|
|
17013
17207
|
/**
|
|
17208
|
+
* The image content that will be used when an `ImageButton` is being pressed. Only supports asset URIs.
|
|
17209
|
+
*
|
|
17014
17210
|
* - **ThreadSafety**: ReadSafe
|
|
17015
17211
|
*
|
|
17016
17212
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImageButton#PressedImageContent)
|
|
@@ -17730,6 +17926,8 @@ interface ScrollingFrame extends GuiObject {
|
|
|
17730
17926
|
*/
|
|
17731
17927
|
BottomImage: ContentId;
|
|
17732
17928
|
/**
|
|
17929
|
+
* Image that displays on the bottom of a vertical scroll bar, or the right of a horizontal scroll bar (rotated 90° counterclockwise for a horizontal scroll bar). Only supports asset URIs as textures.
|
|
17930
|
+
*
|
|
17733
17931
|
* - **ThreadSafety**: ReadSafe
|
|
17734
17932
|
*
|
|
17735
17933
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#BottomImageContent)
|
|
@@ -17776,6 +17974,8 @@ interface ScrollingFrame extends GuiObject {
|
|
|
17776
17974
|
*/
|
|
17777
17975
|
MidImage: ContentId;
|
|
17778
17976
|
/**
|
|
17977
|
+
* Image which spans the area between `TopImageContent` and `BottomImageContent` (rotated 90° counterclockwise for a horizontal scroll bar). Only supports asset URIs as textures.
|
|
17978
|
+
*
|
|
17779
17979
|
* - **ThreadSafety**: ReadSafe
|
|
17780
17980
|
*
|
|
17781
17981
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#MidImageContent)
|
|
@@ -28092,6 +28292,8 @@ interface BasePart extends PVInstance {
|
|
|
28092
28292
|
*/
|
|
28093
28293
|
GetRenderCFrame(this: BasePart): CFrame;
|
|
28094
28294
|
/**
|
|
28295
|
+
* **Deprecated:**
|
|
28296
|
+
*
|
|
28095
28297
|
* Returns the base part of an assembly of parts.
|
|
28096
28298
|
*
|
|
28097
28299
|
* - **ThreadSafety**: Safe
|
|
@@ -30998,6 +31200,21 @@ interface BanHistoryPages extends Pages {
|
|
|
30998
31200
|
*/
|
|
30999
31201
|
readonly _nominal_BanHistoryPages: unique symbol;
|
|
31000
31202
|
}
|
|
31203
|
+
/**
|
|
31204
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
31205
|
+
*
|
|
31206
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CapturesPages)
|
|
31207
|
+
*/
|
|
31208
|
+
interface CapturesPages extends Pages {
|
|
31209
|
+
/**
|
|
31210
|
+
* **DO NOT USE!**
|
|
31211
|
+
*
|
|
31212
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
31213
|
+
* @hidden
|
|
31214
|
+
* @deprecated
|
|
31215
|
+
*/
|
|
31216
|
+
readonly _nominal_CapturesPages: unique symbol;
|
|
31217
|
+
}
|
|
31001
31218
|
/**
|
|
31002
31219
|
* - **Tags**: NotCreatable, NotReplicated
|
|
31003
31220
|
*
|
|
@@ -31099,7 +31316,7 @@ interface DataStoreVersionPages extends Pages<DataStoreObjectVersionInfo> {
|
|
|
31099
31316
|
readonly _nominal_DataStoreVersionPages: unique symbol;
|
|
31100
31317
|
}
|
|
31101
31318
|
/**
|
|
31102
|
-
* A special version of `Pages` that contains information about a player's
|
|
31319
|
+
* A special version of `Pages` that contains information about a player's connections.
|
|
31103
31320
|
*
|
|
31104
31321
|
* - **Tags**: NotCreatable, NotReplicated
|
|
31105
31322
|
*
|
|
@@ -32532,6 +32749,7 @@ interface Player extends Instance {
|
|
|
32532
32749
|
* - **ThreadSafety**: Unsafe
|
|
32533
32750
|
*
|
|
32534
32751
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetData)
|
|
32752
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32535
32753
|
*/
|
|
32536
32754
|
GetData(this: Player): PlayerData;
|
|
32537
32755
|
/**
|
|
@@ -32752,15 +32970,15 @@ interface Player extends Instance {
|
|
|
32752
32970
|
*/
|
|
32753
32971
|
SaveString(this: Player, key: string, value: string): void;
|
|
32754
32972
|
/**
|
|
32755
|
-
* Returns a dictionary of online
|
|
32973
|
+
* Returns a dictionary of online connections.
|
|
32756
32974
|
*
|
|
32757
32975
|
* - **ThreadSafety**: Unsafe
|
|
32758
32976
|
* - **Tags**: Yields
|
|
32759
32977
|
*
|
|
32760
32978
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnline)
|
|
32761
32979
|
* @param this An object that represents a presently connected client to the experience.
|
|
32762
|
-
* @param maxFriends The maximum number of online
|
|
32763
|
-
* @returns A dictionary of online
|
|
32980
|
+
* @param maxFriends The maximum number of online connections to return.
|
|
32981
|
+
* @returns A dictionary of online connections (see the table above).
|
|
32764
32982
|
*/
|
|
32765
32983
|
GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
|
|
32766
32984
|
/**
|
|
@@ -32790,7 +33008,7 @@ interface Player extends Instance {
|
|
|
32790
33008
|
/**
|
|
32791
33009
|
* **Deprecated:** This function is obsolete because the Best Friends feature was removed. Use `Player:IsFriendsWith()` instead.
|
|
32792
33010
|
*
|
|
32793
|
-
* Returns whether a player is
|
|
33011
|
+
* Returns whether a player is connections with the specified user.
|
|
32794
33012
|
*
|
|
32795
33013
|
* - **ThreadSafety**: Unsafe
|
|
32796
33014
|
* - **Tags**: Yields
|
|
@@ -32803,7 +33021,7 @@ interface Player extends Instance {
|
|
|
32803
33021
|
*/
|
|
32804
33022
|
IsBestFriendsWith(this: Player, userId: number): boolean;
|
|
32805
33023
|
/**
|
|
32806
|
-
* Checks whether a player is a
|
|
33024
|
+
* Checks whether a player is a connection of the user with the given `Player.UserId`.
|
|
32807
33025
|
*
|
|
32808
33026
|
* - **ThreadSafety**: Unsafe
|
|
32809
33027
|
* - **Tags**: Yields
|
|
@@ -32811,7 +33029,7 @@ interface Player extends Instance {
|
|
|
32811
33029
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWith)
|
|
32812
33030
|
* @param this An object that represents a presently connected client to the experience.
|
|
32813
33031
|
* @param userId The `Player.UserId` of the specified player.
|
|
32814
|
-
* @returns A boolean indicating whether a player is a
|
|
33032
|
+
* @returns A boolean indicating whether a player is a connection of the specified user.
|
|
32815
33033
|
*/
|
|
32816
33034
|
IsFriendsWith(this: Player, userId: number): boolean;
|
|
32817
33035
|
/**
|
|
@@ -33505,7 +33723,7 @@ interface Players extends Instance {
|
|
|
33505
33723
|
*/
|
|
33506
33724
|
GetCharacterAppearanceInfoAsync(this: Players, userId: number): CharacterAppearanceInfo;
|
|
33507
33725
|
/**
|
|
33508
|
-
* Returns a `FriendPages` object which contains information for all of the given player's
|
|
33726
|
+
* Returns a `FriendPages` object which contains information for all of the given player's connections.
|
|
33509
33727
|
*
|
|
33510
33728
|
* - **ThreadSafety**: Unsafe
|
|
33511
33729
|
* - **Tags**: Yields
|
|
@@ -34509,9 +34727,10 @@ interface RecommendationService extends Instance {
|
|
|
34509
34727
|
*
|
|
34510
34728
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#RegisterItemAsync)
|
|
34511
34729
|
* @param this
|
|
34730
|
+
* @param player
|
|
34512
34731
|
* @param registerRecommendationItemsRequest
|
|
34513
34732
|
*/
|
|
34514
|
-
RegisterItemAsync(this: RecommendationService, registerRecommendationItemsRequest: object): object;
|
|
34733
|
+
RegisterItemAsync(this: RecommendationService, player: Player, registerRecommendationItemsRequest: object): object;
|
|
34515
34734
|
/**
|
|
34516
34735
|
* - **ThreadSafety**: Unsafe
|
|
34517
34736
|
* - **Tags**: Yields
|
|
@@ -36558,6 +36777,9 @@ interface SocialService extends Instance {
|
|
|
36558
36777
|
* - **Tags**: Yields
|
|
36559
36778
|
*
|
|
36560
36779
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptLinkSharing)
|
|
36780
|
+
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
36781
|
+
* @param player
|
|
36782
|
+
* @param options
|
|
36561
36783
|
*/
|
|
36562
36784
|
PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
|
|
36563
36785
|
/**
|
|
@@ -38662,6 +38884,14 @@ interface SurfaceAppearance extends Instance {
|
|
|
38662
38884
|
* @deprecated
|
|
38663
38885
|
*/
|
|
38664
38886
|
readonly _nominal_SurfaceAppearance: unique symbol;
|
|
38887
|
+
/**
|
|
38888
|
+
* Determines how the alpha channel of the `SurfaceAppearance.ColorMap` is used.
|
|
38889
|
+
*
|
|
38890
|
+
* - **ThreadSafety**: ReadSafe
|
|
38891
|
+
*
|
|
38892
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#AlphaMode)
|
|
38893
|
+
*/
|
|
38894
|
+
AlphaMode: Enum.AlphaMode;
|
|
38665
38895
|
/**
|
|
38666
38896
|
* Applies a tint to your existing colormap. Set directly with color picker or programmatically with `Color3`.
|
|
38667
38897
|
*
|
|
@@ -41685,15 +41915,15 @@ interface UIContainerQuery extends UIComponent {
|
|
|
41685
41915
|
/**
|
|
41686
41916
|
* - **ThreadSafety**: ReadSafe
|
|
41687
41917
|
*
|
|
41688
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#
|
|
41918
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#AspectRatioRange)
|
|
41689
41919
|
*/
|
|
41690
|
-
|
|
41920
|
+
AspectRatioRange: NumberRange;
|
|
41691
41921
|
/**
|
|
41692
41922
|
* - **ThreadSafety**: ReadSafe
|
|
41693
41923
|
*
|
|
41694
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#
|
|
41924
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#IsActive)
|
|
41695
41925
|
*/
|
|
41696
|
-
|
|
41926
|
+
IsActive: boolean;
|
|
41697
41927
|
/**
|
|
41698
41928
|
* - **ThreadSafety**: ReadSafe
|
|
41699
41929
|
*
|
|
@@ -42597,6 +42827,18 @@ interface UIStroke extends UIComponent {
|
|
|
42597
42827
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIStroke#ApplyStrokeMode)
|
|
42598
42828
|
*/
|
|
42599
42829
|
ApplyStrokeMode: Enum.ApplyStrokeMode;
|
|
42830
|
+
/**
|
|
42831
|
+
* - **ThreadSafety**: ReadSafe
|
|
42832
|
+
*
|
|
42833
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIStroke#BorderOffset)
|
|
42834
|
+
*/
|
|
42835
|
+
BorderOffset: UDim;
|
|
42836
|
+
/**
|
|
42837
|
+
* - **ThreadSafety**: ReadSafe
|
|
42838
|
+
*
|
|
42839
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIStroke#BorderStrokePosition)
|
|
42840
|
+
*/
|
|
42841
|
+
BorderStrokePosition: Enum.BorderStrokePosition;
|
|
42600
42842
|
/**
|
|
42601
42843
|
* Determines the stroke color.
|
|
42602
42844
|
*
|