@rbxts/types 1.0.711 → 1.0.712
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.
|
@@ -528,6 +528,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
528
528
|
LodDataEntity: LodDataEntity;
|
|
529
529
|
MaterialGenerationSession: MaterialGenerationSession;
|
|
530
530
|
MaterialImportData: MaterialImportData;
|
|
531
|
+
MemoryStoreHashMap: MemoryStoreHashMap;
|
|
531
532
|
MemoryStoreQueue: MemoryStoreQueue;
|
|
532
533
|
MemoryStoreSortedMap: MemoryStoreSortedMap;
|
|
533
534
|
MeshImportData: MeshImportData;
|
|
@@ -2153,6 +2154,7 @@ interface Animator extends Instance {
|
|
|
2153
2154
|
* * [Using Animations in Games](https://developer.roblox.com/articles/using-animations-in-games), learn how to add pre-built and custom animations to your game
|
|
2154
2155
|
*/
|
|
2155
2156
|
LoadAnimation(this: Animator, animation: Animation): AnimationTrack;
|
|
2157
|
+
RegisterEvaluationParallelCallback(this: Animator, callback: Callback): void;
|
|
2156
2158
|
readonly AnimationPlayed: RBXScriptSignal<(animationTrack: AnimationTrack) => void>;
|
|
2157
2159
|
}
|
|
2158
2160
|
|
|
@@ -2252,6 +2254,10 @@ interface AssetService extends Instance {
|
|
|
2252
2254
|
* @deprecated
|
|
2253
2255
|
*/
|
|
2254
2256
|
readonly _nominal_AssetService: unique symbol;
|
|
2257
|
+
/**
|
|
2258
|
+
* Tags: Yields
|
|
2259
|
+
*/
|
|
2260
|
+
CreateDynamicImageAsync(this: AssetService, textureId: string): DynamicImage;
|
|
2255
2261
|
/**
|
|
2256
2262
|
* Clones a place with placeId equal to given templatePlaceId. It is placed into the inventory of the place's creator with the given name and description. This method will also return the placeId of the new place, which can be used with TeleportService. This method cannot be used to clone places that you do not own.
|
|
2257
2263
|
*
|
|
@@ -2365,10 +2371,6 @@ interface AssetService extends Instance {
|
|
|
2365
2371
|
* Tags: Yields
|
|
2366
2372
|
*/
|
|
2367
2373
|
GetGamePlacesAsync(this: AssetService): StandardPages<{ Name: string; PlaceId: number }>;
|
|
2368
|
-
/**
|
|
2369
|
-
* Tags: Yields
|
|
2370
|
-
*/
|
|
2371
|
-
LoadImageAsync(this: AssetService, textureId: string): DynamicImage;
|
|
2372
2374
|
/**
|
|
2373
2375
|
* Tags: Yields
|
|
2374
2376
|
*/
|
|
@@ -10235,7 +10237,9 @@ interface DynamicImage extends Instance {
|
|
|
10235
10237
|
readonly _nominal_DynamicImage: unique symbol;
|
|
10236
10238
|
Size: Vector2;
|
|
10237
10239
|
Clear(this: DynamicImage): void;
|
|
10240
|
+
Crop(this: DynamicImage, min: Vector2, max: Vector2): void;
|
|
10238
10241
|
DrawCircle(this: DynamicImage, center: Vector2, radius: number, color: Color3, transparency: number): void;
|
|
10242
|
+
DrawImage(this: DynamicImage, position: Vector2, image: DynamicImage, combineType: CastsToEnum<Enum.ImageCombineType>): void;
|
|
10239
10243
|
/**
|
|
10240
10244
|
* Tags: CustomLuaState
|
|
10241
10245
|
*/
|
|
@@ -10330,6 +10334,10 @@ interface ExperienceNotificationService extends Instance {
|
|
|
10330
10334
|
* @deprecated
|
|
10331
10335
|
*/
|
|
10332
10336
|
readonly _nominal_ExperienceNotificationService: unique symbol;
|
|
10337
|
+
/**
|
|
10338
|
+
* Tags: Yields
|
|
10339
|
+
*/
|
|
10340
|
+
CreateUserNotificationAsync(this: ExperienceNotificationService, userId: string, userNotification: UserNotification): Instance | undefined;
|
|
10333
10341
|
}
|
|
10334
10342
|
|
|
10335
10343
|
/** An Explosion applies force to `BaseParts` within the explosion's [Explosion.BlastRadius](https://developer.roblox.com/en-us/api-reference/property/Explosion/BlastRadius). This force breaks joints between parts and kills [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) characters not protected by a [ForceField](https://developer.roblox.com/en-us/api-reference/class/ForceField).
|
|
@@ -11116,19 +11124,19 @@ interface GeometryService extends Instance {
|
|
|
11116
11124
|
* @deprecated
|
|
11117
11125
|
*/
|
|
11118
11126
|
readonly _nominal_GeometryService: unique symbol;
|
|
11119
|
-
CalculateConstraintsToPreserve(this: GeometryService, source: Instance, destination: Array<Instance>, options
|
|
11127
|
+
CalculateConstraintsToPreserve(this: GeometryService, source: Instance, destination: Array<Instance>, options?: object): unknown;
|
|
11120
11128
|
/**
|
|
11121
11129
|
* Tags: Yields
|
|
11122
11130
|
*/
|
|
11123
|
-
IntersectAsync(this: GeometryService, part: BasePart, parts: Array<Instance>, options
|
|
11131
|
+
IntersectAsync(this: GeometryService, part: BasePart, parts: Array<Instance>, options?: object): Array<Instance>;
|
|
11124
11132
|
/**
|
|
11125
11133
|
* Tags: Yields
|
|
11126
11134
|
*/
|
|
11127
|
-
SubtractAsync(this: GeometryService, part: BasePart, parts: Array<Instance>, options
|
|
11135
|
+
SubtractAsync(this: GeometryService, part: BasePart, parts: Array<Instance>, options?: object): Array<Instance>;
|
|
11128
11136
|
/**
|
|
11129
11137
|
* Tags: Yields
|
|
11130
11138
|
*/
|
|
11131
|
-
UnionAsync(this: GeometryService, part: BasePart, parts: Array<Instance>, options
|
|
11139
|
+
UnionAsync(this: GeometryService, part: BasePart, parts: Array<Instance>, options?: object): Array<Instance>;
|
|
11132
11140
|
}
|
|
11133
11141
|
|
|
11134
11142
|
interface GetTextBoundsParams extends Instance {
|
|
@@ -14938,6 +14946,10 @@ interface GuiService extends Instance {
|
|
|
14938
14946
|
* If you would like to determine when this property changes without tracking the SelectionGained and SelectionLost events for all GUI elements, you can use the [Changed](https://developer.roblox.com/en-us/api-reference/event/Instance/Changed) event.
|
|
14939
14947
|
*/
|
|
14940
14948
|
SelectedObject: GuiObject | undefined;
|
|
14949
|
+
/**
|
|
14950
|
+
* Tags: Hidden, NotReplicated
|
|
14951
|
+
*/
|
|
14952
|
+
readonly TopbarInset: Rect;
|
|
14941
14953
|
/**
|
|
14942
14954
|
* Determines whether touch controls are enabled. Defaults to true.
|
|
14943
14955
|
*/
|
|
@@ -15077,7 +15089,6 @@ interface GuiService extends Instance {
|
|
|
15077
15089
|
* Fires when the user **opens** the Roblox coregui escape menu.
|
|
15078
15090
|
*/
|
|
15079
15091
|
readonly MenuOpened: RBXScriptSignal<() => void>;
|
|
15080
|
-
readonly TopbarInsetChanged: RBXScriptSignal<(topbarInset: object) => void>;
|
|
15081
15092
|
}
|
|
15082
15093
|
|
|
15083
15094
|
/** The _Xbox One_ controller and some other USB gamepad controllers have motors built in to provide haptic feedback. Adding rumbles and vibrations can greatly enhance a game's experience and provide subtle feedback that is hard to convey through visuals or audio. */
|
|
@@ -22312,6 +22323,33 @@ interface MaterialVariant extends Instance {
|
|
|
22312
22323
|
StudsPerTile: number;
|
|
22313
22324
|
}
|
|
22314
22325
|
|
|
22326
|
+
interface MemoryStoreHashMap extends Instance {
|
|
22327
|
+
/**
|
|
22328
|
+
* **DO NOT USE!**
|
|
22329
|
+
*
|
|
22330
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
22331
|
+
* @hidden
|
|
22332
|
+
* @deprecated
|
|
22333
|
+
*/
|
|
22334
|
+
readonly _nominal_MemoryStoreHashMap: unique symbol;
|
|
22335
|
+
/**
|
|
22336
|
+
* Tags: Yields
|
|
22337
|
+
*/
|
|
22338
|
+
GetAsync(this: MemoryStoreHashMap, key: string): unknown;
|
|
22339
|
+
/**
|
|
22340
|
+
* Tags: Yields
|
|
22341
|
+
*/
|
|
22342
|
+
RemoveAsync(this: MemoryStoreHashMap, key: string): void;
|
|
22343
|
+
/**
|
|
22344
|
+
* Tags: Yields
|
|
22345
|
+
*/
|
|
22346
|
+
SetAsync(this: MemoryStoreHashMap, key: string, value: unknown, expiration: number): boolean;
|
|
22347
|
+
/**
|
|
22348
|
+
* Tags: Yields
|
|
22349
|
+
*/
|
|
22350
|
+
UpdateAsync(this: MemoryStoreHashMap, key: string, transformFunction: Callback, expiration: number): unknown;
|
|
22351
|
+
}
|
|
22352
|
+
|
|
22315
22353
|
/** Provides access to a queue within MemoryStore. A queue is a data structure that provides temporary storage for arbitrary items (up to the maximum item size – see [`MemoryStore Limits`](https://developer.roblox.com/en-us/articles/memory-store). Each queue item has a numeric priority: MemoryStore retrieves items with higher priority from the queue first, and it retrieves Items with the same priority in order of addition.
|
|
22316
22354
|
*
|
|
22317
22355
|
* Items in the queue can optionally be set to expire after a certain amount of time. Expired items simply disappear from the queue as if they were never added.
|
|
@@ -22365,6 +22403,7 @@ interface MemoryStoreService extends Instance {
|
|
|
22365
22403
|
* @deprecated
|
|
22366
22404
|
*/
|
|
22367
22405
|
readonly _nominal_MemoryStoreService: unique symbol;
|
|
22406
|
+
GetHashMap(this: MemoryStoreService, name: string): MemoryStoreHashMap;
|
|
22368
22407
|
/**
|
|
22369
22408
|
* Returns a [MemoryStoreQueue](https://developer.roblox.com/en-us/api-reference/class/MemoryStoreQueue) instance for the provided name. The name is global within the game, thus any place that uses the same name will access the same queue.
|
|
22370
22409
|
*
|
|
@@ -904,6 +904,27 @@ declare namespace Enum {
|
|
|
904
904
|
}
|
|
905
905
|
export type AspectType = AspectType.FitWithinMaxSize | AspectType.ScaleWithParentSize;
|
|
906
906
|
|
|
907
|
+
export namespace AssetCreatorType {
|
|
908
|
+
export interface User extends globalThis.EnumItem {
|
|
909
|
+
Name: "User";
|
|
910
|
+
Value: 0;
|
|
911
|
+
EnumType: typeof globalThis.Enum.AssetCreatorType;
|
|
912
|
+
}
|
|
913
|
+
|
|
914
|
+
export const User: User;
|
|
915
|
+
|
|
916
|
+
export interface Group extends globalThis.EnumItem {
|
|
917
|
+
Name: "Group";
|
|
918
|
+
Value: 1;
|
|
919
|
+
EnumType: typeof globalThis.Enum.AssetCreatorType;
|
|
920
|
+
}
|
|
921
|
+
|
|
922
|
+
export const Group: Group;
|
|
923
|
+
|
|
924
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AssetCreatorType>;
|
|
925
|
+
}
|
|
926
|
+
export type AssetCreatorType = AssetCreatorType.User | AssetCreatorType.Group;
|
|
927
|
+
|
|
907
928
|
export namespace AssetFetchStatus {
|
|
908
929
|
export interface Success extends globalThis.EnumItem {
|
|
909
930
|
Name: "Success";
|
|
@@ -8298,6 +8319,27 @@ declare namespace Enum {
|
|
|
8298
8319
|
}
|
|
8299
8320
|
export type IXPLoadingStatus = IXPLoadingStatus.None | IXPLoadingStatus.Pending | IXPLoadingStatus.Initialized | IXPLoadingStatus.ErrorTimedOut | IXPLoadingStatus.ErrorConnection | IXPLoadingStatus.ErrorJsonParse | IXPLoadingStatus.ErrorInvalidUser;
|
|
8300
8321
|
|
|
8322
|
+
export namespace ImageCombineType {
|
|
8323
|
+
export interface BlendSourceOver extends globalThis.EnumItem {
|
|
8324
|
+
Name: "BlendSourceOver";
|
|
8325
|
+
Value: 1;
|
|
8326
|
+
EnumType: typeof globalThis.Enum.ImageCombineType;
|
|
8327
|
+
}
|
|
8328
|
+
|
|
8329
|
+
export const BlendSourceOver: BlendSourceOver;
|
|
8330
|
+
|
|
8331
|
+
export interface Overwrite extends globalThis.EnumItem {
|
|
8332
|
+
Name: "Overwrite";
|
|
8333
|
+
Value: 2;
|
|
8334
|
+
EnumType: typeof globalThis.Enum.ImageCombineType;
|
|
8335
|
+
}
|
|
8336
|
+
|
|
8337
|
+
export const Overwrite: Overwrite;
|
|
8338
|
+
|
|
8339
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ImageCombineType>;
|
|
8340
|
+
}
|
|
8341
|
+
export type ImageCombineType = ImageCombineType.BlendSourceOver | ImageCombineType.Overwrite;
|
|
8342
|
+
|
|
8301
8343
|
export namespace InOut {
|
|
8302
8344
|
export interface Edge extends globalThis.EnumItem {
|
|
8303
8345
|
Name: "Edge";
|
|
@@ -15104,6 +15146,27 @@ declare namespace Enum {
|
|
|
15104
15146
|
}
|
|
15105
15147
|
export type SizeConstraint = SizeConstraint.RelativeXY | SizeConstraint.RelativeXX | SizeConstraint.RelativeYY;
|
|
15106
15148
|
|
|
15149
|
+
export namespace SolverConvergenceMetricType {
|
|
15150
|
+
export interface IterationBased extends globalThis.EnumItem {
|
|
15151
|
+
Name: "IterationBased";
|
|
15152
|
+
Value: 0;
|
|
15153
|
+
EnumType: typeof globalThis.Enum.SolverConvergenceMetricType;
|
|
15154
|
+
}
|
|
15155
|
+
|
|
15156
|
+
export const IterationBased: IterationBased;
|
|
15157
|
+
|
|
15158
|
+
export interface AlgorithmAgnostic extends globalThis.EnumItem {
|
|
15159
|
+
Name: "AlgorithmAgnostic";
|
|
15160
|
+
Value: 1;
|
|
15161
|
+
EnumType: typeof globalThis.Enum.SolverConvergenceMetricType;
|
|
15162
|
+
}
|
|
15163
|
+
|
|
15164
|
+
export const AlgorithmAgnostic: AlgorithmAgnostic;
|
|
15165
|
+
|
|
15166
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.SolverConvergenceMetricType>;
|
|
15167
|
+
}
|
|
15168
|
+
export type SolverConvergenceMetricType = SolverConvergenceMetricType.IterationBased | SolverConvergenceMetricType.AlgorithmAgnostic;
|
|
15169
|
+
|
|
15107
15170
|
export namespace SolverConvergenceVisualizationMode {
|
|
15108
15171
|
export interface Disabled extends globalThis.EnumItem {
|
|
15109
15172
|
Name: "Disabled";
|