@rbxts/types 1.0.840 → 1.0.841
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.
|
@@ -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;
|
|
@@ -249,6 +250,7 @@ interface CreatableInstances {
|
|
|
249
250
|
AudioPlayer: AudioPlayer;
|
|
250
251
|
AudioReverb: AudioReverb;
|
|
251
252
|
AudioSearchParams: AudioSearchParams;
|
|
253
|
+
AudioTextToSpeech: AudioTextToSpeech;
|
|
252
254
|
AuroraScript: AuroraScript;
|
|
253
255
|
Backpack: Backpack;
|
|
254
256
|
BallSocketConstraint: BallSocketConstraint;
|
|
@@ -1442,7 +1444,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1442
1444
|
Triangulate(this: EditableMesh): void;
|
|
1443
1445
|
}
|
|
1444
1446
|
/**
|
|
1445
|
-
* Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
1447
|
+
* `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1446
1448
|
*
|
|
1447
1449
|
* - **Tags**: NotCreatable, NotBrowsable
|
|
1448
1450
|
*
|
|
@@ -1488,7 +1490,7 @@ interface Instance extends RBXObject {
|
|
|
1488
1490
|
* - **ThreadSafety**: Unsafe
|
|
1489
1491
|
*
|
|
1490
1492
|
* [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.
|
|
1493
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1492
1494
|
* @param tag
|
|
1493
1495
|
*/
|
|
1494
1496
|
AddTag(this: Instance, tag: string): void;
|
|
@@ -1498,7 +1500,7 @@ interface Instance extends RBXObject {
|
|
|
1498
1500
|
* - **ThreadSafety**: Unsafe
|
|
1499
1501
|
*
|
|
1500
1502
|
* [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.
|
|
1503
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1502
1504
|
*/
|
|
1503
1505
|
ClearAllChildren(this: Instance): void;
|
|
1504
1506
|
/**
|
|
@@ -1507,7 +1509,7 @@ interface Instance extends RBXObject {
|
|
|
1507
1509
|
* - **ThreadSafety**: Unsafe
|
|
1508
1510
|
*
|
|
1509
1511
|
* [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.
|
|
1512
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1511
1513
|
*/
|
|
1512
1514
|
Clone<T extends Instance>(this: T): T;
|
|
1513
1515
|
/**
|
|
@@ -1516,7 +1518,7 @@ interface Instance extends RBXObject {
|
|
|
1516
1518
|
* - **ThreadSafety**: Unsafe
|
|
1517
1519
|
*
|
|
1518
1520
|
* [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.
|
|
1521
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1520
1522
|
*/
|
|
1521
1523
|
Destroy(this: Instance): void;
|
|
1522
1524
|
/**
|
|
@@ -1525,7 +1527,7 @@ interface Instance extends RBXObject {
|
|
|
1525
1527
|
* - **ThreadSafety**: Safe
|
|
1526
1528
|
*
|
|
1527
1529
|
* [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.
|
|
1530
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1529
1531
|
* @param name The `Instance.Name` to be looked for.
|
|
1530
1532
|
* @returns The `Instance` found.
|
|
1531
1533
|
*/
|
|
@@ -1536,7 +1538,7 @@ interface Instance extends RBXObject {
|
|
|
1536
1538
|
* - **ThreadSafety**: Safe
|
|
1537
1539
|
*
|
|
1538
1540
|
* [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.
|
|
1541
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1540
1542
|
* @param className The `Object.ClassName` to be looked for.
|
|
1541
1543
|
* @returns The `Instance` found.
|
|
1542
1544
|
*/
|
|
@@ -1547,7 +1549,7 @@ interface Instance extends RBXObject {
|
|
|
1547
1549
|
* - **ThreadSafety**: Safe
|
|
1548
1550
|
*
|
|
1549
1551
|
* [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.
|
|
1552
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1551
1553
|
* @param className The `Object.ClassName` to be looked for.
|
|
1552
1554
|
* @returns The `Instance` found.
|
|
1553
1555
|
*/
|
|
@@ -1558,19 +1560,19 @@ interface Instance extends RBXObject {
|
|
|
1558
1560
|
* - **ThreadSafety**: Safe
|
|
1559
1561
|
*
|
|
1560
1562
|
* [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.
|
|
1563
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1562
1564
|
* @param name The `Instance.Name` to be searched for.
|
|
1563
1565
|
* @param recursive Whether or not the search should be conducted recursively.
|
|
1564
1566
|
* @returns The `Instance` found.
|
|
1565
1567
|
*/
|
|
1566
1568
|
FindFirstChild(this: Instance, childName: string | number, recursive?: boolean): Instance | undefined;
|
|
1567
1569
|
/**
|
|
1568
|
-
* Returns the first child of the `Instance` whose `ClassName` is equal to the given
|
|
1570
|
+
* Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
|
|
1569
1571
|
*
|
|
1570
1572
|
* - **ThreadSafety**: Safe
|
|
1571
1573
|
*
|
|
1572
1574
|
* [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.
|
|
1575
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1574
1576
|
* @param className The `Object.ClassName` to be looked for.
|
|
1575
1577
|
* @returns The `Instance` found.
|
|
1576
1578
|
*/
|
|
@@ -1581,7 +1583,7 @@ interface Instance extends RBXObject {
|
|
|
1581
1583
|
* - **ThreadSafety**: Safe
|
|
1582
1584
|
*
|
|
1583
1585
|
* [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.
|
|
1586
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1585
1587
|
* @param className The `Object.ClassName` to be searched for.
|
|
1586
1588
|
* @param recursive Whether or not the search should be conducted recursively.
|
|
1587
1589
|
* @returns The `Instance` found.
|
|
@@ -1593,7 +1595,7 @@ interface Instance extends RBXObject {
|
|
|
1593
1595
|
* - **ThreadSafety**: Safe
|
|
1594
1596
|
*
|
|
1595
1597
|
* [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.
|
|
1598
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1597
1599
|
* @param name The `Instance.Name` to search for.
|
|
1598
1600
|
* @returns The `Instance` found.
|
|
1599
1601
|
*/
|
|
@@ -1604,7 +1606,7 @@ interface Instance extends RBXObject {
|
|
|
1604
1606
|
* - **ThreadSafety**: Safe
|
|
1605
1607
|
*
|
|
1606
1608
|
* [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.
|
|
1609
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1608
1610
|
* @returns The `Actor` found.
|
|
1609
1611
|
*/
|
|
1610
1612
|
GetActor(this: Instance): Actor | undefined;
|
|
@@ -1614,7 +1616,7 @@ interface Instance extends RBXObject {
|
|
|
1614
1616
|
* - **ThreadSafety**: Safe
|
|
1615
1617
|
*
|
|
1616
1618
|
* [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.
|
|
1619
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1618
1620
|
* @param attribute The name of the attribute being retrieved.
|
|
1619
1621
|
* @returns The value which has been assigned to the given attribute name. If no attribute has been assigned, `nil` is returned.
|
|
1620
1622
|
*/
|
|
@@ -1625,7 +1627,7 @@ interface Instance extends RBXObject {
|
|
|
1625
1627
|
* - **ThreadSafety**: Unsafe
|
|
1626
1628
|
*
|
|
1627
1629
|
* [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.
|
|
1630
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1629
1631
|
* @param attribute The name of the specified attribute for which the change signal is being returned.
|
|
1630
1632
|
* @returns An event that fires when the given attribute changes.
|
|
1631
1633
|
*/
|
|
@@ -1637,7 +1639,7 @@ interface Instance extends RBXObject {
|
|
|
1637
1639
|
* - **Tags**: CustomLuaState
|
|
1638
1640
|
*
|
|
1639
1641
|
* [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.
|
|
1642
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1641
1643
|
* @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
1644
|
*/
|
|
1643
1645
|
GetAttributes(this: Instance): Map<string, AttributeValue>;
|
|
@@ -1647,7 +1649,7 @@ interface Instance extends RBXObject {
|
|
|
1647
1649
|
* - **ThreadSafety**: Safe
|
|
1648
1650
|
*
|
|
1649
1651
|
* [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.
|
|
1652
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1651
1653
|
* @returns An array containing the instance's children.
|
|
1652
1654
|
*/
|
|
1653
1655
|
GetChildren(this: Instance): Array<Instance>;
|
|
@@ -1658,7 +1660,7 @@ interface Instance extends RBXObject {
|
|
|
1658
1660
|
* - **Tags**: CustomLuaState
|
|
1659
1661
|
*
|
|
1660
1662
|
* [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.
|
|
1663
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1662
1664
|
* @returns An array containing the instance's descendants.
|
|
1663
1665
|
*/
|
|
1664
1666
|
GetDescendants(this: Instance): Array<Instance>;
|
|
@@ -1668,7 +1670,7 @@ interface Instance extends RBXObject {
|
|
|
1668
1670
|
* - **ThreadSafety**: Safe
|
|
1669
1671
|
*
|
|
1670
1672
|
* [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.
|
|
1673
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1672
1674
|
* @returns The full name of the `Instance`.
|
|
1673
1675
|
*/
|
|
1674
1676
|
GetFullName(this: Instance): string;
|
|
@@ -1676,7 +1678,7 @@ interface Instance extends RBXObject {
|
|
|
1676
1678
|
* - **ThreadSafety**: Unsafe
|
|
1677
1679
|
*
|
|
1678
1680
|
* [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.
|
|
1681
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1680
1682
|
* @param name
|
|
1681
1683
|
*/
|
|
1682
1684
|
GetStyled(this: Instance, name: string): unknown;
|
|
@@ -1684,7 +1686,7 @@ interface Instance extends RBXObject {
|
|
|
1684
1686
|
* - **ThreadSafety**: Unsafe
|
|
1685
1687
|
*
|
|
1686
1688
|
* [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.
|
|
1689
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1688
1690
|
* @param property
|
|
1689
1691
|
*/
|
|
1690
1692
|
GetStyledPropertyChangedSignal(this: Instance, property: string): RBXScriptSignal;
|
|
@@ -1694,7 +1696,7 @@ interface Instance extends RBXObject {
|
|
|
1694
1696
|
* - **ThreadSafety**: Safe
|
|
1695
1697
|
*
|
|
1696
1698
|
* [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.
|
|
1699
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1698
1700
|
*/
|
|
1699
1701
|
GetTags(this: Instance): Array<string>;
|
|
1700
1702
|
/**
|
|
@@ -1703,7 +1705,7 @@ interface Instance extends RBXObject {
|
|
|
1703
1705
|
* - **ThreadSafety**: Safe
|
|
1704
1706
|
*
|
|
1705
1707
|
* [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.
|
|
1708
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1707
1709
|
* @param tag
|
|
1708
1710
|
*/
|
|
1709
1711
|
HasTag(this: Instance, tag: string): boolean;
|
|
@@ -1713,35 +1715,40 @@ interface Instance extends RBXObject {
|
|
|
1713
1715
|
* - **ThreadSafety**: Safe
|
|
1714
1716
|
*
|
|
1715
1717
|
* [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.
|
|
1718
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1717
1719
|
* @param descendant The descendant `Instance`.
|
|
1718
1720
|
* @returns True if the `Instance` is an ancestor of the given descendant.
|
|
1719
1721
|
*/
|
|
1720
1722
|
IsAncestorOf(this: Instance, descendant: Instance): boolean;
|
|
1721
1723
|
/**
|
|
1722
|
-
* Returns true if an `Instance` is a descendant of the given ancestor.
|
|
1724
|
+
* Returns `true` if an `Instance` is a descendant of the given ancestor.
|
|
1723
1725
|
*
|
|
1724
1726
|
* - **ThreadSafety**: Safe
|
|
1725
1727
|
*
|
|
1726
1728
|
* [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.
|
|
1729
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1728
1730
|
* @param ancestor The ancestor `Instance`.
|
|
1729
1731
|
* @returns True if the `Instance` is a descendant of the given ancestor.
|
|
1730
1732
|
*/
|
|
1731
1733
|
IsDescendantOf(this: Instance, ancestor: Instance): boolean;
|
|
1732
1734
|
/**
|
|
1735
|
+
* Returns `true` if the value stored in the specified property is non-default.
|
|
1736
|
+
*
|
|
1733
1737
|
* - **ThreadSafety**: Unsafe
|
|
1734
1738
|
*
|
|
1735
1739
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#IsPropertyModified)
|
|
1740
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1741
|
+
* @param name Name of the property to query.
|
|
1742
|
+
* @returns Boolean indicating whether the property is modified.
|
|
1736
1743
|
*/
|
|
1737
|
-
IsPropertyModified(this: Instance,
|
|
1744
|
+
IsPropertyModified(this: Instance, property: string): boolean;
|
|
1738
1745
|
/**
|
|
1739
1746
|
* Removes a tag from the instance.
|
|
1740
1747
|
*
|
|
1741
1748
|
* - **ThreadSafety**: Unsafe
|
|
1742
1749
|
*
|
|
1743
1750
|
* [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.
|
|
1751
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1745
1752
|
* @param tag
|
|
1746
1753
|
*/
|
|
1747
1754
|
RemoveTag(this: Instance, tag: string): void;
|
|
@@ -1749,15 +1756,17 @@ interface Instance extends RBXObject {
|
|
|
1749
1756
|
* - **ThreadSafety**: Unsafe
|
|
1750
1757
|
*
|
|
1751
1758
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#ResetPropertyToDefault)
|
|
1759
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1760
|
+
* @param name Name of the property to reset.
|
|
1752
1761
|
*/
|
|
1753
|
-
ResetPropertyToDefault(this: Instance,
|
|
1762
|
+
ResetPropertyToDefault(this: Instance, property: string): void;
|
|
1754
1763
|
/**
|
|
1755
1764
|
* Sets the attribute with the given name to the given value.
|
|
1756
1765
|
*
|
|
1757
1766
|
* - **ThreadSafety**: Unsafe
|
|
1758
1767
|
*
|
|
1759
1768
|
* [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.
|
|
1769
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1761
1770
|
* @param attribute The name of the attribute being set.
|
|
1762
1771
|
* @param value The value to set the specified attribute to.
|
|
1763
1772
|
*/
|
|
@@ -1769,7 +1778,7 @@ interface Instance extends RBXObject {
|
|
|
1769
1778
|
* - **Tags**: CustomLuaState, CanYield
|
|
1770
1779
|
*
|
|
1771
1780
|
* [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.
|
|
1781
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
1773
1782
|
* @param childName The `Instance.Name` to be looked for.
|
|
1774
1783
|
* @param timeOut An optional time out parameter.
|
|
1775
1784
|
* @returns The `Instance` found.
|
|
@@ -3905,12 +3914,14 @@ interface AudioChannelMixer extends Instance {
|
|
|
3905
3914
|
* - **ThreadSafety**: Unsafe
|
|
3906
3915
|
*
|
|
3907
3916
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetInputPins)
|
|
3917
|
+
* @param this
|
|
3908
3918
|
*/
|
|
3909
3919
|
GetInputPins(this: AudioChannelMixer): Array<unknown>;
|
|
3910
3920
|
/**
|
|
3911
3921
|
* - **ThreadSafety**: Unsafe
|
|
3912
3922
|
*
|
|
3913
3923
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetOutputPins)
|
|
3924
|
+
* @param this
|
|
3914
3925
|
*/
|
|
3915
3926
|
GetOutputPins(this: AudioChannelMixer): Array<unknown>;
|
|
3916
3927
|
/**
|
|
@@ -3952,12 +3963,14 @@ interface AudioChannelSplitter extends Instance {
|
|
|
3952
3963
|
* - **ThreadSafety**: Unsafe
|
|
3953
3964
|
*
|
|
3954
3965
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetInputPins)
|
|
3966
|
+
* @param this
|
|
3955
3967
|
*/
|
|
3956
3968
|
GetInputPins(this: AudioChannelSplitter): Array<unknown>;
|
|
3957
3969
|
/**
|
|
3958
3970
|
* - **ThreadSafety**: Unsafe
|
|
3959
3971
|
*
|
|
3960
3972
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetOutputPins)
|
|
3973
|
+
* @param this
|
|
3961
3974
|
*/
|
|
3962
3975
|
GetOutputPins(this: AudioChannelSplitter): Array<unknown>;
|
|
3963
3976
|
/**
|
|
@@ -5615,6 +5628,143 @@ interface AudioSearchParams extends Instance {
|
|
|
5615
5628
|
*/
|
|
5616
5629
|
Title: string;
|
|
5617
5630
|
}
|
|
5631
|
+
/**
|
|
5632
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
|
|
5633
|
+
*/
|
|
5634
|
+
interface AudioTextToSpeech extends Instance {
|
|
5635
|
+
/**
|
|
5636
|
+
* **DO NOT USE!**
|
|
5637
|
+
*
|
|
5638
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
5639
|
+
* @hidden
|
|
5640
|
+
* @deprecated
|
|
5641
|
+
*/
|
|
5642
|
+
readonly _nominal_AudioTextToSpeech: unique symbol;
|
|
5643
|
+
/**
|
|
5644
|
+
* - **ThreadSafety**: ReadSafe
|
|
5645
|
+
* - **Tags**: NotReplicated
|
|
5646
|
+
*
|
|
5647
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#IsLoaded)
|
|
5648
|
+
*/
|
|
5649
|
+
readonly IsLoaded: boolean;
|
|
5650
|
+
/**
|
|
5651
|
+
* - **ThreadSafety**: ReadSafe
|
|
5652
|
+
*
|
|
5653
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#IsPlaying)
|
|
5654
|
+
*/
|
|
5655
|
+
get IsPlaying(): boolean;
|
|
5656
|
+
/**
|
|
5657
|
+
* - **ThreadSafety**: ReadSafe
|
|
5658
|
+
*
|
|
5659
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Looping)
|
|
5660
|
+
*/
|
|
5661
|
+
Looping: boolean;
|
|
5662
|
+
/**
|
|
5663
|
+
* - **ThreadSafety**: ReadSafe
|
|
5664
|
+
*
|
|
5665
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Pitch)
|
|
5666
|
+
*/
|
|
5667
|
+
Pitch: number;
|
|
5668
|
+
/**
|
|
5669
|
+
* - **ThreadSafety**: ReadSafe
|
|
5670
|
+
*
|
|
5671
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#PlaybackSpeed)
|
|
5672
|
+
*/
|
|
5673
|
+
PlaybackSpeed: number;
|
|
5674
|
+
/**
|
|
5675
|
+
* - **ThreadSafety**: ReadSafe
|
|
5676
|
+
*
|
|
5677
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Speed)
|
|
5678
|
+
*/
|
|
5679
|
+
Speed: number;
|
|
5680
|
+
/**
|
|
5681
|
+
* - **ThreadSafety**: ReadSafe
|
|
5682
|
+
*
|
|
5683
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Text)
|
|
5684
|
+
*/
|
|
5685
|
+
Text: string;
|
|
5686
|
+
/**
|
|
5687
|
+
* - **ThreadSafety**: ReadSafe
|
|
5688
|
+
* - **Tags**: NotReplicated
|
|
5689
|
+
*
|
|
5690
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#TimeLength)
|
|
5691
|
+
*/
|
|
5692
|
+
readonly TimeLength: number;
|
|
5693
|
+
/**
|
|
5694
|
+
* - **ThreadSafety**: ReadSafe
|
|
5695
|
+
*
|
|
5696
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#TimePosition)
|
|
5697
|
+
*/
|
|
5698
|
+
TimePosition: number;
|
|
5699
|
+
/**
|
|
5700
|
+
* - **ThreadSafety**: ReadSafe
|
|
5701
|
+
*
|
|
5702
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#VoiceId)
|
|
5703
|
+
*/
|
|
5704
|
+
VoiceId: string;
|
|
5705
|
+
/**
|
|
5706
|
+
* - **ThreadSafety**: ReadSafe
|
|
5707
|
+
*
|
|
5708
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Volume)
|
|
5709
|
+
*/
|
|
5710
|
+
Volume: number;
|
|
5711
|
+
/**
|
|
5712
|
+
* - **ThreadSafety**: Unsafe
|
|
5713
|
+
*
|
|
5714
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetConnectedWires)
|
|
5715
|
+
*/
|
|
5716
|
+
GetConnectedWires(this: AudioTextToSpeech, pin: string): Array<Instance>;
|
|
5717
|
+
/**
|
|
5718
|
+
* - **ThreadSafety**: Unsafe
|
|
5719
|
+
*
|
|
5720
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Pause)
|
|
5721
|
+
*/
|
|
5722
|
+
Pause(this: AudioTextToSpeech): void;
|
|
5723
|
+
/**
|
|
5724
|
+
* - **ThreadSafety**: Unsafe
|
|
5725
|
+
*
|
|
5726
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Play)
|
|
5727
|
+
*/
|
|
5728
|
+
Play(this: AudioTextToSpeech): void;
|
|
5729
|
+
/**
|
|
5730
|
+
* - **ThreadSafety**: Unsafe
|
|
5731
|
+
*
|
|
5732
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Unload)
|
|
5733
|
+
*/
|
|
5734
|
+
Unload(this: AudioTextToSpeech): void;
|
|
5735
|
+
/**
|
|
5736
|
+
* - **ThreadSafety**: Unsafe
|
|
5737
|
+
* - **Tags**: Yields
|
|
5738
|
+
*
|
|
5739
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetWaveformAsync)
|
|
5740
|
+
*/
|
|
5741
|
+
GetWaveformAsync(this: AudioTextToSpeech, timeRange: NumberRange, samples: number): Array<unknown>;
|
|
5742
|
+
/**
|
|
5743
|
+
* - **ThreadSafety**: Unsafe
|
|
5744
|
+
* - **Tags**: Yields
|
|
5745
|
+
*
|
|
5746
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#LoadAsync)
|
|
5747
|
+
*/
|
|
5748
|
+
LoadAsync(this: AudioTextToSpeech): Enum.AssetFetchStatus;
|
|
5749
|
+
/**
|
|
5750
|
+
* - **ThreadSafety**: Unsafe
|
|
5751
|
+
*
|
|
5752
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Ended)
|
|
5753
|
+
*/
|
|
5754
|
+
readonly Ended: RBXScriptSignal<() => void>;
|
|
5755
|
+
/**
|
|
5756
|
+
* - **ThreadSafety**: Unsafe
|
|
5757
|
+
*
|
|
5758
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Looped)
|
|
5759
|
+
*/
|
|
5760
|
+
readonly Looped: RBXScriptSignal<() => void>;
|
|
5761
|
+
/**
|
|
5762
|
+
* - **ThreadSafety**: Unsafe
|
|
5763
|
+
*
|
|
5764
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#WiringChanged)
|
|
5765
|
+
*/
|
|
5766
|
+
readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
|
|
5767
|
+
}
|
|
5618
5768
|
/**
|
|
5619
5769
|
* - **Tags**: NotCreatable, Service
|
|
5620
5770
|
*
|
|
@@ -5912,6 +6062,8 @@ interface AvatarCreationService extends Instance {
|
|
|
5912
6062
|
* - **Tags**: Yields
|
|
5913
6063
|
*
|
|
5914
6064
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PrepareAvatarForPreviewAsync)
|
|
6065
|
+
* @param this A service to support developer avatar creators.
|
|
6066
|
+
* @param humanoidModel
|
|
5915
6067
|
*/
|
|
5916
6068
|
PrepareAvatarForPreviewAsync(this: AvatarCreationService, humanoidModel: Model): void;
|
|
5917
6069
|
/**
|
|
@@ -7306,7 +7458,6 @@ interface BaseWrap extends Instance {
|
|
|
7306
7458
|
readonly _nominal_BaseWrap: unique symbol;
|
|
7307
7459
|
/**
|
|
7308
7460
|
* - **ThreadSafety**: ReadSafe
|
|
7309
|
-
* - **Tags**: Hidden
|
|
7310
7461
|
*
|
|
7311
7462
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseWrap#CageMeshContent)
|
|
7312
7463
|
*/
|
|
@@ -7455,7 +7606,6 @@ interface WrapLayer extends BaseWrap {
|
|
|
7455
7606
|
Puffiness: number;
|
|
7456
7607
|
/**
|
|
7457
7608
|
* - **ThreadSafety**: ReadSafe
|
|
7458
|
-
* - **Tags**: Hidden
|
|
7459
7609
|
*
|
|
7460
7610
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ReferenceMeshContent)
|
|
7461
7611
|
*/
|
|
@@ -8734,7 +8884,7 @@ interface CaptureService extends Instance {
|
|
|
8734
8884
|
*
|
|
8735
8885
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptSaveCapturesToGallery)
|
|
8736
8886
|
* @param this A service which provides control over screenshot capture features.
|
|
8737
|
-
* @param
|
|
8887
|
+
* @param captures
|
|
8738
8888
|
* @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
8889
|
*/
|
|
8740
8890
|
PromptSaveCapturesToGallery<T extends string>(this: CaptureService, contentIds: Array<T>, resultCallback: (results: Record<T, boolean>) => void): void;
|
|
@@ -8745,7 +8895,7 @@ interface CaptureService extends Instance {
|
|
|
8745
8895
|
*
|
|
8746
8896
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptShareCapture)
|
|
8747
8897
|
* @param this A service which provides control over screenshot capture features.
|
|
8748
|
-
* @param
|
|
8898
|
+
* @param captureContent
|
|
8749
8899
|
* @param launchData An optional string to include as launch data in the invite link.
|
|
8750
8900
|
* @param onAcceptedCallback An optional callback function invoked if the user accepts sharing.
|
|
8751
8901
|
* @param onDeniedCallback An optional callback function invoked if the user denies sharing.
|
|
@@ -8755,6 +8905,9 @@ interface CaptureService extends Instance {
|
|
|
8755
8905
|
* - **ThreadSafety**: Unsafe
|
|
8756
8906
|
*
|
|
8757
8907
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#TakeCapture)
|
|
8908
|
+
* @param this A service which provides control over screenshot capture features.
|
|
8909
|
+
* @param onCaptureReady
|
|
8910
|
+
* @param captureParams
|
|
8758
8911
|
*/
|
|
8759
8912
|
TakeCapture(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
|
|
8760
8913
|
/**
|
|
@@ -14297,7 +14450,6 @@ interface Decal extends FaceInstance {
|
|
|
14297
14450
|
Texture: ContentId;
|
|
14298
14451
|
/**
|
|
14299
14452
|
* - **ThreadSafety**: ReadSafe
|
|
14300
|
-
* - **Tags**: Hidden
|
|
14301
14453
|
*
|
|
14302
14454
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#TextureContent)
|
|
14303
14455
|
*/
|
|
@@ -16153,7 +16305,6 @@ interface ImageButton extends GuiButton {
|
|
|
16153
16305
|
* The image content displayed by the UI element. Supports asset URIs and `EditableImage` objects.
|
|
16154
16306
|
*
|
|
16155
16307
|
* - **ThreadSafety**: ReadSafe
|
|
16156
|
-
* - **Tags**: Hidden
|
|
16157
16308
|
*
|
|
16158
16309
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImageButton#ImageContent)
|
|
16159
16310
|
*/
|
|
@@ -16531,7 +16682,6 @@ interface ImageLabel extends GuiLabel {
|
|
|
16531
16682
|
* The image content displayed by the UI element. Supports [asset URIs](../../../projects/assets/index.md#asset-uris) and `EditableImage` objects.
|
|
16532
16683
|
*
|
|
16533
16684
|
* - **ThreadSafety**: ReadSafe
|
|
16534
|
-
* - **Tags**: Hidden
|
|
16535
16685
|
*
|
|
16536
16686
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImageLabel#ImageContent)
|
|
16537
16687
|
*/
|
|
@@ -21884,24 +22034,29 @@ interface HumanoidRigDescription extends Instance {
|
|
|
21884
22034
|
* - **ThreadSafety**: Safe
|
|
21885
22035
|
*
|
|
21886
22036
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Automap)
|
|
22037
|
+
* @param this
|
|
22038
|
+
* @param character
|
|
21887
22039
|
*/
|
|
21888
22040
|
Automap(this: HumanoidRigDescription, character: Instance): void;
|
|
21889
22041
|
/**
|
|
21890
22042
|
* - **ThreadSafety**: Safe
|
|
21891
22043
|
*
|
|
21892
22044
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointNames)
|
|
22045
|
+
* @param this
|
|
21893
22046
|
*/
|
|
21894
22047
|
GetJointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
21895
22048
|
/**
|
|
21896
22049
|
* - **ThreadSafety**: Safe
|
|
21897
22050
|
*
|
|
21898
22051
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR15JointNames)
|
|
22052
|
+
* @param this
|
|
21899
22053
|
*/
|
|
21900
22054
|
GetR15JointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
21901
22055
|
/**
|
|
21902
22056
|
* - **ThreadSafety**: Safe
|
|
21903
22057
|
*
|
|
21904
22058
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR6JointNames)
|
|
22059
|
+
* @param this
|
|
21905
22060
|
*/
|
|
21906
22061
|
GetR6JointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
21907
22062
|
}
|
|
@@ -24753,7 +24908,7 @@ interface MarketplaceService extends Instance {
|
|
|
24753
24908
|
* - `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
24909
|
* - `CurrencySpent` — The amount of currency spent in the transaction.
|
|
24755
24910
|
* - `CurrencyType` — The type of currency spent in the purchase; always `CurrencyType.Robux`.
|
|
24756
|
-
* - `ProductPurchaseChannel` — How the user acquired the developer
|
|
24911
|
+
* - `ProductPurchaseChannel` — How the user acquired the developer product. One of `ProductPurchaseChannel`.
|
|
24757
24912
|
*
|
|
24758
24913
|
*
|
|
24759
24914
|
* @returns An enum that represents how the developer product receipt was processed. - `PurchaseGranted`:
|
|
@@ -24764,6 +24919,39 @@ interface MarketplaceService extends Instance {
|
|
|
24764
24919
|
*/
|
|
24765
24920
|
ProcessReceipt: ((receiptInfo: ReceiptInfo) => Enum.ProductPurchaseDecision) | undefined;
|
|
24766
24921
|
}
|
|
24922
|
+
/**
|
|
24923
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
24924
|
+
*
|
|
24925
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService)
|
|
24926
|
+
*/
|
|
24927
|
+
interface MatchmakingService extends Instance {
|
|
24928
|
+
/**
|
|
24929
|
+
* **DO NOT USE!**
|
|
24930
|
+
*
|
|
24931
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
24932
|
+
* @hidden
|
|
24933
|
+
* @deprecated
|
|
24934
|
+
*/
|
|
24935
|
+
readonly _nominal_MatchmakingService: unique symbol;
|
|
24936
|
+
/**
|
|
24937
|
+
* - **ThreadSafety**: Unsafe
|
|
24938
|
+
*
|
|
24939
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService#GetServerAttribute)
|
|
24940
|
+
*/
|
|
24941
|
+
GetServerAttribute(this: MatchmakingService, name: string): unknown;
|
|
24942
|
+
/**
|
|
24943
|
+
* - **ThreadSafety**: Unsafe
|
|
24944
|
+
*
|
|
24945
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService#InitializeServerAttributesForStudio)
|
|
24946
|
+
*/
|
|
24947
|
+
InitializeServerAttributesForStudio(this: MatchmakingService, serverAttributes: object): unknown;
|
|
24948
|
+
/**
|
|
24949
|
+
* - **ThreadSafety**: Unsafe
|
|
24950
|
+
*
|
|
24951
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService#SetServerAttribute)
|
|
24952
|
+
*/
|
|
24953
|
+
SetServerAttribute(this: MatchmakingService, name: string, value: unknown): unknown;
|
|
24954
|
+
}
|
|
24767
24955
|
/**
|
|
24768
24956
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
24769
24957
|
*
|
|
@@ -27649,7 +27837,6 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
27649
27837
|
* The mesh that is displayed on the `MeshPart`. Supports [asset URIs](../../../projects/assets/index.md#asset-uris) and `EditableMesh` objects.
|
|
27650
27838
|
*
|
|
27651
27839
|
* - **ThreadSafety**: ReadSafe
|
|
27652
|
-
* - **Tags**: Hidden
|
|
27653
27840
|
*
|
|
27654
27841
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MeshPart#MeshContent)
|
|
27655
27842
|
*/
|
|
@@ -27675,7 +27862,6 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
27675
27862
|
* The texture applied to the `MeshPart`. Supports [asset URIs](../../../projects/assets/index.md#asset-uris) and `EditableImage` objects.
|
|
27676
27863
|
*
|
|
27677
27864
|
* - **ThreadSafety**: ReadSafe
|
|
27678
|
-
* - **Tags**: Hidden
|
|
27679
27865
|
*
|
|
27680
27866
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MeshPart#TextureContent)
|
|
27681
27867
|
*/
|
|
@@ -30483,6 +30669,13 @@ interface Player extends Instance {
|
|
|
30483
30669
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#Neutral)
|
|
30484
30670
|
*/
|
|
30485
30671
|
Neutral: boolean;
|
|
30672
|
+
/**
|
|
30673
|
+
* - **ThreadSafety**: ReadSafe
|
|
30674
|
+
* - **Tags**: Hidden, NotReplicated
|
|
30675
|
+
*
|
|
30676
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#PartyId)
|
|
30677
|
+
*/
|
|
30678
|
+
get PartyId(): string;
|
|
30486
30679
|
/**
|
|
30487
30680
|
* Sets the part to focus replication around.
|
|
30488
30681
|
*
|
|
@@ -30552,6 +30745,12 @@ interface Player extends Instance {
|
|
|
30552
30745
|
* @returns The distance in studs between the player and the location.
|
|
30553
30746
|
*/
|
|
30554
30747
|
DistanceFromCharacter(this: Player, point: Vector3): number;
|
|
30748
|
+
/**
|
|
30749
|
+
* - **ThreadSafety**: Unsafe
|
|
30750
|
+
*
|
|
30751
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetData)
|
|
30752
|
+
*/
|
|
30753
|
+
GetData(this: Player): PlayerData;
|
|
30555
30754
|
/**
|
|
30556
30755
|
* Returns a dictionary containing information describing how the `Player` joins the experience.
|
|
30557
30756
|
*
|
|
@@ -30963,10 +31162,11 @@ interface PlayerData extends Instance {
|
|
|
30963
31162
|
GetPlayer(this: PlayerData): Player;
|
|
30964
31163
|
/**
|
|
30965
31164
|
* - **ThreadSafety**: Unsafe
|
|
31165
|
+
* - **Tags**: Yields
|
|
30966
31166
|
*
|
|
30967
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerData#
|
|
31167
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerData#GetRecordAsync)
|
|
30968
31168
|
*/
|
|
30969
|
-
|
|
31169
|
+
GetRecordAsync(this: PlayerData, recordName?: string): PlayerDataRecord;
|
|
30970
31170
|
}
|
|
30971
31171
|
/**
|
|
30972
31172
|
* - **Tags**: NotCreatable, NotReplicated
|
|
@@ -31102,13 +31302,6 @@ interface PlayerDataRecord extends Instance {
|
|
|
31102
31302
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#RequestFlushAsync)
|
|
31103
31303
|
*/
|
|
31104
31304
|
RequestFlushAsync(this: PlayerDataRecord): void;
|
|
31105
|
-
/**
|
|
31106
|
-
* - **ThreadSafety**: Unsafe
|
|
31107
|
-
* - **Tags**: Yields
|
|
31108
|
-
*
|
|
31109
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#WaitForLoadAsync)
|
|
31110
|
-
*/
|
|
31111
|
-
WaitForLoadAsync(this: PlayerDataRecord): void;
|
|
31112
31305
|
/**
|
|
31113
31306
|
* - **ThreadSafety**: Unsafe
|
|
31114
31307
|
*
|
|
@@ -36179,7 +36372,7 @@ interface StyleBase extends Instance {
|
|
|
36179
36372
|
* @param rule
|
|
36180
36373
|
* @param index
|
|
36181
36374
|
*/
|
|
36182
|
-
InsertStyleRule(this: StyleBase, rule: StyleRule,
|
|
36375
|
+
InsertStyleRule(this: StyleBase, rule: StyleRule, priority?: number): void;
|
|
36183
36376
|
/**
|
|
36184
36377
|
* - **ThreadSafety**: Unsafe
|
|
36185
36378
|
*
|
|
@@ -36248,7 +36441,7 @@ interface StyleRule extends StyleBase {
|
|
|
36248
36441
|
* @param this
|
|
36249
36442
|
* @param table
|
|
36250
36443
|
*/
|
|
36251
|
-
SetProperties(this: StyleRule,
|
|
36444
|
+
SetProperties(this: StyleRule, styleProperties: object): void;
|
|
36252
36445
|
/**
|
|
36253
36446
|
* - **ThreadSafety**: Unsafe
|
|
36254
36447
|
*
|
|
@@ -103,6 +103,7 @@ interface Services {
|
|
|
103
103
|
LSPFileSyncService: LSPFileSyncService;
|
|
104
104
|
LuauScriptAnalyzerService: LuauScriptAnalyzerService;
|
|
105
105
|
MarketplaceService: MarketplaceService;
|
|
106
|
+
MatchmakingService: MatchmakingService;
|
|
106
107
|
MaterialGenerationService: MaterialGenerationService;
|
|
107
108
|
MaterialService: MaterialService;
|
|
108
109
|
MemoryStoreService: MemoryStoreService;
|
|
@@ -267,6 +268,7 @@ interface CreatableInstances {
|
|
|
267
268
|
AudioPlayer: AudioPlayer;
|
|
268
269
|
AudioReverb: AudioReverb;
|
|
269
270
|
AudioSearchParams: AudioSearchParams;
|
|
271
|
+
AudioTextToSpeech: AudioTextToSpeech;
|
|
270
272
|
AuroraScript: AuroraScript;
|
|
271
273
|
Backpack: Backpack;
|
|
272
274
|
BallSocketConstraint: BallSocketConstraint;
|
|
@@ -806,7 +808,7 @@ interface EditableMesh extends RBXObject {
|
|
|
806
808
|
readonly _nominal_EditableMesh: unique symbol;
|
|
807
809
|
}
|
|
808
810
|
/**
|
|
809
|
-
* Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
811
|
+
* `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
810
812
|
*
|
|
811
813
|
* - **Tags**: NotCreatable, NotBrowsable
|
|
812
814
|
*
|
|
@@ -837,7 +839,7 @@ interface Instance extends RBXObject {
|
|
|
837
839
|
* - **Tags**: NotBrowsable
|
|
838
840
|
*
|
|
839
841
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetDebugId)
|
|
840
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
842
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
841
843
|
* @param scopeLength The scope length.
|
|
842
844
|
* @returns The Debug ID string.
|
|
843
845
|
*/
|
|
@@ -1760,6 +1762,19 @@ interface AudioSearchParams extends Instance {
|
|
|
1760
1762
|
*/
|
|
1761
1763
|
readonly _nominal_AudioSearchParams: unique symbol;
|
|
1762
1764
|
}
|
|
1765
|
+
/**
|
|
1766
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
|
|
1767
|
+
*/
|
|
1768
|
+
interface AudioTextToSpeech extends Instance {
|
|
1769
|
+
/**
|
|
1770
|
+
* **DO NOT USE!**
|
|
1771
|
+
*
|
|
1772
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1773
|
+
* @hidden
|
|
1774
|
+
* @deprecated
|
|
1775
|
+
*/
|
|
1776
|
+
readonly _nominal_AudioTextToSpeech: unique symbol;
|
|
1777
|
+
}
|
|
1763
1778
|
/**
|
|
1764
1779
|
* - **Tags**: NotCreatable, Service
|
|
1765
1780
|
*
|
|
@@ -2169,7 +2184,6 @@ interface BaseWrap extends Instance {
|
|
|
2169
2184
|
readonly _nominal_BaseWrap: unique symbol;
|
|
2170
2185
|
/**
|
|
2171
2186
|
* - **ThreadSafety**: ReadSafe
|
|
2172
|
-
* - **Tags**: Hidden
|
|
2173
2187
|
*
|
|
2174
2188
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseWrap#CageMeshContent)
|
|
2175
2189
|
*/
|
|
@@ -2238,7 +2252,6 @@ interface WrapLayer extends BaseWrap {
|
|
|
2238
2252
|
set BindOffset(value: CFrame);
|
|
2239
2253
|
/**
|
|
2240
2254
|
* - **ThreadSafety**: ReadSafe
|
|
2241
|
-
* - **Tags**: Hidden
|
|
2242
2255
|
*
|
|
2243
2256
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ReferenceMeshContent)
|
|
2244
2257
|
*/
|
|
@@ -7515,6 +7528,21 @@ interface MarketplaceService extends Instance {
|
|
|
7515
7528
|
*/
|
|
7516
7529
|
readonly _nominal_MarketplaceService: unique symbol;
|
|
7517
7530
|
}
|
|
7531
|
+
/**
|
|
7532
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
7533
|
+
*
|
|
7534
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService)
|
|
7535
|
+
*/
|
|
7536
|
+
interface MatchmakingService extends Instance {
|
|
7537
|
+
/**
|
|
7538
|
+
* **DO NOT USE!**
|
|
7539
|
+
*
|
|
7540
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
7541
|
+
* @hidden
|
|
7542
|
+
* @deprecated
|
|
7543
|
+
*/
|
|
7544
|
+
readonly _nominal_MatchmakingService: unique symbol;
|
|
7545
|
+
}
|
|
7518
7546
|
/**
|
|
7519
7547
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
7520
7548
|
*
|
|
@@ -1672,11 +1672,20 @@ declare namespace Enum {
|
|
|
1672
1672
|
EnumType: typeof globalThis.Enum.AnnotationRequestResult;
|
|
1673
1673
|
}
|
|
1674
1674
|
export const ErrorNotFound: ErrorNotFound;
|
|
1675
|
+
/**
|
|
1676
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestResult#ErrorModerated)
|
|
1677
|
+
*/
|
|
1678
|
+
export interface ErrorModerated extends globalThis.EnumItem {
|
|
1679
|
+
Name: "ErrorModerated";
|
|
1680
|
+
Value: 3;
|
|
1681
|
+
EnumType: typeof globalThis.Enum.AnnotationRequestResult;
|
|
1682
|
+
}
|
|
1683
|
+
export const ErrorModerated: ErrorModerated;
|
|
1675
1684
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AnnotationRequestResult>;
|
|
1676
1685
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnnotationRequestResult | undefined;
|
|
1677
1686
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnnotationRequestResult | undefined;
|
|
1678
1687
|
}
|
|
1679
|
-
export type AnnotationRequestResult = AnnotationRequestResult.Success | AnnotationRequestResult.ErrorInternalFailure | AnnotationRequestResult.ErrorNotFound;
|
|
1688
|
+
export type AnnotationRequestResult = AnnotationRequestResult.Success | AnnotationRequestResult.ErrorInternalFailure | AnnotationRequestResult.ErrorNotFound | AnnotationRequestResult.ErrorModerated;
|
|
1680
1689
|
/**
|
|
1681
1690
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType)
|
|
1682
1691
|
*/
|
|
@@ -17102,6 +17111,8 @@ declare namespace Enum {
|
|
|
17102
17111
|
}
|
|
17103
17112
|
export const Thumbstick2: Thumbstick2;
|
|
17104
17113
|
/**
|
|
17114
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17115
|
+
*
|
|
17105
17116
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseLeftButton)
|
|
17106
17117
|
*/
|
|
17107
17118
|
export interface MouseLeftButton extends globalThis.EnumItem {
|
|
@@ -17111,6 +17122,8 @@ declare namespace Enum {
|
|
|
17111
17122
|
}
|
|
17112
17123
|
export const MouseLeftButton: MouseLeftButton;
|
|
17113
17124
|
/**
|
|
17125
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17126
|
+
*
|
|
17114
17127
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseRightButton)
|
|
17115
17128
|
*/
|
|
17116
17129
|
export interface MouseRightButton extends globalThis.EnumItem {
|
|
@@ -17120,6 +17133,8 @@ declare namespace Enum {
|
|
|
17120
17133
|
}
|
|
17121
17134
|
export const MouseRightButton: MouseRightButton;
|
|
17122
17135
|
/**
|
|
17136
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17137
|
+
*
|
|
17123
17138
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseMiddleButton)
|
|
17124
17139
|
*/
|
|
17125
17140
|
export interface MouseMiddleButton extends globalThis.EnumItem {
|
|
@@ -17129,6 +17144,8 @@ declare namespace Enum {
|
|
|
17129
17144
|
}
|
|
17130
17145
|
export const MouseMiddleButton: MouseMiddleButton;
|
|
17131
17146
|
/**
|
|
17147
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17148
|
+
*
|
|
17132
17149
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseBackButton)
|
|
17133
17150
|
*/
|
|
17134
17151
|
export interface MouseBackButton extends globalThis.EnumItem {
|
|
@@ -17138,6 +17155,8 @@ declare namespace Enum {
|
|
|
17138
17155
|
}
|
|
17139
17156
|
export const MouseBackButton: MouseBackButton;
|
|
17140
17157
|
/**
|
|
17158
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17159
|
+
*
|
|
17141
17160
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseNoButton)
|
|
17142
17161
|
*/
|
|
17143
17162
|
export interface MouseNoButton extends globalThis.EnumItem {
|
|
@@ -17147,6 +17166,8 @@ declare namespace Enum {
|
|
|
17147
17166
|
}
|
|
17148
17167
|
export const MouseNoButton: MouseNoButton;
|
|
17149
17168
|
/**
|
|
17169
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17170
|
+
*
|
|
17150
17171
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseX)
|
|
17151
17172
|
*/
|
|
17152
17173
|
export interface MouseX extends globalThis.EnumItem {
|
|
@@ -17156,6 +17177,8 @@ declare namespace Enum {
|
|
|
17156
17177
|
}
|
|
17157
17178
|
export const MouseX: MouseX;
|
|
17158
17179
|
/**
|
|
17180
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17181
|
+
*
|
|
17159
17182
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseY)
|
|
17160
17183
|
*/
|
|
17161
17184
|
export interface MouseY extends globalThis.EnumItem {
|
|
@@ -24791,11 +24814,20 @@ declare namespace Enum {
|
|
|
24791
24814
|
EnumType: typeof globalThis.Enum.SecurityCapability;
|
|
24792
24815
|
}
|
|
24793
24816
|
export const LegacySound: LegacySound;
|
|
24817
|
+
/**
|
|
24818
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Players)
|
|
24819
|
+
*/
|
|
24820
|
+
export interface Players extends globalThis.EnumItem {
|
|
24821
|
+
Name: "Players";
|
|
24822
|
+
Value: 21;
|
|
24823
|
+
EnumType: typeof globalThis.Enum.SecurityCapability;
|
|
24824
|
+
}
|
|
24825
|
+
export const Players: Players;
|
|
24794
24826
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.SecurityCapability>;
|
|
24795
24827
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.SecurityCapability | undefined;
|
|
24796
24828
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.SecurityCapability | undefined;
|
|
24797
24829
|
}
|
|
24798
|
-
export type SecurityCapability = SecurityCapability.RunClientScript | SecurityCapability.RunServerScript | SecurityCapability.AccessOutsideWrite | SecurityCapability.AssetRequire | SecurityCapability.LoadString | SecurityCapability.ScriptGlobals | SecurityCapability.CreateInstances | SecurityCapability.Basic | SecurityCapability.Audio | SecurityCapability.DataStore | SecurityCapability.Network | SecurityCapability.Physics | SecurityCapability.UI | SecurityCapability.CSG | SecurityCapability.Chat | SecurityCapability.Animation | SecurityCapability.Avatar | SecurityCapability.Input | SecurityCapability.Environment | SecurityCapability.RemoteEvent | SecurityCapability.LegacySound;
|
|
24830
|
+
export type SecurityCapability = SecurityCapability.RunClientScript | SecurityCapability.RunServerScript | SecurityCapability.AccessOutsideWrite | SecurityCapability.AssetRequire | SecurityCapability.LoadString | SecurityCapability.ScriptGlobals | SecurityCapability.CreateInstances | SecurityCapability.Basic | SecurityCapability.Audio | SecurityCapability.DataStore | SecurityCapability.Network | SecurityCapability.Physics | SecurityCapability.UI | SecurityCapability.CSG | SecurityCapability.Chat | SecurityCapability.Animation | SecurityCapability.Avatar | SecurityCapability.Input | SecurityCapability.Environment | SecurityCapability.RemoteEvent | SecurityCapability.LegacySound | SecurityCapability.Players;
|
|
24799
24831
|
/**
|
|
24800
24832
|
* Customization options for gamepad selection when `GuiBase2d.SelectionGroup` is true.
|
|
24801
24833
|
*
|