@rbxts/types 1.0.729 → 1.0.731
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 +189 -136
- package/include/generated/enums.d.ts +292 -138
- package/package.json +1 -1
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
/// <reference path="enums.d.ts" />
|
|
6
6
|
|
|
7
7
|
interface Services {
|
|
8
|
+
AccountService: AccountService;
|
|
8
9
|
AnalyticsService: AnalyticsService;
|
|
9
10
|
AnimationClipProvider: AnimationClipProvider;
|
|
10
11
|
AnimationFromVideoCreatorService: AnimationFromVideoCreatorService;
|
|
@@ -261,9 +262,9 @@ interface CreatableInstances {
|
|
|
261
262
|
DoubleConstrainedValue: DoubleConstrainedValue;
|
|
262
263
|
DragDetector: DragDetector;
|
|
263
264
|
Dragger: Dragger;
|
|
264
|
-
DynamicImage: DynamicImage;
|
|
265
|
-
DynamicMesh: DynamicMesh;
|
|
266
265
|
EchoSoundEffect: EchoSoundEffect;
|
|
266
|
+
EditableImage: EditableImage;
|
|
267
|
+
EditableMesh: EditableMesh;
|
|
267
268
|
EqualizerSoundEffect: EqualizerSoundEffect;
|
|
268
269
|
EulerRotationCurve: EulerRotationCurve;
|
|
269
270
|
ExperienceInviteOptions: ExperienceInviteOptions;
|
|
@@ -325,6 +326,7 @@ interface CreatableInstances {
|
|
|
325
326
|
Part: Part;
|
|
326
327
|
ParticleEmitter: ParticleEmitter;
|
|
327
328
|
PartOperation: PartOperation;
|
|
329
|
+
Path2D: Path2D;
|
|
328
330
|
PathfindingLink: PathfindingLink;
|
|
329
331
|
PathfindingModifier: PathfindingModifier;
|
|
330
332
|
PitchShiftSoundEffect: PitchShiftSoundEffect;
|
|
@@ -417,6 +419,7 @@ interface CreatableInstances {
|
|
|
417
419
|
UITextSizeConstraint: UITextSizeConstraint;
|
|
418
420
|
UnionOperation: UnionOperation;
|
|
419
421
|
UniversalConstraint: UniversalConstraint;
|
|
422
|
+
UnreliableRemoteEvent: UnreliableRemoteEvent;
|
|
420
423
|
UserNotification: UserNotification;
|
|
421
424
|
UserNotificationPayload: UserNotificationPayload;
|
|
422
425
|
UserNotificationPayloadAnalyticsData: UserNotificationPayloadAnalyticsData;
|
|
@@ -501,6 +504,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
501
504
|
AssetSoundEffect: AssetSoundEffect;
|
|
502
505
|
AudioPages: AudioPages;
|
|
503
506
|
BaseImportData: BaseImportData;
|
|
507
|
+
BaseRemoteEvent: BaseRemoteEvent;
|
|
504
508
|
BaseWrap: BaseWrap;
|
|
505
509
|
BubbleChatConfiguration: BubbleChatConfiguration;
|
|
506
510
|
CatalogPages: CatalogPages;
|
|
@@ -1253,6 +1257,17 @@ interface AccessoryDescription extends Instance {
|
|
|
1253
1257
|
Puffiness: number;
|
|
1254
1258
|
}
|
|
1255
1259
|
|
|
1260
|
+
interface AccountService extends Instance {
|
|
1261
|
+
/**
|
|
1262
|
+
* **DO NOT USE!**
|
|
1263
|
+
*
|
|
1264
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1265
|
+
* @hidden
|
|
1266
|
+
* @deprecated
|
|
1267
|
+
*/
|
|
1268
|
+
readonly _nominal_AccountService: unique symbol;
|
|
1269
|
+
}
|
|
1270
|
+
|
|
1256
1271
|
/** An Accoutrement is an object that welds its child [part](https://developer.roblox.com/en-us/api-reference/class/Part) called “Handle” to the Head of a player's character. The position and rotation of the Handle part can be changed with the [AttachmentPos](https://developer.roblox.com/en-us/api-reference/property/Accoutrement/AttachmentPos)/[Right](https://developer.roblox.com/en-us/api-reference/property/Accoutrement/AttachmentRight)/[Forward](https://developer.roblox.com/en-us/api-reference/property/Accoutrement/AttachmentForward)/[Up](https://developer.roblox.com/en-us/api-reference/property/Accoutrement/AttachmentUp) properties.
|
|
1257
1272
|
*
|
|
1258
1273
|
* Parts descending from an accoutrement will be massless when attached to other parts (e.g. with a Weld) as long as they are not the root part of the assembly returned by [GetRootPart()](https://developer.roblox.com/en-us/api-reference/function/BasePart/GetRootPart). [GetMass()](https://developer.roblox.com/en-us/api-reference/function/BasePart/GetMass) will return 0 for parts in this case and it will not add to the total mass or rotational inertia of the Assembly.
|
|
@@ -2300,11 +2315,15 @@ interface AssetService extends Instance {
|
|
|
2300
2315
|
/**
|
|
2301
2316
|
* Tags: Yields
|
|
2302
2317
|
*/
|
|
2303
|
-
|
|
2318
|
+
CreateEditableImageAsync(this: AssetService, textureId: string): EditableImage;
|
|
2319
|
+
/**
|
|
2320
|
+
* Tags: Yields
|
|
2321
|
+
*/
|
|
2322
|
+
CreateEditableMeshAsync(this: AssetService, meshId: string): EditableMesh;
|
|
2304
2323
|
/**
|
|
2305
2324
|
* Tags: Yields
|
|
2306
2325
|
*/
|
|
2307
|
-
|
|
2326
|
+
CreateEditableMeshFromPartAsync(this: AssetService, meshPart: MeshPart): EditableMesh;
|
|
2308
2327
|
/**
|
|
2309
2328
|
* 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.
|
|
2310
2329
|
*
|
|
@@ -4652,6 +4671,112 @@ interface StarterGui extends BasePlayerGui {
|
|
|
4652
4671
|
GetCore<T extends keyof GettableCores>(this: StarterGui, parameter: T): GettableCores[T];
|
|
4653
4672
|
}
|
|
4654
4673
|
|
|
4674
|
+
interface BaseRemoteEvent extends Instance {
|
|
4675
|
+
/**
|
|
4676
|
+
* **DO NOT USE!**
|
|
4677
|
+
*
|
|
4678
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
4679
|
+
* @hidden
|
|
4680
|
+
* @deprecated
|
|
4681
|
+
*/
|
|
4682
|
+
readonly _nominal_BaseRemoteEvent: unique symbol;
|
|
4683
|
+
}
|
|
4684
|
+
|
|
4685
|
+
/** A **RemoteEvent** is designed to provide a one-way message between the server and clients, allowing [Scripts](https://developer.roblox.com/en-us/api-reference/class/Script) to call code in [LocalScripts](https://developer.roblox.com/en-us/api-reference/class/LocalScript) and vice-versa. This message can be directed from one client to the server, from the server to a particular client, or from the server to all clients.
|
|
4686
|
+
*
|
|
4687
|
+
* In order for both the server and clients to utilize a remote event, the RemoteEvent object itself must be in a place where both sides can see it. As such, we recommend that you store the RemoteEvent inside of [ReplicatedStorage](https://developer.roblox.com/en-us/api-reference/class/ReplicatedStorage), although in some cases it's appropriate to store it in the workspace or inside a [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool).
|
|
4688
|
+
*
|
|
4689
|
+
* If you need the result of the call, you should use a [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) instead. Otherwise a remote event is recommended since it will minimize network traffic/latency and won't yield the script to wait for a response. See [Remote Functions and Events](https://developer.roblox.com/en-us/articles/remote-functions-and-events) for more info.
|
|
4690
|
+
*/
|
|
4691
|
+
interface RemoteEvent<T extends Callback = Callback> extends BaseRemoteEvent {
|
|
4692
|
+
/**
|
|
4693
|
+
* **DO NOT USE!**
|
|
4694
|
+
*
|
|
4695
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
4696
|
+
* @hidden
|
|
4697
|
+
* @deprecated
|
|
4698
|
+
*/
|
|
4699
|
+
readonly _nominal_RemoteEvent: unique symbol;
|
|
4700
|
+
/**
|
|
4701
|
+
* The FireAllClients function fires the [RemoteEvent.OnClientEvent](https://developer.roblox.com/en-us/api-reference/event/RemoteEvent/OnClientEvent) event for each client.
|
|
4702
|
+
*
|
|
4703
|
+
* Unlike [RemoteEvent:FireClient](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireClient), this event does not take a target player as an argument. Instead it will fire to all clients who have the same remote event connected to an OnClientEvent event.
|
|
4704
|
+
*
|
|
4705
|
+
* Since this function is used to communicate from the server to the client, it will only work when used in a [Script](https://developer.roblox.com/en-us/api-reference/class/Script).
|
|
4706
|
+
*
|
|
4707
|
+
* The behavior of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
|
|
4708
|
+
*
|
|
4709
|
+
* There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
|
|
4710
|
+
*
|
|
4711
|
+
* Note
|
|
4712
|
+
* ----
|
|
4713
|
+
*
|
|
4714
|
+
* * Data can be passed from server to client through remote events in the same way data is passed from client to server. Any extra information can be passed in as arguments to the [RemoteEvent:FireClient](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireClient) and FireAllClients functions. Note that the FireClient function still needs to pass the player to send the message to as the first argument.
|
|
4715
|
+
*/
|
|
4716
|
+
FireAllClients(this: RemoteEvent, ...args: Parameters<T>): void;
|
|
4717
|
+
/**
|
|
4718
|
+
* **FireClient** causes [OnClientEvent](https://developer.roblox.com/en-us/api-reference/event/RemoteEvent/OnClientEvent) to be fired in [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript)s running for the given [Player](https://developer.roblox.com/en-us/api-reference/class/Player). Additional data passed to this function is then provided to OnClientEvent; beware of [limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations) on this data.
|
|
4719
|
+
*
|
|
4720
|
+
* Since this function is used for communication from server to client, so it will only work when used by a server-side [Script](https://developer.roblox.com/en-us/api-reference/class/Script). For client-to-server communication (the other direction), use [FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer). Direct client-to-client communication not possible on Roblox; however, it can be simulated using a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) that relays information received through some other means, such as [FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer).
|
|
4721
|
+
*
|
|
4722
|
+
* There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
|
|
4723
|
+
*
|
|
4724
|
+
* See also
|
|
4725
|
+
* --------
|
|
4726
|
+
*
|
|
4727
|
+
* * [FireAllClients](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireAllClients), which works similarly but for all [Player](https://developer.roblox.com/en-us/api-reference/class/Player)
|
|
4728
|
+
*
|
|
4729
|
+
* * [Remote Functions and Events](https://developer.roblox.com/articles/Remote-Functions-and-Events), which describes related classes, functions and events and also important limitations on the data that can be sent
|
|
4730
|
+
*
|
|
4731
|
+
* * Sometimes a game will need to send information from one client to another. Roblox does not support direct client to client contact, so any communication must first go through the server. This is typically done using remote events (although functions could be used if desired). First, the sending client would call FireServer. On the server, the function connected to OnServerEvent would hear this firing, and itself would then call FireClient.
|
|
4732
|
+
*/
|
|
4733
|
+
FireClient(this: RemoteEvent, player: Player, ...args: Parameters<T>): void;
|
|
4734
|
+
/**
|
|
4735
|
+
* The FireServer event fires the [RemoteEvent.OnServerEvent](https://developer.roblox.com/en-us/api-reference/event/RemoteEvent/OnServerEvent) event on the server using the arguments specified with an additional player argument at the beginning.
|
|
4736
|
+
*
|
|
4737
|
+
* Since this function is used to communicate from the client to the server, it will only work when used in a [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript).
|
|
4738
|
+
*
|
|
4739
|
+
* When firing from the client note that nothing has to be passed in by default (unlike firing to the client from the server - where the player is passed in).
|
|
4740
|
+
*
|
|
4741
|
+
* The behavior of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
|
|
4742
|
+
*
|
|
4743
|
+
* There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
|
|
4744
|
+
*/
|
|
4745
|
+
FireServer(this: RemoteEvent, ...args: Parameters<T>): void;
|
|
4746
|
+
/**
|
|
4747
|
+
* The OnClientEvent event fires listening functions in [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript) when either [RemoteEvent:FireClient](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireClient) or [RemoteEvent:FireAllClients](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireAllClients) is fired by the server from a [Script](https://developer.roblox.com/en-us/api-reference/class/Script).
|
|
4748
|
+
*
|
|
4749
|
+
* This is used to retrieve remote events fired by the server and intended for the client. This event is in place to provide a method for communicating between the server and client, which is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article. This event retrieves remote events fired by the server to the client.
|
|
4750
|
+
*
|
|
4751
|
+
* To fire from the client to the server, you should use [RemoteEvent:FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer) and [RemoteEvent.OnServerEvent](https://developer.roblox.com/en-us/api-reference/event/RemoteEvent/OnServerEvent).
|
|
4752
|
+
*/
|
|
4753
|
+
readonly OnClientEvent: RBXScriptSignal<T>;
|
|
4754
|
+
/**
|
|
4755
|
+
* Fires listening functions in [Script](https://developer.roblox.com/en-us/api-reference/class/Script) when [RemoteEvent:FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer) is called from a [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript).
|
|
4756
|
+
*
|
|
4757
|
+
* This is used to retrieve remote events fired by the client and intended for the server. This event is in place to provide a method for communicating between the client and server, which is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article. This event retrieves remote events fired by the client to the server.
|
|
4758
|
+
*
|
|
4759
|
+
* To fire from the server to the client, you should use [RemoteEvent:FireClient](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireClient) and [RemoteEvent.OnClientEvent](https://developer.roblox.com/en-us/api-reference/event/RemoteEvent/OnClientEvent).
|
|
4760
|
+
*/
|
|
4761
|
+
readonly OnServerEvent: RBXScriptSignal<(player: Player, ...args: Array<unknown>) => void>;
|
|
4762
|
+
}
|
|
4763
|
+
|
|
4764
|
+
interface UnreliableRemoteEvent extends BaseRemoteEvent {
|
|
4765
|
+
/**
|
|
4766
|
+
* **DO NOT USE!**
|
|
4767
|
+
*
|
|
4768
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
4769
|
+
* @hidden
|
|
4770
|
+
* @deprecated
|
|
4771
|
+
*/
|
|
4772
|
+
readonly _nominal_UnreliableRemoteEvent: unique symbol;
|
|
4773
|
+
FireAllClients(this: UnreliableRemoteEvent, arguments: Array<any>): void;
|
|
4774
|
+
FireClient(this: UnreliableRemoteEvent, player: Player, arguments: Array<any>): void;
|
|
4775
|
+
FireServer(this: UnreliableRemoteEvent, arguments: Array<any>): void;
|
|
4776
|
+
readonly OnClientEvent: RBXScriptSignal<(arguments: Array<any>) => void>;
|
|
4777
|
+
readonly OnServerEvent: RBXScriptSignal<(player: Player, arguments: Array<any>) => void>;
|
|
4778
|
+
}
|
|
4779
|
+
|
|
4655
4780
|
/** The base class for [WrapTarget](https://developer.roblox.com/en-us/api-reference/class/WrapTarget) and [WrapLayer](https://developer.roblox.com/en-us/api-reference/class/WrapLayer) objects. Note that [MeshPart](https://developer.roblox.com/en-us/api-reference/class/MeshPart) is the only valid parent type for [BaseWrap](https://developer.roblox.com/en-us/api-reference/class/BaseWrap) and that it behaves more like a component of [MeshPart](https://developer.roblox.com/en-us/api-reference/class/MeshPart) than an independent object. */
|
|
4656
4781
|
interface BaseWrap extends Instance {
|
|
4657
4782
|
/**
|
|
@@ -9421,7 +9546,7 @@ interface CylinderMesh extends BevelMesh {
|
|
|
9421
9546
|
readonly _nominal_CylinderMesh: unique symbol;
|
|
9422
9547
|
}
|
|
9423
9548
|
|
|
9424
|
-
interface
|
|
9549
|
+
interface EditableMesh extends DataModelMesh {
|
|
9425
9550
|
/**
|
|
9426
9551
|
* **DO NOT USE!**
|
|
9427
9552
|
*
|
|
@@ -9429,38 +9554,38 @@ interface DynamicMesh extends DataModelMesh {
|
|
|
9429
9554
|
* @hidden
|
|
9430
9555
|
* @deprecated
|
|
9431
9556
|
*/
|
|
9432
|
-
readonly
|
|
9557
|
+
readonly _nominal_EditableMesh: unique symbol;
|
|
9433
9558
|
/**
|
|
9434
9559
|
* Tags: Hidden
|
|
9435
9560
|
*/
|
|
9436
9561
|
readonly MeshVersion: number;
|
|
9437
|
-
AddTriangle(this:
|
|
9438
|
-
AddVertex(this:
|
|
9439
|
-
FindClosestPointOnSurface(this:
|
|
9440
|
-
FindClosestVertex(this:
|
|
9441
|
-
FindVerticesWithinSphere(this:
|
|
9442
|
-
GetAdjacentTriangles(this:
|
|
9443
|
-
GetAdjacentVertices(this:
|
|
9444
|
-
GetPosition(this:
|
|
9445
|
-
GetTriangleVertices(this:
|
|
9446
|
-
GetTriangles(this:
|
|
9447
|
-
GetUV(this:
|
|
9448
|
-
GetVertexColor(this:
|
|
9449
|
-
GetVertexColorAlpha(this:
|
|
9450
|
-
GetVertexNormal(this:
|
|
9451
|
-
GetVertices(this:
|
|
9452
|
-
Raycast(this:
|
|
9453
|
-
RemoveTriangle(this:
|
|
9454
|
-
RemoveVertex(this:
|
|
9455
|
-
SetPosition(this:
|
|
9456
|
-
SetUV(this:
|
|
9457
|
-
SetVertexColor(this:
|
|
9458
|
-
SetVertexColorAlpha(this:
|
|
9459
|
-
SetVertexNormal(this:
|
|
9562
|
+
AddTriangle(this: EditableMesh, vertexId0: number, vertexId1: number, vertexId2: number): number;
|
|
9563
|
+
AddVertex(this: EditableMesh, p: Vector3): number;
|
|
9564
|
+
FindClosestPointOnSurface(this: EditableMesh, point: Vector3): unknown;
|
|
9565
|
+
FindClosestVertex(this: EditableMesh, toThisPoint: Vector3): number;
|
|
9566
|
+
FindVerticesWithinSphere(this: EditableMesh, center: Vector3, radius: number): unknown;
|
|
9567
|
+
GetAdjacentTriangles(this: EditableMesh, triangleId: number): unknown;
|
|
9568
|
+
GetAdjacentVertices(this: EditableMesh, vertexId: number): unknown;
|
|
9569
|
+
GetPosition(this: EditableMesh, vertexId: number): Vector3;
|
|
9570
|
+
GetTriangleVertices(this: EditableMesh, triangleId: number): unknown;
|
|
9571
|
+
GetTriangles(this: EditableMesh): unknown;
|
|
9572
|
+
GetUV(this: EditableMesh, vertexId: number): Vector2;
|
|
9573
|
+
GetVertexColor(this: EditableMesh, vertexId: number): Color3;
|
|
9574
|
+
GetVertexColorAlpha(this: EditableMesh, vertexId: number): number;
|
|
9575
|
+
GetVertexNormal(this: EditableMesh, vertexId: number): Vector3;
|
|
9576
|
+
GetVertices(this: EditableMesh): unknown;
|
|
9577
|
+
Raycast(this: EditableMesh, origin: Vector3, direction: Vector3): unknown;
|
|
9578
|
+
RemoveTriangle(this: EditableMesh, triangleId: number): void;
|
|
9579
|
+
RemoveVertex(this: EditableMesh, vertexId: number): void;
|
|
9580
|
+
SetPosition(this: EditableMesh, vertexId: number, p: Vector3): void;
|
|
9581
|
+
SetUV(this: EditableMesh, vertexId: number, uv: Vector2): void;
|
|
9582
|
+
SetVertexColor(this: EditableMesh, vertexId: number, color: Color3): void;
|
|
9583
|
+
SetVertexColorAlpha(this: EditableMesh, vertexId: number, alpha: number): void;
|
|
9584
|
+
SetVertexNormal(this: EditableMesh, vertexId: number, vnormal: Vector3): void;
|
|
9460
9585
|
/**
|
|
9461
9586
|
* Tags: Yields
|
|
9462
9587
|
*/
|
|
9463
|
-
CreateMeshPartAsync(this:
|
|
9588
|
+
CreateMeshPartAsync(this: EditableMesh, collisionFidelity: CastsToEnum<Enum.CollisionFidelity>): MeshPart;
|
|
9464
9589
|
}
|
|
9465
9590
|
|
|
9466
9591
|
/** The FileMesh object applies a textured mesh to a [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) when parented to it. Its properties are inherited by the [SpecialMesh](https://developer.roblox.com/en-us/api-reference/class/SpecialMesh) object.
|
|
@@ -9887,7 +10012,7 @@ interface DataStoreService extends Instance {
|
|
|
9887
10012
|
/**
|
|
9888
10013
|
* This function returns the default [GlobalDataStore](https://developer.roblox.com/en-us/api-reference/class/GlobalDataStore). If you want to access a specific **named** data store instead, you should use the [GetDataStore()](https://developer.roblox.com/en-us/api-reference/function/DataStoreService/GetDataStore) function.
|
|
9889
10014
|
*/
|
|
9890
|
-
GetGlobalDataStore(this: DataStoreService):
|
|
10015
|
+
GetGlobalDataStore(this: DataStoreService): DataStore;
|
|
9891
10016
|
/**
|
|
9892
10017
|
* This method returns an [OrderedDataStore](https://developer.roblox.com/en-us/api-reference/class/OrderedDataStore), similar to the way [GetDataStore()](https://developer.roblox.com/en-us/api-reference/function/DataStoreService/GetDataStore) does with [GlobalDataStores](https://developer.roblox.com/en-us/api-reference/class/GlobalDataStore). Subsequent calls to this method with the same name/scope will return the same object.
|
|
9893
10018
|
*/
|
|
@@ -10354,7 +10479,7 @@ interface DraggerService extends Instance {
|
|
|
10354
10479
|
ShowPivotIndicator: boolean;
|
|
10355
10480
|
}
|
|
10356
10481
|
|
|
10357
|
-
interface
|
|
10482
|
+
interface EditableImage extends Instance {
|
|
10358
10483
|
/**
|
|
10359
10484
|
* **DO NOT USE!**
|
|
10360
10485
|
*
|
|
@@ -10362,24 +10487,24 @@ interface DynamicImage extends Instance {
|
|
|
10362
10487
|
* @hidden
|
|
10363
10488
|
* @deprecated
|
|
10364
10489
|
*/
|
|
10365
|
-
readonly
|
|
10490
|
+
readonly _nominal_EditableImage: unique symbol;
|
|
10366
10491
|
Size: Vector2;
|
|
10367
|
-
Copy(this:
|
|
10368
|
-
Crop(this:
|
|
10369
|
-
DrawCircle(this:
|
|
10370
|
-
DrawImage(this:
|
|
10371
|
-
DrawLine(this:
|
|
10372
|
-
DrawRectangle(this:
|
|
10492
|
+
Copy(this: EditableImage, min: Vector2, max: Vector2): EditableImage;
|
|
10493
|
+
Crop(this: EditableImage, min: Vector2, max: Vector2): void;
|
|
10494
|
+
DrawCircle(this: EditableImage, center: Vector2, radius: number, color: Color3, transparency: number): void;
|
|
10495
|
+
DrawImage(this: EditableImage, position: Vector2, image: EditableImage, combineType: CastsToEnum<Enum.ImageCombineType>): void;
|
|
10496
|
+
DrawLine(this: EditableImage, p1: Vector2, p2: Vector2, color: Color3, transparency: number): void;
|
|
10497
|
+
DrawRectangle(this: EditableImage, position: Vector2, size: Vector2, color: Color3, transparency: number): void;
|
|
10373
10498
|
/**
|
|
10374
10499
|
* Tags: CustomLuaState
|
|
10375
10500
|
*/
|
|
10376
|
-
ReadPixels(this:
|
|
10377
|
-
Resize(this:
|
|
10378
|
-
Rotate(this:
|
|
10501
|
+
ReadPixels(this: EditableImage, position: Vector2, size: Vector2): unknown;
|
|
10502
|
+
Resize(this: EditableImage, size: Vector2): void;
|
|
10503
|
+
Rotate(this: EditableImage, degrees: number, changeSize: boolean): void;
|
|
10379
10504
|
/**
|
|
10380
10505
|
* Tags: CustomLuaState
|
|
10381
10506
|
*/
|
|
10382
|
-
WritePixels(this:
|
|
10507
|
+
WritePixels(this: EditableImage, position: Vector2, size: Vector2, pixels: Array<any>): void;
|
|
10383
10508
|
}
|
|
10384
10509
|
|
|
10385
10510
|
interface EngineAPICloudProcessingService extends Instance {
|
|
@@ -11454,7 +11579,11 @@ interface DataStore extends GlobalDataStore {
|
|
|
11454
11579
|
* @deprecated
|
|
11455
11580
|
*/
|
|
11456
11581
|
readonly _nominal_DataStore: unique symbol;
|
|
11457
|
-
GetAsync<T>(
|
|
11582
|
+
GetAsync<T>(
|
|
11583
|
+
this: DataStore,
|
|
11584
|
+
key: string,
|
|
11585
|
+
options?: DataStoreGetOptions,
|
|
11586
|
+
): LuaTuple<[T | undefined, DataStoreKeyInfo]>;
|
|
11458
11587
|
IncrementAsync(
|
|
11459
11588
|
this: DataStore,
|
|
11460
11589
|
key: string,
|
|
@@ -14272,9 +14401,6 @@ interface ScreenGui extends LayerCollector {
|
|
|
14272
14401
|
* @deprecated
|
|
14273
14402
|
*/
|
|
14274
14403
|
readonly _nominal_ScreenGui: unique symbol;
|
|
14275
|
-
/**
|
|
14276
|
-
* Tags: NotBrowsable
|
|
14277
|
-
*/
|
|
14278
14404
|
ClipToDeviceSafeArea: boolean;
|
|
14279
14405
|
/**
|
|
14280
14406
|
* This property controls the order that multiple ScreenGuis are drawn.
|
|
@@ -14286,9 +14412,6 @@ interface ScreenGui extends LayerCollector {
|
|
|
14286
14412
|
* IgnoreGuiInset is a boolean property of ScreenGuis that, when set to true, will force the [GUI Inset](https://developer.roblox.com/en-us/api-reference/function/GuiService/GetGuiInset) imposed by Roblox's CoreGuis to be ignored by this ScreenGui and its descendants. This means that an element with a UDim2 size of `{1,0},{1,0}` will fill up the entire screen, without a 36 pixel gap reserved for Roblox's top bar.
|
|
14287
14413
|
*/
|
|
14288
14414
|
IgnoreGuiInset: boolean;
|
|
14289
|
-
/**
|
|
14290
|
-
* Tags: NotBrowsable
|
|
14291
|
-
*/
|
|
14292
14415
|
SafeAreaCompatibility: Enum.SafeAreaCompatibility;
|
|
14293
14416
|
/**
|
|
14294
14417
|
* Tags: NotBrowsable
|
|
@@ -15034,6 +15157,17 @@ interface SelectionPointLasso extends SelectionLasso {
|
|
|
15034
15157
|
Point: Vector3;
|
|
15035
15158
|
}
|
|
15036
15159
|
|
|
15160
|
+
interface Path2D extends GuiBase {
|
|
15161
|
+
/**
|
|
15162
|
+
* **DO NOT USE!**
|
|
15163
|
+
*
|
|
15164
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
15165
|
+
* @hidden
|
|
15166
|
+
* @deprecated
|
|
15167
|
+
*/
|
|
15168
|
+
readonly _nominal_Path2D: unique symbol;
|
|
15169
|
+
}
|
|
15170
|
+
|
|
15037
15171
|
/** The GuiService is a service which currently allows developers to control what [GuiObject](https://developer.roblox.com/en-us/api-reference/class/GuiObject) is currently being selected by the gamepad navigator. It also allows clients to check if Roblox's main menu is currently open.
|
|
15038
15172
|
*
|
|
15039
15173
|
* This service has a lot of hidden members, which are mainly used internally by Roblox's [CoreScripts](https://developer.roblox.com/en-us/api-reference/class/CoreScript).
|
|
@@ -26430,6 +26564,7 @@ interface PackageLink extends Instance {
|
|
|
26430
26564
|
* @deprecated
|
|
26431
26565
|
*/
|
|
26432
26566
|
readonly _nominal_PackageLink: unique symbol;
|
|
26567
|
+
readonly DefaultName: string;
|
|
26433
26568
|
/**
|
|
26434
26569
|
* The id of the asset this package corresponds to.
|
|
26435
26570
|
*
|
|
@@ -29433,85 +29568,6 @@ interface RemoteDebuggerServer extends Instance {
|
|
|
29433
29568
|
readonly _nominal_RemoteDebuggerServer: unique symbol;
|
|
29434
29569
|
}
|
|
29435
29570
|
|
|
29436
|
-
/** A **RemoteEvent** is designed to provide a one-way message between the server and clients, allowing [Scripts](https://developer.roblox.com/en-us/api-reference/class/Script) to call code in [LocalScripts](https://developer.roblox.com/en-us/api-reference/class/LocalScript) and vice-versa. This message can be directed from one client to the server, from the server to a particular client, or from the server to all clients.
|
|
29437
|
-
*
|
|
29438
|
-
* In order for both the server and clients to utilize a remote event, the RemoteEvent object itself must be in a place where both sides can see it. As such, we recommend that you store the RemoteEvent inside of [ReplicatedStorage](https://developer.roblox.com/en-us/api-reference/class/ReplicatedStorage), although in some cases it's appropriate to store it in the workspace or inside a [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool).
|
|
29439
|
-
*
|
|
29440
|
-
* If you need the result of the call, you should use a [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) instead. Otherwise a remote event is recommended since it will minimize network traffic/latency and won't yield the script to wait for a response. See [Remote Functions and Events](https://developer.roblox.com/en-us/articles/remote-functions-and-events) for more info.
|
|
29441
|
-
*/
|
|
29442
|
-
interface RemoteEvent<T extends Callback = Callback> extends Instance {
|
|
29443
|
-
/**
|
|
29444
|
-
* **DO NOT USE!**
|
|
29445
|
-
*
|
|
29446
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
29447
|
-
* @hidden
|
|
29448
|
-
* @deprecated
|
|
29449
|
-
*/
|
|
29450
|
-
readonly _nominal_RemoteEvent: unique symbol;
|
|
29451
|
-
/**
|
|
29452
|
-
* The FireAllClients function fires the [RemoteEvent.OnClientEvent](https://developer.roblox.com/en-us/api-reference/event/RemoteEvent/OnClientEvent) event for each client.
|
|
29453
|
-
*
|
|
29454
|
-
* Unlike [RemoteEvent:FireClient](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireClient), this event does not take a target player as an argument. Instead it will fire to all clients who have the same remote event connected to an OnClientEvent event.
|
|
29455
|
-
*
|
|
29456
|
-
* Since this function is used to communicate from the server to the client, it will only work when used in a [Script](https://developer.roblox.com/en-us/api-reference/class/Script).
|
|
29457
|
-
*
|
|
29458
|
-
* The behavior of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
|
|
29459
|
-
*
|
|
29460
|
-
* There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
|
|
29461
|
-
*
|
|
29462
|
-
* Note
|
|
29463
|
-
* ----
|
|
29464
|
-
*
|
|
29465
|
-
* * Data can be passed from server to client through remote events in the same way data is passed from client to server. Any extra information can be passed in as arguments to the [RemoteEvent:FireClient](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireClient) and FireAllClients functions. Note that the FireClient function still needs to pass the player to send the message to as the first argument.
|
|
29466
|
-
*/
|
|
29467
|
-
FireAllClients(this: RemoteEvent, ...args: Parameters<T>): void;
|
|
29468
|
-
/**
|
|
29469
|
-
* **FireClient** causes [OnClientEvent](https://developer.roblox.com/en-us/api-reference/event/RemoteEvent/OnClientEvent) to be fired in [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript)s running for the given [Player](https://developer.roblox.com/en-us/api-reference/class/Player). Additional data passed to this function is then provided to OnClientEvent; beware of [limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations) on this data.
|
|
29470
|
-
*
|
|
29471
|
-
* Since this function is used for communication from server to client, so it will only work when used by a server-side [Script](https://developer.roblox.com/en-us/api-reference/class/Script). For client-to-server communication (the other direction), use [FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer). Direct client-to-client communication not possible on Roblox; however, it can be simulated using a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) that relays information received through some other means, such as [FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer).
|
|
29472
|
-
*
|
|
29473
|
-
* There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
|
|
29474
|
-
*
|
|
29475
|
-
* See also
|
|
29476
|
-
* --------
|
|
29477
|
-
*
|
|
29478
|
-
* * [FireAllClients](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireAllClients), which works similarly but for all [Player](https://developer.roblox.com/en-us/api-reference/class/Player)
|
|
29479
|
-
*
|
|
29480
|
-
* * [Remote Functions and Events](https://developer.roblox.com/articles/Remote-Functions-and-Events), which describes related classes, functions and events and also important limitations on the data that can be sent
|
|
29481
|
-
*
|
|
29482
|
-
* * Sometimes a game will need to send information from one client to another. Roblox does not support direct client to client contact, so any communication must first go through the server. This is typically done using remote events (although functions could be used if desired). First, the sending client would call FireServer. On the server, the function connected to OnServerEvent would hear this firing, and itself would then call FireClient.
|
|
29483
|
-
*/
|
|
29484
|
-
FireClient(this: RemoteEvent, player: Player, ...args: Parameters<T>): void;
|
|
29485
|
-
/**
|
|
29486
|
-
* The FireServer event fires the [RemoteEvent.OnServerEvent](https://developer.roblox.com/en-us/api-reference/event/RemoteEvent/OnServerEvent) event on the server using the arguments specified with an additional player argument at the beginning.
|
|
29487
|
-
*
|
|
29488
|
-
* Since this function is used to communicate from the client to the server, it will only work when used in a [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript).
|
|
29489
|
-
*
|
|
29490
|
-
* When firing from the client note that nothing has to be passed in by default (unlike firing to the client from the server - where the player is passed in).
|
|
29491
|
-
*
|
|
29492
|
-
* The behavior of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
|
|
29493
|
-
*
|
|
29494
|
-
* There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
|
|
29495
|
-
*/
|
|
29496
|
-
FireServer(this: RemoteEvent, ...args: Parameters<T>): void;
|
|
29497
|
-
/**
|
|
29498
|
-
* The OnClientEvent event fires listening functions in [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript) when either [RemoteEvent:FireClient](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireClient) or [RemoteEvent:FireAllClients](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireAllClients) is fired by the server from a [Script](https://developer.roblox.com/en-us/api-reference/class/Script).
|
|
29499
|
-
*
|
|
29500
|
-
* This is used to retrieve remote events fired by the server and intended for the client. This event is in place to provide a method for communicating between the server and client, which is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article. This event retrieves remote events fired by the server to the client.
|
|
29501
|
-
*
|
|
29502
|
-
* To fire from the client to the server, you should use [RemoteEvent:FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer) and [RemoteEvent.OnServerEvent](https://developer.roblox.com/en-us/api-reference/event/RemoteEvent/OnServerEvent).
|
|
29503
|
-
*/
|
|
29504
|
-
readonly OnClientEvent: RBXScriptSignal<T>;
|
|
29505
|
-
/**
|
|
29506
|
-
* Fires listening functions in [Script](https://developer.roblox.com/en-us/api-reference/class/Script) when [RemoteEvent:FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer) is called from a [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript).
|
|
29507
|
-
*
|
|
29508
|
-
* This is used to retrieve remote events fired by the client and intended for the server. This event is in place to provide a method for communicating between the client and server, which is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article. This event retrieves remote events fired by the client to the server.
|
|
29509
|
-
*
|
|
29510
|
-
* To fire from the server to the client, you should use [RemoteEvent:FireClient](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireClient) and [RemoteEvent.OnClientEvent](https://developer.roblox.com/en-us/api-reference/event/RemoteEvent/OnClientEvent).
|
|
29511
|
-
*/
|
|
29512
|
-
readonly OnServerEvent: RBXScriptSignal<(player: Player, ...args: Array<unknown>) => void>;
|
|
29513
|
-
}
|
|
29514
|
-
|
|
29515
29571
|
/** A server should rarely invoke a client via [InvokeClient()](https://developer.roblox.com/en-us/api-reference/function/RemoteFunction/InvokeClient) as it can be potentially game breaking. For client-only actions that don't require a callback, like updating a GUI, a [server-to-client remote event](#server-to-client-remote-event) should be used instead. If [InvokeClient()](https://developer.roblox.com/en-us/api-reference/function/RemoteFunction/InvokeClient) is used, risks include:
|
|
29516
29572
|
*
|
|
29517
29573
|
* * If the client throws an error, the server will throw the error too.
|
|
@@ -29684,6 +29740,7 @@ interface RomarkService extends Instance {
|
|
|
29684
29740
|
* @deprecated
|
|
29685
29741
|
*/
|
|
29686
29742
|
readonly _nominal_RomarkService: unique symbol;
|
|
29743
|
+
EndRemoteRomarkTest(this: RomarkService): void;
|
|
29687
29744
|
}
|
|
29688
29745
|
|
|
29689
29746
|
/** A sorted list of [RotationCurveKey](https://developer.roblox.com/en-us/api-reference/class/RotationCurveKeys). RotationCurveKeys are value-time points on a curve that dictate the animation curves. It provides a sampling method returning its result as the rotation component of a CFrame. */
|
|
@@ -30999,7 +31056,6 @@ interface SocialService extends Instance {
|
|
|
30999
31056
|
* Before using this function, you should use the [CanSendGameInviteAsync](https://developer.roblox.com/en-us/api-reference/function/SocialService/CanSendGameInviteAsync) function to determine whether a player can send a game invite, as this can vary depending on the platform or player. After determining that invites are possible for this player, allow the player to opt-in to inviting others. For example, the player clicked on an “Invite Friends” button, shown after `CanSendGameInviteAsync` returned true.\`
|
|
31000
31057
|
*/
|
|
31001
31058
|
PromptGameInvite(this: SocialService, player: Player, experienceInviteOptions?: ExperienceInviteOptions): void;
|
|
31002
|
-
PromptIrisInvite(this: SocialService, player: Player, tag: string): void;
|
|
31003
31059
|
PromptPhoneBook(this: SocialService, player: Player, tag: string): void;
|
|
31004
31060
|
ShowSelfView(this: SocialService, selfViewPosition?: CastsToEnum<Enum.SelfViewPosition>): void;
|
|
31005
31061
|
/**
|
|
@@ -31014,10 +31070,6 @@ interface SocialService extends Instance {
|
|
|
31014
31070
|
* Tags: Yields
|
|
31015
31071
|
*/
|
|
31016
31072
|
CanSendGameInviteAsync(this: SocialService, player: Player, recipientId?: number): boolean;
|
|
31017
|
-
/**
|
|
31018
|
-
* Tags: Yields
|
|
31019
|
-
*/
|
|
31020
|
-
CanSendIrisInviteAsync(this: SocialService, player: Player): boolean;
|
|
31021
31073
|
readonly CallInviteStateChanged: RBXScriptSignal<(player: Player, inviteState: Enum.InviteState) => void>;
|
|
31022
31074
|
/**
|
|
31023
31075
|
* This event is a signal invoked when a player has closed the game invite prompt and batches all users and conversation participants into a single array. This prompt can be prompted by the developer or accessed from the SettingsHub menu.
|
|
@@ -31044,10 +31096,8 @@ interface SocialService extends Instance {
|
|
|
31044
31096
|
* * [SocialService:CanSendGameInviteAsync](https://developer.roblox.com/en-us/api-reference/function/SocialService/CanSendGameInviteAsync), returns true or false depending on the user
|
|
31045
31097
|
*/
|
|
31046
31098
|
readonly GameInvitePromptClosed: RBXScriptSignal<(senderPlayer: Player, recipientIds: Array<number>) => void>;
|
|
31047
|
-
readonly IrisInvitePromptClosed: RBXScriptSignal<(player: Player) => void>;
|
|
31048
31099
|
readonly PhoneBookPromptClosed: RBXScriptSignal<(player: Player) => void>;
|
|
31049
31100
|
OnCallInviteInvoked: (tag: string, callParticipantIds: Array<any>) => Instance;
|
|
31050
|
-
OnIrisInviteInvoked: (tag: string, irisParticipantIds: Array<any>) => Instance;
|
|
31051
31101
|
}
|
|
31052
31102
|
|
|
31053
31103
|
/** A [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) is an object that emits sound. See [Adding Sounds](https://developer.roblox.com/en-us/articles/adding-sounds) for more info on how to upload a sound file.
|
|
@@ -31084,6 +31134,7 @@ interface Sound extends Instance {
|
|
|
31084
31134
|
* Sounds parented to a [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) or [Attachment](https://developer.roblox.com/en-us/api-reference/class/Attachment) that are descendants of the [Workspace](https://developer.roblox.com/en-us/api-reference/class/Workspace) are considered 3D sounds and their volume whilst playing is dependent on the distance between the client's sound listener ([Camera](https://developer.roblox.com/en-us/api-reference/class/Camera) position by default) and the Sound's parent. Two properties influence this behavior EmitterSize and [Sound.RollOffMode](https://developer.roblox.com/en-us/api-reference/property/Sound/RollOffMode).
|
|
31085
31135
|
*
|
|
31086
31136
|
* The way the [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) attenuates (fades out) after the distance between the listener and the sound exceeds the EmitterSize is determined by RollOffMode.
|
|
31137
|
+
* @deprecated Use `RollOffMinDistance` instead
|
|
31087
31138
|
*/
|
|
31088
31139
|
EmitterSize: number;
|
|
31089
31140
|
/**
|
|
@@ -31129,12 +31180,14 @@ interface Sound extends Instance {
|
|
|
31129
31180
|
* How MaxDistance impacts the attenuation of a sound (manner in which it fades out) is dependent on the [Sound.RollOffMode](https://developer.roblox.com/en-us/api-reference/property/Sound/RollOffMode) property. When RollOffMode is set to use an inverse type distance model (Inverse or InverseTapered) the MaxDistance will not effect the attenuation of the sound. This means that low values for MaxDistance will cause the sound to abruptly cut off when the listener reaches the MaxDistance. In most cases this is not desirable and developers are advised not to use low MaxDistance values.
|
|
31130
31181
|
*
|
|
31131
31182
|
* When RollOffMode is set to a linear type distance model (Linear or LinearSquared) the sound will attenuate between [Sound.EmitterSize](https://developer.roblox.com/en-us/api-reference/property/Sound/EmitterSize) and MaxDistance (with playback volume reaching zero at MaxDistance). This is less realistic, but in some cases allows attenuation to be handled in a more intuitive way.
|
|
31183
|
+
* @deprecated Use `RollOffMaxDistance` instead
|
|
31132
31184
|
*/
|
|
31133
31185
|
MaxDistance: number;
|
|
31134
31186
|
/**
|
|
31135
31187
|
* The minimum distance at which a 3D [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) (direct child of a [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) or [Attachment](https://developer.roblox.com/en-us/api-reference/class/Attachment)) will begin to attenuate. Effectively, the emitter size.
|
|
31136
31188
|
*
|
|
31137
31189
|
* Deprecated in favor of Sound.EmitterSize.
|
|
31190
|
+
* @deprecated Use `RollOffMinDistance` instead
|
|
31138
31191
|
*/
|
|
31139
31192
|
MinDistance: number;
|
|
31140
31193
|
/**
|
|
@@ -434,6 +434,38 @@ declare namespace Enum {
|
|
|
434
434
|
export type AdornCullingMode = AdornCullingMode.Automatic | AdornCullingMode.Never;
|
|
435
435
|
|
|
436
436
|
export namespace AlignType {
|
|
437
|
+
export interface PrimaryAxisParallel extends globalThis.EnumItem {
|
|
438
|
+
Name: "PrimaryAxisParallel";
|
|
439
|
+
Value: 2;
|
|
440
|
+
EnumType: typeof globalThis.Enum.AlignType;
|
|
441
|
+
}
|
|
442
|
+
|
|
443
|
+
export const PrimaryAxisParallel: PrimaryAxisParallel;
|
|
444
|
+
|
|
445
|
+
export interface PrimaryAxisPerpendicular extends globalThis.EnumItem {
|
|
446
|
+
Name: "PrimaryAxisPerpendicular";
|
|
447
|
+
Value: 3;
|
|
448
|
+
EnumType: typeof globalThis.Enum.AlignType;
|
|
449
|
+
}
|
|
450
|
+
|
|
451
|
+
export const PrimaryAxisPerpendicular: PrimaryAxisPerpendicular;
|
|
452
|
+
|
|
453
|
+
export interface PrimaryAxisLookAt extends globalThis.EnumItem {
|
|
454
|
+
Name: "PrimaryAxisLookAt";
|
|
455
|
+
Value: 4;
|
|
456
|
+
EnumType: typeof globalThis.Enum.AlignType;
|
|
457
|
+
}
|
|
458
|
+
|
|
459
|
+
export const PrimaryAxisLookAt: PrimaryAxisLookAt;
|
|
460
|
+
|
|
461
|
+
export interface AllAxes extends globalThis.EnumItem {
|
|
462
|
+
Name: "AllAxes";
|
|
463
|
+
Value: 5;
|
|
464
|
+
EnumType: typeof globalThis.Enum.AlignType;
|
|
465
|
+
}
|
|
466
|
+
|
|
467
|
+
export const AllAxes: AllAxes;
|
|
468
|
+
|
|
437
469
|
export interface Parallel extends globalThis.EnumItem {
|
|
438
470
|
Name: "Parallel";
|
|
439
471
|
Value: 0;
|
|
@@ -452,7 +484,7 @@ declare namespace Enum {
|
|
|
452
484
|
|
|
453
485
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AlignType>;
|
|
454
486
|
}
|
|
455
|
-
export type AlignType = AlignType.Parallel | AlignType.Perpendicular;
|
|
487
|
+
export type AlignType = AlignType.PrimaryAxisParallel | AlignType.PrimaryAxisPerpendicular | AlignType.PrimaryAxisLookAt | AlignType.AllAxes | AlignType.Parallel | AlignType.Perpendicular;
|
|
456
488
|
|
|
457
489
|
export namespace AlphaMode {
|
|
458
490
|
export interface Overlay extends globalThis.EnumItem {
|
|
@@ -4541,6 +4573,14 @@ declare namespace Enum {
|
|
|
4541
4573
|
|
|
4542
4574
|
export const NetworkSecurity: NetworkSecurity;
|
|
4543
4575
|
|
|
4576
|
+
export interface ReplacementReady extends globalThis.EnumItem {
|
|
4577
|
+
Name: "ReplacementReady";
|
|
4578
|
+
Value: 301;
|
|
4579
|
+
EnumType: typeof globalThis.Enum.ConnectionError;
|
|
4580
|
+
}
|
|
4581
|
+
|
|
4582
|
+
export const ReplacementReady: ReplacementReady;
|
|
4583
|
+
|
|
4544
4584
|
export interface PlacelaunchErrors extends globalThis.EnumItem {
|
|
4545
4585
|
Name: "PlacelaunchErrors";
|
|
4546
4586
|
Value: 512;
|
|
@@ -4735,7 +4775,7 @@ declare namespace Enum {
|
|
|
4735
4775
|
|
|
4736
4776
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ConnectionError>;
|
|
4737
4777
|
}
|
|
4738
|
-
export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectProtocolMismatch | ConnectionError.DisconnectReceivePacketError | ConnectionError.DisconnectReceivePacketStreamError | ConnectionError.DisconnectSendPacketError | ConnectionError.DisconnectIllegalTeleport | ConnectionError.DisconnectDuplicatePlayer | ConnectionError.DisconnectDuplicateTicket | ConnectionError.DisconnectTimeout | ConnectionError.DisconnectLuaKick | ConnectionError.DisconnectOnRemoteSysStats | ConnectionError.DisconnectHashTimeout | ConnectionError.DisconnectCloudEditKick | ConnectionError.DisconnectPlayerless | ConnectionError.DisconnectNewSecurityKeyMismatch | ConnectionError.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.DisconnectPrivateServerKickout | ConnectionError.DisconnectModeratedGame | ConnectionError.ServerShutdown | ConnectionError.ReplicatorTimeout | ConnectionError.PlayerRemoved | ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave | ConnectionError.DisconnectRomarkEndOfTest | ConnectionError.DisconnectCollaboratorPermissionRevoked | ConnectionError.DisconnectCollaboratorUnderage | ConnectionError.NetworkInternal | ConnectionError.NetworkSend | ConnectionError.NetworkTimeout | ConnectionError.NetworkMisbehavior | ConnectionError.NetworkSecurity | ConnectionError.PlacelaunchErrors | ConnectionError.PlacelaunchDisabled | ConnectionError.PlacelaunchError | ConnectionError.PlacelaunchGameEnded | ConnectionError.PlacelaunchGameFull | ConnectionError.PlacelaunchUserLeft | ConnectionError.PlacelaunchRestricted | ConnectionError.PlacelaunchUnauthorized | ConnectionError.PlacelaunchFlooded | ConnectionError.PlacelaunchHashExpired | ConnectionError.PlacelaunchHashException | ConnectionError.PlacelaunchPartyCannotFit | ConnectionError.PlacelaunchHttpError | ConnectionError.PlacelaunchUserPrivacyUnauthorized | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
|
|
4778
|
+
export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectProtocolMismatch | ConnectionError.DisconnectReceivePacketError | ConnectionError.DisconnectReceivePacketStreamError | ConnectionError.DisconnectSendPacketError | ConnectionError.DisconnectIllegalTeleport | ConnectionError.DisconnectDuplicatePlayer | ConnectionError.DisconnectDuplicateTicket | ConnectionError.DisconnectTimeout | ConnectionError.DisconnectLuaKick | ConnectionError.DisconnectOnRemoteSysStats | ConnectionError.DisconnectHashTimeout | ConnectionError.DisconnectCloudEditKick | ConnectionError.DisconnectPlayerless | ConnectionError.DisconnectNewSecurityKeyMismatch | ConnectionError.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.DisconnectPrivateServerKickout | ConnectionError.DisconnectModeratedGame | ConnectionError.ServerShutdown | ConnectionError.ReplicatorTimeout | ConnectionError.PlayerRemoved | ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave | ConnectionError.DisconnectRomarkEndOfTest | ConnectionError.DisconnectCollaboratorPermissionRevoked | ConnectionError.DisconnectCollaboratorUnderage | ConnectionError.NetworkInternal | ConnectionError.NetworkSend | ConnectionError.NetworkTimeout | ConnectionError.NetworkMisbehavior | ConnectionError.NetworkSecurity | ConnectionError.ReplacementReady | ConnectionError.PlacelaunchErrors | ConnectionError.PlacelaunchDisabled | ConnectionError.PlacelaunchError | ConnectionError.PlacelaunchGameEnded | ConnectionError.PlacelaunchGameFull | ConnectionError.PlacelaunchUserLeft | ConnectionError.PlacelaunchRestricted | ConnectionError.PlacelaunchUnauthorized | ConnectionError.PlacelaunchFlooded | ConnectionError.PlacelaunchHashExpired | ConnectionError.PlacelaunchHashException | ConnectionError.PlacelaunchPartyCannotFit | ConnectionError.PlacelaunchHttpError | ConnectionError.PlacelaunchUserPrivacyUnauthorized | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
|
|
4739
4779
|
|
|
4740
4780
|
export namespace ConnectionState {
|
|
4741
4781
|
export interface Connected extends globalThis.EnumItem {
|
|
@@ -4888,9 +4928,17 @@ declare namespace Enum {
|
|
|
4888
4928
|
|
|
4889
4929
|
export const SelfView: SelfView;
|
|
4890
4930
|
|
|
4931
|
+
export interface Captures extends globalThis.EnumItem {
|
|
4932
|
+
Name: "Captures";
|
|
4933
|
+
Value: 7;
|
|
4934
|
+
EnumType: typeof globalThis.Enum.CoreGuiType;
|
|
4935
|
+
}
|
|
4936
|
+
|
|
4937
|
+
export const Captures: Captures;
|
|
4938
|
+
|
|
4891
4939
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.CoreGuiType>;
|
|
4892
4940
|
}
|
|
4893
|
-
export type CoreGuiType = CoreGuiType.PlayerList | CoreGuiType.Health | CoreGuiType.Backpack | CoreGuiType.Chat | CoreGuiType.All | CoreGuiType.EmotesMenu | CoreGuiType.SelfView;
|
|
4941
|
+
export type CoreGuiType = CoreGuiType.PlayerList | CoreGuiType.Health | CoreGuiType.Backpack | CoreGuiType.Chat | CoreGuiType.All | CoreGuiType.EmotesMenu | CoreGuiType.SelfView | CoreGuiType.Captures;
|
|
4894
4942
|
|
|
4895
4943
|
export namespace CreateOutfitFailure {
|
|
4896
4944
|
export interface InvalidName extends globalThis.EnumItem {
|
|
@@ -11402,79 +11450,61 @@ declare namespace Enum {
|
|
|
11402
11450
|
|
|
11403
11451
|
export const Plastic: Plastic;
|
|
11404
11452
|
|
|
11405
|
-
export interface
|
|
11406
|
-
Name: "
|
|
11407
|
-
Value:
|
|
11408
|
-
EnumType: typeof globalThis.Enum.Material;
|
|
11409
|
-
}
|
|
11410
|
-
|
|
11411
|
-
export const Wood: Wood;
|
|
11412
|
-
|
|
11413
|
-
export interface Slate extends globalThis.EnumItem {
|
|
11414
|
-
Name: "Slate";
|
|
11415
|
-
Value: 800;
|
|
11416
|
-
EnumType: typeof globalThis.Enum.Material;
|
|
11417
|
-
}
|
|
11418
|
-
|
|
11419
|
-
export const Slate: Slate;
|
|
11420
|
-
|
|
11421
|
-
export interface Concrete extends globalThis.EnumItem {
|
|
11422
|
-
Name: "Concrete";
|
|
11423
|
-
Value: 816;
|
|
11453
|
+
export interface SmoothPlastic extends globalThis.EnumItem {
|
|
11454
|
+
Name: "SmoothPlastic";
|
|
11455
|
+
Value: 272;
|
|
11424
11456
|
EnumType: typeof globalThis.Enum.Material;
|
|
11425
11457
|
}
|
|
11426
11458
|
|
|
11427
|
-
export const
|
|
11459
|
+
export const SmoothPlastic: SmoothPlastic;
|
|
11428
11460
|
|
|
11429
|
-
export interface
|
|
11430
|
-
Name: "
|
|
11431
|
-
Value:
|
|
11461
|
+
export interface Neon extends globalThis.EnumItem {
|
|
11462
|
+
Name: "Neon";
|
|
11463
|
+
Value: 288;
|
|
11432
11464
|
EnumType: typeof globalThis.Enum.Material;
|
|
11433
11465
|
}
|
|
11434
11466
|
|
|
11435
|
-
export const
|
|
11467
|
+
export const Neon: Neon;
|
|
11436
11468
|
|
|
11437
|
-
export interface
|
|
11438
|
-
Name: "
|
|
11439
|
-
Value:
|
|
11469
|
+
export interface Wood extends globalThis.EnumItem {
|
|
11470
|
+
Name: "Wood";
|
|
11471
|
+
Value: 512;
|
|
11440
11472
|
EnumType: typeof globalThis.Enum.Material;
|
|
11441
11473
|
}
|
|
11442
11474
|
|
|
11443
|
-
export const
|
|
11475
|
+
export const Wood: Wood;
|
|
11444
11476
|
|
|
11445
|
-
export interface
|
|
11446
|
-
Name: "
|
|
11447
|
-
Value:
|
|
11477
|
+
export interface WoodPlanks extends globalThis.EnumItem {
|
|
11478
|
+
Name: "WoodPlanks";
|
|
11479
|
+
Value: 528;
|
|
11448
11480
|
EnumType: typeof globalThis.Enum.Material;
|
|
11449
11481
|
}
|
|
11450
11482
|
|
|
11451
|
-
export const
|
|
11452
|
-
/** @deprecated renamed to Foil */
|
|
11453
|
-
export const Aluminum: Foil;
|
|
11483
|
+
export const WoodPlanks: WoodPlanks;
|
|
11454
11484
|
|
|
11455
|
-
export interface
|
|
11456
|
-
Name: "
|
|
11457
|
-
Value:
|
|
11485
|
+
export interface Marble extends globalThis.EnumItem {
|
|
11486
|
+
Name: "Marble";
|
|
11487
|
+
Value: 784;
|
|
11458
11488
|
EnumType: typeof globalThis.Enum.Material;
|
|
11459
11489
|
}
|
|
11460
11490
|
|
|
11461
|
-
export const
|
|
11491
|
+
export const Marble: Marble;
|
|
11462
11492
|
|
|
11463
|
-
export interface
|
|
11464
|
-
Name: "
|
|
11465
|
-
Value:
|
|
11493
|
+
export interface Slate extends globalThis.EnumItem {
|
|
11494
|
+
Name: "Slate";
|
|
11495
|
+
Value: 800;
|
|
11466
11496
|
EnumType: typeof globalThis.Enum.Material;
|
|
11467
11497
|
}
|
|
11468
11498
|
|
|
11469
|
-
export const
|
|
11499
|
+
export const Slate: Slate;
|
|
11470
11500
|
|
|
11471
|
-
export interface
|
|
11472
|
-
Name: "
|
|
11473
|
-
Value:
|
|
11501
|
+
export interface Concrete extends globalThis.EnumItem {
|
|
11502
|
+
Name: "Concrete";
|
|
11503
|
+
Value: 816;
|
|
11474
11504
|
EnumType: typeof globalThis.Enum.Material;
|
|
11475
11505
|
}
|
|
11476
11506
|
|
|
11477
|
-
export const
|
|
11507
|
+
export const Concrete: Concrete;
|
|
11478
11508
|
|
|
11479
11509
|
export interface Granite extends globalThis.EnumItem {
|
|
11480
11510
|
Name: "Granite";
|
|
@@ -11500,149 +11530,151 @@ declare namespace Enum {
|
|
|
11500
11530
|
|
|
11501
11531
|
export const Pebble: Pebble;
|
|
11502
11532
|
|
|
11503
|
-
export interface
|
|
11504
|
-
Name: "
|
|
11505
|
-
Value:
|
|
11533
|
+
export interface Cobblestone extends globalThis.EnumItem {
|
|
11534
|
+
Name: "Cobblestone";
|
|
11535
|
+
Value: 880;
|
|
11506
11536
|
EnumType: typeof globalThis.Enum.Material;
|
|
11507
11537
|
}
|
|
11508
11538
|
|
|
11509
|
-
export const
|
|
11539
|
+
export const Cobblestone: Cobblestone;
|
|
11510
11540
|
|
|
11511
|
-
export interface
|
|
11512
|
-
Name: "
|
|
11513
|
-
Value:
|
|
11541
|
+
export interface Rock extends globalThis.EnumItem {
|
|
11542
|
+
Name: "Rock";
|
|
11543
|
+
Value: 896;
|
|
11514
11544
|
EnumType: typeof globalThis.Enum.Material;
|
|
11515
11545
|
}
|
|
11516
11546
|
|
|
11517
|
-
export const
|
|
11547
|
+
export const Rock: Rock;
|
|
11518
11548
|
|
|
11519
|
-
export interface
|
|
11520
|
-
Name: "
|
|
11521
|
-
Value:
|
|
11549
|
+
export interface Sandstone extends globalThis.EnumItem {
|
|
11550
|
+
Name: "Sandstone";
|
|
11551
|
+
Value: 912;
|
|
11522
11552
|
EnumType: typeof globalThis.Enum.Material;
|
|
11523
11553
|
}
|
|
11524
11554
|
|
|
11525
|
-
export const
|
|
11555
|
+
export const Sandstone: Sandstone;
|
|
11526
11556
|
|
|
11527
|
-
export interface
|
|
11528
|
-
Name: "
|
|
11529
|
-
Value:
|
|
11557
|
+
export interface Basalt extends globalThis.EnumItem {
|
|
11558
|
+
Name: "Basalt";
|
|
11559
|
+
Value: 788;
|
|
11530
11560
|
EnumType: typeof globalThis.Enum.Material;
|
|
11531
11561
|
}
|
|
11532
11562
|
|
|
11533
|
-
export const
|
|
11563
|
+
export const Basalt: Basalt;
|
|
11534
11564
|
|
|
11535
|
-
export interface
|
|
11536
|
-
Name: "
|
|
11537
|
-
Value:
|
|
11565
|
+
export interface CrackedLava extends globalThis.EnumItem {
|
|
11566
|
+
Name: "CrackedLava";
|
|
11567
|
+
Value: 804;
|
|
11538
11568
|
EnumType: typeof globalThis.Enum.Material;
|
|
11539
11569
|
}
|
|
11540
11570
|
|
|
11541
|
-
export const
|
|
11571
|
+
export const CrackedLava: CrackedLava;
|
|
11542
11572
|
|
|
11543
|
-
export interface
|
|
11544
|
-
Name: "
|
|
11545
|
-
Value:
|
|
11573
|
+
export interface Limestone extends globalThis.EnumItem {
|
|
11574
|
+
Name: "Limestone";
|
|
11575
|
+
Value: 820;
|
|
11546
11576
|
EnumType: typeof globalThis.Enum.Material;
|
|
11547
11577
|
}
|
|
11548
11578
|
|
|
11549
|
-
export const
|
|
11579
|
+
export const Limestone: Limestone;
|
|
11550
11580
|
|
|
11551
|
-
export interface
|
|
11552
|
-
Name: "
|
|
11553
|
-
Value:
|
|
11581
|
+
export interface Pavement extends globalThis.EnumItem {
|
|
11582
|
+
Name: "Pavement";
|
|
11583
|
+
Value: 836;
|
|
11554
11584
|
EnumType: typeof globalThis.Enum.Material;
|
|
11555
11585
|
}
|
|
11556
11586
|
|
|
11557
|
-
export const
|
|
11587
|
+
export const Pavement: Pavement;
|
|
11558
11588
|
|
|
11559
|
-
export interface
|
|
11560
|
-
Name: "
|
|
11561
|
-
Value:
|
|
11589
|
+
export interface CorrodedMetal extends globalThis.EnumItem {
|
|
11590
|
+
Name: "CorrodedMetal";
|
|
11591
|
+
Value: 1040;
|
|
11562
11592
|
EnumType: typeof globalThis.Enum.Material;
|
|
11563
11593
|
}
|
|
11564
11594
|
|
|
11565
|
-
export const
|
|
11595
|
+
export const CorrodedMetal: CorrodedMetal;
|
|
11566
11596
|
|
|
11567
|
-
export interface
|
|
11568
|
-
Name: "
|
|
11569
|
-
Value:
|
|
11597
|
+
export interface DiamondPlate extends globalThis.EnumItem {
|
|
11598
|
+
Name: "DiamondPlate";
|
|
11599
|
+
Value: 1056;
|
|
11570
11600
|
EnumType: typeof globalThis.Enum.Material;
|
|
11571
11601
|
}
|
|
11572
11602
|
|
|
11573
|
-
export const
|
|
11603
|
+
export const DiamondPlate: DiamondPlate;
|
|
11574
11604
|
|
|
11575
|
-
export interface
|
|
11576
|
-
Name: "
|
|
11577
|
-
Value:
|
|
11605
|
+
export interface Foil extends globalThis.EnumItem {
|
|
11606
|
+
Name: "Foil";
|
|
11607
|
+
Value: 1072;
|
|
11578
11608
|
EnumType: typeof globalThis.Enum.Material;
|
|
11579
11609
|
}
|
|
11580
11610
|
|
|
11581
|
-
export const
|
|
11611
|
+
export const Foil: Foil;
|
|
11612
|
+
/** @deprecated renamed to Foil */
|
|
11613
|
+
export const Aluminum: Foil;
|
|
11582
11614
|
|
|
11583
|
-
export interface
|
|
11584
|
-
Name: "
|
|
11585
|
-
Value:
|
|
11615
|
+
export interface Metal extends globalThis.EnumItem {
|
|
11616
|
+
Name: "Metal";
|
|
11617
|
+
Value: 1088;
|
|
11586
11618
|
EnumType: typeof globalThis.Enum.Material;
|
|
11587
11619
|
}
|
|
11588
11620
|
|
|
11589
|
-
export const
|
|
11621
|
+
export const Metal: Metal;
|
|
11590
11622
|
|
|
11591
|
-
export interface
|
|
11592
|
-
Name: "
|
|
11593
|
-
Value:
|
|
11623
|
+
export interface Grass extends globalThis.EnumItem {
|
|
11624
|
+
Name: "Grass";
|
|
11625
|
+
Value: 1280;
|
|
11594
11626
|
EnumType: typeof globalThis.Enum.Material;
|
|
11595
11627
|
}
|
|
11596
11628
|
|
|
11597
|
-
export const
|
|
11629
|
+
export const Grass: Grass;
|
|
11598
11630
|
|
|
11599
|
-
export interface
|
|
11600
|
-
Name: "
|
|
11601
|
-
Value:
|
|
11631
|
+
export interface LeafyGrass extends globalThis.EnumItem {
|
|
11632
|
+
Name: "LeafyGrass";
|
|
11633
|
+
Value: 1284;
|
|
11602
11634
|
EnumType: typeof globalThis.Enum.Material;
|
|
11603
11635
|
}
|
|
11604
11636
|
|
|
11605
|
-
export const
|
|
11637
|
+
export const LeafyGrass: LeafyGrass;
|
|
11606
11638
|
|
|
11607
|
-
export interface
|
|
11608
|
-
Name: "
|
|
11609
|
-
Value:
|
|
11639
|
+
export interface Sand extends globalThis.EnumItem {
|
|
11640
|
+
Name: "Sand";
|
|
11641
|
+
Value: 1296;
|
|
11610
11642
|
EnumType: typeof globalThis.Enum.Material;
|
|
11611
11643
|
}
|
|
11612
11644
|
|
|
11613
|
-
export const
|
|
11645
|
+
export const Sand: Sand;
|
|
11614
11646
|
|
|
11615
|
-
export interface
|
|
11616
|
-
Name: "
|
|
11617
|
-
Value:
|
|
11647
|
+
export interface Fabric extends globalThis.EnumItem {
|
|
11648
|
+
Name: "Fabric";
|
|
11649
|
+
Value: 1312;
|
|
11618
11650
|
EnumType: typeof globalThis.Enum.Material;
|
|
11619
11651
|
}
|
|
11620
11652
|
|
|
11621
|
-
export const
|
|
11653
|
+
export const Fabric: Fabric;
|
|
11622
11654
|
|
|
11623
|
-
export interface
|
|
11624
|
-
Name: "
|
|
11625
|
-
Value:
|
|
11655
|
+
export interface Snow extends globalThis.EnumItem {
|
|
11656
|
+
Name: "Snow";
|
|
11657
|
+
Value: 1328;
|
|
11626
11658
|
EnumType: typeof globalThis.Enum.Material;
|
|
11627
11659
|
}
|
|
11628
11660
|
|
|
11629
|
-
export const
|
|
11661
|
+
export const Snow: Snow;
|
|
11630
11662
|
|
|
11631
|
-
export interface
|
|
11632
|
-
Name: "
|
|
11633
|
-
Value:
|
|
11663
|
+
export interface Mud extends globalThis.EnumItem {
|
|
11664
|
+
Name: "Mud";
|
|
11665
|
+
Value: 1344;
|
|
11634
11666
|
EnumType: typeof globalThis.Enum.Material;
|
|
11635
11667
|
}
|
|
11636
11668
|
|
|
11637
|
-
export const
|
|
11669
|
+
export const Mud: Mud;
|
|
11638
11670
|
|
|
11639
|
-
export interface
|
|
11640
|
-
Name: "
|
|
11641
|
-
Value:
|
|
11671
|
+
export interface Ground extends globalThis.EnumItem {
|
|
11672
|
+
Name: "Ground";
|
|
11673
|
+
Value: 1360;
|
|
11642
11674
|
EnumType: typeof globalThis.Enum.Material;
|
|
11643
11675
|
}
|
|
11644
11676
|
|
|
11645
|
-
export const
|
|
11677
|
+
export const Ground: Ground;
|
|
11646
11678
|
|
|
11647
11679
|
export interface Asphalt extends globalThis.EnumItem {
|
|
11648
11680
|
Name: "Asphalt";
|
|
@@ -11652,14 +11684,6 @@ declare namespace Enum {
|
|
|
11652
11684
|
|
|
11653
11685
|
export const Asphalt: Asphalt;
|
|
11654
11686
|
|
|
11655
|
-
export interface LeafyGrass extends globalThis.EnumItem {
|
|
11656
|
-
Name: "LeafyGrass";
|
|
11657
|
-
Value: 1284;
|
|
11658
|
-
EnumType: typeof globalThis.Enum.Material;
|
|
11659
|
-
}
|
|
11660
|
-
|
|
11661
|
-
export const LeafyGrass: LeafyGrass;
|
|
11662
|
-
|
|
11663
11687
|
export interface Salt extends globalThis.EnumItem {
|
|
11664
11688
|
Name: "Salt";
|
|
11665
11689
|
Value: 1392;
|
|
@@ -11668,21 +11692,29 @@ declare namespace Enum {
|
|
|
11668
11692
|
|
|
11669
11693
|
export const Salt: Salt;
|
|
11670
11694
|
|
|
11671
|
-
export interface
|
|
11672
|
-
Name: "
|
|
11673
|
-
Value:
|
|
11695
|
+
export interface Ice extends globalThis.EnumItem {
|
|
11696
|
+
Name: "Ice";
|
|
11697
|
+
Value: 1536;
|
|
11674
11698
|
EnumType: typeof globalThis.Enum.Material;
|
|
11675
11699
|
}
|
|
11676
11700
|
|
|
11677
|
-
export const
|
|
11701
|
+
export const Ice: Ice;
|
|
11678
11702
|
|
|
11679
|
-
export interface
|
|
11680
|
-
Name: "
|
|
11681
|
-
Value:
|
|
11703
|
+
export interface Glacier extends globalThis.EnumItem {
|
|
11704
|
+
Name: "Glacier";
|
|
11705
|
+
Value: 1552;
|
|
11682
11706
|
EnumType: typeof globalThis.Enum.Material;
|
|
11683
11707
|
}
|
|
11684
11708
|
|
|
11685
|
-
export const
|
|
11709
|
+
export const Glacier: Glacier;
|
|
11710
|
+
|
|
11711
|
+
export interface Glass extends globalThis.EnumItem {
|
|
11712
|
+
Name: "Glass";
|
|
11713
|
+
Value: 1568;
|
|
11714
|
+
EnumType: typeof globalThis.Enum.Material;
|
|
11715
|
+
}
|
|
11716
|
+
|
|
11717
|
+
export const Glass: Glass;
|
|
11686
11718
|
|
|
11687
11719
|
export interface ForceField extends globalThis.EnumItem {
|
|
11688
11720
|
Name: "ForceField";
|
|
@@ -11692,6 +11724,22 @@ declare namespace Enum {
|
|
|
11692
11724
|
|
|
11693
11725
|
export const ForceField: ForceField;
|
|
11694
11726
|
|
|
11727
|
+
export interface Air extends globalThis.EnumItem {
|
|
11728
|
+
Name: "Air";
|
|
11729
|
+
Value: 1792;
|
|
11730
|
+
EnumType: typeof globalThis.Enum.Material;
|
|
11731
|
+
}
|
|
11732
|
+
|
|
11733
|
+
export const Air: Air;
|
|
11734
|
+
|
|
11735
|
+
export interface Water extends globalThis.EnumItem {
|
|
11736
|
+
Name: "Water";
|
|
11737
|
+
Value: 2048;
|
|
11738
|
+
EnumType: typeof globalThis.Enum.Material;
|
|
11739
|
+
}
|
|
11740
|
+
|
|
11741
|
+
export const Water: Water;
|
|
11742
|
+
|
|
11695
11743
|
export interface Cardboard extends globalThis.EnumItem {
|
|
11696
11744
|
Name: "Cardboard";
|
|
11697
11745
|
Value: 2304;
|
|
@@ -11758,7 +11806,7 @@ declare namespace Enum {
|
|
|
11758
11806
|
|
|
11759
11807
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.Material>;
|
|
11760
11808
|
}
|
|
11761
|
-
export type Material = Material.Plastic | Material.
|
|
11809
|
+
export type Material = Material.Plastic | Material.SmoothPlastic | Material.Neon | Material.Wood | Material.WoodPlanks | Material.Marble | Material.Slate | Material.Concrete | Material.Granite | Material.Brick | Material.Pebble | Material.Cobblestone | Material.Rock | Material.Sandstone | Material.Basalt | Material.CrackedLava | Material.Limestone | Material.Pavement | Material.CorrodedMetal | Material.DiamondPlate | Material.Foil | Material.Metal | Material.Grass | Material.LeafyGrass | Material.Sand | Material.Fabric | Material.Snow | Material.Mud | Material.Ground | Material.Asphalt | Material.Salt | Material.Ice | Material.Glacier | Material.Glass | Material.ForceField | Material.Air | Material.Water | Material.Cardboard | Material.Carpet | Material.CeramicTiles | Material.ClayRoofTiles | Material.RoofShingles | Material.Leather | Material.Plaster | Material.Rubber;
|
|
11762
11810
|
|
|
11763
11811
|
export namespace MaterialPattern {
|
|
11764
11812
|
export interface Regular extends globalThis.EnumItem {
|
|
@@ -13754,6 +13802,91 @@ declare namespace Enum {
|
|
|
13754
13802
|
}
|
|
13755
13803
|
export type PromptCreateAssetResult = PromptCreateAssetResult.Success | PromptCreateAssetResult.PermissionDenied | PromptCreateAssetResult.Timeout | PromptCreateAssetResult.UploadFailed | PromptCreateAssetResult.NoUserInput | PromptCreateAssetResult.UnknownFailure;
|
|
13756
13804
|
|
|
13805
|
+
export namespace PromptCreateAvatarResult {
|
|
13806
|
+
export interface Success extends globalThis.EnumItem {
|
|
13807
|
+
Name: "Success";
|
|
13808
|
+
Value: 1;
|
|
13809
|
+
EnumType: typeof globalThis.Enum.PromptCreateAvatarResult;
|
|
13810
|
+
}
|
|
13811
|
+
|
|
13812
|
+
export const Success: Success;
|
|
13813
|
+
|
|
13814
|
+
export interface PermissionDenied extends globalThis.EnumItem {
|
|
13815
|
+
Name: "PermissionDenied";
|
|
13816
|
+
Value: 2;
|
|
13817
|
+
EnumType: typeof globalThis.Enum.PromptCreateAvatarResult;
|
|
13818
|
+
}
|
|
13819
|
+
|
|
13820
|
+
export const PermissionDenied: PermissionDenied;
|
|
13821
|
+
|
|
13822
|
+
export interface Timeout extends globalThis.EnumItem {
|
|
13823
|
+
Name: "Timeout";
|
|
13824
|
+
Value: 3;
|
|
13825
|
+
EnumType: typeof globalThis.Enum.PromptCreateAvatarResult;
|
|
13826
|
+
}
|
|
13827
|
+
|
|
13828
|
+
export const Timeout: Timeout;
|
|
13829
|
+
|
|
13830
|
+
export interface UploadFailed extends globalThis.EnumItem {
|
|
13831
|
+
Name: "UploadFailed";
|
|
13832
|
+
Value: 4;
|
|
13833
|
+
EnumType: typeof globalThis.Enum.PromptCreateAvatarResult;
|
|
13834
|
+
}
|
|
13835
|
+
|
|
13836
|
+
export const UploadFailed: UploadFailed;
|
|
13837
|
+
|
|
13838
|
+
export interface NoUserInput extends globalThis.EnumItem {
|
|
13839
|
+
Name: "NoUserInput";
|
|
13840
|
+
Value: 5;
|
|
13841
|
+
EnumType: typeof globalThis.Enum.PromptCreateAvatarResult;
|
|
13842
|
+
}
|
|
13843
|
+
|
|
13844
|
+
export const NoUserInput: NoUserInput;
|
|
13845
|
+
|
|
13846
|
+
export interface InvalidHumanoidDescription extends globalThis.EnumItem {
|
|
13847
|
+
Name: "InvalidHumanoidDescription";
|
|
13848
|
+
Value: 6;
|
|
13849
|
+
EnumType: typeof globalThis.Enum.PromptCreateAvatarResult;
|
|
13850
|
+
}
|
|
13851
|
+
|
|
13852
|
+
export const InvalidHumanoidDescription: InvalidHumanoidDescription;
|
|
13853
|
+
|
|
13854
|
+
export interface UGCValidationFailed extends globalThis.EnumItem {
|
|
13855
|
+
Name: "UGCValidationFailed";
|
|
13856
|
+
Value: 7;
|
|
13857
|
+
EnumType: typeof globalThis.Enum.PromptCreateAvatarResult;
|
|
13858
|
+
}
|
|
13859
|
+
|
|
13860
|
+
export const UGCValidationFailed: UGCValidationFailed;
|
|
13861
|
+
|
|
13862
|
+
export interface ModeratedName extends globalThis.EnumItem {
|
|
13863
|
+
Name: "ModeratedName";
|
|
13864
|
+
Value: 8;
|
|
13865
|
+
EnumType: typeof globalThis.Enum.PromptCreateAvatarResult;
|
|
13866
|
+
}
|
|
13867
|
+
|
|
13868
|
+
export const ModeratedName: ModeratedName;
|
|
13869
|
+
|
|
13870
|
+
export interface MaxOutfits extends globalThis.EnumItem {
|
|
13871
|
+
Name: "MaxOutfits";
|
|
13872
|
+
Value: 9;
|
|
13873
|
+
EnumType: typeof globalThis.Enum.PromptCreateAvatarResult;
|
|
13874
|
+
}
|
|
13875
|
+
|
|
13876
|
+
export const MaxOutfits: MaxOutfits;
|
|
13877
|
+
|
|
13878
|
+
export interface UnknownFailure extends globalThis.EnumItem {
|
|
13879
|
+
Name: "UnknownFailure";
|
|
13880
|
+
Value: 10;
|
|
13881
|
+
EnumType: typeof globalThis.Enum.PromptCreateAvatarResult;
|
|
13882
|
+
}
|
|
13883
|
+
|
|
13884
|
+
export const UnknownFailure: UnknownFailure;
|
|
13885
|
+
|
|
13886
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PromptCreateAvatarResult>;
|
|
13887
|
+
}
|
|
13888
|
+
export type PromptCreateAvatarResult = PromptCreateAvatarResult.Success | PromptCreateAvatarResult.PermissionDenied | PromptCreateAvatarResult.Timeout | PromptCreateAvatarResult.UploadFailed | PromptCreateAvatarResult.NoUserInput | PromptCreateAvatarResult.InvalidHumanoidDescription | PromptCreateAvatarResult.UGCValidationFailed | PromptCreateAvatarResult.ModeratedName | PromptCreateAvatarResult.MaxOutfits | PromptCreateAvatarResult.UnknownFailure;
|
|
13889
|
+
|
|
13757
13890
|
export namespace PromptPublishAssetResult {
|
|
13758
13891
|
export interface Success extends globalThis.EnumItem {
|
|
13759
13892
|
Name: "Success";
|
|
@@ -16175,6 +16308,27 @@ declare namespace Enum {
|
|
|
16175
16308
|
}
|
|
16176
16309
|
export type StudioDataModelType = StudioDataModelType.Edit | StudioDataModelType.PlayClient | StudioDataModelType.PlayServer | StudioDataModelType.Standalone | StudioDataModelType.None;
|
|
16177
16310
|
|
|
16311
|
+
export namespace StudioPlaceUpdateFailureReason {
|
|
16312
|
+
export interface Other extends globalThis.EnumItem {
|
|
16313
|
+
Name: "Other";
|
|
16314
|
+
Value: 0;
|
|
16315
|
+
EnumType: typeof globalThis.Enum.StudioPlaceUpdateFailureReason;
|
|
16316
|
+
}
|
|
16317
|
+
|
|
16318
|
+
export const Other: Other;
|
|
16319
|
+
|
|
16320
|
+
export interface TeamCreateConflict extends globalThis.EnumItem {
|
|
16321
|
+
Name: "TeamCreateConflict";
|
|
16322
|
+
Value: 1;
|
|
16323
|
+
EnumType: typeof globalThis.Enum.StudioPlaceUpdateFailureReason;
|
|
16324
|
+
}
|
|
16325
|
+
|
|
16326
|
+
export const TeamCreateConflict: TeamCreateConflict;
|
|
16327
|
+
|
|
16328
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.StudioPlaceUpdateFailureReason>;
|
|
16329
|
+
}
|
|
16330
|
+
export type StudioPlaceUpdateFailureReason = StudioPlaceUpdateFailureReason.Other | StudioPlaceUpdateFailureReason.TeamCreateConflict;
|
|
16331
|
+
|
|
16178
16332
|
export namespace StudioScriptEditorColorCategories {
|
|
16179
16333
|
export interface Default extends globalThis.EnumItem {
|
|
16180
16334
|
Name: "Default";
|