@rbxts/types 1.0.612 → 1.0.615
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.
|
@@ -35,6 +35,7 @@ interface Services {
|
|
|
35
35
|
DebuggablePluginWatcher: DebuggablePluginWatcher;
|
|
36
36
|
DebuggerConnectionManager: DebuggerConnectionManager;
|
|
37
37
|
DebuggerUIService: DebuggerUIService;
|
|
38
|
+
DeviceIdService: DeviceIdService;
|
|
38
39
|
DraggerService: DraggerService;
|
|
39
40
|
EventIngestService: EventIngestService;
|
|
40
41
|
FaceAnimatorService: FaceAnimatorService;
|
|
@@ -452,6 +453,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
452
453
|
PlayerScripts: PlayerScripts;
|
|
453
454
|
PluginManagerInterface: PluginManagerInterface;
|
|
454
455
|
PoseBase: PoseBase;
|
|
456
|
+
ScreenshotHud: ScreenshotHud;
|
|
455
457
|
ScriptDocument: ScriptDocument;
|
|
456
458
|
StackFrame: StackFrame;
|
|
457
459
|
StandardPages: StandardPages;
|
|
@@ -762,7 +764,7 @@ interface Instance {
|
|
|
762
764
|
* * [Instance.AttributeChanged](https://developer.roblox.com/en-us/api-reference/event/Instance/AttributeChanged), fires whenever an attribute is changed on the instance
|
|
763
765
|
* * [Instance:GetAttributeChangedSignal](https://developer.roblox.com/en-us/api-reference/function/Instance/GetAttributeChangedSignal), returns an event that fires when the given attribute changes
|
|
764
766
|
*/
|
|
765
|
-
GetAttribute(this: Instance, attribute: string):
|
|
767
|
+
GetAttribute(this: Instance, attribute: string): AttributeValue | undefined;
|
|
766
768
|
/**
|
|
767
769
|
* This function returns an event that behaves exactly like the `Changed` event, except that the event only fires when the given attribute changes. It's generally a good idea to use this method instead of a connection to Changed with a function that checks the attribute name. Subsequent calls to this method on the same object with the same attribute name return the same event.
|
|
768
770
|
*
|
|
@@ -803,7 +805,7 @@ interface Instance {
|
|
|
803
805
|
* * [Instance.AttributeChanged](https://developer.roblox.com/en-us/api-reference/event/Instance/AttributeChanged), fires whenever an attribute is changed on the instance
|
|
804
806
|
* * [Instance:GetAttributeChangedSignal](https://developer.roblox.com/en-us/api-reference/function/Instance/GetAttributeChangedSignal), returns an event that fires when the given attribute changes
|
|
805
807
|
*/
|
|
806
|
-
GetAttributes(this: Instance):
|
|
808
|
+
GetAttributes(this: Instance): Map<string, AttributeValue>;
|
|
807
809
|
/**
|
|
808
810
|
* Returns an array (a numerically indexed table) containing all of the [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance)'s direct children, or every [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance) whose [Parent](https://developer.roblox.com/en-us/api-reference/property/Instance/Parent) is equal to the object. The array can be iterated upon using either a numeric or generic for-loop:
|
|
809
811
|
*
|
|
@@ -935,7 +937,7 @@ interface Instance {
|
|
|
935
937
|
* * [Instance.AttributeChanged](https://developer.roblox.com/en-us/api-reference/event/Instance/AttributeChanged), fires whenever an attribute is changed on the instance
|
|
936
938
|
* * [Instance:GetAttributeChangedSignal](https://developer.roblox.com/en-us/api-reference/function/Instance/GetAttributeChangedSignal), returns an event that fires when the given attribute changes
|
|
937
939
|
*/
|
|
938
|
-
SetAttribute(this: Instance, attribute: string, value:
|
|
940
|
+
SetAttribute(this: Instance, attribute: string, value: AttributeValue | undefined): void;
|
|
939
941
|
/**
|
|
940
942
|
* Returns the child of the [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance) with the given name. If the child does not exist, it will yield the current thread until it does.
|
|
941
943
|
*
|
|
@@ -9147,6 +9149,17 @@ interface DebuggerVariable extends Instance {
|
|
|
9147
9149
|
readonly _nominal_DebuggerVariable: unique symbol;
|
|
9148
9150
|
}
|
|
9149
9151
|
|
|
9152
|
+
interface DeviceIdService extends Instance {
|
|
9153
|
+
/**
|
|
9154
|
+
* **DO NOT USE!**
|
|
9155
|
+
*
|
|
9156
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
9157
|
+
* @hidden
|
|
9158
|
+
* @deprecated
|
|
9159
|
+
*/
|
|
9160
|
+
readonly _nominal_DeviceIdService: unique symbol;
|
|
9161
|
+
}
|
|
9162
|
+
|
|
9150
9163
|
/** 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.
|
|
9151
9164
|
*
|
|
9152
9165
|
* **See Also:**
|
|
@@ -24227,7 +24240,7 @@ interface WorldRoot extends Model {
|
|
|
24227
24240
|
*
|
|
24228
24241
|
* This and other spatial query functions do not consider parts' [CanCollide](https://developer.roblox.com/en-us/api-reference/property/BasePart/CanCollide) or [CanTouch](https://developer.roblox.com/en-us/api-reference/property/BasePart/CanTouch) properties. However, it will consider parts' collision group if specified by the given OverlapParams.
|
|
24229
24242
|
*/
|
|
24230
|
-
GetPartBoundsInBox(
|
|
24243
|
+
GetPartBoundsInBox(cframe: CFrame, size: Vector3, overlapParams?: OverlapParams): Array<BasePart>;
|
|
24231
24244
|
/**
|
|
24232
24245
|
* **GetPartBoundsInRadius** returns an array of parts whose _bounding boxes_ overlap a sphere whose volume is described using the given center (Vector3) and radius (number).
|
|
24233
24246
|
*
|
|
@@ -24237,7 +24250,7 @@ interface WorldRoot extends Model {
|
|
|
24237
24250
|
*
|
|
24238
24251
|
* This and other spatial query functions do not consider parts' [CanCollide](https://developer.roblox.com/en-us/api-reference/property/BasePart/CanCollide) or [CanTouch](https://developer.roblox.com/en-us/api-reference/property/BasePart/CanTouch) properties. However, it will consider parts' collision group if specified by the given OverlapParams.
|
|
24239
24252
|
*/
|
|
24240
|
-
GetPartBoundsInRadius(
|
|
24253
|
+
GetPartBoundsInRadius(position: Vector3, radius: number, overlapParams?: OverlapParams): Array<BasePart>;
|
|
24241
24254
|
/**
|
|
24242
24255
|
* **GetPartsInPart** returns an array of parts whose occupied space is shared with the given part, which must exist in the same WorldRoot ([Workspace](https://developer.roblox.com/en-us/api-reference/class/Workspace)) as the parts to be queried.
|
|
24243
24256
|
*
|
|
@@ -24249,7 +24262,7 @@ interface WorldRoot extends Model {
|
|
|
24249
24262
|
*
|
|
24250
24263
|
* This and other spatial query functions do not consider parts' [CanCollide](https://developer.roblox.com/en-us/api-reference/property/BasePart/CanCollide) or [CanTouch](https://developer.roblox.com/en-us/api-reference/property/BasePart/CanTouch) properties. However, it will consider parts' collision group if specified by the given OverlapParams.
|
|
24251
24264
|
*/
|
|
24252
|
-
GetPartsInPart(
|
|
24265
|
+
GetPartsInPart(part: BasePart, overlapParams?: OverlapParams): Array<BasePart>;
|
|
24253
24266
|
/**
|
|
24254
24267
|
* **IsRegion3Empty** returns a bool indicating whether there are no [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart)s within the given [Region3](https://developer.roblox.com/en-us/api-reference/datatype/Region3).
|
|
24255
24268
|
*
|
|
@@ -24650,12 +24663,12 @@ interface PackageLink extends Instance {
|
|
|
24650
24663
|
readonly _nominal_PackageLink: unique symbol;
|
|
24651
24664
|
/**
|
|
24652
24665
|
* The id of the asset this package corresponds to.
|
|
24653
|
-
* Tags: ReadOnly, NotReplicated
|
|
24666
|
+
* Tags: Hidden, ReadOnly, NotReplicated
|
|
24654
24667
|
*/
|
|
24655
24668
|
readonly PackageId: string;
|
|
24656
24669
|
/**
|
|
24657
24670
|
* This property refers to a revision of a specific package
|
|
24658
|
-
* Tags: NotReplicated
|
|
24671
|
+
* Tags: Hidden, NotReplicated
|
|
24659
24672
|
*/
|
|
24660
24673
|
readonly VersionNumber: number;
|
|
24661
24674
|
}
|
|
@@ -28079,6 +28092,25 @@ interface RunService extends Instance {
|
|
|
28079
28092
|
readonly Stepped: RBXScriptSignal<(time: number, deltaTime: number) => void>;
|
|
28080
28093
|
}
|
|
28081
28094
|
|
|
28095
|
+
interface ScreenshotHud extends Instance {
|
|
28096
|
+
/**
|
|
28097
|
+
* **DO NOT USE!**
|
|
28098
|
+
*
|
|
28099
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
28100
|
+
* @hidden
|
|
28101
|
+
* @deprecated
|
|
28102
|
+
*/
|
|
28103
|
+
readonly _nominal_ScreenshotHud: unique symbol;
|
|
28104
|
+
CameraButtonIcon: string;
|
|
28105
|
+
CameraButtonPosition: UDim2;
|
|
28106
|
+
CloseButtonPosition: UDim2;
|
|
28107
|
+
CloseWhenScreenshotTaken: boolean;
|
|
28108
|
+
ExperienceNameOverlayEnabled: boolean;
|
|
28109
|
+
OverlayFont: Enum.Font;
|
|
28110
|
+
UsernameOverlayEnabled: boolean;
|
|
28111
|
+
Visible: boolean;
|
|
28112
|
+
}
|
|
28113
|
+
|
|
28082
28114
|
interface ScriptChangeService extends Instance {
|
|
28083
28115
|
/**
|
|
28084
28116
|
* **DO NOT USE!**
|
|
@@ -2054,6 +2054,14 @@ interface Plugin extends Instance {
|
|
|
2054
2054
|
* [Intro to Plugins](https://developer.roblox.com/en-us/articles/intro-to-plugins), an introductory article to plugin use and development
|
|
2055
2055
|
*/
|
|
2056
2056
|
readonly Unloading: RBXScriptSignal<() => void>;
|
|
2057
|
+
/**
|
|
2058
|
+
* Tags: NoYield
|
|
2059
|
+
*/
|
|
2060
|
+
ProcessAssetInsertionDrag: (assetId: string, assetTypeId: number, instances: Array<Instance>) => void;
|
|
2061
|
+
/**
|
|
2062
|
+
* Tags: NoYield
|
|
2063
|
+
*/
|
|
2064
|
+
ProcessAssetInsertionDrop: () => void;
|
|
2057
2065
|
}
|
|
2058
2066
|
|
|
2059
2067
|
/** PluginAction is an object that represents a generic performable action in Roblox Studio, with no directly associated `Toolbar` or `Button`. In Roblox Studio, they can be assigned a keyboard shortcut under `File → Advanced → Customize Shortcuts...`, and they can also be added to the Quick Access Toolbar.
|
|
@@ -2762,6 +2770,41 @@ interface ScriptDebugger extends Instance {
|
|
|
2762
2770
|
readonly WatchRemoved: RBXScriptSignal<(watch: Instance) => void>;
|
|
2763
2771
|
}
|
|
2764
2772
|
|
|
2773
|
+
interface ScriptDocument extends Instance {
|
|
2774
|
+
/**
|
|
2775
|
+
* **DO NOT USE!**
|
|
2776
|
+
*
|
|
2777
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
2778
|
+
* @hidden
|
|
2779
|
+
* @deprecated
|
|
2780
|
+
*/
|
|
2781
|
+
readonly _nominal_ScriptDocument: unique symbol;
|
|
2782
|
+
GetLine(this: ScriptDocument, lineIndex?: number): string;
|
|
2783
|
+
GetLineCount(this: ScriptDocument): number;
|
|
2784
|
+
GetScript(this: ScriptDocument): LuaSourceContainer;
|
|
2785
|
+
GetText(this: ScriptDocument, startLine?: number, startCharacter?: number, endLine?: number, endCharacter?: number): string;
|
|
2786
|
+
IsCommandBar(this: ScriptDocument): boolean;
|
|
2787
|
+
/**
|
|
2788
|
+
* Tags: Yields
|
|
2789
|
+
*/
|
|
2790
|
+
EditTextAsync(this: ScriptDocument, newText: string, startLine: number, startCharacter: number, endLine?: number, endCharacter?: number): unknown;
|
|
2791
|
+
}
|
|
2792
|
+
|
|
2793
|
+
interface ScriptEditorService extends Instance {
|
|
2794
|
+
/**
|
|
2795
|
+
* **DO NOT USE!**
|
|
2796
|
+
*
|
|
2797
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
2798
|
+
* @hidden
|
|
2799
|
+
* @deprecated
|
|
2800
|
+
*/
|
|
2801
|
+
readonly _nominal_ScriptEditorService: unique symbol;
|
|
2802
|
+
FindScriptDocument(this: ScriptEditorService, script: LuaSourceContainer): ScriptDocument;
|
|
2803
|
+
readonly TextDocumentDidChange: RBXScriptSignal<(document: ScriptDocument, changesArray: unknown) => void>;
|
|
2804
|
+
readonly TextDocumentDidClose: RBXScriptSignal<(oldDocument: ScriptDocument) => void>;
|
|
2805
|
+
readonly TextDocumentDidOpen: RBXScriptSignal<(newDocument: ScriptDocument) => void>;
|
|
2806
|
+
}
|
|
2807
|
+
|
|
2765
2808
|
/** The Selection service controls the [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance)s that are selected in Roblox Studio.
|
|
2766
2809
|
*
|
|
2767
2810
|
* This service is particularly useful when developing [Plugin](https://developer.roblox.com/en-us/api-reference/class/Plugin)s, as it allows the developer to access and manipulate the current selection.
|
|
@@ -3165,6 +3208,7 @@ interface Studio extends Instance {
|
|
|
3165
3208
|
["Hover Animate Speed"]: Enum.HoverAnimateSpeed;
|
|
3166
3209
|
readonly ["Hover Box Thickness"]: number;
|
|
3167
3210
|
["Hover Over Color"]: Color3;
|
|
3211
|
+
readonly IconOverrideDir: QDir;
|
|
3168
3212
|
["Indent Using Spaces"]: boolean;
|
|
3169
3213
|
/**
|
|
3170
3214
|
* Tags: NotReplicated
|
package/include/roblox.d.ts
CHANGED
|
@@ -2344,3 +2344,18 @@ interface CheckableTypes extends CheckablePrimitives {
|
|
|
2344
2344
|
Vector3: Vector3;
|
|
2345
2345
|
Vector3int16: Vector3int16;
|
|
2346
2346
|
}
|
|
2347
|
+
|
|
2348
|
+
type AttributeValue =
|
|
2349
|
+
| string
|
|
2350
|
+
| boolean
|
|
2351
|
+
| number
|
|
2352
|
+
| UDim
|
|
2353
|
+
| UDim2
|
|
2354
|
+
| BrickColor
|
|
2355
|
+
| Color3
|
|
2356
|
+
| Vector2
|
|
2357
|
+
| Vector3
|
|
2358
|
+
| NumberSequence
|
|
2359
|
+
| ColorSequence
|
|
2360
|
+
| NumberRange
|
|
2361
|
+
| Rect;
|