@rbxts/types 1.0.621 → 1.0.624
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 +13 -10
- package/include/generated/PluginSecurity.d.ts +0 -218
- package/include/roblox.d.ts +51 -39
- package/package.json +1 -1
|
@@ -21069,26 +21069,29 @@ interface MarketplaceService extends Instance {
|
|
|
21069
21069
|
* * [Monetization Guides](https://developer.roblox.com/learn-roblox/monetization), learning materials related to monetizing your game
|
|
21070
21070
|
* Tags: Yields
|
|
21071
21071
|
*/
|
|
21072
|
+
GetProductInfo(this: MarketplaceService, id: number): AssetProductInfo;
|
|
21073
|
+
GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Asset>): AssetProductInfo;
|
|
21074
|
+
GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Bundle>): BundleInfo;
|
|
21072
21075
|
GetProductInfo(
|
|
21073
21076
|
this: MarketplaceService,
|
|
21074
|
-
|
|
21075
|
-
infoType: CastsToEnum<Enum.InfoType.
|
|
21076
|
-
):
|
|
21077
|
+
id: number,
|
|
21078
|
+
infoType: CastsToEnum<Enum.InfoType.GamePass>,
|
|
21079
|
+
): GamePassProductInfo;
|
|
21077
21080
|
GetProductInfo(
|
|
21078
21081
|
this: MarketplaceService,
|
|
21079
|
-
|
|
21082
|
+
id: number,
|
|
21080
21083
|
infoType: CastsToEnum<Enum.InfoType.Product>,
|
|
21081
21084
|
): DeveloperProductInfo;
|
|
21082
21085
|
GetProductInfo(
|
|
21083
21086
|
this: MarketplaceService,
|
|
21084
|
-
|
|
21085
|
-
infoType: CastsToEnum<Enum.InfoType.
|
|
21086
|
-
):
|
|
21087
|
+
id: number,
|
|
21088
|
+
infoType: CastsToEnum<Enum.InfoType.Subscription>,
|
|
21089
|
+
): SubscriptionProductInfo;
|
|
21087
21090
|
GetProductInfo(
|
|
21088
21091
|
this: MarketplaceService,
|
|
21089
|
-
|
|
21090
|
-
infoType
|
|
21091
|
-
): AssetProductInfo | DeveloperProductInfo;
|
|
21092
|
+
id: number,
|
|
21093
|
+
infoType?: CastsToEnum<Enum.InfoType>,
|
|
21094
|
+
): AssetProductInfo | BundleInfo | GamePassProductInfo | DeveloperProductInfo | SubscriptionProductInfo;
|
|
21092
21095
|
/**
|
|
21093
21096
|
* Tags: Yields
|
|
21094
21097
|
*/
|
|
@@ -106,22 +106,6 @@ interface ABTestService extends Instance {
|
|
|
106
106
|
* @deprecated
|
|
107
107
|
*/
|
|
108
108
|
readonly _nominal_ABTestService: unique symbol;
|
|
109
|
-
ClearUserVariations(this: ABTestService): void;
|
|
110
|
-
GetBrowserTrackerABTestLoadingStatus(this: ABTestService): Enum.ABTestLoadingStatus;
|
|
111
|
-
GetPendingOrInitializedUserId(this: ABTestService): number;
|
|
112
|
-
GetUserABTestLoadingStatus(this: ABTestService): Enum.ABTestLoadingStatus;
|
|
113
|
-
GetVariant(this: ABTestService, name: string): string;
|
|
114
|
-
InitializeForUserId(this: ABTestService, userId: number): void;
|
|
115
|
-
/**
|
|
116
|
-
* Tags: Yields
|
|
117
|
-
*/
|
|
118
|
-
WaitUntilBrowserTrackerABTestsInitialized(this: ABTestService): void;
|
|
119
|
-
/**
|
|
120
|
-
* Tags: Yields
|
|
121
|
-
*/
|
|
122
|
-
WaitUntilUserABTestsInitialized(this: ABTestService): void;
|
|
123
|
-
readonly OnBrowserTrackerABTestLoadingStatusChanged: RBXScriptSignal<(status: Enum.ABTestLoadingStatus) => void>;
|
|
124
|
-
readonly OnUserABTestLoadingStatusChanged: RBXScriptSignal<(status: Enum.ABTestLoadingStatus, userId: number) => void>;
|
|
125
109
|
}
|
|
126
110
|
|
|
127
111
|
interface KeyframeSequence extends AnimationClip {
|
|
@@ -197,15 +181,11 @@ interface CoreGui extends BasePlayerGui {
|
|
|
197
181
|
* @deprecated
|
|
198
182
|
*/
|
|
199
183
|
readonly _nominal_CoreGui: unique symbol;
|
|
200
|
-
readonly SelectionImageObject: GuiObject | undefined;
|
|
201
184
|
/**
|
|
202
185
|
* The current version of the CoreGui. Everytime the CoreGui is majorly changed, this number is increased.
|
|
203
186
|
* Tags: ReadOnly, NotReplicated
|
|
204
187
|
*/
|
|
205
188
|
readonly Version: number;
|
|
206
|
-
SetUserGuiRendering(this: CoreGui, enabled: boolean, guiAdornee: Instance, faceId: CastsToEnum<Enum.NormalId>): void;
|
|
207
|
-
TakeScreenshot(this: CoreGui): void;
|
|
208
|
-
ToggleRecording(this: CoreGui): void;
|
|
209
189
|
}
|
|
210
190
|
|
|
211
191
|
interface StarterGui extends BasePlayerGui {
|
|
@@ -285,18 +265,6 @@ interface DataModelSession extends Instance {
|
|
|
285
265
|
* @deprecated
|
|
286
266
|
*/
|
|
287
267
|
readonly _nominal_DataModelSession: unique symbol;
|
|
288
|
-
/**
|
|
289
|
-
* Tags: Hidden, ReadOnly, NotReplicated
|
|
290
|
-
*/
|
|
291
|
-
readonly CurrentDataModelType: Enum.StudioDataModelType;
|
|
292
|
-
/**
|
|
293
|
-
* Tags: Hidden, ReadOnly, NotReplicated
|
|
294
|
-
*/
|
|
295
|
-
readonly SessionId: string;
|
|
296
|
-
readonly CurrentDataModelTypeAboutToChange: RBXScriptSignal<(dataModelType: Enum.StudioDataModelType) => void>;
|
|
297
|
-
readonly CurrentDataModelTypeChanged: RBXScriptSignal<() => void>;
|
|
298
|
-
readonly DataModelCreated: RBXScriptSignal<(gameStateType: Enum.StudioDataModelType) => void>;
|
|
299
|
-
readonly DataModelWillBeDestroyed: RBXScriptSignal<(gameStateType: Enum.StudioDataModelType) => void>;
|
|
300
268
|
}
|
|
301
269
|
|
|
302
270
|
/** The DebugSettings allows you to view diagnostics information regarding Roblox. It is labeled as **Diagnostics** in the Roblox Studio Settings menu. */
|
|
@@ -411,10 +379,6 @@ interface DebuggerManager extends Instance {
|
|
|
411
379
|
* Registers a script to be used in the Lua Debugger. Returns a [ScriptDebugger](https://developer.roblox.com/en-us/api-reference/class/ScriptDebugger) for the script.
|
|
412
380
|
*/
|
|
413
381
|
AddDebugger(this: DebuggerManager, script: LuaSourceContainer): Instance | undefined;
|
|
414
|
-
/**
|
|
415
|
-
* Enables the DebuggerManager.
|
|
416
|
-
*/
|
|
417
|
-
EnableDebugging(this: DebuggerManager): void;
|
|
418
382
|
/**
|
|
419
383
|
* Returns a list of [ScriptDebugger](https://developer.roblox.com/en-us/api-reference/class/ScriptDebugger) present in the experience.
|
|
420
384
|
*/
|
|
@@ -769,11 +733,6 @@ interface GameSettings extends Instance {
|
|
|
769
733
|
* Toggles whether or not video capture is enabled.
|
|
770
734
|
*/
|
|
771
735
|
VideoCaptureEnabled: boolean;
|
|
772
|
-
/**
|
|
773
|
-
* Tags: NotReplicated
|
|
774
|
-
*/
|
|
775
|
-
readonly VideoRecording: boolean;
|
|
776
|
-
readonly VideoRecordingChangeRequest: RBXScriptSignal<(recording: boolean) => void>;
|
|
777
736
|
}
|
|
778
737
|
|
|
779
738
|
/** PluginGui is an abstract class for GUIs that allow the display of [GuiObjects](https://developer.roblox.com/en-us/api-reference/class/GuiObject) in various Roblox Studio widgets. As of right now, the only available PluginGui type is [DockWidgetPluginGui](https://developer.roblox.com/en-us/api-reference/class/DockWidgetPluginGui), but there may be more in the future! */
|
|
@@ -1085,12 +1044,6 @@ interface MultipleDocumentInterfaceInstance extends Instance {
|
|
|
1085
1044
|
* @deprecated
|
|
1086
1045
|
*/
|
|
1087
1046
|
readonly _nominal_MultipleDocumentInterfaceInstance: unique symbol;
|
|
1088
|
-
/**
|
|
1089
|
-
* Tags: Hidden, ReadOnly, NotReplicated
|
|
1090
|
-
*/
|
|
1091
|
-
readonly FocusedDataModelSession: Instance | undefined;
|
|
1092
|
-
readonly DataModelSessionEnded: RBXScriptSignal<(dataModelSession: DataModelSession) => void>;
|
|
1093
|
-
readonly DataModelSessionStarted: RBXScriptSignal<(dataModelSession: DataModelSession) => void>;
|
|
1094
1047
|
}
|
|
1095
1048
|
|
|
1096
1049
|
/** The NetworkPeer object is the most basic class of the network objects. */
|
|
@@ -1544,7 +1497,6 @@ interface PhysicsSettings extends Instance {
|
|
|
1544
1497
|
*/
|
|
1545
1498
|
AreRegionsShown: boolean;
|
|
1546
1499
|
AreTerrainReplicationRegionsShown: boolean;
|
|
1547
|
-
readonly AreTimestepsShown: boolean;
|
|
1548
1500
|
/**
|
|
1549
1501
|
* When set to true, parts that aren't aligned on the 1x1x1 grid will be outlined yellow.
|
|
1550
1502
|
*/
|
|
@@ -1750,22 +1702,6 @@ interface Plugin extends Instance {
|
|
|
1750
1702
|
* Tags: ReadOnly, NotReplicated
|
|
1751
1703
|
*/
|
|
1752
1704
|
readonly GridSize: number;
|
|
1753
|
-
/**
|
|
1754
|
-
* Tags: Hidden, ReadOnly, NotReplicated
|
|
1755
|
-
*/
|
|
1756
|
-
readonly HostDataModelType: Enum.StudioDataModelType;
|
|
1757
|
-
/**
|
|
1758
|
-
* Tags: Hidden, ReadOnly, NotReplicated
|
|
1759
|
-
*/
|
|
1760
|
-
readonly HostDataModelTypeIsCurrent: boolean;
|
|
1761
|
-
/**
|
|
1762
|
-
* Tags: Hidden, ReadOnly, NotReplicated
|
|
1763
|
-
*/
|
|
1764
|
-
readonly MultipleDocumentInterfaceInstance: MultipleDocumentInterfaceInstance | undefined;
|
|
1765
|
-
/**
|
|
1766
|
-
* Tags: Hidden, NotReplicated
|
|
1767
|
-
*/
|
|
1768
|
-
readonly UsesAssetInsertionDrag: boolean;
|
|
1769
1705
|
/**
|
|
1770
1706
|
* This function sets the state of the calling plugin to activated. Activating the plugin allows mouse control through the [Plugin:GetMouse](https://developer.roblox.com/en-us/api-reference/function/Plugin/GetMouse) method.
|
|
1771
1707
|
*
|
|
@@ -1838,7 +1774,6 @@ interface Plugin extends Instance {
|
|
|
1838
1774
|
* * [Plugin.Unloading](https://developer.roblox.com/en-us/api-reference/event/Plugin/Unloading), fires immediately before the plugin is unloaded or reloaded via uninstallation, deactivation, or updating
|
|
1839
1775
|
*/
|
|
1840
1776
|
Deactivate(this: Plugin): void;
|
|
1841
|
-
GetItem(this: Plugin, key: string, defaultValue: unknown): unknown;
|
|
1842
1777
|
/**
|
|
1843
1778
|
* Returns the [JointCreationMode](https://developer.roblox.com/en-us/api-reference/enum/JointCreationMode) the user has set in studio under the Model tab.
|
|
1844
1779
|
*/
|
|
@@ -1861,7 +1796,6 @@ interface Plugin extends Instance {
|
|
|
1861
1796
|
* @deprecated
|
|
1862
1797
|
*/
|
|
1863
1798
|
GetStudioUserId(this: Plugin): number;
|
|
1864
|
-
Invoke(this: Plugin, key: string, arguments: Array<any>): void;
|
|
1865
1799
|
/**
|
|
1866
1800
|
* This function returns true if this plugin is currently active, after having been activated via the [Plugin:Activate](https://developer.roblox.com/en-us/api-reference/function/Plugin/Activate) function.
|
|
1867
1801
|
*/
|
|
@@ -1880,8 +1814,6 @@ interface Plugin extends Instance {
|
|
|
1880
1814
|
* Negates the given parts and returns the resulting NegateOperations.
|
|
1881
1815
|
*/
|
|
1882
1816
|
Negate(this: Plugin, objects: Array<Instance>): Array<Instance>;
|
|
1883
|
-
OnInvoke(this: Plugin, key: string, callback: Callback): Instance | undefined;
|
|
1884
|
-
OnSetItem(this: Plugin, key: string, callback: Callback): Instance | undefined;
|
|
1885
1817
|
/**
|
|
1886
1818
|
* Used to open the given script instance in an editor window, in Roblox studio, at the given line. If no line is given as an argument it will default to 0.
|
|
1887
1819
|
*/
|
|
@@ -1890,9 +1822,6 @@ interface Plugin extends Instance {
|
|
|
1890
1822
|
* Opens the context help window to the wiki page that `url` links to.
|
|
1891
1823
|
*/
|
|
1892
1824
|
OpenWikiPage(this: Plugin, url: string): void;
|
|
1893
|
-
PauseSound(this: Plugin, sound: Sound): void;
|
|
1894
|
-
PlaySound(this: Plugin, sound: Sound, normalizedTimePosition?: number): void;
|
|
1895
|
-
ResumeSound(this: Plugin, sound: Sound): void;
|
|
1896
1825
|
/**
|
|
1897
1826
|
* Opens an upload window for the user's current selection.
|
|
1898
1827
|
*/
|
|
@@ -1912,13 +1841,10 @@ interface Plugin extends Instance {
|
|
|
1912
1841
|
* Separates the given UnionOperations and returns the resulting parts.
|
|
1913
1842
|
*/
|
|
1914
1843
|
Separate(this: Plugin, objects: Array<Instance>): Array<Instance>;
|
|
1915
|
-
SetItem(this: Plugin, key: string, value: unknown): void;
|
|
1916
|
-
SetReady(this: Plugin): void;
|
|
1917
1844
|
/**
|
|
1918
1845
|
* Stores a given value for later use under the given key. The value will persist even after studio is closed.
|
|
1919
1846
|
*/
|
|
1920
1847
|
SetSetting(this: Plugin, key: string, value: unknown): void;
|
|
1921
|
-
StartDecalDrag(this: Plugin, decal: Decal): void;
|
|
1922
1848
|
/**
|
|
1923
1849
|
* **StartDrag** initiates a drag action using a dictionary of parameters. The parameters are as follows:
|
|
1924
1850
|
*
|
|
@@ -1988,7 +1914,6 @@ interface Plugin extends Instance {
|
|
|
1988
1914
|
* * [PluginGui.PluginDragLeft](https://developer.roblox.com/en-us/api-reference/event/PluginGui/PluginDragLeft)
|
|
1989
1915
|
*/
|
|
1990
1916
|
StartDrag(this: Plugin, dragData: object): void;
|
|
1991
|
-
StopAllSounds(this: Plugin): void;
|
|
1992
1917
|
/**
|
|
1993
1918
|
* Unions the given parts and returns the resulting UnionOperation.
|
|
1994
1919
|
*/
|
|
@@ -2007,10 +1932,6 @@ interface Plugin extends Instance {
|
|
|
2007
1932
|
pluginGuiId: string,
|
|
2008
1933
|
dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo,
|
|
2009
1934
|
): DockWidgetPluginGui;
|
|
2010
|
-
/**
|
|
2011
|
-
* Tags: Yields
|
|
2012
|
-
*/
|
|
2013
|
-
CreateQWidgetPluginGui(this: Plugin, pluginGuiId: string, pluginGuiOptions: object): QWidgetPluginGui;
|
|
2014
1935
|
/**
|
|
2015
1936
|
* This function prompts the user to open a .fbx animation file that can be loaded onto the _rigModel_, then proceeds to insert the animation as a [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) in the [Workspace](https://developer.roblox.com/en-us/api-reference/class/Workspace).
|
|
2016
1937
|
* Tags: Yields
|
|
@@ -2040,7 +1961,6 @@ interface Plugin extends Instance {
|
|
|
2040
1961
|
* * [Plugin.Unloading](https://developer.roblox.com/en-us/api-reference/event/Plugin/Unloading), fires immediately before the plugin is unloaded or reloaded via uninstallation, deactivation, or updating
|
|
2041
1962
|
*/
|
|
2042
1963
|
readonly Deactivation: RBXScriptSignal<() => void>;
|
|
2043
|
-
readonly Ready: RBXScriptSignal<() => void>;
|
|
2044
1964
|
/**
|
|
2045
1965
|
* This event fires immediately before the [Plugin](https://developer.roblox.com/en-us/api-reference/class/Plugin) stops running. Plugins are unloaded when disabled, uninstalled, about to be updated, or when the place is closing.
|
|
2046
1966
|
*
|
|
@@ -2054,14 +1974,6 @@ interface Plugin extends Instance {
|
|
|
2054
1974
|
* [Intro to Plugins](https://developer.roblox.com/en-us/articles/intro-to-plugins), an introductory article to plugin use and development
|
|
2055
1975
|
*/
|
|
2056
1976
|
readonly Unloading: RBXScriptSignal<() => void>;
|
|
2057
|
-
/**
|
|
2058
|
-
* Tags: NoYield
|
|
2059
|
-
*/
|
|
2060
|
-
ProcessAssetInsertionDrag: (assetId: string, assetTypeId: number, instances: Array<Instance>) => void;
|
|
2061
|
-
/**
|
|
2062
|
-
* Tags: NoYield
|
|
2063
|
-
*/
|
|
2064
|
-
ProcessAssetInsertionDrop: () => void;
|
|
2065
1977
|
}
|
|
2066
1978
|
|
|
2067
1979
|
/** PluginAction is an object that represents a generic performable action in Roblox Studio, with no directly associated `Toolbar` or `Button`. In Roblox Studio, they can be assigned a keyboard shortcut under `File → Advanced → Customize Shortcuts...`, and they can also be added to the Quick Access Toolbar.
|
|
@@ -2092,18 +2004,6 @@ interface PluginAction extends Instance {
|
|
|
2092
2004
|
* Tags: ReadOnly, NotReplicated
|
|
2093
2005
|
*/
|
|
2094
2006
|
readonly AllowBinding: boolean;
|
|
2095
|
-
/**
|
|
2096
|
-
* Tags: Hidden, NotReplicated
|
|
2097
|
-
*/
|
|
2098
|
-
readonly Checked: boolean;
|
|
2099
|
-
/**
|
|
2100
|
-
* Tags: Hidden, NotReplicated
|
|
2101
|
-
*/
|
|
2102
|
-
readonly DefaultShortcut: string;
|
|
2103
|
-
/**
|
|
2104
|
-
* Tags: Hidden, NotReplicated
|
|
2105
|
-
*/
|
|
2106
|
-
readonly Enabled: boolean;
|
|
2107
2007
|
/**
|
|
2108
2008
|
* The description of the action, when viewing it from the keyboard shortcuts window in Roblox Studio.
|
|
2109
2009
|
* Tags: ReadOnly, NotReplicated
|
|
@@ -2828,16 +2728,11 @@ interface Selection extends Instance {
|
|
|
2828
2728
|
* @deprecated
|
|
2829
2729
|
*/
|
|
2830
2730
|
readonly _nominal_Selection: unique symbol;
|
|
2831
|
-
/**
|
|
2832
|
-
* Tags: Hidden, ReadOnly, NotReplicated
|
|
2833
|
-
*/
|
|
2834
|
-
readonly ActiveInstance: Instance | undefined;
|
|
2835
2731
|
/**
|
|
2836
2732
|
* Tags: ReadOnly, NotReplicated
|
|
2837
2733
|
*/
|
|
2838
2734
|
readonly SelectionThickness: number;
|
|
2839
2735
|
Add(this: Selection, instancesToAdd: Array<Instance>): void;
|
|
2840
|
-
ClearTerrainSelectionHack(this: Selection): void;
|
|
2841
2736
|
/**
|
|
2842
2737
|
* Returns an array of currently selected [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance)s in Roblox Studio.
|
|
2843
2738
|
*
|
|
@@ -2861,7 +2756,6 @@ interface Selection extends Instance {
|
|
|
2861
2756
|
* Selection:Set(selected)
|
|
2862
2757
|
*/
|
|
2863
2758
|
Set(this: Selection, selection: Array<Instance>): void;
|
|
2864
|
-
SetTerrainSelectionHack(this: Selection, center: Vector3, size: Vector3): void;
|
|
2865
2759
|
/**
|
|
2866
2760
|
* Fires when the [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance)s selected in Roblox Studio changes.
|
|
2867
2761
|
*
|
|
@@ -3133,7 +3027,6 @@ interface Studio extends Instance {
|
|
|
3133
3027
|
*/
|
|
3134
3028
|
["Built-in Function Color"]: Color3;
|
|
3135
3029
|
["Camera Mouse Wheel Speed"]: number;
|
|
3136
|
-
readonly ["Camera Pan Speed"]: number;
|
|
3137
3030
|
["Camera Shift Speed"]: number;
|
|
3138
3031
|
["Camera Speed"]: number;
|
|
3139
3032
|
["Camera Zoom to Mouse Position"]: boolean;
|
|
@@ -3163,29 +3056,14 @@ interface Studio extends Instance {
|
|
|
3163
3056
|
* If set to true, deprecated objects will be shown in the Advanced Objects window, as well as the Object Browser.
|
|
3164
3057
|
*/
|
|
3165
3058
|
DeprecatedObjectsShown: boolean;
|
|
3166
|
-
readonly DisplayLanguage: string;
|
|
3167
|
-
/**
|
|
3168
|
-
* Tags: Hidden, NotReplicated
|
|
3169
|
-
*/
|
|
3170
|
-
readonly ["Doc View Code Background Color"]: Color3;
|
|
3171
3059
|
["Drag Multiple Parts As Single Part"]: boolean;
|
|
3172
3060
|
["Enable Autocomplete"]: boolean;
|
|
3173
|
-
readonly ["Enable Autocomplete Doc View"]: boolean;
|
|
3174
3061
|
["Enable CoreScript Debugger"]: boolean;
|
|
3175
3062
|
["Enable Http Sandboxing"]: boolean;
|
|
3176
3063
|
["Enable Internal Beta Features"]: boolean;
|
|
3177
3064
|
["Enable Internal Features"]: boolean;
|
|
3178
|
-
readonly ["Enable Script Analysis"]: boolean;
|
|
3179
|
-
readonly ["Enable Scrollbar Markers"]: boolean;
|
|
3180
|
-
readonly ["Enable Signature Help"]: boolean;
|
|
3181
|
-
readonly ["Enable Signature Help Doc View"]: boolean;
|
|
3182
3065
|
["Enable Temporary Tabs"]: boolean;
|
|
3183
3066
|
["Enable Temporary Tabs In Explorer"]: boolean;
|
|
3184
|
-
readonly ["Enable Type Hover"]: boolean;
|
|
3185
|
-
/**
|
|
3186
|
-
* Tags: Hidden, NotReplicated
|
|
3187
|
-
*/
|
|
3188
|
-
readonly EnableOnTypeAutocomplete: boolean;
|
|
3189
3067
|
/**
|
|
3190
3068
|
* Tags: NotReplicated
|
|
3191
3069
|
*/
|
|
@@ -3207,9 +3085,7 @@ interface Studio extends Instance {
|
|
|
3207
3085
|
["Highlight Current Line"]: boolean;
|
|
3208
3086
|
["Highlight Occurances"]: boolean;
|
|
3209
3087
|
["Hover Animate Speed"]: Enum.HoverAnimateSpeed;
|
|
3210
|
-
readonly ["Hover Box Thickness"]: number;
|
|
3211
3088
|
["Hover Over Color"]: Color3;
|
|
3212
|
-
readonly IconOverrideDir: QDir;
|
|
3213
3089
|
["Indent Using Spaces"]: boolean;
|
|
3214
3090
|
/**
|
|
3215
3091
|
* Tags: NotReplicated
|
|
@@ -3229,7 +3105,6 @@ interface Studio extends Instance {
|
|
|
3229
3105
|
* Tags: NotReplicated
|
|
3230
3106
|
*/
|
|
3231
3107
|
["Luau Keyword Color"]: Color3;
|
|
3232
|
-
readonly ["Main Volume"]: number;
|
|
3233
3108
|
/**
|
|
3234
3109
|
* Tags: NotReplicated
|
|
3235
3110
|
*/
|
|
@@ -3259,8 +3134,6 @@ interface Studio extends Instance {
|
|
|
3259
3134
|
* See [PermissionLevelShown](https://developer.roblox.com/en-us/api-reference/enum/PermissionLevelShown) for more info.
|
|
3260
3135
|
*/
|
|
3261
3136
|
PermissionLevelShown: Enum.PermissionLevelShown;
|
|
3262
|
-
readonly ["Physical Draggers Select Scope By Default"]: boolean;
|
|
3263
|
-
readonly ["Pivot Snap To Geometry Color"]: Color3;
|
|
3264
3137
|
PluginDebuggingEnabled: boolean;
|
|
3265
3138
|
/**
|
|
3266
3139
|
* The directory where local plugins are stored.
|
|
@@ -3291,14 +3164,6 @@ interface Studio extends Instance {
|
|
|
3291
3164
|
* Tags: NotReplicated
|
|
3292
3165
|
*/
|
|
3293
3166
|
["Script Editor Scrollbar Handle Color"]: Color3;
|
|
3294
|
-
/**
|
|
3295
|
-
* Tags: Hidden, NotReplicated
|
|
3296
|
-
*/
|
|
3297
|
-
readonly ScriptEditorMenuBorderColor: Color3;
|
|
3298
|
-
/**
|
|
3299
|
-
* Tags: Hidden, NotReplicated
|
|
3300
|
-
*/
|
|
3301
|
-
readonly ScriptEditorShouldShowPluginMethods: boolean;
|
|
3302
3167
|
/**
|
|
3303
3168
|
* The time (in seconds) a script can wait to be resumed before timing out.
|
|
3304
3169
|
*/
|
|
@@ -3327,7 +3192,6 @@ interface Studio extends Instance {
|
|
|
3327
3192
|
* Tags: NotReplicated
|
|
3328
3193
|
*/
|
|
3329
3194
|
["Selection Color"]: Color3;
|
|
3330
|
-
readonly ["Selection Highlight Thickness"]: number;
|
|
3331
3195
|
["Server Audio Behavior"]: Enum.ServerAudioBehavior;
|
|
3332
3196
|
["Set Pivot of Imported Parts"]: boolean;
|
|
3333
3197
|
["Show Core GUI in Explorer while Playing"]: boolean;
|
|
@@ -3336,15 +3200,11 @@ interface Studio extends Instance {
|
|
|
3336
3200
|
["Show FileSyncService"]: boolean;
|
|
3337
3201
|
["Show Hidden Objects in Explorer"]: boolean;
|
|
3338
3202
|
["Show Hover Over"]: boolean;
|
|
3339
|
-
readonly ["Show Light Guides"]: boolean;
|
|
3340
|
-
readonly ["Show Navigation Labels"]: boolean;
|
|
3341
3203
|
["Show Navigation Mesh"]: boolean;
|
|
3342
|
-
readonly ["Show Pathfinding Links"]: boolean;
|
|
3343
3204
|
["Show Plugin GUI Service in Explorer"]: boolean;
|
|
3344
3205
|
["Show QT warnings in output"]: boolean;
|
|
3345
3206
|
["Show Whitespace"]: boolean;
|
|
3346
3207
|
["Show plus button on hover in Explorer"]: boolean;
|
|
3347
|
-
readonly ShowCorePackagesInExplorer: boolean;
|
|
3348
3208
|
["Skip Closing Brackets and Quotes"]: boolean;
|
|
3349
3209
|
/**
|
|
3350
3210
|
* Tags: NotReplicated
|
|
@@ -3373,7 +3233,6 @@ interface Studio extends Instance {
|
|
|
3373
3233
|
* @deprecated
|
|
3374
3234
|
*/
|
|
3375
3235
|
readonly ["UI Theme"]: Enum.UITheme;
|
|
3376
|
-
readonly ["Use Bounding Box Move Handles"]: boolean;
|
|
3377
3236
|
/**
|
|
3378
3237
|
* Tags: NotReplicated
|
|
3379
3238
|
*/
|
|
@@ -3405,18 +3264,6 @@ interface StudioData extends Instance {
|
|
|
3405
3264
|
* @deprecated
|
|
3406
3265
|
*/
|
|
3407
3266
|
readonly _nominal_StudioData: unique symbol;
|
|
3408
|
-
/**
|
|
3409
|
-
* Tags: Hidden
|
|
3410
|
-
*/
|
|
3411
|
-
readonly EnableScriptCollabByDefaultOnLoad: boolean;
|
|
3412
|
-
/**
|
|
3413
|
-
* Tags: Hidden, NotReplicated
|
|
3414
|
-
*/
|
|
3415
|
-
readonly SrcPlaceId: number;
|
|
3416
|
-
/**
|
|
3417
|
-
* Tags: Hidden, NotReplicated
|
|
3418
|
-
*/
|
|
3419
|
-
readonly SrcUniverseId: number;
|
|
3420
3267
|
}
|
|
3421
3268
|
|
|
3422
3269
|
/** StudioService provides access to configuration of Roblox Studio, allows importing files from the user's file system, and other miscellaneous information. It is intended to be used by [Plugin](https://developer.roblox.com/en-us/api-reference/class/Plugin)s in order to provide a consistent user experience.
|
|
@@ -3452,10 +3299,6 @@ interface StudioService extends Instance {
|
|
|
3452
3299
|
* Tags: ReadOnly, NotReplicated
|
|
3453
3300
|
*/
|
|
3454
3301
|
readonly ActiveScript: Instance | undefined;
|
|
3455
|
-
/**
|
|
3456
|
-
* Tags: Hidden, ReadOnly, NotReplicated
|
|
3457
|
-
*/
|
|
3458
|
-
readonly AlignDraggedObjects: boolean;
|
|
3459
3302
|
/**
|
|
3460
3303
|
* Tags: ReadOnly, NotReplicated
|
|
3461
3304
|
*/
|
|
@@ -3471,18 +3314,6 @@ interface StudioService extends Instance {
|
|
|
3471
3314
|
* Tags: ReadOnly, NotReplicated
|
|
3472
3315
|
*/
|
|
3473
3316
|
readonly GridSize: number;
|
|
3474
|
-
/**
|
|
3475
|
-
* Tags: Hidden, NotReplicated
|
|
3476
|
-
*/
|
|
3477
|
-
readonly HoverInstance: Instance | undefined;
|
|
3478
|
-
/**
|
|
3479
|
-
* Tags: Hidden, ReadOnly, NotReplicated
|
|
3480
|
-
*/
|
|
3481
|
-
readonly InstalledPluginData: string;
|
|
3482
|
-
/**
|
|
3483
|
-
* Tags: Hidden, ReadOnly, NotReplicated
|
|
3484
|
-
*/
|
|
3485
|
-
readonly PivotSnapToGeometry: boolean;
|
|
3486
3317
|
/**
|
|
3487
3318
|
* **RotateIncrement** determines the angle in degrees by which studio's rotation tool will rotate selected objects each tick. This is set by the user Model tab under the “Snap to Grid” section.
|
|
3488
3319
|
*
|
|
@@ -3504,10 +3335,6 @@ interface StudioService extends Instance {
|
|
|
3504
3335
|
* Tags: ReadOnly, NotReplicated
|
|
3505
3336
|
*/
|
|
3506
3337
|
readonly RotateIncrement: number;
|
|
3507
|
-
/**
|
|
3508
|
-
* Tags: Hidden, NotReplicated
|
|
3509
|
-
*/
|
|
3510
|
-
readonly ShowActiveInstanceHighlight: boolean;
|
|
3511
3338
|
/**
|
|
3512
3339
|
* Tags: ReadOnly, NotReplicated
|
|
3513
3340
|
*/
|
|
@@ -3555,15 +3382,6 @@ interface StudioService extends Instance {
|
|
|
3555
3382
|
* Tags: NotReplicated
|
|
3556
3383
|
*/
|
|
3557
3384
|
UseLocalSpace: boolean;
|
|
3558
|
-
AnimationIdSelected(this: StudioService, id: number): void;
|
|
3559
|
-
CopyToClipboard(this: StudioService, stringToCopy: string): void;
|
|
3560
|
-
DEPRECATED_EmitPlacePublishedSignal(this: StudioService): void;
|
|
3561
|
-
DEPRECATED_RefreshDocumentDisplayName(this: StudioService): void;
|
|
3562
|
-
DEPRECATED_SetUniverseDisplayName(this: StudioService, newName: string): void;
|
|
3563
|
-
DEPRECATED_ShowSaveOrPublishPlaceToRoblox(this: StudioService, showGameSelect: boolean, isPublish: boolean, closeMode: CastsToEnum<Enum.StudioCloseMode>): void;
|
|
3564
|
-
DEPRECATED_publishAs(this: StudioService, universeId: number, placeId: number, groupId: number): void;
|
|
3565
|
-
GetBadgeConfigureUrl(this: StudioService, badgeId: number): string;
|
|
3566
|
-
GetBadgeUploadUrl(this: StudioService): string;
|
|
3567
3385
|
/**
|
|
3568
3386
|
* **GetClassIcon** provides a dictionary that allows the display of a class' Explorer window icon, e.g. calling this function with “Part” returns property values that display the part icon from the Explorer window.
|
|
3569
3387
|
*
|
|
@@ -3587,26 +3405,11 @@ interface StudioService extends Instance {
|
|
|
3587
3405
|
* displayClassIcon(imageLabel, "Part")
|
|
3588
3406
|
*/
|
|
3589
3407
|
GetClassIcon(this: StudioService, className: string): object;
|
|
3590
|
-
GetPlaceIsPersistedToCloud(this: StudioService): boolean;
|
|
3591
|
-
GetResourceByCategory(this: StudioService, category: string): object;
|
|
3592
|
-
GetStartupAssetId(this: StudioService): string;
|
|
3593
|
-
GetStartupPluginId(this: StudioService): string;
|
|
3594
|
-
GetTermsOfUseUrl(this: StudioService): string;
|
|
3595
3408
|
/**
|
|
3596
3409
|
* Returns the studio user's userId if they're logged in, otherwise returns 0.
|
|
3597
3410
|
*/
|
|
3598
3411
|
GetUserId(this: StudioService): number;
|
|
3599
3412
|
GizmoRaycast(this: StudioService, origin: Vector3, direction: Vector3, raycastParams?: RaycastParams): RaycastResult;
|
|
3600
|
-
HasInternalPermission(this: StudioService): boolean;
|
|
3601
|
-
IsPluginInstalled(this: StudioService, assetId: number): boolean;
|
|
3602
|
-
IsPluginUpToDate(this: StudioService, assetId: number, currentAssetVersion: number): boolean;
|
|
3603
|
-
OpenInBrowser_DONOTUSE(this: StudioService, url: string): void;
|
|
3604
|
-
RequestClose(this: StudioService, closeMode: CastsToEnum<Enum.StudioCloseMode>): void;
|
|
3605
|
-
SetPluginEnabled(this: StudioService, assetId: number, state: boolean): void;
|
|
3606
|
-
ShowPlaceVersionHistoryDialog(this: StudioService, placeId: number): void;
|
|
3607
|
-
ShowPublishToRoblox(this: StudioService): void;
|
|
3608
|
-
UninstallPlugin(this: StudioService, assetId: number): void;
|
|
3609
|
-
UpdatePluginManagement(this: StudioService): void;
|
|
3610
3413
|
/**
|
|
3611
3414
|
* This function prompts the current Studio user to select one file, which will then be loaded as a [File](https://developer.roblox.com/en-us/api-reference/class/File).
|
|
3612
3415
|
*
|
|
@@ -3629,23 +3432,6 @@ interface StudioService extends Instance {
|
|
|
3629
3432
|
* Tags: Yields
|
|
3630
3433
|
*/
|
|
3631
3434
|
PromptImportFiles(this: StudioService, fileTypeFilter?: Array<any>): Array<Instance>;
|
|
3632
|
-
/**
|
|
3633
|
-
* Tags: Yields
|
|
3634
|
-
*/
|
|
3635
|
-
TryInstallPlugin(this: StudioService, assetId: number, assetVersionId: number): void;
|
|
3636
|
-
readonly DEPRECATED_GameNameUpdated: RBXScriptSignal<(name: string) => void>;
|
|
3637
|
-
readonly DEPRECATED_GamePublishFinished: RBXScriptSignal<(success: boolean, gameId: number) => void>;
|
|
3638
|
-
readonly DEPRECATED_OnPublishPlaceToRoblox: RBXScriptSignal<(isOverwritePublish: boolean) => void>;
|
|
3639
|
-
readonly DEPRECATED_OnSaveOrPublishPlaceToRoblox: RBXScriptSignal<(showGameSelect: boolean, isPublish: boolean, closeMode: Enum.StudioCloseMode) => void>;
|
|
3640
|
-
readonly OnImportFromRoblox: RBXScriptSignal<() => void>;
|
|
3641
|
-
readonly OnOpenGameSettings: RBXScriptSignal<(pageIdentifier: string) => void>;
|
|
3642
|
-
readonly OnOpenManagePackagePlugin: RBXScriptSignal<(userId: number, assetId: number) => void>;
|
|
3643
|
-
readonly OnPluginInstalledFromToolbox: RBXScriptSignal<() => void>;
|
|
3644
|
-
readonly OnPluginInstalledFromWeb: RBXScriptSignal<(pluginId: string) => void>;
|
|
3645
|
-
readonly OnPublishAsPlugin: RBXScriptSignal<(instances: Array<Instance>) => void>;
|
|
3646
|
-
readonly OnSaveToRoblox: RBXScriptSignal<(instances: Array<Instance>) => void>;
|
|
3647
|
-
readonly PromptTransformPluginCheckEnable: RBXScriptSignal<() => void>;
|
|
3648
|
-
readonly SaveLocallyAsComplete: RBXScriptSignal<(success: boolean) => void>;
|
|
3649
3435
|
}
|
|
3650
3436
|
|
|
3651
3437
|
interface StudioTheme extends Instance {
|
|
@@ -4104,10 +3890,6 @@ interface VersionControlService extends Instance {
|
|
|
4104
3890
|
* @deprecated
|
|
4105
3891
|
*/
|
|
4106
3892
|
readonly _nominal_VersionControlService: unique symbol;
|
|
4107
|
-
/**
|
|
4108
|
-
* Tags: Hidden
|
|
4109
|
-
*/
|
|
4110
|
-
readonly ScriptCollabEnabled: boolean;
|
|
4111
3893
|
}
|
|
4112
3894
|
|
|
4113
3895
|
interface VoiceChatService extends Instance {
|
package/include/roblox.d.ts
CHANGED
|
@@ -148,37 +148,71 @@ interface ReceiptInfo {
|
|
|
148
148
|
interface ProductInfo {
|
|
149
149
|
/** The name shown on the asset's page */
|
|
150
150
|
Name: string;
|
|
151
|
-
/** The description as shown on the asset's page
|
|
152
|
-
* May be `undefined` if the description is empty.
|
|
153
|
-
*/
|
|
151
|
+
/** The description as shown on the asset's page; May be `undefined` if the description is empty. */
|
|
154
152
|
Description: string | undefined;
|
|
155
153
|
/** The cost of purchasing the asset using Robux */
|
|
156
|
-
PriceInRobux: number;
|
|
154
|
+
PriceInRobux: number | undefined;
|
|
157
155
|
/** Timestamp of when the asset was created, e.g. `2018-08-01T17:55:11.98Z` */
|
|
158
156
|
Created: string;
|
|
159
157
|
/** Timestamp of when the asset was last updated by its creator, e.g. `2018-08-01T17:55:11.98Z` */
|
|
160
158
|
Updated: string;
|
|
161
|
-
/**
|
|
162
|
-
|
|
163
|
-
/** The
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
IsPublicDomain: boolean;
|
|
167
|
-
/** Describes whether the asset is a User Product, Developer Product, or Game Pass */
|
|
168
|
-
ProductType: "User Product" | "Developer Product" | "Game Pass";
|
|
159
|
+
/** Describes whether the asset is purchasable */
|
|
160
|
+
IsForSale: boolean;
|
|
161
|
+
/** The number of items the asset has been sold */
|
|
162
|
+
Sales: number | undefined;
|
|
163
|
+
ProductId: number;
|
|
169
164
|
/** A table of information describing the creator of the asset */
|
|
170
165
|
Creator: {
|
|
171
166
|
/** Either `User` or `Group` */
|
|
172
|
-
CreatorType: "User" | "Group";
|
|
167
|
+
CreatorType: "User" | "Group" | undefined;
|
|
173
168
|
/** The ID of the creator user or group */
|
|
174
169
|
CreatorTargetId: number;
|
|
175
170
|
/** The name/username of the creator */
|
|
176
|
-
Name: string;
|
|
171
|
+
Name: string | undefined;
|
|
177
172
|
};
|
|
178
|
-
IconImageAssetId: number;
|
|
179
173
|
TargetId: number;
|
|
180
174
|
}
|
|
181
175
|
|
|
176
|
+
interface AssetProductInfo extends ProductInfo {
|
|
177
|
+
/** Describes whether the asset is a User Product, Developer Product, or Game Pass */
|
|
178
|
+
ProductType: "User Product";
|
|
179
|
+
/** If InfoType was Asset, this is the ID of the given asset. */
|
|
180
|
+
AssetId: number;
|
|
181
|
+
/** The [type of asset](https://developer.roblox.com/articles/Asset-types) (e.g. place, model, shirt). In TypeScript, you should compare this value to a member of the `AssetTypeId` const enum. */
|
|
182
|
+
AssetTypeId: AssetTypeId;
|
|
183
|
+
/** Describes whether the asset is marked as "new" in the catalog */
|
|
184
|
+
IsNew: boolean;
|
|
185
|
+
/** Describes whether the asset is a "limited item" that is no longer (if ever) sold */
|
|
186
|
+
IsLimited: boolean;
|
|
187
|
+
/** Describes whether the asset is a "limited unique" ("Limited U") item that only has a fixed number sold */
|
|
188
|
+
IsLimitedUnique: boolean;
|
|
189
|
+
/** Describes whether the asset can be taken for free */
|
|
190
|
+
IsPublicDomain: boolean;
|
|
191
|
+
/** The remaining number of items a limited unique item may be sold */
|
|
192
|
+
Remaining: number | undefined;
|
|
193
|
+
/** Indicates whether the item is marked as 13+ in catalog */
|
|
194
|
+
ContentRatingTypeId: number;
|
|
195
|
+
/** The minimum Builder's Club subscription necessary to purchase the item */
|
|
196
|
+
MinimumMembershipLevel: number;
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
interface DeveloperProductInfo extends ProductInfo {
|
|
200
|
+
/** Describes whether the asset is a User Product, Developer Product, or Game Pass */
|
|
201
|
+
ProductType: "Developer Product";
|
|
202
|
+
IconImageAssetId: number;
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
interface GamePassProductInfo extends ProductInfo {
|
|
206
|
+
/** Describes whether the asset is a User Product, Developer Product, or Game Pass */
|
|
207
|
+
ProductType: "Game Pass";
|
|
208
|
+
IconImageAssetId: number;
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
interface SubscriptionProductInfo extends ProductInfo {
|
|
212
|
+
/** Describes whether the asset is a User Product, Developer Product, or Game Pass */
|
|
213
|
+
ProductType: "Subscription";
|
|
214
|
+
}
|
|
215
|
+
|
|
182
216
|
interface BadgeInfo {
|
|
183
217
|
/** The name of the badge. */
|
|
184
218
|
Name: string;
|
|
@@ -287,30 +321,6 @@ declare const enum AssetTypeId {
|
|
|
287
321
|
EyeAccessory = 58,
|
|
288
322
|
}
|
|
289
323
|
|
|
290
|
-
interface AssetProductInfo extends ProductInfo {
|
|
291
|
-
/** If InfoType was Asset, this is the ID of the given asset. */
|
|
292
|
-
AssetId: number;
|
|
293
|
-
/** The [type of asset](https://developer.roblox.com/articles/Asset-types) (e.g. place, model, shirt). In TypeScript, you should compare this value to a member of the `AssetTypeId` const enum. */
|
|
294
|
-
AssetTypeId: AssetTypeId;
|
|
295
|
-
/** Describes whether the asset is purchasable */
|
|
296
|
-
IsForSale: boolean;
|
|
297
|
-
/** Describes whether the asset is a "limited item" that is no longer (if ever) sold */
|
|
298
|
-
IsLimited: boolean;
|
|
299
|
-
/** Describes whether the asset is a "limited unique" ("Limited U") item that only has a fixed number sold */
|
|
300
|
-
IsLimitedUnique: boolean;
|
|
301
|
-
/** Describes whether the asset is marked as "new" in the catalog */
|
|
302
|
-
IsNew: boolean;
|
|
303
|
-
/** The remaining number of items a limited unique item may be sold */
|
|
304
|
-
Remaining: number;
|
|
305
|
-
/** The number of items the asset has been sold */
|
|
306
|
-
Sales: number;
|
|
307
|
-
}
|
|
308
|
-
|
|
309
|
-
interface DeveloperProductInfo extends ProductInfo {
|
|
310
|
-
/** If the InfoType was Product, this is the product's ID */
|
|
311
|
-
ProductId: number;
|
|
312
|
-
}
|
|
313
|
-
|
|
314
324
|
interface AgentParameters {
|
|
315
325
|
/** Humanoid radius. Used to determine the minimum separation from obstacles. */
|
|
316
326
|
AgentRadius?: number;
|
|
@@ -541,6 +551,8 @@ interface RBXScriptSignal<T extends Callback = Callback> {
|
|
|
541
551
|
|
|
542
552
|
ConnectParallel(this: RBXScriptSignal, callback: T): RBXScriptConnection;
|
|
543
553
|
|
|
554
|
+
Once(this: RBXScriptSignal, callback: T): RBXScriptConnection;
|
|
555
|
+
|
|
544
556
|
/**
|
|
545
557
|
* Yields the current thread until this signal is fired. Returns what was fired to the signal.
|
|
546
558
|
*/
|