@rbxts/types 1.0.677 → 1.0.678
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 +435 -430
- package/include/generated/PluginSecurity.d.ts +70 -62
- package/include/generated/enums.d.ts +162 -93
- package/package.json +1 -1
|
@@ -199,6 +199,7 @@ interface CreatableInstances {
|
|
|
199
199
|
ControllerManager: ControllerManager;
|
|
200
200
|
ControllerPartSensor: ControllerPartSensor;
|
|
201
201
|
CornerWedgePart: CornerWedgePart;
|
|
202
|
+
CSGOptions: CSGOptions;
|
|
202
203
|
CurveAnimation: CurveAnimation;
|
|
203
204
|
CylinderHandleAdornment: CylinderHandleAdornment;
|
|
204
205
|
CylinderMesh: CylinderMesh;
|
|
@@ -428,12 +429,14 @@ interface AbstractInstances {
|
|
|
428
429
|
|
|
429
430
|
interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
430
431
|
AnimationClip: AnimationClip;
|
|
432
|
+
AnimationImportData: AnimationImportData;
|
|
431
433
|
AnimationStreamTrack: AnimationStreamTrack;
|
|
432
434
|
AnimationTrack: AnimationTrack;
|
|
433
435
|
AssetImportSession: AssetImportSession;
|
|
434
436
|
AssetPatchSettings: AssetPatchSettings;
|
|
435
437
|
AssetSoundEffect: AssetSoundEffect;
|
|
436
438
|
AudioPages: AudioPages;
|
|
439
|
+
BaseImportData: BaseImportData;
|
|
437
440
|
BaseWrap: BaseWrap;
|
|
438
441
|
BubbleChatConfiguration: BubbleChatConfiguration;
|
|
439
442
|
CatalogPages: CatalogPages;
|
|
@@ -460,26 +463,23 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
460
463
|
DebuggerVariable: DebuggerVariable;
|
|
461
464
|
EmotesPages: EmotesPages;
|
|
462
465
|
FacialAnimationStreamingServiceStats: FacialAnimationStreamingServiceStats;
|
|
466
|
+
FacsImportData: FacsImportData;
|
|
463
467
|
FriendPages: FriendPages;
|
|
464
468
|
GlobalDataStore: GlobalDataStore;
|
|
469
|
+
GroupImportData: GroupImportData;
|
|
465
470
|
ImageDataExperimental: ImageDataExperimental;
|
|
466
|
-
ImporterAnimationSettings: ImporterAnimationSettings;
|
|
467
|
-
ImporterBaseSettings: ImporterBaseSettings;
|
|
468
|
-
ImporterFacsSettings: ImporterFacsSettings;
|
|
469
|
-
ImporterGroupSettings: ImporterGroupSettings;
|
|
470
|
-
ImporterJointSettings: ImporterJointSettings;
|
|
471
|
-
ImporterMaterialSettings: ImporterMaterialSettings;
|
|
472
|
-
ImporterMeshSettings: ImporterMeshSettings;
|
|
473
|
-
ImporterRootSettings: ImporterRootSettings;
|
|
474
471
|
InputObject: InputObject;
|
|
475
472
|
InstanceAdornment: InstanceAdornment;
|
|
476
473
|
InventoryPages: InventoryPages;
|
|
474
|
+
JointImportData: JointImportData;
|
|
477
475
|
LocalDebuggerConnection: LocalDebuggerConnection;
|
|
478
476
|
LodDataEntity: LodDataEntity;
|
|
479
477
|
MaterialGenerationSession: MaterialGenerationSession;
|
|
478
|
+
MaterialImportData: MaterialImportData;
|
|
480
479
|
MemoryStoreQueue: MemoryStoreQueue;
|
|
481
480
|
MemoryStoreSortedMap: MemoryStoreSortedMap;
|
|
482
481
|
MeshDataExperimental: MeshDataExperimental;
|
|
482
|
+
MeshImportData: MeshImportData;
|
|
483
483
|
MessageBusConnection: MessageBusConnection;
|
|
484
484
|
MetaBreakpoint: MetaBreakpoint;
|
|
485
485
|
MetaBreakpointContext: MetaBreakpointContext;
|
|
@@ -501,6 +501,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
501
501
|
PlayerScripts: PlayerScripts;
|
|
502
502
|
PluginManagerInterface: PluginManagerInterface;
|
|
503
503
|
PoseBase: PoseBase;
|
|
504
|
+
RootImportData: RootImportData;
|
|
504
505
|
ScreenshotHud: ScreenshotHud;
|
|
505
506
|
ScriptBuilder: ScriptBuilder;
|
|
506
507
|
ScriptDocument: ScriptDocument;
|
|
@@ -527,7 +528,6 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
527
528
|
Tween: Tween;
|
|
528
529
|
UserGameSettings: UserGameSettings;
|
|
529
530
|
UserSettings: UserSettings;
|
|
530
|
-
VoiceSource: VoiceSource;
|
|
531
531
|
}
|
|
532
532
|
|
|
533
533
|
// GENERATED ROBLOX INSTANCE CLASSES
|
|
@@ -643,7 +643,7 @@ interface Instance {
|
|
|
643
643
|
* end
|
|
644
644
|
* end
|
|
645
645
|
*/
|
|
646
|
-
ClearAllChildren(this: Instance):
|
|
646
|
+
ClearAllChildren(this: Instance): null;
|
|
647
647
|
/**
|
|
648
648
|
* **Clone** creates a copy of an object and all of its descendants, ignoring all objects that are not [Archivable](https://developer.roblox.com/en-us/api-reference/property/Instance/Archivable). The copy of the root object is returned by this function and its [Parent](https://developer.roblox.com/en-us/api-reference/property/Instance/Parent) is set to nil.
|
|
649
649
|
*
|
|
@@ -676,7 +676,7 @@ interface Instance {
|
|
|
676
676
|
*
|
|
677
677
|
* To Destroy an object after a set amount of time, use [Debris:AddItem](https://developer.roblox.com/en-us/api-reference/function/Debris/AddItem).
|
|
678
678
|
*/
|
|
679
|
-
Destroy(this: Instance):
|
|
679
|
+
Destroy(this: Instance): null;
|
|
680
680
|
/**
|
|
681
681
|
* Returns the first ancestor of the [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance) whose [Instance.Name](https://developer.roblox.com/en-us/api-reference/property/Instance/Name) is equal to the given name.
|
|
682
682
|
*
|
|
@@ -1329,7 +1329,7 @@ interface AnalyticsService extends Instance {
|
|
|
1329
1329
|
* Tags: Deprecated
|
|
1330
1330
|
* @deprecated
|
|
1331
1331
|
*/
|
|
1332
|
-
FireEvent(this: AnalyticsService, category: string, value: unknown):
|
|
1332
|
+
FireEvent(this: AnalyticsService, category: string, value: unknown): null;
|
|
1333
1333
|
/**
|
|
1334
1334
|
* This function triggers an event used to track player actions pertaining to the in-game economy.
|
|
1335
1335
|
*
|
|
@@ -1616,7 +1616,7 @@ interface KeyframeSequence extends AnimationClip {
|
|
|
1616
1616
|
*
|
|
1617
1617
|
* Note, this function will not error when an instance other than a [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) is given as the keyframe parameter and will parent it successfully.
|
|
1618
1618
|
*/
|
|
1619
|
-
AddKeyframe(this: KeyframeSequence, keyframe: Keyframe):
|
|
1619
|
+
AddKeyframe(this: KeyframeSequence, keyframe: Keyframe): null;
|
|
1620
1620
|
/**
|
|
1621
1621
|
* **GetKeyframes** returns an array that contains all [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe)s that have been added to a [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence).
|
|
1622
1622
|
*/
|
|
@@ -1628,7 +1628,7 @@ interface KeyframeSequence extends AnimationClip {
|
|
|
1628
1628
|
*
|
|
1629
1629
|
* Note, this function will not error when an [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance) other than a [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) is given as the keyframe parameter.
|
|
1630
1630
|
*/
|
|
1631
|
-
RemoveKeyframe(this: KeyframeSequence, keyframe: Keyframe):
|
|
1631
|
+
RemoveKeyframe(this: KeyframeSequence, keyframe: Keyframe): null;
|
|
1632
1632
|
}
|
|
1633
1633
|
|
|
1634
1634
|
interface AnimationClipProvider extends Instance {
|
|
@@ -1915,7 +1915,7 @@ interface AnimationTrack extends Instance {
|
|
|
1915
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
1916
|
* Tags: CustomLuaState
|
|
1917
1917
|
*/
|
|
1918
|
-
AdjustSpeed(this: AnimationTrack, speed?: number):
|
|
1918
|
+
AdjustSpeed(this: AnimationTrack, speed?: number): null;
|
|
1919
1919
|
/**
|
|
1920
1920
|
* Changes the weight of an animation, with the optional fadeTime parameter determining how long it takes for [AnimationTrack.WeightCurrent](https://developer.roblox.com/en-us/api-reference/property/AnimationTrack/WeightCurrent) to reach [AnimationTrack.WeightTarget](https://developer.roblox.com/en-us/api-reference/property/AnimationTrack/WeightTarget).
|
|
1921
1921
|
*
|
|
@@ -1930,7 +1930,7 @@ interface AnimationTrack extends Instance {
|
|
|
1930
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
1931
|
* Tags: CustomLuaState
|
|
1932
1932
|
*/
|
|
1933
|
-
AdjustWeight(this: AnimationTrack, weight?: number, fadeTime?: number):
|
|
1933
|
+
AdjustWeight(this: AnimationTrack, weight?: number, fadeTime?: number): null;
|
|
1934
1934
|
/**
|
|
1935
1935
|
* This function returns an [event](https://developer.roblox.com/en-us/api-reference/datatype/RBXScriptSignal) similar to the [AnimationTrack.KeyframeReached](https://developer.roblox.com/en-us/api-reference/event/AnimationTrack/KeyframeReached) event, except it only fires when a specified [KeyframeMarker](https://developer.roblox.com/en-us/api-reference/class/KeyframeMarker) has been hit in an [animation](https://developer.roblox.com/en-us/api-reference/class/Animation). The difference allows for greater control of when the event will fire.
|
|
1936
1936
|
*
|
|
@@ -1971,7 +1971,7 @@ interface AnimationTrack extends Instance {
|
|
|
1971
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
1972
|
* Tags: CustomLuaState
|
|
1973
1973
|
*/
|
|
1974
|
-
Play(this: AnimationTrack, fadeTime?: number, weight?: number, speed?: number):
|
|
1974
|
+
Play(this: AnimationTrack, fadeTime?: number, weight?: number, speed?: number): null;
|
|
1975
1975
|
/**
|
|
1976
1976
|
* Stops the [AnimationTrack](https://developer.roblox.com/en-us/api-reference/class/AnimationTrack). Once called playback of the [AnimationTrack](https://developer.roblox.com/en-us/api-reference/class/AnimationTrack) will stop and the weight of the animation will move towards zero over a length of time specified by the optional fadeTime parameter.
|
|
1977
1977
|
*
|
|
@@ -1980,7 +1980,7 @@ interface AnimationTrack extends Instance {
|
|
|
1980
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
1981
|
* Tags: CustomLuaState
|
|
1982
1982
|
*/
|
|
1983
|
-
Stop(this: AnimationTrack, fadeTime?: number):
|
|
1983
|
+
Stop(this: AnimationTrack, fadeTime?: number): null;
|
|
1984
1984
|
/**
|
|
1985
1985
|
* This event fires whenever a looped [AnimationTrack](https://developer.roblox.com/en-us/api-reference/class/AnimationTrack) completes a loop, on the next update.
|
|
1986
1986
|
*
|
|
@@ -2298,7 +2298,7 @@ interface AssetService extends Instance {
|
|
|
2298
2298
|
* Saves the state of the current place. This will only work for places that have been created with [AssetService:CreatePlaceAsync](https://developer.roblox.com/en-us/api-reference/function/AssetService/CreatePlaceAsync) or [AssetService:CreatePlaceInPlayerInventoryAsync](https://developer.roblox.com/en-us/api-reference/function/AssetService/CreatePlaceInPlayerInventoryAsync).
|
|
2299
2299
|
* Tags: Yields
|
|
2300
2300
|
*/
|
|
2301
|
-
SavePlaceAsync(this: AssetService):
|
|
2301
|
+
SavePlaceAsync(this: AssetService): null;
|
|
2302
2302
|
/**
|
|
2303
2303
|
* Tags: Yields
|
|
2304
2304
|
*/
|
|
@@ -2509,13 +2509,13 @@ interface Attachment extends Instance {
|
|
|
2509
2509
|
* Tags: Deprecated, [object Object]
|
|
2510
2510
|
* @deprecated
|
|
2511
2511
|
*/
|
|
2512
|
-
SetAxis(this: Attachment, axis: Vector3):
|
|
2512
|
+
SetAxis(this: Attachment, axis: Vector3): null;
|
|
2513
2513
|
/**
|
|
2514
2514
|
* Sets the value of the Attachment's [Attachment.SecondaryAxis](https://developer.roblox.com/en-us/api-reference/property/Attachment/SecondaryAxis).
|
|
2515
2515
|
* Tags: Deprecated, [object Object]
|
|
2516
2516
|
* @deprecated
|
|
2517
2517
|
*/
|
|
2518
|
-
SetSecondaryAxis(this: Attachment, axis: Vector3):
|
|
2518
|
+
SetSecondaryAxis(this: Attachment, axis: Vector3): null;
|
|
2519
2519
|
}
|
|
2520
2520
|
|
|
2521
2521
|
interface Bone extends Attachment {
|
|
@@ -2606,31 +2606,31 @@ interface AvatarEditorService extends Instance {
|
|
|
2606
2606
|
/**
|
|
2607
2607
|
* Prompts the [Players.LocalPlayer](https://developer.roblox.com/en-us/api-reference/property/Players/LocalPlayer) to allow the developer to read what items the user has in their inventory and other avatar editor related information. The prompt needs to be confirmed by the user for the developer to use [AvatarEditorService:GetInventory](https://developer.roblox.com/en-us/api-reference/function/AvatarEditorService/GetInventory), [AvatarEditorService:GetOutfits](https://developer.roblox.com/en-us/api-reference/function/AvatarEditorService/GetOutfits) and [AvatarEditorService:GetFavorite](https://developer.roblox.com/en-us/api-reference/function/AvatarEditorService/GetFavorite). Permission does not persist between sessions.
|
|
2608
2608
|
*/
|
|
2609
|
-
PromptAllowInventoryReadAccess(this: AvatarEditorService):
|
|
2609
|
+
PromptAllowInventoryReadAccess(this: AvatarEditorService): null;
|
|
2610
2610
|
/**
|
|
2611
2611
|
* Prompts the [Players.LocalPlayer](https://developer.roblox.com/en-us/api-reference/property/Players/LocalPlayer) to save the given [HumanoidDescription](https://developer.roblox.com/en-us/api-reference/class/HumanoidDescription) as an outfit. Does not yield. The result can be retrieved by listening to the [AvatarEditorService.PromptCreateOutfitCompleted](https://developer.roblox.com/en-us/api-reference/event/AvatarEditorService/PromptCreateOutfitCompleted) event.
|
|
2612
2612
|
*/
|
|
2613
|
-
PromptCreateOutfit(this: AvatarEditorService, outfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>):
|
|
2613
|
+
PromptCreateOutfit(this: AvatarEditorService, outfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): null;
|
|
2614
2614
|
/**
|
|
2615
2615
|
* Prompts the [Players.LocalPlayer](https://developer.roblox.com/en-us/api-reference/property/Players/LocalPlayer) to delete the given outfit. Does not yield. The result can be retrieved by listening to the [AvatarEditorService.PromptDeleteOutfitCompleted](https://developer.roblox.com/en-us/api-reference/event/AvatarEditorService/PromptDeleteOutfitCompleted) event.
|
|
2616
2616
|
*/
|
|
2617
|
-
PromptDeleteOutfit(this: AvatarEditorService, outfitId: number):
|
|
2617
|
+
PromptDeleteOutfit(this: AvatarEditorService, outfitId: number): null;
|
|
2618
2618
|
/**
|
|
2619
2619
|
* Prompts the [Players.LocalPlayer](https://developer.roblox.com/en-us/api-reference/property/Players/LocalPlayer) to delete the given outfit. Does not yield. The result can be retrieved by listening to the [AvatarEditorService.PromptRenameOutfitCompleted](https://developer.roblox.com/en-us/api-reference/event/AvatarEditorService/PromptRenameOutfitCompleted) event.
|
|
2620
2620
|
*/
|
|
2621
|
-
PromptRenameOutfit(this: AvatarEditorService, outfitId: number):
|
|
2621
|
+
PromptRenameOutfit(this: AvatarEditorService, outfitId: number): null;
|
|
2622
2622
|
/**
|
|
2623
2623
|
* 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.
|
|
2624
2624
|
*/
|
|
2625
|
-
PromptSaveAvatar(this: AvatarEditorService, humanoidDescription: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>):
|
|
2625
|
+
PromptSaveAvatar(this: AvatarEditorService, humanoidDescription: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): null;
|
|
2626
2626
|
/**
|
|
2627
2627
|
* This function prompts the [Players.LocalPlayer](https://developer.roblox.com/en-us/api-reference/property/Players/LocalPlayer) to favorite or unfavorite the given asset or bundle.
|
|
2628
2628
|
*/
|
|
2629
|
-
PromptSetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>, shouldFavorite: boolean):
|
|
2629
|
+
PromptSetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>, shouldFavorite: boolean): null;
|
|
2630
2630
|
/**
|
|
2631
2631
|
* Prompts the [Players.LocalPlayer](https://developer.roblox.com/en-us/api-reference/property/Players/LocalPlayer) to update the given outfit with the given HumanoidDescription.
|
|
2632
2632
|
*/
|
|
2633
|
-
PromptUpdateOutfit(this: AvatarEditorService, outfitId: number, updatedOutfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>):
|
|
2633
|
+
PromptUpdateOutfit(this: AvatarEditorService, outfitId: number, updatedOutfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): null;
|
|
2634
2634
|
/**
|
|
2635
2635
|
* Returns a new [HumanoidDescription](https://developer.roblox.com/en-us/api-reference/class/HumanoidDescription) with the Shirt and Pants properties updated if necessary. Returns nil if default clothing was not needed.
|
|
2636
2636
|
*
|
|
@@ -3134,6 +3134,185 @@ interface BadgeService extends Instance {
|
|
|
3134
3134
|
UserHasBadgeAsync(this: BadgeService, userId: number, badgeId: number): boolean;
|
|
3135
3135
|
}
|
|
3136
3136
|
|
|
3137
|
+
interface BaseImportData extends Instance {
|
|
3138
|
+
/**
|
|
3139
|
+
* **DO NOT USE!**
|
|
3140
|
+
*
|
|
3141
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3142
|
+
* @hidden
|
|
3143
|
+
* @deprecated
|
|
3144
|
+
*/
|
|
3145
|
+
readonly _nominal_BaseImportData: unique symbol;
|
|
3146
|
+
/**
|
|
3147
|
+
* Tags: ReadOnly, NotReplicated
|
|
3148
|
+
*/
|
|
3149
|
+
readonly Id: string;
|
|
3150
|
+
ImportName: string;
|
|
3151
|
+
ShouldImport: boolean;
|
|
3152
|
+
}
|
|
3153
|
+
|
|
3154
|
+
interface AnimationImportData extends BaseImportData {
|
|
3155
|
+
/**
|
|
3156
|
+
* **DO NOT USE!**
|
|
3157
|
+
*
|
|
3158
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3159
|
+
* @hidden
|
|
3160
|
+
* @deprecated
|
|
3161
|
+
*/
|
|
3162
|
+
readonly _nominal_AnimationImportData: unique symbol;
|
|
3163
|
+
}
|
|
3164
|
+
|
|
3165
|
+
interface FacsImportData extends BaseImportData {
|
|
3166
|
+
/**
|
|
3167
|
+
* **DO NOT USE!**
|
|
3168
|
+
*
|
|
3169
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3170
|
+
* @hidden
|
|
3171
|
+
* @deprecated
|
|
3172
|
+
*/
|
|
3173
|
+
readonly _nominal_FacsImportData: unique symbol;
|
|
3174
|
+
}
|
|
3175
|
+
|
|
3176
|
+
interface GroupImportData extends BaseImportData {
|
|
3177
|
+
/**
|
|
3178
|
+
* **DO NOT USE!**
|
|
3179
|
+
*
|
|
3180
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3181
|
+
* @hidden
|
|
3182
|
+
* @deprecated
|
|
3183
|
+
*/
|
|
3184
|
+
readonly _nominal_GroupImportData: unique symbol;
|
|
3185
|
+
Anchored: boolean;
|
|
3186
|
+
ImportAsModelAsset: boolean;
|
|
3187
|
+
InsertInWorkspace: boolean;
|
|
3188
|
+
}
|
|
3189
|
+
|
|
3190
|
+
interface JointImportData extends BaseImportData {
|
|
3191
|
+
/**
|
|
3192
|
+
* **DO NOT USE!**
|
|
3193
|
+
*
|
|
3194
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3195
|
+
* @hidden
|
|
3196
|
+
* @deprecated
|
|
3197
|
+
*/
|
|
3198
|
+
readonly _nominal_JointImportData: unique symbol;
|
|
3199
|
+
}
|
|
3200
|
+
|
|
3201
|
+
interface MaterialImportData extends BaseImportData {
|
|
3202
|
+
/**
|
|
3203
|
+
* **DO NOT USE!**
|
|
3204
|
+
*
|
|
3205
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3206
|
+
* @hidden
|
|
3207
|
+
* @deprecated
|
|
3208
|
+
*/
|
|
3209
|
+
readonly _nominal_MaterialImportData: unique symbol;
|
|
3210
|
+
DiffuseFilePath: string;
|
|
3211
|
+
/**
|
|
3212
|
+
* Tags: ReadOnly, NotReplicated
|
|
3213
|
+
*/
|
|
3214
|
+
readonly IsPbr: boolean;
|
|
3215
|
+
MetalnessFilePath: string;
|
|
3216
|
+
NormalFilePath: string;
|
|
3217
|
+
RoughnessFilePath: string;
|
|
3218
|
+
}
|
|
3219
|
+
|
|
3220
|
+
interface MeshImportData extends BaseImportData {
|
|
3221
|
+
/**
|
|
3222
|
+
* **DO NOT USE!**
|
|
3223
|
+
*
|
|
3224
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3225
|
+
* @hidden
|
|
3226
|
+
* @deprecated
|
|
3227
|
+
*/
|
|
3228
|
+
readonly _nominal_MeshImportData: unique symbol;
|
|
3229
|
+
Anchored: boolean;
|
|
3230
|
+
/**
|
|
3231
|
+
* Tags: ReadOnly, NotReplicated
|
|
3232
|
+
*/
|
|
3233
|
+
readonly CageManifold: boolean;
|
|
3234
|
+
CageMeshIntersectedPreview: boolean;
|
|
3235
|
+
/**
|
|
3236
|
+
* Tags: ReadOnly, NotReplicated
|
|
3237
|
+
*/
|
|
3238
|
+
readonly CageMeshNotIntersected: boolean;
|
|
3239
|
+
/**
|
|
3240
|
+
* Tags: ReadOnly, NotReplicated
|
|
3241
|
+
*/
|
|
3242
|
+
readonly CageNoOverlappingVertices: boolean;
|
|
3243
|
+
CageNonManifoldPreview: boolean;
|
|
3244
|
+
CageOverlappingVerticesPreview: boolean;
|
|
3245
|
+
/**
|
|
3246
|
+
* Tags: ReadOnly, NotReplicated
|
|
3247
|
+
*/
|
|
3248
|
+
readonly CageUVMatched: boolean;
|
|
3249
|
+
CageUVMisMatchedPreview: boolean;
|
|
3250
|
+
/**
|
|
3251
|
+
* Tags: ReadOnly, NotReplicated
|
|
3252
|
+
*/
|
|
3253
|
+
readonly Dimensions: Vector3;
|
|
3254
|
+
DoubleSided: boolean;
|
|
3255
|
+
IgnoreVertexColors: boolean;
|
|
3256
|
+
IrrelevantCageModifiedPreview: boolean;
|
|
3257
|
+
MeshHoleDetectedPreview: boolean;
|
|
3258
|
+
/**
|
|
3259
|
+
* Tags: ReadOnly, NotReplicated
|
|
3260
|
+
*/
|
|
3261
|
+
readonly MeshNoHoleDetected: boolean;
|
|
3262
|
+
/**
|
|
3263
|
+
* Tags: ReadOnly, NotReplicated
|
|
3264
|
+
*/
|
|
3265
|
+
readonly NoIrrelevantCageModified: boolean;
|
|
3266
|
+
/**
|
|
3267
|
+
* Tags: ReadOnly, NotReplicated
|
|
3268
|
+
*/
|
|
3269
|
+
readonly NoOuterCageFarExtendedFromMesh: boolean;
|
|
3270
|
+
OuterCageFarExtendedFromMeshPreview: boolean;
|
|
3271
|
+
/**
|
|
3272
|
+
* Tags: ReadOnly, NotReplicated
|
|
3273
|
+
*/
|
|
3274
|
+
readonly PolygonCount: number;
|
|
3275
|
+
UseImportedPivot: boolean;
|
|
3276
|
+
}
|
|
3277
|
+
|
|
3278
|
+
interface RootImportData extends BaseImportData {
|
|
3279
|
+
/**
|
|
3280
|
+
* **DO NOT USE!**
|
|
3281
|
+
*
|
|
3282
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3283
|
+
* @hidden
|
|
3284
|
+
* @deprecated
|
|
3285
|
+
*/
|
|
3286
|
+
readonly _nominal_RootImportData: unique symbol;
|
|
3287
|
+
AddModelToInventory: boolean;
|
|
3288
|
+
Anchored: boolean;
|
|
3289
|
+
AnimationIdForRestPose: number;
|
|
3290
|
+
ExistingPackageId: string;
|
|
3291
|
+
/**
|
|
3292
|
+
* Tags: ReadOnly, NotReplicated
|
|
3293
|
+
*/
|
|
3294
|
+
readonly FileDimensions: Vector3;
|
|
3295
|
+
ImportAsModelAsset: boolean;
|
|
3296
|
+
ImportAsPackage: boolean;
|
|
3297
|
+
InsertInWorkspace: boolean;
|
|
3298
|
+
InsertWithScenePosition: boolean;
|
|
3299
|
+
InvertNegativeFaces: boolean;
|
|
3300
|
+
MergeMeshes: boolean;
|
|
3301
|
+
/**
|
|
3302
|
+
* Tags: ReadOnly, NotReplicated
|
|
3303
|
+
*/
|
|
3304
|
+
readonly PolygonCount: number;
|
|
3305
|
+
RestPose: Enum.RestPose;
|
|
3306
|
+
RigScale: Enum.RigScale;
|
|
3307
|
+
RigType: Enum.RigType;
|
|
3308
|
+
ScaleUnit: Enum.MeshScaleUnit;
|
|
3309
|
+
UseSceneOriginAsCFrame: boolean;
|
|
3310
|
+
UseSceneOriginAsPivot: boolean;
|
|
3311
|
+
UsesCages: boolean;
|
|
3312
|
+
WorldForward: Enum.NormalId;
|
|
3313
|
+
WorldUp: Enum.NormalId;
|
|
3314
|
+
}
|
|
3315
|
+
|
|
3137
3316
|
/** The BasePlayerGui is an abstract class that all GUI drawing storage classes inherit from. */
|
|
3138
3317
|
interface BasePlayerGui extends Instance {
|
|
3139
3318
|
/**
|
|
@@ -3210,7 +3389,7 @@ interface PlayerGui extends BasePlayerGui {
|
|
|
3210
3389
|
* Tags: Deprecated
|
|
3211
3390
|
* @deprecated
|
|
3212
3391
|
*/
|
|
3213
|
-
SetTopbarTransparency(this: PlayerGui, transparency: number):
|
|
3392
|
+
SetTopbarTransparency(this: PlayerGui, transparency: number): null;
|
|
3214
3393
|
/**
|
|
3215
3394
|
* Fires when the transparency of the Topbar CoreGui changes.
|
|
3216
3395
|
* Tags: Deprecated
|
|
@@ -3925,7 +4104,7 @@ interface StarterGui extends BasePlayerGui {
|
|
|
3925
4104
|
*
|
|
3926
4105
|
* For more information on how to use this function, see the article on [disabling the game interface](https://developer.roblox.com/en-us/articles/disabling-parts-of-game-interface).
|
|
3927
4106
|
*/
|
|
3928
|
-
SetCoreGuiEnabled(this: StarterGui, coreGuiType: CastsToEnum<Enum.CoreGuiType>, enabled: boolean):
|
|
4107
|
+
SetCoreGuiEnabled(this: StarterGui, coreGuiType: CastsToEnum<Enum.CoreGuiType>, enabled: boolean): null;
|
|
3929
4108
|
/**
|
|
3930
4109
|
* GetCore returns data set or made available by Roblox's [CoreScripts](https://developer.roblox.com/en-us/api-reference/class/CoreScript). The first and only parameter is a string that selects the information to be fetched. The following sections describe the strings and the data they return by this function.
|
|
3931
4110
|
*
|
|
@@ -4506,7 +4685,7 @@ interface Beam extends Instance {
|
|
|
4506
4685
|
* * If the [Beam.Texture](https://developer.roblox.com/en-us/api-reference/property/Beam/Texture) property is not set, this function will do nothing
|
|
4507
4686
|
* * Increasing the offset will act in the inverse direction to the [Beam.TextureSpeed](https://developer.roblox.com/en-us/api-reference/property/Beam/TextureSpeed) property. Meaning, it will move the texture in the opposite direction to the direction the texture animates when [Beam.TextureSpeed](https://developer.roblox.com/en-us/api-reference/property/Beam/TextureSpeed) is more than 0
|
|
4508
4687
|
*/
|
|
4509
|
-
SetTextureOffset(this: Beam, offset?: number):
|
|
4688
|
+
SetTextureOffset(this: Beam, offset?: number): null;
|
|
4510
4689
|
}
|
|
4511
4690
|
|
|
4512
4691
|
/** An object that allows events defined in one server-side [Script](https://developer.roblox.com/en-us/api-reference/class/Script) to be subscribed to by another script for one-way communication.
|
|
@@ -5214,11 +5393,11 @@ interface RocketPropulsion extends BodyMover {
|
|
|
5214
5393
|
/**
|
|
5215
5394
|
* Causes the Rocket to stop moving towards its target, making it fall.
|
|
5216
5395
|
*/
|
|
5217
|
-
Abort(this: RocketPropulsion):
|
|
5396
|
+
Abort(this: RocketPropulsion): null;
|
|
5218
5397
|
/**
|
|
5219
5398
|
* Causes the rocket to fly towards Target.
|
|
5220
5399
|
*/
|
|
5221
|
-
Fire(this: RocketPropulsion):
|
|
5400
|
+
Fire(this: RocketPropulsion): null;
|
|
5222
5401
|
/**
|
|
5223
5402
|
* Fired when the Rocket comes within TargetRadius of the Target. This is used to make the rocket work, such as make an explosion when it flies near the Target.
|
|
5224
5403
|
*/
|
|
@@ -5247,6 +5426,17 @@ interface BulkImportService extends Instance {
|
|
|
5247
5426
|
readonly _nominal_BulkImportService: unique symbol;
|
|
5248
5427
|
}
|
|
5249
5428
|
|
|
5429
|
+
interface CSGOptions extends Instance {
|
|
5430
|
+
/**
|
|
5431
|
+
* **DO NOT USE!**
|
|
5432
|
+
*
|
|
5433
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
5434
|
+
* @hidden
|
|
5435
|
+
* @deprecated
|
|
5436
|
+
*/
|
|
5437
|
+
readonly _nominal_CSGOptions: unique symbol;
|
|
5438
|
+
}
|
|
5439
|
+
|
|
5250
5440
|
interface CalloutService extends Instance {
|
|
5251
5441
|
/**
|
|
5252
5442
|
* **DO NOT USE!**
|
|
@@ -5667,7 +5857,7 @@ interface Camera extends Instance {
|
|
|
5667
5857
|
* Tags: Deprecated
|
|
5668
5858
|
* @deprecated
|
|
5669
5859
|
*/
|
|
5670
|
-
Interpolate(this: Camera, endPos: CFrame, endFocus: CFrame, duration: number):
|
|
5860
|
+
Interpolate(this: Camera, endPos: CFrame, endFocus: CFrame, duration: number): null;
|
|
5671
5861
|
/**
|
|
5672
5862
|
* This function pans the [Camera](https://developer.roblox.com/en-us/api-reference/class/Camera) around the [Camera.Focus](https://developer.roblox.com/en-us/api-reference/property/Camera/Focus) in 45 degree increments around the Y axis.
|
|
5673
5863
|
*
|
|
@@ -5682,7 +5872,7 @@ interface Camera extends Instance {
|
|
|
5682
5872
|
* Tags: Deprecated
|
|
5683
5873
|
* @deprecated
|
|
5684
5874
|
*/
|
|
5685
|
-
PanUnits(this: Camera, units: number):
|
|
5875
|
+
PanUnits(this: Camera, units: number): null;
|
|
5686
5876
|
/**
|
|
5687
5877
|
* This function creates a unit [Ray](https://developer.roblox.com/en-us/api-reference/datatype/Ray) from a 2D position on the screen (defined in pixels). This position accounts for the GUI inset. The [Ray](https://developer.roblox.com/en-us/api-reference/datatype/Ray) originates from the [Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3) equivalent of the 2D position in the world at the given depth (in studs) away from the [Camera](https://developer.roblox.com/en-us/api-reference/class/Camera).
|
|
5688
5878
|
*
|
|
@@ -5703,7 +5893,7 @@ interface Camera extends Instance {
|
|
|
5703
5893
|
*
|
|
5704
5894
|
* SetCameraPan mode has no effect on PC / Mac users.
|
|
5705
5895
|
*/
|
|
5706
|
-
SetCameraPanMode(this: Camera, mode?: CastsToEnum<Enum.CameraPanMode>):
|
|
5896
|
+
SetCameraPanMode(this: Camera, mode?: CastsToEnum<Enum.CameraPanMode>): null;
|
|
5707
5897
|
/**
|
|
5708
5898
|
* This function is outdated and no longer considered best practice.
|
|
5709
5899
|
*
|
|
@@ -5727,7 +5917,7 @@ interface Camera extends Instance {
|
|
|
5727
5917
|
* local rollCFrame = CFrame.Angles(0, 0, roll)
|
|
5728
5918
|
* workspace.CurrentCamera.CFrame = currentCFrame \* rollCFrame
|
|
5729
5919
|
*/
|
|
5730
|
-
SetRoll(this: Camera, rollAngle: number):
|
|
5920
|
+
SetRoll(this: Camera, rollAngle: number): null;
|
|
5731
5921
|
/**
|
|
5732
5922
|
* This function 'tilts' the [Camera](https://developer.roblox.com/en-us/api-reference/class/Camera) by rotating it around the [Camera.Focus](https://developer.roblox.com/en-us/api-reference/property/Camera/Focus) around the [Camera's](https://developer.roblox.com/en-us/api-reference/class/Camera) X axis by a given multiple of 10 degrees.
|
|
5733
5923
|
*
|
|
@@ -5807,7 +5997,7 @@ interface Camera extends Instance {
|
|
|
5807
5997
|
* Note this function does not perform any raycasting, meaning the visible bool will be true regardless if the _worldPoint_ is obscured by [BaseParts](https://developer.roblox.com/en-us/api-reference/class/BasePart) or [Terrain](https://developer.roblox.com/en-us/api-reference/class/Terrain).
|
|
5808
5998
|
*/
|
|
5809
5999
|
WorldToViewportPoint(this: Camera, worldPoint: Vector3): LuaTuple<[Vector3, boolean]>;
|
|
5810
|
-
ZoomToExtents(this: Camera, boundingBoxCFrame: CFrame, boundingBoxSize: Vector3):
|
|
6000
|
+
ZoomToExtents(this: Camera, boundingBoxCFrame: CFrame, boundingBoxSize: Vector3): null;
|
|
5811
6001
|
/**
|
|
5812
6002
|
* This event fires when the [Camera](https://developer.roblox.com/en-us/api-reference/class/Camera) has finished interpolating using the [Camera:Interpolate](https://developer.roblox.com/en-us/api-reference/function/Camera/Interpolate) function.
|
|
5813
6003
|
*
|
|
@@ -6120,7 +6310,7 @@ interface Chat extends Instance {
|
|
|
6120
6310
|
*
|
|
6121
6311
|
* _Note:_ Since dialogs are controlled by a LocalScript, you will not be able to see any dialogs created from this method unless you are running in _Play Solo_ mode.
|
|
6122
6312
|
*/
|
|
6123
|
-
Chat(this: Chat, partOrCharacter: BasePart | Model, message: string, color?: CastsToEnum<Enum.ChatColor>):
|
|
6313
|
+
Chat(this: Chat, partOrCharacter: BasePart | Model, message: string, color?: CastsToEnum<Enum.ChatColor>): null;
|
|
6124
6314
|
/**
|
|
6125
6315
|
* InvokeChatCallback will call a function registered by [RegisterChatCallback](https://developer.roblox.com/en-us/api-reference/function/Chat/RegisterChatCallback), given the ChatCallbackType enum and the arguments to send the function. It will return the result of the registered function, or raise an error if no function has been registered.
|
|
6126
6316
|
*
|
|
@@ -6153,7 +6343,7 @@ interface Chat extends Instance {
|
|
|
6153
6343
|
* * Set `message.ShouldDeliver` to false in order to cancel delivery of the message to players (useful for implementing a chat blacklist)
|
|
6154
6344
|
* * Get/set the speaker's name color (`message.ExtraData.NameColor`, a Color3) on a message-by-message basis
|
|
6155
6345
|
*/
|
|
6156
|
-
RegisterChatCallback(this: Chat, callbackType: CastsToEnum<Enum.ChatCallbackType>, callbackFunction: Callback):
|
|
6346
|
+
RegisterChatCallback(this: Chat, callbackType: CastsToEnum<Enum.ChatCallbackType>, callbackFunction: Callback): null;
|
|
6157
6347
|
/**
|
|
6158
6348
|
* **Note**
|
|
6159
6349
|
*
|
|
@@ -6167,7 +6357,7 @@ interface Chat extends Instance {
|
|
|
6167
6357
|
*
|
|
6168
6358
|
* This function is client-side only, attempting to call it on the server will trigger an error.
|
|
6169
6359
|
*/
|
|
6170
|
-
SetBubbleChatSettings(this: Chat, settings: unknown):
|
|
6360
|
+
SetBubbleChatSettings(this: Chat, settings: unknown): null;
|
|
6171
6361
|
/**
|
|
6172
6362
|
* Will return false if the player with the specified [Player.UserId](https://developer.roblox.com/en-us/api-reference/property/Player/UserId) is not allowed to chat because of their account settings.
|
|
6173
6363
|
* Tags: Yields
|
|
@@ -6383,7 +6573,7 @@ interface CollectionService extends Instance {
|
|
|
6383
6573
|
*
|
|
6384
6574
|
* **Warning:** When tagging an object, it is common that some resources are used to give the tag its functionality, e.g. event connections or tables. To prevent memory leaks, it is a good idea to clean these up (disconnect, set to nil, etc) when no longer needed for a tag. Do this when calling [CollectionService:RemoveTag](https://developer.roblox.com/en-us/api-reference/function/CollectionService/RemoveTag), calling [Instance:Destroy](https://developer.roblox.com/en-us/api-reference/function/Instance/Destroy) or in a function connected to a signal returned by [CollectionService:GetInstanceRemovedSignal](https://developer.roblox.com/en-us/api-reference/function/CollectionService/GetInstanceRemovedSignal).
|
|
6385
6575
|
*/
|
|
6386
|
-
AddTag(this: CollectionService, instance: Instance, tag: string):
|
|
6576
|
+
AddTag(this: CollectionService, instance: Instance, tag: string): null;
|
|
6387
6577
|
GetAllTags(this: CollectionService): unknown;
|
|
6388
6578
|
/**
|
|
6389
6579
|
* GetInstanceAdded is given a tag (a string) and returns a signal which fires under two conditions:
|
|
@@ -6440,7 +6630,7 @@ interface CollectionService extends Instance {
|
|
|
6440
6630
|
*
|
|
6441
6631
|
* When removing a tag, it is common that some resources are used to give the tag its functionality, e.g. event connections or tables. To prevent memory leaks, it is a good idea to clean these up (disconnect, set to nil, etc) when no longer needed for a tag.
|
|
6442
6632
|
*/
|
|
6443
|
-
RemoveTag(this: CollectionService, instance: Instance, tag: string):
|
|
6633
|
+
RemoveTag(this: CollectionService, instance: Instance, tag: string): null;
|
|
6444
6634
|
/**
|
|
6445
6635
|
* This function fires when a [Configuration](https://developer.roblox.com/en-us/api-reference/class/Configuration), [CustomEvent](https://developer.roblox.com/en-us/api-reference/class/CustomEvent), [CustomEventReceiver](https://developer.roblox.com/en-us/api-reference/class/CustomEventReceiver), [Dialog](https://developer.roblox.com/en-us/api-reference/class/Dialog), or [VehicleSeat](https://developer.roblox.com/en-us/api-reference/class/VehicleSeat) is added to the [DataModel](https://developer.roblox.com/en-us/api-reference/class/DataModel).
|
|
6446
6636
|
* Tags: Deprecated, [object Object]
|
|
@@ -7895,13 +8085,13 @@ interface ContentProvider extends Instance {
|
|
|
7895
8085
|
* Tags: Deprecated, [object Object]
|
|
7896
8086
|
* @deprecated
|
|
7897
8087
|
*/
|
|
7898
|
-
Preload(this: ContentProvider, contentId: string):
|
|
7899
|
-
RegisterDefaultEncryptionKey(this: ContentProvider, encryptionKey: string):
|
|
7900
|
-
RegisterDefaultSessionKey(this: ContentProvider, sessionKey: string):
|
|
7901
|
-
RegisterEncryptedAsset(this: ContentProvider, assetId: string, encryptionKey: string):
|
|
7902
|
-
RegisterSessionEncryptedAsset(this: ContentProvider, contentId: string, sessionKey: string):
|
|
7903
|
-
UnregisterDefaultEncryptionKey(this: ContentProvider):
|
|
7904
|
-
UnregisterEncryptedAsset(this: ContentProvider, assetId: string):
|
|
8088
|
+
Preload(this: ContentProvider, contentId: string): null;
|
|
8089
|
+
RegisterDefaultEncryptionKey(this: ContentProvider, encryptionKey: string): null;
|
|
8090
|
+
RegisterDefaultSessionKey(this: ContentProvider, sessionKey: string): null;
|
|
8091
|
+
RegisterEncryptedAsset(this: ContentProvider, assetId: string, encryptionKey: string): null;
|
|
8092
|
+
RegisterSessionEncryptedAsset(this: ContentProvider, contentId: string, sessionKey: string): null;
|
|
8093
|
+
UnregisterDefaultEncryptionKey(this: ContentProvider): null;
|
|
8094
|
+
UnregisterEncryptedAsset(this: ContentProvider, assetId: string): null;
|
|
7905
8095
|
/**
|
|
7906
8096
|
* Yields until all of the assets associated with the given [Instances](https://developer.roblox.com/en-us/api-reference/class/Instance) have loaded and takes an array of [Instances](https://developer.roblox.com/en-us/api-reference/class/Instance) as a parameter.
|
|
7907
8097
|
*
|
|
@@ -8053,13 +8243,13 @@ interface ContextActionService extends Instance {
|
|
|
8053
8243
|
* Tags: Deprecated, [object Object]
|
|
8054
8244
|
* @deprecated
|
|
8055
8245
|
*/
|
|
8056
|
-
BindActionToInputTypes(this: ContextActionService, actionName: string, functionToBind: Callback, createTouchButton: boolean, inputTypes: Array<any>):
|
|
8246
|
+
BindActionToInputTypes(this: ContextActionService, actionName: string, functionToBind: Callback, createTouchButton: boolean, inputTypes: Array<any>): null;
|
|
8057
8247
|
/**
|
|
8058
8248
|
* Bind an [KeyCode](https://developer.roblox.com/en-us/api-reference/enum/KeyCode) that can be used with an [UserInputType](https://developer.roblox.com/en-us/api-reference/enum/UserInputType) to activate [ClickDetector](https://developer.roblox.com/en-us/api-reference/class/ClickDetector) events and [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool) objects. When the given key/button is pressed, it fires the [Mouse.Button1Down](https://developer.roblox.com/en-us/api-reference/event/Mouse/Button1Down) event on the mouse sent to [Tool.Equipped](https://developer.roblox.com/en-us/api-reference/event/Tool/Equipped). This in turn fires the [Tool.Activated](https://developer.roblox.com/en-us/api-reference/event/Tool/Activated) event if [Tool.ManualActivationOnly](https://developer.roblox.com/en-us/api-reference/property/Tool/ManualActivationOnly) is not set to true. For gamepad input, this function is called by the default control scripts in order to bind the ButtonR2 [KeyCode](https://developer.roblox.com/en-us/api-reference/enum/KeyCode).
|
|
8059
8249
|
*
|
|
8060
8250
|
* Note that the [UserInputType](https://developer.roblox.com/en-us/api-reference/enum/UserInputType) specified must be `Keyboard` or `Gamepad1` through `Gamepad8` in order to be valid.
|
|
8061
8251
|
*/
|
|
8062
|
-
BindActivate(this: ContextActionService, userInputTypeForActivation: CastsToEnum<Enum.UserInputType>, keyCodesForActivation: Array<any>):
|
|
8252
|
+
BindActivate(this: ContextActionService, userInputTypeForActivation: CastsToEnum<Enum.UserInputType>, keyCodesForActivation: Array<any>): null;
|
|
8063
8253
|
/**
|
|
8064
8254
|
* GetAllBoundActioninfo returns a table which maps all actions' names (those originally passed to [BindAction](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/BindAction)) to a table returned by [GetBoundActionInfo](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/GetBoundActionInfo) when called with the action name itself. Using this function, you can inspect all presently bound actions. This is useful when debugging their priority levels or stack orders.
|
|
8065
8255
|
*/
|
|
@@ -8128,39 +8318,39 @@ interface ContextActionService extends Instance {
|
|
|
8128
8318
|
*
|
|
8129
8319
|
* Although the name may suggest that this method is related to the family of functions that customize a touch button for actions that create them ([SetTitle](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/SetTitle), [SetImage](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/SetImage) and [SetPosition](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/SetPosition)), this method does not affect such a button. This method merely sets a text description of an action, and nothing more.
|
|
8130
8320
|
*/
|
|
8131
|
-
SetDescription(this: ContextActionService, actionName: string, description: string):
|
|
8321
|
+
SetDescription(this: ContextActionService, actionName: string, description: string): null;
|
|
8132
8322
|
/**
|
|
8133
8323
|
* SetPosition will set the text shown on a touch button created by [BindAction](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/BindAction). Specifically, this sets the [ImageLabel.Image](https://developer.roblox.com/en-us/api-reference/property/ImageLabel/Image) property of the [ImageLabel](https://developer.roblox.com/en-us/api-reference/class/ImageLabel) within the [ImageButton](https://developer.roblox.com/en-us/api-reference/class/ImageButton) that would be returned by [GetButton](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/GetButton). If no such bound action exists (e.g. nothing is returned by GetButton), this function does nothing and throws no error.
|
|
8134
8324
|
*
|
|
8135
8325
|
* This function is part of a family of methods that customize the touch button of an action. Others in this family include [SetPosition](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/SetPosition) and [SetTitle](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/SetTitle).
|
|
8136
8326
|
*/
|
|
8137
|
-
SetImage(this: ContextActionService, actionName: string, image: string):
|
|
8327
|
+
SetImage(this: ContextActionService, actionName: string, image: string): null;
|
|
8138
8328
|
/**
|
|
8139
8329
|
* SetPosition will set the text shown on a touch button created by [BindAction](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/BindAction). Specifically, this sets the [GuiObject.Position](https://developer.roblox.com/en-us/api-reference/property/GuiObject/Position) property of the [ImageButton](https://developer.roblox.com/en-us/api-reference/class/ImageButton) that would be returned by [GetButton](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/GetButton). If no such bound action exists (e.g. nothing is returned by GetButton), this function does nothing and throws no error.
|
|
8140
8330
|
*
|
|
8141
8331
|
* This function is part of a family of methods that customize the touch button of an action. Others in this family include [SetImage](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/SetImage) and [SetTitle](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/SetTitle).
|
|
8142
8332
|
*/
|
|
8143
|
-
SetPosition(this: ContextActionService, actionName: string, position: UDim2):
|
|
8333
|
+
SetPosition(this: ContextActionService, actionName: string, position: UDim2): null;
|
|
8144
8334
|
/**
|
|
8145
8335
|
* SetTitle will set the text shown on a touch button created by [BindAction](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/BindAction). Specifically, this sets the [TextLabel.Text](https://developer.roblox.com/en-us/api-reference/property/TextLabel/Text) property of a [TextLabel](https://developer.roblox.com/en-us/api-reference/class/TextLabel) within the [ImageButton](https://developer.roblox.com/en-us/api-reference/class/ImageButton) that would be returned by [GetButton](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/GetButton). If no such bound action exists (e.g. nothing is returned by GetButton), this function does nothing and throws no error.
|
|
8146
8336
|
*
|
|
8147
8337
|
* This function is part of a family of methods that customize the touch button of an action. Others in this family include [SetImage](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/SetImage) and [SetPosition](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/SetPosition).
|
|
8148
8338
|
*/
|
|
8149
|
-
SetTitle(this: ContextActionService, actionName: string, title: string):
|
|
8339
|
+
SetTitle(this: ContextActionService, actionName: string, title: string): null;
|
|
8150
8340
|
/**
|
|
8151
8341
|
* UnbindAction will unbind an action by name from user inputs so that the action handler function will no longer be called. Call this function when the context for some action is no longer applicable, such as closing a user interface, exiting a car or [unequipping](https://developer.roblox.com/en-us/api-reference/event/Tool/Unequipped) a [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool). See [BindAction](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/BindAction) for more information on how bound actions operate.
|
|
8152
8342
|
*
|
|
8153
8343
|
* This function **will not** throw an error if there is no such action bound with the given string. Using [GetAllBoundActionInfo](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/GetAllBoundActionInfo) or the Developer Console's “Action Bindings” tab, you can find out what actions are presently bound.
|
|
8154
8344
|
*/
|
|
8155
|
-
UnbindAction(this: ContextActionService, actionName: string):
|
|
8345
|
+
UnbindAction(this: ContextActionService, actionName: string): null;
|
|
8156
8346
|
/**
|
|
8157
8347
|
* UnbindActivate unbinds an [KeyCode](https://developer.roblox.com/en-us/api-reference/enum/KeyCode) used with an [UserInputType](https://developer.roblox.com/en-us/api-reference/enum/UserInputType) for activating a [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool) (or a [HopperBin](https://developer.roblox.com/en-us/api-reference/class/HopperBin)) using [BindActivate](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/BindActivate). This function essentially undoes the action performed by that function.
|
|
8158
8348
|
*/
|
|
8159
|
-
UnbindActivate(this: ContextActionService, userInputTypeForActivation: CastsToEnum<Enum.UserInputType>, keyCodeForActivation?: CastsToEnum<Enum.KeyCode>):
|
|
8349
|
+
UnbindActivate(this: ContextActionService, userInputTypeForActivation: CastsToEnum<Enum.UserInputType>, keyCodeForActivation?: CastsToEnum<Enum.KeyCode>): null;
|
|
8160
8350
|
/**
|
|
8161
8351
|
* Removes all functions bound. No actionNames will remain. All touch buttons will be removed. If a button was manipulated manually there is no guarantee it will be cleaned up.
|
|
8162
8352
|
*/
|
|
8163
|
-
UnbindAllActions(this: ContextActionService):
|
|
8353
|
+
UnbindAllActions(this: ContextActionService): null;
|
|
8164
8354
|
/**
|
|
8165
8355
|
* GetButton returns the [ImageButton](https://developer.roblox.com/en-us/api-reference/class/ImageButton) created by [BindAction](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/BindAction) if its third parameter was true and the device is [TouchEnabled](https://developer.roblox.com/en-us/api-reference/property/UserInputService/TouchEnabled). The only parameter to this function must match exactly the name of the action originally sent to BindAction.
|
|
8166
8356
|
*
|
|
@@ -8191,7 +8381,7 @@ interface Controller extends Instance {
|
|
|
8191
8381
|
/**
|
|
8192
8382
|
* Activates an overriding bind on the specified button.
|
|
8193
8383
|
*/
|
|
8194
|
-
BindButton(this: Controller, button: CastsToEnum<Enum.Button>, caption: string):
|
|
8384
|
+
BindButton(this: Controller, button: CastsToEnum<Enum.Button>, caption: string): null;
|
|
8195
8385
|
/**
|
|
8196
8386
|
* Returns whether or not Button is being pressed.
|
|
8197
8387
|
*/
|
|
@@ -8199,7 +8389,7 @@ interface Controller extends Instance {
|
|
|
8199
8389
|
/**
|
|
8200
8390
|
* Removes the bind on button.
|
|
8201
8391
|
*/
|
|
8202
|
-
UnbindButton(this: Controller, button: CastsToEnum<Enum.Button>):
|
|
8392
|
+
UnbindButton(this: Controller, button: CastsToEnum<Enum.Button>): null;
|
|
8203
8393
|
/**
|
|
8204
8394
|
* Fired when the pressed state of a bound button is changed. This event can be used in conjunction with [Controller:GetButton](https://developer.roblox.com/en-us/api-reference/function/Controller/GetButton) to see whether a bound button is being pressed down or not.
|
|
8205
8395
|
*/
|
|
@@ -8289,6 +8479,7 @@ interface AirController extends ControllerBase {
|
|
|
8289
8479
|
BalanceMaxTorque: number;
|
|
8290
8480
|
BalanceRigidityEnabled: boolean;
|
|
8291
8481
|
BalanceSpeed: number;
|
|
8482
|
+
LinearImpulse: Vector3;
|
|
8292
8483
|
MaintainAngularMomentum: boolean;
|
|
8293
8484
|
MaintainLinearMomentum: boolean;
|
|
8294
8485
|
MoveMaxForce: number;
|
|
@@ -8296,6 +8487,10 @@ interface AirController extends ControllerBase {
|
|
|
8296
8487
|
OrientationSpeedFactor: number;
|
|
8297
8488
|
TurningMaxTorque: number;
|
|
8298
8489
|
TurningSpeedFactor: number;
|
|
8490
|
+
/**
|
|
8491
|
+
* Tags: Hidden, NotReplicated, Deprecated
|
|
8492
|
+
* @deprecated
|
|
8493
|
+
*/
|
|
8299
8494
|
VectorForce: Vector3;
|
|
8300
8495
|
}
|
|
8301
8496
|
|
|
@@ -8339,6 +8534,7 @@ interface GroundController extends ControllerBase {
|
|
|
8339
8534
|
GroundOffset: number;
|
|
8340
8535
|
StandForce: number;
|
|
8341
8536
|
StandSpeed: number;
|
|
8537
|
+
TurnSpeedFactor: number;
|
|
8342
8538
|
TurningFactor: number;
|
|
8343
8539
|
}
|
|
8344
8540
|
|
|
@@ -8723,7 +8919,7 @@ interface DataStoreIncrementOptions extends Instance {
|
|
|
8723
8919
|
*
|
|
8724
8920
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
8725
8921
|
*/
|
|
8726
|
-
SetMetadata(this: DataStoreIncrementOptions, attributes: object):
|
|
8922
|
+
SetMetadata(this: DataStoreIncrementOptions, attributes: object): null;
|
|
8727
8923
|
}
|
|
8728
8924
|
|
|
8729
8925
|
/** Object describing data store information such as name, created time, and time last updated. This object is a member of the [DataStoreListingPages](https://developer.roblox.com/en-us/api-reference/class/DataStoreListingPages) object returned by [DataStoreService:ListDataStoresAsync](https://developer.roblox.com/en-us/api-reference/function/DataStoreService/ListDataStoresAsync).
|
|
@@ -8945,7 +9141,7 @@ interface DataStoreOptions extends Instance {
|
|
|
8945
9141
|
*
|
|
8946
9142
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
8947
9143
|
*/
|
|
8948
|
-
SetExperimentalFeatures(this: DataStoreOptions, experimentalFeatures: object):
|
|
9144
|
+
SetExperimentalFeatures(this: DataStoreOptions, experimentalFeatures: object): null;
|
|
8949
9145
|
}
|
|
8950
9146
|
|
|
8951
9147
|
/** **DataStoreService** exposes methods for getting [GlobalDataStore](https://developer.roblox.com/en-us/api-reference/class/GlobalDataStore) and [OrderedDataStore](https://developer.roblox.com/en-us/api-reference/class/OrderedDataStore) objects. Data stores can only be accessed by game servers, so you can only use [DataStoreService](https://developer.roblox.com/en-us/api-reference/class/DataStoreService) within a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) or a [ModuleScript](https://developer.roblox.com/en-us/api-reference/class/ModuleScript) that is used by a [Script](https://developer.roblox.com/en-us/api-reference/class/Script).
|
|
@@ -9026,7 +9222,7 @@ interface DataStoreSetOptions extends Instance {
|
|
|
9026
9222
|
*
|
|
9027
9223
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
9028
9224
|
*/
|
|
9029
|
-
SetMetadata(this: DataStoreSetOptions, attributes: object):
|
|
9225
|
+
SetMetadata(this: DataStoreSetOptions, attributes: object): null;
|
|
9030
9226
|
}
|
|
9031
9227
|
|
|
9032
9228
|
/** The Debris service allows the developer to schedule the removal of the object without yielding any code, through the usage of the [Debris:AddItem](https://developer.roblox.com/en-us/api-reference/function/Debris/AddItem) method.
|
|
@@ -9105,7 +9301,7 @@ interface Debris extends Instance {
|
|
|
9105
9301
|
*
|
|
9106
9302
|
* Debris does not yield the current thread, does not require a new thread and will not error if the object is already destroyed. For this reason it is the recommended method for cleaning up objects with a fixed lifetime.
|
|
9107
9303
|
*/
|
|
9108
|
-
AddItem(this: Debris, item: Instance, lifetime?: number):
|
|
9304
|
+
AddItem(this: Debris, item: Instance, lifetime?: number): null;
|
|
9109
9305
|
}
|
|
9110
9306
|
|
|
9111
9307
|
interface DebuggablePluginWatcher extends Instance {
|
|
@@ -9355,7 +9551,7 @@ interface Dragger extends Instance {
|
|
|
9355
9551
|
/**
|
|
9356
9552
|
* Rotates the currently dragged part(s) by 90 degrees on the given axis.
|
|
9357
9553
|
*/
|
|
9358
|
-
AxisRotate(this: Dragger, axis?: CastsToEnum<Enum.Axis>):
|
|
9554
|
+
AxisRotate(this: Dragger, axis?: CastsToEnum<Enum.Axis>): null;
|
|
9359
9555
|
/**
|
|
9360
9556
|
* Initializes a dragging action, specifying which parts to use when dragging.
|
|
9361
9557
|
*/
|
|
@@ -9363,11 +9559,11 @@ interface Dragger extends Instance {
|
|
|
9363
9559
|
/**
|
|
9364
9560
|
* Tries to move the currently dragged part to the point where MouseRay hits another part.
|
|
9365
9561
|
*/
|
|
9366
|
-
MouseMove(this: Dragger, mouseRay: Ray):
|
|
9562
|
+
MouseMove(this: Dragger, mouseRay: Ray): null;
|
|
9367
9563
|
/**
|
|
9368
9564
|
* Stops the current dragging action (made by [MouseDown](https://developer.roblox.com/api-reference/function/Dragger/MouseDown "MouseDown"))
|
|
9369
9565
|
*/
|
|
9370
|
-
MouseUp(this: Dragger):
|
|
9566
|
+
MouseUp(this: Dragger): null;
|
|
9371
9567
|
}
|
|
9372
9568
|
|
|
9373
9569
|
interface DraggerService extends Instance {
|
|
@@ -10278,7 +10474,7 @@ interface GamepadService extends Instance {
|
|
|
10278
10474
|
*/
|
|
10279
10475
|
readonly _nominal_GamepadService: unique symbol;
|
|
10280
10476
|
readonly GamepadCursorEnabled: boolean;
|
|
10281
|
-
DisableGamepadCursor(this: GamepadService):
|
|
10477
|
+
DisableGamepadCursor(this: GamepadService): null;
|
|
10282
10478
|
EnableGamepadCursor(this: GamepadService, guiObject: GuiObject | undefined): void;
|
|
10283
10479
|
}
|
|
10284
10480
|
|
|
@@ -10514,7 +10710,7 @@ interface DataStore extends GlobalDataStore {
|
|
|
10514
10710
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
10515
10711
|
* Tags: Yields
|
|
10516
10712
|
*/
|
|
10517
|
-
RemoveVersionAsync(this: DataStore, key: string, version: string):
|
|
10713
|
+
RemoveVersionAsync(this: DataStore, key: string, version: string): null;
|
|
10518
10714
|
}
|
|
10519
10715
|
|
|
10520
10716
|
/** A **OrderedDataStore** is essentially a [GlobalDataStore](https://developer.roblox.com/en-us/api-reference/class/GlobalDataStore) with the exception that stored values must be **positive integers**. It exposes a method [GetSortedAsync()](https://developer.roblox.com/en-us/api-reference/function/OrderedDataStore/GetSortedAsync) which allows inspection of the entries in sorted order using a [DataStorePages](https://developer.roblox.com/en-us/api-reference/class/DataStorePages) object.
|
|
@@ -12637,7 +12833,7 @@ interface TextBox extends GuiObject {
|
|
|
12637
12833
|
/**
|
|
12638
12834
|
* Forces the client to focus on the TextBox.
|
|
12639
12835
|
*/
|
|
12640
|
-
CaptureFocus(this: TextBox):
|
|
12836
|
+
CaptureFocus(this: TextBox): null;
|
|
12641
12837
|
/**
|
|
12642
12838
|
* Returns true if the textbox is focused, or false if it is not.
|
|
12643
12839
|
*/
|
|
@@ -12665,7 +12861,7 @@ interface TextBox extends GuiObject {
|
|
|
12665
12861
|
*
|
|
12666
12862
|
* Please be aware that the above example assumes that it's in a LocalScript, as a child of a TextBox.
|
|
12667
12863
|
*/
|
|
12668
|
-
ReleaseFocus(this: TextBox, submitted?: boolean):
|
|
12864
|
+
ReleaseFocus(this: TextBox, submitted?: boolean): null;
|
|
12669
12865
|
/**
|
|
12670
12866
|
* The FocusLost event fires when the client lets their focus off the TextBox - typically when a client clicks/taps on a TextBox to begin text entry. This also fires if a TextBox forces focus on the user.
|
|
12671
12867
|
*
|
|
@@ -12755,11 +12951,11 @@ interface VideoFrame extends GuiObject {
|
|
|
12755
12951
|
*
|
|
12756
12952
|
* As [VideoFrame.TimePosition](https://developer.roblox.com/en-us/api-reference/property/VideoFrame/TimePosition) is not reset, when the video is resumed it will continue from its previous position.
|
|
12757
12953
|
*/
|
|
12758
|
-
Pause(this: VideoFrame):
|
|
12954
|
+
Pause(this: VideoFrame): null;
|
|
12759
12955
|
/**
|
|
12760
12956
|
* Sets [VideoFrame.Playing](https://developer.roblox.com/en-us/api-reference/property/VideoFrame/Playing) to true, This plays the [VideoFrame.Video](https://developer.roblox.com/en-us/api-reference/property/VideoFrame/Video), continuing from the current [VideoFrame.TimePosition](https://developer.roblox.com/en-us/api-reference/property/VideoFrame/TimePosition).
|
|
12761
12957
|
*/
|
|
12762
|
-
Play(this: VideoFrame):
|
|
12958
|
+
Play(this: VideoFrame): null;
|
|
12763
12959
|
/**
|
|
12764
12960
|
* An event that fires whenever the [VideoFrame.Video](https://developer.roblox.com/en-us/api-reference/property/VideoFrame/Video) loops. Returns the content ID of the video.
|
|
12765
12961
|
*/
|
|
@@ -13737,10 +13933,10 @@ interface WireframeHandleAdornment extends HandleAdornment {
|
|
|
13737
13933
|
*/
|
|
13738
13934
|
readonly _nominal_WireframeHandleAdornment: unique symbol;
|
|
13739
13935
|
Scale: Vector3;
|
|
13740
|
-
AddLine(this: WireframeHandleAdornment, from: Vector3, to: Vector3):
|
|
13741
|
-
AddLines(this: WireframeHandleAdornment, points: Array<any>):
|
|
13742
|
-
AddPath(this: WireframeHandleAdornment, points: Array<any>, loop: boolean):
|
|
13743
|
-
Clear(this: WireframeHandleAdornment):
|
|
13936
|
+
AddLine(this: WireframeHandleAdornment, from: Vector3, to: Vector3): null;
|
|
13937
|
+
AddLines(this: WireframeHandleAdornment, points: Array<any>): null;
|
|
13938
|
+
AddPath(this: WireframeHandleAdornment, points: Array<any>, loop: boolean): null;
|
|
13939
|
+
Clear(this: WireframeHandleAdornment): null;
|
|
13744
13940
|
}
|
|
13745
13941
|
|
|
13746
13942
|
/** A special type of Adornment that is still a work in progress.
|
|
@@ -14058,7 +14254,7 @@ interface GuiService extends Instance {
|
|
|
14058
14254
|
* * [GuiService:InspectPlayerFromHumanoidDescription](https://developer.roblox.com/en-us/api-reference/function/GuiService/InspectPlayerFromHumanoidDescription), allows a developer to bring up the Inspect menu showing the assets listed in this [HumanoidDescription](https://developer.roblox.com/en-us/api-reference/class/HumanoidDescription) object. This is especially useful when what is being worn on a player's avatar on the Roblox platform is not necessarily the same as their in-game appearance
|
|
14059
14255
|
* * [GuiService:InspectPlayerFromUserId](https://developer.roblox.com/en-us/api-reference/function/GuiService/InspectPlayerFromUserId), allows the Inspect Menu to appear showing the user that has the given [UserId](https://developer.roblox.com/en-us/api-reference/property/Player/UserId). This is especially useful when you want to inspect players who aren't in the current game
|
|
14060
14256
|
*/
|
|
14061
|
-
CloseInspectMenu(this: GuiService):
|
|
14257
|
+
CloseInspectMenu(this: GuiService): null;
|
|
14062
14258
|
/**
|
|
14063
14259
|
* Returns a boolean indicating whether or not the player Emotes menu is open.
|
|
14064
14260
|
*
|
|
@@ -14122,7 +14318,7 @@ interface GuiService extends Instance {
|
|
|
14122
14318
|
* * `GuiService:SetInspectMenuEnabled`, allows developers to enable or disable default Inspect and Buy functionality. This is especially useful when what is being worn on a player's avatar on the Roblox platform is not necessarily the same as their in-game appearance
|
|
14123
14319
|
* * [GuiService:InspectPlayerFromHumanoidDescription](https://developer.roblox.com/en-us/api-reference/function/GuiService/InspectPlayerFromHumanoidDescription), allows a developer to bring up the Inspect menu showing the assets listed in this [HumanoidDescription](https://developer.roblox.com/en-us/api-reference/class/HumanoidDescription) object
|
|
14124
14320
|
*/
|
|
14125
|
-
InspectPlayerFromUserId(this: GuiService, userId: number):
|
|
14321
|
+
InspectPlayerFromUserId(this: GuiService, userId: number): null;
|
|
14126
14322
|
/**
|
|
14127
14323
|
* Returns true if the client is using the ten foot interface, which is a special version of Roblox's UI, exclusive to consoles.
|
|
14128
14324
|
*
|
|
@@ -14132,12 +14328,12 @@ interface GuiService extends Instance {
|
|
|
14132
14328
|
/**
|
|
14133
14329
|
* Removes a group that was created with [GuiService:AddSelectionParent](https://developer.roblox.com/en-us/api-reference/function/GuiService/AddSelectionParent) or [GuiService:AddSelectionTuple](https://developer.roblox.com/en-us/api-reference/function/GuiService/AddSelectionTuple).
|
|
14134
14330
|
*/
|
|
14135
|
-
RemoveSelectionGroup(this: GuiService, selectionName: string):
|
|
14331
|
+
RemoveSelectionGroup(this: GuiService, selectionName: string): null;
|
|
14136
14332
|
Select(this: GuiService, selectionParent: Instance): void;
|
|
14137
14333
|
/**
|
|
14138
14334
|
* Opens or closes the player Emotes menu.
|
|
14139
14335
|
*/
|
|
14140
|
-
SetEmotesMenuOpen(this: GuiService, isOpen: boolean):
|
|
14336
|
+
SetEmotesMenuOpen(this: GuiService, isOpen: boolean): null;
|
|
14141
14337
|
/**
|
|
14142
14338
|
* This method allows developers to disable the built-in notification when a players gameplay is paused. They can then add in their own UI if they wish to customize it.
|
|
14143
14339
|
*
|
|
@@ -14148,7 +14344,7 @@ interface GuiService extends Instance {
|
|
|
14148
14344
|
*
|
|
14149
14345
|
* * [Workspace.StreamingPauseMode](https://developer.roblox.com/en-us/api-reference/property/Workspace/StreamingPauseMode), controls which streaming physics pause mode is active
|
|
14150
14346
|
*/
|
|
14151
|
-
SetGameplayPausedNotificationEnabled(this: GuiService, enabled: boolean):
|
|
14347
|
+
SetGameplayPausedNotificationEnabled(this: GuiService, enabled: boolean): null;
|
|
14152
14348
|
/**
|
|
14153
14349
|
* This function allows developers to enable or disable default Inspect and Buy functionality. This is useful when you want to disable the feature in your game, entirely or during certain parts of your game (such as a cutscene). The feature is enabled by default.
|
|
14154
14350
|
*
|
|
@@ -14164,7 +14360,7 @@ interface GuiService extends Instance {
|
|
|
14164
14360
|
* * [GuiService:InspectPlayerFromHumanoidDescription](https://developer.roblox.com/en-us/api-reference/function/GuiService/InspectPlayerFromHumanoidDescription), allows a developer to bring up the Inspect menu showing the assets listed in this [HumanoidDescription](https://developer.roblox.com/en-us/api-reference/class/HumanoidDescription) object. This is especially useful when what is being worn on a player's avatar on the Roblox platform is not necessarily the same as their in-game appearance
|
|
14165
14361
|
* * [GuiService:InspectPlayerFromUserId](https://developer.roblox.com/en-us/api-reference/function/GuiService/InspectPlayerFromUserId), allows the Inspect Menu to appear showing the user that has the given [UserId](https://developer.roblox.com/en-us/api-reference/property/Player/UserId). This is especially useful when you want to inspect players who aren't in the current game
|
|
14166
14362
|
*/
|
|
14167
|
-
SetInspectMenuEnabled(this: GuiService, enabled: boolean):
|
|
14363
|
+
SetInspectMenuEnabled(this: GuiService, enabled: boolean): null;
|
|
14168
14364
|
/**
|
|
14169
14365
|
* Fires when the user **closes** the Roblox coregui escape menu.
|
|
14170
14366
|
*/
|
|
@@ -15037,7 +15233,7 @@ interface Humanoid extends Instance {
|
|
|
15037
15233
|
*
|
|
15038
15234
|
* If the required [Attachment](https://developer.roblox.com/en-us/api-reference/class/Attachment) can not be found, then the [Accessory](https://developer.roblox.com/en-us/api-reference/class/Accessory) will remain parented to the [Humanoid's](https://developer.roblox.com/en-us/api-reference/class/Humanoid) parent but it will be unattached.
|
|
15039
15235
|
*/
|
|
15040
|
-
AddAccessory(this: Humanoid, accessory: Accessory):
|
|
15236
|
+
AddAccessory(this: Humanoid, accessory: Accessory): null;
|
|
15041
15237
|
/**
|
|
15042
15238
|
* Adds a BoolValue to the Humanoid's _Status_ object, whose name is equal to the string passed as the _status_ argument. If the status already exists, a new BoolValue will not be created.
|
|
15043
15239
|
* Tags: Deprecated
|
|
@@ -15057,7 +15253,7 @@ interface Humanoid extends Instance {
|
|
|
15057
15253
|
*
|
|
15058
15254
|
* See the provided code sample below to see how this function works.
|
|
15059
15255
|
*/
|
|
15060
|
-
BuildRigFromAttachments(this: Humanoid):
|
|
15256
|
+
BuildRigFromAttachments(this: Humanoid): null;
|
|
15061
15257
|
/**
|
|
15062
15258
|
* This function causes the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) to enter the given [HumanoidStateType](https://developer.roblox.com/en-us/api-reference/enum/HumanoidStateType).
|
|
15063
15259
|
*
|
|
@@ -15076,7 +15272,7 @@ interface Humanoid extends Instance {
|
|
|
15076
15272
|
* * To enable or disable a particular state use [Humanoid:SetStateEnabled](https://developer.roblox.com/en-us/api-reference/function/Humanoid/SetStateEnabled)
|
|
15077
15273
|
* * To get the current state use [Humanoid:GetState](https://developer.roblox.com/en-us/api-reference/function/Humanoid/GetState)
|
|
15078
15274
|
*/
|
|
15079
|
-
ChangeState(this: Humanoid, state?: CastsToEnum<Enum.HumanoidStateType>):
|
|
15275
|
+
ChangeState(this: Humanoid, state?: CastsToEnum<Enum.HumanoidStateType>): null;
|
|
15080
15276
|
/**
|
|
15081
15277
|
* This function makes the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) equip the given [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool).
|
|
15082
15278
|
*
|
|
@@ -15104,7 +15300,7 @@ interface Humanoid extends Instance {
|
|
|
15104
15300
|
*
|
|
15105
15301
|
* * To unequip tools, use [Humanoid:UnequipTools](https://developer.roblox.com/en-us/api-reference/function/Humanoid/UnequipTools)
|
|
15106
15302
|
*/
|
|
15107
|
-
EquipTool(this: Humanoid, tool: Tool):
|
|
15303
|
+
EquipTool(this: Humanoid, tool: Tool): null;
|
|
15108
15304
|
/**
|
|
15109
15305
|
* This function returns an array of [Accessories](https://developer.roblox.com/en-us/api-reference/class/Accessory) that the [Humanoid's](https://developer.roblox.com/en-us/api-reference/class/Humanoid) parent is currently wearing. All [Accessory](https://developer.roblox.com/en-us/api-reference/class/Accessory) objects parented to the [Humanoid's](https://developer.roblox.com/en-us/api-reference/class/Humanoid) parent will be included, regardless of if they are attached or not. If the humanoid is not wearing any accessories, the array will be empty.
|
|
15110
15306
|
*
|
|
@@ -15249,7 +15445,7 @@ interface Humanoid extends Instance {
|
|
|
15249
15445
|
* * To make a[Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) walk to a point, use the [Humanoid:MoveTo](https://developer.roblox.com/en-us/api-reference/function/Humanoid/MoveTo) function
|
|
15250
15446
|
* * For [Players](https://developer.roblox.com/en-us/api-reference/class/Player) the [Player:Move](https://developer.roblox.com/en-us/api-reference/function/Player/Move) function exists that calls this function
|
|
15251
15447
|
*/
|
|
15252
|
-
Move(this: Humanoid, moveDirection: Vector3, relativeToCamera?: boolean):
|
|
15448
|
+
Move(this: Humanoid, moveDirection: Vector3, relativeToCamera?: boolean): null;
|
|
15253
15449
|
/**
|
|
15254
15450
|
* This function causes the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) to attempt to walk to the given location by setting the [Humanoid.WalkToPoint](https://developer.roblox.com/en-us/api-reference/property/Humanoid/WalkToPoint) and [Humanoid.WalkToPart](https://developer.roblox.com/en-us/api-reference/property/Humanoid/WalkToPart) properties.
|
|
15255
15451
|
*
|
|
@@ -15259,7 +15455,7 @@ interface Humanoid extends Instance {
|
|
|
15259
15455
|
*
|
|
15260
15456
|
* The _reach goal_ state of a humanoid will timeout after 8 seconds if it doesn't reach its goal. This is done so that NPCs won't get stuck waiting for [Humanoid.MoveToFinished](https://developer.roblox.com/en-us/api-reference/event/Humanoid/MoveToFinished) to fire. If you don't want this to happen, you should repeatedly call MoveTo so that the timeout will keep resetting.
|
|
15261
15457
|
*/
|
|
15262
|
-
MoveTo(this: Humanoid, location: Vector3, part?: BasePart):
|
|
15458
|
+
MoveTo(this: Humanoid, location: Vector3, part?: BasePart): null;
|
|
15263
15459
|
/**
|
|
15264
15460
|
* This function removes all [Accessories](https://developer.roblox.com/en-us/api-reference/class/Accessory) worn by the [Humanoid's](https://developer.roblox.com/en-us/api-reference/class/Humanoid) parent. When this function is called, all [Accessories](https://developer.roblox.com/en-us/api-reference/class/Accessory) sharing an [Instance.Parent](https://developer.roblox.com/en-us/api-reference/property/Instance/Parent) with the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) will be removed. For [Player](https://developer.roblox.com/en-us/api-reference/class/Player) [Characters](https://developer.roblox.com/en-us/api-reference/property/Player/Character) this will remove all hats and other accessories.
|
|
15265
15461
|
*
|
|
@@ -15271,7 +15467,7 @@ interface Humanoid extends Instance {
|
|
|
15271
15467
|
* * To attach an [Accessory](https://developer.roblox.com/en-us/api-reference/class/Accessory) use the [Humanoid:AddAccessory](https://developer.roblox.com/en-us/api-reference/function/Humanoid/AddAccessory) function
|
|
15272
15468
|
* * To get all [Accessories](https://developer.roblox.com/en-us/api-reference/class/Accessory) belonging to a [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) use the [Humanoid:GetAccessories](https://developer.roblox.com/en-us/api-reference/function/Humanoid/GetAccessories) function
|
|
15273
15469
|
*/
|
|
15274
|
-
RemoveAccessories(this: Humanoid):
|
|
15470
|
+
RemoveAccessories(this: Humanoid): null;
|
|
15275
15471
|
/**
|
|
15276
15472
|
* The RemoveCustomStatus function removes the defined custom status from the Status model in the Humanoid…
|
|
15277
15473
|
* Tags: Deprecated
|
|
@@ -15299,7 +15495,7 @@ interface Humanoid extends Instance {
|
|
|
15299
15495
|
*
|
|
15300
15496
|
* When a particular [HumanoidStateType](https://developer.roblox.com/en-us/api-reference/enum/HumanoidStateType) is disabled, the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) can never enter that state. This is true regardless if the attempt to change state is made using [Humanoid:ChangeState](https://developer.roblox.com/en-us/api-reference/function/Humanoid/ChangeState) or Roblox internal [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) code.
|
|
15301
15497
|
*/
|
|
15302
|
-
SetStateEnabled(this: Humanoid, state: CastsToEnum<Enum.HumanoidStateType>, enabled: boolean):
|
|
15498
|
+
SetStateEnabled(this: Humanoid, state: CastsToEnum<Enum.HumanoidStateType>, enabled: boolean): null;
|
|
15303
15499
|
/**
|
|
15304
15500
|
* This function lowers the [Humanoid.Health](https://developer.roblox.com/en-us/api-reference/property/Humanoid/Health) of the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) by the given _amount_ if it is not protected by a [ForceField](https://developer.roblox.com/en-us/api-reference/class/ForceField)
|
|
15305
15501
|
*
|
|
@@ -15318,7 +15514,7 @@ interface Humanoid extends Instance {
|
|
|
15318
15514
|
*
|
|
15319
15515
|
* For more information on how [ForceFields](https://developer.roblox.com/en-us/api-reference/class/ForceField) protect [Humanoids](https://developer.roblox.com/en-us/api-reference/class/Humanoid) see the [ForceField](https://developer.roblox.com/en-us/api-reference/class/ForceField) page
|
|
15320
15516
|
*/
|
|
15321
|
-
TakeDamage(this: Humanoid, amount: number):
|
|
15517
|
+
TakeDamage(this: Humanoid, amount: number): null;
|
|
15322
15518
|
/**
|
|
15323
15519
|
* This function unequips any [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool) currently equipped by the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid)
|
|
15324
15520
|
*
|
|
@@ -15333,7 +15529,7 @@ interface Humanoid extends Instance {
|
|
|
15333
15529
|
*
|
|
15334
15530
|
* * To instead equip a [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool), use [Humanoid:EquipTool](https://developer.roblox.com/en-us/api-reference/function/Humanoid/EquipTool)
|
|
15335
15531
|
*/
|
|
15336
|
-
UnequipTools(this: Humanoid):
|
|
15532
|
+
UnequipTools(this: Humanoid): null;
|
|
15337
15533
|
/**
|
|
15338
15534
|
* This yield function makes the [character's](https://developer.roblox.com/en-us/api-reference/property/Player/Character) look match that of the passed in [HumanoidDescription](https://developer.roblox.com/en-us/api-reference/class/HumanoidDescription). A copy of the passed look will then be cached in the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) as the current HumanoidDescription for the Humanoid.
|
|
15339
15535
|
*
|
|
@@ -15348,11 +15544,11 @@ interface Humanoid extends Instance {
|
|
|
15348
15544
|
* * [Player:LoadCharacterWithHumanoidDescription](https://developer.roblox.com/en-us/api-reference/function/Player/LoadCharacterWithHumanoidDescription), spawns a player with the look from the HumanoidDescription Instance passed in
|
|
15349
15545
|
* Tags: Yields
|
|
15350
15546
|
*/
|
|
15351
|
-
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>):
|
|
15547
|
+
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): null;
|
|
15352
15548
|
/**
|
|
15353
15549
|
* Tags: Yields
|
|
15354
15550
|
*/
|
|
15355
|
-
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>):
|
|
15551
|
+
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): null;
|
|
15356
15552
|
/**
|
|
15357
15553
|
* If the emote could not be played because the emoteName is not found in the HumanoidDescription for the humanoid or the Humanoid is in the wrong HumanoidState for emotes then this API would return false to indicate that the emote was not played. The API would return true to indicate that the emote was played successfully.
|
|
15358
15554
|
* Tags: Yields
|
|
@@ -16120,7 +16316,7 @@ interface HumanoidDescription extends Instance {
|
|
|
16120
16316
|
* * [SetEmotes](https://developer.roblox.com/en-us/api-reference/function/HumanoidDescription/SetEmotes) and [RemoveEmote](https://developer.roblox.com/en-us/api-reference/function/HumanoidDescription/RemoveEmote), which also manipulate what emotes have been added
|
|
16121
16317
|
* * [EmotesChanged](https://developer.roblox.com/en-us/api-reference/event/HumanoidDescription/EmotesChanged), which fires after this function is called
|
|
16122
16318
|
*/
|
|
16123
|
-
AddEmote(this: HumanoidDescription, name: string, assetId: number):
|
|
16319
|
+
AddEmote(this: HumanoidDescription, name: string, assetId: number): null;
|
|
16124
16320
|
/**
|
|
16125
16321
|
* Returns a table of an avatar's current accessories. If the second parameter (includeRigidAccessories) is true then the returned table will also include entries for rigid accessories from the rigid accessory properties.
|
|
16126
16322
|
*/
|
|
@@ -16182,11 +16378,11 @@ interface HumanoidDescription extends Instance {
|
|
|
16182
16378
|
* * [SetEmotes](https://developer.roblox.com/en-us/api-reference/function/HumanoidDescription/SetEmotes) and [AddEmote](https://developer.roblox.com/en-us/api-reference/function/HumanoidDescription/AddEmote), which can add emotes that may be removed
|
|
16183
16379
|
* * [GetEmotes](https://developer.roblox.com/en-us/api-reference/function/HumanoidDescription/GetEmotes), which can retrieve a dictionary of emotes that may be removed
|
|
16184
16380
|
*/
|
|
16185
|
-
RemoveEmote(this: HumanoidDescription, name: string):
|
|
16381
|
+
RemoveEmote(this: HumanoidDescription, name: string): null;
|
|
16186
16382
|
/**
|
|
16187
16383
|
* Accepts a table that sets the accessories and related properties for an avatar. If the second parameter (includeRigidAccessories) is true, then this function can also be used to set the rigid accessories in the rigid accessory properties. In this case any table entry that does not have an Order will be considered a rigid accessory and put in the appropriate property according to the AccessoryType.
|
|
16188
16384
|
*/
|
|
16189
|
-
SetAccessories(this: HumanoidDescription, accessories: Array<any>, includeRigidAccessories: boolean):
|
|
16385
|
+
SetAccessories(this: HumanoidDescription, accessories: Array<any>, includeRigidAccessories: boolean): null;
|
|
16190
16386
|
/**
|
|
16191
16387
|
* **SetEmotes** sets all of the emotes on this description given a table similar to that returned by [GetEmotes](https://developer.roblox.com/en-us/api-reference/function/HumanoidDescription/GetEmotes). It fires [EmotesChanged](https://developer.roblox.com/en-us/api-reference/event/HumanoidDescription/EmotesChanged)
|
|
16192
16388
|
*
|
|
@@ -16354,191 +16550,14 @@ interface ImageDataExperimental extends Instance {
|
|
|
16354
16550
|
* Tags: ReadOnly, NotReplicated
|
|
16355
16551
|
*/
|
|
16356
16552
|
readonly TemporaryId: string;
|
|
16357
|
-
Clear(this: ImageDataExperimental):
|
|
16358
|
-
DrawCircle(this: ImageDataExperimental, center: Vector2, radius: number, color: Color3, alpha: number):
|
|
16359
|
-
Resize(this: ImageDataExperimental, newSize: Vector2):
|
|
16360
|
-
Rotate(this: ImageDataExperimental, degrees: number, resizeCanvas?: boolean):
|
|
16553
|
+
Clear(this: ImageDataExperimental): null;
|
|
16554
|
+
DrawCircle(this: ImageDataExperimental, center: Vector2, radius: number, color: Color3, alpha: number): null;
|
|
16555
|
+
Resize(this: ImageDataExperimental, newSize: Vector2): null;
|
|
16556
|
+
Rotate(this: ImageDataExperimental, degrees: number, resizeCanvas?: boolean): null;
|
|
16361
16557
|
/**
|
|
16362
16558
|
* Tags: Yields
|
|
16363
16559
|
*/
|
|
16364
|
-
PopulateFromImageAsync(this: ImageDataExperimental, textureId: string):
|
|
16365
|
-
}
|
|
16366
|
-
|
|
16367
|
-
interface ImporterBaseSettings extends Instance {
|
|
16368
|
-
/**
|
|
16369
|
-
* **DO NOT USE!**
|
|
16370
|
-
*
|
|
16371
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16372
|
-
* @hidden
|
|
16373
|
-
* @deprecated
|
|
16374
|
-
*/
|
|
16375
|
-
readonly _nominal_ImporterBaseSettings: unique symbol;
|
|
16376
|
-
/**
|
|
16377
|
-
* Tags: ReadOnly, NotReplicated
|
|
16378
|
-
*/
|
|
16379
|
-
readonly Id: string;
|
|
16380
|
-
ImportName: string;
|
|
16381
|
-
ShouldImport: boolean;
|
|
16382
|
-
}
|
|
16383
|
-
|
|
16384
|
-
interface ImporterAnimationSettings extends ImporterBaseSettings {
|
|
16385
|
-
/**
|
|
16386
|
-
* **DO NOT USE!**
|
|
16387
|
-
*
|
|
16388
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16389
|
-
* @hidden
|
|
16390
|
-
* @deprecated
|
|
16391
|
-
*/
|
|
16392
|
-
readonly _nominal_ImporterAnimationSettings: unique symbol;
|
|
16393
|
-
}
|
|
16394
|
-
|
|
16395
|
-
interface ImporterFacsSettings extends ImporterBaseSettings {
|
|
16396
|
-
/**
|
|
16397
|
-
* **DO NOT USE!**
|
|
16398
|
-
*
|
|
16399
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16400
|
-
* @hidden
|
|
16401
|
-
* @deprecated
|
|
16402
|
-
*/
|
|
16403
|
-
readonly _nominal_ImporterFacsSettings: unique symbol;
|
|
16404
|
-
}
|
|
16405
|
-
|
|
16406
|
-
interface ImporterGroupSettings extends ImporterBaseSettings {
|
|
16407
|
-
/**
|
|
16408
|
-
* **DO NOT USE!**
|
|
16409
|
-
*
|
|
16410
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16411
|
-
* @hidden
|
|
16412
|
-
* @deprecated
|
|
16413
|
-
*/
|
|
16414
|
-
readonly _nominal_ImporterGroupSettings: unique symbol;
|
|
16415
|
-
Anchored: boolean;
|
|
16416
|
-
ImportAsModelAsset: boolean;
|
|
16417
|
-
InsertInWorkspace: boolean;
|
|
16418
|
-
}
|
|
16419
|
-
|
|
16420
|
-
interface ImporterJointSettings extends ImporterBaseSettings {
|
|
16421
|
-
/**
|
|
16422
|
-
* **DO NOT USE!**
|
|
16423
|
-
*
|
|
16424
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16425
|
-
* @hidden
|
|
16426
|
-
* @deprecated
|
|
16427
|
-
*/
|
|
16428
|
-
readonly _nominal_ImporterJointSettings: unique symbol;
|
|
16429
|
-
}
|
|
16430
|
-
|
|
16431
|
-
interface ImporterMaterialSettings extends ImporterBaseSettings {
|
|
16432
|
-
/**
|
|
16433
|
-
* **DO NOT USE!**
|
|
16434
|
-
*
|
|
16435
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16436
|
-
* @hidden
|
|
16437
|
-
* @deprecated
|
|
16438
|
-
*/
|
|
16439
|
-
readonly _nominal_ImporterMaterialSettings: unique symbol;
|
|
16440
|
-
DiffuseFilePath: string;
|
|
16441
|
-
/**
|
|
16442
|
-
* Tags: ReadOnly, NotReplicated
|
|
16443
|
-
*/
|
|
16444
|
-
readonly IsPbr: boolean;
|
|
16445
|
-
MetalnessFilePath: string;
|
|
16446
|
-
NormalFilePath: string;
|
|
16447
|
-
RoughnessFilePath: string;
|
|
16448
|
-
}
|
|
16449
|
-
|
|
16450
|
-
interface ImporterMeshSettings extends ImporterBaseSettings {
|
|
16451
|
-
/**
|
|
16452
|
-
* **DO NOT USE!**
|
|
16453
|
-
*
|
|
16454
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16455
|
-
* @hidden
|
|
16456
|
-
* @deprecated
|
|
16457
|
-
*/
|
|
16458
|
-
readonly _nominal_ImporterMeshSettings: unique symbol;
|
|
16459
|
-
Anchored: boolean;
|
|
16460
|
-
/**
|
|
16461
|
-
* Tags: ReadOnly, NotReplicated
|
|
16462
|
-
*/
|
|
16463
|
-
readonly CageManifold: boolean;
|
|
16464
|
-
CageMeshIntersectedPreview: boolean;
|
|
16465
|
-
/**
|
|
16466
|
-
* Tags: ReadOnly, NotReplicated
|
|
16467
|
-
*/
|
|
16468
|
-
readonly CageMeshNotIntersected: boolean;
|
|
16469
|
-
/**
|
|
16470
|
-
* Tags: ReadOnly, NotReplicated
|
|
16471
|
-
*/
|
|
16472
|
-
readonly CageNoOverlappingVertices: boolean;
|
|
16473
|
-
CageNonManifoldPreview: boolean;
|
|
16474
|
-
CageOverlappingVerticesPreview: boolean;
|
|
16475
|
-
/**
|
|
16476
|
-
* Tags: ReadOnly, NotReplicated
|
|
16477
|
-
*/
|
|
16478
|
-
readonly CageUVMatched: boolean;
|
|
16479
|
-
CageUVMisMatchedPreview: boolean;
|
|
16480
|
-
/**
|
|
16481
|
-
* Tags: ReadOnly, NotReplicated
|
|
16482
|
-
*/
|
|
16483
|
-
readonly Dimensions: Vector3;
|
|
16484
|
-
DoubleSided: boolean;
|
|
16485
|
-
IgnoreVertexColors: boolean;
|
|
16486
|
-
IrrelevantCageModifiedPreview: boolean;
|
|
16487
|
-
MeshHoleDetectedPreview: boolean;
|
|
16488
|
-
/**
|
|
16489
|
-
* Tags: ReadOnly, NotReplicated
|
|
16490
|
-
*/
|
|
16491
|
-
readonly MeshNoHoleDetected: boolean;
|
|
16492
|
-
/**
|
|
16493
|
-
* Tags: ReadOnly, NotReplicated
|
|
16494
|
-
*/
|
|
16495
|
-
readonly NoIrrelevantCageModified: boolean;
|
|
16496
|
-
/**
|
|
16497
|
-
* Tags: ReadOnly, NotReplicated
|
|
16498
|
-
*/
|
|
16499
|
-
readonly NoOuterCageFarExtendedFromMesh: boolean;
|
|
16500
|
-
OuterCageFarExtendedFromMeshPreview: boolean;
|
|
16501
|
-
/**
|
|
16502
|
-
* Tags: ReadOnly, NotReplicated
|
|
16503
|
-
*/
|
|
16504
|
-
readonly PolygonCount: number;
|
|
16505
|
-
UseImportedPivot: boolean;
|
|
16506
|
-
}
|
|
16507
|
-
|
|
16508
|
-
interface ImporterRootSettings extends ImporterBaseSettings {
|
|
16509
|
-
/**
|
|
16510
|
-
* **DO NOT USE!**
|
|
16511
|
-
*
|
|
16512
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16513
|
-
* @hidden
|
|
16514
|
-
* @deprecated
|
|
16515
|
-
*/
|
|
16516
|
-
readonly _nominal_ImporterRootSettings: unique symbol;
|
|
16517
|
-
AddModelToInventory: boolean;
|
|
16518
|
-
Anchored: boolean;
|
|
16519
|
-
ExistingPackageId: string;
|
|
16520
|
-
/**
|
|
16521
|
-
* Tags: ReadOnly, NotReplicated
|
|
16522
|
-
*/
|
|
16523
|
-
readonly FileDimensions: Vector3;
|
|
16524
|
-
ImportAsModelAsset: boolean;
|
|
16525
|
-
ImportAsPackage: boolean;
|
|
16526
|
-
InsertInWorkspace: boolean;
|
|
16527
|
-
InsertWithScenePosition: boolean;
|
|
16528
|
-
InvertNegativeFaces: boolean;
|
|
16529
|
-
MergeMeshes: boolean;
|
|
16530
|
-
/**
|
|
16531
|
-
* Tags: ReadOnly, NotReplicated
|
|
16532
|
-
*/
|
|
16533
|
-
readonly PolygonCount: number;
|
|
16534
|
-
RigScale: Enum.RigScale;
|
|
16535
|
-
RigType: Enum.RigType;
|
|
16536
|
-
ScaleUnit: Enum.MeshScaleUnit;
|
|
16537
|
-
UseSceneOriginAsCFrame: boolean;
|
|
16538
|
-
UseSceneOriginAsPivot: boolean;
|
|
16539
|
-
UsesCages: boolean;
|
|
16540
|
-
WorldForward: Enum.NormalId;
|
|
16541
|
-
WorldUp: Enum.NormalId;
|
|
16560
|
+
PopulateFromImageAsync(this: ImageDataExperimental, textureId: string): null;
|
|
16542
16561
|
}
|
|
16543
16562
|
|
|
16544
16563
|
interface IncrementalPatchBuilder extends Instance {
|
|
@@ -18206,18 +18225,18 @@ interface InsertService extends Instance {
|
|
|
18206
18225
|
* Tags: Deprecated
|
|
18207
18226
|
* @deprecated
|
|
18208
18227
|
*/
|
|
18209
|
-
ApproveAssetId(this: InsertService, assetId: number):
|
|
18228
|
+
ApproveAssetId(this: InsertService, assetId: number): null;
|
|
18210
18229
|
/**
|
|
18211
18230
|
* Tags: Deprecated
|
|
18212
18231
|
* @deprecated
|
|
18213
18232
|
*/
|
|
18214
|
-
ApproveAssetVersionId(this: InsertService, assetVersionId: number):
|
|
18233
|
+
ApproveAssetVersionId(this: InsertService, assetVersionId: number): null;
|
|
18215
18234
|
/**
|
|
18216
18235
|
* The Insert function is an ancient method used to insert an [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance) into Workspace.
|
|
18217
18236
|
* Tags: Deprecated
|
|
18218
18237
|
* @deprecated
|
|
18219
18238
|
*/
|
|
18220
|
-
Insert(this: InsertService, instance: Instance):
|
|
18239
|
+
Insert(this: InsertService, instance: Instance): null;
|
|
18221
18240
|
/**
|
|
18222
18241
|
* Tags: Yields, Deprecated, [object Object]
|
|
18223
18242
|
* @deprecated
|
|
@@ -18642,7 +18661,7 @@ interface Motor extends JointInstance {
|
|
|
18642
18661
|
/**
|
|
18643
18662
|
* Sets [Motor.DesiredAngle](https://developer.roblox.com/en-us/api-reference/property/Motor/DesiredAngle) of the motor.
|
|
18644
18663
|
*/
|
|
18645
|
-
SetDesiredAngle(this: Motor, value: number):
|
|
18664
|
+
SetDesiredAngle(this: Motor, value: number): null;
|
|
18646
18665
|
}
|
|
18647
18666
|
|
|
18648
18667
|
/** **Motor6D** joins two [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) ([Part0](https://developer.roblox.com/en-us/api-reference/property/JointInstance/Part0) and [Part1](https://developer.roblox.com/en-us/api-reference/property/JointInstance/Part1)) together in an animatable way. The [Transform](https://developer.roblox.com/en-us/api-reference/property/Motor6D/Transform) property determines the offset between these parts. This can be set manually using [RunService.Stepped](https://developer.roblox.com/en-us/api-reference/event/RunService/Stepped) or through an [Animator](https://developer.roblox.com/en-us/api-reference/class/Animator).
|
|
@@ -18788,11 +18807,11 @@ interface JointsService extends Instance {
|
|
|
18788
18807
|
/**
|
|
18789
18808
|
* Will remove any 'create joints' that were made visible via the [JointsService:ShowPermissibleJoints](https://developer.roblox.com/en-us/api-reference/function/JointsService/ShowPermissibleJoints) method.
|
|
18790
18809
|
*/
|
|
18791
|
-
ClearJoinAfterMoveJoints(this: JointsService):
|
|
18810
|
+
ClearJoinAfterMoveJoints(this: JointsService): null;
|
|
18792
18811
|
/**
|
|
18793
18812
|
* Updates all visible joints for the parts assigned by the [JointsService:SetJoinAfterMoveTarget](https://developer.roblox.com/en-us/api-reference/function/JointsService/SetJoinAfterMoveTarget) and [JointsService:SetJoinAfterMoveInstance](https://developer.roblox.com/en-us/api-reference/function/JointsService/SetJoinAfterMoveInstance) methods.
|
|
18794
18813
|
*/
|
|
18795
|
-
CreateJoinAfterMoveJoints(this: JointsService):
|
|
18814
|
+
CreateJoinAfterMoveJoints(this: JointsService): null;
|
|
18796
18815
|
/**
|
|
18797
18816
|
* Sets the PVInstance that will be connected with the target PVInstance specified by [JointsService:SetJoinAfterMoveTarget](https://developer.roblox.com/en-us/api-reference/function/JointsService/SetJoinAfterMoveTarget).
|
|
18798
18817
|
*/
|
|
@@ -18804,7 +18823,7 @@ interface JointsService extends Instance {
|
|
|
18804
18823
|
/**
|
|
18805
18824
|
* When used it will visibly display a potential surface connection between the two [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart), which were set with [JointsService:SetJoinAfterMoveTarget](https://developer.roblox.com/en-us/api-reference/function/JointsService/SetJoinAfterMoveTarget) and [JointsService:SetJoinAfterMoveInstance](https://developer.roblox.com/en-us/api-reference/function/JointsService/SetJoinAfterMoveInstance).
|
|
18806
18825
|
*/
|
|
18807
|
-
ShowPermissibleJoints(this: JointsService):
|
|
18826
|
+
ShowPermissibleJoints(this: JointsService): null;
|
|
18808
18827
|
}
|
|
18809
18828
|
|
|
18810
18829
|
/** A Keyframe holds the [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose)s applied to joints in a [Model](https://developer.roblox.com/en-us/api-reference/class/Model) at a given point of time in an animation. [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe)s are interpolated between during animation playback.
|
|
@@ -18863,7 +18882,7 @@ interface Keyframe extends Instance {
|
|
|
18863
18882
|
*
|
|
18864
18883
|
* Note, this function will not error when an instance other than a [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose) is given as the pose parameter and will parent it successfully.
|
|
18865
18884
|
*/
|
|
18866
|
-
AddPose(this: Keyframe, pose: Pose):
|
|
18885
|
+
AddPose(this: Keyframe, pose: Pose): null;
|
|
18867
18886
|
/**
|
|
18868
18887
|
* This function returns an array containing all [KeyframeMarkers](https://developer.roblox.com/en-us/api-reference/class/KeyframeMarker) that have been added to the [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe). Note, this function will only return [instances](https://developer.roblox.com/en-us/api-reference/class/Instance) of type KeyframeMarker.
|
|
18869
18888
|
*
|
|
@@ -18915,7 +18934,7 @@ interface Keyframe extends Instance {
|
|
|
18915
18934
|
*
|
|
18916
18935
|
* Note, this function will not error when an instance other than a [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose) is given as the pose parameter.
|
|
18917
18936
|
*/
|
|
18918
|
-
RemovePose(this: Keyframe, pose: Pose):
|
|
18937
|
+
RemovePose(this: Keyframe, pose: Pose): null;
|
|
18919
18938
|
}
|
|
18920
18939
|
|
|
18921
18940
|
/** A KeyframeMarker is an instance meant to represent an event that will eventually be fired when a [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) is hit.
|
|
@@ -19604,7 +19623,7 @@ interface Lighting extends Instance {
|
|
|
19604
19623
|
* wait()
|
|
19605
19624
|
* end
|
|
19606
19625
|
*/
|
|
19607
|
-
SetMinutesAfterMidnight(this: Lighting, minutes: number):
|
|
19626
|
+
SetMinutesAfterMidnight(this: Lighting, minutes: number): null;
|
|
19608
19627
|
/**
|
|
19609
19628
|
* This event fires when a [Lighting](https://developer.roblox.com/en-us/api-reference/class/Lighting) property is changed or a [Sky](https://developer.roblox.com/en-us/api-reference/class/Sky) is added or removed from [Lighting](https://developer.roblox.com/en-us/api-reference/class/Lighting).
|
|
19610
19629
|
*
|
|
@@ -20844,11 +20863,11 @@ interface LocalizationTable extends Instance {
|
|
|
20844
20863
|
/**
|
|
20845
20864
|
* Removes an entry from the LocalizationTable, using the specified _key_, _source_, and _context_ to narrow down the specific entry to be removed.
|
|
20846
20865
|
*/
|
|
20847
|
-
RemoveEntry(this: LocalizationTable, key: string, source: string, context: string):
|
|
20866
|
+
RemoveEntry(this: LocalizationTable, key: string, source: string, context: string): null;
|
|
20848
20867
|
/**
|
|
20849
20868
|
* Removes a single language translation from the LocalizationTable, using the provided _key_, _source_, _context_, and _localeId_ to narrow down the specific entry to be removed.
|
|
20850
20869
|
*/
|
|
20851
|
-
RemoveEntryValue(this: LocalizationTable, key: string, source: string, context: string, localeId: string):
|
|
20870
|
+
RemoveEntryValue(this: LocalizationTable, key: string, source: string, context: string, localeId: string): null;
|
|
20852
20871
|
/**
|
|
20853
20872
|
* Deprecated in favor of [LocalizationTable:RemoveEntry](https://developer.roblox.com/en-us/api-reference/function/LocalizationTable/RemoveEntry).
|
|
20854
20873
|
*
|
|
@@ -20858,17 +20877,17 @@ interface LocalizationTable extends Instance {
|
|
|
20858
20877
|
* Tags: Deprecated, [object Object]
|
|
20859
20878
|
* @deprecated
|
|
20860
20879
|
*/
|
|
20861
|
-
RemoveKey(this: LocalizationTable, key: string):
|
|
20880
|
+
RemoveKey(this: LocalizationTable, key: string): null;
|
|
20862
20881
|
/**
|
|
20863
20882
|
* Removes all translations from the LocalizationTable with the specified localeId.
|
|
20864
20883
|
*/
|
|
20865
|
-
RemoveTargetLocale(this: LocalizationTable, localeId: string):
|
|
20884
|
+
RemoveTargetLocale(this: LocalizationTable, localeId: string): null;
|
|
20866
20885
|
/**
|
|
20867
20886
|
* The SetContents function sets the contents of the LocalizationTable, via the legacy JSON format.
|
|
20868
20887
|
* Tags: Deprecated, [object Object]
|
|
20869
20888
|
* @deprecated
|
|
20870
20889
|
*/
|
|
20871
|
-
SetContents(this: LocalizationTable, contents: string):
|
|
20890
|
+
SetContents(this: LocalizationTable, contents: string): null;
|
|
20872
20891
|
/**
|
|
20873
20892
|
* Sets the contents of the LocalizationTable.
|
|
20874
20893
|
*
|
|
@@ -20879,27 +20898,27 @@ interface LocalizationTable extends Instance {
|
|
|
20879
20898
|
* Tags: Deprecated, [object Object]
|
|
20880
20899
|
* @deprecated
|
|
20881
20900
|
*/
|
|
20882
|
-
SetEntry(this: LocalizationTable, key: string, targetLocaleId: string, text: string):
|
|
20901
|
+
SetEntry(this: LocalizationTable, key: string, targetLocaleId: string, text: string): null;
|
|
20883
20902
|
/**
|
|
20884
20903
|
* Sets the **Context** field of a LocalizationTable entry to _newContext_, using the specified _key_, _source_, and _context_ to narrow down the entry that will have this change applied.
|
|
20885
20904
|
*/
|
|
20886
|
-
SetEntryContext(this: LocalizationTable, key: string, source: string, context: string, newContext: string):
|
|
20905
|
+
SetEntryContext(this: LocalizationTable, key: string, source: string, context: string, newContext: string): null;
|
|
20887
20906
|
/**
|
|
20888
20907
|
* Sets the **Example** field of a LocalizationTable entry to _example_, using the specified _key_, _source_, and _context_ to narrow down the entry that will have this change applied.
|
|
20889
20908
|
*/
|
|
20890
|
-
SetEntryExample(this: LocalizationTable, key: string, source: string, context: string, example: string):
|
|
20909
|
+
SetEntryExample(this: LocalizationTable, key: string, source: string, context: string, example: string): null;
|
|
20891
20910
|
/**
|
|
20892
20911
|
* Sets the **Key** field of a LocalizationTable entry to _newKey_, using the specified _key_, _source_, and _context_ to narrow down the entry that will have this change applied.
|
|
20893
20912
|
*/
|
|
20894
|
-
SetEntryKey(this: LocalizationTable, key: string, source: string, context: string, newKey: string):
|
|
20913
|
+
SetEntryKey(this: LocalizationTable, key: string, source: string, context: string, newKey: string): null;
|
|
20895
20914
|
/**
|
|
20896
20915
|
* Sets the **Source** field of a LocalizationTable entry to _newSource_, using the specified _key_, _source_, and _context_ to narrow down the entry that will have this change applied.
|
|
20897
20916
|
*/
|
|
20898
|
-
SetEntrySource(this: LocalizationTable, key: string, source: string, context: string, newSource: string):
|
|
20917
|
+
SetEntrySource(this: LocalizationTable, key: string, source: string, context: string, newSource: string): null;
|
|
20899
20918
|
/**
|
|
20900
20919
|
* Sets the text of the specified localeId in a LocalizationTable entry, using the specified _key_, _source_, and _context_ to narrow down the entry that will have this change applied.
|
|
20901
20920
|
*/
|
|
20902
|
-
SetEntryValue(this: LocalizationTable, key: string, source: string, context: string, localeId: string, text: string):
|
|
20921
|
+
SetEntryValue(this: LocalizationTable, key: string, source: string, context: string, localeId: string, text: string): null;
|
|
20903
20922
|
}
|
|
20904
20923
|
|
|
20905
20924
|
interface CloudLocalizationTable extends LocalizationTable {
|
|
@@ -21166,11 +21185,11 @@ interface MarketplaceService extends Instance {
|
|
|
21166
21185
|
/**
|
|
21167
21186
|
* Used to prompt a user to purchase a bundle with the given bundleId
|
|
21168
21187
|
*/
|
|
21169
|
-
PromptBundlePurchase(this: MarketplaceService, player: Player, bundleId: number):
|
|
21188
|
+
PromptBundlePurchase(this: MarketplaceService, player: Player, bundleId: number): null;
|
|
21170
21189
|
/**
|
|
21171
21190
|
* Used to prompt a user to purchase a game pass with the given assetId.
|
|
21172
21191
|
*/
|
|
21173
|
-
PromptGamePassPurchase(this: MarketplaceService, player: Player, gamePassId: number):
|
|
21192
|
+
PromptGamePassPurchase(this: MarketplaceService, player: Player, gamePassId: number): null;
|
|
21174
21193
|
/**
|
|
21175
21194
|
* Used to prompt a user to purchase Premium. If the user is already premium, the user will receive an error message “You are already subscribed to Roblox Premium! Please try again.”
|
|
21176
21195
|
*
|
|
@@ -21184,7 +21203,7 @@ interface MarketplaceService extends Instance {
|
|
|
21184
21203
|
* * [MarketplaceService.PromptPremiumPurchaseFinished](https://developer.roblox.com/en-us/api-reference/event/MarketplaceService/PromptPremiumPurchaseFinished), fires when the Premium purchase UI closes
|
|
21185
21204
|
* * [Players.PlayerMembershipChanged](https://developer.roblox.com/en-us/api-reference/event/Players/PlayerMembershipChanged), fires when the game server recognizes that a player's membership has changed
|
|
21186
21205
|
*/
|
|
21187
|
-
PromptPremiumPurchase(this: MarketplaceService, player: Player):
|
|
21206
|
+
PromptPremiumPurchase(this: MarketplaceService, player: Player): null;
|
|
21188
21207
|
/**
|
|
21189
21208
|
* Used to prompt a user to purchase a product with the given product id.
|
|
21190
21209
|
*/
|
|
@@ -21213,8 +21232,8 @@ interface MarketplaceService extends Instance {
|
|
|
21213
21232
|
equipIfPurchased?: boolean,
|
|
21214
21233
|
currencyType?: CastsToEnum<Enum.CurrencyType>,
|
|
21215
21234
|
): void;
|
|
21216
|
-
PromptSubscriptionCancellation(this: MarketplaceService, player: Player, subscriptionId: number):
|
|
21217
|
-
PromptSubscriptionPurchase(this: MarketplaceService, player: Player, subscriptionId: number):
|
|
21235
|
+
PromptSubscriptionCancellation(this: MarketplaceService, player: Player, subscriptionId: number): null;
|
|
21236
|
+
PromptSubscriptionPurchase(this: MarketplaceService, player: Player, subscriptionId: number): null;
|
|
21218
21237
|
/**
|
|
21219
21238
|
* Returns a [Pages](https://developer.roblox.com/en-us/api-reference/class/Pages) object which contains information for all of the current game's developer products.
|
|
21220
21239
|
* Tags: Yields
|
|
@@ -21584,7 +21603,7 @@ interface MaterialService extends Instance {
|
|
|
21584
21603
|
readonly _nominal_MaterialService: unique symbol;
|
|
21585
21604
|
GetBaseMaterialOverride(this: MaterialService, material: CastsToEnum<Enum.Material>): string;
|
|
21586
21605
|
GetMaterialVariant(this: MaterialService, material: CastsToEnum<Enum.Material>, name: string): MaterialVariant;
|
|
21587
|
-
SetBaseMaterialOverride(this: MaterialService, material: CastsToEnum<Enum.Material>, name: string):
|
|
21606
|
+
SetBaseMaterialOverride(this: MaterialService, material: CastsToEnum<Enum.Material>, name: string): null;
|
|
21588
21607
|
}
|
|
21589
21608
|
|
|
21590
21609
|
interface MaterialVariant extends Instance {
|
|
@@ -21618,7 +21637,7 @@ interface MemoryStoreQueue extends Instance {
|
|
|
21618
21637
|
* Adds an item to the queue.
|
|
21619
21638
|
* Tags: Yields
|
|
21620
21639
|
*/
|
|
21621
|
-
AddAsync(this: MemoryStoreQueue, value: unknown, expiration: number, priority?: number):
|
|
21640
|
+
AddAsync(this: MemoryStoreQueue, value: unknown, expiration: number, priority?: number): null;
|
|
21622
21641
|
/**
|
|
21623
21642
|
* Reads one or more items from the queue as a single atomic operation.
|
|
21624
21643
|
*
|
|
@@ -21635,7 +21654,7 @@ interface MemoryStoreQueue extends Instance {
|
|
|
21635
21654
|
* 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.
|
|
21636
21655
|
* Tags: Yields
|
|
21637
21656
|
*/
|
|
21638
|
-
RemoveAsync(this: MemoryStoreQueue, id: string):
|
|
21657
|
+
RemoveAsync(this: MemoryStoreQueue, id: string): null;
|
|
21639
21658
|
}
|
|
21640
21659
|
|
|
21641
21660
|
/** 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.
|
|
@@ -21695,7 +21714,7 @@ interface MemoryStoreSortedMap extends Instance {
|
|
|
21695
21714
|
* For a more in-depth look, take a look at the [Memory Store](https://developer.roblox.com/en-us/articles/memory-store) article.
|
|
21696
21715
|
* Tags: Yields
|
|
21697
21716
|
*/
|
|
21698
|
-
RemoveAsync(this: MemoryStoreSortedMap, key: string):
|
|
21717
|
+
RemoveAsync(this: MemoryStoreSortedMap, key: string): null;
|
|
21699
21718
|
/**
|
|
21700
21719
|
* Sets the value of the key overwriting any existing key value.
|
|
21701
21720
|
* Tags: Yields
|
|
@@ -21738,7 +21757,7 @@ interface MeshDataExperimental extends Instance {
|
|
|
21738
21757
|
/**
|
|
21739
21758
|
* Tags: Yields
|
|
21740
21759
|
*/
|
|
21741
|
-
PopulateFromMeshAsync(this: MeshDataExperimental, meshId: string):
|
|
21760
|
+
PopulateFromMeshAsync(this: MeshDataExperimental, meshId: string): null;
|
|
21742
21761
|
}
|
|
21743
21762
|
|
|
21744
21763
|
interface MessageBusConnection extends Instance {
|
|
@@ -21818,7 +21837,7 @@ interface MessagingService extends Instance {
|
|
|
21818
21837
|
* * [MessagingService:SubscribeAsync](https://developer.roblox.com/en-us/api-reference/function/MessagingService/SubscribeAsync), begins listening to the given topic
|
|
21819
21838
|
* Tags: Yields
|
|
21820
21839
|
*/
|
|
21821
|
-
PublishAsync(this: MessagingService, topic: string, message: unknown):
|
|
21840
|
+
PublishAsync(this: MessagingService, topic: string, message: unknown): null;
|
|
21822
21841
|
/**
|
|
21823
21842
|
* This function registers a callback to begin listening to the given topic. The callback is invoked when a topic receives a message. It can be called multiple times for the same topic.
|
|
21824
21843
|
*
|
|
@@ -22434,7 +22453,7 @@ interface PVInstance extends Instance {
|
|
|
22434
22453
|
*
|
|
22435
22454
|
* [Models](https://developer.roblox.com/en-us/api-reference/class/Model) and [BaseParts](https://developer.roblox.com/en-us/api-reference/class/BasePart) are both [PVInstances](https://developer.roblox.com/en-us/api-reference/class/PVInstance) (“Position Velocity Instances”) and so both have this function.
|
|
22436
22455
|
*/
|
|
22437
|
-
PivotTo(this: PVInstance, targetCFrame: CFrame):
|
|
22456
|
+
PivotTo(this: PVInstance, targetCFrame: CFrame): null;
|
|
22438
22457
|
}
|
|
22439
22458
|
|
|
22440
22459
|
/** BasePart is an abstract base class for in-world objects that render and are physically simulated while in the [Workspace](https://developer.roblox.com/en-us/api-reference/class/Workspace). There are several implementations of BasePart, the most common is [Part](https://developer.roblox.com/en-us/api-reference/class/Part), a simple 6-face rectangular prism. Others include [SpawnLocation](https://developer.roblox.com/en-us/api-reference/class/SpawnLocation), [WedgePart](https://developer.roblox.com/en-us/api-reference/class/WedgePart) and the singleton [Terrain](https://developer.roblox.com/en-us/api-reference/class/Terrain) object within the [Workspace](https://developer.roblox.com/en-us/api-reference/class/Workspace). Most of the time, when documentation refers to a part, most BasePart implementations will work and not just [Part](https://developer.roblox.com/en-us/api-reference/class/Part).
|
|
@@ -23157,7 +23176,7 @@ interface BasePart extends PVInstance {
|
|
|
23157
23176
|
*
|
|
23158
23177
|
* If the part is owned by the server, this function must be called on a server [Script](https://developer.roblox.com/en-us/api-reference/class/Script). If the part is owned by a client, this function must be called on a \`LocalScript\`\`.
|
|
23159
23178
|
*/
|
|
23160
|
-
ApplyAngularImpulse(this: BasePart, impulse: Vector3):
|
|
23179
|
+
ApplyAngularImpulse(this: BasePart, impulse: Vector3): null;
|
|
23161
23180
|
/**
|
|
23162
23181
|
* This function applies an instant force impulse to this [part's](https://developer.roblox.com/en-us/api-reference/class/BasePart) assembly.
|
|
23163
23182
|
*
|
|
@@ -23167,7 +23186,7 @@ interface BasePart extends PVInstance {
|
|
|
23167
23186
|
*
|
|
23168
23187
|
* If the part is owned by the server, this function must be called on a server [Script](https://developer.roblox.com/en-us/api-reference/class/Script). If the part is owned by a client, this function must be called on a [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript).
|
|
23169
23188
|
*/
|
|
23170
|
-
ApplyImpulse(this: BasePart, impulse: Vector3):
|
|
23189
|
+
ApplyImpulse(this: BasePart, impulse: Vector3): null;
|
|
23171
23190
|
/**
|
|
23172
23191
|
* This function pplies an instant force impulse to this [part's](https://developer.roblox.com/en-us/api-reference/class/BasePart) assembly, at the specified position in world space.
|
|
23173
23192
|
*
|
|
@@ -23177,13 +23196,13 @@ interface BasePart extends PVInstance {
|
|
|
23177
23196
|
*
|
|
23178
23197
|
* If the part is owned by the server, this function must be called on a server [Script](https://developer.roblox.com/en-us/api-reference/class/Script). If the part is owned by a client, this function must be called on a [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript).
|
|
23179
23198
|
*/
|
|
23180
|
-
ApplyImpulseAtPosition(this: BasePart, impulse: Vector3, position: Vector3):
|
|
23199
|
+
ApplyImpulseAtPosition(this: BasePart, impulse: Vector3, position: Vector3): null;
|
|
23181
23200
|
/**
|
|
23182
23201
|
* Breaks any surface connection with any adjacent part, including [Weld](https://developer.roblox.com/en-us/api-reference/class/Weld) and other [JointInstance](https://developer.roblox.com/en-us/api-reference/class/JointInstance).
|
|
23183
23202
|
* Tags: Deprecated
|
|
23184
23203
|
* @deprecated
|
|
23185
23204
|
*/
|
|
23186
|
-
BreakJoints(this: BasePart):
|
|
23205
|
+
BreakJoints(this: BasePart): null;
|
|
23187
23206
|
/**
|
|
23188
23207
|
* Returns whether the parts can collide with each other or not. This function takes into account the collision groups of the two parts.
|
|
23189
23208
|
*
|
|
@@ -23293,7 +23312,7 @@ interface BasePart extends PVInstance {
|
|
|
23293
23312
|
* Tags: Deprecated
|
|
23294
23313
|
* @deprecated
|
|
23295
23314
|
*/
|
|
23296
|
-
MakeJoints(this: BasePart):
|
|
23315
|
+
MakeJoints(this: BasePart): null;
|
|
23297
23316
|
/**
|
|
23298
23317
|
* Changes the size of an object just like using the Studio resize tool.
|
|
23299
23318
|
*/
|
|
@@ -23614,7 +23633,7 @@ interface Seat extends Part {
|
|
|
23614
23633
|
/**
|
|
23615
23634
|
* Forces the character with the specified [Humanoid](https://developer.roblox.com/api-reference/class/Humanoid "Humanoid") to sit in the Seat.
|
|
23616
23635
|
*/
|
|
23617
|
-
Sit(this: Seat, humanoid: Humanoid):
|
|
23636
|
+
Sit(this: Seat, humanoid: Humanoid): null;
|
|
23618
23637
|
/**
|
|
23619
23638
|
* Tags: Hidden
|
|
23620
23639
|
*/
|
|
@@ -23660,7 +23679,7 @@ interface SkateboardPlatform extends Part {
|
|
|
23660
23679
|
/**
|
|
23661
23680
|
* Adds ''impulseWorld'' to the SkateboardPlatform's [BasePart.Velocity](https://developer.roblox.com/en-us/api-reference/property/BasePart/Velocity).
|
|
23662
23681
|
*/
|
|
23663
|
-
ApplySpecificImpulse(this: SkateboardPlatform, impulseWorld: Vector3):
|
|
23682
|
+
ApplySpecificImpulse(this: SkateboardPlatform, impulseWorld: Vector3): null;
|
|
23664
23683
|
/**
|
|
23665
23684
|
* Fired when the skateboard is equipped.
|
|
23666
23685
|
*/
|
|
@@ -23823,7 +23842,7 @@ interface Terrain extends BasePart {
|
|
|
23823
23842
|
* Tags: Deprecated
|
|
23824
23843
|
* @deprecated
|
|
23825
23844
|
*/
|
|
23826
|
-
AutowedgeCells(this: Terrain, region: Region3int16):
|
|
23845
|
+
AutowedgeCells(this: Terrain, region: Region3int16): null;
|
|
23827
23846
|
/**
|
|
23828
23847
|
* Returns the world position of the center of the terrain cell (x, y, z).
|
|
23829
23848
|
*/
|
|
@@ -23835,7 +23854,7 @@ interface Terrain extends BasePart {
|
|
|
23835
23854
|
/**
|
|
23836
23855
|
* Clears the terrain.
|
|
23837
23856
|
*/
|
|
23838
|
-
Clear(this: Terrain):
|
|
23857
|
+
Clear(this: Terrain): null;
|
|
23839
23858
|
/**
|
|
23840
23859
|
* Stores a chunk of terrain into a [TerrainRegion](https://developer.roblox.com/en-us/api-reference/class/TerrainRegion) object so it can be loaded back later. Note: [TerrainRegion](https://developer.roblox.com/en-us/api-reference/class/TerrainRegion) data does not replicate between server and client.
|
|
23841
23860
|
*/
|
|
@@ -23847,11 +23866,11 @@ interface Terrain extends BasePart {
|
|
|
23847
23866
|
/**
|
|
23848
23867
|
* Fills a ball of smooth terrain in a given space.
|
|
23849
23868
|
*/
|
|
23850
|
-
FillBall(this: Terrain, center: Vector3, radius: number, material: CastsToEnum<Enum.Material>):
|
|
23869
|
+
FillBall(this: Terrain, center: Vector3, radius: number, material: CastsToEnum<Enum.Material>): null;
|
|
23851
23870
|
/**
|
|
23852
23871
|
* Fills a block of smooth terrain with a given location, rotation, size, and material.
|
|
23853
23872
|
*/
|
|
23854
|
-
FillBlock(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>):
|
|
23873
|
+
FillBlock(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>): null;
|
|
23855
23874
|
/**
|
|
23856
23875
|
* Fills a cylinder of smooth terrain in a given space. The space is defined using a CFrame, height, and radius.
|
|
23857
23876
|
*
|
|
@@ -23860,11 +23879,11 @@ interface Terrain extends BasePart {
|
|
|
23860
23879
|
*
|
|
23861
23880
|
* workspace.Terrain:FillCylinder(CFrame.new(0, 50, 0), 5, 30, Enum.Material.Asphalt)
|
|
23862
23881
|
*/
|
|
23863
|
-
FillCylinder(this: Terrain, cframe: CFrame, height: number, radius: number, material: CastsToEnum<Enum.Material>):
|
|
23882
|
+
FillCylinder(this: Terrain, cframe: CFrame, height: number, radius: number, material: CastsToEnum<Enum.Material>): null;
|
|
23864
23883
|
/**
|
|
23865
23884
|
* Fills a [Region3](https://developer.roblox.com/api-reference/datatype/Region3 "Region3") space with smooth terrain.
|
|
23866
23885
|
*/
|
|
23867
|
-
FillRegion(this: Terrain, region: Region3, resolution: number, material: CastsToEnum<Enum.Material>):
|
|
23886
|
+
FillRegion(this: Terrain, region: Region3, resolution: number, material: CastsToEnum<Enum.Material>): null;
|
|
23868
23887
|
/**
|
|
23869
23888
|
* **FillWedge** fills a wedge-shaped volume of Terrain with the given [Material](https://developer.roblox.com/en-us/api-reference/enum/Material) and the area's CFrame and Size. The orientation of the wedge is the same as an equivalent [WedgePart](https://developer.roblox.com/en-us/api-reference/class/WedgePart).
|
|
23870
23889
|
*
|
|
@@ -23874,7 +23893,7 @@ interface Terrain extends BasePart {
|
|
|
23874
23893
|
*
|
|
23875
23894
|
* workspace.Terrain:FillWedge(CFrame.new(0, 50, 0), Vector3.new(20, 20, 20), Enum.Material.Asphalt)
|
|
23876
23895
|
*/
|
|
23877
|
-
FillWedge(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>):
|
|
23896
|
+
FillWedge(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>): null;
|
|
23878
23897
|
/**
|
|
23879
23898
|
* Returns the closest CellMaterial from the legacy terrain engine that matches the smooth terrain voxel specified. CellBlock will always be ''Solid'' and CellOrientation will always be ''NegZ''.
|
|
23880
23899
|
* Tags: Deprecated
|
|
@@ -23894,7 +23913,7 @@ interface Terrain extends BasePart {
|
|
|
23894
23913
|
/**
|
|
23895
23914
|
* Applies a chunk of terrain to the Terrain object. Note: [TerrainRegion](https://developer.roblox.com/en-us/api-reference/class/TerrainRegion) data does not replicate between server and client.
|
|
23896
23915
|
*/
|
|
23897
|
-
PasteRegion(this: Terrain, region: TerrainRegion, corner: Vector3int16, pasteEmptyCells: boolean):
|
|
23916
|
+
PasteRegion(this: Terrain, region: TerrainRegion, corner: Vector3int16, pasteEmptyCells: boolean): null;
|
|
23898
23917
|
/**
|
|
23899
23918
|
* Returns a certain region of [smooth terrain](https://developer.roblox.com/articles/Intro-To-Terrain) in [table format](https://developer.roblox.com/articles/Scripting-With-Terrain#reading-and-writing-voxels). Both of the returned arrays have an additional `Size` property, a [Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3).
|
|
23900
23919
|
* Tags: CustomLuaState
|
|
@@ -23912,7 +23931,7 @@ interface Terrain extends BasePart {
|
|
|
23912
23931
|
*
|
|
23913
23932
|
* When calling this method, the `resolution` parameter must be exactly 4. Additionally, the Region3 must be aligned to the terrain materials grid, i.e. the components of the Region3's minimum and maximum points must be divisible by 4. Use `Region3:ExpandToGrid` to make a region compatible with this function.
|
|
23914
23933
|
*/
|
|
23915
|
-
ReplaceMaterial(this: Terrain, region: Region3, resolution: number, sourceMaterial: CastsToEnum<Enum.Material>, targetMaterial: CastsToEnum<Enum.Material>):
|
|
23934
|
+
ReplaceMaterial(this: Terrain, region: Region3, resolution: number, sourceMaterial: CastsToEnum<Enum.Material>, targetMaterial: CastsToEnum<Enum.Material>): null;
|
|
23916
23935
|
/**
|
|
23917
23936
|
* Sets the occupancy of the specified terrain voxel to 1, and sets it's material to the closest smooth terrain material that matches the CellMaterial.
|
|
23918
23937
|
*
|
|
@@ -23920,7 +23939,7 @@ interface Terrain extends BasePart {
|
|
|
23920
23939
|
* Tags: Deprecated
|
|
23921
23940
|
* @deprecated
|
|
23922
23941
|
*/
|
|
23923
|
-
SetCell(this: Terrain, x: number, y: number, z: number, material: CastsToEnum<Enum.CellMaterial>, block: CastsToEnum<Enum.CellBlock>, orientation: CastsToEnum<Enum.CellOrientation>):
|
|
23942
|
+
SetCell(this: Terrain, x: number, y: number, z: number, material: CastsToEnum<Enum.CellMaterial>, block: CastsToEnum<Enum.CellBlock>, orientation: CastsToEnum<Enum.CellOrientation>): null;
|
|
23924
23943
|
/**
|
|
23925
23944
|
* Sets the occupancy of all terrain voxels in the specified region to 1, and sets their materials to the closest smooth terrain material that matches the CellMaterial.
|
|
23926
23945
|
*
|
|
@@ -23928,11 +23947,11 @@ interface Terrain extends BasePart {
|
|
|
23928
23947
|
* Tags: Deprecated
|
|
23929
23948
|
* @deprecated
|
|
23930
23949
|
*/
|
|
23931
|
-
SetCells(this: Terrain, region: Region3int16, material: CastsToEnum<Enum.CellMaterial>, block: CastsToEnum<Enum.CellBlock>, orientation: CastsToEnum<Enum.CellOrientation>):
|
|
23950
|
+
SetCells(this: Terrain, region: Region3int16, material: CastsToEnum<Enum.CellMaterial>, block: CastsToEnum<Enum.CellBlock>, orientation: CastsToEnum<Enum.CellOrientation>): null;
|
|
23932
23951
|
/**
|
|
23933
23952
|
* Sets current terrain material color for specified terrain material. Terrain material will shift its base color toward specified color.
|
|
23934
23953
|
*/
|
|
23935
|
-
SetMaterialColor(this: Terrain, material: CastsToEnum<Enum.Material>, value: Color3):
|
|
23954
|
+
SetMaterialColor(this: Terrain, material: CastsToEnum<Enum.Material>, value: Color3): null;
|
|
23936
23955
|
/**
|
|
23937
23956
|
* Sets the specified terrain voxel's material to ''Water'' and sets its occupancy to 1. _WaterDirection_ and _WaterForce_ no longer have any effect.
|
|
23938
23957
|
*
|
|
@@ -23940,7 +23959,7 @@ interface Terrain extends BasePart {
|
|
|
23940
23959
|
* Tags: Deprecated
|
|
23941
23960
|
* @deprecated
|
|
23942
23961
|
*/
|
|
23943
|
-
SetWaterCell(this: Terrain, x: number, y: number, z: number, force: CastsToEnum<Enum.WaterForce>, direction: CastsToEnum<Enum.WaterDirection>):
|
|
23962
|
+
SetWaterCell(this: Terrain, x: number, y: number, z: number, force: CastsToEnum<Enum.WaterForce>, direction: CastsToEnum<Enum.WaterDirection>): null;
|
|
23944
23963
|
/**
|
|
23945
23964
|
* Returns the grid cell location that contains the point **position**.
|
|
23946
23965
|
*/
|
|
@@ -24107,7 +24126,7 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
24107
24126
|
* A mesh can only be textured if the mesh has been UV mapped. UV mapping refers to the practice of projecting a texture map onto a mesh. This cannot be done using Roblox Studio and has to be done using an external 3D modelling application such as [Blender](https://www.blender.org/).
|
|
24108
24127
|
*/
|
|
24109
24128
|
TextureID: string;
|
|
24110
|
-
ApplyMesh(this: MeshPart, meshPart: MeshPart):
|
|
24129
|
+
ApplyMesh(this: MeshPart, meshPart: MeshPart): null;
|
|
24111
24130
|
}
|
|
24112
24131
|
|
|
24113
24132
|
/** An abstract class that all parts based on [solid modeling](https://developer.roblox.com/en-us/articles/3d-modeling-with-parts) inherit from. */
|
|
@@ -24295,7 +24314,7 @@ interface VehicleSeat extends BasePart {
|
|
|
24295
24314
|
/**
|
|
24296
24315
|
* Forces the character with the specified [Humanoid](https://developer.roblox.com/api-reference/class/Humanoid "Humanoid") to sit in the VehicleSeat.
|
|
24297
24316
|
*/
|
|
24298
|
-
Sit(this: VehicleSeat, humanoid: Humanoid):
|
|
24317
|
+
Sit(this: VehicleSeat, humanoid: Humanoid): null;
|
|
24299
24318
|
/**
|
|
24300
24319
|
* Tags: Hidden
|
|
24301
24320
|
*/
|
|
@@ -24358,7 +24377,7 @@ interface Model extends PVInstance {
|
|
|
24358
24377
|
* Tags: NotReplicated
|
|
24359
24378
|
*/
|
|
24360
24379
|
WorldPivot: CFrame;
|
|
24361
|
-
AddPersistentPlayer(this: Model, playerInstance?: Player):
|
|
24380
|
+
AddPersistentPlayer(this: Model, playerInstance?: Player): null;
|
|
24362
24381
|
/**
|
|
24363
24382
|
* Breaks connections between `BaseParts`, including surface connections with any adjacent parts, [WeldConstraint](https://developer.roblox.com/en-us/api-reference/class/WeldConstraint)s, and all [Weld](https://developer.roblox.com/en-us/api-reference/class/Weld)s and other [JointInstance](https://developer.roblox.com/en-us/api-reference/class/JointInstance)s.
|
|
24364
24383
|
*
|
|
@@ -24368,7 +24387,7 @@ interface Model extends PVInstance {
|
|
|
24368
24387
|
* Tags: Deprecated
|
|
24369
24388
|
* @deprecated
|
|
24370
24389
|
*/
|
|
24371
|
-
BreakJoints(this: Model):
|
|
24390
|
+
BreakJoints(this: Model): null;
|
|
24372
24391
|
/**
|
|
24373
24392
|
* This function returns a description of a volume that contains all [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) children within a [Model](https://developer.roblox.com/en-us/api-reference/class/Model). The volume's orientation is based on the orientation of the [PrimaryPart](https://developer.roblox.com/en-us/api-reference/property/Model/PrimaryPart), and matches the selection box rendered in Studio when the model is selected. The description is provided in the form of a [CFrame](https://developer.roblox.com/en-us/api-reference/datatype/CFrame) **orientation** and [Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3) **size**.
|
|
24374
24393
|
*
|
|
@@ -24449,7 +24468,7 @@ interface Model extends PVInstance {
|
|
|
24449
24468
|
* Tags: Deprecated
|
|
24450
24469
|
* @deprecated
|
|
24451
24470
|
*/
|
|
24452
|
-
MakeJoints(this: Model):
|
|
24471
|
+
MakeJoints(this: Model): null;
|
|
24453
24472
|
/**
|
|
24454
24473
|
* Moves the [Model.PrimaryPart](https://developer.roblox.com/en-us/api-reference/property/Model/PrimaryPart) to the given position. If a primary part has not been specified then the root part of the model will be used. Because the root part is not deterministic, it is recommended to always set a [Model.PrimaryPart](https://developer.roblox.com/en-us/api-reference/property/Model/PrimaryPart) when using MoveTo.
|
|
24455
24474
|
*
|
|
@@ -24457,21 +24476,21 @@ interface Model extends PVInstance {
|
|
|
24457
24476
|
*
|
|
24458
24477
|
* Note that rotation is not preserved when moving a model with MoveTo. It is recommended to use either [Model:TranslateBy](https://developer.roblox.com/en-us/api-reference/function/Model/TranslateBy) or [Model:SetPrimaryPartCFrame](https://developer.roblox.com/en-us/api-reference/function/Model/SetPrimaryPartCFrame) if the current rotation of the model needs to be preserved.
|
|
24459
24478
|
*/
|
|
24460
|
-
MoveTo(this: Model, position: Vector3):
|
|
24461
|
-
RemovePersistentPlayer(this: Model, playerInstance?: Player):
|
|
24479
|
+
MoveTo(this: Model, position: Vector3): null;
|
|
24480
|
+
RemovePersistentPlayer(this: Model, playerInstance?: Player): null;
|
|
24462
24481
|
/**
|
|
24463
24482
|
* Resets the rotation of the model's parts to the previously set identity rotation, which is done through the [Model:SetIdentityOrientation](https://developer.roblox.com/en-us/api-reference/function/Model/SetIdentityOrientation) method.
|
|
24464
24483
|
* Tags: Deprecated, [object Object]
|
|
24465
24484
|
* @deprecated
|
|
24466
24485
|
*/
|
|
24467
|
-
ResetOrientationToIdentity(this: Model):
|
|
24468
|
-
ScaleTo(this: Model, newScaleFactor: number):
|
|
24486
|
+
ResetOrientationToIdentity(this: Model): null;
|
|
24487
|
+
ScaleTo(this: Model, newScaleFactor: number): null;
|
|
24469
24488
|
/**
|
|
24470
24489
|
* Sets the identity rotation of the given model, allowing you to reset the rotation of the entire model later, through the use of the `ResetOrientationToIdentity` method.
|
|
24471
24490
|
* Tags: Deprecated, [object Object]
|
|
24472
24491
|
* @deprecated
|
|
24473
24492
|
*/
|
|
24474
|
-
SetIdentityOrientation(this: Model):
|
|
24493
|
+
SetIdentityOrientation(this: Model): null;
|
|
24475
24494
|
/**
|
|
24476
24495
|
* This function has been superseded by [PVInstance:PivotTo](https://developer.roblox.com/en-us/api-reference/function/PVInstance/PivotTo) which acts as a more performant replacement and does not change your code's behavior. Use [PVInstance:PivotTo](https://developer.roblox.com/en-us/api-reference/function/PVInstance/PivotTo) for new work and migrate your existing [Model:SetPrimaryPartCFrame](https://developer.roblox.com/en-us/api-reference/function/Model/SetPrimaryPartCFrame) calls when convenient.
|
|
24477
24496
|
*
|
|
@@ -24489,13 +24508,13 @@ interface Model extends PVInstance {
|
|
|
24489
24508
|
* Tags: Deprecated, [object Object]
|
|
24490
24509
|
* @deprecated
|
|
24491
24510
|
*/
|
|
24492
|
-
SetPrimaryPartCFrame(this: Model, cframe: CFrame):
|
|
24511
|
+
SetPrimaryPartCFrame(this: Model, cframe: CFrame): null;
|
|
24493
24512
|
/**
|
|
24494
24513
|
* Shifts a [Model](https://developer.roblox.com/en-us/api-reference/class/Model) by the given `Vector3` offset, preserving the [Model](https://developer.roblox.com/en-us/api-reference/class/Model)'s orientation. If another [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) or [Terrain](https://developer.roblox.com/en-us/api-reference/class/Terrain) already exists at the new position then the [Model](https://developer.roblox.com/en-us/api-reference/class/Model) will overlap said object.
|
|
24495
24514
|
*
|
|
24496
24515
|
* The translation is applied in world space rather than object space, meaning even if the model's parts are orientated differently it will still move along the standard axis.
|
|
24497
24516
|
*/
|
|
24498
|
-
TranslateBy(this: Model, delta: Vector3):
|
|
24517
|
+
TranslateBy(this: Model, delta: Vector3): null;
|
|
24499
24518
|
}
|
|
24500
24519
|
|
|
24501
24520
|
/** This is the Actor Class */
|
|
@@ -24510,7 +24529,7 @@ interface Actor extends Model {
|
|
|
24510
24529
|
readonly _nominal_Actor: unique symbol;
|
|
24511
24530
|
BindToMessage(this: Actor, topic: string, callback: Callback): RBXScriptConnection;
|
|
24512
24531
|
BindToMessageParallel(this: Actor, topic: string, callback: Callback): RBXScriptConnection;
|
|
24513
|
-
SendMessage(this: Actor, topic: string, message: Array<any>):
|
|
24532
|
+
SendMessage(this: Actor, topic: string, message: Array<any>): null;
|
|
24514
24533
|
}
|
|
24515
24534
|
|
|
24516
24535
|
/** BackpackItem is an abstract class for backpack items such as HopperBins and Tools. */
|
|
@@ -24665,7 +24684,7 @@ interface Tool extends BackpackItem {
|
|
|
24665
24684
|
*
|
|
24666
24685
|
* tool.Activated:Connect(toolActivated)
|
|
24667
24686
|
*/
|
|
24668
|
-
Activate(this: Tool):
|
|
24687
|
+
Activate(this: Tool): null;
|
|
24669
24688
|
/**
|
|
24670
24689
|
* The Deactivate function simulates the deactivation of a [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool). The Tool must be equipped for this function to work.
|
|
24671
24690
|
*
|
|
@@ -24687,7 +24706,7 @@ interface Tool extends BackpackItem {
|
|
|
24687
24706
|
*
|
|
24688
24707
|
* tool.Deactivated:Connect(toolDeactivated)
|
|
24689
24708
|
*/
|
|
24690
|
-
Deactivate(this: Tool):
|
|
24709
|
+
Deactivate(this: Tool): null;
|
|
24691
24710
|
/**
|
|
24692
24711
|
* **Activated** is not called if the Ctrl key is pressed during a click.
|
|
24693
24712
|
*
|
|
@@ -24774,7 +24793,7 @@ interface WorldRoot extends Model {
|
|
|
24774
24793
|
*
|
|
24775
24794
|
* The third argument of BulkMoveTo allows you to further speed up movement of the parts by specifying the [Position](https://developer.roblox.com/en-us/api-reference/property/BasePart/Position) and [Orientation](https://developer.roblox.com/en-us/api-reference/property/BasePart/Orientation). Changed events should not be fired on the parts. If you specify FireCFrameChanged as the BulkMoveMode then only CFrame .Changed will be fired, rather than changed firing for Position, Orientation, and CFrame like it normally does.
|
|
24776
24795
|
*/
|
|
24777
|
-
BulkMoveTo(this: WorldRoot, partList: Array<Instance>, cframeList: Array<any>, eventMode?: CastsToEnum<Enum.BulkMoveMode>):
|
|
24796
|
+
BulkMoveTo(this: WorldRoot, partList: Array<Instance>, cframeList: Array<any>, eventMode?: CastsToEnum<Enum.BulkMoveMode>): null;
|
|
24778
24797
|
/**
|
|
24779
24798
|
* **FindPartOnRay** uses [raycasting](https://developer.roblox.com/articles/Raycasting) to find the first [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) or [Terrain](https://developer.roblox.com/en-us/api-reference/class/Terrain) cell intersecting with a given [Ray](https://developer.roblox.com/en-us/api-reference/datatype/Ray). This function returns the [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) or terrain cell hit, the point of intersection, the surface normal at the point of intersection, and the associated [Material](https://developer.roblox.com/en-us/api-reference/enum/Material) hit.
|
|
24780
24799
|
*
|
|
@@ -25323,7 +25342,7 @@ interface Workspace extends WorldRoot {
|
|
|
25323
25342
|
*
|
|
25324
25343
|
* Developers interested in seeing how this function is used in the Roblox Studio should see the [Studio Tools GitHub repository](https://github.com/Roblox/Studio-Tools).
|
|
25325
25344
|
*/
|
|
25326
|
-
JoinToOutsiders(this: Workspace, objects: Array<Instance>, jointType: CastsToEnum<Enum.JointCreationMode>):
|
|
25345
|
+
JoinToOutsiders(this: Workspace, objects: Array<Instance>, jointType: CastsToEnum<Enum.JointCreationMode>): null;
|
|
25327
25346
|
/**
|
|
25328
25347
|
* Returns true if the game has the PGS Physics solver enabled.
|
|
25329
25348
|
*
|
|
@@ -25360,7 +25379,7 @@ interface Workspace extends WorldRoot {
|
|
|
25360
25379
|
*
|
|
25361
25380
|
* Developers interested in seeing how this function is used in the Roblox Studio should see the [Studio Tools GitHub repository](https://github.com/Roblox/Studio-Tools).
|
|
25362
25381
|
*/
|
|
25363
|
-
UnjoinFromOutsiders(this: Workspace, objects: Array<Instance>):
|
|
25382
|
+
UnjoinFromOutsiders(this: Workspace, objects: Array<Instance>): null;
|
|
25364
25383
|
readonly PersistentLoaded: RBXScriptSignal<(player: Player) => void>;
|
|
25365
25384
|
}
|
|
25366
25385
|
|
|
@@ -25466,7 +25485,7 @@ interface Pages<T = unknown> extends Instance {
|
|
|
25466
25485
|
* Iterates to the next page in the pages object, if possible.
|
|
25467
25486
|
* Tags: Yields
|
|
25468
25487
|
*/
|
|
25469
|
-
AdvanceToNextPageAsync(this: Pages):
|
|
25488
|
+
AdvanceToNextPageAsync(this: Pages): null;
|
|
25470
25489
|
}
|
|
25471
25490
|
|
|
25472
25491
|
interface AudioPages extends Pages {
|
|
@@ -25901,13 +25920,13 @@ interface ParticleEmitter extends Instance {
|
|
|
25901
25920
|
*
|
|
25902
25921
|
* Sometimes it is desirable to clear particles before teleporting a character so that there are no lingering effects that might follow due to [ParticleEmitter.LockedToPart](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/LockedToPart).
|
|
25903
25922
|
*/
|
|
25904
|
-
Clear(this: ParticleEmitter):
|
|
25923
|
+
Clear(this: ParticleEmitter): null;
|
|
25905
25924
|
/**
|
|
25906
25925
|
* The Emit method will cause the [ParticleEmitter](https://developer.roblox.com/en-us/api-reference/class/ParticleEmitter) to emit the given number of particles similar to how [ParticleEmitter.Rate](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Rate) does on `ParticleEmitter/Enalbed` emitters. Be warned - this always emits exactly the number of particles even if Roblox' graphics settings are lower. Emitting too many particles can cause performance issues on lower-end hardware.
|
|
25907
25926
|
*
|
|
25908
25927
|
* To clear any emit particles, use [ParticleEmitter:Clear](https://developer.roblox.com/en-us/api-reference/function/ParticleEmitter/Clear).
|
|
25909
25928
|
*/
|
|
25910
|
-
Emit(this: ParticleEmitter, particleCount?: number):
|
|
25929
|
+
Emit(this: ParticleEmitter, particleCount?: number): null;
|
|
25911
25930
|
/**
|
|
25912
25931
|
* Tags: Hidden
|
|
25913
25932
|
*/
|
|
@@ -25999,7 +26018,7 @@ interface Path extends Instance {
|
|
|
25999
26018
|
* * [Pathfinding](https://developer.roblox.com/en-us/articles/pathfinding), provides an in-depth pathfinding walkthrough
|
|
26000
26019
|
* Tags: Yields
|
|
26001
26020
|
*/
|
|
26002
|
-
ComputeAsync(this: Path, start: Vector3, finish: Vector3):
|
|
26021
|
+
ComputeAsync(this: Path, start: Vector3, finish: Vector3): null;
|
|
26003
26022
|
readonly Blocked: RBXScriptSignal<(blockedWaypointIdx: number) => void>;
|
|
26004
26023
|
readonly Unblocked: RBXScriptSignal<(unblockedWaypointIdx: number) => void>;
|
|
26005
26024
|
}
|
|
@@ -26258,7 +26277,7 @@ interface PhysicsService extends Instance {
|
|
|
26258
26277
|
*
|
|
26259
26278
|
* This function will throw an error if either of the groups do not exist.
|
|
26260
26279
|
*/
|
|
26261
|
-
CollisionGroupSetCollidable(this: PhysicsService, name1: string, name2: string, collidable: boolean):
|
|
26280
|
+
CollisionGroupSetCollidable(this: PhysicsService, name1: string, name2: string, collidable: boolean): null;
|
|
26262
26281
|
/**
|
|
26263
26282
|
* Returns whether the two specified collision groups will collide.
|
|
26264
26283
|
*
|
|
@@ -26323,7 +26342,7 @@ interface PhysicsService extends Instance {
|
|
|
26323
26342
|
GetMaxCollisionGroups(this: PhysicsService): number;
|
|
26324
26343
|
GetRegisteredCollisionGroups(this: PhysicsService): unknown;
|
|
26325
26344
|
IsCollisionGroupRegistered(this: PhysicsService, name: string): boolean;
|
|
26326
|
-
RegisterCollisionGroup(this: PhysicsService, name: string):
|
|
26345
|
+
RegisterCollisionGroup(this: PhysicsService, name: string): null;
|
|
26327
26346
|
/**
|
|
26328
26347
|
* Removes the collision group with the given name. If an invalid name is provided the function will not do anything, although if the reserved name “Default” is provided then the function will throw an error.
|
|
26329
26348
|
*
|
|
@@ -26336,7 +26355,7 @@ interface PhysicsService extends Instance {
|
|
|
26336
26355
|
* Tags: Deprecated, [object Object]
|
|
26337
26356
|
* @deprecated
|
|
26338
26357
|
*/
|
|
26339
|
-
RemoveCollisionGroup(this: PhysicsService, name: string):
|
|
26358
|
+
RemoveCollisionGroup(this: PhysicsService, name: string): null;
|
|
26340
26359
|
/**
|
|
26341
26360
|
* Renames the specified collision group. The first argument of this function is the name of the group to rename, the second argument is the new name for the group. If the specified group does not exist, then this function will not do anything.
|
|
26342
26361
|
*
|
|
@@ -26347,7 +26366,7 @@ interface PhysicsService extends Instance {
|
|
|
26347
26366
|
* * Invalid or empty name provided for either argument.
|
|
26348
26367
|
* * The function is called from a client.
|
|
26349
26368
|
*/
|
|
26350
|
-
RenameCollisionGroup(this: PhysicsService, from: string, to: string):
|
|
26369
|
+
RenameCollisionGroup(this: PhysicsService, from: string, to: string): null;
|
|
26351
26370
|
/**
|
|
26352
26371
|
* The SetPartCollisionGroup function sets the collision group of the specified part to the group with the specified name.
|
|
26353
26372
|
*
|
|
@@ -26362,8 +26381,8 @@ interface PhysicsService extends Instance {
|
|
|
26362
26381
|
* Tags: Deprecated, [object Object]
|
|
26363
26382
|
* @deprecated
|
|
26364
26383
|
*/
|
|
26365
|
-
SetPartCollisionGroup(this: PhysicsService, part: BasePart, name: string):
|
|
26366
|
-
UnregisterCollisionGroup(this: PhysicsService, name: string):
|
|
26384
|
+
SetPartCollisionGroup(this: PhysicsService, part: BasePart, name: string): null;
|
|
26385
|
+
UnregisterCollisionGroup(this: PhysicsService, name: string): null;
|
|
26367
26386
|
}
|
|
26368
26387
|
|
|
26369
26388
|
/** A Player object a client that is currently connected. These objects are added to the [Players](https://developer.roblox.com/en-us/api-reference/class/Players) service when a new player connects, then removed when they eventually disconnect from the server.
|
|
@@ -26712,7 +26731,7 @@ interface Player extends Instance {
|
|
|
26712
26731
|
*
|
|
26713
26732
|
* It does not remove [t-shirts](https://developer.roblox.com/en-us/api-reference/class/ShirtGraphic), head meshes, or faces.
|
|
26714
26733
|
*/
|
|
26715
|
-
ClearCharacterAppearance(this: Player):
|
|
26734
|
+
ClearCharacterAppearance(this: Player): null;
|
|
26716
26735
|
/**
|
|
26717
26736
|
* The DistanceFromCharacter [Player](https://developer.roblox.com/en-us/api-reference/class/Player) function returns the distance between the character's head and the given [Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3) point. It returns 0 if the player has no [Player.Character](https://developer.roblox.com/en-us/api-reference/property/Player/Character).
|
|
26718
26737
|
*
|
|
@@ -26807,6 +26826,7 @@ interface Player extends Instance {
|
|
|
26807
26826
|
* This is useful when determining whether a player's appearance has loaded after they first join the game, which can be tracked using the [Players.PlayerAdded](https://developer.roblox.com/en-us/api-reference/event/Players/PlayerAdded) event.
|
|
26808
26827
|
*/
|
|
26809
26828
|
HasAppearanceLoaded(this: Player): boolean;
|
|
26829
|
+
IsVerified(this: Player): boolean;
|
|
26810
26830
|
/**
|
|
26811
26831
|
* The Kick [Player](https://developer.roblox.com/en-us/api-reference/class/Player) method allows a game to gracefully disconnect a client from the game and optionally provide a message to the disconnected player. This is useful for moderating abusive players. When used in conjunction with a [DataStore](https://developer.roblox.com/en-us/api-reference/class/DataStore), it is possible to create ban lists with expiration dates. Only allow specific whitelisted users whom you trust to trigger this method on other players.
|
|
26812
26832
|
*
|
|
@@ -26821,7 +26841,7 @@ interface Player extends Instance {
|
|
|
26821
26841
|
*
|
|
26822
26842
|
* 
|
|
26823
26843
|
*/
|
|
26824
|
-
Kick(this: Player, message?: string):
|
|
26844
|
+
Kick(this: Player, message?: string): null;
|
|
26825
26845
|
/**
|
|
26826
26846
|
* This function returns a boolean value that was previously saved to the player with [Player:SaveBoolean](https://developer.roblox.com/en-us/api-reference/function/Player/SaveBoolean) with the same key. Returns false if the key doesn't exist, not nil.
|
|
26827
26847
|
* Tags: Deprecated
|
|
@@ -26845,7 +26865,7 @@ interface Player extends Instance {
|
|
|
26845
26865
|
* Tags: Deprecated
|
|
26846
26866
|
* @deprecated
|
|
26847
26867
|
*/
|
|
26848
|
-
LoadCharacterAppearance(this: Player, assetInstance: Instance):
|
|
26868
|
+
LoadCharacterAppearance(this: Player, assetInstance: Instance): null;
|
|
26849
26869
|
/**
|
|
26850
26870
|
* This function returns an instance that was previously saved to the player with [Player:SaveInstance](https://developer.roblox.com/en-us/api-reference/function/Player/SaveInstance) with the same key. Returns nil if the key doesn't exist.
|
|
26851
26871
|
* Tags: Deprecated
|
|
@@ -26871,31 +26891,31 @@ interface Player extends Instance {
|
|
|
26871
26891
|
*
|
|
26872
26892
|
* Note that the function's second argument indicates whether the provided [Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3) should move the player relative to world coordinates (_false_) or the player's [Camera](https://developer.roblox.com/en-us/api-reference/class/Camera) (_true_).
|
|
26873
26893
|
*/
|
|
26874
|
-
Move(this: Player, walkDirection: Vector3, relativeToCamera?: boolean):
|
|
26894
|
+
Move(this: Player, walkDirection: Vector3, relativeToCamera?: boolean): null;
|
|
26875
26895
|
/**
|
|
26876
26896
|
* This function is used to save a boolean value that can be loaded again at a later time using [Player:LoadBoolean](https://developer.roblox.com/en-us/api-reference/function/Player/LoadBoolean).
|
|
26877
26897
|
* Tags: Deprecated
|
|
26878
26898
|
* @deprecated
|
|
26879
26899
|
*/
|
|
26880
|
-
SaveBoolean(this: Player, key: string, value: boolean):
|
|
26900
|
+
SaveBoolean(this: Player, key: string, value: boolean): null;
|
|
26881
26901
|
/**
|
|
26882
26902
|
* This function was once used by an ancient data persistence method to save an instance which can be loaded again at a later time using [Player:LoadInstance](https://developer.roblox.com/en-us/api-reference/function/Player/LoadInstance)…
|
|
26883
26903
|
* Tags: Deprecated
|
|
26884
26904
|
* @deprecated
|
|
26885
26905
|
*/
|
|
26886
|
-
SaveInstance(this: Player, key: string, value: Instance):
|
|
26906
|
+
SaveInstance(this: Player, key: string, value: Instance): null;
|
|
26887
26907
|
/**
|
|
26888
26908
|
* This function was once used by an ancient data persistence method to save a number value that can be loaded again at a later time using [Player:LoadNumber](https://developer.roblox.com/en-us/api-reference/function/Player/LoadNumber).
|
|
26889
26909
|
* Tags: Deprecated
|
|
26890
26910
|
* @deprecated
|
|
26891
26911
|
*/
|
|
26892
|
-
SaveNumber(this: Player, key: string, value: number):
|
|
26912
|
+
SaveNumber(this: Player, key: string, value: number): null;
|
|
26893
26913
|
/**
|
|
26894
26914
|
* This function was once used by an ancient data persistence method to save a string value that can be loaded again at a later time using [Player:LoadString](https://developer.roblox.com/en-us/api-reference/function/Player/LoadString).
|
|
26895
26915
|
* Tags: Deprecated
|
|
26896
26916
|
* @deprecated
|
|
26897
26917
|
*/
|
|
26898
|
-
SaveString(this: Player, key: string, value: string):
|
|
26918
|
+
SaveString(this: Player, key: string, value: string): null;
|
|
26899
26919
|
/**
|
|
26900
26920
|
* This function returns a dictionary array of online friends, limited by the `maxFriends` value.
|
|
26901
26921
|
*
|
|
@@ -27091,7 +27111,7 @@ interface Player extends Instance {
|
|
|
27091
27111
|
* For more details, see the [Game Content Streaming](https://developer.roblox.com/en-us/articles/content-streaming) article.
|
|
27092
27112
|
* Tags: Yields
|
|
27093
27113
|
*/
|
|
27094
|
-
RequestStreamAroundAsync(this: Player, position: Vector3, timeOut?: number):
|
|
27114
|
+
RequestStreamAroundAsync(this: Player, position: Vector3, timeOut?: number): null;
|
|
27095
27115
|
/**
|
|
27096
27116
|
* This function is used to pause the script until the player's data is available to manipulate, or until a certain amount of time has elapsed without fetching the player's data
|
|
27097
27117
|
* Tags: Yields, Deprecated
|
|
@@ -27194,35 +27214,35 @@ interface PlayerScripts extends Instance {
|
|
|
27194
27214
|
/**
|
|
27195
27215
|
* Unregisters all ComputerCameraMovementMode enums from the game settings menu.
|
|
27196
27216
|
*/
|
|
27197
|
-
ClearComputerCameraMovementModes(this: PlayerScripts):
|
|
27217
|
+
ClearComputerCameraMovementModes(this: PlayerScripts): null;
|
|
27198
27218
|
/**
|
|
27199
27219
|
* Unregisters all ComputerMovementMode enums from the game settings menu.
|
|
27200
27220
|
*/
|
|
27201
|
-
ClearComputerMovementModes(this: PlayerScripts):
|
|
27221
|
+
ClearComputerMovementModes(this: PlayerScripts): null;
|
|
27202
27222
|
/**
|
|
27203
27223
|
* Unregisters all TouchCameraMovementMode enums from the game settings menu.
|
|
27204
27224
|
*/
|
|
27205
|
-
ClearTouchCameraMovementModes(this: PlayerScripts):
|
|
27225
|
+
ClearTouchCameraMovementModes(this: PlayerScripts): null;
|
|
27206
27226
|
/**
|
|
27207
27227
|
* Unregisters all TouchMovementMode enums from the game settings menu.
|
|
27208
27228
|
*/
|
|
27209
|
-
ClearTouchMovementModes(this: PlayerScripts):
|
|
27229
|
+
ClearTouchMovementModes(this: PlayerScripts): null;
|
|
27210
27230
|
/**
|
|
27211
27231
|
* Registers that a computer camera movement mode is available to be selected from the game menu.
|
|
27212
27232
|
*/
|
|
27213
|
-
RegisterComputerCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.ComputerCameraMovementMode>):
|
|
27233
|
+
RegisterComputerCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.ComputerCameraMovementMode>): null;
|
|
27214
27234
|
/**
|
|
27215
27235
|
* Registers that a computer movement mode is available to be selected from the game menu.
|
|
27216
27236
|
*/
|
|
27217
|
-
RegisterComputerMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.ComputerMovementMode>):
|
|
27237
|
+
RegisterComputerMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.ComputerMovementMode>): null;
|
|
27218
27238
|
/**
|
|
27219
27239
|
* Registers that a touch camera movement mode is available to be selected from the game menu.
|
|
27220
27240
|
*/
|
|
27221
|
-
RegisterTouchCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.TouchCameraMovementMode>):
|
|
27241
|
+
RegisterTouchCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.TouchCameraMovementMode>): null;
|
|
27222
27242
|
/**
|
|
27223
27243
|
* Registers that a touch movement mode is available to be selected from the game menu.
|
|
27224
27244
|
*/
|
|
27225
|
-
RegisterTouchMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.TouchMovementMode>):
|
|
27245
|
+
RegisterTouchMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.TouchMovementMode>): null;
|
|
27226
27246
|
}
|
|
27227
27247
|
|
|
27228
27248
|
/** The Players game service contains only [Player](https://developer.roblox.com/en-us/api-reference/class/Player) objects for presently connected clients to a Roblox game server. It also contains information about a place's configuration (such as bubble chat or classic chat). It can fetch information about players not connected to the server, such as character appearances, friends and avatar thumbnail. */
|
|
@@ -27862,7 +27882,7 @@ interface Pose extends PoseBase {
|
|
|
27862
27882
|
*
|
|
27863
27883
|
* Note, this function will not error when an instance other than a [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose) is given as the pose parameter and will parent it successfully.
|
|
27864
27884
|
*/
|
|
27865
|
-
AddSubPose(this: Pose, pose: Pose):
|
|
27885
|
+
AddSubPose(this: Pose, pose: Pose): null;
|
|
27866
27886
|
/**
|
|
27867
27887
|
* This function returns an array containing all sub [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose)s that have been added to a [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose). This is functionally the same as using the [Instance:GetChildren](https://developer.roblox.com/en-us/api-reference/function/Instance/GetChildren) function on the [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose).
|
|
27868
27888
|
*
|
|
@@ -27874,7 +27894,7 @@ interface Pose extends PoseBase {
|
|
|
27874
27894
|
*
|
|
27875
27895
|
* Note, this function will not error when an instance other than a [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose) is given as the pose parameter and remove it successfully.
|
|
27876
27896
|
*/
|
|
27877
|
-
RemoveSubPose(this: Pose, pose: Pose):
|
|
27897
|
+
RemoveSubPose(this: Pose, pose: Pose): null;
|
|
27878
27898
|
}
|
|
27879
27899
|
|
|
27880
27900
|
/** PostEffect is an abstract base class for post-processing effects, such as [BloomEffect](https://developer.roblox.com/en-us/api-reference/class/BloomEffect) and [ColorCorrectionEffect](https://developer.roblox.com/en-us/api-reference/class/ColorCorrectionEffect). They change how the world looks **after** it has been rendered. They do not affect [GuiObject](https://developer.roblox.com/en-us/api-reference/class/GuiObject)s. Objects of this kind should be parented to the [Lighting](https://developer.roblox.com/en-us/api-reference/class/Lighting) or the [Workspace.CurrentCamera](https://developer.roblox.com/en-us/api-reference/property/Workspace/CurrentCamera) in order to work.
|
|
@@ -28165,11 +28185,11 @@ interface ProximityPrompt extends Instance {
|
|
|
28165
28185
|
/**
|
|
28166
28186
|
* This function triggers a signal indicating that the user began pressing the [ProximityPrompt](https://developer.roblox.com/en-us/api-reference/class/ProximityPrompt) prompt button. It should be used by developers who wish to customize the prompt and trigger it from a prompt GUI button press.
|
|
28167
28187
|
*/
|
|
28168
|
-
InputHoldBegin(this: ProximityPrompt):
|
|
28188
|
+
InputHoldBegin(this: ProximityPrompt): null;
|
|
28169
28189
|
/**
|
|
28170
28190
|
* A counterpoint to [ProximityPrompt:InputHoldBegin](https://developer.roblox.com/en-us/api-reference/function/ProximityPrompt/InputHoldBegin), this signals that the user ended pressing the prompt GUI button.
|
|
28171
28191
|
*/
|
|
28172
|
-
InputHoldEnd(this: ProximityPrompt):
|
|
28192
|
+
InputHoldEnd(this: ProximityPrompt): null;
|
|
28173
28193
|
/**
|
|
28174
28194
|
* This event triggers when a player begins holding down the [key](https://developer.roblox.com/en-us/api-reference/property/ProximityPrompt/KeyboardKeyCode)/button on a prompt with a non-zero [ProximityPrompt.HoldDuration](https://developer.roblox.com/en-us/api-reference/property/ProximityPrompt/HoldDuration). One possible usage includes to animate a hold progress bar.
|
|
28175
28195
|
*/
|
|
@@ -28491,7 +28511,7 @@ interface ReplicatedFirst extends Instance {
|
|
|
28491
28511
|
*
|
|
28492
28512
|
* It is advised to not remove the default loading screen unless the developer wishes to display their own loading screen as an alternative. If the default screen is removed without replacement users will be able to see geometry loading in the background.
|
|
28493
28513
|
*/
|
|
28494
|
-
RemoveDefaultLoadingScreen(this: ReplicatedFirst):
|
|
28514
|
+
RemoveDefaultLoadingScreen(this: ReplicatedFirst): null;
|
|
28495
28515
|
}
|
|
28496
28516
|
|
|
28497
28517
|
/** **ReplicatedStorage** is a general container service for objects that are available to both the server and connected game clients. It is ideal for [ModuleScript](https://developer.roblox.com/en-us/api-reference/class/ModuleScript), [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction), [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and other objects which are useful to both server-side [Script](https://developer.roblox.com/en-us/api-reference/class/Script)s and client-side [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript)s. [Script](https://developer.roblox.com/en-us/api-reference/class/Script) and [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript) objects will not run if they are parented to this service even if they are not [Disabled](https://developer.roblox.com/en-us/api-reference/property/BaseScript/Disabled).
|
|
@@ -28865,7 +28885,7 @@ interface RunService extends Instance {
|
|
|
28865
28885
|
* print("An error occurred: "..message)
|
|
28866
28886
|
* end
|
|
28867
28887
|
*/
|
|
28868
|
-
UnbindFromRenderStep(this: RunService, name: string):
|
|
28888
|
+
UnbindFromRenderStep(this: RunService, name: string): null;
|
|
28869
28889
|
/**
|
|
28870
28890
|
* The Heartbeat event fires every _frame_, after the physics simulation has completed. The _step_ argument indicates the time that has elapsed since the previous frame.
|
|
28871
28891
|
*
|
|
@@ -29100,7 +29120,7 @@ interface SensorBase extends Instance {
|
|
|
29100
29120
|
*/
|
|
29101
29121
|
readonly _nominal_SensorBase: unique symbol;
|
|
29102
29122
|
UpdateType: Enum.SensorUpdateType;
|
|
29103
|
-
Sense(this: SensorBase):
|
|
29123
|
+
Sense(this: SensorBase): null;
|
|
29104
29124
|
readonly OnSensorOutputChanged: RBXScriptSignal<() => void>;
|
|
29105
29125
|
}
|
|
29106
29126
|
|
|
@@ -29571,7 +29591,7 @@ interface UserSettings extends GenericSettings<{ UserGameSettings: UserGameSetti
|
|
|
29571
29591
|
/**
|
|
29572
29592
|
* Erases the saved state of the UserSettings, and restores its values back to default. This function will fail to run correctly from a LocalScript, as it does not have permission to restore all of the properties in the [UserGameSettings](https://developer.roblox.com/en-us/api-reference/class/UserGameSettings) class.
|
|
29573
29593
|
*/
|
|
29574
|
-
Reset(this: UserSettings):
|
|
29594
|
+
Reset(this: UserSettings): null;
|
|
29575
29595
|
}
|
|
29576
29596
|
|
|
29577
29597
|
interface ServiceVisibilityService extends Instance {
|
|
@@ -29606,7 +29626,7 @@ interface SharedTableRegistry extends Instance {
|
|
|
29606
29626
|
*/
|
|
29607
29627
|
readonly _nominal_SharedTableRegistry: unique symbol;
|
|
29608
29628
|
GetSharedTable(this: SharedTableRegistry, name: string): SharedTable;
|
|
29609
|
-
SetSharedTable(this: SharedTableRegistry, name: string, st: SharedTable | undefined):
|
|
29629
|
+
SetSharedTable(this: SharedTableRegistry, name: string, st: SharedTable | undefined): null;
|
|
29610
29630
|
}
|
|
29611
29631
|
|
|
29612
29632
|
interface ShorelineUpgraderService extends Instance {
|
|
@@ -29794,7 +29814,7 @@ interface SocialService extends Instance {
|
|
|
29794
29814
|
*
|
|
29795
29815
|
* Before using this function, you should use the [CanSendGameInviteAsync](https://developer.roblox.com/en-us/api-reference/function/SocialService/CanSendGameInviteAsync) function to determine whether a player can send a game invite, as this can vary depending on the platform or player. After determining that invites are possible for this player, allow the player to opt-in to inviting others. For example, the player clicked on an “Invite Friends” button, shown after `CanSendGameInviteAsync` returned true.\`
|
|
29796
29816
|
*/
|
|
29797
|
-
PromptGameInvite(this: SocialService, player: Player, experienceInviteOptions?: ExperienceInviteOptions):
|
|
29817
|
+
PromptGameInvite(this: SocialService, player: Player, experienceInviteOptions?: ExperienceInviteOptions): null;
|
|
29798
29818
|
/**
|
|
29799
29819
|
* **CanSendGameInviteAsync** indicates whether the given [Player](https://developer.roblox.com/en-us/api-reference/class/Player) can invite other players to the current game. If they can, it returns true.
|
|
29800
29820
|
*
|
|
@@ -30113,7 +30133,7 @@ interface Sound extends Instance {
|
|
|
30113
30133
|
*
|
|
30114
30134
|
* 0
|
|
30115
30135
|
*/
|
|
30116
|
-
Pause(this: Sound):
|
|
30136
|
+
Pause(this: Sound): null;
|
|
30117
30137
|
/**
|
|
30118
30138
|
* Plays the [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound). Sets [Sound.TimePosition](https://developer.roblox.com/en-us/api-reference/property/Sound/TimePosition) to the last value set by a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) (or 0 if it has not been set), and then sets [Sound.Playing](https://developer.roblox.com/en-us/api-reference/property/Sound/Playing) to true.
|
|
30119
30139
|
*
|
|
@@ -30149,7 +30169,7 @@ interface Sound extends Instance {
|
|
|
30149
30169
|
*
|
|
30150
30170
|
* 0
|
|
30151
30171
|
*/
|
|
30152
|
-
Play(this: Sound):
|
|
30172
|
+
Play(this: Sound): null;
|
|
30153
30173
|
/**
|
|
30154
30174
|
* Resumes the [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound). Sets [Sound.Playing](https://developer.roblox.com/en-us/api-reference/property/Sound/Playing) to true. Does not alter [Sound.TimePosition](https://developer.roblox.com/en-us/api-reference/property/Sound/TimePosition) and thus can be used to resume the playback of a sound stopped using [Sound:Pause](https://developer.roblox.com/en-us/api-reference/function/Sound/Pause).
|
|
30155
30175
|
*
|
|
@@ -30185,7 +30205,7 @@ interface Sound extends Instance {
|
|
|
30185
30205
|
*
|
|
30186
30206
|
* 0
|
|
30187
30207
|
*/
|
|
30188
|
-
Resume(this: Sound):
|
|
30208
|
+
Resume(this: Sound): null;
|
|
30189
30209
|
/**
|
|
30190
30210
|
* Stops the [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound). Sets [Sound.Playing](https://developer.roblox.com/en-us/api-reference/property/Sound/Playing) to false then sets [Sound.TimePosition](https://developer.roblox.com/en-us/api-reference/property/Sound/TimePosition) to 0.
|
|
30191
30211
|
*
|
|
@@ -30221,7 +30241,7 @@ interface Sound extends Instance {
|
|
|
30221
30241
|
*
|
|
30222
30242
|
* 0
|
|
30223
30243
|
*/
|
|
30224
|
-
Stop(this: Sound):
|
|
30244
|
+
Stop(this: Sound): null;
|
|
30225
30245
|
/**
|
|
30226
30246
|
* Event that fires whenever the [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) loops. Returns soundId and numOfTimesLooped, giving the contentID of the sound and the number of times looped respectively.
|
|
30227
30247
|
*
|
|
@@ -31667,7 +31687,7 @@ interface Teams extends Instance {
|
|
|
31667
31687
|
* Tags: Deprecated
|
|
31668
31688
|
* @deprecated
|
|
31669
31689
|
*/
|
|
31670
|
-
RebalanceTeams(this: Teams):
|
|
31690
|
+
RebalanceTeams(this: Teams): null;
|
|
31671
31691
|
}
|
|
31672
31692
|
|
|
31673
31693
|
/** This class is an instance that is returned by the `TeleportAsync` function with information about the teleport. */
|
|
@@ -31796,7 +31816,7 @@ interface TeleportOptions extends Instance {
|
|
|
31796
31816
|
*
|
|
31797
31817
|
* For more information on how to teleport players between servers, take a look at the [Telporting Between Places](../../../articles/Teleporting-Between-Places) article.
|
|
31798
31818
|
*/
|
|
31799
|
-
SetTeleportData(this: TeleportOptions, teleportData: unknown):
|
|
31819
|
+
SetTeleportData(this: TeleportOptions, teleportData: unknown): null;
|
|
31800
31820
|
}
|
|
31801
31821
|
|
|
31802
31822
|
/** TeleportService is responsible for transporting [Player](https://developer.roblox.com/en-us/api-reference/class/Player)s between different [places](https://developer.roblox.com/articles/games-and-places) and servers.
|
|
@@ -33225,7 +33245,7 @@ interface Trail extends Instance {
|
|
|
33225
33245
|
*
|
|
33226
33246
|
* Calling this function will only affect old segments that have already been done. It will not affect the drawing of any new trail segments after this function call. If you would like to clear existing trail segments, and temporarily prevent new segments from being drawn, consider toggling the trail's [Trail.Enabled](https://developer.roblox.com/en-us/api-reference/property/Trail/Enabled) property to false at the same time.
|
|
33227
33247
|
*/
|
|
33228
|
-
Clear(this: Trail):
|
|
33248
|
+
Clear(this: Trail): null;
|
|
33229
33249
|
/**
|
|
33230
33250
|
* Tags: Hidden
|
|
33231
33251
|
*/
|
|
@@ -33379,7 +33399,7 @@ interface TweenBase extends Instance {
|
|
|
33379
33399
|
*
|
|
33380
33400
|
* Only the tween variables are reset, not the properties being changed by the tween. This means if you cancel a tween half way through its animation the properties will not reset to their original values. Where Cancel differs from [TweenBase:Pause](https://developer.roblox.com/en-us/api-reference/function/TweenBase/Pause) is that once resumed, it will take the full duration of the tween to complete the animation.
|
|
33381
33401
|
*/
|
|
33382
|
-
Cancel(this: TweenBase):
|
|
33402
|
+
Cancel(this: TweenBase): null;
|
|
33383
33403
|
/**
|
|
33384
33404
|
* The Pause function halts playback of its [Tween](https://developer.roblox.com/en-us/api-reference/class/Tween). However the progress variables of the tween will not be reset, meaning that when [TweenBase:Play](https://developer.roblox.com/en-us/api-reference/function/TweenBase/Play) is called again the tween will resume playback from the moment it was paused.
|
|
33385
33405
|
*
|
|
@@ -33387,13 +33407,13 @@ interface TweenBase extends Instance {
|
|
|
33387
33407
|
*
|
|
33388
33408
|
* This means a tween paused half way through its animation will take half of its duration to complete when resumed.
|
|
33389
33409
|
*/
|
|
33390
|
-
Pause(this: TweenBase):
|
|
33410
|
+
Pause(this: TweenBase): null;
|
|
33391
33411
|
/**
|
|
33392
33412
|
* The Play function starts the playback of its [Tween](https://developer.roblox.com/en-us/api-reference/class/Tween). Note that if a tween has already begun calling Play will have no effect unless the tween has finished or has been stopped (either by [TweenBase:Cancel](https://developer.roblox.com/en-us/api-reference/function/TweenBase/Cancel) or [TweenBase:Pause](https://developer.roblox.com/en-us/api-reference/function/TweenBase/Pause)).
|
|
33393
33413
|
*
|
|
33394
33414
|
* Multiple tweens can be played on the same object at the same time, but they must not be animating the same property. If two tweens attempt to modify the same property, the initial tween will be cancelled and overwritten by the most recent tween (see examples).
|
|
33395
33415
|
*/
|
|
33396
|
-
Play(this: TweenBase):
|
|
33416
|
+
Play(this: TweenBase): null;
|
|
33397
33417
|
/**
|
|
33398
33418
|
* The Completed event of a [Tween](https://developer.roblox.com/en-us/api-reference/class/Tween) fires when the tween finishes playing. This will happen either when the tween naturally finishes playing, or if it is stopped with [TweenBase:Cancel](https://developer.roblox.com/en-us/api-reference/function/TweenBase/Cancel).
|
|
33399
33419
|
*
|
|
@@ -33856,7 +33876,7 @@ interface UIGridStyleLayout extends UILayout {
|
|
|
33856
33876
|
* Tags: Deprecated
|
|
33857
33877
|
* @deprecated
|
|
33858
33878
|
*/
|
|
33859
|
-
ApplyLayout(this: UIGridStyleLayout):
|
|
33879
|
+
ApplyLayout(this: UIGridStyleLayout): null;
|
|
33860
33880
|
/**
|
|
33861
33881
|
* This method is deprecated. Use [UIGridStyleLayout.SortOrder](https://developer.roblox.com/en-us/api-reference/property/UIGridStyleLayout/SortOrder) instead.
|
|
33862
33882
|
*
|
|
@@ -33865,7 +33885,7 @@ interface UIGridStyleLayout extends UILayout {
|
|
|
33865
33885
|
* Tags: Deprecated
|
|
33866
33886
|
* @deprecated
|
|
33867
33887
|
*/
|
|
33868
|
-
SetCustomSortFunction(this: UIGridStyleLayout, callback?: Callback):
|
|
33888
|
+
SetCustomSortFunction(this: UIGridStyleLayout, callback?: Callback): null;
|
|
33869
33889
|
}
|
|
33870
33890
|
|
|
33871
33891
|
/** A UIGridLayout (not to be confused with the abstract [UIGridStyleLayout](https://developer.roblox.com/en-us/api-reference/class/UIGridStyleLayout) from which this class inherits) lays out sibling UI elements in multiple rows within the parent UI element, adding elements to a row one-by-one until the next element would not fit. It then continues adding elements in the next row. A UIGridLayout will take UI elements' [GuiObject.Size](https://developer.roblox.com/en-us/api-reference/property/GuiObject/Size) and [GuiObject.Position](https://developer.roblox.com/en-us/api-reference/property/GuiObject/Position) under control. While under control, these UI elements' properties will not be editable in the Properties window.
|
|
@@ -34011,15 +34031,15 @@ interface UIPageLayout extends UIGridStyleLayout {
|
|
|
34011
34031
|
/**
|
|
34012
34032
|
* If the index is >= 0 and less than the size of the layout, this method acts like [UIPageLayout:JumpTo](https://developer.roblox.com/en-us/api-reference/function/UIPageLayout/JumpTo). If it's out of bounds and circular is set, it will animate the full distance between the in-bounds index of [UIPageLayout.CurrentPage](https://developer.roblox.com/en-us/api-reference/property/UIPageLayout/CurrentPage) and the new index.
|
|
34013
34033
|
*/
|
|
34014
|
-
JumpToIndex(this: UIPageLayout, index: number):
|
|
34034
|
+
JumpToIndex(this: UIPageLayout, index: number): null;
|
|
34015
34035
|
/**
|
|
34016
34036
|
* Sets [UIPageLayout.CurrentPage](https://developer.roblox.com/en-us/api-reference/property/UIPageLayout/CurrentPage) to the page after the current page and animates to it, or does nothing if there isn't a next page.
|
|
34017
34037
|
*/
|
|
34018
|
-
Next(this: UIPageLayout):
|
|
34038
|
+
Next(this: UIPageLayout): null;
|
|
34019
34039
|
/**
|
|
34020
34040
|
* Sets [UIPageLayout.CurrentPage](https://developer.roblox.com/en-us/api-reference/property/UIPageLayout/CurrentPage) to the page before the current page and animates to it, or does nothing if there isn't a previous page.
|
|
34021
34041
|
*/
|
|
34022
|
-
Previous(this: UIPageLayout):
|
|
34042
|
+
Previous(this: UIPageLayout): null;
|
|
34023
34043
|
/**
|
|
34024
34044
|
* Fires when a page comes into view, and is going to be rendered.
|
|
34025
34045
|
*/
|
|
@@ -34393,11 +34413,11 @@ interface UserGameSettings extends Instance {
|
|
|
34393
34413
|
/**
|
|
34394
34414
|
* If called, Roblox toggles the menu option to invert the user's camera y axis.
|
|
34395
34415
|
*/
|
|
34396
|
-
SetCameraYInvertVisible(this: UserGameSettings):
|
|
34416
|
+
SetCameraYInvertVisible(this: UserGameSettings): null;
|
|
34397
34417
|
/**
|
|
34398
34418
|
* If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.
|
|
34399
34419
|
*/
|
|
34400
|
-
SetGamepadCameraSensitivityVisible(this: UserGameSettings):
|
|
34420
|
+
SetGamepadCameraSensitivityVisible(this: UserGameSettings): null;
|
|
34401
34421
|
/**
|
|
34402
34422
|
* Sets the given onboarding as completed, so it won't be shown again to the user the next time they play.
|
|
34403
34423
|
*
|
|
@@ -34410,7 +34430,7 @@ interface UserGameSettings extends Instance {
|
|
|
34410
34430
|
*
|
|
34411
34431
|
* * [UserGameSettings:GetOnboardingCompleted](https://developer.roblox.com/en-us/api-reference/function/UserGameSettings/GetOnboardingCompleted), checks if onboarding has been completed
|
|
34412
34432
|
*/
|
|
34413
|
-
SetOnboardingCompleted(this: UserGameSettings, onboardingId: string):
|
|
34433
|
+
SetOnboardingCompleted(this: UserGameSettings, onboardingId: string): null;
|
|
34414
34434
|
/**
|
|
34415
34435
|
* Fires if the user's full screen mode is changed.
|
|
34416
34436
|
* The event will only fire on desktop devices that can toggle full screen mode. The game will always be in full screen on mobile devices and consoles.
|
|
@@ -35251,7 +35271,7 @@ interface UserInputService extends Instance {
|
|
|
35251
35271
|
*
|
|
35252
35272
|
* Since [UserInputService](https://developer.roblox.com/en-us/api-reference/class/UserInputService) is client-side only, this function can only be used in a [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript).
|
|
35253
35273
|
*/
|
|
35254
|
-
RecenterUserHeadCFrame(this: UserInputService):
|
|
35274
|
+
RecenterUserHeadCFrame(this: UserInputService): null;
|
|
35255
35275
|
/**
|
|
35256
35276
|
* The SetNavigationGamepad function sets whether the specified [UserInputType](https://developer.roblox.com/en-us/api-reference/enum/UserInputType) gamepad can move the GUI navigator. A gamepad that is allowed to move the GUI navigator is considered a _navigation gamepad_.
|
|
35257
35277
|
*
|
|
@@ -35278,7 +35298,7 @@ interface UserInputService extends Instance {
|
|
|
35278
35298
|
* * [UserInputService:GamepadSupports](https://developer.roblox.com/en-us/api-reference/function/UserInputService/GamepadSupports)
|
|
35279
35299
|
* * [UserInputService.GamepadEnabled](https://developer.roblox.com/en-us/api-reference/property/UserInputService/GamepadEnabled)
|
|
35280
35300
|
*/
|
|
35281
|
-
SetNavigationGamepad(this: UserInputService, gamepadEnum: CastsToEnum<Enum.UserInputType>, enabled: boolean):
|
|
35301
|
+
SetNavigationGamepad(this: UserInputService, gamepadEnum: CastsToEnum<Enum.UserInputType>, enabled: boolean): null;
|
|
35282
35302
|
/**
|
|
35283
35303
|
* The DeviceAccelerationChanged event fires when a user moves a device that has an accelerometer.
|
|
35284
35304
|
*
|
|
@@ -36015,7 +36035,7 @@ interface VRService extends Instance {
|
|
|
36015
36035
|
*
|
|
36016
36036
|
* Since `/VRServiceService` only runs client-side, this function will only work when used in a `/LocalScript`.
|
|
36017
36037
|
*/
|
|
36018
|
-
RecenterUserHeadCFrame(this: VRService):
|
|
36038
|
+
RecenterUserHeadCFrame(this: VRService): null;
|
|
36019
36039
|
/**
|
|
36020
36040
|
* The RequestNavigation function requests navigation to the specified [CFrame](https://developer.roblox.com/en-us/api-reference/datatype/CFrame), using the specified [UserCFrame](https://developer.roblox.com/en-us/api-reference/enum/UserCFrame) as the origin for the visualizer parabola.
|
|
36021
36041
|
*
|
|
@@ -36025,7 +36045,7 @@ interface VRService extends Instance {
|
|
|
36025
36045
|
*
|
|
36026
36046
|
* Since VRService only runs client-side, this function will only work when used in a `/LocalScript`.
|
|
36027
36047
|
*/
|
|
36028
|
-
RequestNavigation(this: VRService, cframe: CFrame, inputUserCFrame: CastsToEnum<Enum.UserCFrame>):
|
|
36048
|
+
RequestNavigation(this: VRService, cframe: CFrame, inputUserCFrame: CastsToEnum<Enum.UserCFrame>): null;
|
|
36029
36049
|
/**
|
|
36030
36050
|
* The SetTouchpadMode function sets the mode of the specified [VRTouchpad](https://developer.roblox.com/en-us/api-reference/enum/VRTouchpad) to the specified [VRTouchpadMode](https://developer.roblox.com/en-us/api-reference/enum/VRTouchpadMode).
|
|
36031
36051
|
*
|
|
@@ -36035,7 +36055,7 @@ interface VRService extends Instance {
|
|
|
36035
36055
|
*
|
|
36036
36056
|
* Since `/VRService` only runs client-side, this function will only work when used in a `/LocalScript`.
|
|
36037
36057
|
*/
|
|
36038
|
-
SetTouchpadMode(this: VRService, pad: CastsToEnum<Enum.VRTouchpad>, mode: CastsToEnum<Enum.VRTouchpadMode>):
|
|
36058
|
+
SetTouchpadMode(this: VRService, pad: CastsToEnum<Enum.VRTouchpad>, mode: CastsToEnum<Enum.VRTouchpadMode>): null;
|
|
36039
36059
|
/**
|
|
36040
36060
|
* The NavigationRequested event fires when navigation is requested from the VRService for a specified [UserCFrame](https://developer.roblox.com/en-us/api-reference/enum/UserCFrame) VR device.
|
|
36041
36061
|
*
|
|
@@ -36597,7 +36617,7 @@ interface VoiceChatInternal extends Instance {
|
|
|
36597
36617
|
* Tags: Deprecated
|
|
36598
36618
|
* @deprecated
|
|
36599
36619
|
*/
|
|
36600
|
-
Leave(this: VoiceChatInternal):
|
|
36620
|
+
Leave(this: VoiceChatInternal): null;
|
|
36601
36621
|
/**
|
|
36602
36622
|
* Tags: Deprecated
|
|
36603
36623
|
* @deprecated
|
|
@@ -36607,12 +36627,12 @@ interface VoiceChatInternal extends Instance {
|
|
|
36607
36627
|
* Tags: Deprecated
|
|
36608
36628
|
* @deprecated
|
|
36609
36629
|
*/
|
|
36610
|
-
SetMicDevice(this: VoiceChatInternal, micDeviceName: string, micDeviceGuid: string):
|
|
36630
|
+
SetMicDevice(this: VoiceChatInternal, micDeviceName: string, micDeviceGuid: string): null;
|
|
36611
36631
|
/**
|
|
36612
36632
|
* Tags: Deprecated
|
|
36613
36633
|
* @deprecated
|
|
36614
36634
|
*/
|
|
36615
|
-
SetSpeakerDevice(this: VoiceChatInternal, speakerDeviceName: string, speakerDeviceGuid: string):
|
|
36635
|
+
SetSpeakerDevice(this: VoiceChatInternal, speakerDeviceName: string, speakerDeviceGuid: string): null;
|
|
36616
36636
|
/**
|
|
36617
36637
|
* Tags: Deprecated
|
|
36618
36638
|
* @deprecated
|
|
@@ -36667,21 +36687,6 @@ interface VoiceChatService extends Instance {
|
|
|
36667
36687
|
IsVoiceEnabledForUserIdAsync(this: VoiceChatService, userId: number): boolean;
|
|
36668
36688
|
}
|
|
36669
36689
|
|
|
36670
|
-
interface VoiceSource extends Instance {
|
|
36671
|
-
/**
|
|
36672
|
-
* **DO NOT USE!**
|
|
36673
|
-
*
|
|
36674
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
36675
|
-
* @hidden
|
|
36676
|
-
* @deprecated
|
|
36677
|
-
*/
|
|
36678
|
-
readonly _nominal_VoiceSource: unique symbol;
|
|
36679
|
-
/**
|
|
36680
|
-
* Tags: ReadOnly, NotReplicated
|
|
36681
|
-
*/
|
|
36682
|
-
readonly UserId: number;
|
|
36683
|
-
}
|
|
36684
|
-
|
|
36685
36690
|
/** **WeldConstraints** are used to attach two [parts](https://developer.roblox.com/en-us/api-reference/class/BasePart) together. The constraint makes sure that the parts stay in the same relative position and orientation to one another, meaning that if one part moves, the other will move the same amount. Even if the two parts are not touching one another, they can be welded together with a weld constraint.
|
|
36686
36691
|
*
|
|
36687
36692
|
* The most common way to create a weld constraint is through the Studio **Create** menu in the **Model** tab (select **Weld**). This tool will act differently based on how many parts are selected when the tool is activated:
|