@rbxts/types 1.0.688 → 1.0.690
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 +42 -12
- package/include/generated/enums.d.ts +56 -40
- package/include/roblox.d.ts +74 -1
- package/package.json +1 -1
|
@@ -21,6 +21,7 @@ interface Services {
|
|
|
21
21
|
BadgeService: BadgeService;
|
|
22
22
|
BulkImportService: BulkImportService;
|
|
23
23
|
CalloutService: CalloutService;
|
|
24
|
+
CaptureService: CaptureService;
|
|
24
25
|
Chat: Chat;
|
|
25
26
|
CollectionService: CollectionService;
|
|
26
27
|
CommandService: CommandService;
|
|
@@ -42,7 +43,6 @@ interface Services {
|
|
|
42
43
|
ExperienceAuthService: ExperienceAuthService;
|
|
43
44
|
FaceAnimatorService: FaceAnimatorService;
|
|
44
45
|
FacialAnimationRecordingService: FacialAnimationRecordingService;
|
|
45
|
-
FacialAnimationStreamingService: FacialAnimationStreamingService;
|
|
46
46
|
FacialAnimationStreamingServiceV2: FacialAnimationStreamingServiceV2;
|
|
47
47
|
GamepadService: GamepadService;
|
|
48
48
|
GamePassService: GamePassService;
|
|
@@ -74,6 +74,7 @@ interface Services {
|
|
|
74
74
|
MessageBusService: MessageBusService;
|
|
75
75
|
MessagingService: MessagingService;
|
|
76
76
|
MetaBreakpointManager: MetaBreakpointManager;
|
|
77
|
+
OmniRecommendationsService: OmniRecommendationsService;
|
|
77
78
|
PackageUIService: PackageUIService;
|
|
78
79
|
PatchBundlerFileWatch: PatchBundlerFileWatch;
|
|
79
80
|
PathfindingService: PathfindingService;
|
|
@@ -978,7 +979,9 @@ interface Instance {
|
|
|
978
979
|
* See also, [Instance:IsAncestorOf](https://developer.roblox.com/en-us/api-reference/function/Instance/IsAncestorOf).
|
|
979
980
|
*/
|
|
980
981
|
IsDescendantOf(this: Instance, ancestor: Instance): boolean;
|
|
982
|
+
IsPropertyModified(this: Instance, name: string): boolean;
|
|
981
983
|
RemoveTag(this: Instance, tag: string): void;
|
|
984
|
+
ResetPropertyToDefault(this: Instance, name: string): void;
|
|
982
985
|
/**
|
|
983
986
|
* This function sets the attribute with the given name to the given value. If the value given is nil, then the attribute will be removed (since nil is returned by default).
|
|
984
987
|
*
|
|
@@ -6022,6 +6025,17 @@ interface Camera extends Instance {
|
|
|
6022
6025
|
readonly InterpolationFinished: RBXScriptSignal<() => void>;
|
|
6023
6026
|
}
|
|
6024
6027
|
|
|
6028
|
+
interface CaptureService extends Instance {
|
|
6029
|
+
/**
|
|
6030
|
+
* **DO NOT USE!**
|
|
6031
|
+
*
|
|
6032
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
6033
|
+
* @hidden
|
|
6034
|
+
* @deprecated
|
|
6035
|
+
*/
|
|
6036
|
+
readonly _nominal_CaptureService: unique symbol;
|
|
6037
|
+
}
|
|
6038
|
+
|
|
6025
6039
|
/** Base class for objects that change a character's appearance. */
|
|
6026
6040
|
interface CharacterAppearance extends Instance {
|
|
6027
6041
|
/**
|
|
@@ -6530,6 +6544,7 @@ interface DragDetector extends ClickDetector {
|
|
|
6530
6544
|
* @deprecated
|
|
6531
6545
|
*/
|
|
6532
6546
|
readonly _nominal_DragDetector: unique symbol;
|
|
6547
|
+
ActivatedCursorIcon: string;
|
|
6533
6548
|
ApplyAtCenterOfMass: boolean;
|
|
6534
6549
|
/**
|
|
6535
6550
|
* Tags: NotReplicated
|
|
@@ -8650,6 +8665,7 @@ interface ControllerManager extends Instance {
|
|
|
8650
8665
|
FacingDirection: Vector3;
|
|
8651
8666
|
GroundSensor: ControllerSensor | undefined;
|
|
8652
8667
|
MovingDirection: Vector3;
|
|
8668
|
+
RootPart: BasePart | undefined;
|
|
8653
8669
|
}
|
|
8654
8670
|
|
|
8655
8671
|
/** Container class for the [HumanoidController](https://developer.roblox.com/en-us/api-reference/class/HumanoidController) among other classes. */
|
|
@@ -10144,17 +10160,6 @@ interface FacialAnimationRecordingService extends Instance {
|
|
|
10144
10160
|
readonly _nominal_FacialAnimationRecordingService: unique symbol;
|
|
10145
10161
|
}
|
|
10146
10162
|
|
|
10147
|
-
interface FacialAnimationStreamingService extends Instance {
|
|
10148
|
-
/**
|
|
10149
|
-
* **DO NOT USE!**
|
|
10150
|
-
*
|
|
10151
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
10152
|
-
* @hidden
|
|
10153
|
-
* @deprecated
|
|
10154
|
-
*/
|
|
10155
|
-
readonly _nominal_FacialAnimationStreamingService: unique symbol;
|
|
10156
|
-
}
|
|
10157
|
-
|
|
10158
10163
|
interface FacialAnimationStreamingServiceStats extends Instance {
|
|
10159
10164
|
/**
|
|
10160
10165
|
* **DO NOT USE!**
|
|
@@ -22513,6 +22518,17 @@ interface NoCollisionConstraint extends Instance {
|
|
|
22513
22518
|
Part1: BasePart | undefined;
|
|
22514
22519
|
}
|
|
22515
22520
|
|
|
22521
|
+
interface OmniRecommendationsService extends Instance {
|
|
22522
|
+
/**
|
|
22523
|
+
* **DO NOT USE!**
|
|
22524
|
+
*
|
|
22525
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
22526
|
+
* @hidden
|
|
22527
|
+
* @deprecated
|
|
22528
|
+
*/
|
|
22529
|
+
readonly _nominal_OmniRecommendationsService: unique symbol;
|
|
22530
|
+
}
|
|
22531
|
+
|
|
22516
22532
|
/** A [PVInstance](https://developer.roblox.com/en-us/api-reference/class/PVInstance) (“Position Velocity Instance”) is an abstract class that cannot be created. It is the base for all objects that have a physical location in the world, specifically [BaseParts](https://developer.roblox.com/en-us/api-reference/class/BasePart) and [Models](https://developer.roblox.com/en-us/api-reference/class/Model). */
|
|
22517
22533
|
interface PVInstance extends Instance {
|
|
22518
22534
|
/**
|
|
@@ -24252,6 +24268,7 @@ interface PartOperation extends TriangleMeshPart {
|
|
|
24252
24268
|
* Sets whether the PartOperation can be recolored using the BrickColor property. When true, the entire Union will be colored as per [BasePart.BrickColor](https://developer.roblox.com/en-us/api-reference/property/BasePart/BrickColor). When false, the parts in the Union will maintain their original colors before the Union operation was performed.
|
|
24253
24269
|
*/
|
|
24254
24270
|
UsePartColor: boolean;
|
|
24271
|
+
SubstituteGeometry(this: PartOperation, source: Instance): void;
|
|
24255
24272
|
}
|
|
24256
24273
|
|
|
24257
24274
|
interface IntersectOperation extends PartOperation {
|
|
@@ -31593,6 +31610,7 @@ interface StyleBase extends Instance {
|
|
|
31593
31610
|
GetStyleRules(this: StyleBase): Array<Instance>;
|
|
31594
31611
|
InsertStyleRule(this: StyleBase, rule: StyleRule, index: number | undefined): void;
|
|
31595
31612
|
SetStyleRules(this: StyleBase, rules: Array<Instance>): void;
|
|
31613
|
+
readonly StyleRulesChanged: RBXScriptSignal<() => void>;
|
|
31596
31614
|
}
|
|
31597
31615
|
|
|
31598
31616
|
interface StyleRule extends StyleBase {
|
|
@@ -32882,8 +32900,10 @@ interface BubbleChatConfiguration extends TextChatConfigurations {
|
|
|
32882
32900
|
Font: Enum.Font;
|
|
32883
32901
|
FontFace: Font;
|
|
32884
32902
|
LocalPlayerStudsOffset: Vector3;
|
|
32903
|
+
MaxBubbles: number;
|
|
32885
32904
|
MaxDistance: number;
|
|
32886
32905
|
MinimizeDistance: number;
|
|
32906
|
+
TailVisible: boolean;
|
|
32887
32907
|
TextColor3: Color3;
|
|
32888
32908
|
TextSize: number;
|
|
32889
32909
|
VerticalStudsOffset: number;
|
|
@@ -32999,6 +33019,16 @@ interface TextChatService extends Instance {
|
|
|
32999
33019
|
readonly ChatVersion: Enum.ChatVersion;
|
|
33000
33020
|
readonly CreateDefaultCommands: boolean;
|
|
33001
33021
|
readonly CreateDefaultTextChannels: boolean;
|
|
33022
|
+
DisplayBubble(this: TextChatService, partOrCharacter: BasePart | Model, message: string): void;
|
|
33023
|
+
/**
|
|
33024
|
+
* Tags: Yields
|
|
33025
|
+
*/
|
|
33026
|
+
CanUserChatAsync(this: TextChatService, userId: number): boolean;
|
|
33027
|
+
/**
|
|
33028
|
+
* Tags: Yields
|
|
33029
|
+
*/
|
|
33030
|
+
CanUsersChatAsync(this: TextChatService, userIdFrom: number, userIdTo: number): boolean;
|
|
33031
|
+
readonly BubbleDisplayed: RBXScriptSignal<(part: BasePart, message: string) => void>;
|
|
33002
33032
|
readonly MessageReceived: RBXScriptSignal<(textChatMessage: TextChatMessage) => void>;
|
|
33003
33033
|
readonly SendingMessage: RBXScriptSignal<(textChatMessage: TextChatMessage) => void>;
|
|
33004
33034
|
OnIncomingMessage: (message: TextChatMessage) => void;
|
|
@@ -1954,9 +1954,17 @@ declare namespace Enum {
|
|
|
1954
1954
|
|
|
1955
1955
|
export const UserVideo: UserVideo;
|
|
1956
1956
|
|
|
1957
|
+
export interface UserBanned extends globalThis.EnumItem {
|
|
1958
|
+
Name: "UserBanned";
|
|
1959
|
+
Value: 256;
|
|
1960
|
+
EnumType: typeof globalThis.Enum.AvatarChatServiceFeature;
|
|
1961
|
+
}
|
|
1962
|
+
|
|
1963
|
+
export const UserBanned: UserBanned;
|
|
1964
|
+
|
|
1957
1965
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AvatarChatServiceFeature>;
|
|
1958
1966
|
}
|
|
1959
|
-
export type AvatarChatServiceFeature = AvatarChatServiceFeature.None | AvatarChatServiceFeature.UniverseAudio | AvatarChatServiceFeature.UniverseVideo | AvatarChatServiceFeature.PlaceAudio | AvatarChatServiceFeature.PlaceVideo | AvatarChatServiceFeature.UserAudioEligible | AvatarChatServiceFeature.UserAudio | AvatarChatServiceFeature.UserVideoEligible | AvatarChatServiceFeature.UserVideo;
|
|
1967
|
+
export type AvatarChatServiceFeature = AvatarChatServiceFeature.None | AvatarChatServiceFeature.UniverseAudio | AvatarChatServiceFeature.UniverseVideo | AvatarChatServiceFeature.PlaceAudio | AvatarChatServiceFeature.PlaceVideo | AvatarChatServiceFeature.UserAudioEligible | AvatarChatServiceFeature.UserAudio | AvatarChatServiceFeature.UserVideoEligible | AvatarChatServiceFeature.UserVideo | AvatarChatServiceFeature.UserBanned;
|
|
1960
1968
|
|
|
1961
1969
|
export namespace AvatarContextMenuOption {
|
|
1962
1970
|
export interface Friend extends globalThis.EnumItem {
|
|
@@ -5939,43 +5947,6 @@ declare namespace Enum {
|
|
|
5939
5947
|
}
|
|
5940
5948
|
export type ExplosionType = ExplosionType.NoCraters | ExplosionType.Craters;
|
|
5941
5949
|
|
|
5942
|
-
export namespace FacialAnimationFlags {
|
|
5943
|
-
export interface None extends globalThis.EnumItem {
|
|
5944
|
-
Name: "None";
|
|
5945
|
-
Value: 0;
|
|
5946
|
-
EnumType: typeof globalThis.Enum.FacialAnimationFlags;
|
|
5947
|
-
}
|
|
5948
|
-
|
|
5949
|
-
export const None: None;
|
|
5950
|
-
|
|
5951
|
-
export interface Place extends globalThis.EnumItem {
|
|
5952
|
-
Name: "Place";
|
|
5953
|
-
Value: 1;
|
|
5954
|
-
EnumType: typeof globalThis.Enum.FacialAnimationFlags;
|
|
5955
|
-
}
|
|
5956
|
-
|
|
5957
|
-
export const Place: Place;
|
|
5958
|
-
|
|
5959
|
-
export interface Server extends globalThis.EnumItem {
|
|
5960
|
-
Name: "Server";
|
|
5961
|
-
Value: 2;
|
|
5962
|
-
EnumType: typeof globalThis.Enum.FacialAnimationFlags;
|
|
5963
|
-
}
|
|
5964
|
-
|
|
5965
|
-
export const Server: Server;
|
|
5966
|
-
|
|
5967
|
-
export interface PlaceServer extends globalThis.EnumItem {
|
|
5968
|
-
Name: "PlaceServer";
|
|
5969
|
-
Value: 3;
|
|
5970
|
-
EnumType: typeof globalThis.Enum.FacialAnimationFlags;
|
|
5971
|
-
}
|
|
5972
|
-
|
|
5973
|
-
export const PlaceServer: PlaceServer;
|
|
5974
|
-
|
|
5975
|
-
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.FacialAnimationFlags>;
|
|
5976
|
-
}
|
|
5977
|
-
export type FacialAnimationFlags = FacialAnimationFlags.None | FacialAnimationFlags.Place | FacialAnimationFlags.Server | FacialAnimationFlags.PlaceServer;
|
|
5978
|
-
|
|
5979
5950
|
export namespace FacialAnimationStreamingState {
|
|
5980
5951
|
export interface None extends globalThis.EnumItem {
|
|
5981
5952
|
Name: "None";
|
|
@@ -11366,6 +11337,35 @@ declare namespace Enum {
|
|
|
11366
11337
|
}
|
|
11367
11338
|
export type ModelLevelOfDetail = ModelLevelOfDetail.Automatic | ModelLevelOfDetail.StreamingMesh | ModelLevelOfDetail.Disabled;
|
|
11368
11339
|
|
|
11340
|
+
export namespace ModelStreamingBehavior {
|
|
11341
|
+
export interface Default extends globalThis.EnumItem {
|
|
11342
|
+
Name: "Default";
|
|
11343
|
+
Value: 0;
|
|
11344
|
+
EnumType: typeof globalThis.Enum.ModelStreamingBehavior;
|
|
11345
|
+
}
|
|
11346
|
+
|
|
11347
|
+
export const Default: Default;
|
|
11348
|
+
|
|
11349
|
+
export interface Legacy extends globalThis.EnumItem {
|
|
11350
|
+
Name: "Legacy";
|
|
11351
|
+
Value: 1;
|
|
11352
|
+
EnumType: typeof globalThis.Enum.ModelStreamingBehavior;
|
|
11353
|
+
}
|
|
11354
|
+
|
|
11355
|
+
export const Legacy: Legacy;
|
|
11356
|
+
|
|
11357
|
+
export interface Improved extends globalThis.EnumItem {
|
|
11358
|
+
Name: "Improved";
|
|
11359
|
+
Value: 2;
|
|
11360
|
+
EnumType: typeof globalThis.Enum.ModelStreamingBehavior;
|
|
11361
|
+
}
|
|
11362
|
+
|
|
11363
|
+
export const Improved: Improved;
|
|
11364
|
+
|
|
11365
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ModelStreamingBehavior>;
|
|
11366
|
+
}
|
|
11367
|
+
export type ModelStreamingBehavior = ModelStreamingBehavior.Default | ModelStreamingBehavior.Legacy | ModelStreamingBehavior.Improved;
|
|
11368
|
+
|
|
11369
11369
|
export namespace ModelStreamingMode {
|
|
11370
11370
|
export interface Default extends globalThis.EnumItem {
|
|
11371
11371
|
Name: "Default";
|
|
@@ -12816,9 +12816,17 @@ declare namespace Enum {
|
|
|
12816
12816
|
|
|
12817
12817
|
export const NoUserInput: NoUserInput;
|
|
12818
12818
|
|
|
12819
|
+
export interface UnknownFailure extends globalThis.EnumItem {
|
|
12820
|
+
Name: "UnknownFailure";
|
|
12821
|
+
Value: 6;
|
|
12822
|
+
EnumType: typeof globalThis.Enum.PromptPublishAssetResult;
|
|
12823
|
+
}
|
|
12824
|
+
|
|
12825
|
+
export const UnknownFailure: UnknownFailure;
|
|
12826
|
+
|
|
12819
12827
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PromptPublishAssetResult>;
|
|
12820
12828
|
}
|
|
12821
|
-
export type PromptPublishAssetResult = PromptPublishAssetResult.Success | PromptPublishAssetResult.PermissionDenied | PromptPublishAssetResult.Timeout | PromptPublishAssetResult.UploadFailed | PromptPublishAssetResult.NoUserInput;
|
|
12829
|
+
export type PromptPublishAssetResult = PromptPublishAssetResult.Success | PromptPublishAssetResult.PermissionDenied | PromptPublishAssetResult.Timeout | PromptPublishAssetResult.UploadFailed | PromptPublishAssetResult.NoUserInput | PromptPublishAssetResult.UnknownFailure;
|
|
12822
12830
|
|
|
12823
12831
|
export namespace PropertyStatus {
|
|
12824
12832
|
export interface Ok extends globalThis.EnumItem {
|
|
@@ -15430,9 +15438,17 @@ declare namespace Enum {
|
|
|
15430
15438
|
|
|
15431
15439
|
export const AICOOverlayButtonBackgroundPressed: AICOOverlayButtonBackgroundPressed;
|
|
15432
15440
|
|
|
15441
|
+
export interface IndentationRuler extends globalThis.EnumItem {
|
|
15442
|
+
Name: "IndentationRuler";
|
|
15443
|
+
Value: 45;
|
|
15444
|
+
EnumType: typeof globalThis.Enum.StudioScriptEditorColorCategories;
|
|
15445
|
+
}
|
|
15446
|
+
|
|
15447
|
+
export const IndentationRuler: IndentationRuler;
|
|
15448
|
+
|
|
15433
15449
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.StudioScriptEditorColorCategories>;
|
|
15434
15450
|
}
|
|
15435
|
-
export type StudioScriptEditorColorCategories = StudioScriptEditorColorCategories.Default | StudioScriptEditorColorCategories.Operator | StudioScriptEditorColorCategories.Number | StudioScriptEditorColorCategories.String | StudioScriptEditorColorCategories.Comment | StudioScriptEditorColorCategories.Keyword | StudioScriptEditorColorCategories.Builtin | StudioScriptEditorColorCategories.Method | StudioScriptEditorColorCategories.Property | StudioScriptEditorColorCategories.Nil | StudioScriptEditorColorCategories.Bool | StudioScriptEditorColorCategories.Function | StudioScriptEditorColorCategories.Local | StudioScriptEditorColorCategories.Self | StudioScriptEditorColorCategories.LuauKeyword | StudioScriptEditorColorCategories.FunctionName | StudioScriptEditorColorCategories.TODO | StudioScriptEditorColorCategories.Background | StudioScriptEditorColorCategories.SelectionText | StudioScriptEditorColorCategories.SelectionBackground | StudioScriptEditorColorCategories.FindSelectionBackground | StudioScriptEditorColorCategories.MatchingWordBackground | StudioScriptEditorColorCategories.Warning | StudioScriptEditorColorCategories.Error | StudioScriptEditorColorCategories.Info | StudioScriptEditorColorCategories.Hint | StudioScriptEditorColorCategories.Whitespace | StudioScriptEditorColorCategories.ActiveLine | StudioScriptEditorColorCategories.DebuggerCurrentLine | StudioScriptEditorColorCategories.DebuggerErrorLine | StudioScriptEditorColorCategories.Ruler | StudioScriptEditorColorCategories.Bracket | StudioScriptEditorColorCategories.MenuPrimaryText | StudioScriptEditorColorCategories.MenuSecondaryText | StudioScriptEditorColorCategories.MenuSelectedText | StudioScriptEditorColorCategories.MenuBackground | StudioScriptEditorColorCategories.MenuSelectedBackground | StudioScriptEditorColorCategories.MenuScrollbarBackground | StudioScriptEditorColorCategories.MenuScrollbarHandle | StudioScriptEditorColorCategories.MenuBorder | StudioScriptEditorColorCategories.DocViewCodeBackground | StudioScriptEditorColorCategories.AICOOverlayText | StudioScriptEditorColorCategories.AICOOverlayButtonBackground | StudioScriptEditorColorCategories.AICOOverlayButtonBackgroundHover | StudioScriptEditorColorCategories.AICOOverlayButtonBackgroundPressed;
|
|
15451
|
+
export type StudioScriptEditorColorCategories = StudioScriptEditorColorCategories.Default | StudioScriptEditorColorCategories.Operator | StudioScriptEditorColorCategories.Number | StudioScriptEditorColorCategories.String | StudioScriptEditorColorCategories.Comment | StudioScriptEditorColorCategories.Keyword | StudioScriptEditorColorCategories.Builtin | StudioScriptEditorColorCategories.Method | StudioScriptEditorColorCategories.Property | StudioScriptEditorColorCategories.Nil | StudioScriptEditorColorCategories.Bool | StudioScriptEditorColorCategories.Function | StudioScriptEditorColorCategories.Local | StudioScriptEditorColorCategories.Self | StudioScriptEditorColorCategories.LuauKeyword | StudioScriptEditorColorCategories.FunctionName | StudioScriptEditorColorCategories.TODO | StudioScriptEditorColorCategories.Background | StudioScriptEditorColorCategories.SelectionText | StudioScriptEditorColorCategories.SelectionBackground | StudioScriptEditorColorCategories.FindSelectionBackground | StudioScriptEditorColorCategories.MatchingWordBackground | StudioScriptEditorColorCategories.Warning | StudioScriptEditorColorCategories.Error | StudioScriptEditorColorCategories.Info | StudioScriptEditorColorCategories.Hint | StudioScriptEditorColorCategories.Whitespace | StudioScriptEditorColorCategories.ActiveLine | StudioScriptEditorColorCategories.DebuggerCurrentLine | StudioScriptEditorColorCategories.DebuggerErrorLine | StudioScriptEditorColorCategories.Ruler | StudioScriptEditorColorCategories.Bracket | StudioScriptEditorColorCategories.MenuPrimaryText | StudioScriptEditorColorCategories.MenuSecondaryText | StudioScriptEditorColorCategories.MenuSelectedText | StudioScriptEditorColorCategories.MenuBackground | StudioScriptEditorColorCategories.MenuSelectedBackground | StudioScriptEditorColorCategories.MenuScrollbarBackground | StudioScriptEditorColorCategories.MenuScrollbarHandle | StudioScriptEditorColorCategories.MenuBorder | StudioScriptEditorColorCategories.DocViewCodeBackground | StudioScriptEditorColorCategories.AICOOverlayText | StudioScriptEditorColorCategories.AICOOverlayButtonBackground | StudioScriptEditorColorCategories.AICOOverlayButtonBackgroundHover | StudioScriptEditorColorCategories.AICOOverlayButtonBackgroundPressed | StudioScriptEditorColorCategories.IndentationRuler;
|
|
15436
15452
|
|
|
15437
15453
|
export namespace StudioScriptEditorColorPresets {
|
|
15438
15454
|
export interface RobloxDefault extends globalThis.EnumItem {
|
package/include/roblox.d.ts
CHANGED
|
@@ -1875,6 +1875,8 @@ type RotationCurveKeyConstructor = new (
|
|
|
1875
1875
|
) => RotationCurveKey;
|
|
1876
1876
|
declare const RotationCurveKey: RotationCurveKeyConstructor;
|
|
1877
1877
|
|
|
1878
|
+
declare const SharedTableNominal: unique symbol;
|
|
1879
|
+
type SharedTableValue = boolean | number | Vector3 | string | SharedTable | Instance | typeof SharedTableNominal;
|
|
1878
1880
|
// SharedTable
|
|
1879
1881
|
interface SharedTable {
|
|
1880
1882
|
/**
|
|
@@ -1884,9 +1886,80 @@ interface SharedTable {
|
|
|
1884
1886
|
* @hidden
|
|
1885
1887
|
* @deprecated
|
|
1886
1888
|
*/
|
|
1887
|
-
readonly _nominal_SharedTable:
|
|
1889
|
+
readonly _nominal_SharedTable: typeof SharedTableNominal;
|
|
1890
|
+
[K: string | number]: SharedTableValue;
|
|
1888
1891
|
}
|
|
1889
1892
|
|
|
1893
|
+
interface SharedTableConstructor {
|
|
1894
|
+
/** Returns a new, empty SharedTable. */
|
|
1895
|
+
new (): SharedTable;
|
|
1896
|
+
/** Returns a new SharedTable containing elements equivalent to those in the provided object. */
|
|
1897
|
+
new (t: object): SharedTable;
|
|
1898
|
+
/** Removes all of the elements from the SharedTable. */
|
|
1899
|
+
clear: (st: SharedTable) => void;
|
|
1900
|
+
/**
|
|
1901
|
+
* Creates a clone of a SharedTable and returns the clone.
|
|
1902
|
+
*
|
|
1903
|
+
* If the optional deep argument is not present, or if it is present and its value is false, then a shallow clone is created.
|
|
1904
|
+
* A shallow clone copies only the top-level SharedTable object. If any value in the SharedTable itself is a SharedTable, then both the original SharedTable and the clone SharedTable will refer to the same SharedTable.
|
|
1905
|
+
*
|
|
1906
|
+
* The shallow clone operation is atomic, so the clone SharedTable will contain a consistent snapshot of the state in the original SharedTable, even if it is being modified concurrently from other scripts.
|
|
1907
|
+
*
|
|
1908
|
+
* If the optional deep argument is present and its value is true, then a deep clone is created.
|
|
1909
|
+
* A deep clone recursively copies a structure of SharedTable objects, such that there is no state shared between the original SharedTable and the clone.
|
|
1910
|
+
*
|
|
1911
|
+
* The clone of each SharedTable within the graph of SharedTable objects is atomic, but the deep clone as a whole is not atomic.
|
|
1912
|
+
* Thus, the clone of each SharedTable within the graph will contain a consistent snapshot of the state of the original SharedTable object from which it was cloned, but the states of different SharedTable objects may be inconsistent if the graph is being modified concurrently from other scripts.
|
|
1913
|
+
*
|
|
1914
|
+
* The SharedTable object(s) being cloned may be frozen (read-only) or not.
|
|
1915
|
+
* Regardless, the newly created clones are not frozen (and are thus modifiable).
|
|
1916
|
+
* To create frozen clones, use the SharedTable.cloneAndFreeze function.
|
|
1917
|
+
*/
|
|
1918
|
+
clone: (st: SharedTable, deep?: boolean) => SharedTable;
|
|
1919
|
+
/**
|
|
1920
|
+
* Creates a frozen (read-only) clone of a SharedTable and returns the clone.
|
|
1921
|
+
* The behavior of this function is the same as the behavior of clone, except that the clone is frozen.
|
|
1922
|
+
*
|
|
1923
|
+
* If a deep clone is requested, then all of the cloned SharedTable objects are frozen.
|
|
1924
|
+
*/
|
|
1925
|
+
cloneAndFreeze: (st: SharedTable, deep?: boolean) => SharedTable;
|
|
1926
|
+
/**
|
|
1927
|
+
* Atomically increments the value of an element.
|
|
1928
|
+
* An element with the specified key must exist in the SharedTable, and it must be of type number.
|
|
1929
|
+
* The specified delta is added to the value, and the original value is returned.
|
|
1930
|
+
*
|
|
1931
|
+
* The SharedTable.update function can also be used for this purpose; this increment function exists for convenience and performance.
|
|
1932
|
+
* In general, increment is much faster than update, so it should be preferred where possible.
|
|
1933
|
+
*/
|
|
1934
|
+
increment: (st: SharedTable, k: string | number, delta: number) => number;
|
|
1935
|
+
/** Returns true if the SharedTable is frozen (read-only). */
|
|
1936
|
+
isFrozen: (st: SharedTable) => boolean;
|
|
1937
|
+
/**
|
|
1938
|
+
* Returns the number of elements stored in the SharedTable.
|
|
1939
|
+
* Note that if other scripts are concurrently modifying the SharedTable, the returned size may no longer be correct after it is returned, since other scripts may have added or removed elements from the SharedTable.
|
|
1940
|
+
*/
|
|
1941
|
+
size: (st: SharedTable) => number;
|
|
1942
|
+
/**
|
|
1943
|
+
* Atomically updates the value of an element.
|
|
1944
|
+
*
|
|
1945
|
+
* When a SharedTable is accessed concurrently from scripts running in different execution contexts, it is possible for their accesses to interleave unpredictably.
|
|
1946
|
+
* Because of this, code like the following is generally incorrect, because the value may have changed between the read on the first line and the update on the second line:
|
|
1947
|
+
* ```ts
|
|
1948
|
+
* const oldValue = st["x"];
|
|
1949
|
+
* st["x"] = oldValue + ",x";
|
|
1950
|
+
* ```
|
|
1951
|
+
* The update function makes it possible to perform an atomic update to an element.
|
|
1952
|
+
* It takes a function that it will call with the current value of the element.
|
|
1953
|
+
* The function can then compute and return the new value.
|
|
1954
|
+
* Note that the function may be called multiple times if the SharedTable is being concurrently modified from other scripts.
|
|
1955
|
+
*
|
|
1956
|
+
* If the SharedTable is frozen, the operation fails and an error will be raised.
|
|
1957
|
+
*/
|
|
1958
|
+
update: (st: SharedTable, k: string | number, f: (v: SharedTableValue) => SharedTableValue) => void;
|
|
1959
|
+
}
|
|
1960
|
+
|
|
1961
|
+
declare const SharedTable: SharedTableConstructor;
|
|
1962
|
+
|
|
1890
1963
|
// TextChatMessage
|
|
1891
1964
|
interface TextChatMessage {
|
|
1892
1965
|
/**
|