@rbxts/types 1.0.528 → 1.0.532
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 +236 -18
- package/include/generated/enums.d.ts +80 -0
- package/package.json +1 -1
|
@@ -76,6 +76,7 @@ interface Services {
|
|
|
76
76
|
StudioDeviceEmulatorService: StudioDeviceEmulatorService;
|
|
77
77
|
Teams: Teams;
|
|
78
78
|
TeleportService: TeleportService;
|
|
79
|
+
TextChatService: TextChatService;
|
|
79
80
|
TextService: TextService;
|
|
80
81
|
ToastNotificationService: ToastNotificationService;
|
|
81
82
|
TracerService: TracerService;
|
|
@@ -153,11 +154,13 @@ interface CreatableInstances {
|
|
|
153
154
|
Dragger: Dragger;
|
|
154
155
|
EchoSoundEffect: EchoSoundEffect;
|
|
155
156
|
EqualizerSoundEffect: EqualizerSoundEffect;
|
|
157
|
+
EulerRotationCurve: EulerRotationCurve;
|
|
156
158
|
Explosion: Explosion;
|
|
157
159
|
FaceControls: FaceControls;
|
|
158
160
|
FileMesh: FileMesh;
|
|
159
161
|
Fire: Fire;
|
|
160
162
|
FlangeSoundEffect: FlangeSoundEffect;
|
|
163
|
+
FloatCurve: FloatCurve;
|
|
161
164
|
FloorWire: FloorWire;
|
|
162
165
|
Folder: Folder;
|
|
163
166
|
ForceField: ForceField;
|
|
@@ -253,7 +256,9 @@ interface CreatableInstances {
|
|
|
253
256
|
TerrainRegion: TerrainRegion;
|
|
254
257
|
TextBox: TextBox;
|
|
255
258
|
TextButton: TextButton;
|
|
259
|
+
TextChannel: TextChannel;
|
|
256
260
|
TextLabel: TextLabel;
|
|
261
|
+
TextSource: TextSource;
|
|
257
262
|
Texture: Texture;
|
|
258
263
|
Tool: Tool;
|
|
259
264
|
Torque: Torque;
|
|
@@ -275,6 +280,7 @@ interface CreatableInstances {
|
|
|
275
280
|
UITextSizeConstraint: UITextSizeConstraint;
|
|
276
281
|
UnionOperation: UnionOperation;
|
|
277
282
|
UniversalConstraint: UniversalConstraint;
|
|
283
|
+
Vector3Curve: Vector3Curve;
|
|
278
284
|
Vector3Value: Vector3Value;
|
|
279
285
|
VectorForce: VectorForce;
|
|
280
286
|
VehicleController: VehicleController;
|
|
@@ -358,6 +364,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
358
364
|
DataStorePages: DataStorePages;
|
|
359
365
|
DataStoreVersionPages: DataStoreVersionPages;
|
|
360
366
|
DebuggerConnection: DebuggerConnection;
|
|
367
|
+
DebuggerVariable: DebuggerVariable;
|
|
361
368
|
EmotesPages: EmotesPages;
|
|
362
369
|
FriendPages: FriendPages;
|
|
363
370
|
GlobalDataStore: GlobalDataStore;
|
|
@@ -393,6 +400,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
393
400
|
ScriptRef: ScriptRef;
|
|
394
401
|
ScriptRefId: ScriptRefId;
|
|
395
402
|
ScriptRefPath: ScriptRefPath;
|
|
403
|
+
StackFrame: StackFrame;
|
|
396
404
|
StandardPages: StandardPages;
|
|
397
405
|
StarterCharacterScripts: StarterCharacterScripts;
|
|
398
406
|
StarterPlayerScripts: StarterPlayerScripts;
|
|
@@ -2212,6 +2220,7 @@ interface AvatarEditorService extends Instance {
|
|
|
2212
2220
|
*/
|
|
2213
2221
|
PromptCreateOutfit(this: AvatarEditorService, outfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): void;
|
|
2214
2222
|
PromptDeleteOutfit(this: AvatarEditorService, outfitId: number): void;
|
|
2223
|
+
PromptRenameOutfit(this: AvatarEditorService, outfitId: number): void;
|
|
2215
2224
|
/**
|
|
2216
2225
|
* This function prompts the [Players.LocalPlayer](https://developer.roblox.com/en-us/api-reference/property/Players/LocalPlayer) to update their avatar based on the given [HumanoidDescription](https://developer.roblox.com/en-us/api-reference/class/HumanoidDescription) and [RigType](https://developer.roblox.com/en-us/api-reference/enum/RigType) (R6 or R15). Does not yield and can get the result by listening to the PromptSaveAvatarCompleted event. This is similar to how other prompts such as PromptPurchase work.
|
|
2217
2226
|
*/
|
|
@@ -2525,6 +2534,7 @@ interface AvatarEditorService extends Instance {
|
|
|
2525
2534
|
*/
|
|
2526
2535
|
readonly PromptCreateOutfitCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult, failureType: unknown) => void>;
|
|
2527
2536
|
readonly PromptDeleteOutfitCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult) => void>;
|
|
2537
|
+
readonly PromptRenameOutfitCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult) => void>;
|
|
2528
2538
|
/**
|
|
2529
2539
|
* This event fires when the [AvatarEditorService:PromptSaveAvatar](https://developer.roblox.com/en-us/api-reference/function/AvatarEditorService/PromptSaveAvatar) operation is completed. It gives a status [enum](https://developer.roblox.com/en-us/api-reference/enum/AvatarPromptResult) indicating whether the prompt succeeded, failed or permission was not granted by the user.
|
|
2530
2540
|
*/
|
|
@@ -6019,13 +6029,13 @@ interface CommandInstance extends Instance {
|
|
|
6019
6029
|
*/
|
|
6020
6030
|
readonly AllowGUIAccessPoints: boolean;
|
|
6021
6031
|
/**
|
|
6022
|
-
* Tags:
|
|
6032
|
+
* Tags: NotReplicated
|
|
6023
6033
|
*/
|
|
6024
|
-
|
|
6034
|
+
DisplayName: string;
|
|
6025
6035
|
/**
|
|
6026
6036
|
* Tags: ReadOnly, NotReplicated
|
|
6027
6037
|
*/
|
|
6028
|
-
readonly
|
|
6038
|
+
readonly Name: string;
|
|
6029
6039
|
}
|
|
6030
6040
|
|
|
6031
6041
|
interface CommandService extends Instance {
|
|
@@ -6192,7 +6202,7 @@ interface AlignOrientation extends Constraint {
|
|
|
6192
6202
|
* Two perpendicular axes
|
|
6193
6203
|
*/
|
|
6194
6204
|
AlignType: Enum.AlignType;
|
|
6195
|
-
|
|
6205
|
+
CFrame: CFrame;
|
|
6196
6206
|
/**
|
|
6197
6207
|
* The maximum angular velocity the constraint can use to reach its goal.
|
|
6198
6208
|
*/
|
|
@@ -8382,6 +8392,17 @@ interface DebuggerConnectionManager extends Instance {
|
|
|
8382
8392
|
readonly _nominal_DebuggerConnectionManager: unique symbol;
|
|
8383
8393
|
}
|
|
8384
8394
|
|
|
8395
|
+
interface DebuggerVariable extends Instance {
|
|
8396
|
+
/**
|
|
8397
|
+
* **DO NOT USE!**
|
|
8398
|
+
*
|
|
8399
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
8400
|
+
* @hidden
|
|
8401
|
+
* @deprecated
|
|
8402
|
+
*/
|
|
8403
|
+
readonly _nominal_DebuggerVariable: unique symbol;
|
|
8404
|
+
}
|
|
8405
|
+
|
|
8385
8406
|
/** The Dialog object allows users to create non-player characters (NPCs) that players can talk to using a list of choices. The Dialog object can be inserted into a part such as a Humanoid's head, and then a player will see a speech bubble above the part that they can click on to start a conversation. The creator of a place can choose what choices the player can say by inserting [DialogChoice](https://developer.roblox.com/en-us/api-reference/class/DialogChoice) objects into the dialog.
|
|
8386
8407
|
*
|
|
8387
8408
|
* **See Also:**
|
|
@@ -8627,6 +8648,23 @@ interface DraggerService extends Instance {
|
|
|
8627
8648
|
ShowPivotIndicator: boolean;
|
|
8628
8649
|
}
|
|
8629
8650
|
|
|
8651
|
+
interface EulerRotationCurve extends Instance {
|
|
8652
|
+
/**
|
|
8653
|
+
* **DO NOT USE!**
|
|
8654
|
+
*
|
|
8655
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
8656
|
+
* @hidden
|
|
8657
|
+
* @deprecated
|
|
8658
|
+
*/
|
|
8659
|
+
readonly _nominal_EulerRotationCurve: unique symbol;
|
|
8660
|
+
RotationOrder: Enum.RotationOrder;
|
|
8661
|
+
GetAnglesAtTime(this: EulerRotationCurve, time: number): unknown;
|
|
8662
|
+
GetRotationAtTime(this: EulerRotationCurve, time: number): CFrame;
|
|
8663
|
+
X(this: EulerRotationCurve): FloatCurve;
|
|
8664
|
+
Y(this: EulerRotationCurve): FloatCurve;
|
|
8665
|
+
Z(this: EulerRotationCurve): FloatCurve;
|
|
8666
|
+
}
|
|
8667
|
+
|
|
8630
8668
|
interface EventIngestService extends Instance {
|
|
8631
8669
|
/**
|
|
8632
8670
|
* **DO NOT USE!**
|
|
@@ -9095,6 +9133,28 @@ interface Fire extends Instance {
|
|
|
9095
9133
|
Size: number;
|
|
9096
9134
|
}
|
|
9097
9135
|
|
|
9136
|
+
interface FloatCurve extends Instance {
|
|
9137
|
+
/**
|
|
9138
|
+
* **DO NOT USE!**
|
|
9139
|
+
*
|
|
9140
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
9141
|
+
* @hidden
|
|
9142
|
+
* @deprecated
|
|
9143
|
+
*/
|
|
9144
|
+
readonly _nominal_FloatCurve: unique symbol;
|
|
9145
|
+
/**
|
|
9146
|
+
* Tags: ReadOnly, NotReplicated
|
|
9147
|
+
*/
|
|
9148
|
+
readonly Length: number;
|
|
9149
|
+
GetKeyAtIndex(this: FloatCurve, index: number): FloatCurveKey;
|
|
9150
|
+
GetKeyIndicesAtTime(this: FloatCurve, time: number): unknown;
|
|
9151
|
+
GetKeys(this: FloatCurve): unknown;
|
|
9152
|
+
GetValueAtTime(this: FloatCurve, time: number): float?;
|
|
9153
|
+
InsertKey(this: FloatCurve, key: FloatCurveKey): unknown;
|
|
9154
|
+
RemoveKeyAtIndex(this: FloatCurve, startingIndex: number, count?: number): number;
|
|
9155
|
+
SetKeys(this: FloatCurve, keys: Array<any>): number;
|
|
9156
|
+
}
|
|
9157
|
+
|
|
9098
9158
|
/** A simple container used to hold and organize Roblox objects. Unlike other container classes like [Model](https://developer.roblox.com/en-us/api-reference/class/Model), it offers no additional functionality.
|
|
9099
9159
|
*
|
|
9100
9160
|
* The Folder object is ideal for organizing and storing objects. It is not recommended to use folders to group [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart)s as [Model](https://developer.roblox.com/en-us/api-reference/class/Model)s offer a range of useful functions for moving and manipulating the parts.
|
|
@@ -11086,6 +11146,10 @@ interface ScrollingFrame extends GuiObject {
|
|
|
11086
11146
|
* @deprecated
|
|
11087
11147
|
*/
|
|
11088
11148
|
readonly _nominal_ScrollingFrame: unique symbol;
|
|
11149
|
+
/**
|
|
11150
|
+
* Tags: ReadOnly, NotReplicated
|
|
11151
|
+
*/
|
|
11152
|
+
readonly AbsoluteCanvasSize: Vector2;
|
|
11089
11153
|
/**
|
|
11090
11154
|
* The size in pixels of the frame, without the scrollbars.
|
|
11091
11155
|
* Tags: ReadOnly, NotReplicated
|
|
@@ -14901,8 +14965,8 @@ interface ImporterRootSettings extends ImporterBaseSettings {
|
|
|
14901
14965
|
* Tags: ReadOnly, NotReplicated
|
|
14902
14966
|
*/
|
|
14903
14967
|
readonly FileDimensions: Vector3;
|
|
14904
|
-
FlattenAll: boolean;
|
|
14905
14968
|
InvertNegativeFaces: boolean;
|
|
14969
|
+
MergeMeshes: boolean;
|
|
14906
14970
|
/**
|
|
14907
14971
|
* Tags: ReadOnly, NotReplicated
|
|
14908
14972
|
*/
|
|
@@ -19894,6 +19958,10 @@ interface MaterialVariant extends Instance {
|
|
|
19894
19958
|
StudsPerTile: number;
|
|
19895
19959
|
}
|
|
19896
19960
|
|
|
19961
|
+
/** 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.
|
|
19962
|
+
*
|
|
19963
|
+
* 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.
|
|
19964
|
+
*/
|
|
19897
19965
|
interface MemoryStoreQueue extends Instance {
|
|
19898
19966
|
/**
|
|
19899
19967
|
* **DO NOT USE!**
|
|
@@ -19904,19 +19972,28 @@ interface MemoryStoreQueue extends Instance {
|
|
|
19904
19972
|
*/
|
|
19905
19973
|
readonly _nominal_MemoryStoreQueue: unique symbol;
|
|
19906
19974
|
/**
|
|
19975
|
+
* Adds an item to the queue.
|
|
19907
19976
|
* Tags: Yields
|
|
19908
19977
|
*/
|
|
19909
19978
|
AddAsync(this: MemoryStoreQueue, value: unknown, expiration: number, priority?: number): void;
|
|
19910
19979
|
/**
|
|
19980
|
+
* Reads one or more items from the queue as a single atomic operation.
|
|
19981
|
+
*
|
|
19982
|
+
* This method does not automatically delete the returned items from the queue but makes them invisible to other ReadAsync calls for the period of the invisibility timeout. The items must be explicitly removed from the queue with [MemoryStoreQueue:RemoveAsync](https://developer.roblox.com/en-us/api-reference/function/MemoryStoreQueue/RemoveAsync) before the invisibility timeout expires. The invisibility timeout defaults to 30 seconds unless a different value was provided in [MemoryStoreService:GetQueue](https://developer.roblox.com/en-us/api-reference/function/MemoryStoreService/GetQueue).
|
|
19911
19983
|
* Tags: Yields
|
|
19912
19984
|
*/
|
|
19913
19985
|
ReadAsync(this: MemoryStoreQueue, count: number, allOrNothing?: boolean, waitTimeout?: number): unknown;
|
|
19914
19986
|
/**
|
|
19987
|
+
* Removes an item or items previously read from the queue. This method uses the identifier returned by [MemoryStoreQueue:ReadAsync](https://developer.roblox.com/en-us/api-reference/function/MemoryStoreQueue/ReadAsync) to identify the items to remove. If called after the invisibility timeout has expired, the call has no effect.
|
|
19915
19988
|
* Tags: Yields
|
|
19916
19989
|
*/
|
|
19917
19990
|
RemoveAsync(this: MemoryStoreQueue, id: string): void;
|
|
19918
19991
|
}
|
|
19919
19992
|
|
|
19993
|
+
/** A top-level singleton class which exposes methods to access specific primitives within the MemoryStoreService. Use it for any data that rapidly changes that other servers can restore, such as global leaderboards, matchmaking queues, and auction houses.
|
|
19994
|
+
*
|
|
19995
|
+
* For a more in-depth look, take a look at the `articles/Memory Store|Memory Store` article.
|
|
19996
|
+
*/
|
|
19920
19997
|
interface MemoryStoreService extends Instance {
|
|
19921
19998
|
/**
|
|
19922
19999
|
* **DO NOT USE!**
|
|
@@ -19926,10 +20003,21 @@ interface MemoryStoreService extends Instance {
|
|
|
19926
20003
|
* @deprecated
|
|
19927
20004
|
*/
|
|
19928
20005
|
readonly _nominal_MemoryStoreService: unique symbol;
|
|
20006
|
+
/**
|
|
20007
|
+
* 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.
|
|
20008
|
+
*
|
|
20009
|
+
* For a more in-depth look, take a look at the `articles/Memory Store` article.
|
|
20010
|
+
*/
|
|
19929
20011
|
GetQueue(this: MemoryStoreService, name: string, invisibilityTimeout?: number): MemoryStoreQueue;
|
|
20012
|
+
/**
|
|
20013
|
+
* Returns a [MemoryStoreSortedMap](https://developer.roblox.com/en-us/api-reference/class/MemoryStoreSortedMap) instance for the provided name. The name is global within the game, so any place that uses the same name will access the same sorted map.
|
|
20014
|
+
*
|
|
20015
|
+
* For a more in-depth look, take a look at the `articles/Memory Store|Memory Store` article.
|
|
20016
|
+
*/
|
|
19930
20017
|
GetSortedMap(this: MemoryStoreService, name: string): MemoryStoreSortedMap;
|
|
19931
20018
|
}
|
|
19932
20019
|
|
|
20020
|
+
/** Provides access to a sorted map within MemoryStore. A sorted map is a collection of items where string keys are associated with arbitrary values (up to the maximum allowed size – see `articles/Memory Store|MemoryStore Limits`). The keys are arranged in alphabetical order. */
|
|
19933
20021
|
interface MemoryStoreSortedMap extends Instance {
|
|
19934
20022
|
/**
|
|
19935
20023
|
* **DO NOT USE!**
|
|
@@ -19940,22 +20028,42 @@ interface MemoryStoreSortedMap extends Instance {
|
|
|
19940
20028
|
*/
|
|
19941
20029
|
readonly _nominal_MemoryStoreSortedMap: unique symbol;
|
|
19942
20030
|
/**
|
|
20031
|
+
* Retrieves the value of a key in the sorted map.
|
|
20032
|
+
*
|
|
20033
|
+
* For a more in-depth look, take a look at the `articles/Memory Store|Memory Store` article.
|
|
19943
20034
|
* Tags: Yields
|
|
19944
20035
|
*/
|
|
19945
20036
|
GetAsync(this: MemoryStoreSortedMap, key: string): unknown;
|
|
19946
20037
|
/**
|
|
20038
|
+
* Gets items within a sorted range of keys.
|
|
20039
|
+
*
|
|
20040
|
+
* For a more in-depth look, take a look at the `articles/Memory Store|Memory Store` article.
|
|
19947
20041
|
* Tags: Yields
|
|
19948
20042
|
*/
|
|
19949
20043
|
GetRangeAsync(this: MemoryStoreSortedMap, direction: CastsToEnum<Enum.SortDirection>, count: number, exclusiveLowerBound?: string, exclusiveUpperBound?: string): unknown;
|
|
19950
20044
|
/**
|
|
20045
|
+
* Removes the provided key from the sorted map.
|
|
20046
|
+
*
|
|
20047
|
+
* For a more in-depth look, take a look at the `articles/Memory Store|Memory Store` article.
|
|
19951
20048
|
* Tags: Yields
|
|
19952
20049
|
*/
|
|
19953
20050
|
RemoveAsync(this: MemoryStoreSortedMap, key: string): void;
|
|
19954
20051
|
/**
|
|
20052
|
+
* Sets the value of the key overwriting any existing key value.
|
|
19955
20053
|
* Tags: Yields
|
|
19956
20054
|
*/
|
|
19957
20055
|
SetAsync(this: MemoryStoreSortedMap, key: string, value: unknown, expiration: number): boolean;
|
|
19958
20056
|
/**
|
|
20057
|
+
* Retrieves the value of a key from a sorted map and lets you update it to a new value via a callback function.
|
|
20058
|
+
*
|
|
20059
|
+
* This method accepts a callback function that transforms the old value into the updated value as required. The method retrieves the existing key value and passes it to the transform function which returns the new value for the item, with these exceptions:
|
|
20060
|
+
*
|
|
20061
|
+
* * If the key does not exist, the old value passed to the function will be nil.
|
|
20062
|
+
* * If the function returns nil, the update is canceled.
|
|
20063
|
+
*
|
|
20064
|
+
* The new value is saved only if the key was not updated (e.g. by a different game server) since the moment it was read. If the value did change, the transform function is invoked again with the most recent item value. This cycle repeats until the value is saved successfully or the transform function returns nil to abort the operation.
|
|
20065
|
+
*
|
|
20066
|
+
* For a more in-depth look, take a look at the `articles/Memory Store|Memory Store` article.
|
|
19959
20067
|
* Tags: Yields
|
|
19960
20068
|
*/
|
|
19961
20069
|
UpdateAsync(this: MemoryStoreSortedMap, key: string, transformFunction: Function, expiration: number): unknown;
|
|
@@ -23710,6 +23818,19 @@ interface Path extends Instance {
|
|
|
23710
23818
|
readonly Unblocked: RBXScriptSignal<(unblockedWaypointIdx: number) => void>;
|
|
23711
23819
|
}
|
|
23712
23820
|
|
|
23821
|
+
/** **Beta Feature** This class is currently a part of the PathfindingModifier beta feature. Eligible developers must enable the feature within Studio and functionality may change.
|
|
23822
|
+
*
|
|
23823
|
+
* For a more detailed overview of the [PathfindingService](https://developer.roblox.com/en-us/api-reference/class/PathfindingService) and [PathfindingModifiers](https://developer.roblox.com/en-us/api-reference/class/PathfindingModifier), see the `Articles/Pathfinding|Pathfinding` article.
|
|
23824
|
+
*
|
|
23825
|
+
* Pathfinding modifiers can be used to represent space that has a higher or lower cost to be traversed. When added as a child to a [Part](https://developer.roblox.com/en-us/api-reference/class/Part), it takes that Part's volume to annotate areas of the navmesh that are inside and on top of it.
|
|
23826
|
+
*
|
|
23827
|
+
* You can include pathfinding modifiers in the [PathfindingService:CreatePath](https://developer.roblox.com/en-us/api-reference/function/PathfindingService/CreatePath) parameters and compute smarter paths across various materials or around defined regions.
|
|
23828
|
+
*
|
|
23829
|
+
* Note that when adding a [PathfindingModifier](https://developer.roblox.com/en-us/api-reference/class/PathfindingModifier) to a part, **either**:
|
|
23830
|
+
*
|
|
23831
|
+
* 1. The part is [collidable](https://developer.roblox.com/en-us/api-reference/property/BasePart/CanCollide) and we are interested in modifying pathfinding costs of paths on top of this part, which we call **area**.
|
|
23832
|
+
* 2. The part is `BasePart/CanCollide|non-collidable` (and usually invisible in game) and we are interested in modifying pathfinding costs of paths inside the part, which we call **volume**.
|
|
23833
|
+
*/
|
|
23713
23834
|
interface PathfindingModifier extends Instance {
|
|
23714
23835
|
/**
|
|
23715
23836
|
* **DO NOT USE!**
|
|
@@ -23719,7 +23840,17 @@ interface PathfindingModifier extends Instance {
|
|
|
23719
23840
|
* @deprecated
|
|
23720
23841
|
*/
|
|
23721
23842
|
readonly _nominal_PathfindingModifier: unique symbol;
|
|
23843
|
+
/**
|
|
23844
|
+
* **Beta Feature** This class is currently a part of the PathfindingModifier beta feature. Eligible developers must enable the feature within Studio and functionality may change.
|
|
23845
|
+
*
|
|
23846
|
+
* For a more detailed overview of the [PathfindingService](”PathfindingService”) and PathfindingModifiers, you can take a look at the [Pathfinding](”`Articles/Pathfinding|Pathfinding`”) article.
|
|
23847
|
+
*
|
|
23848
|
+
* The name of the navigation area inside or on top of the `Part|Part's` volume.
|
|
23849
|
+
*/
|
|
23722
23850
|
ModifierId: string;
|
|
23851
|
+
/**
|
|
23852
|
+
* Determines if the parts enclosed by the modifier are traversable, even if they would normally be collided with. See [Ignoring Obstacles](https://developer.roblox.com/articles/Pathfinding#ignoring-obstacles) for details.
|
|
23853
|
+
*/
|
|
23723
23854
|
PassThrough: boolean;
|
|
23724
23855
|
}
|
|
23725
23856
|
|
|
@@ -23764,7 +23895,7 @@ interface PathfindingService extends Instance {
|
|
|
23764
23895
|
/**
|
|
23765
23896
|
* Creates a [Path](https://developer.roblox.com/en-us/api-reference/class/Path) object based on various agent parameters (see below).
|
|
23766
23897
|
*
|
|
23767
|
-
* Agent
|
|
23898
|
+
* Agent parameters
|
|
23768
23899
|
* ----------------
|
|
23769
23900
|
*
|
|
23770
23901
|
* Key
|
|
@@ -23807,6 +23938,34 @@ interface PathfindingService extends Instance {
|
|
|
23807
23938
|
*
|
|
23808
23939
|
* Determines the spacing between intermediate waypoints in path.
|
|
23809
23940
|
*
|
|
23941
|
+
* **Costs**
|
|
23942
|
+
*
|
|
23943
|
+
* table
|
|
23944
|
+
*
|
|
23945
|
+
* {}
|
|
23946
|
+
*
|
|
23947
|
+
* Table of materials or defined [PathfindingModifiers](https://developer.roblox.com/en-us/api-reference/class/PathfindingModifier) and their "cost" for traversal. Useful for making the agent prefer certain materials/regions over others.
|
|
23948
|
+
*
|
|
23949
|
+
* Pathfinding Costs
|
|
23950
|
+
* -----------------
|
|
23951
|
+
*
|
|
23952
|
+
* By default, all walkable (navmesh) areas have a pathfinding cost of 1.0 (jumps have a cost of 4.0), which is exactly how pathfinding worked before the introduction of [PathfindingModifiers](https://developer.roblox.com/en-us/api-reference/class/PathfindingModifier).
|
|
23953
|
+
*
|
|
23954
|
+
* Since not all characters have the same movement abilities or constraints, it is desirable to provide a way to customize them. For example, a regular car always wants to avoid water, while an amphibian vehicle might not have such restriction.
|
|
23955
|
+
*
|
|
23956
|
+
* To assign different pathfinding costs to different named areas/volumes and/or materials, for a particular AI character (including the player character in the Click to Move mode), just add an optional parameter `Costs` of type dictionary to CreatePath(.). It maps Pathfinding Modifier areas/volumes and materials to their pathfinding costs. For example:
|
|
23957
|
+
*
|
|
23958
|
+
* local path = PathfindingService:CreatePath{
|
|
23959
|
+
* AgentRadius = agentRadius,
|
|
23960
|
+
* AgentHeight = agentHeight,
|
|
23961
|
+
* AgentCanJump = agentCanJump,
|
|
23962
|
+
*
|
|
23963
|
+
* -- New parameter --
|
|
23964
|
+
* Costs = {
|
|
23965
|
+
* Grass = 10
|
|
23966
|
+
* }
|
|
23967
|
+
* }
|
|
23968
|
+
*
|
|
23810
23969
|
* See the `Articles/Pathfinding|Pathfinding` guide for details and examples on using pathfinding in Roblox.
|
|
23811
23970
|
*/
|
|
23812
23971
|
CreatePath(this: PathfindingService, agentParameters?: AgentParameters): Path;
|
|
@@ -27566,18 +27725,6 @@ interface SoundEffect extends Instance {
|
|
|
27566
27725
|
Priority: number;
|
|
27567
27726
|
}
|
|
27568
27727
|
|
|
27569
|
-
interface ChannelSelectorSoundEffect extends SoundEffect {
|
|
27570
|
-
/**
|
|
27571
|
-
* **DO NOT USE!**
|
|
27572
|
-
*
|
|
27573
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
27574
|
-
* @hidden
|
|
27575
|
-
* @deprecated
|
|
27576
|
-
*/
|
|
27577
|
-
readonly _nominal_ChannelSelectorSoundEffect: unique symbol;
|
|
27578
|
-
Channel: number;
|
|
27579
|
-
}
|
|
27580
|
-
|
|
27581
27728
|
/** A ChorusSoundEffect simulates the effect of multiple vocals or instruments playing the same part. It does this by taking the original sound and overlaying copies of that sound. These copies are not exact matches to the original but instead vary in pitch slightly. This simulates a real chorus, as different singers or instruments will have slight variations. This effect can be applied to either an individual sound or to a sound group by parenting it to the desired instance.
|
|
27582
27729
|
*
|
|
27583
27730
|
* Like all other [SoundEffect](https://developer.roblox.com/en-us/api-reference/class/SoundEffect), a ChorusSoundEffect can be applied either to a [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) or [SoundGroup](https://developer.roblox.com/en-us/api-reference/class/SoundGroup) by being parented to either.
|
|
@@ -27679,6 +27826,18 @@ interface CustomDspSoundEffect extends SoundEffect {
|
|
|
27679
27826
|
readonly _nominal_CustomDspSoundEffect: unique symbol;
|
|
27680
27827
|
}
|
|
27681
27828
|
|
|
27829
|
+
interface ChannelSelectorSoundEffect extends CustomDspSoundEffect {
|
|
27830
|
+
/**
|
|
27831
|
+
* **DO NOT USE!**
|
|
27832
|
+
*
|
|
27833
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
27834
|
+
* @hidden
|
|
27835
|
+
* @deprecated
|
|
27836
|
+
*/
|
|
27837
|
+
readonly _nominal_ChannelSelectorSoundEffect: unique symbol;
|
|
27838
|
+
Channel: number;
|
|
27839
|
+
}
|
|
27840
|
+
|
|
27682
27841
|
/** A distortion effect is used to simulate the effect that would occur when overdriving older style audio equipment (such as vaccuum tubes). This effect causes clipping in the sound and adds a general “fuzzyness”.
|
|
27683
27842
|
*
|
|
27684
27843
|
* Like all other [SoundEffect](https://developer.roblox.com/en-us/api-reference/class/SoundEffect), a DistortionSoundEffect can be applied either to a [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) or [SoundGroup](https://developer.roblox.com/en-us/api-reference/class/SoundGroup) by being parented to either.
|
|
@@ -28219,6 +28378,17 @@ interface Speaker extends Instance {
|
|
|
28219
28378
|
Volume: number;
|
|
28220
28379
|
}
|
|
28221
28380
|
|
|
28381
|
+
interface StackFrame extends Instance {
|
|
28382
|
+
/**
|
|
28383
|
+
* **DO NOT USE!**
|
|
28384
|
+
*
|
|
28385
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
28386
|
+
* @hidden
|
|
28387
|
+
* @deprecated
|
|
28388
|
+
*/
|
|
28389
|
+
readonly _nominal_StackFrame: unique symbol;
|
|
28390
|
+
}
|
|
28391
|
+
|
|
28222
28392
|
/** StarterGear is a container that is automatically inserted into each [Player](https://developer.roblox.com/en-us/api-reference/class/Player) when the player joins the game. When a player spawns, the contents of that player's StarterGear is copied into the player's [Backpack](https://developer.roblox.com/en-us/api-reference/class/Backpack). Additionally, when a player connects to a game that permits gear, all of the appropriate gear [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool) objects that the player owns are inserted into that player's StarterGear.
|
|
28223
28393
|
*
|
|
28224
28394
|
* Unlike [StarterPack](https://developer.roblox.com/en-us/api-reference/class/StarterPack), StarterGear is not a service but rather a child of each [Player](https://developer.roblox.com/en-us/api-reference/class/Player) object – this means that its contents are player-specific so that each player can have different [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool)s within their [StarterGear](https://developer.roblox.com/en-us/api-reference/class/StarterGear). It is not replicated to any client, including the owning player.
|
|
@@ -29712,6 +29882,28 @@ interface TerrainRegion extends Instance {
|
|
|
29712
29882
|
readonly SizeInCells: Vector3;
|
|
29713
29883
|
}
|
|
29714
29884
|
|
|
29885
|
+
interface TextChannel extends Instance {
|
|
29886
|
+
/**
|
|
29887
|
+
* **DO NOT USE!**
|
|
29888
|
+
*
|
|
29889
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
29890
|
+
* @hidden
|
|
29891
|
+
* @deprecated
|
|
29892
|
+
*/
|
|
29893
|
+
readonly _nominal_TextChannel: unique symbol;
|
|
29894
|
+
}
|
|
29895
|
+
|
|
29896
|
+
interface TextChatService extends Instance {
|
|
29897
|
+
/**
|
|
29898
|
+
* **DO NOT USE!**
|
|
29899
|
+
*
|
|
29900
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
29901
|
+
* @hidden
|
|
29902
|
+
* @deprecated
|
|
29903
|
+
*/
|
|
29904
|
+
readonly _nominal_TextChatService: unique symbol;
|
|
29905
|
+
}
|
|
29906
|
+
|
|
29715
29907
|
/** Represents the result of a call to [TextService:FilterStringAsync](https://developer.roblox.com/en-us/api-reference/function/TextService/FilterStringAsync).
|
|
29716
29908
|
* Used to distribute a filtered string accordingly.
|
|
29717
29909
|
*/
|
|
@@ -29812,6 +30004,17 @@ interface TextService extends Instance {
|
|
|
29812
30004
|
): TextFilterResult | undefined;
|
|
29813
30005
|
}
|
|
29814
30006
|
|
|
30007
|
+
interface TextSource extends Instance {
|
|
30008
|
+
/**
|
|
30009
|
+
* **DO NOT USE!**
|
|
30010
|
+
*
|
|
30011
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
30012
|
+
* @hidden
|
|
30013
|
+
* @deprecated
|
|
30014
|
+
*/
|
|
30015
|
+
readonly _nominal_TextSource: unique symbol;
|
|
30016
|
+
}
|
|
30017
|
+
|
|
29815
30018
|
interface ThreadState extends Instance {
|
|
29816
30019
|
/**
|
|
29817
30020
|
* **DO NOT USE!**
|
|
@@ -33332,6 +33535,21 @@ interface Vector3Value extends ValueBase {
|
|
|
33332
33535
|
readonly Changed: RBXScriptSignal<(value: Vector3) => void>;
|
|
33333
33536
|
}
|
|
33334
33537
|
|
|
33538
|
+
interface Vector3Curve extends Instance {
|
|
33539
|
+
/**
|
|
33540
|
+
* **DO NOT USE!**
|
|
33541
|
+
*
|
|
33542
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
33543
|
+
* @hidden
|
|
33544
|
+
* @deprecated
|
|
33545
|
+
*/
|
|
33546
|
+
readonly _nominal_Vector3Curve: unique symbol;
|
|
33547
|
+
GetValueAtTime(this: Vector3Curve, time: number): unknown;
|
|
33548
|
+
X(this: Vector3Curve): FloatCurve;
|
|
33549
|
+
Y(this: Vector3Curve): FloatCurve;
|
|
33550
|
+
Z(this: Vector3Curve): FloatCurve;
|
|
33551
|
+
}
|
|
33552
|
+
|
|
33335
33553
|
interface VoiceChatService extends Instance {
|
|
33336
33554
|
/**
|
|
33337
33555
|
* **DO NOT USE!**
|
|
@@ -8773,6 +8773,34 @@ declare namespace Enum {
|
|
|
8773
8773
|
export function GetEnumItems(this: defined): Array<KeyCode>
|
|
8774
8774
|
}
|
|
8775
8775
|
export type KeyCode = KeyCode.Unknown | KeyCode.Backspace | KeyCode.Tab | KeyCode.Clear | KeyCode.Return | KeyCode.Pause | KeyCode.Escape | KeyCode.Space | KeyCode.QuotedDouble | KeyCode.Hash | KeyCode.Dollar | KeyCode.Percent | KeyCode.Ampersand | KeyCode.Quote | KeyCode.LeftParenthesis | KeyCode.RightParenthesis | KeyCode.Asterisk | KeyCode.Plus | KeyCode.Comma | KeyCode.Minus | KeyCode.Period | KeyCode.Slash | KeyCode.Zero | KeyCode.One | KeyCode.Two | KeyCode.Three | KeyCode.Four | KeyCode.Five | KeyCode.Six | KeyCode.Seven | KeyCode.Eight | KeyCode.Nine | KeyCode.Colon | KeyCode.Semicolon | KeyCode.LessThan | KeyCode.Equals | KeyCode.GreaterThan | KeyCode.Question | KeyCode.At | KeyCode.LeftBracket | KeyCode.BackSlash | KeyCode.RightBracket | KeyCode.Caret | KeyCode.Underscore | KeyCode.Backquote | KeyCode.A | KeyCode.B | KeyCode.C | KeyCode.D | KeyCode.E | KeyCode.F | KeyCode.G | KeyCode.H | KeyCode.I | KeyCode.J | KeyCode.K | KeyCode.L | KeyCode.M | KeyCode.N | KeyCode.O | KeyCode.P | KeyCode.Q | KeyCode.R | KeyCode.S | KeyCode.T | KeyCode.U | KeyCode.V | KeyCode.W | KeyCode.X | KeyCode.Y | KeyCode.Z | KeyCode.LeftCurly | KeyCode.Pipe | KeyCode.RightCurly | KeyCode.Tilde | KeyCode.Delete | KeyCode.KeypadZero | KeyCode.KeypadOne | KeyCode.KeypadTwo | KeyCode.KeypadThree | KeyCode.KeypadFour | KeyCode.KeypadFive | KeyCode.KeypadSix | KeyCode.KeypadSeven | KeyCode.KeypadEight | KeyCode.KeypadNine | KeyCode.KeypadPeriod | KeyCode.KeypadDivide | KeyCode.KeypadMultiply | KeyCode.KeypadMinus | KeyCode.KeypadPlus | KeyCode.KeypadEnter | KeyCode.KeypadEquals | KeyCode.Up | KeyCode.Down | KeyCode.Right | KeyCode.Left | KeyCode.Insert | KeyCode.Home | KeyCode.End | KeyCode.PageUp | KeyCode.PageDown | KeyCode.LeftShift | KeyCode.RightShift | KeyCode.LeftMeta | KeyCode.RightMeta | KeyCode.LeftAlt | KeyCode.RightAlt | KeyCode.LeftControl | KeyCode.RightControl | KeyCode.CapsLock | KeyCode.NumLock | KeyCode.ScrollLock | KeyCode.LeftSuper | KeyCode.RightSuper | KeyCode.Mode | KeyCode.Compose | KeyCode.Help | KeyCode.Print | KeyCode.SysReq | KeyCode.Break | KeyCode.Menu | KeyCode.Power | KeyCode.Euro | KeyCode.Undo | KeyCode.F1 | KeyCode.F2 | KeyCode.F3 | KeyCode.F4 | KeyCode.F5 | KeyCode.F6 | KeyCode.F7 | KeyCode.F8 | KeyCode.F9 | KeyCode.F10 | KeyCode.F11 | KeyCode.F12 | KeyCode.F13 | KeyCode.F14 | KeyCode.F15 | KeyCode.World0 | KeyCode.World1 | KeyCode.World2 | KeyCode.World3 | KeyCode.World4 | KeyCode.World5 | KeyCode.World6 | KeyCode.World7 | KeyCode.World8 | KeyCode.World9 | KeyCode.World10 | KeyCode.World11 | KeyCode.World12 | KeyCode.World13 | KeyCode.World14 | KeyCode.World15 | KeyCode.World16 | KeyCode.World17 | KeyCode.World18 | KeyCode.World19 | KeyCode.World20 | KeyCode.World21 | KeyCode.World22 | KeyCode.World23 | KeyCode.World24 | KeyCode.World25 | KeyCode.World26 | KeyCode.World27 | KeyCode.World28 | KeyCode.World29 | KeyCode.World30 | KeyCode.World31 | KeyCode.World32 | KeyCode.World33 | KeyCode.World34 | KeyCode.World35 | KeyCode.World36 | KeyCode.World37 | KeyCode.World38 | KeyCode.World39 | KeyCode.World40 | KeyCode.World41 | KeyCode.World42 | KeyCode.World43 | KeyCode.World44 | KeyCode.World45 | KeyCode.World46 | KeyCode.World47 | KeyCode.World48 | KeyCode.World49 | KeyCode.World50 | KeyCode.World51 | KeyCode.World52 | KeyCode.World53 | KeyCode.World54 | KeyCode.World55 | KeyCode.World56 | KeyCode.World57 | KeyCode.World58 | KeyCode.World59 | KeyCode.World60 | KeyCode.World61 | KeyCode.World62 | KeyCode.World63 | KeyCode.World64 | KeyCode.World65 | KeyCode.World66 | KeyCode.World67 | KeyCode.World68 | KeyCode.World69 | KeyCode.World70 | KeyCode.World71 | KeyCode.World72 | KeyCode.World73 | KeyCode.World74 | KeyCode.World75 | KeyCode.World76 | KeyCode.World77 | KeyCode.World78 | KeyCode.World79 | KeyCode.World80 | KeyCode.World81 | KeyCode.World82 | KeyCode.World83 | KeyCode.World84 | KeyCode.World85 | KeyCode.World86 | KeyCode.World87 | KeyCode.World88 | KeyCode.World89 | KeyCode.World90 | KeyCode.World91 | KeyCode.World92 | KeyCode.World93 | KeyCode.World94 | KeyCode.World95 | KeyCode.ButtonX | KeyCode.ButtonY | KeyCode.ButtonA | KeyCode.ButtonB | KeyCode.ButtonR1 | KeyCode.ButtonL1 | KeyCode.ButtonR2 | KeyCode.ButtonL2 | KeyCode.ButtonR3 | KeyCode.ButtonL3 | KeyCode.ButtonStart | KeyCode.ButtonSelect | KeyCode.DPadLeft | KeyCode.DPadRight | KeyCode.DPadUp | KeyCode.DPadDown | KeyCode.Thumbstick1 | KeyCode.Thumbstick2;
|
|
8776
|
+
export namespace KeyInterpolationMode {
|
|
8777
|
+
export interface Constant {
|
|
8778
|
+
Name: "Constant";
|
|
8779
|
+
Value: 0;
|
|
8780
|
+
EnumType: EnumType<KeyInterpolationMode>;
|
|
8781
|
+
}
|
|
8782
|
+
|
|
8783
|
+
export const Constant: Constant;
|
|
8784
|
+
|
|
8785
|
+
export interface Linear {
|
|
8786
|
+
Name: "Linear";
|
|
8787
|
+
Value: 1;
|
|
8788
|
+
EnumType: EnumType<KeyInterpolationMode>;
|
|
8789
|
+
}
|
|
8790
|
+
|
|
8791
|
+
export const Linear: Linear;
|
|
8792
|
+
|
|
8793
|
+
export interface Cubic {
|
|
8794
|
+
Name: "Cubic";
|
|
8795
|
+
Value: 2;
|
|
8796
|
+
EnumType: EnumType<KeyInterpolationMode>;
|
|
8797
|
+
}
|
|
8798
|
+
|
|
8799
|
+
export const Cubic: Cubic;
|
|
8800
|
+
|
|
8801
|
+
export function GetEnumItems(this: defined): Array<KeyInterpolationMode>
|
|
8802
|
+
}
|
|
8803
|
+
export type KeyInterpolationMode = KeyInterpolationMode.Constant | KeyInterpolationMode.Linear | KeyInterpolationMode.Cubic;
|
|
8776
8804
|
export namespace KeywordFilterType {
|
|
8777
8805
|
export interface Include {
|
|
8778
8806
|
Name: "Include";
|
|
@@ -11577,6 +11605,58 @@ declare namespace Enum {
|
|
|
11577
11605
|
export function GetEnumItems(this: defined): Array<RollOffMode>
|
|
11578
11606
|
}
|
|
11579
11607
|
export type RollOffMode = RollOffMode.Inverse | RollOffMode.Linear | RollOffMode.InverseTapered | RollOffMode.LinearSquare;
|
|
11608
|
+
export namespace RotationOrder {
|
|
11609
|
+
export interface XYZ {
|
|
11610
|
+
Name: "XYZ";
|
|
11611
|
+
Value: 0;
|
|
11612
|
+
EnumType: EnumType<RotationOrder>;
|
|
11613
|
+
}
|
|
11614
|
+
|
|
11615
|
+
export const XYZ: XYZ;
|
|
11616
|
+
|
|
11617
|
+
export interface XZY {
|
|
11618
|
+
Name: "XZY";
|
|
11619
|
+
Value: 1;
|
|
11620
|
+
EnumType: EnumType<RotationOrder>;
|
|
11621
|
+
}
|
|
11622
|
+
|
|
11623
|
+
export const XZY: XZY;
|
|
11624
|
+
|
|
11625
|
+
export interface YZX {
|
|
11626
|
+
Name: "YZX";
|
|
11627
|
+
Value: 2;
|
|
11628
|
+
EnumType: EnumType<RotationOrder>;
|
|
11629
|
+
}
|
|
11630
|
+
|
|
11631
|
+
export const YZX: YZX;
|
|
11632
|
+
|
|
11633
|
+
export interface YXZ {
|
|
11634
|
+
Name: "YXZ";
|
|
11635
|
+
Value: 3;
|
|
11636
|
+
EnumType: EnumType<RotationOrder>;
|
|
11637
|
+
}
|
|
11638
|
+
|
|
11639
|
+
export const YXZ: YXZ;
|
|
11640
|
+
|
|
11641
|
+
export interface ZXY {
|
|
11642
|
+
Name: "ZXY";
|
|
11643
|
+
Value: 4;
|
|
11644
|
+
EnumType: EnumType<RotationOrder>;
|
|
11645
|
+
}
|
|
11646
|
+
|
|
11647
|
+
export const ZXY: ZXY;
|
|
11648
|
+
|
|
11649
|
+
export interface ZYX {
|
|
11650
|
+
Name: "ZYX";
|
|
11651
|
+
Value: 5;
|
|
11652
|
+
EnumType: EnumType<RotationOrder>;
|
|
11653
|
+
}
|
|
11654
|
+
|
|
11655
|
+
export const ZYX: ZYX;
|
|
11656
|
+
|
|
11657
|
+
export function GetEnumItems(this: defined): Array<RotationOrder>
|
|
11658
|
+
}
|
|
11659
|
+
export type RotationOrder = RotationOrder.XYZ | RotationOrder.XZY | RotationOrder.YZX | RotationOrder.YXZ | RotationOrder.ZXY | RotationOrder.ZYX;
|
|
11580
11660
|
export namespace RotationType {
|
|
11581
11661
|
export interface MovementRelative {
|
|
11582
11662
|
Name: "MovementRelative";
|