@rbxts/types 1.0.840 → 1.0.842
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 +406 -86
- package/include/generated/PluginSecurity.d.ts +70 -4
- package/include/generated/enums.d.ts +241 -45
- package/package.json +1 -1
|
@@ -100,6 +100,7 @@ interface Services {
|
|
|
100
100
|
LSPFileSyncService: LSPFileSyncService;
|
|
101
101
|
LuauScriptAnalyzerService: LuauScriptAnalyzerService;
|
|
102
102
|
MarketplaceService: MarketplaceService;
|
|
103
|
+
MatchmakingService: MatchmakingService;
|
|
103
104
|
MaterialGenerationService: MaterialGenerationService;
|
|
104
105
|
MaterialService: MaterialService;
|
|
105
106
|
MemoryStoreService: MemoryStoreService;
|
|
@@ -205,6 +206,7 @@ interface Services {
|
|
|
205
206
|
VoiceChatService: VoiceChatService;
|
|
206
207
|
VRService: VRService;
|
|
207
208
|
VRStatusService: VRStatusService;
|
|
209
|
+
WebSocketService: WebSocketService;
|
|
208
210
|
WebViewService: WebViewService;
|
|
209
211
|
Workspace: Workspace;
|
|
210
212
|
}
|
|
@@ -249,6 +251,7 @@ interface CreatableInstances {
|
|
|
249
251
|
AudioPlayer: AudioPlayer;
|
|
250
252
|
AudioReverb: AudioReverb;
|
|
251
253
|
AudioSearchParams: AudioSearchParams;
|
|
254
|
+
AudioTextToSpeech: AudioTextToSpeech;
|
|
252
255
|
AuroraScript: AuroraScript;
|
|
253
256
|
Backpack: Backpack;
|
|
254
257
|
BallSocketConstraint: BallSocketConstraint;
|
|
@@ -662,6 +665,7 @@ interface Instances extends Services, CreatableInstances {
|
|
|
662
665
|
UserGameSettings: UserGameSettings;
|
|
663
666
|
UserSettings: UserSettings;
|
|
664
667
|
ValueBase: ValueBase;
|
|
668
|
+
WebSocketClient: WebSocketClient;
|
|
665
669
|
WorldRoot: WorldRoot;
|
|
666
670
|
}
|
|
667
671
|
interface Objects extends Instances {
|
|
@@ -1442,7 +1446,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1442
1446
|
Triangulate(this: EditableMesh): void;
|
|
1443
1447
|
}
|
|
1444
1448
|
/**
|
|
1445
|
-
* Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1449
|
+
* `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1446
1450
|
*
|
|
1447
1451
|
* - **Tags**: NotCreatable, NotBrowsable
|
|
1448
1452
|
*
|
|
@@ -1488,7 +1492,7 @@ interface Instance extends RBXObject {
|
|
|
1488
1492
|
* - **ThreadSafety**: Unsafe
|
|
1489
1493
|
*
|
|
1490
1494
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#AddTag)
|
|
1491
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1495
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1492
1496
|
* @param tag
|
|
1493
1497
|
*/
|
|
1494
1498
|
AddTag(this: Instance, tag: string): void;
|
|
@@ -1498,7 +1502,7 @@ interface Instance extends RBXObject {
|
|
|
1498
1502
|
* - **ThreadSafety**: Unsafe
|
|
1499
1503
|
*
|
|
1500
1504
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#ClearAllChildren)
|
|
1501
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1505
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1502
1506
|
*/
|
|
1503
1507
|
ClearAllChildren(this: Instance): void;
|
|
1504
1508
|
/**
|
|
@@ -1507,7 +1511,7 @@ interface Instance extends RBXObject {
|
|
|
1507
1511
|
* - **ThreadSafety**: Unsafe
|
|
1508
1512
|
*
|
|
1509
1513
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#Clone)
|
|
1510
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1514
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1511
1515
|
*/
|
|
1512
1516
|
Clone<T extends Instance>(this: T): T;
|
|
1513
1517
|
/**
|
|
@@ -1516,7 +1520,7 @@ interface Instance extends RBXObject {
|
|
|
1516
1520
|
* - **ThreadSafety**: Unsafe
|
|
1517
1521
|
*
|
|
1518
1522
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#Destroy)
|
|
1519
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1523
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1520
1524
|
*/
|
|
1521
1525
|
Destroy(this: Instance): void;
|
|
1522
1526
|
/**
|
|
@@ -1525,7 +1529,7 @@ interface Instance extends RBXObject {
|
|
|
1525
1529
|
* - **ThreadSafety**: Safe
|
|
1526
1530
|
*
|
|
1527
1531
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstAncestor)
|
|
1528
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1532
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1529
1533
|
* @param name The `Instance.Name` to be looked for.
|
|
1530
1534
|
* @returns The `Instance` found.
|
|
1531
1535
|
*/
|
|
@@ -1536,7 +1540,7 @@ interface Instance extends RBXObject {
|
|
|
1536
1540
|
* - **ThreadSafety**: Safe
|
|
1537
1541
|
*
|
|
1538
1542
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstAncestorOfClass)
|
|
1539
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1543
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1540
1544
|
* @param className The `Object.ClassName` to be looked for.
|
|
1541
1545
|
* @returns The `Instance` found.
|
|
1542
1546
|
*/
|
|
@@ -1547,7 +1551,7 @@ interface Instance extends RBXObject {
|
|
|
1547
1551
|
* - **ThreadSafety**: Safe
|
|
1548
1552
|
*
|
|
1549
1553
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstAncestorWhichIsA)
|
|
1550
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1554
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1551
1555
|
* @param className The `Object.ClassName` to be looked for.
|
|
1552
1556
|
* @returns The `Instance` found.
|
|
1553
1557
|
*/
|
|
@@ -1558,19 +1562,19 @@ interface Instance extends RBXObject {
|
|
|
1558
1562
|
* - **ThreadSafety**: Safe
|
|
1559
1563
|
*
|
|
1560
1564
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstChild)
|
|
1561
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1565
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1562
1566
|
* @param name The `Instance.Name` to be searched for.
|
|
1563
1567
|
* @param recursive Whether or not the search should be conducted recursively.
|
|
1564
1568
|
* @returns The `Instance` found.
|
|
1565
1569
|
*/
|
|
1566
1570
|
FindFirstChild(this: Instance, childName: string | number, recursive?: boolean): Instance | undefined;
|
|
1567
1571
|
/**
|
|
1568
|
-
* Returns the first child of the `Instance` whose `ClassName` is equal to the given
|
|
1572
|
+
* Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
|
|
1569
1573
|
*
|
|
1570
1574
|
* - **ThreadSafety**: Safe
|
|
1571
1575
|
*
|
|
1572
1576
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstChildOfClass)
|
|
1573
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1577
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1574
1578
|
* @param className The `Object.ClassName` to be looked for.
|
|
1575
1579
|
* @returns The `Instance` found.
|
|
1576
1580
|
*/
|
|
@@ -1581,7 +1585,7 @@ interface Instance extends RBXObject {
|
|
|
1581
1585
|
* - **ThreadSafety**: Safe
|
|
1582
1586
|
*
|
|
1583
1587
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstChildWhichIsA)
|
|
1584
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1588
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1585
1589
|
* @param className The `Object.ClassName` to be searched for.
|
|
1586
1590
|
* @param recursive Whether or not the search should be conducted recursively.
|
|
1587
1591
|
* @returns The `Instance` found.
|
|
@@ -1593,7 +1597,7 @@ interface Instance extends RBXObject {
|
|
|
1593
1597
|
* - **ThreadSafety**: Safe
|
|
1594
1598
|
*
|
|
1595
1599
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstDescendant)
|
|
1596
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1600
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1597
1601
|
* @param name The `Instance.Name` to search for.
|
|
1598
1602
|
* @returns The `Instance` found.
|
|
1599
1603
|
*/
|
|
@@ -1604,7 +1608,7 @@ interface Instance extends RBXObject {
|
|
|
1604
1608
|
* - **ThreadSafety**: Safe
|
|
1605
1609
|
*
|
|
1606
1610
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetActor)
|
|
1607
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1611
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1608
1612
|
* @returns The `Actor` found.
|
|
1609
1613
|
*/
|
|
1610
1614
|
GetActor(this: Instance): Actor | undefined;
|
|
@@ -1614,7 +1618,7 @@ interface Instance extends RBXObject {
|
|
|
1614
1618
|
* - **ThreadSafety**: Safe
|
|
1615
1619
|
*
|
|
1616
1620
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetAttribute)
|
|
1617
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1621
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1618
1622
|
* @param attribute The name of the attribute being retrieved.
|
|
1619
1623
|
* @returns The value which has been assigned to the given attribute name. If no attribute has been assigned, `nil` is returned.
|
|
1620
1624
|
*/
|
|
@@ -1625,7 +1629,7 @@ interface Instance extends RBXObject {
|
|
|
1625
1629
|
* - **ThreadSafety**: Unsafe
|
|
1626
1630
|
*
|
|
1627
1631
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetAttributeChangedSignal)
|
|
1628
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1632
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1629
1633
|
* @param attribute The name of the specified attribute for which the change signal is being returned.
|
|
1630
1634
|
* @returns An event that fires when the given attribute changes.
|
|
1631
1635
|
*/
|
|
@@ -1637,7 +1641,7 @@ interface Instance extends RBXObject {
|
|
|
1637
1641
|
* - **Tags**: CustomLuaState
|
|
1638
1642
|
*
|
|
1639
1643
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetAttributes)
|
|
1640
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1644
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1641
1645
|
* @returns A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.
|
|
1642
1646
|
*/
|
|
1643
1647
|
GetAttributes(this: Instance): Map<string, AttributeValue>;
|
|
@@ -1647,7 +1651,7 @@ interface Instance extends RBXObject {
|
|
|
1647
1651
|
* - **ThreadSafety**: Safe
|
|
1648
1652
|
*
|
|
1649
1653
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetChildren)
|
|
1650
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1654
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1651
1655
|
* @returns An array containing the instance's children.
|
|
1652
1656
|
*/
|
|
1653
1657
|
GetChildren(this: Instance): Array<Instance>;
|
|
@@ -1658,7 +1662,7 @@ interface Instance extends RBXObject {
|
|
|
1658
1662
|
* - **Tags**: CustomLuaState
|
|
1659
1663
|
*
|
|
1660
1664
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetDescendants)
|
|
1661
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1665
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1662
1666
|
* @returns An array containing the instance's descendants.
|
|
1663
1667
|
*/
|
|
1664
1668
|
GetDescendants(this: Instance): Array<Instance>;
|
|
@@ -1668,7 +1672,7 @@ interface Instance extends RBXObject {
|
|
|
1668
1672
|
* - **ThreadSafety**: Safe
|
|
1669
1673
|
*
|
|
1670
1674
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetFullName)
|
|
1671
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1675
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1672
1676
|
* @returns The full name of the `Instance`.
|
|
1673
1677
|
*/
|
|
1674
1678
|
GetFullName(this: Instance): string;
|
|
@@ -1676,7 +1680,7 @@ interface Instance extends RBXObject {
|
|
|
1676
1680
|
* - **ThreadSafety**: Unsafe
|
|
1677
1681
|
*
|
|
1678
1682
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetStyled)
|
|
1679
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1683
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1680
1684
|
* @param name
|
|
1681
1685
|
*/
|
|
1682
1686
|
GetStyled(this: Instance, name: string): unknown;
|
|
@@ -1684,7 +1688,7 @@ interface Instance extends RBXObject {
|
|
|
1684
1688
|
* - **ThreadSafety**: Unsafe
|
|
1685
1689
|
*
|
|
1686
1690
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetStyledPropertyChangedSignal)
|
|
1687
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1691
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1688
1692
|
* @param property
|
|
1689
1693
|
*/
|
|
1690
1694
|
GetStyledPropertyChangedSignal(this: Instance, property: string): RBXScriptSignal;
|
|
@@ -1694,7 +1698,7 @@ interface Instance extends RBXObject {
|
|
|
1694
1698
|
* - **ThreadSafety**: Safe
|
|
1695
1699
|
*
|
|
1696
1700
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetTags)
|
|
1697
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1701
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1698
1702
|
*/
|
|
1699
1703
|
GetTags(this: Instance): Array<string>;
|
|
1700
1704
|
/**
|
|
@@ -1703,7 +1707,7 @@ interface Instance extends RBXObject {
|
|
|
1703
1707
|
* - **ThreadSafety**: Safe
|
|
1704
1708
|
*
|
|
1705
1709
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#HasTag)
|
|
1706
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1710
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1707
1711
|
* @param tag
|
|
1708
1712
|
*/
|
|
1709
1713
|
HasTag(this: Instance, tag: string): boolean;
|
|
@@ -1713,35 +1717,40 @@ interface Instance extends RBXObject {
|
|
|
1713
1717
|
* - **ThreadSafety**: Safe
|
|
1714
1718
|
*
|
|
1715
1719
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#IsAncestorOf)
|
|
1716
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1720
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1717
1721
|
* @param descendant The descendant `Instance`.
|
|
1718
1722
|
* @returns True if the `Instance` is an ancestor of the given descendant.
|
|
1719
1723
|
*/
|
|
1720
1724
|
IsAncestorOf(this: Instance, descendant: Instance): boolean;
|
|
1721
1725
|
/**
|
|
1722
|
-
* Returns true if an `Instance` is a descendant of the given ancestor.
|
|
1726
|
+
* Returns `true` if an `Instance` is a descendant of the given ancestor.
|
|
1723
1727
|
*
|
|
1724
1728
|
* - **ThreadSafety**: Safe
|
|
1725
1729
|
*
|
|
1726
1730
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#IsDescendantOf)
|
|
1727
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1731
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1728
1732
|
* @param ancestor The ancestor `Instance`.
|
|
1729
1733
|
* @returns True if the `Instance` is a descendant of the given ancestor.
|
|
1730
1734
|
*/
|
|
1731
1735
|
IsDescendantOf(this: Instance, ancestor: Instance): boolean;
|
|
1732
1736
|
/**
|
|
1737
|
+
* Returns `true` if the value stored in the specified property is non-default.
|
|
1738
|
+
*
|
|
1733
1739
|
* - **ThreadSafety**: Unsafe
|
|
1734
1740
|
*
|
|
1735
1741
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#IsPropertyModified)
|
|
1742
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1743
|
+
* @param property
|
|
1744
|
+
* @returns Boolean indicating whether the property is modified.
|
|
1736
1745
|
*/
|
|
1737
|
-
IsPropertyModified(this: Instance,
|
|
1746
|
+
IsPropertyModified(this: Instance, property: string): boolean;
|
|
1738
1747
|
/**
|
|
1739
1748
|
* Removes a tag from the instance.
|
|
1740
1749
|
*
|
|
1741
1750
|
* - **ThreadSafety**: Unsafe
|
|
1742
1751
|
*
|
|
1743
1752
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#RemoveTag)
|
|
1744
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1753
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1745
1754
|
* @param tag
|
|
1746
1755
|
*/
|
|
1747
1756
|
RemoveTag(this: Instance, tag: string): void;
|
|
@@ -1749,15 +1758,17 @@ interface Instance extends RBXObject {
|
|
|
1749
1758
|
* - **ThreadSafety**: Unsafe
|
|
1750
1759
|
*
|
|
1751
1760
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#ResetPropertyToDefault)
|
|
1761
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1762
|
+
* @param property
|
|
1752
1763
|
*/
|
|
1753
|
-
ResetPropertyToDefault(this: Instance,
|
|
1764
|
+
ResetPropertyToDefault(this: Instance, property: string): void;
|
|
1754
1765
|
/**
|
|
1755
1766
|
* Sets the attribute with the given name to the given value.
|
|
1756
1767
|
*
|
|
1757
1768
|
* - **ThreadSafety**: Unsafe
|
|
1758
1769
|
*
|
|
1759
1770
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#SetAttribute)
|
|
1760
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1771
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1761
1772
|
* @param attribute The name of the attribute being set.
|
|
1762
1773
|
* @param value The value to set the specified attribute to.
|
|
1763
1774
|
*/
|
|
@@ -1769,7 +1780,7 @@ interface Instance extends RBXObject {
|
|
|
1769
1780
|
* - **Tags**: CustomLuaState, CanYield
|
|
1770
1781
|
*
|
|
1771
1782
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#WaitForChild)
|
|
1772
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1783
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1773
1784
|
* @param childName The `Instance.Name` to be looked for.
|
|
1774
1785
|
* @param timeOut An optional time out parameter.
|
|
1775
1786
|
* @returns The `Instance` found.
|
|
@@ -2830,6 +2841,18 @@ interface AnimationTrack extends Instance {
|
|
|
2830
2841
|
* @returns The signal created and fired when the animation reaches the created `KeyFrameMarker`.
|
|
2831
2842
|
*/
|
|
2832
2843
|
GetMarkerReachedSignal(this: AnimationTrack, name: string): RBXScriptSignal<(param?: string) => void>;
|
|
2844
|
+
/**
|
|
2845
|
+
* - **ThreadSafety**: Unsafe
|
|
2846
|
+
*
|
|
2847
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetInstance)
|
|
2848
|
+
*/
|
|
2849
|
+
GetTargetInstance(this: AnimationTrack, name: string): Instance | undefined;
|
|
2850
|
+
/**
|
|
2851
|
+
* - **ThreadSafety**: Unsafe
|
|
2852
|
+
*
|
|
2853
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetNames)
|
|
2854
|
+
*/
|
|
2855
|
+
GetTargetNames(this: AnimationTrack): Array<unknown>;
|
|
2833
2856
|
/**
|
|
2834
2857
|
* Returns the time position of the first `Keyframe` of the given name in an `AnimationTrack`.
|
|
2835
2858
|
*
|
|
@@ -2854,6 +2877,12 @@ interface AnimationTrack extends Instance {
|
|
|
2854
2877
|
* @param speed The playback speed of the animation.
|
|
2855
2878
|
*/
|
|
2856
2879
|
Play(this: AnimationTrack, fadeTime?: number, weight?: number, speed?: number): void;
|
|
2880
|
+
/**
|
|
2881
|
+
* - **ThreadSafety**: Unsafe
|
|
2882
|
+
*
|
|
2883
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetTargetInstance)
|
|
2884
|
+
*/
|
|
2885
|
+
SetTargetInstance(this: AnimationTrack, name: string, target: Instance): void;
|
|
2857
2886
|
/**
|
|
2858
2887
|
* Stops the `AnimationTrack`.
|
|
2859
2888
|
*
|
|
@@ -3905,12 +3934,14 @@ interface AudioChannelMixer extends Instance {
|
|
|
3905
3934
|
* - **ThreadSafety**: Unsafe
|
|
3906
3935
|
*
|
|
3907
3936
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetInputPins)
|
|
3937
|
+
* @param this
|
|
3908
3938
|
*/
|
|
3909
3939
|
GetInputPins(this: AudioChannelMixer): Array<unknown>;
|
|
3910
3940
|
/**
|
|
3911
3941
|
* - **ThreadSafety**: Unsafe
|
|
3912
3942
|
*
|
|
3913
3943
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetOutputPins)
|
|
3944
|
+
* @param this
|
|
3914
3945
|
*/
|
|
3915
3946
|
GetOutputPins(this: AudioChannelMixer): Array<unknown>;
|
|
3916
3947
|
/**
|
|
@@ -3952,12 +3983,14 @@ interface AudioChannelSplitter extends Instance {
|
|
|
3952
3983
|
* - **ThreadSafety**: Unsafe
|
|
3953
3984
|
*
|
|
3954
3985
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetInputPins)
|
|
3986
|
+
* @param this
|
|
3955
3987
|
*/
|
|
3956
3988
|
GetInputPins(this: AudioChannelSplitter): Array<unknown>;
|
|
3957
3989
|
/**
|
|
3958
3990
|
* - **ThreadSafety**: Unsafe
|
|
3959
3991
|
*
|
|
3960
3992
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetOutputPins)
|
|
3993
|
+
* @param this
|
|
3961
3994
|
*/
|
|
3962
3995
|
GetOutputPins(this: AudioChannelSplitter): Array<unknown>;
|
|
3963
3996
|
/**
|
|
@@ -5615,6 +5648,154 @@ interface AudioSearchParams extends Instance {
|
|
|
5615
5648
|
*/
|
|
5616
5649
|
Title: string;
|
|
5617
5650
|
}
|
|
5651
|
+
/**
|
|
5652
|
+
* - **Tags**: NotBrowsable
|
|
5653
|
+
*
|
|
5654
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
|
|
5655
|
+
*/
|
|
5656
|
+
interface AudioTextToSpeech extends Instance {
|
|
5657
|
+
/**
|
|
5658
|
+
* **DO NOT USE!**
|
|
5659
|
+
*
|
|
5660
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
5661
|
+
* @hidden
|
|
5662
|
+
* @deprecated
|
|
5663
|
+
*/
|
|
5664
|
+
readonly _nominal_AudioTextToSpeech: unique symbol;
|
|
5665
|
+
/**
|
|
5666
|
+
* - **ThreadSafety**: ReadSafe
|
|
5667
|
+
* - **Tags**: NotReplicated
|
|
5668
|
+
*
|
|
5669
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#IsLoaded)
|
|
5670
|
+
*/
|
|
5671
|
+
readonly IsLoaded: boolean;
|
|
5672
|
+
/**
|
|
5673
|
+
* - **ThreadSafety**: ReadSafe
|
|
5674
|
+
*
|
|
5675
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#IsPlaying)
|
|
5676
|
+
*/
|
|
5677
|
+
get IsPlaying(): boolean;
|
|
5678
|
+
/**
|
|
5679
|
+
* - **ThreadSafety**: ReadSafe
|
|
5680
|
+
*
|
|
5681
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Looping)
|
|
5682
|
+
*/
|
|
5683
|
+
Looping: boolean;
|
|
5684
|
+
/**
|
|
5685
|
+
* - **ThreadSafety**: ReadSafe
|
|
5686
|
+
*
|
|
5687
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Pitch)
|
|
5688
|
+
*/
|
|
5689
|
+
Pitch: number;
|
|
5690
|
+
/**
|
|
5691
|
+
* - **ThreadSafety**: ReadSafe
|
|
5692
|
+
*
|
|
5693
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#PlaybackSpeed)
|
|
5694
|
+
*/
|
|
5695
|
+
PlaybackSpeed: number;
|
|
5696
|
+
/**
|
|
5697
|
+
* - **ThreadSafety**: ReadSafe
|
|
5698
|
+
*
|
|
5699
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Speed)
|
|
5700
|
+
*/
|
|
5701
|
+
Speed: number;
|
|
5702
|
+
/**
|
|
5703
|
+
* - **ThreadSafety**: ReadSafe
|
|
5704
|
+
*
|
|
5705
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Text)
|
|
5706
|
+
*/
|
|
5707
|
+
Text: string;
|
|
5708
|
+
/**
|
|
5709
|
+
* - **ThreadSafety**: ReadSafe
|
|
5710
|
+
* - **Tags**: NotReplicated
|
|
5711
|
+
*
|
|
5712
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#TimeLength)
|
|
5713
|
+
*/
|
|
5714
|
+
readonly TimeLength: number;
|
|
5715
|
+
/**
|
|
5716
|
+
* - **ThreadSafety**: ReadSafe
|
|
5717
|
+
*
|
|
5718
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#TimePosition)
|
|
5719
|
+
*/
|
|
5720
|
+
TimePosition: number;
|
|
5721
|
+
/**
|
|
5722
|
+
* - **ThreadSafety**: ReadSafe
|
|
5723
|
+
*
|
|
5724
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#VoiceId)
|
|
5725
|
+
*/
|
|
5726
|
+
VoiceId: string;
|
|
5727
|
+
/**
|
|
5728
|
+
* - **ThreadSafety**: ReadSafe
|
|
5729
|
+
*
|
|
5730
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Volume)
|
|
5731
|
+
*/
|
|
5732
|
+
Volume: number;
|
|
5733
|
+
/**
|
|
5734
|
+
* - **ThreadSafety**: Unsafe
|
|
5735
|
+
*
|
|
5736
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetConnectedWires)
|
|
5737
|
+
* @param this
|
|
5738
|
+
* @param pin
|
|
5739
|
+
*/
|
|
5740
|
+
GetConnectedWires(this: AudioTextToSpeech, pin: string): Array<Instance>;
|
|
5741
|
+
/**
|
|
5742
|
+
* - **ThreadSafety**: Unsafe
|
|
5743
|
+
*
|
|
5744
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Pause)
|
|
5745
|
+
* @param this
|
|
5746
|
+
*/
|
|
5747
|
+
Pause(this: AudioTextToSpeech): void;
|
|
5748
|
+
/**
|
|
5749
|
+
* - **ThreadSafety**: Unsafe
|
|
5750
|
+
*
|
|
5751
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Play)
|
|
5752
|
+
* @param this
|
|
5753
|
+
*/
|
|
5754
|
+
Play(this: AudioTextToSpeech): void;
|
|
5755
|
+
/**
|
|
5756
|
+
* - **ThreadSafety**: Unsafe
|
|
5757
|
+
*
|
|
5758
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Unload)
|
|
5759
|
+
* @param this
|
|
5760
|
+
*/
|
|
5761
|
+
Unload(this: AudioTextToSpeech): void;
|
|
5762
|
+
/**
|
|
5763
|
+
* - **ThreadSafety**: Unsafe
|
|
5764
|
+
* - **Tags**: Yields
|
|
5765
|
+
*
|
|
5766
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetWaveformAsync)
|
|
5767
|
+
* @param this
|
|
5768
|
+
* @param timeRange
|
|
5769
|
+
* @param samples
|
|
5770
|
+
*/
|
|
5771
|
+
GetWaveformAsync(this: AudioTextToSpeech, timeRange: NumberRange, samples: number): Array<unknown>;
|
|
5772
|
+
/**
|
|
5773
|
+
* - **ThreadSafety**: Unsafe
|
|
5774
|
+
* - **Tags**: Yields
|
|
5775
|
+
*
|
|
5776
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#LoadAsync)
|
|
5777
|
+
* @param this
|
|
5778
|
+
*/
|
|
5779
|
+
LoadAsync(this: AudioTextToSpeech): Enum.AssetFetchStatus;
|
|
5780
|
+
/**
|
|
5781
|
+
* - **ThreadSafety**: Unsafe
|
|
5782
|
+
*
|
|
5783
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Ended)
|
|
5784
|
+
*/
|
|
5785
|
+
readonly Ended: RBXScriptSignal<() => void>;
|
|
5786
|
+
/**
|
|
5787
|
+
* - **ThreadSafety**: Unsafe
|
|
5788
|
+
*
|
|
5789
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Looped)
|
|
5790
|
+
*/
|
|
5791
|
+
readonly Looped: RBXScriptSignal<() => void>;
|
|
5792
|
+
/**
|
|
5793
|
+
* - **ThreadSafety**: Unsafe
|
|
5794
|
+
*
|
|
5795
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#WiringChanged)
|
|
5796
|
+
*/
|
|
5797
|
+
readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
|
|
5798
|
+
}
|
|
5618
5799
|
/**
|
|
5619
5800
|
* - **Tags**: NotCreatable, Service
|
|
5620
5801
|
*
|
|
@@ -5638,18 +5819,11 @@ interface AuroraScriptService extends Instance {
|
|
|
5638
5819
|
*/
|
|
5639
5820
|
get BufferSize(): number;
|
|
5640
5821
|
/**
|
|
5641
|
-
* - **ThreadSafety**:
|
|
5642
|
-
* - **Tags**: NotReplicated
|
|
5643
|
-
*
|
|
5644
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#LocalFrameId)
|
|
5645
|
-
*/
|
|
5646
|
-
get LocalFrameId(): number;
|
|
5647
|
-
/**
|
|
5648
|
-
* - **ThreadSafety**: ReadSafe
|
|
5822
|
+
* - **ThreadSafety**: Safe
|
|
5649
5823
|
*
|
|
5650
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#
|
|
5824
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#GetLocalFrameId)
|
|
5651
5825
|
*/
|
|
5652
|
-
|
|
5826
|
+
GetLocalFrameId(this: AuroraScriptService): number;
|
|
5653
5827
|
/**
|
|
5654
5828
|
* - **ThreadSafety**: Safe
|
|
5655
5829
|
*
|
|
@@ -5691,12 +5865,6 @@ interface AuroraService extends Instance {
|
|
|
5691
5865
|
* @deprecated
|
|
5692
5866
|
*/
|
|
5693
5867
|
readonly _nominal_AuroraService: unique symbol;
|
|
5694
|
-
/**
|
|
5695
|
-
* - **ThreadSafety**: ReadSafe
|
|
5696
|
-
*
|
|
5697
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#RollbackEnabled)
|
|
5698
|
-
*/
|
|
5699
|
-
RollbackEnabled: boolean;
|
|
5700
5868
|
/**
|
|
5701
5869
|
* - **ThreadSafety**: Unsafe
|
|
5702
5870
|
*
|
|
@@ -5727,18 +5895,6 @@ interface AuroraService extends Instance {
|
|
|
5727
5895
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsDesynced)
|
|
5728
5896
|
*/
|
|
5729
5897
|
IsDesynced(this: AuroraService, target: Instance): boolean;
|
|
5730
|
-
/**
|
|
5731
|
-
* - **ThreadSafety**: Unsafe
|
|
5732
|
-
*
|
|
5733
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#NetDesync)
|
|
5734
|
-
*/
|
|
5735
|
-
NetDesync(this: AuroraService, target: Instance): void;
|
|
5736
|
-
/**
|
|
5737
|
-
* - **ThreadSafety**: Unsafe
|
|
5738
|
-
*
|
|
5739
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#NetSync)
|
|
5740
|
-
*/
|
|
5741
|
-
NetSync(this: AuroraService, target: Instance): void;
|
|
5742
5898
|
/**
|
|
5743
5899
|
* - **ThreadSafety**: Unsafe
|
|
5744
5900
|
*
|
|
@@ -5912,6 +6068,8 @@ interface AvatarCreationService extends Instance {
|
|
|
5912
6068
|
* - **Tags**: Yields
|
|
5913
6069
|
*
|
|
5914
6070
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PrepareAvatarForPreviewAsync)
|
|
6071
|
+
* @param this A service to support developer avatar creators.
|
|
6072
|
+
* @param humanoidModel
|
|
5915
6073
|
*/
|
|
5916
6074
|
PrepareAvatarForPreviewAsync(this: AvatarCreationService, humanoidModel: Model): void;
|
|
5917
6075
|
/**
|
|
@@ -7306,7 +7464,6 @@ interface BaseWrap extends Instance {
|
|
|
7306
7464
|
readonly _nominal_BaseWrap: unique symbol;
|
|
7307
7465
|
/**
|
|
7308
7466
|
* - **ThreadSafety**: ReadSafe
|
|
7309
|
-
* - **Tags**: Hidden
|
|
7310
7467
|
*
|
|
7311
7468
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseWrap#CageMeshContent)
|
|
7312
7469
|
*/
|
|
@@ -7455,7 +7612,6 @@ interface WrapLayer extends BaseWrap {
|
|
|
7455
7612
|
Puffiness: number;
|
|
7456
7613
|
/**
|
|
7457
7614
|
* - **ThreadSafety**: ReadSafe
|
|
7458
|
-
* - **Tags**: Hidden
|
|
7459
7615
|
*
|
|
7460
7616
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ReferenceMeshContent)
|
|
7461
7617
|
*/
|
|
@@ -8734,7 +8890,7 @@ interface CaptureService extends Instance {
|
|
|
8734
8890
|
*
|
|
8735
8891
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptSaveCapturesToGallery)
|
|
8736
8892
|
* @param this A service which provides control over screenshot capture features.
|
|
8737
|
-
* @param
|
|
8893
|
+
* @param captures
|
|
8738
8894
|
* @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.
|
|
8739
8895
|
*/
|
|
8740
8896
|
PromptSaveCapturesToGallery<T extends string>(this: CaptureService, contentIds: Array<T>, resultCallback: (results: Record<T, boolean>) => void): void;
|
|
@@ -8745,7 +8901,7 @@ interface CaptureService extends Instance {
|
|
|
8745
8901
|
*
|
|
8746
8902
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptShareCapture)
|
|
8747
8903
|
* @param this A service which provides control over screenshot capture features.
|
|
8748
|
-
* @param
|
|
8904
|
+
* @param captureContent
|
|
8749
8905
|
* @param launchData An optional string to include as launch data in the invite link.
|
|
8750
8906
|
* @param onAcceptedCallback An optional callback function invoked if the user accepts sharing.
|
|
8751
8907
|
* @param onDeniedCallback An optional callback function invoked if the user denies sharing.
|
|
@@ -8755,6 +8911,9 @@ interface CaptureService extends Instance {
|
|
|
8755
8911
|
* - **ThreadSafety**: Unsafe
|
|
8756
8912
|
*
|
|
8757
8913
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#TakeCapture)
|
|
8914
|
+
* @param this A service which provides control over screenshot capture features.
|
|
8915
|
+
* @param onCaptureReady
|
|
8916
|
+
* @param captureParams
|
|
8758
8917
|
*/
|
|
8759
8918
|
TakeCapture(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
|
|
8760
8919
|
/**
|
|
@@ -14297,7 +14456,6 @@ interface Decal extends FaceInstance {
|
|
|
14297
14456
|
Texture: ContentId;
|
|
14298
14457
|
/**
|
|
14299
14458
|
* - **ThreadSafety**: ReadSafe
|
|
14300
|
-
* - **Tags**: Hidden
|
|
14301
14459
|
*
|
|
14302
14460
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#TextureContent)
|
|
14303
14461
|
*/
|
|
@@ -16030,6 +16188,12 @@ interface GuiButton extends GuiObject {
|
|
|
16030
16188
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#AutoButtonColor)
|
|
16031
16189
|
*/
|
|
16032
16190
|
AutoButtonColor: boolean;
|
|
16191
|
+
/**
|
|
16192
|
+
* - **ThreadSafety**: ReadSafe
|
|
16193
|
+
*
|
|
16194
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#HoverHapticEffect)
|
|
16195
|
+
*/
|
|
16196
|
+
HoverHapticEffect: HapticEffect | undefined;
|
|
16033
16197
|
/**
|
|
16034
16198
|
* If `true` while the GUI element is visible, the mouse will not be locked unless the right mouse button is down.
|
|
16035
16199
|
*
|
|
@@ -16038,6 +16202,12 @@ interface GuiButton extends GuiObject {
|
|
|
16038
16202
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#Modal)
|
|
16039
16203
|
*/
|
|
16040
16204
|
Modal: boolean;
|
|
16205
|
+
/**
|
|
16206
|
+
* - **ThreadSafety**: ReadSafe
|
|
16207
|
+
*
|
|
16208
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#PressHapticEffect)
|
|
16209
|
+
*/
|
|
16210
|
+
PressHapticEffect: HapticEffect | undefined;
|
|
16041
16211
|
/**
|
|
16042
16212
|
* A boolean property which indicates whether the object has been selected.
|
|
16043
16213
|
*
|
|
@@ -16153,7 +16323,6 @@ interface ImageButton extends GuiButton {
|
|
|
16153
16323
|
* The image content displayed by the UI element. Supports asset URIs and `EditableImage` objects.
|
|
16154
16324
|
*
|
|
16155
16325
|
* - **ThreadSafety**: ReadSafe
|
|
16156
|
-
* - **Tags**: Hidden
|
|
16157
16326
|
*
|
|
16158
16327
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImageButton#ImageContent)
|
|
16159
16328
|
*/
|
|
@@ -16531,7 +16700,6 @@ interface ImageLabel extends GuiLabel {
|
|
|
16531
16700
|
* The image content displayed by the UI element. Supports [asset URIs](../../../projects/assets/index.md#asset-uris) and `EditableImage` objects.
|
|
16532
16701
|
*
|
|
16533
16702
|
* - **ThreadSafety**: ReadSafe
|
|
16534
|
-
* - **Tags**: Hidden
|
|
16535
16703
|
*
|
|
16536
16704
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImageLabel#ImageContent)
|
|
16537
16705
|
*/
|
|
@@ -19502,6 +19670,8 @@ interface GuiService extends Instance {
|
|
|
19502
19670
|
readonly MenuOpened: RBXScriptSignal<() => void>;
|
|
19503
19671
|
}
|
|
19504
19672
|
/**
|
|
19673
|
+
* - **Tags**: NotBrowsable
|
|
19674
|
+
*
|
|
19505
19675
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect)
|
|
19506
19676
|
*/
|
|
19507
19677
|
interface HapticEffect extends Instance {
|
|
@@ -21884,24 +22054,29 @@ interface HumanoidRigDescription extends Instance {
|
|
|
21884
22054
|
* - **ThreadSafety**: Safe
|
|
21885
22055
|
*
|
|
21886
22056
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Automap)
|
|
22057
|
+
* @param this
|
|
22058
|
+
* @param character
|
|
21887
22059
|
*/
|
|
21888
22060
|
Automap(this: HumanoidRigDescription, character: Instance): void;
|
|
21889
22061
|
/**
|
|
21890
22062
|
* - **ThreadSafety**: Safe
|
|
21891
22063
|
*
|
|
21892
22064
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointNames)
|
|
22065
|
+
* @param this
|
|
21893
22066
|
*/
|
|
21894
22067
|
GetJointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
21895
22068
|
/**
|
|
21896
22069
|
* - **ThreadSafety**: Safe
|
|
21897
22070
|
*
|
|
21898
22071
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR15JointNames)
|
|
22072
|
+
* @param this
|
|
21899
22073
|
*/
|
|
21900
22074
|
GetR15JointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
21901
22075
|
/**
|
|
21902
22076
|
* - **ThreadSafety**: Safe
|
|
21903
22077
|
*
|
|
21904
22078
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR6JointNames)
|
|
22079
|
+
* @param this
|
|
21905
22080
|
*/
|
|
21906
22081
|
GetR6JointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
21907
22082
|
}
|
|
@@ -22222,6 +22397,24 @@ interface InputBinding extends Instance {
|
|
|
22222
22397
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#KeyCode)
|
|
22223
22398
|
*/
|
|
22224
22399
|
KeyCode: Enum.KeyCode;
|
|
22400
|
+
/**
|
|
22401
|
+
* - **ThreadSafety**: ReadSafe
|
|
22402
|
+
*
|
|
22403
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#PressedThreshold)
|
|
22404
|
+
*/
|
|
22405
|
+
PressedThreshold: number;
|
|
22406
|
+
/**
|
|
22407
|
+
* - **ThreadSafety**: ReadSafe
|
|
22408
|
+
*
|
|
22409
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ReleasedThreshold)
|
|
22410
|
+
*/
|
|
22411
|
+
ReleasedThreshold: number;
|
|
22412
|
+
/**
|
|
22413
|
+
* - **ThreadSafety**: ReadSafe
|
|
22414
|
+
*
|
|
22415
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Scale)
|
|
22416
|
+
*/
|
|
22417
|
+
Scale: number;
|
|
22225
22418
|
/**
|
|
22226
22419
|
* - **ThreadSafety**: ReadSafe
|
|
22227
22420
|
*
|
|
@@ -24753,7 +24946,7 @@ interface MarketplaceService extends Instance {
|
|
|
24753
24946
|
* - `PlaceIdWherePurchased` — The place ID in which the purchase was made. Depending on where the user is during gameplay, the purchase place's ID can be the same as or different from the current place's ID.
|
|
24754
24947
|
* - `CurrencySpent` — The amount of currency spent in the transaction.
|
|
24755
24948
|
* - `CurrencyType` — The type of currency spent in the purchase; always `CurrencyType.Robux`.
|
|
24756
|
-
* - `ProductPurchaseChannel` — How the user acquired the developer
|
|
24949
|
+
* - `ProductPurchaseChannel` — How the user acquired the developer product. One of `ProductPurchaseChannel`.
|
|
24757
24950
|
*
|
|
24758
24951
|
*
|
|
24759
24952
|
* @returns An enum that represents how the developer product receipt was processed. - `PurchaseGranted`:
|
|
@@ -24764,6 +24957,46 @@ interface MarketplaceService extends Instance {
|
|
|
24764
24957
|
*/
|
|
24765
24958
|
ProcessReceipt: ((receiptInfo: ReceiptInfo) => Enum.ProductPurchaseDecision) | undefined;
|
|
24766
24959
|
}
|
|
24960
|
+
/**
|
|
24961
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
24962
|
+
*
|
|
24963
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService)
|
|
24964
|
+
*/
|
|
24965
|
+
interface MatchmakingService extends Instance {
|
|
24966
|
+
/**
|
|
24967
|
+
* **DO NOT USE!**
|
|
24968
|
+
*
|
|
24969
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
24970
|
+
* @hidden
|
|
24971
|
+
* @deprecated
|
|
24972
|
+
*/
|
|
24973
|
+
readonly _nominal_MatchmakingService: unique symbol;
|
|
24974
|
+
/**
|
|
24975
|
+
* - **ThreadSafety**: Unsafe
|
|
24976
|
+
*
|
|
24977
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService#GetServerAttribute)
|
|
24978
|
+
* @param this
|
|
24979
|
+
* @param name
|
|
24980
|
+
*/
|
|
24981
|
+
GetServerAttribute(this: MatchmakingService, name: string): unknown;
|
|
24982
|
+
/**
|
|
24983
|
+
* - **ThreadSafety**: Unsafe
|
|
24984
|
+
*
|
|
24985
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService#InitializeServerAttributesForStudio)
|
|
24986
|
+
* @param this
|
|
24987
|
+
* @param serverAttributes
|
|
24988
|
+
*/
|
|
24989
|
+
InitializeServerAttributesForStudio(this: MatchmakingService, serverAttributes: object): unknown;
|
|
24990
|
+
/**
|
|
24991
|
+
* - **ThreadSafety**: Unsafe
|
|
24992
|
+
*
|
|
24993
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService#SetServerAttribute)
|
|
24994
|
+
* @param this
|
|
24995
|
+
* @param name
|
|
24996
|
+
* @param value
|
|
24997
|
+
*/
|
|
24998
|
+
SetServerAttribute(this: MatchmakingService, name: string, value: unknown): unknown;
|
|
24999
|
+
}
|
|
24767
25000
|
/**
|
|
24768
25001
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
24769
25002
|
*
|
|
@@ -27649,7 +27882,6 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
27649
27882
|
* The mesh that is displayed on the `MeshPart`. Supports [asset URIs](../../../projects/assets/index.md#asset-uris) and `EditableMesh` objects.
|
|
27650
27883
|
*
|
|
27651
27884
|
* - **ThreadSafety**: ReadSafe
|
|
27652
|
-
* - **Tags**: Hidden
|
|
27653
27885
|
*
|
|
27654
27886
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MeshPart#MeshContent)
|
|
27655
27887
|
*/
|
|
@@ -27675,7 +27907,6 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
27675
27907
|
* The texture applied to the `MeshPart`. Supports [asset URIs](../../../projects/assets/index.md#asset-uris) and `EditableImage` objects.
|
|
27676
27908
|
*
|
|
27677
27909
|
* - **ThreadSafety**: ReadSafe
|
|
27678
|
-
* - **Tags**: Hidden
|
|
27679
27910
|
*
|
|
27680
27911
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MeshPart#TextureContent)
|
|
27681
27912
|
*/
|
|
@@ -30483,6 +30714,13 @@ interface Player extends Instance {
|
|
|
30483
30714
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#Neutral)
|
|
30484
30715
|
*/
|
|
30485
30716
|
Neutral: boolean;
|
|
30717
|
+
/**
|
|
30718
|
+
* - **ThreadSafety**: ReadSafe
|
|
30719
|
+
* - **Tags**: Hidden, NotReplicated
|
|
30720
|
+
*
|
|
30721
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#PartyId)
|
|
30722
|
+
*/
|
|
30723
|
+
get PartyId(): string;
|
|
30486
30724
|
/**
|
|
30487
30725
|
* Sets the part to focus replication around.
|
|
30488
30726
|
*
|
|
@@ -30552,6 +30790,12 @@ interface Player extends Instance {
|
|
|
30552
30790
|
* @returns The distance in studs between the player and the location.
|
|
30553
30791
|
*/
|
|
30554
30792
|
DistanceFromCharacter(this: Player, point: Vector3): number;
|
|
30793
|
+
/**
|
|
30794
|
+
* - **ThreadSafety**: Unsafe
|
|
30795
|
+
*
|
|
30796
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetData)
|
|
30797
|
+
*/
|
|
30798
|
+
GetData(this: Player): PlayerData;
|
|
30555
30799
|
/**
|
|
30556
30800
|
* Returns a dictionary containing information describing how the `Player` joins the experience.
|
|
30557
30801
|
*
|
|
@@ -30963,10 +31207,11 @@ interface PlayerData extends Instance {
|
|
|
30963
31207
|
GetPlayer(this: PlayerData): Player;
|
|
30964
31208
|
/**
|
|
30965
31209
|
* - **ThreadSafety**: Unsafe
|
|
31210
|
+
* - **Tags**: Yields
|
|
30966
31211
|
*
|
|
30967
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerData#
|
|
31212
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerData#GetRecordAsync)
|
|
30968
31213
|
*/
|
|
30969
|
-
|
|
31214
|
+
GetRecordAsync(this: PlayerData, recordName?: string): PlayerDataRecord;
|
|
30970
31215
|
}
|
|
30971
31216
|
/**
|
|
30972
31217
|
* - **Tags**: NotCreatable, NotReplicated
|
|
@@ -31077,12 +31322,6 @@ interface PlayerDataRecord extends Instance {
|
|
|
31077
31322
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#GetValueChangedSignal)
|
|
31078
31323
|
*/
|
|
31079
31324
|
GetValueChangedSignal(this: PlayerDataRecord, key: string): RBXScriptSignal;
|
|
31080
|
-
/**
|
|
31081
|
-
* - **ThreadSafety**: Unsafe
|
|
31082
|
-
*
|
|
31083
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#Release)
|
|
31084
|
-
*/
|
|
31085
|
-
Release(this: PlayerDataRecord): void;
|
|
31086
31325
|
/**
|
|
31087
31326
|
* - **ThreadSafety**: Unsafe
|
|
31088
31327
|
*
|
|
@@ -31099,16 +31338,16 @@ interface PlayerDataRecord extends Instance {
|
|
|
31099
31338
|
* - **ThreadSafety**: Unsafe
|
|
31100
31339
|
* - **Tags**: Yields
|
|
31101
31340
|
*
|
|
31102
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#
|
|
31341
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#ReleaseAsync)
|
|
31103
31342
|
*/
|
|
31104
|
-
|
|
31343
|
+
ReleaseAsync(this: PlayerDataRecord): void;
|
|
31105
31344
|
/**
|
|
31106
31345
|
* - **ThreadSafety**: Unsafe
|
|
31107
31346
|
* - **Tags**: Yields
|
|
31108
31347
|
*
|
|
31109
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#
|
|
31348
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#RequestFlushAsync)
|
|
31110
31349
|
*/
|
|
31111
|
-
|
|
31350
|
+
RequestFlushAsync(this: PlayerDataRecord): void;
|
|
31112
31351
|
/**
|
|
31113
31352
|
* - **ThreadSafety**: Unsafe
|
|
31114
31353
|
*
|
|
@@ -33734,6 +33973,8 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
33734
33973
|
*/
|
|
33735
33974
|
readonly JobId: string;
|
|
33736
33975
|
/**
|
|
33976
|
+
* Represents how players in the server are handled by matchmaking.
|
|
33977
|
+
*
|
|
33737
33978
|
* - **ThreadSafety**: ReadSafe
|
|
33738
33979
|
* - **Tags**: NotReplicated
|
|
33739
33980
|
*
|
|
@@ -34314,6 +34555,12 @@ interface SocialService extends Instance {
|
|
|
34314
34555
|
* @deprecated
|
|
34315
34556
|
*/
|
|
34316
34557
|
readonly _nominal_SocialService: unique symbol;
|
|
34558
|
+
/**
|
|
34559
|
+
* - **ThreadSafety**: Unsafe
|
|
34560
|
+
*
|
|
34561
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#GetPlayersByPartyId)
|
|
34562
|
+
*/
|
|
34563
|
+
GetPlayersByPartyId(this: SocialService, partyId: string): Array<Instance>;
|
|
34317
34564
|
/**
|
|
34318
34565
|
* Hides the calling player's self view.
|
|
34319
34566
|
*
|
|
@@ -36177,9 +36424,9 @@ interface StyleBase extends Instance {
|
|
|
36177
36424
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleBase#InsertStyleRule)
|
|
36178
36425
|
* @param this
|
|
36179
36426
|
* @param rule
|
|
36180
|
-
* @param
|
|
36427
|
+
* @param priority
|
|
36181
36428
|
*/
|
|
36182
|
-
InsertStyleRule(this: StyleBase, rule: StyleRule,
|
|
36429
|
+
InsertStyleRule(this: StyleBase, rule: StyleRule, priority?: number): void;
|
|
36183
36430
|
/**
|
|
36184
36431
|
* - **ThreadSafety**: Unsafe
|
|
36185
36432
|
*
|
|
@@ -36246,9 +36493,9 @@ interface StyleRule extends StyleBase {
|
|
|
36246
36493
|
*
|
|
36247
36494
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetProperties)
|
|
36248
36495
|
* @param this
|
|
36249
|
-
* @param
|
|
36496
|
+
* @param styleProperties
|
|
36250
36497
|
*/
|
|
36251
|
-
SetProperties(this: StyleRule,
|
|
36498
|
+
SetProperties(this: StyleRule, styleProperties: object): void;
|
|
36252
36499
|
/**
|
|
36253
36500
|
* - **ThreadSafety**: Unsafe
|
|
36254
36501
|
*
|
|
@@ -42301,6 +42548,79 @@ interface VoiceChatService extends Instance {
|
|
|
42301
42548
|
*/
|
|
42302
42549
|
IsVoiceEnabledForUserIdAsync(this: VoiceChatService, userId: number): boolean;
|
|
42303
42550
|
}
|
|
42551
|
+
/**
|
|
42552
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
42553
|
+
*
|
|
42554
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient)
|
|
42555
|
+
*/
|
|
42556
|
+
interface WebSocketClient extends Instance {
|
|
42557
|
+
/**
|
|
42558
|
+
* **DO NOT USE!**
|
|
42559
|
+
*
|
|
42560
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
42561
|
+
* @hidden
|
|
42562
|
+
* @deprecated
|
|
42563
|
+
*/
|
|
42564
|
+
readonly _nominal_WebSocketClient: unique symbol;
|
|
42565
|
+
/**
|
|
42566
|
+
* - **ThreadSafety**: ReadSafe
|
|
42567
|
+
* - **Tags**: NotReplicated
|
|
42568
|
+
*
|
|
42569
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#ConnectionState)
|
|
42570
|
+
*/
|
|
42571
|
+
readonly ConnectionState: Enum.WebSocketState;
|
|
42572
|
+
/**
|
|
42573
|
+
* - **ThreadSafety**: Unsafe
|
|
42574
|
+
*
|
|
42575
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Close)
|
|
42576
|
+
*/
|
|
42577
|
+
Close(this: WebSocketClient): void;
|
|
42578
|
+
/**
|
|
42579
|
+
* - **ThreadSafety**: Unsafe
|
|
42580
|
+
*
|
|
42581
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Send)
|
|
42582
|
+
*/
|
|
42583
|
+
Send(this: WebSocketClient, data: string): void;
|
|
42584
|
+
/**
|
|
42585
|
+
* - **ThreadSafety**: Unsafe
|
|
42586
|
+
*
|
|
42587
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Closed)
|
|
42588
|
+
*/
|
|
42589
|
+
readonly Closed: RBXScriptSignal<() => void>;
|
|
42590
|
+
/**
|
|
42591
|
+
* - **ThreadSafety**: Unsafe
|
|
42592
|
+
*
|
|
42593
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#MessageReceived)
|
|
42594
|
+
*/
|
|
42595
|
+
readonly MessageReceived: RBXScriptSignal<(data: string) => void>;
|
|
42596
|
+
/**
|
|
42597
|
+
* - **ThreadSafety**: Unsafe
|
|
42598
|
+
*
|
|
42599
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Opened)
|
|
42600
|
+
*/
|
|
42601
|
+
readonly Opened: RBXScriptSignal<() => void>;
|
|
42602
|
+
}
|
|
42603
|
+
/**
|
|
42604
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
42605
|
+
*
|
|
42606
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketService)
|
|
42607
|
+
*/
|
|
42608
|
+
interface WebSocketService extends Instance {
|
|
42609
|
+
/**
|
|
42610
|
+
* **DO NOT USE!**
|
|
42611
|
+
*
|
|
42612
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
42613
|
+
* @hidden
|
|
42614
|
+
* @deprecated
|
|
42615
|
+
*/
|
|
42616
|
+
readonly _nominal_WebSocketService: unique symbol;
|
|
42617
|
+
/**
|
|
42618
|
+
* - **ThreadSafety**: Unsafe
|
|
42619
|
+
*
|
|
42620
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketService#CreateClient)
|
|
42621
|
+
*/
|
|
42622
|
+
CreateClient(this: WebSocketService, uri: string): WebSocketClient;
|
|
42623
|
+
}
|
|
42304
42624
|
/**
|
|
42305
42625
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
42306
42626
|
*
|