@rbxts/types 1.0.876 → 1.0.878
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.
|
@@ -32,6 +32,7 @@ interface Services {
|
|
|
32
32
|
BulkImportService: BulkImportService;
|
|
33
33
|
CalloutService: CalloutService;
|
|
34
34
|
CaptureService: CaptureService;
|
|
35
|
+
ChangeHistoryStreamingService: ChangeHistoryStreamingService;
|
|
35
36
|
Chat: Chat;
|
|
36
37
|
ChatbotUIService: ChatbotUIService;
|
|
37
38
|
CloudCRUDService: CloudCRUDService;
|
|
@@ -141,6 +142,7 @@ interface Services {
|
|
|
141
142
|
PublishService: PublishService;
|
|
142
143
|
RecommendationService: RecommendationService;
|
|
143
144
|
ReflectionService: ReflectionService;
|
|
145
|
+
RemoteCommandService: RemoteCommandService;
|
|
144
146
|
RemoteCursorService: RemoteCursorService;
|
|
145
147
|
RemoteDebuggerServer: RemoteDebuggerServer;
|
|
146
148
|
ReplicatedFirst: ReplicatedFirst;
|
|
@@ -173,6 +175,7 @@ interface Services {
|
|
|
173
175
|
SnippetService: SnippetService;
|
|
174
176
|
SocialService: SocialService;
|
|
175
177
|
SoundService: SoundService;
|
|
178
|
+
SoundShimService: SoundShimService;
|
|
176
179
|
StarterGui: StarterGui;
|
|
177
180
|
StarterPack: StarterPack;
|
|
178
181
|
StarterPlayer: StarterPlayer;
|
|
@@ -477,6 +480,7 @@ interface CreatableInstances {
|
|
|
477
480
|
TextChannel: TextChannel;
|
|
478
481
|
TextChatCommand: TextChatCommand;
|
|
479
482
|
TextChatMessageProperties: TextChatMessageProperties;
|
|
483
|
+
TextGenerator: TextGenerator;
|
|
480
484
|
TextLabel: TextLabel;
|
|
481
485
|
Texture: Texture;
|
|
482
486
|
Tool: Tool;
|
|
@@ -702,6 +706,7 @@ interface Objects extends Instances {
|
|
|
702
706
|
ConfigSnapshot: ConfigSnapshot;
|
|
703
707
|
EditableImage: EditableImage;
|
|
704
708
|
EditableMesh: EditableMesh;
|
|
709
|
+
ExecutedRemoteCommand: ExecutedRemoteCommand;
|
|
705
710
|
MLSession: MLSession;
|
|
706
711
|
Object: RBXObject;
|
|
707
712
|
ScreenshotCapture: ScreenshotCapture;
|
|
@@ -1130,6 +1135,12 @@ interface EditableMesh extends RBXObject {
|
|
|
1130
1135
|
* @returns Stable color ID of the new color.
|
|
1131
1136
|
*/
|
|
1132
1137
|
AddColor(this: EditableMesh, color: Color3, alpha: number): number;
|
|
1138
|
+
/**
|
|
1139
|
+
* - **ThreadSafety**: Unsafe
|
|
1140
|
+
*
|
|
1141
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddFace)
|
|
1142
|
+
*/
|
|
1143
|
+
AddFace(this: EditableMesh, vertexIds: Array<unknown>): number;
|
|
1133
1144
|
/**
|
|
1134
1145
|
* Adds a new normal to the geometry and returns a stable normal ID.
|
|
1135
1146
|
*
|
|
@@ -1427,24 +1438,39 @@ interface EditableMesh extends RBXObject {
|
|
|
1427
1438
|
*/
|
|
1428
1439
|
GetFacesWithAttribute(this: EditableMesh, id: number): Array<unknown>;
|
|
1429
1440
|
/**
|
|
1441
|
+
* Returns an array of face IDs that use the given color ID.
|
|
1442
|
+
*
|
|
1430
1443
|
* - **ThreadSafety**: Unsafe
|
|
1431
1444
|
* - **Tags**: CustomLuaState
|
|
1432
1445
|
*
|
|
1433
1446
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithColor)
|
|
1447
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1448
|
+
* @param colorId Color ID to find faces for.
|
|
1449
|
+
* @returns List of face IDs that use the provided color ID.
|
|
1434
1450
|
*/
|
|
1435
1451
|
GetFacesWithColor(this: EditableMesh, colorId: number): Array<unknown>;
|
|
1436
1452
|
/**
|
|
1453
|
+
* Returns an array of face IDs that use the given normal ID.
|
|
1454
|
+
*
|
|
1437
1455
|
* - **ThreadSafety**: Unsafe
|
|
1438
1456
|
* - **Tags**: CustomLuaState
|
|
1439
1457
|
*
|
|
1440
1458
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithNormal)
|
|
1459
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1460
|
+
* @param normalId Normal ID to find faces for.
|
|
1461
|
+
* @returns List of face IDs that use the provided normal ID.
|
|
1441
1462
|
*/
|
|
1442
1463
|
GetFacesWithNormal(this: EditableMesh, normalId: number): Array<unknown>;
|
|
1443
1464
|
/**
|
|
1465
|
+
* Returns an array of face IDs that use the given UV ID.
|
|
1466
|
+
*
|
|
1444
1467
|
* - **ThreadSafety**: Unsafe
|
|
1445
1468
|
* - **Tags**: CustomLuaState
|
|
1446
1469
|
*
|
|
1447
1470
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithUV)
|
|
1471
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1472
|
+
* @param uvId UV ID to find faces for.
|
|
1473
|
+
* @returns List of face IDs that use the provided UV ID.
|
|
1448
1474
|
*/
|
|
1449
1475
|
GetFacesWithUV(this: EditableMesh, uvId: number): Array<unknown>;
|
|
1450
1476
|
/**
|
|
@@ -1575,49 +1601,87 @@ interface EditableMesh extends RBXObject {
|
|
|
1575
1601
|
*/
|
|
1576
1602
|
GetVertexBones(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1577
1603
|
/**
|
|
1604
|
+
* Returns the color IDs of the faces attached to the given vertex.
|
|
1605
|
+
*
|
|
1578
1606
|
* - **ThreadSafety**: Unsafe
|
|
1579
1607
|
* - **Tags**: CustomLuaState
|
|
1580
1608
|
*
|
|
1581
1609
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexColors)
|
|
1610
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1611
|
+
* @param vertexId Stable vertex ID to find color IDs.
|
|
1612
|
+
* @returns Array of color IDs of faces attached to the given vertex.
|
|
1582
1613
|
*/
|
|
1583
1614
|
GetVertexColors(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1584
1615
|
/**
|
|
1616
|
+
* Returns the color ID of a vertex/face pair.
|
|
1617
|
+
*
|
|
1585
1618
|
* - **ThreadSafety**: Unsafe
|
|
1586
1619
|
*
|
|
1587
1620
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceColor)
|
|
1621
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1622
|
+
* @param vertexId Stable vertex ID.
|
|
1623
|
+
* @param faceId Stable face ID.
|
|
1624
|
+
* @returns Stable color ID of the vertex/face pair.
|
|
1588
1625
|
*/
|
|
1589
1626
|
GetVertexFaceColor(this: EditableMesh, vertexId: number, faceId: number): number;
|
|
1590
1627
|
/**
|
|
1628
|
+
* Returns the normal ID of a vertex/face pair.
|
|
1629
|
+
*
|
|
1591
1630
|
* - **ThreadSafety**: Unsafe
|
|
1592
1631
|
*
|
|
1593
1632
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceNormal)
|
|
1633
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1634
|
+
* @param vertexId Stable vertex ID.
|
|
1635
|
+
* @param faceId Stable face ID.
|
|
1636
|
+
* @returns Stable normal ID of the vertex/face pair.
|
|
1594
1637
|
*/
|
|
1595
1638
|
GetVertexFaceNormal(this: EditableMesh, vertexId: number, faceId: number): number;
|
|
1596
1639
|
/**
|
|
1640
|
+
* Returns the UV ID of a vertex/face pair.
|
|
1641
|
+
*
|
|
1597
1642
|
* - **ThreadSafety**: Unsafe
|
|
1598
1643
|
*
|
|
1599
1644
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceUV)
|
|
1645
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1646
|
+
* @param vertexId Stable vertex ID.
|
|
1647
|
+
* @param faceId Stable face ID.
|
|
1648
|
+
* @returns Stable UV ID of the vertex/face pair.
|
|
1600
1649
|
*/
|
|
1601
1650
|
GetVertexFaceUV(this: EditableMesh, vertexId: number, faceId: number): number;
|
|
1602
1651
|
/**
|
|
1652
|
+
* Returns the face IDs of the faces attached to the given vertex.
|
|
1653
|
+
*
|
|
1603
1654
|
* - **ThreadSafety**: Unsafe
|
|
1604
1655
|
* - **Tags**: CustomLuaState
|
|
1605
1656
|
*
|
|
1606
1657
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaces)
|
|
1658
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1659
|
+
* @param vertexId Stable vertex ID to find faces for.
|
|
1660
|
+
* @returns Array of face IDs attached to the given vertex.
|
|
1607
1661
|
*/
|
|
1608
1662
|
GetVertexFaces(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1609
1663
|
/**
|
|
1664
|
+
* Returns the normal IDs of the faces attached to the given vertex.
|
|
1665
|
+
*
|
|
1610
1666
|
* - **ThreadSafety**: Unsafe
|
|
1611
1667
|
* - **Tags**: CustomLuaState
|
|
1612
1668
|
*
|
|
1613
1669
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexNormals)
|
|
1670
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1671
|
+
* @param vertexId Stable vertex ID to find normal IDs.
|
|
1672
|
+
* @returns Array of normal IDs of faces attached to the given vertex.
|
|
1614
1673
|
*/
|
|
1615
1674
|
GetVertexNormals(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1616
1675
|
/**
|
|
1676
|
+
* Returns the UV IDs of the faces attached to the given vertex.
|
|
1677
|
+
*
|
|
1617
1678
|
* - **ThreadSafety**: Unsafe
|
|
1618
1679
|
* - **Tags**: CustomLuaState
|
|
1619
1680
|
*
|
|
1620
1681
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexUVs)
|
|
1682
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1683
|
+
* @param vertexId Stable vertex ID to find UV IDs.
|
|
1684
|
+
* @returns Array of UV IDs of faces attached to the given vertex.
|
|
1621
1685
|
*/
|
|
1622
1686
|
GetVertexUVs(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1623
1687
|
/**
|
|
@@ -1647,24 +1711,39 @@ interface EditableMesh extends RBXObject {
|
|
|
1647
1711
|
*/
|
|
1648
1712
|
GetVerticesWithAttribute(this: EditableMesh, id: number): Array<unknown>;
|
|
1649
1713
|
/**
|
|
1714
|
+
* Returns an array of face IDs that use the given color ID.
|
|
1715
|
+
*
|
|
1650
1716
|
* - **ThreadSafety**: Unsafe
|
|
1651
1717
|
* - **Tags**: CustomLuaState
|
|
1652
1718
|
*
|
|
1653
1719
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithColor)
|
|
1720
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1721
|
+
* @param colorId Color ID to find faces for.
|
|
1722
|
+
* @returns List of face IDs that use the provided color ID.
|
|
1654
1723
|
*/
|
|
1655
1724
|
GetVerticesWithColor(this: EditableMesh, colorId: number): Array<unknown>;
|
|
1656
1725
|
/**
|
|
1726
|
+
* Returns an array of vertex IDs that use the given normal ID.
|
|
1727
|
+
*
|
|
1657
1728
|
* - **ThreadSafety**: Unsafe
|
|
1658
1729
|
* - **Tags**: CustomLuaState
|
|
1659
1730
|
*
|
|
1660
1731
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithNormal)
|
|
1732
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1733
|
+
* @param normalId Normal ID to find vertices for.
|
|
1734
|
+
* @returns List of vertex IDs that use the provided normal ID.
|
|
1661
1735
|
*/
|
|
1662
1736
|
GetVerticesWithNormal(this: EditableMesh, normalId: number): Array<unknown>;
|
|
1663
1737
|
/**
|
|
1738
|
+
* Returns an array of vertex IDs that use the given UV ID.
|
|
1739
|
+
*
|
|
1664
1740
|
* - **ThreadSafety**: Unsafe
|
|
1665
1741
|
* - **Tags**: CustomLuaState
|
|
1666
1742
|
*
|
|
1667
1743
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithUV)
|
|
1744
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1745
|
+
* @param uvId UV ID to find vertices for.
|
|
1746
|
+
* @returns List of vertex IDs that use the provided UV ID.
|
|
1668
1747
|
*/
|
|
1669
1748
|
GetVerticesWithUV(this: EditableMesh, uvId: number): Array<unknown>;
|
|
1670
1749
|
/**
|
|
@@ -1949,21 +2028,39 @@ interface EditableMesh extends RBXObject {
|
|
|
1949
2028
|
*/
|
|
1950
2029
|
SetVertexBones(this: EditableMesh, vertexId: number, boneIDs: Array<unknown>): void;
|
|
1951
2030
|
/**
|
|
2031
|
+
* Sets the color ID of a vertex/face pair.
|
|
2032
|
+
*
|
|
1952
2033
|
* - **ThreadSafety**: Unsafe
|
|
1953
2034
|
*
|
|
1954
2035
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceColor)
|
|
2036
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
2037
|
+
* @param vertexId Stable vertex ID.
|
|
2038
|
+
* @param faceId Stable face ID.
|
|
2039
|
+
* @param colorId Stable color ID to set for the vertex/face pair.
|
|
1955
2040
|
*/
|
|
1956
2041
|
SetVertexFaceColor(this: EditableMesh, vertexId: number, faceId: number, colorId: number): void;
|
|
1957
2042
|
/**
|
|
2043
|
+
* Sets the normal ID of a vertex/face pair.
|
|
2044
|
+
*
|
|
1958
2045
|
* - **ThreadSafety**: Unsafe
|
|
1959
2046
|
*
|
|
1960
2047
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceNormal)
|
|
2048
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
2049
|
+
* @param vertexId Stable vertex ID.
|
|
2050
|
+
* @param faceId Stable face ID.
|
|
2051
|
+
* @param normalId Stable normal ID to set for the vertex/face pair.
|
|
1961
2052
|
*/
|
|
1962
2053
|
SetVertexFaceNormal(this: EditableMesh, vertexId: number, faceId: number, normalId: number): void;
|
|
1963
2054
|
/**
|
|
2055
|
+
* Sets the UV ID of a vertex/face pair.
|
|
2056
|
+
*
|
|
1964
2057
|
* - **ThreadSafety**: Unsafe
|
|
1965
2058
|
*
|
|
1966
2059
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceUV)
|
|
2060
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
2061
|
+
* @param vertexId Stable vertex ID.
|
|
2062
|
+
* @param faceId Stable face ID.
|
|
2063
|
+
* @param uvId Stable UV ID to set for the vertex/face pair.
|
|
1967
2064
|
*/
|
|
1968
2065
|
SetVertexFaceUV(this: EditableMesh, vertexId: number, faceId: number, uvId: number): void;
|
|
1969
2066
|
/**
|
|
@@ -1976,6 +2073,45 @@ interface EditableMesh extends RBXObject {
|
|
|
1976
2073
|
*/
|
|
1977
2074
|
Triangulate(this: EditableMesh): void;
|
|
1978
2075
|
}
|
|
2076
|
+
/**
|
|
2077
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
2078
|
+
*
|
|
2079
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExecutedRemoteCommand)
|
|
2080
|
+
*/
|
|
2081
|
+
interface ExecutedRemoteCommand extends RBXObject {
|
|
2082
|
+
/**
|
|
2083
|
+
* **DO NOT USE!**
|
|
2084
|
+
*
|
|
2085
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
2086
|
+
* @hidden
|
|
2087
|
+
* @deprecated
|
|
2088
|
+
*/
|
|
2089
|
+
readonly _nominal_ExecutedRemoteCommand: unique symbol;
|
|
2090
|
+
/**
|
|
2091
|
+
* - **ThreadSafety**: Unsafe
|
|
2092
|
+
*
|
|
2093
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExecutedRemoteCommand#RunMoreCode)
|
|
2094
|
+
*/
|
|
2095
|
+
RunMoreCode(this: ExecutedRemoteCommand, code: string, args: unknown): void;
|
|
2096
|
+
/**
|
|
2097
|
+
* - **ThreadSafety**: Unsafe
|
|
2098
|
+
*
|
|
2099
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExecutedRemoteCommand#SendUpdate)
|
|
2100
|
+
*/
|
|
2101
|
+
SendUpdate(this: ExecutedRemoteCommand, args: unknown): void;
|
|
2102
|
+
/**
|
|
2103
|
+
* - **ThreadSafety**: Unsafe
|
|
2104
|
+
*
|
|
2105
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExecutedRemoteCommand#Stop)
|
|
2106
|
+
*/
|
|
2107
|
+
Stop(this: ExecutedRemoteCommand): void;
|
|
2108
|
+
/**
|
|
2109
|
+
* - **ThreadSafety**: Unsafe
|
|
2110
|
+
*
|
|
2111
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExecutedRemoteCommand#ReceivedUpdate)
|
|
2112
|
+
*/
|
|
2113
|
+
readonly ReceivedUpdate: RBXScriptSignal<(args: unknown) => void>;
|
|
2114
|
+
}
|
|
1979
2115
|
/**
|
|
1980
2116
|
* `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1981
2117
|
*
|
|
@@ -3387,14 +3523,14 @@ interface AnimationTrack extends Instance {
|
|
|
3387
3523
|
*/
|
|
3388
3524
|
AdjustWeight(this: AnimationTrack, weight?: number, fadeTime?: number): void;
|
|
3389
3525
|
/**
|
|
3390
|
-
* Returns an `
|
|
3526
|
+
* Returns an `RBXScriptSignal` (event) that fires when a specified `KeyframeMarker` has been hit in an `animation`.
|
|
3391
3527
|
*
|
|
3392
3528
|
* - **ThreadSafety**: Unsafe
|
|
3393
3529
|
*
|
|
3394
3530
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetMarkerReachedSignal)
|
|
3395
3531
|
* @param this Controls the playback of an animation on an `Animator`.
|
|
3396
3532
|
* @param name The name of the `KeyframeMarker` the signal is being created for. Not to be confused with the name of the `Keyframe`.
|
|
3397
|
-
* @returns The signal created and fired when the animation reaches the created `KeyframeMarker`.
|
|
3533
|
+
* @returns The signal created and fired when the animation reaches the created `KeyframeMarker`.
|
|
3398
3534
|
*/
|
|
3399
3535
|
GetMarkerReachedSignal(this: AnimationTrack, name: string): RBXScriptSignal<(param?: string) => void>;
|
|
3400
3536
|
/**
|
|
@@ -3809,6 +3945,13 @@ interface AssetService extends Instance {
|
|
|
3809
3945
|
* @param editableMeshOptions Table containing options for the created `EditableMesh`. Currently no options are available since `FixedSize` will always be `false` for empty editable meshes.
|
|
3810
3946
|
*/
|
|
3811
3947
|
CreateEditableMesh(this: AssetService, editableMeshOptions?: object): EditableMesh;
|
|
3948
|
+
/**
|
|
3949
|
+
* - **ThreadSafety**: Unsafe
|
|
3950
|
+
* - **Tags**: Yields
|
|
3951
|
+
*
|
|
3952
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#ComposeDecalAsync)
|
|
3953
|
+
*/
|
|
3954
|
+
ComposeDecalAsync(this: AssetService, layers: Array<unknown>): Decal;
|
|
3812
3955
|
/**
|
|
3813
3956
|
* Uploads a new asset to Roblox from the given object.
|
|
3814
3957
|
*
|
|
@@ -3931,12 +4074,20 @@ interface AssetService extends Instance {
|
|
|
3931
4074
|
*/
|
|
3932
4075
|
CreatePlaceInPlayerInventoryAsync(this: AssetService, player: Player, placeName: string, templatePlaceID: number, description: string): number;
|
|
3933
4076
|
/**
|
|
4077
|
+
* Creates a new `SurfaceAppearance` object using the provided content maps.
|
|
4078
|
+
*
|
|
3934
4079
|
* - **ThreadSafety**: Unsafe
|
|
3935
4080
|
* - **Tags**: Yields
|
|
3936
4081
|
*
|
|
3937
4082
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateSurfaceAppearanceAsync)
|
|
3938
4083
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
3939
|
-
* @param content
|
|
4084
|
+
* @param content Dictionary containing the following key-value pairs: - `ColorMap` — A `Content` object that contains the color map. Default is `nil`.
|
|
4085
|
+
* - `MetalnessMap` — A `Content` object that contains the metalness map. If more than one channel is present, only the red channel is used. Default is `nil`.
|
|
4086
|
+
* - `NormalMap` — A `Content` object that contains the normal map. Default is `nil`.
|
|
4087
|
+
* - `RoughnessMap` — A `Content` object that contains the roughness map. If more than one channel is present, only the red channel is used. Default is `nil`.
|
|
4088
|
+
*
|
|
4089
|
+
*
|
|
4090
|
+
* @returns A new `SurfaceAppearance` instance with the given maps from the `content` parameter.
|
|
3940
4091
|
*/
|
|
3941
4092
|
CreateSurfaceAppearanceAsync(this: AssetService, content: object): SurfaceAppearance;
|
|
3942
4093
|
/**
|
|
@@ -4016,6 +4167,13 @@ interface AssetService extends Instance {
|
|
|
4016
4167
|
Name: string;
|
|
4017
4168
|
PlaceId: number;
|
|
4018
4169
|
}>;
|
|
4170
|
+
/**
|
|
4171
|
+
* - **ThreadSafety**: Unsafe
|
|
4172
|
+
* - **Tags**: Yields
|
|
4173
|
+
*
|
|
4174
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#LoadAssetAsync)
|
|
4175
|
+
*/
|
|
4176
|
+
LoadAssetAsync(this: AssetService, assetId: number): Instance | undefined;
|
|
4019
4177
|
/**
|
|
4020
4178
|
* Allows in-experience asset creation for users by prompting a publish dialog.
|
|
4021
4179
|
*
|
|
@@ -4048,8 +4206,9 @@ interface AssetService extends Instance {
|
|
|
4048
4206
|
*
|
|
4049
4207
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#SavePlaceAsync)
|
|
4050
4208
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4209
|
+
* @param requestParameters Optional dictionary that includes `SaveWithoutPublish`, a boolean indicating whether to save with publish or without publish, and `PlaceId`, the destination place ID to save over. An example usage would be: AssetService:SavePlaceAsync({PlaceId = 1, SaveWithoutPublish = true}). If PlaceId is not provided, the default behavior will save over the current original place which is calling SavePlaceAsync. If SaveWithoutPublish is not provided, the default behavior is SaveWithoutPublish=false.
|
|
4051
4210
|
*/
|
|
4052
|
-
SavePlaceAsync(this: AssetService): void;
|
|
4211
|
+
SavePlaceAsync(this: AssetService, requestParameters?: object): void;
|
|
4053
4212
|
/**
|
|
4054
4213
|
* Finds audio assets matching a variety of search criteria.
|
|
4055
4214
|
*
|
|
@@ -5902,6 +6061,12 @@ interface AudioPlayer extends Instance {
|
|
|
5902
6061
|
* @deprecated Asset
|
|
5903
6062
|
*/
|
|
5904
6063
|
AssetId: string;
|
|
6064
|
+
/**
|
|
6065
|
+
* - **ThreadSafety**: ReadSafe
|
|
6066
|
+
*
|
|
6067
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AudioContent)
|
|
6068
|
+
*/
|
|
6069
|
+
AudioContent: Content;
|
|
5905
6070
|
/**
|
|
5906
6071
|
* Controls whether `Asset` loads automatically once assigned.
|
|
5907
6072
|
*
|
|
@@ -9653,6 +9818,21 @@ interface CaptureService extends Instance {
|
|
|
9653
9818
|
*/
|
|
9654
9819
|
readonly UserCaptureSaved: RBXScriptSignal<(captureContentId: ContentId) => void>;
|
|
9655
9820
|
}
|
|
9821
|
+
/**
|
|
9822
|
+
* - **Tags**: NotCreatable, Service
|
|
9823
|
+
*
|
|
9824
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryStreamingService)
|
|
9825
|
+
*/
|
|
9826
|
+
interface ChangeHistoryStreamingService extends Instance {
|
|
9827
|
+
/**
|
|
9828
|
+
* **DO NOT USE!**
|
|
9829
|
+
*
|
|
9830
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
9831
|
+
* @hidden
|
|
9832
|
+
* @deprecated
|
|
9833
|
+
*/
|
|
9834
|
+
readonly _nominal_ChangeHistoryStreamingService: unique symbol;
|
|
9835
|
+
}
|
|
9656
9836
|
/**
|
|
9657
9837
|
* The base class for objects that change the character's appearance, such as the `BodyColors`, `CharacterMesh`, `ShirtGraphic`, `Pants` and `Shirt` objects.
|
|
9658
9838
|
*
|
|
@@ -10119,6 +10299,12 @@ interface ClickDetector extends Instance {
|
|
|
10119
10299
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ClickDetector#CursorIcon)
|
|
10120
10300
|
*/
|
|
10121
10301
|
CursorIcon: ContentId;
|
|
10302
|
+
/**
|
|
10303
|
+
* - **ThreadSafety**: ReadSafe
|
|
10304
|
+
*
|
|
10305
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ClickDetector#CursorIconContent)
|
|
10306
|
+
*/
|
|
10307
|
+
CursorIconContent: Content;
|
|
10122
10308
|
/**
|
|
10123
10309
|
* Maximum distance between a character and the `ClickDetector` or `DragDetector` for the player to be able to interact with it.
|
|
10124
10310
|
*
|
|
@@ -10182,6 +10368,12 @@ interface DragDetector extends ClickDetector {
|
|
|
10182
10368
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#ActivatedCursorIcon)
|
|
10183
10369
|
*/
|
|
10184
10370
|
ActivatedCursorIcon: ContentId;
|
|
10371
|
+
/**
|
|
10372
|
+
* - **ThreadSafety**: ReadSafe
|
|
10373
|
+
*
|
|
10374
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#ActivatedCursorIconContent)
|
|
10375
|
+
*/
|
|
10376
|
+
ActivatedCursorIconContent: Content;
|
|
10185
10377
|
/**
|
|
10186
10378
|
* Whether constraint force is applied to the object's center of mass.
|
|
10187
10379
|
*
|
|
@@ -17085,6 +17277,12 @@ interface GuiButton extends GuiObject {
|
|
|
17085
17277
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#MouseButton2Up)
|
|
17086
17278
|
*/
|
|
17087
17279
|
readonly MouseButton2Up: RBXScriptSignal<(x: number, y: number) => void>;
|
|
17280
|
+
/**
|
|
17281
|
+
* - **ThreadSafety**: Unsafe
|
|
17282
|
+
*
|
|
17283
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#SecondaryActivated)
|
|
17284
|
+
*/
|
|
17285
|
+
readonly SecondaryActivated: RBXScriptSignal<(inputObject: InputObject) => void>;
|
|
17088
17286
|
}
|
|
17089
17287
|
/**
|
|
17090
17288
|
* A 2D user interface element that displays an interactive image.
|
|
@@ -18541,7 +18739,7 @@ interface VideoFrame extends GuiObject {
|
|
|
18541
18739
|
*/
|
|
18542
18740
|
Volume: number;
|
|
18543
18741
|
/**
|
|
18544
|
-
* Sets `VideoFrame.Playing` to false
|
|
18742
|
+
* Sets `VideoFrame.Playing` to `false`, pausing playback if the `VideoFrame.Video` is playing.
|
|
18545
18743
|
*
|
|
18546
18744
|
* - **ThreadSafety**: Unsafe
|
|
18547
18745
|
*
|
|
@@ -18550,7 +18748,7 @@ interface VideoFrame extends GuiObject {
|
|
|
18550
18748
|
*/
|
|
18551
18749
|
Pause(this: VideoFrame): void;
|
|
18552
18750
|
/**
|
|
18553
|
-
* Sets `VideoFrame.Playing` to true
|
|
18751
|
+
* Sets `VideoFrame.Playing` to `true`, playing the `VideoFrame.Video` from the current `VideoFrame.TimePosition`.
|
|
18554
18752
|
*
|
|
18555
18753
|
* - **ThreadSafety**: Unsafe
|
|
18556
18754
|
*
|
|
@@ -20364,6 +20562,8 @@ interface GuiService extends Instance {
|
|
|
20364
20562
|
*/
|
|
20365
20563
|
TouchControlsEnabled: boolean;
|
|
20366
20564
|
/**
|
|
20565
|
+
* Read-only property which represents the physical rendering size of the viewport.
|
|
20566
|
+
*
|
|
20367
20567
|
* - **ThreadSafety**: ReadSafe
|
|
20368
20568
|
* - **Tags**: NotReplicated
|
|
20369
20569
|
*
|
|
@@ -23754,6 +23954,12 @@ interface InputBinding extends Instance {
|
|
|
23754
23954
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ReleasedThreshold)
|
|
23755
23955
|
*/
|
|
23756
23956
|
ReleasedThreshold: number;
|
|
23957
|
+
/**
|
|
23958
|
+
* - **ThreadSafety**: ReadSafe
|
|
23959
|
+
*
|
|
23960
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ResponseCurve)
|
|
23961
|
+
*/
|
|
23962
|
+
ResponseCurve: number;
|
|
23757
23963
|
/**
|
|
23758
23964
|
* Specifies an alternate `KeyCode` for dispatching directionally "right" inputs to the parent `InputAction`.
|
|
23759
23965
|
*
|
|
@@ -27073,6 +27279,12 @@ interface Mouse extends Instance {
|
|
|
27073
27279
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Mouse#Icon)
|
|
27074
27280
|
*/
|
|
27075
27281
|
Icon: ContentId;
|
|
27282
|
+
/**
|
|
27283
|
+
* - **ThreadSafety**: ReadSafe
|
|
27284
|
+
*
|
|
27285
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Mouse#IconContent)
|
|
27286
|
+
*/
|
|
27287
|
+
IconContent: Content;
|
|
27076
27288
|
/**
|
|
27077
27289
|
* A `CFrame` positioned at the `Workspace.CurrentCamera` and oriented toward the mouse's 3D position.
|
|
27078
27290
|
*
|
|
@@ -30433,6 +30645,12 @@ interface BackpackItem extends Model {
|
|
|
30433
30645
|
* @deprecated
|
|
30434
30646
|
*/
|
|
30435
30647
|
readonly _nominal_BackpackItem: unique symbol;
|
|
30648
|
+
/**
|
|
30649
|
+
* - **ThreadSafety**: ReadSafe
|
|
30650
|
+
*
|
|
30651
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BackpackItem#TextureContent)
|
|
30652
|
+
*/
|
|
30653
|
+
TextureContent: Content;
|
|
30436
30654
|
/**
|
|
30437
30655
|
* The texture icon that is displayed for a tool in the player's backpack.
|
|
30438
30656
|
*
|
|
@@ -34870,6 +35088,45 @@ interface ReflectionService extends Instance {
|
|
|
34870
35088
|
*/
|
|
34871
35089
|
GetPropertiesOfClass(this: ReflectionService, className: string, filter?: object): Array<unknown>;
|
|
34872
35090
|
}
|
|
35091
|
+
/**
|
|
35092
|
+
* - **Tags**: NotCreatable, Service
|
|
35093
|
+
*
|
|
35094
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService)
|
|
35095
|
+
*/
|
|
35096
|
+
interface RemoteCommandService extends Instance {
|
|
35097
|
+
/**
|
|
35098
|
+
* **DO NOT USE!**
|
|
35099
|
+
*
|
|
35100
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
35101
|
+
* @hidden
|
|
35102
|
+
* @deprecated
|
|
35103
|
+
*/
|
|
35104
|
+
readonly _nominal_RemoteCommandService: unique symbol;
|
|
35105
|
+
/**
|
|
35106
|
+
* - **ThreadSafety**: Unsafe
|
|
35107
|
+
*
|
|
35108
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService#GetExecutingPlayer)
|
|
35109
|
+
*/
|
|
35110
|
+
GetExecutingPlayer(this: RemoteCommandService): Player;
|
|
35111
|
+
/**
|
|
35112
|
+
* - **ThreadSafety**: Unsafe
|
|
35113
|
+
*
|
|
35114
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService#GetReceivedUpdateSignal)
|
|
35115
|
+
*/
|
|
35116
|
+
GetReceivedUpdateSignal(this: RemoteCommandService): RBXScriptSignal;
|
|
35117
|
+
/**
|
|
35118
|
+
* - **ThreadSafety**: Unsafe
|
|
35119
|
+
*
|
|
35120
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService#GetStoppingSignal)
|
|
35121
|
+
*/
|
|
35122
|
+
GetStoppingSignal(this: RemoteCommandService): RBXScriptSignal;
|
|
35123
|
+
/**
|
|
35124
|
+
* - **ThreadSafety**: Unsafe
|
|
35125
|
+
*
|
|
35126
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService#SendUpdate)
|
|
35127
|
+
*/
|
|
35128
|
+
SendUpdate(this: RemoteCommandService, args: unknown): void;
|
|
35129
|
+
}
|
|
34873
35130
|
/**
|
|
34874
35131
|
* - **Tags**: NotCreatable, Service
|
|
34875
35132
|
*
|
|
@@ -36929,6 +37186,12 @@ interface Sound extends Instance {
|
|
|
36929
37186
|
* @deprecated
|
|
36930
37187
|
*/
|
|
36931
37188
|
readonly _nominal_Sound: unique symbol;
|
|
37189
|
+
/**
|
|
37190
|
+
* - **ThreadSafety**: ReadSafe
|
|
37191
|
+
*
|
|
37192
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#AudioContent)
|
|
37193
|
+
*/
|
|
37194
|
+
AudioContent: Content;
|
|
36932
37195
|
/**
|
|
36933
37196
|
* **Deprecated:** This property has deprecated in favor of `Sound.RollOffMinDistance` and `Sound.RollOffMaxDistance` which should be used instead in new work.
|
|
36934
37197
|
*
|
|
@@ -37817,6 +38080,21 @@ interface SoundService extends Instance {
|
|
|
37817
38080
|
SetListener(this: SoundService, listenerType: CastsToEnum<Enum.ListenerType.ObjectCFrame>, basePart: BasePart): void;
|
|
37818
38081
|
SetListener(this: SoundService, listenerType: CastsToEnum<Enum.ListenerType.ObjectPosition>, basePart: BasePart): void;
|
|
37819
38082
|
}
|
|
38083
|
+
/**
|
|
38084
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
38085
|
+
*
|
|
38086
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundShimService)
|
|
38087
|
+
*/
|
|
38088
|
+
interface SoundShimService extends Instance {
|
|
38089
|
+
/**
|
|
38090
|
+
* **DO NOT USE!**
|
|
38091
|
+
*
|
|
38092
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
38093
|
+
* @hidden
|
|
38094
|
+
* @deprecated
|
|
38095
|
+
*/
|
|
38096
|
+
readonly _nominal_SoundShimService: unique symbol;
|
|
38097
|
+
}
|
|
37820
38098
|
/**
|
|
37821
38099
|
* A particle emitter with the visual aesthetic of sparkles.
|
|
37822
38100
|
*
|
|
@@ -38261,6 +38539,15 @@ interface Stats extends Instance {
|
|
|
38261
38539
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Stats#InstanceCount)
|
|
38262
38540
|
*/
|
|
38263
38541
|
readonly InstanceCount: number;
|
|
38542
|
+
/**
|
|
38543
|
+
* An indication of whether memory tracking is enabled. This is guaranteed to be unchanged until the next time the Client is started.
|
|
38544
|
+
*
|
|
38545
|
+
* - **ThreadSafety**: ReadSafe
|
|
38546
|
+
* - **Tags**: NotReplicated
|
|
38547
|
+
*
|
|
38548
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Stats#MemoryTrackingEnabled)
|
|
38549
|
+
*/
|
|
38550
|
+
readonly MemoryTrackingEnabled: boolean;
|
|
38264
38551
|
/**
|
|
38265
38552
|
* A measurement of how many physically simulated components are currently moving in the game world.
|
|
38266
38553
|
*
|
|
@@ -38424,6 +38711,8 @@ interface Stats extends Instance {
|
|
|
38424
38711
|
*/
|
|
38425
38712
|
GetMemoryCategoryNames(this: Stats): Array<unknown>;
|
|
38426
38713
|
/**
|
|
38714
|
+
* Returns the number of megabytes that are being consumed by all available categories, or an empty array if `MemoryTrackingEnabled` is false.
|
|
38715
|
+
*
|
|
38427
38716
|
* - **ThreadSafety**: Unsafe
|
|
38428
38717
|
*
|
|
38429
38718
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Stats#GetMemoryUsageMbAllCategories)
|
|
@@ -38431,7 +38720,7 @@ interface Stats extends Instance {
|
|
|
38431
38720
|
*/
|
|
38432
38721
|
GetMemoryUsageMbAllCategories(this: Stats): Array<unknown>;
|
|
38433
38722
|
/**
|
|
38434
|
-
* Returns the number of megabytes that are being consumed in the specified `DeveloperMemoryTag` category.
|
|
38723
|
+
* Returns the number of megabytes that are being consumed in the specified `DeveloperMemoryTag` category, or 0 if `MemoryTrackingEnabled` is false.
|
|
38435
38724
|
*
|
|
38436
38725
|
* - **ThreadSafety**: Unsafe
|
|
38437
38726
|
*
|
|
@@ -38441,7 +38730,7 @@ interface Stats extends Instance {
|
|
|
38441
38730
|
*/
|
|
38442
38731
|
GetMemoryUsageMbForTag(this: Stats, tag: CastsToEnum<Enum.DeveloperMemoryTag>): number;
|
|
38443
38732
|
/**
|
|
38444
|
-
* Returns the total amount of memory being consumed by the current game session, in megabytes.
|
|
38733
|
+
* Returns the total amount of memory being consumed by the current game session, in megabytes, or 0 if `MemoryTrackingEnabled` is false.
|
|
38445
38734
|
*
|
|
38446
38735
|
* - **ThreadSafety**: Unsafe
|
|
38447
38736
|
*
|
|
@@ -41138,6 +41427,32 @@ interface TextFilterTranslatedResult extends Instance {
|
|
|
41138
41427
|
*/
|
|
41139
41428
|
GetTranslations(this: TextFilterTranslatedResult): object;
|
|
41140
41429
|
}
|
|
41430
|
+
/**
|
|
41431
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator)
|
|
41432
|
+
*/
|
|
41433
|
+
interface TextGenerator extends Instance {
|
|
41434
|
+
/**
|
|
41435
|
+
* **DO NOT USE!**
|
|
41436
|
+
*
|
|
41437
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
41438
|
+
* @hidden
|
|
41439
|
+
* @deprecated
|
|
41440
|
+
*/
|
|
41441
|
+
readonly _nominal_TextGenerator: unique symbol;
|
|
41442
|
+
/**
|
|
41443
|
+
* - **ThreadSafety**: ReadSafe
|
|
41444
|
+
*
|
|
41445
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#SystemPrompt)
|
|
41446
|
+
*/
|
|
41447
|
+
SystemPrompt: string;
|
|
41448
|
+
/**
|
|
41449
|
+
* - **ThreadSafety**: Unsafe
|
|
41450
|
+
* - **Tags**: Yields
|
|
41451
|
+
*
|
|
41452
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#GenerateTextAsync)
|
|
41453
|
+
*/
|
|
41454
|
+
GenerateTextAsync(this: TextGenerator, request: object): object;
|
|
41455
|
+
}
|
|
41141
41456
|
/**
|
|
41142
41457
|
* The TextService is a service internally responsible for handling the display of text in the game.
|
|
41143
41458
|
*
|
|
@@ -42062,6 +42377,12 @@ interface UIDragDetector extends UIComponent {
|
|
|
42062
42377
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#ActivatedCursorIcon)
|
|
42063
42378
|
*/
|
|
42064
42379
|
ActivatedCursorIcon: ContentId;
|
|
42380
|
+
/**
|
|
42381
|
+
* - **ThreadSafety**: ReadSafe
|
|
42382
|
+
*
|
|
42383
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#ActivatedCursorIconContent)
|
|
42384
|
+
*/
|
|
42385
|
+
ActivatedCursorIconContent: Content;
|
|
42065
42386
|
/**
|
|
42066
42387
|
* Determines bounding behavior of the dragged UI object when the detector's `BoundingUI` is set.
|
|
42067
42388
|
*
|
|
@@ -42086,6 +42407,12 @@ interface UIDragDetector extends UIComponent {
|
|
|
42086
42407
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#CursorIcon)
|
|
42087
42408
|
*/
|
|
42088
42409
|
CursorIcon: ContentId;
|
|
42410
|
+
/**
|
|
42411
|
+
* - **ThreadSafety**: ReadSafe
|
|
42412
|
+
*
|
|
42413
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#CursorIconContent)
|
|
42414
|
+
*/
|
|
42415
|
+
CursorIconContent: Content;
|
|
42089
42416
|
/**
|
|
42090
42417
|
* The drag axis for the `UIDragDetector` instance when `DragStyle` is set to `UIDragDetectorDragStyle.TranslateLine`.
|
|
42091
42418
|
*
|
|
@@ -43311,6 +43638,12 @@ interface UserInputService extends Instance {
|
|
|
43311
43638
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#MouseIcon)
|
|
43312
43639
|
*/
|
|
43313
43640
|
MouseIcon: ContentId;
|
|
43641
|
+
/**
|
|
43642
|
+
* - **ThreadSafety**: ReadSafe
|
|
43643
|
+
*
|
|
43644
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#MouseIconContent)
|
|
43645
|
+
*/
|
|
43646
|
+
MouseIconContent: Content;
|
|
43314
43647
|
/**
|
|
43315
43648
|
* Determines whether the mouse icon is visible.
|
|
43316
43649
|
*
|
|
@@ -44713,6 +45046,12 @@ interface VideoPlayer extends Instance {
|
|
|
44713
45046
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#TimePosition)
|
|
44714
45047
|
*/
|
|
44715
45048
|
TimePosition: number;
|
|
45049
|
+
/**
|
|
45050
|
+
* - **ThreadSafety**: ReadSafe
|
|
45051
|
+
*
|
|
45052
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#VideoContent)
|
|
45053
|
+
*/
|
|
45054
|
+
VideoContent: Content;
|
|
44716
45055
|
/**
|
|
44717
45056
|
* - **ThreadSafety**: ReadSafe
|
|
44718
45057
|
*
|
|
@@ -33,6 +33,7 @@ interface Services {
|
|
|
33
33
|
CalloutService: CalloutService;
|
|
34
34
|
CaptureService: CaptureService;
|
|
35
35
|
ChangeHistoryService: ChangeHistoryService;
|
|
36
|
+
ChangeHistoryStreamingService: ChangeHistoryStreamingService;
|
|
36
37
|
Chat: Chat;
|
|
37
38
|
ChatbotUIService: ChatbotUIService;
|
|
38
39
|
CloudCRUDService: CloudCRUDService;
|
|
@@ -150,6 +151,7 @@ interface Services {
|
|
|
150
151
|
PublishService: PublishService;
|
|
151
152
|
RecommendationService: RecommendationService;
|
|
152
153
|
ReflectionService: ReflectionService;
|
|
154
|
+
RemoteCommandService: RemoteCommandService;
|
|
153
155
|
RemoteCursorService: RemoteCursorService;
|
|
154
156
|
RemoteDebuggerServer: RemoteDebuggerServer;
|
|
155
157
|
RenderSettings: RenderSettings;
|
|
@@ -186,6 +188,7 @@ interface Services {
|
|
|
186
188
|
SnippetService: SnippetService;
|
|
187
189
|
SocialService: SocialService;
|
|
188
190
|
SoundService: SoundService;
|
|
191
|
+
SoundShimService: SoundShimService;
|
|
189
192
|
StarterGui: StarterGui;
|
|
190
193
|
StarterPack: StarterPack;
|
|
191
194
|
StarterPlayer: StarterPlayer;
|
|
@@ -497,6 +500,7 @@ interface CreatableInstances {
|
|
|
497
500
|
TextChannel: TextChannel;
|
|
498
501
|
TextChatCommand: TextChatCommand;
|
|
499
502
|
TextChatMessageProperties: TextChatMessageProperties;
|
|
503
|
+
TextGenerator: TextGenerator;
|
|
500
504
|
TextLabel: TextLabel;
|
|
501
505
|
Texture: Texture;
|
|
502
506
|
Tool: Tool;
|
|
@@ -754,6 +758,7 @@ interface Objects extends Instances {
|
|
|
754
758
|
ConfigSnapshot: ConfigSnapshot;
|
|
755
759
|
EditableImage: EditableImage;
|
|
756
760
|
EditableMesh: EditableMesh;
|
|
761
|
+
ExecutedRemoteCommand: ExecutedRemoteCommand;
|
|
757
762
|
MLSession: MLSession;
|
|
758
763
|
Object: RBXObject;
|
|
759
764
|
ScreenshotCapture: ScreenshotCapture;
|
|
@@ -876,6 +881,21 @@ interface EditableMesh extends RBXObject {
|
|
|
876
881
|
*/
|
|
877
882
|
readonly _nominal_EditableMesh: unique symbol;
|
|
878
883
|
}
|
|
884
|
+
/**
|
|
885
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
886
|
+
*
|
|
887
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExecutedRemoteCommand)
|
|
888
|
+
*/
|
|
889
|
+
interface ExecutedRemoteCommand extends RBXObject {
|
|
890
|
+
/**
|
|
891
|
+
* **DO NOT USE!**
|
|
892
|
+
*
|
|
893
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
894
|
+
* @hidden
|
|
895
|
+
* @deprecated
|
|
896
|
+
*/
|
|
897
|
+
readonly _nominal_ExecutedRemoteCommand: unique symbol;
|
|
898
|
+
}
|
|
879
899
|
/**
|
|
880
900
|
* `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
881
901
|
*
|
|
@@ -2974,6 +2994,21 @@ interface ChangeHistoryService extends Instance {
|
|
|
2974
2994
|
*/
|
|
2975
2995
|
readonly OnUndo: RBXScriptSignal<(waypoint: string) => void>;
|
|
2976
2996
|
}
|
|
2997
|
+
/**
|
|
2998
|
+
* - **Tags**: NotCreatable, Service
|
|
2999
|
+
*
|
|
3000
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryStreamingService)
|
|
3001
|
+
*/
|
|
3002
|
+
interface ChangeHistoryStreamingService extends Instance {
|
|
3003
|
+
/**
|
|
3004
|
+
* **DO NOT USE!**
|
|
3005
|
+
*
|
|
3006
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3007
|
+
* @hidden
|
|
3008
|
+
* @deprecated
|
|
3009
|
+
*/
|
|
3010
|
+
readonly _nominal_ChangeHistoryStreamingService: unique symbol;
|
|
3011
|
+
}
|
|
2977
3012
|
/**
|
|
2978
3013
|
* The base class for objects that change the character's appearance, such as the `BodyColors`, `CharacterMesh`, `ShirtGraphic`, `Pants` and `Shirt` objects.
|
|
2979
3014
|
*
|
|
@@ -10822,6 +10857,21 @@ interface ReflectionService extends Instance {
|
|
|
10822
10857
|
*/
|
|
10823
10858
|
readonly _nominal_ReflectionService: unique symbol;
|
|
10824
10859
|
}
|
|
10860
|
+
/**
|
|
10861
|
+
* - **Tags**: NotCreatable, Service
|
|
10862
|
+
*
|
|
10863
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService)
|
|
10864
|
+
*/
|
|
10865
|
+
interface RemoteCommandService extends Instance {
|
|
10866
|
+
/**
|
|
10867
|
+
* **DO NOT USE!**
|
|
10868
|
+
*
|
|
10869
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
10870
|
+
* @hidden
|
|
10871
|
+
* @deprecated
|
|
10872
|
+
*/
|
|
10873
|
+
readonly _nominal_RemoteCommandService: unique symbol;
|
|
10874
|
+
}
|
|
10825
10875
|
/**
|
|
10826
10876
|
* - **Tags**: NotCreatable, Service
|
|
10827
10877
|
*
|
|
@@ -12496,6 +12546,21 @@ interface SoundService extends Instance {
|
|
|
12496
12546
|
*/
|
|
12497
12547
|
OpenDirectionalCurveEditor(this: SoundService, selectedCurveObjects: Array<Instance>): void;
|
|
12498
12548
|
}
|
|
12549
|
+
/**
|
|
12550
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
12551
|
+
*
|
|
12552
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundShimService)
|
|
12553
|
+
*/
|
|
12554
|
+
interface SoundShimService extends Instance {
|
|
12555
|
+
/**
|
|
12556
|
+
* **DO NOT USE!**
|
|
12557
|
+
*
|
|
12558
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
12559
|
+
* @hidden
|
|
12560
|
+
* @deprecated
|
|
12561
|
+
*/
|
|
12562
|
+
readonly _nominal_SoundShimService: unique symbol;
|
|
12563
|
+
}
|
|
12499
12564
|
/**
|
|
12500
12565
|
* A particle emitter with the visual aesthetic of sparkles.
|
|
12501
12566
|
*
|
|
@@ -13862,6 +13927,19 @@ interface TextFilterTranslatedResult extends Instance {
|
|
|
13862
13927
|
*/
|
|
13863
13928
|
readonly _nominal_TextFilterTranslatedResult: unique symbol;
|
|
13864
13929
|
}
|
|
13930
|
+
/**
|
|
13931
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator)
|
|
13932
|
+
*/
|
|
13933
|
+
interface TextGenerator extends Instance {
|
|
13934
|
+
/**
|
|
13935
|
+
* **DO NOT USE!**
|
|
13936
|
+
*
|
|
13937
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
13938
|
+
* @hidden
|
|
13939
|
+
* @deprecated
|
|
13940
|
+
*/
|
|
13941
|
+
readonly _nominal_TextGenerator: unique symbol;
|
|
13942
|
+
}
|
|
13865
13943
|
/**
|
|
13866
13944
|
* The TextService is a service internally responsible for handling the display of text in the game.
|
|
13867
13945
|
*
|
|
@@ -579,7 +579,7 @@ declare namespace Enum {
|
|
|
579
579
|
*/
|
|
580
580
|
export namespace AdEventType {
|
|
581
581
|
/**
|
|
582
|
-
* The event is fired when a click-to-play video
|
|
582
|
+
* The event is fired when a click-to-play video ad is being served. This can be used to communicate and promote the reward to users through the UI or signage.
|
|
583
583
|
*
|
|
584
584
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType#RewardedAdLoaded)
|
|
585
585
|
*/
|
|
@@ -590,7 +590,7 @@ declare namespace Enum {
|
|
|
590
590
|
}
|
|
591
591
|
export const RewardedAdLoaded: RewardedAdLoaded;
|
|
592
592
|
/**
|
|
593
|
-
* The event is fired when a user has watched the click-to-play video for a certain time. This can be used to grant the player a reward such as an in-game item or in-game currency. The RewardedAdGrant enum will only be triggered once per ad rotation.
|
|
593
|
+
* The event is fired when a user has watched the click-to-play video ad for a certain time. This can be used to grant the player a reward such as an in-game item or in-game currency. The `RewardedAdGrant` enum will only be triggered once per ad rotation.
|
|
594
594
|
*
|
|
595
595
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType#RewardedAdGrant)
|
|
596
596
|
*/
|
|
@@ -601,7 +601,7 @@ declare namespace Enum {
|
|
|
601
601
|
}
|
|
602
602
|
export const RewardedAdGrant: RewardedAdGrant;
|
|
603
603
|
/**
|
|
604
|
-
* The event is fired when a click-to-play video
|
|
604
|
+
* The event is fired when a click-to-play video ad is rotated out. This can be used to remove any UI or signage that is promoting the reward.
|
|
605
605
|
*
|
|
606
606
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType#RewardedAdUnloaded)
|
|
607
607
|
*/
|
|
@@ -10077,10 +10077,14 @@ declare namespace Enum {
|
|
|
10077
10077
|
}
|
|
10078
10078
|
export type DialogTone = DialogTone.Neutral | DialogTone.Friendly | DialogTone.Enemy;
|
|
10079
10079
|
/**
|
|
10080
|
+
* This enum is used with `GuiService.ViewportDisplaySize` to indicate the internally-categorized rendering size of the viewport.
|
|
10081
|
+
*
|
|
10080
10082
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize)
|
|
10081
10083
|
*/
|
|
10082
10084
|
export namespace DisplaySize {
|
|
10083
10085
|
/**
|
|
10086
|
+
* Viewport is categorized as small. Applies to most tablet/mobile/handheld devices.
|
|
10087
|
+
*
|
|
10084
10088
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Small)
|
|
10085
10089
|
*/
|
|
10086
10090
|
export interface Small extends globalThis.EnumItem {
|
|
@@ -10090,6 +10094,8 @@ declare namespace Enum {
|
|
|
10090
10094
|
}
|
|
10091
10095
|
export const Small: Small;
|
|
10092
10096
|
/**
|
|
10097
|
+
* Viewport is categorized as medium. Applies to most laptops and monitors.
|
|
10098
|
+
*
|
|
10093
10099
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Medium)
|
|
10094
10100
|
*/
|
|
10095
10101
|
export interface Medium extends globalThis.EnumItem {
|
|
@@ -10099,6 +10105,8 @@ declare namespace Enum {
|
|
|
10099
10105
|
}
|
|
10100
10106
|
export const Medium: Medium;
|
|
10101
10107
|
/**
|
|
10108
|
+
* Viewport is categorized as large. Applies to most TVs or larger.
|
|
10109
|
+
*
|
|
10102
10110
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Large)
|
|
10103
10111
|
*/
|
|
10104
10112
|
export interface Large extends globalThis.EnumItem {
|
|
@@ -11453,6 +11461,33 @@ declare namespace Enum {
|
|
|
11453
11461
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FacsActionUnit | undefined;
|
|
11454
11462
|
}
|
|
11455
11463
|
export type FacsActionUnit = FacsActionUnit.ChinRaiserUpperLip | FacsActionUnit.ChinRaiser | FacsActionUnit.FlatPucker | FacsActionUnit.Funneler | FacsActionUnit.LowerLipSuck | FacsActionUnit.LipPresser | FacsActionUnit.LipsTogether | FacsActionUnit.MouthLeft | FacsActionUnit.MouthRight | FacsActionUnit.Pucker | FacsActionUnit.UpperLipSuck | FacsActionUnit.LeftCheekPuff | FacsActionUnit.LeftDimpler | FacsActionUnit.LeftLipCornerDown | FacsActionUnit.LeftLowerLipDepressor | FacsActionUnit.LeftLipCornerPuller | FacsActionUnit.LeftLipStretcher | FacsActionUnit.LeftUpperLipRaiser | FacsActionUnit.RightCheekPuff | FacsActionUnit.RightDimpler | FacsActionUnit.RightLipCornerDown | FacsActionUnit.RightLowerLipDepressor | FacsActionUnit.RightLipCornerPuller | FacsActionUnit.RightLipStretcher | FacsActionUnit.RightUpperLipRaiser | FacsActionUnit.JawDrop | FacsActionUnit.JawLeft | FacsActionUnit.JawRight | FacsActionUnit.Corrugator | FacsActionUnit.LeftBrowLowerer | FacsActionUnit.LeftOuterBrowRaiser | FacsActionUnit.LeftNoseWrinkler | FacsActionUnit.LeftInnerBrowRaiser | FacsActionUnit.RightBrowLowerer | FacsActionUnit.RightOuterBrowRaiser | FacsActionUnit.RightInnerBrowRaiser | FacsActionUnit.RightNoseWrinkler | FacsActionUnit.EyesLookDown | FacsActionUnit.EyesLookLeft | FacsActionUnit.EyesLookUp | FacsActionUnit.EyesLookRight | FacsActionUnit.LeftCheekRaiser | FacsActionUnit.LeftEyeUpperLidRaiser | FacsActionUnit.LeftEyeClosed | FacsActionUnit.RightCheekRaiser | FacsActionUnit.RightEyeUpperLidRaiser | FacsActionUnit.RightEyeClosed | FacsActionUnit.TongueDown | FacsActionUnit.TongueOut | FacsActionUnit.TongueUp;
|
|
11464
|
+
/**
|
|
11465
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FeatureRestrictionAbuseVector)
|
|
11466
|
+
*/
|
|
11467
|
+
export namespace FeatureRestrictionAbuseVector {
|
|
11468
|
+
/**
|
|
11469
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FeatureRestrictionAbuseVector#ExperienceChat)
|
|
11470
|
+
*/
|
|
11471
|
+
export interface ExperienceChat extends globalThis.EnumItem {
|
|
11472
|
+
Name: "ExperienceChat";
|
|
11473
|
+
Value: 0;
|
|
11474
|
+
EnumType: typeof globalThis.Enum.FeatureRestrictionAbuseVector;
|
|
11475
|
+
}
|
|
11476
|
+
export const ExperienceChat: ExperienceChat;
|
|
11477
|
+
/**
|
|
11478
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FeatureRestrictionAbuseVector#Communication)
|
|
11479
|
+
*/
|
|
11480
|
+
export interface Communication extends globalThis.EnumItem {
|
|
11481
|
+
Name: "Communication";
|
|
11482
|
+
Value: 1;
|
|
11483
|
+
EnumType: typeof globalThis.Enum.FeatureRestrictionAbuseVector;
|
|
11484
|
+
}
|
|
11485
|
+
export const Communication: Communication;
|
|
11486
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.FeatureRestrictionAbuseVector>;
|
|
11487
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FeatureRestrictionAbuseVector | undefined;
|
|
11488
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FeatureRestrictionAbuseVector | undefined;
|
|
11489
|
+
}
|
|
11490
|
+
export type FeatureRestrictionAbuseVector = FeatureRestrictionAbuseVector.ExperienceChat | FeatureRestrictionAbuseVector.Communication;
|
|
11456
11491
|
/**
|
|
11457
11492
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FieldOfViewMode)
|
|
11458
11493
|
*/
|