@rbxts/types 1.0.834 → 1.0.835
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.
|
@@ -2220,7 +2220,7 @@ interface AnalyticsService extends Instance {
|
|
|
2220
2220
|
* @param itemSku Optional SKU of the item or bundle being purchased. This is a unique identifier for the item being purchased. Limited to 100 unique SKUs per experience.
|
|
2221
2221
|
* @param customFields Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by `AnalyticsCustomFieldKeys`, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience.
|
|
2222
2222
|
*/
|
|
2223
|
-
LogEconomyEvent(this: AnalyticsService, player: Player, flowType: CastsToEnum<Enum.AnalyticsEconomyFlowType>, currencyType: string, amount: number, endingBalance: number, transactionType: string, itemSku
|
|
2223
|
+
LogEconomyEvent(this: AnalyticsService, player: Player, flowType: CastsToEnum<Enum.AnalyticsEconomyFlowType>, currencyType: string, amount: number, endingBalance: number, transactionType: string, itemSku?: string, customFields?: object): void;
|
|
2224
2224
|
/**
|
|
2225
2225
|
* Logs an event used to track user actions stepping through a pre-planned funnel.
|
|
2226
2226
|
*
|
|
@@ -2235,7 +2235,7 @@ interface AnalyticsService extends Instance {
|
|
|
2235
2235
|
* @param stepName Optional name of the step in the funnel. This field is only used for display purposes in Roblox-provided charts.
|
|
2236
2236
|
* @param customFields Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by `AnalyticsCustomFieldKeys`, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience.
|
|
2237
2237
|
*/
|
|
2238
|
-
LogFunnelStepEvent(this: AnalyticsService, player: Player, funnelName: string, funnelSessionId
|
|
2238
|
+
LogFunnelStepEvent(this: AnalyticsService, player: Player, funnelName: string, funnelSessionId?: string, step?: number, stepName?: string, customFields?: object): void;
|
|
2239
2239
|
/**
|
|
2240
2240
|
* Logs an event used to track user actions stepping through an onboarding funnel.
|
|
2241
2241
|
*
|
|
@@ -2248,7 +2248,7 @@ interface AnalyticsService extends Instance {
|
|
|
2248
2248
|
* @param stepName Optional name of the step in the funnel. This field is only used for display purposes in Roblox-provided charts.
|
|
2249
2249
|
* @param customFields Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by `AnalyticsCustomFieldKeys`, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience.
|
|
2250
2250
|
*/
|
|
2251
|
-
LogOnboardingFunnelStepEvent(this: AnalyticsService, player: Player, step: number, stepName
|
|
2251
|
+
LogOnboardingFunnelStepEvent(this: AnalyticsService, player: Player, step: number, stepName?: string, customFields?: object): void;
|
|
2252
2252
|
/**
|
|
2253
2253
|
* Logs an event for when a user has completed a level attempt.
|
|
2254
2254
|
*
|
|
@@ -2262,7 +2262,7 @@ interface AnalyticsService extends Instance {
|
|
|
2262
2262
|
* @param levelName
|
|
2263
2263
|
* @param customFields
|
|
2264
2264
|
*/
|
|
2265
|
-
LogProgressionCompleteEvent(this: AnalyticsService, player: Player, progressionPathName: string, level: number, levelName
|
|
2265
|
+
LogProgressionCompleteEvent(this: AnalyticsService, player: Player, progressionPathName: string, level: number, levelName?: string, customFields?: object): void;
|
|
2266
2266
|
/**
|
|
2267
2267
|
* Logs an event for when a user has started, completed, or failed a level attempt.
|
|
2268
2268
|
*
|
|
@@ -2277,7 +2277,7 @@ interface AnalyticsService extends Instance {
|
|
|
2277
2277
|
* @param levelName
|
|
2278
2278
|
* @param customFields
|
|
2279
2279
|
*/
|
|
2280
|
-
LogProgressionEvent(this: AnalyticsService, player: Player, progressionPathName: string, status: CastsToEnum<Enum.AnalyticsProgressionType>, level: number, levelName
|
|
2280
|
+
LogProgressionEvent(this: AnalyticsService, player: Player, progressionPathName: string, status: CastsToEnum<Enum.AnalyticsProgressionType>, level: number, levelName?: string, customFields?: object): void;
|
|
2281
2281
|
/**
|
|
2282
2282
|
* Logs an event for when a user has failed a level attempt.
|
|
2283
2283
|
*
|
|
@@ -2291,7 +2291,7 @@ interface AnalyticsService extends Instance {
|
|
|
2291
2291
|
* @param levelName
|
|
2292
2292
|
* @param customFields
|
|
2293
2293
|
*/
|
|
2294
|
-
LogProgressionFailEvent(this: AnalyticsService, player: Player, progressionPathName: string, level: number, levelName
|
|
2294
|
+
LogProgressionFailEvent(this: AnalyticsService, player: Player, progressionPathName: string, level: number, levelName?: string, customFields?: object): void;
|
|
2295
2295
|
/**
|
|
2296
2296
|
* Logs an event for when a user has started a level attempt.
|
|
2297
2297
|
*
|
|
@@ -2305,7 +2305,7 @@ interface AnalyticsService extends Instance {
|
|
|
2305
2305
|
* @param levelName
|
|
2306
2306
|
* @param customFields
|
|
2307
2307
|
*/
|
|
2308
|
-
LogProgressionStartEvent(this: AnalyticsService, player: Player, progressionPathName: string, level: number, levelName
|
|
2308
|
+
LogProgressionStartEvent(this: AnalyticsService, player: Player, progressionPathName: string, level: number, levelName?: string, customFields?: object): void;
|
|
2309
2309
|
}
|
|
2310
2310
|
/**
|
|
2311
2311
|
* References an animation asset which can be loaded by an `AnimationController`.
|
|
@@ -3290,7 +3290,7 @@ interface AssetService extends Instance {
|
|
|
3290
3290
|
* @param description Description of the new place.
|
|
3291
3291
|
* @returns `PlaceId` of the new place.
|
|
3292
3292
|
*/
|
|
3293
|
-
CreatePlaceAsync(this: AssetService, placeName: string, templatePlaceID: number, description
|
|
3293
|
+
CreatePlaceAsync(this: AssetService, placeName: string, templatePlaceID: number, description?: string): number;
|
|
3294
3294
|
/**
|
|
3295
3295
|
* Clones a place through the given `templatePlaceID` and puts it into the inventory of the given player.
|
|
3296
3296
|
*
|
|
@@ -13031,7 +13031,7 @@ interface DataStoreService extends Instance {
|
|
|
13031
13031
|
* @param cursor **(Optional)** Cursor to continue iteration.
|
|
13032
13032
|
* @returns `DataStoreListingPages` instance containing `DataStoreInfo` instances that provide details such as name, creation time, and time last updated.
|
|
13033
13033
|
*/
|
|
13034
|
-
ListDataStoresAsync(this: DataStoreService, prefix
|
|
13034
|
+
ListDataStoresAsync(this: DataStoreService, prefix?: string, pageSize?: number, cursor?: string): DataStoreListingPages;
|
|
13035
13035
|
}
|
|
13036
13036
|
/**
|
|
13037
13037
|
* Specifies additional parameters for a `GlobalDataStore:SetAsync()` call.
|
|
@@ -14927,7 +14927,7 @@ interface DataStore extends GlobalDataStore {
|
|
|
14927
14927
|
* @param excludeDeleted **(Optional)** Exclude deleted keys from being returned. When enabled ListKeys will check up to 512 keys. If all checked keys are deleted then it will return an empty list with a cursor to continue iteration.
|
|
14928
14928
|
* @returns A `DataStoreKeyPages` instance that enumerates the keys as `DataStoreKey` instances.
|
|
14929
14929
|
*/
|
|
14930
|
-
ListKeysAsync(this: DataStore, prefix
|
|
14930
|
+
ListKeysAsync(this: DataStore, prefix?: string, pageSize?: number, cursor?: string, excludeDeleted?: boolean): DataStoreKeyPages;
|
|
14931
14931
|
/**
|
|
14932
14932
|
* Enumerates all versions of a key.
|
|
14933
14933
|
*
|
|
@@ -29414,7 +29414,7 @@ interface Player extends Instance {
|
|
|
29414
29414
|
* @param this An object that represents a presently connected client to the game.
|
|
29415
29415
|
* @param message The message to show the user upon kicking.
|
|
29416
29416
|
*/
|
|
29417
|
-
Kick(this: Player, message
|
|
29417
|
+
Kick(this: Player, message?: string): void;
|
|
29418
29418
|
/**
|
|
29419
29419
|
* **Deprecated:** This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using `DataStoreService` for new work.
|
|
29420
29420
|
*
|
|
@@ -35808,7 +35808,7 @@ interface TextChannel extends Instance {
|
|
|
35808
35808
|
* @param metadata Use to identify system message types, such as the default system messages.
|
|
35809
35809
|
* @returns A `TextChatMessage` with `TextChatMessage.Status` property that indicates the condition of the message.
|
|
35810
35810
|
*/
|
|
35811
|
-
DisplaySystemMessage(this: TextChannel, systemMessage: string, metadata
|
|
35811
|
+
DisplaySystemMessage(this: TextChannel, systemMessage: string, metadata?: string): TextChatMessage;
|
|
35812
35812
|
/**
|
|
35813
35813
|
* Sets the `DirectChatRequester` for the `TextChannel`. The `TextChannel` will only deliver messages to users that can send direct messages to the `DirectChatRequester`.
|
|
35814
35814
|
*
|
|
@@ -35852,7 +35852,7 @@ interface TextChannel extends Instance {
|
|
|
35852
35852
|
* @param metadata Custom metadata to attach to the message.
|
|
35853
35853
|
* @returns A `TextChatMessage` with `TextChatMessage.Status` property that indicates the condition of the message.
|
|
35854
35854
|
*/
|
|
35855
|
-
SendAsync(this: TextChannel, message: string, metadata
|
|
35855
|
+
SendAsync(this: TextChannel, message: string, metadata?: string): TextChatMessage;
|
|
35856
35856
|
/**
|
|
35857
35857
|
* Fires when `TextChannel:DisplaySystemMessage()` is invoked on the client, or when the client receives a valid `TextChannel:SendAsync()` response from the server.
|
|
35858
35858
|
*
|
|
@@ -9399,7 +9399,7 @@ interface Plugin extends Instance {
|
|
|
9399
9399
|
* @param this
|
|
9400
9400
|
* @param suggestedFileName
|
|
9401
9401
|
*/
|
|
9402
|
-
PromptSaveSelection(this: Plugin, suggestedFileName
|
|
9402
|
+
PromptSaveSelection(this: Plugin, suggestedFileName?: string): boolean;
|
|
9403
9403
|
/**
|
|
9404
9404
|
* Fired when the plugin is deactivated.
|
|
9405
9405
|
*
|
|
@@ -9548,7 +9548,7 @@ interface PluginManagerInterface extends Instance {
|
|
|
9548
9548
|
* @param this
|
|
9549
9549
|
* @param filePath
|
|
9550
9550
|
*/
|
|
9551
|
-
ExportPlace(this: PluginManagerInterface, filePath
|
|
9551
|
+
ExportPlace(this: PluginManagerInterface, filePath?: string): void;
|
|
9552
9552
|
/**
|
|
9553
9553
|
* - **ThreadSafety**: Unsafe
|
|
9554
9554
|
*
|
|
@@ -9556,7 +9556,7 @@ interface PluginManagerInterface extends Instance {
|
|
|
9556
9556
|
* @param this
|
|
9557
9557
|
* @param filePath
|
|
9558
9558
|
*/
|
|
9559
|
-
ExportSelection(this: PluginManagerInterface, filePath
|
|
9559
|
+
ExportSelection(this: PluginManagerInterface, filePath?: string): void;
|
|
9560
9560
|
}
|
|
9561
9561
|
/**
|
|
9562
9562
|
* A context menu that can be shown in Studio. Displays a list of `PluginActions` and supports submenus.
|