@rbxts/types 1.0.674 → 1.0.676
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.
|
@@ -84,6 +84,7 @@ interface Services {
|
|
|
84
84
|
ProcessInstancePhysicsService: ProcessInstancePhysicsService;
|
|
85
85
|
ProximityPromptService: ProximityPromptService;
|
|
86
86
|
PublishService: PublishService;
|
|
87
|
+
RemoteCursorService: RemoteCursorService;
|
|
87
88
|
RemoteDebuggerServer: RemoteDebuggerServer;
|
|
88
89
|
ReplicatedFirst: ReplicatedFirst;
|
|
89
90
|
ReplicatedStorage: ReplicatedStorage;
|
|
@@ -99,6 +100,7 @@ interface Services {
|
|
|
99
100
|
SelectionHighlightManager: SelectionHighlightManager;
|
|
100
101
|
ServerScriptService: ServerScriptService;
|
|
101
102
|
ServerStorage: ServerStorage;
|
|
103
|
+
ServiceVisibilityService: ServiceVisibilityService;
|
|
102
104
|
SessionService: SessionService;
|
|
103
105
|
SharedTableRegistry: SharedTableRegistry;
|
|
104
106
|
ShorelineUpgraderService: ShorelineUpgraderService;
|
|
@@ -442,7 +444,6 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
442
444
|
CommandInstance: CommandInstance;
|
|
443
445
|
ControllerBase: ControllerBase;
|
|
444
446
|
ControllerSensor: ControllerSensor;
|
|
445
|
-
CoreScriptBuilder: CoreScriptBuilder;
|
|
446
447
|
CustomSoundEffect: CustomSoundEffect;
|
|
447
448
|
DataModel: DataModel;
|
|
448
449
|
DataStore: DataStore;
|
|
@@ -1912,6 +1913,7 @@ interface AnimationTrack extends Instance {
|
|
|
1912
1913
|
* When is adjusted, then the actual time it will take a track to play can be computed by dividing the length by the speed. Speed is a unitless quantity.
|
|
1913
1914
|
*
|
|
1914
1915
|
* Speed can be used to link the length of an animation to different gameplay events (for example recharging an ability) without having to upload different variants of the same animation.
|
|
1916
|
+
* Tags: CustomLuaState
|
|
1915
1917
|
*/
|
|
1916
1918
|
AdjustSpeed(this: AnimationTrack, speed?: number): void;
|
|
1917
1919
|
/**
|
|
@@ -1926,6 +1928,7 @@ interface AnimationTrack extends Instance {
|
|
|
1926
1928
|
* 
|
|
1927
1929
|
*
|
|
1928
1930
|
* In most cases blending animations is not required and using [AnimationTrack.Priority](https://developer.roblox.com/en-us/api-reference/property/AnimationTrack/Priority) is more suitable.
|
|
1931
|
+
* Tags: CustomLuaState
|
|
1929
1932
|
*/
|
|
1930
1933
|
AdjustWeight(this: AnimationTrack, weight?: number, fadeTime?: number): void;
|
|
1931
1934
|
/**
|
|
@@ -1966,6 +1969,7 @@ interface AnimationTrack extends Instance {
|
|
|
1966
1969
|
* The weight and speed of the animation can also be changed after the animation has begun playing by using the [AnimationTrack:AdjustWeight](https://developer.roblox.com/en-us/api-reference/function/AnimationTrack/AdjustWeight) and [AnimationTrack:AdjustSpeed](https://developer.roblox.com/en-us/api-reference/function/AnimationTrack/AdjustSpeed) methods.
|
|
1967
1970
|
*
|
|
1968
1971
|
* If the developer wants to start the animation at a specific point using [AnimationTrack.TimePosition](https://developer.roblox.com/en-us/api-reference/property/AnimationTrack/TimePosition), it is important the animation is played before this is done.
|
|
1972
|
+
* Tags: CustomLuaState
|
|
1969
1973
|
*/
|
|
1970
1974
|
Play(this: AnimationTrack, fadeTime?: number, weight?: number, speed?: number): void;
|
|
1971
1975
|
/**
|
|
@@ -1974,6 +1978,7 @@ interface AnimationTrack extends Instance {
|
|
|
1974
1978
|
* For example, if Stop is called with a fadeTime of 2 seconds it will take two seconds for the weight of the [AnimationTrack](https://developer.roblox.com/en-us/api-reference/class/AnimationTrack) to reach zero and its effects completely end. Please note this will be the case regardless of the initial weight of the animation.
|
|
1975
1979
|
*
|
|
1976
1980
|
* It is not recommended to use a fadeTime of 0 seconds to try to override this effect and end the animation immediately as presently, this causes the [AnimationTrack](https://developer.roblox.com/en-us/api-reference/class/AnimationTrack) poses to freeze.
|
|
1981
|
+
* Tags: CustomLuaState
|
|
1977
1982
|
*/
|
|
1978
1983
|
Stop(this: AnimationTrack, fadeTime?: number): void;
|
|
1979
1984
|
/**
|
|
@@ -2568,6 +2573,11 @@ interface AudioSearchParams extends Instance {
|
|
|
2568
2573
|
readonly _nominal_AudioSearchParams: unique symbol;
|
|
2569
2574
|
Album: string;
|
|
2570
2575
|
Artist: string;
|
|
2576
|
+
AudioSubType: Enum.AudioSubType;
|
|
2577
|
+
/**
|
|
2578
|
+
* Tags: NotReplicated, Deprecated, [object Object]
|
|
2579
|
+
* @deprecated
|
|
2580
|
+
*/
|
|
2571
2581
|
AudioSubtype: Enum.AudioSubType;
|
|
2572
2582
|
MaxDuration: number;
|
|
2573
2583
|
MinDuration: number;
|
|
@@ -8276,11 +8286,16 @@ interface AirController extends ControllerBase {
|
|
|
8276
8286
|
* @deprecated
|
|
8277
8287
|
*/
|
|
8278
8288
|
readonly _nominal_AirController: unique symbol;
|
|
8289
|
+
BalanceMaxTorque: number;
|
|
8290
|
+
BalanceRigidityEnabled: boolean;
|
|
8291
|
+
BalanceSpeed: number;
|
|
8279
8292
|
MaintainAngularMomentum: boolean;
|
|
8280
8293
|
MaintainLinearMomentum: boolean;
|
|
8281
8294
|
MoveMaxForce: number;
|
|
8282
8295
|
OrientationMaxTorque: number;
|
|
8283
8296
|
OrientationSpeedFactor: number;
|
|
8297
|
+
TurningMaxTorque: number;
|
|
8298
|
+
TurningSpeedFactor: number;
|
|
8284
8299
|
VectorForce: Vector3;
|
|
8285
8300
|
}
|
|
8286
8301
|
|
|
@@ -8294,6 +8309,9 @@ interface ClimbController extends ControllerBase {
|
|
|
8294
8309
|
*/
|
|
8295
8310
|
readonly _nominal_ClimbController: unique symbol;
|
|
8296
8311
|
AccelerationTime: number;
|
|
8312
|
+
BalanceMaxTorque: number;
|
|
8313
|
+
BalanceRigidityEnabled: boolean;
|
|
8314
|
+
BalanceSpeed: number;
|
|
8297
8315
|
MoveMaxForce: number;
|
|
8298
8316
|
OrientationMaxTorque: number;
|
|
8299
8317
|
OrientationSpeedFactor: number;
|
|
@@ -8312,6 +8330,9 @@ interface GroundController extends ControllerBase {
|
|
|
8312
8330
|
AccelerationTime: number;
|
|
8313
8331
|
AlignSpeed: number;
|
|
8314
8332
|
AlignTorque: number;
|
|
8333
|
+
BalanceMaxTorque: number;
|
|
8334
|
+
BalanceRigidityEnabled: boolean;
|
|
8335
|
+
BalanceSpeed: number;
|
|
8315
8336
|
DecelerationTime: number;
|
|
8316
8337
|
Friction: number;
|
|
8317
8338
|
FrictionWeight: number;
|
|
@@ -24483,9 +24504,9 @@ interface Actor extends Model {
|
|
|
24483
24504
|
* @deprecated
|
|
24484
24505
|
*/
|
|
24485
24506
|
readonly _nominal_Actor: unique symbol;
|
|
24486
|
-
BindToMessage(this: Actor,
|
|
24487
|
-
BindToMessageParallel(this: Actor,
|
|
24488
|
-
SendMessage(this: Actor,
|
|
24507
|
+
BindToMessage(this: Actor, topic: string, callback: Callback): RBXScriptConnection;
|
|
24508
|
+
BindToMessageParallel(this: Actor, topic: string, callback: Callback): RBXScriptConnection;
|
|
24509
|
+
SendMessage(this: Actor, topic: string, message: Array<any>): void;
|
|
24489
24510
|
}
|
|
24490
24511
|
|
|
24491
24512
|
/** BackpackItem is an abstract class for backpack items such as HopperBins and Tools. */
|
|
@@ -28248,6 +28269,17 @@ interface PublishService extends Instance {
|
|
|
28248
28269
|
readonly _nominal_PublishService: unique symbol;
|
|
28249
28270
|
}
|
|
28250
28271
|
|
|
28272
|
+
interface RemoteCursorService extends Instance {
|
|
28273
|
+
/**
|
|
28274
|
+
* **DO NOT USE!**
|
|
28275
|
+
*
|
|
28276
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
28277
|
+
* @hidden
|
|
28278
|
+
* @deprecated
|
|
28279
|
+
*/
|
|
28280
|
+
readonly _nominal_RemoteCursorService: unique symbol;
|
|
28281
|
+
}
|
|
28282
|
+
|
|
28251
28283
|
interface RemoteDebuggerServer extends Instance {
|
|
28252
28284
|
/**
|
|
28253
28285
|
* **DO NOT USE!**
|
|
@@ -28935,17 +28967,6 @@ interface ScriptBuilder extends Instance {
|
|
|
28935
28967
|
readonly _nominal_ScriptBuilder: unique symbol;
|
|
28936
28968
|
}
|
|
28937
28969
|
|
|
28938
|
-
interface CoreScriptBuilder extends ScriptBuilder {
|
|
28939
|
-
/**
|
|
28940
|
-
* **DO NOT USE!**
|
|
28941
|
-
*
|
|
28942
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
28943
|
-
* @hidden
|
|
28944
|
-
* @deprecated
|
|
28945
|
-
*/
|
|
28946
|
-
readonly _nominal_CoreScriptBuilder: unique symbol;
|
|
28947
|
-
}
|
|
28948
|
-
|
|
28949
28970
|
interface SyncScriptBuilder extends ScriptBuilder {
|
|
28950
28971
|
/**
|
|
28951
28972
|
* **DO NOT USE!**
|
|
@@ -29549,6 +29570,17 @@ interface UserSettings extends GenericSettings<{ UserGameSettings: UserGameSetti
|
|
|
29549
29570
|
Reset(this: UserSettings): void;
|
|
29550
29571
|
}
|
|
29551
29572
|
|
|
29573
|
+
interface ServiceVisibilityService extends Instance {
|
|
29574
|
+
/**
|
|
29575
|
+
* **DO NOT USE!**
|
|
29576
|
+
*
|
|
29577
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
29578
|
+
* @hidden
|
|
29579
|
+
* @deprecated
|
|
29580
|
+
*/
|
|
29581
|
+
readonly _nominal_ServiceVisibilityService: unique symbol;
|
|
29582
|
+
}
|
|
29583
|
+
|
|
29552
29584
|
interface SessionService extends Instance {
|
|
29553
29585
|
/**
|
|
29554
29586
|
* **DO NOT USE!**
|
|
@@ -35895,6 +35927,10 @@ interface VRService extends Instance {
|
|
|
35895
35927
|
* @deprecated
|
|
35896
35928
|
*/
|
|
35897
35929
|
readonly _nominal_VRService: unique symbol;
|
|
35930
|
+
/**
|
|
35931
|
+
* Tags: NotReplicated
|
|
35932
|
+
*/
|
|
35933
|
+
AutomaticScaling: Enum.VRScaling;
|
|
35898
35934
|
FadeOutViewOnCollision: boolean;
|
|
35899
35935
|
/**
|
|
35900
35936
|
* The GuiInputUserCFrame property describes what [UserCFrame](https://developer.roblox.com/en-us/api-reference/enum/UserCFrame) is responsible for input in VR. For instance, if a VR headset is responsible, the value of this property will be UserCFrame.Head.
|
|
@@ -940,6 +940,21 @@ interface LuaSettings extends Instance {
|
|
|
940
940
|
readonly _nominal_LuaSettings: unique symbol;
|
|
941
941
|
}
|
|
942
942
|
|
|
943
|
+
interface LuaSourceContainer extends Instance {
|
|
944
|
+
/**
|
|
945
|
+
* **DO NOT USE!**
|
|
946
|
+
*
|
|
947
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
948
|
+
* @hidden
|
|
949
|
+
* @deprecated
|
|
950
|
+
*/
|
|
951
|
+
readonly _nominal_LuaSourceContainer: unique symbol;
|
|
952
|
+
/**
|
|
953
|
+
* Tags: NotReplicated
|
|
954
|
+
*/
|
|
955
|
+
RuntimeSource: string;
|
|
956
|
+
}
|
|
957
|
+
|
|
943
958
|
interface Script extends BaseScript {
|
|
944
959
|
/**
|
|
945
960
|
* **DO NOT USE!**
|
|
@@ -3226,7 +3241,6 @@ interface Studio extends Instance {
|
|
|
3226
3241
|
["Server Audio Behavior"]: Enum.ServerAudioBehavior;
|
|
3227
3242
|
["Set Pivot of Imported Parts"]: boolean;
|
|
3228
3243
|
["Show Core GUI in Explorer while Playing"]: boolean;
|
|
3229
|
-
["Show Deployment Warnings"]: boolean;
|
|
3230
3244
|
["Show Diagnostics Bar"]: boolean;
|
|
3231
3245
|
["Show FileSyncService"]: boolean;
|
|
3232
3246
|
["Show Hidden Objects in Explorer"]: boolean;
|
|
@@ -4003,14 +4003,6 @@ declare namespace Enum {
|
|
|
4003
4003
|
|
|
4004
4004
|
export const DisconnectClientRequest: DisconnectClientRequest;
|
|
4005
4005
|
|
|
4006
|
-
export interface DisconnectOutOfMemory extends globalThis.EnumItem {
|
|
4007
|
-
Name: "DisconnectOutOfMemory";
|
|
4008
|
-
Value: 286;
|
|
4009
|
-
EnumType: typeof globalThis.Enum.ConnectionError;
|
|
4010
|
-
}
|
|
4011
|
-
|
|
4012
|
-
export const DisconnectOutOfMemory: DisconnectOutOfMemory;
|
|
4013
|
-
|
|
4014
4006
|
export interface DisconnectModeratedGame extends globalThis.EnumItem {
|
|
4015
4007
|
Name: "DisconnectModeratedGame";
|
|
4016
4008
|
Value: 287;
|
|
@@ -4019,21 +4011,13 @@ declare namespace Enum {
|
|
|
4019
4011
|
|
|
4020
4012
|
export const DisconnectModeratedGame: DisconnectModeratedGame;
|
|
4021
4013
|
|
|
4022
|
-
export interface
|
|
4023
|
-
Name: "
|
|
4024
|
-
Value:
|
|
4025
|
-
EnumType: typeof globalThis.Enum.ConnectionError;
|
|
4026
|
-
}
|
|
4027
|
-
|
|
4028
|
-
export const DisconnectOutOfMemoryExitContinue: DisconnectOutOfMemoryExitContinue;
|
|
4029
|
-
|
|
4030
|
-
export interface DisconnectOutOfMemoryKeepPlayingExit extends globalThis.EnumItem {
|
|
4031
|
-
Name: "DisconnectOutOfMemoryKeepPlayingExit";
|
|
4032
|
-
Value: 289;
|
|
4014
|
+
export interface DisconnectRomarkEndOfTest extends globalThis.EnumItem {
|
|
4015
|
+
Name: "DisconnectRomarkEndOfTest";
|
|
4016
|
+
Value: 293;
|
|
4033
4017
|
EnumType: typeof globalThis.Enum.ConnectionError;
|
|
4034
4018
|
}
|
|
4035
4019
|
|
|
4036
|
-
export const
|
|
4020
|
+
export const DisconnectRomarkEndOfTest: DisconnectRomarkEndOfTest;
|
|
4037
4021
|
|
|
4038
4022
|
export interface ReplicatorTimeout extends globalThis.EnumItem {
|
|
4039
4023
|
Name: "ReplicatorTimeout";
|
|
@@ -4253,7 +4237,7 @@ declare namespace Enum {
|
|
|
4253
4237
|
|
|
4254
4238
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ConnectionError>;
|
|
4255
4239
|
}
|
|
4256
|
-
export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectNewSecurityKeyMismatch | 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.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.
|
|
4240
|
+
export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectNewSecurityKeyMismatch | 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.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.DisconnectModeratedGame | ConnectionError.DisconnectRomarkEndOfTest | ConnectionError.ReplicatorTimeout | ConnectionError.PlayerRemoved | ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave | 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;
|
|
4257
4241
|
|
|
4258
4242
|
export namespace ConnectionState {
|
|
4259
4243
|
export interface Connected extends globalThis.EnumItem {
|
|
@@ -18036,6 +18020,27 @@ declare namespace Enum {
|
|
|
18036
18020
|
}
|
|
18037
18021
|
export type VRSafetyBubbleMode = VRSafetyBubbleMode.NoOne | VRSafetyBubbleMode.OnlyFriends | VRSafetyBubbleMode.Anyone;
|
|
18038
18022
|
|
|
18023
|
+
export namespace VRScaling {
|
|
18024
|
+
export interface World extends globalThis.EnumItem {
|
|
18025
|
+
Name: "World";
|
|
18026
|
+
Value: 0;
|
|
18027
|
+
EnumType: typeof globalThis.Enum.VRScaling;
|
|
18028
|
+
}
|
|
18029
|
+
|
|
18030
|
+
export const World: World;
|
|
18031
|
+
|
|
18032
|
+
export interface Off extends globalThis.EnumItem {
|
|
18033
|
+
Name: "Off";
|
|
18034
|
+
Value: 1;
|
|
18035
|
+
EnumType: typeof globalThis.Enum.VRScaling;
|
|
18036
|
+
}
|
|
18037
|
+
|
|
18038
|
+
export const Off: Off;
|
|
18039
|
+
|
|
18040
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.VRScaling>;
|
|
18041
|
+
}
|
|
18042
|
+
export type VRScaling = VRScaling.World | VRScaling.Off;
|
|
18043
|
+
|
|
18039
18044
|
export namespace VRSessionState {
|
|
18040
18045
|
export interface Idle extends globalThis.EnumItem {
|
|
18041
18046
|
Name: "Idle";
|