@rbxts/types 1.0.679 → 1.0.681
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 +230 -265
- package/include/generated/PluginSecurity.d.ts +66 -63
- package/include/generated/enums.d.ts +46 -1
- package/include/roblox.d.ts +5 -0
- package/package.json +1 -1
|
@@ -507,7 +507,6 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
507
507
|
ScriptDocument: ScriptDocument;
|
|
508
508
|
ScriptRuntime: ScriptRuntime;
|
|
509
509
|
SensorBase: SensorBase;
|
|
510
|
-
Speaker: Speaker;
|
|
511
510
|
StackFrame: StackFrame;
|
|
512
511
|
StandardPages: StandardPages;
|
|
513
512
|
StarterCharacterScripts: StarterCharacterScripts;
|
|
@@ -643,7 +642,7 @@ interface Instance {
|
|
|
643
642
|
* end
|
|
644
643
|
* end
|
|
645
644
|
*/
|
|
646
|
-
ClearAllChildren(this: Instance):
|
|
645
|
+
ClearAllChildren(this: Instance): void;
|
|
647
646
|
/**
|
|
648
647
|
* **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
648
|
*
|
|
@@ -676,7 +675,7 @@ interface Instance {
|
|
|
676
675
|
*
|
|
677
676
|
* 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
677
|
*/
|
|
679
|
-
Destroy(this: Instance):
|
|
678
|
+
Destroy(this: Instance): void;
|
|
680
679
|
/**
|
|
681
680
|
* 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
681
|
*
|
|
@@ -1329,7 +1328,7 @@ interface AnalyticsService extends Instance {
|
|
|
1329
1328
|
* Tags: Deprecated
|
|
1330
1329
|
* @deprecated
|
|
1331
1330
|
*/
|
|
1332
|
-
FireEvent(this: AnalyticsService, category: string, value: unknown):
|
|
1331
|
+
FireEvent(this: AnalyticsService, category: string, value: unknown): void;
|
|
1333
1332
|
/**
|
|
1334
1333
|
* This function triggers an event used to track player actions pertaining to the in-game economy.
|
|
1335
1334
|
*
|
|
@@ -1616,7 +1615,7 @@ interface KeyframeSequence extends AnimationClip {
|
|
|
1616
1615
|
*
|
|
1617
1616
|
* 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
1617
|
*/
|
|
1619
|
-
AddKeyframe(this: KeyframeSequence, keyframe: Keyframe):
|
|
1618
|
+
AddKeyframe(this: KeyframeSequence, keyframe: Keyframe): void;
|
|
1620
1619
|
/**
|
|
1621
1620
|
* **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
1621
|
*/
|
|
@@ -1628,7 +1627,7 @@ interface KeyframeSequence extends AnimationClip {
|
|
|
1628
1627
|
*
|
|
1629
1628
|
* 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
1629
|
*/
|
|
1631
|
-
RemoveKeyframe(this: KeyframeSequence, keyframe: Keyframe):
|
|
1630
|
+
RemoveKeyframe(this: KeyframeSequence, keyframe: Keyframe): void;
|
|
1632
1631
|
}
|
|
1633
1632
|
|
|
1634
1633
|
interface AnimationClipProvider extends Instance {
|
|
@@ -1915,7 +1914,7 @@ interface AnimationTrack extends Instance {
|
|
|
1915
1914
|
* 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
1915
|
* Tags: CustomLuaState
|
|
1917
1916
|
*/
|
|
1918
|
-
AdjustSpeed(this: AnimationTrack, speed?: number):
|
|
1917
|
+
AdjustSpeed(this: AnimationTrack, speed?: number): void;
|
|
1919
1918
|
/**
|
|
1920
1919
|
* 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
1920
|
*
|
|
@@ -1930,7 +1929,7 @@ interface AnimationTrack extends Instance {
|
|
|
1930
1929
|
* 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
1930
|
* Tags: CustomLuaState
|
|
1932
1931
|
*/
|
|
1933
|
-
AdjustWeight(this: AnimationTrack, weight?: number, fadeTime?: number):
|
|
1932
|
+
AdjustWeight(this: AnimationTrack, weight?: number, fadeTime?: number): void;
|
|
1934
1933
|
/**
|
|
1935
1934
|
* 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
1935
|
*
|
|
@@ -1971,7 +1970,7 @@ interface AnimationTrack extends Instance {
|
|
|
1971
1970
|
* 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
1971
|
* Tags: CustomLuaState
|
|
1973
1972
|
*/
|
|
1974
|
-
Play(this: AnimationTrack, fadeTime?: number, weight?: number, speed?: number):
|
|
1973
|
+
Play(this: AnimationTrack, fadeTime?: number, weight?: number, speed?: number): void;
|
|
1975
1974
|
/**
|
|
1976
1975
|
* 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
1976
|
*
|
|
@@ -1980,7 +1979,7 @@ interface AnimationTrack extends Instance {
|
|
|
1980
1979
|
* 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
1980
|
* Tags: CustomLuaState
|
|
1982
1981
|
*/
|
|
1983
|
-
Stop(this: AnimationTrack, fadeTime?: number):
|
|
1982
|
+
Stop(this: AnimationTrack, fadeTime?: number): void;
|
|
1984
1983
|
/**
|
|
1985
1984
|
* 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
1985
|
*
|
|
@@ -2298,7 +2297,7 @@ interface AssetService extends Instance {
|
|
|
2298
2297
|
* 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
2298
|
* Tags: Yields
|
|
2300
2299
|
*/
|
|
2301
|
-
SavePlaceAsync(this: AssetService):
|
|
2300
|
+
SavePlaceAsync(this: AssetService): void;
|
|
2302
2301
|
/**
|
|
2303
2302
|
* Tags: Yields
|
|
2304
2303
|
*/
|
|
@@ -2509,13 +2508,13 @@ interface Attachment extends Instance {
|
|
|
2509
2508
|
* Tags: Deprecated, [object Object]
|
|
2510
2509
|
* @deprecated
|
|
2511
2510
|
*/
|
|
2512
|
-
SetAxis(this: Attachment, axis: Vector3):
|
|
2511
|
+
SetAxis(this: Attachment, axis: Vector3): void;
|
|
2513
2512
|
/**
|
|
2514
2513
|
* Sets the value of the Attachment's [Attachment.SecondaryAxis](https://developer.roblox.com/en-us/api-reference/property/Attachment/SecondaryAxis).
|
|
2515
2514
|
* Tags: Deprecated, [object Object]
|
|
2516
2515
|
* @deprecated
|
|
2517
2516
|
*/
|
|
2518
|
-
SetSecondaryAxis(this: Attachment, axis: Vector3):
|
|
2517
|
+
SetSecondaryAxis(this: Attachment, axis: Vector3): void;
|
|
2519
2518
|
}
|
|
2520
2519
|
|
|
2521
2520
|
interface Bone extends Attachment {
|
|
@@ -2606,31 +2605,31 @@ interface AvatarEditorService extends Instance {
|
|
|
2606
2605
|
/**
|
|
2607
2606
|
* 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
2607
|
*/
|
|
2609
|
-
PromptAllowInventoryReadAccess(this: AvatarEditorService):
|
|
2608
|
+
PromptAllowInventoryReadAccess(this: AvatarEditorService): void;
|
|
2610
2609
|
/**
|
|
2611
2610
|
* 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
2611
|
*/
|
|
2613
|
-
PromptCreateOutfit(this: AvatarEditorService, outfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>):
|
|
2612
|
+
PromptCreateOutfit(this: AvatarEditorService, outfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): void;
|
|
2614
2613
|
/**
|
|
2615
2614
|
* 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
2615
|
*/
|
|
2617
|
-
PromptDeleteOutfit(this: AvatarEditorService, outfitId: number):
|
|
2616
|
+
PromptDeleteOutfit(this: AvatarEditorService, outfitId: number): void;
|
|
2618
2617
|
/**
|
|
2619
2618
|
* 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
2619
|
*/
|
|
2621
|
-
PromptRenameOutfit(this: AvatarEditorService, outfitId: number):
|
|
2620
|
+
PromptRenameOutfit(this: AvatarEditorService, outfitId: number): void;
|
|
2622
2621
|
/**
|
|
2623
2622
|
* 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
2623
|
*/
|
|
2625
|
-
PromptSaveAvatar(this: AvatarEditorService, humanoidDescription: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>):
|
|
2624
|
+
PromptSaveAvatar(this: AvatarEditorService, humanoidDescription: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): void;
|
|
2626
2625
|
/**
|
|
2627
2626
|
* 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
2627
|
*/
|
|
2629
|
-
PromptSetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>, shouldFavorite: boolean):
|
|
2628
|
+
PromptSetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>, shouldFavorite: boolean): void;
|
|
2630
2629
|
/**
|
|
2631
2630
|
* 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
2631
|
*/
|
|
2633
|
-
PromptUpdateOutfit(this: AvatarEditorService, outfitId: number, updatedOutfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>):
|
|
2632
|
+
PromptUpdateOutfit(this: AvatarEditorService, outfitId: number, updatedOutfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): void;
|
|
2634
2633
|
/**
|
|
2635
2634
|
* 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
2635
|
*
|
|
@@ -3389,7 +3388,7 @@ interface PlayerGui extends BasePlayerGui {
|
|
|
3389
3388
|
* Tags: Deprecated
|
|
3390
3389
|
* @deprecated
|
|
3391
3390
|
*/
|
|
3392
|
-
SetTopbarTransparency(this: PlayerGui, transparency: number):
|
|
3391
|
+
SetTopbarTransparency(this: PlayerGui, transparency: number): void;
|
|
3393
3392
|
/**
|
|
3394
3393
|
* Fires when the transparency of the Topbar CoreGui changes.
|
|
3395
3394
|
* Tags: Deprecated
|
|
@@ -4104,7 +4103,7 @@ interface StarterGui extends BasePlayerGui {
|
|
|
4104
4103
|
*
|
|
4105
4104
|
* 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).
|
|
4106
4105
|
*/
|
|
4107
|
-
SetCoreGuiEnabled(this: StarterGui, coreGuiType: CastsToEnum<Enum.CoreGuiType>, enabled: boolean):
|
|
4106
|
+
SetCoreGuiEnabled(this: StarterGui, coreGuiType: CastsToEnum<Enum.CoreGuiType>, enabled: boolean): void;
|
|
4108
4107
|
/**
|
|
4109
4108
|
* 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.
|
|
4110
4109
|
*
|
|
@@ -4685,7 +4684,7 @@ interface Beam extends Instance {
|
|
|
4685
4684
|
* * If the [Beam.Texture](https://developer.roblox.com/en-us/api-reference/property/Beam/Texture) property is not set, this function will do nothing
|
|
4686
4685
|
* * 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
|
|
4687
4686
|
*/
|
|
4688
|
-
SetTextureOffset(this: Beam, offset?: number):
|
|
4687
|
+
SetTextureOffset(this: Beam, offset?: number): void;
|
|
4689
4688
|
}
|
|
4690
4689
|
|
|
4691
4690
|
/** 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.
|
|
@@ -5393,11 +5392,11 @@ interface RocketPropulsion extends BodyMover {
|
|
|
5393
5392
|
/**
|
|
5394
5393
|
* Causes the Rocket to stop moving towards its target, making it fall.
|
|
5395
5394
|
*/
|
|
5396
|
-
Abort(this: RocketPropulsion):
|
|
5395
|
+
Abort(this: RocketPropulsion): void;
|
|
5397
5396
|
/**
|
|
5398
5397
|
* Causes the rocket to fly towards Target.
|
|
5399
5398
|
*/
|
|
5400
|
-
Fire(this: RocketPropulsion):
|
|
5399
|
+
Fire(this: RocketPropulsion): void;
|
|
5401
5400
|
/**
|
|
5402
5401
|
* 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.
|
|
5403
5402
|
*/
|
|
@@ -5857,7 +5856,7 @@ interface Camera extends Instance {
|
|
|
5857
5856
|
* Tags: Deprecated
|
|
5858
5857
|
* @deprecated
|
|
5859
5858
|
*/
|
|
5860
|
-
Interpolate(this: Camera, endPos: CFrame, endFocus: CFrame, duration: number):
|
|
5859
|
+
Interpolate(this: Camera, endPos: CFrame, endFocus: CFrame, duration: number): void;
|
|
5861
5860
|
/**
|
|
5862
5861
|
* 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.
|
|
5863
5862
|
*
|
|
@@ -5872,7 +5871,7 @@ interface Camera extends Instance {
|
|
|
5872
5871
|
* Tags: Deprecated
|
|
5873
5872
|
* @deprecated
|
|
5874
5873
|
*/
|
|
5875
|
-
PanUnits(this: Camera, units: number):
|
|
5874
|
+
PanUnits(this: Camera, units: number): void;
|
|
5876
5875
|
/**
|
|
5877
5876
|
* 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).
|
|
5878
5877
|
*
|
|
@@ -5893,7 +5892,7 @@ interface Camera extends Instance {
|
|
|
5893
5892
|
*
|
|
5894
5893
|
* SetCameraPan mode has no effect on PC / Mac users.
|
|
5895
5894
|
*/
|
|
5896
|
-
SetCameraPanMode(this: Camera, mode?: CastsToEnum<Enum.CameraPanMode>):
|
|
5895
|
+
SetCameraPanMode(this: Camera, mode?: CastsToEnum<Enum.CameraPanMode>): void;
|
|
5897
5896
|
/**
|
|
5898
5897
|
* This function is outdated and no longer considered best practice.
|
|
5899
5898
|
*
|
|
@@ -5917,7 +5916,7 @@ interface Camera extends Instance {
|
|
|
5917
5916
|
* local rollCFrame = CFrame.Angles(0, 0, roll)
|
|
5918
5917
|
* workspace.CurrentCamera.CFrame = currentCFrame \* rollCFrame
|
|
5919
5918
|
*/
|
|
5920
|
-
SetRoll(this: Camera, rollAngle: number):
|
|
5919
|
+
SetRoll(this: Camera, rollAngle: number): void;
|
|
5921
5920
|
/**
|
|
5922
5921
|
* 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.
|
|
5923
5922
|
*
|
|
@@ -5997,7 +5996,7 @@ interface Camera extends Instance {
|
|
|
5997
5996
|
* 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).
|
|
5998
5997
|
*/
|
|
5999
5998
|
WorldToViewportPoint(this: Camera, worldPoint: Vector3): LuaTuple<[Vector3, boolean]>;
|
|
6000
|
-
ZoomToExtents(this: Camera, boundingBoxCFrame: CFrame, boundingBoxSize: Vector3):
|
|
5999
|
+
ZoomToExtents(this: Camera, boundingBoxCFrame: CFrame, boundingBoxSize: Vector3): void;
|
|
6001
6000
|
/**
|
|
6002
6001
|
* 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.
|
|
6003
6002
|
*
|
|
@@ -6310,7 +6309,7 @@ interface Chat extends Instance {
|
|
|
6310
6309
|
*
|
|
6311
6310
|
* _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.
|
|
6312
6311
|
*/
|
|
6313
|
-
Chat(this: Chat, partOrCharacter: BasePart | Model, message: string, color?: CastsToEnum<Enum.ChatColor>):
|
|
6312
|
+
Chat(this: Chat, partOrCharacter: BasePart | Model, message: string, color?: CastsToEnum<Enum.ChatColor>): void;
|
|
6314
6313
|
/**
|
|
6315
6314
|
* 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.
|
|
6316
6315
|
*
|
|
@@ -6343,7 +6342,7 @@ interface Chat extends Instance {
|
|
|
6343
6342
|
* * Set `message.ShouldDeliver` to false in order to cancel delivery of the message to players (useful for implementing a chat blacklist)
|
|
6344
6343
|
* * Get/set the speaker's name color (`message.ExtraData.NameColor`, a Color3) on a message-by-message basis
|
|
6345
6344
|
*/
|
|
6346
|
-
RegisterChatCallback(this: Chat, callbackType: CastsToEnum<Enum.ChatCallbackType>, callbackFunction: Callback):
|
|
6345
|
+
RegisterChatCallback(this: Chat, callbackType: CastsToEnum<Enum.ChatCallbackType>, callbackFunction: Callback): void;
|
|
6347
6346
|
/**
|
|
6348
6347
|
* **Note**
|
|
6349
6348
|
*
|
|
@@ -6357,7 +6356,7 @@ interface Chat extends Instance {
|
|
|
6357
6356
|
*
|
|
6358
6357
|
* This function is client-side only, attempting to call it on the server will trigger an error.
|
|
6359
6358
|
*/
|
|
6360
|
-
SetBubbleChatSettings(this: Chat, settings: unknown):
|
|
6359
|
+
SetBubbleChatSettings(this: Chat, settings: unknown): void;
|
|
6361
6360
|
/**
|
|
6362
6361
|
* 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.
|
|
6363
6362
|
* Tags: Yields
|
|
@@ -6573,7 +6572,7 @@ interface CollectionService extends Instance {
|
|
|
6573
6572
|
*
|
|
6574
6573
|
* **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).
|
|
6575
6574
|
*/
|
|
6576
|
-
AddTag(this: CollectionService, instance: Instance, tag: string):
|
|
6575
|
+
AddTag(this: CollectionService, instance: Instance, tag: string): void;
|
|
6577
6576
|
GetAllTags(this: CollectionService): unknown;
|
|
6578
6577
|
/**
|
|
6579
6578
|
* GetInstanceAdded is given a tag (a string) and returns a signal which fires under two conditions:
|
|
@@ -6630,7 +6629,7 @@ interface CollectionService extends Instance {
|
|
|
6630
6629
|
*
|
|
6631
6630
|
* 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.
|
|
6632
6631
|
*/
|
|
6633
|
-
RemoveTag(this: CollectionService, instance: Instance, tag: string):
|
|
6632
|
+
RemoveTag(this: CollectionService, instance: Instance, tag: string): void;
|
|
6634
6633
|
/**
|
|
6635
6634
|
* 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).
|
|
6636
6635
|
* Tags: Deprecated, [object Object]
|
|
@@ -8085,13 +8084,13 @@ interface ContentProvider extends Instance {
|
|
|
8085
8084
|
* Tags: Deprecated, [object Object]
|
|
8086
8085
|
* @deprecated
|
|
8087
8086
|
*/
|
|
8088
|
-
Preload(this: ContentProvider, contentId: string):
|
|
8089
|
-
RegisterDefaultEncryptionKey(this: ContentProvider, encryptionKey: string):
|
|
8090
|
-
RegisterDefaultSessionKey(this: ContentProvider, sessionKey: string):
|
|
8091
|
-
RegisterEncryptedAsset(this: ContentProvider, assetId: string, encryptionKey: string):
|
|
8092
|
-
RegisterSessionEncryptedAsset(this: ContentProvider, contentId: string, sessionKey: string):
|
|
8093
|
-
UnregisterDefaultEncryptionKey(this: ContentProvider):
|
|
8094
|
-
UnregisterEncryptedAsset(this: ContentProvider, assetId: string):
|
|
8087
|
+
Preload(this: ContentProvider, contentId: string): void;
|
|
8088
|
+
RegisterDefaultEncryptionKey(this: ContentProvider, encryptionKey: string): void;
|
|
8089
|
+
RegisterDefaultSessionKey(this: ContentProvider, sessionKey: string): void;
|
|
8090
|
+
RegisterEncryptedAsset(this: ContentProvider, assetId: string, encryptionKey: string): void;
|
|
8091
|
+
RegisterSessionEncryptedAsset(this: ContentProvider, contentId: string, sessionKey: string): void;
|
|
8092
|
+
UnregisterDefaultEncryptionKey(this: ContentProvider): void;
|
|
8093
|
+
UnregisterEncryptedAsset(this: ContentProvider, assetId: string): void;
|
|
8095
8094
|
/**
|
|
8096
8095
|
* 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.
|
|
8097
8096
|
*
|
|
@@ -8102,7 +8101,7 @@ interface ContentProvider extends Instance {
|
|
|
8102
8101
|
*/
|
|
8103
8102
|
PreloadAsync(
|
|
8104
8103
|
this: ContentProvider,
|
|
8105
|
-
contentIdList: Array<Instance>,
|
|
8104
|
+
contentIdList: Array<Instance | string>,
|
|
8106
8105
|
callback?: (contentId: string, status: Enum.AssetFetchStatus) => void,
|
|
8107
8106
|
): void;
|
|
8108
8107
|
readonly AssetFetchFailed: RBXScriptSignal<(assetId: string) => void>;
|
|
@@ -8243,13 +8242,13 @@ interface ContextActionService extends Instance {
|
|
|
8243
8242
|
* Tags: Deprecated, [object Object]
|
|
8244
8243
|
* @deprecated
|
|
8245
8244
|
*/
|
|
8246
|
-
BindActionToInputTypes(this: ContextActionService, actionName: string, functionToBind: Callback, createTouchButton: boolean, inputTypes: Array<any>):
|
|
8245
|
+
BindActionToInputTypes(this: ContextActionService, actionName: string, functionToBind: Callback, createTouchButton: boolean, inputTypes: Array<any>): void;
|
|
8247
8246
|
/**
|
|
8248
8247
|
* 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).
|
|
8249
8248
|
*
|
|
8250
8249
|
* 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.
|
|
8251
8250
|
*/
|
|
8252
|
-
BindActivate(this: ContextActionService, userInputTypeForActivation: CastsToEnum<Enum.UserInputType>, keyCodesForActivation: Array<any>):
|
|
8251
|
+
BindActivate(this: ContextActionService, userInputTypeForActivation: CastsToEnum<Enum.UserInputType>, keyCodesForActivation: Array<any>): void;
|
|
8253
8252
|
/**
|
|
8254
8253
|
* 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.
|
|
8255
8254
|
*/
|
|
@@ -8318,39 +8317,39 @@ interface ContextActionService extends Instance {
|
|
|
8318
8317
|
*
|
|
8319
8318
|
* 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.
|
|
8320
8319
|
*/
|
|
8321
|
-
SetDescription(this: ContextActionService, actionName: string, description: string):
|
|
8320
|
+
SetDescription(this: ContextActionService, actionName: string, description: string): void;
|
|
8322
8321
|
/**
|
|
8323
8322
|
* 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.
|
|
8324
8323
|
*
|
|
8325
8324
|
* 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).
|
|
8326
8325
|
*/
|
|
8327
|
-
SetImage(this: ContextActionService, actionName: string, image: string):
|
|
8326
|
+
SetImage(this: ContextActionService, actionName: string, image: string): void;
|
|
8328
8327
|
/**
|
|
8329
8328
|
* 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.
|
|
8330
8329
|
*
|
|
8331
8330
|
* 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).
|
|
8332
8331
|
*/
|
|
8333
|
-
SetPosition(this: ContextActionService, actionName: string, position: UDim2):
|
|
8332
|
+
SetPosition(this: ContextActionService, actionName: string, position: UDim2): void;
|
|
8334
8333
|
/**
|
|
8335
8334
|
* 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.
|
|
8336
8335
|
*
|
|
8337
8336
|
* 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).
|
|
8338
8337
|
*/
|
|
8339
|
-
SetTitle(this: ContextActionService, actionName: string, title: string):
|
|
8338
|
+
SetTitle(this: ContextActionService, actionName: string, title: string): void;
|
|
8340
8339
|
/**
|
|
8341
8340
|
* 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.
|
|
8342
8341
|
*
|
|
8343
8342
|
* 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.
|
|
8344
8343
|
*/
|
|
8345
|
-
UnbindAction(this: ContextActionService, actionName: string):
|
|
8344
|
+
UnbindAction(this: ContextActionService, actionName: string): void;
|
|
8346
8345
|
/**
|
|
8347
8346
|
* 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.
|
|
8348
8347
|
*/
|
|
8349
|
-
UnbindActivate(this: ContextActionService, userInputTypeForActivation: CastsToEnum<Enum.UserInputType>, keyCodeForActivation?: CastsToEnum<Enum.KeyCode>):
|
|
8348
|
+
UnbindActivate(this: ContextActionService, userInputTypeForActivation: CastsToEnum<Enum.UserInputType>, keyCodeForActivation?: CastsToEnum<Enum.KeyCode>): void;
|
|
8350
8349
|
/**
|
|
8351
8350
|
* 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.
|
|
8352
8351
|
*/
|
|
8353
|
-
UnbindAllActions(this: ContextActionService):
|
|
8352
|
+
UnbindAllActions(this: ContextActionService): void;
|
|
8354
8353
|
/**
|
|
8355
8354
|
* 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.
|
|
8356
8355
|
*
|
|
@@ -8381,7 +8380,7 @@ interface Controller extends Instance {
|
|
|
8381
8380
|
/**
|
|
8382
8381
|
* Activates an overriding bind on the specified button.
|
|
8383
8382
|
*/
|
|
8384
|
-
BindButton(this: Controller, button: CastsToEnum<Enum.Button>, caption: string):
|
|
8383
|
+
BindButton(this: Controller, button: CastsToEnum<Enum.Button>, caption: string): void;
|
|
8385
8384
|
/**
|
|
8386
8385
|
* Returns whether or not Button is being pressed.
|
|
8387
8386
|
*/
|
|
@@ -8389,7 +8388,7 @@ interface Controller extends Instance {
|
|
|
8389
8388
|
/**
|
|
8390
8389
|
* Removes the bind on button.
|
|
8391
8390
|
*/
|
|
8392
|
-
UnbindButton(this: Controller, button: CastsToEnum<Enum.Button>):
|
|
8391
|
+
UnbindButton(this: Controller, button: CastsToEnum<Enum.Button>): void;
|
|
8393
8392
|
/**
|
|
8394
8393
|
* 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.
|
|
8395
8394
|
*/
|
|
@@ -8914,7 +8913,7 @@ interface DataStoreIncrementOptions extends Instance {
|
|
|
8914
8913
|
*
|
|
8915
8914
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
8916
8915
|
*/
|
|
8917
|
-
SetMetadata(this: DataStoreIncrementOptions, attributes: object):
|
|
8916
|
+
SetMetadata(this: DataStoreIncrementOptions, attributes: object): void;
|
|
8918
8917
|
}
|
|
8919
8918
|
|
|
8920
8919
|
/** 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).
|
|
@@ -9136,7 +9135,7 @@ interface DataStoreOptions extends Instance {
|
|
|
9136
9135
|
*
|
|
9137
9136
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
9138
9137
|
*/
|
|
9139
|
-
SetExperimentalFeatures(this: DataStoreOptions, experimentalFeatures: object):
|
|
9138
|
+
SetExperimentalFeatures(this: DataStoreOptions, experimentalFeatures: object): void;
|
|
9140
9139
|
}
|
|
9141
9140
|
|
|
9142
9141
|
/** **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).
|
|
@@ -9217,7 +9216,7 @@ interface DataStoreSetOptions extends Instance {
|
|
|
9217
9216
|
*
|
|
9218
9217
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
9219
9218
|
*/
|
|
9220
|
-
SetMetadata(this: DataStoreSetOptions, attributes: object):
|
|
9219
|
+
SetMetadata(this: DataStoreSetOptions, attributes: object): void;
|
|
9221
9220
|
}
|
|
9222
9221
|
|
|
9223
9222
|
/** 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.
|
|
@@ -9296,7 +9295,7 @@ interface Debris extends Instance {
|
|
|
9296
9295
|
*
|
|
9297
9296
|
* 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.
|
|
9298
9297
|
*/
|
|
9299
|
-
AddItem(this: Debris, item: Instance, lifetime?: number):
|
|
9298
|
+
AddItem(this: Debris, item: Instance, lifetime?: number): void;
|
|
9300
9299
|
}
|
|
9301
9300
|
|
|
9302
9301
|
interface DebuggablePluginWatcher extends Instance {
|
|
@@ -9546,7 +9545,7 @@ interface Dragger extends Instance {
|
|
|
9546
9545
|
/**
|
|
9547
9546
|
* Rotates the currently dragged part(s) by 90 degrees on the given axis.
|
|
9548
9547
|
*/
|
|
9549
|
-
AxisRotate(this: Dragger, axis?: CastsToEnum<Enum.Axis>):
|
|
9548
|
+
AxisRotate(this: Dragger, axis?: CastsToEnum<Enum.Axis>): void;
|
|
9550
9549
|
/**
|
|
9551
9550
|
* Initializes a dragging action, specifying which parts to use when dragging.
|
|
9552
9551
|
*/
|
|
@@ -9554,11 +9553,11 @@ interface Dragger extends Instance {
|
|
|
9554
9553
|
/**
|
|
9555
9554
|
* Tries to move the currently dragged part to the point where MouseRay hits another part.
|
|
9556
9555
|
*/
|
|
9557
|
-
MouseMove(this: Dragger, mouseRay: Ray):
|
|
9556
|
+
MouseMove(this: Dragger, mouseRay: Ray): void;
|
|
9558
9557
|
/**
|
|
9559
9558
|
* Stops the current dragging action (made by [MouseDown](https://developer.roblox.com/api-reference/function/Dragger/MouseDown "MouseDown"))
|
|
9560
9559
|
*/
|
|
9561
|
-
MouseUp(this: Dragger):
|
|
9560
|
+
MouseUp(this: Dragger): void;
|
|
9562
9561
|
}
|
|
9563
9562
|
|
|
9564
9563
|
interface DraggerService extends Instance {
|
|
@@ -10469,7 +10468,7 @@ interface GamepadService extends Instance {
|
|
|
10469
10468
|
*/
|
|
10470
10469
|
readonly _nominal_GamepadService: unique symbol;
|
|
10471
10470
|
readonly GamepadCursorEnabled: boolean;
|
|
10472
|
-
DisableGamepadCursor(this: GamepadService):
|
|
10471
|
+
DisableGamepadCursor(this: GamepadService): void;
|
|
10473
10472
|
EnableGamepadCursor(this: GamepadService, guiObject: GuiObject | undefined): void;
|
|
10474
10473
|
}
|
|
10475
10474
|
|
|
@@ -10705,7 +10704,7 @@ interface DataStore extends GlobalDataStore {
|
|
|
10705
10704
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
10706
10705
|
* Tags: Yields
|
|
10707
10706
|
*/
|
|
10708
|
-
RemoveVersionAsync(this: DataStore, key: string, version: string):
|
|
10707
|
+
RemoveVersionAsync(this: DataStore, key: string, version: string): void;
|
|
10709
10708
|
}
|
|
10710
10709
|
|
|
10711
10710
|
/** 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.
|
|
@@ -12828,7 +12827,7 @@ interface TextBox extends GuiObject {
|
|
|
12828
12827
|
/**
|
|
12829
12828
|
* Forces the client to focus on the TextBox.
|
|
12830
12829
|
*/
|
|
12831
|
-
CaptureFocus(this: TextBox):
|
|
12830
|
+
CaptureFocus(this: TextBox): void;
|
|
12832
12831
|
/**
|
|
12833
12832
|
* Returns true if the textbox is focused, or false if it is not.
|
|
12834
12833
|
*/
|
|
@@ -12856,7 +12855,7 @@ interface TextBox extends GuiObject {
|
|
|
12856
12855
|
*
|
|
12857
12856
|
* Please be aware that the above example assumes that it's in a LocalScript, as a child of a TextBox.
|
|
12858
12857
|
*/
|
|
12859
|
-
ReleaseFocus(this: TextBox, submitted?: boolean):
|
|
12858
|
+
ReleaseFocus(this: TextBox, submitted?: boolean): void;
|
|
12860
12859
|
/**
|
|
12861
12860
|
* 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.
|
|
12862
12861
|
*
|
|
@@ -12946,11 +12945,11 @@ interface VideoFrame extends GuiObject {
|
|
|
12946
12945
|
*
|
|
12947
12946
|
* 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.
|
|
12948
12947
|
*/
|
|
12949
|
-
Pause(this: VideoFrame):
|
|
12948
|
+
Pause(this: VideoFrame): void;
|
|
12950
12949
|
/**
|
|
12951
12950
|
* 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).
|
|
12952
12951
|
*/
|
|
12953
|
-
Play(this: VideoFrame):
|
|
12952
|
+
Play(this: VideoFrame): void;
|
|
12954
12953
|
/**
|
|
12955
12954
|
* 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.
|
|
12956
12955
|
*/
|
|
@@ -13929,10 +13928,10 @@ interface WireframeHandleAdornment extends HandleAdornment {
|
|
|
13929
13928
|
*/
|
|
13930
13929
|
readonly _nominal_WireframeHandleAdornment: unique symbol;
|
|
13931
13930
|
Scale: Vector3;
|
|
13932
|
-
AddLine(this: WireframeHandleAdornment, from: Vector3, to: Vector3):
|
|
13933
|
-
AddLines(this: WireframeHandleAdornment, points: Array<any>):
|
|
13934
|
-
AddPath(this: WireframeHandleAdornment, points: Array<any>, loop: boolean):
|
|
13935
|
-
Clear(this: WireframeHandleAdornment):
|
|
13931
|
+
AddLine(this: WireframeHandleAdornment, from: Vector3, to: Vector3): void;
|
|
13932
|
+
AddLines(this: WireframeHandleAdornment, points: Array<any>): void;
|
|
13933
|
+
AddPath(this: WireframeHandleAdornment, points: Array<any>, loop: boolean): void;
|
|
13934
|
+
Clear(this: WireframeHandleAdornment): void;
|
|
13936
13935
|
}
|
|
13937
13936
|
|
|
13938
13937
|
/** A special type of Adornment that is still a work in progress.
|
|
@@ -14250,7 +14249,7 @@ interface GuiService extends Instance {
|
|
|
14250
14249
|
* * [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
|
|
14251
14250
|
* * [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
|
|
14252
14251
|
*/
|
|
14253
|
-
CloseInspectMenu(this: GuiService):
|
|
14252
|
+
CloseInspectMenu(this: GuiService): void;
|
|
14254
14253
|
/**
|
|
14255
14254
|
* Returns a boolean indicating whether or not the player Emotes menu is open.
|
|
14256
14255
|
*
|
|
@@ -14314,7 +14313,7 @@ interface GuiService extends Instance {
|
|
|
14314
14313
|
* * `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
|
|
14315
14314
|
* * [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
|
|
14316
14315
|
*/
|
|
14317
|
-
InspectPlayerFromUserId(this: GuiService, userId: number):
|
|
14316
|
+
InspectPlayerFromUserId(this: GuiService, userId: number): void;
|
|
14318
14317
|
/**
|
|
14319
14318
|
* Returns true if the client is using the ten foot interface, which is a special version of Roblox's UI, exclusive to consoles.
|
|
14320
14319
|
*
|
|
@@ -14324,12 +14323,12 @@ interface GuiService extends Instance {
|
|
|
14324
14323
|
/**
|
|
14325
14324
|
* 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).
|
|
14326
14325
|
*/
|
|
14327
|
-
RemoveSelectionGroup(this: GuiService, selectionName: string):
|
|
14326
|
+
RemoveSelectionGroup(this: GuiService, selectionName: string): void;
|
|
14328
14327
|
Select(this: GuiService, selectionParent: Instance): void;
|
|
14329
14328
|
/**
|
|
14330
14329
|
* Opens or closes the player Emotes menu.
|
|
14331
14330
|
*/
|
|
14332
|
-
SetEmotesMenuOpen(this: GuiService, isOpen: boolean):
|
|
14331
|
+
SetEmotesMenuOpen(this: GuiService, isOpen: boolean): void;
|
|
14333
14332
|
/**
|
|
14334
14333
|
* 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.
|
|
14335
14334
|
*
|
|
@@ -14340,7 +14339,7 @@ interface GuiService extends Instance {
|
|
|
14340
14339
|
*
|
|
14341
14340
|
* * [Workspace.StreamingPauseMode](https://developer.roblox.com/en-us/api-reference/property/Workspace/StreamingPauseMode), controls which streaming physics pause mode is active
|
|
14342
14341
|
*/
|
|
14343
|
-
SetGameplayPausedNotificationEnabled(this: GuiService, enabled: boolean):
|
|
14342
|
+
SetGameplayPausedNotificationEnabled(this: GuiService, enabled: boolean): void;
|
|
14344
14343
|
/**
|
|
14345
14344
|
* 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.
|
|
14346
14345
|
*
|
|
@@ -14356,7 +14355,7 @@ interface GuiService extends Instance {
|
|
|
14356
14355
|
* * [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
|
|
14357
14356
|
* * [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
|
|
14358
14357
|
*/
|
|
14359
|
-
SetInspectMenuEnabled(this: GuiService, enabled: boolean):
|
|
14358
|
+
SetInspectMenuEnabled(this: GuiService, enabled: boolean): void;
|
|
14360
14359
|
/**
|
|
14361
14360
|
* Fires when the user **closes** the Roblox coregui escape menu.
|
|
14362
14361
|
*/
|
|
@@ -15229,7 +15228,7 @@ interface Humanoid extends Instance {
|
|
|
15229
15228
|
*
|
|
15230
15229
|
* 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.
|
|
15231
15230
|
*/
|
|
15232
|
-
AddAccessory(this: Humanoid, accessory: Accessory):
|
|
15231
|
+
AddAccessory(this: Humanoid, accessory: Accessory): void;
|
|
15233
15232
|
/**
|
|
15234
15233
|
* 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.
|
|
15235
15234
|
* Tags: Deprecated
|
|
@@ -15249,7 +15248,7 @@ interface Humanoid extends Instance {
|
|
|
15249
15248
|
*
|
|
15250
15249
|
* See the provided code sample below to see how this function works.
|
|
15251
15250
|
*/
|
|
15252
|
-
BuildRigFromAttachments(this: Humanoid):
|
|
15251
|
+
BuildRigFromAttachments(this: Humanoid): void;
|
|
15253
15252
|
/**
|
|
15254
15253
|
* 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).
|
|
15255
15254
|
*
|
|
@@ -15268,7 +15267,7 @@ interface Humanoid extends Instance {
|
|
|
15268
15267
|
* * To enable or disable a particular state use [Humanoid:SetStateEnabled](https://developer.roblox.com/en-us/api-reference/function/Humanoid/SetStateEnabled)
|
|
15269
15268
|
* * To get the current state use [Humanoid:GetState](https://developer.roblox.com/en-us/api-reference/function/Humanoid/GetState)
|
|
15270
15269
|
*/
|
|
15271
|
-
ChangeState(this: Humanoid, state?: CastsToEnum<Enum.HumanoidStateType>):
|
|
15270
|
+
ChangeState(this: Humanoid, state?: CastsToEnum<Enum.HumanoidStateType>): void;
|
|
15272
15271
|
/**
|
|
15273
15272
|
* 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).
|
|
15274
15273
|
*
|
|
@@ -15296,7 +15295,7 @@ interface Humanoid extends Instance {
|
|
|
15296
15295
|
*
|
|
15297
15296
|
* * To unequip tools, use [Humanoid:UnequipTools](https://developer.roblox.com/en-us/api-reference/function/Humanoid/UnequipTools)
|
|
15298
15297
|
*/
|
|
15299
|
-
EquipTool(this: Humanoid, tool: Tool):
|
|
15298
|
+
EquipTool(this: Humanoid, tool: Tool): void;
|
|
15300
15299
|
/**
|
|
15301
15300
|
* 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.
|
|
15302
15301
|
*
|
|
@@ -15441,7 +15440,7 @@ interface Humanoid extends Instance {
|
|
|
15441
15440
|
* * 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
|
|
15442
15441
|
* * 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
|
|
15443
15442
|
*/
|
|
15444
|
-
Move(this: Humanoid, moveDirection: Vector3, relativeToCamera?: boolean):
|
|
15443
|
+
Move(this: Humanoid, moveDirection: Vector3, relativeToCamera?: boolean): void;
|
|
15445
15444
|
/**
|
|
15446
15445
|
* 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.
|
|
15447
15446
|
*
|
|
@@ -15451,7 +15450,7 @@ interface Humanoid extends Instance {
|
|
|
15451
15450
|
*
|
|
15452
15451
|
* 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.
|
|
15453
15452
|
*/
|
|
15454
|
-
MoveTo(this: Humanoid, location: Vector3, part?: BasePart):
|
|
15453
|
+
MoveTo(this: Humanoid, location: Vector3, part?: BasePart): void;
|
|
15455
15454
|
/**
|
|
15456
15455
|
* 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.
|
|
15457
15456
|
*
|
|
@@ -15463,7 +15462,7 @@ interface Humanoid extends Instance {
|
|
|
15463
15462
|
* * 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
|
|
15464
15463
|
* * 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
|
|
15465
15464
|
*/
|
|
15466
|
-
RemoveAccessories(this: Humanoid):
|
|
15465
|
+
RemoveAccessories(this: Humanoid): void;
|
|
15467
15466
|
/**
|
|
15468
15467
|
* The RemoveCustomStatus function removes the defined custom status from the Status model in the Humanoid…
|
|
15469
15468
|
* Tags: Deprecated
|
|
@@ -15491,7 +15490,7 @@ interface Humanoid extends Instance {
|
|
|
15491
15490
|
*
|
|
15492
15491
|
* 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.
|
|
15493
15492
|
*/
|
|
15494
|
-
SetStateEnabled(this: Humanoid, state: CastsToEnum<Enum.HumanoidStateType>, enabled: boolean):
|
|
15493
|
+
SetStateEnabled(this: Humanoid, state: CastsToEnum<Enum.HumanoidStateType>, enabled: boolean): void;
|
|
15495
15494
|
/**
|
|
15496
15495
|
* 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)
|
|
15497
15496
|
*
|
|
@@ -15510,7 +15509,7 @@ interface Humanoid extends Instance {
|
|
|
15510
15509
|
*
|
|
15511
15510
|
* 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
|
|
15512
15511
|
*/
|
|
15513
|
-
TakeDamage(this: Humanoid, amount: number):
|
|
15512
|
+
TakeDamage(this: Humanoid, amount: number): void;
|
|
15514
15513
|
/**
|
|
15515
15514
|
* 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)
|
|
15516
15515
|
*
|
|
@@ -15525,7 +15524,7 @@ interface Humanoid extends Instance {
|
|
|
15525
15524
|
*
|
|
15526
15525
|
* * 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)
|
|
15527
15526
|
*/
|
|
15528
|
-
UnequipTools(this: Humanoid):
|
|
15527
|
+
UnequipTools(this: Humanoid): void;
|
|
15529
15528
|
/**
|
|
15530
15529
|
* 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.
|
|
15531
15530
|
*
|
|
@@ -15540,11 +15539,11 @@ interface Humanoid extends Instance {
|
|
|
15540
15539
|
* * [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
|
|
15541
15540
|
* Tags: Yields
|
|
15542
15541
|
*/
|
|
15543
|
-
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>):
|
|
15542
|
+
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
15544
15543
|
/**
|
|
15545
15544
|
* Tags: Yields
|
|
15546
15545
|
*/
|
|
15547
|
-
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>):
|
|
15546
|
+
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
15548
15547
|
/**
|
|
15549
15548
|
* 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.
|
|
15550
15549
|
* Tags: Yields
|
|
@@ -16312,7 +16311,7 @@ interface HumanoidDescription extends Instance {
|
|
|
16312
16311
|
* * [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
|
|
16313
16312
|
* * [EmotesChanged](https://developer.roblox.com/en-us/api-reference/event/HumanoidDescription/EmotesChanged), which fires after this function is called
|
|
16314
16313
|
*/
|
|
16315
|
-
AddEmote(this: HumanoidDescription, name: string, assetId: number):
|
|
16314
|
+
AddEmote(this: HumanoidDescription, name: string, assetId: number): void;
|
|
16316
16315
|
/**
|
|
16317
16316
|
* 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.
|
|
16318
16317
|
*/
|
|
@@ -16374,11 +16373,11 @@ interface HumanoidDescription extends Instance {
|
|
|
16374
16373
|
* * [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
|
|
16375
16374
|
* * [GetEmotes](https://developer.roblox.com/en-us/api-reference/function/HumanoidDescription/GetEmotes), which can retrieve a dictionary of emotes that may be removed
|
|
16376
16375
|
*/
|
|
16377
|
-
RemoveEmote(this: HumanoidDescription, name: string):
|
|
16376
|
+
RemoveEmote(this: HumanoidDescription, name: string): void;
|
|
16378
16377
|
/**
|
|
16379
16378
|
* 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.
|
|
16380
16379
|
*/
|
|
16381
|
-
SetAccessories(this: HumanoidDescription, accessories: Array<any>, includeRigidAccessories: boolean):
|
|
16380
|
+
SetAccessories(this: HumanoidDescription, accessories: Array<any>, includeRigidAccessories: boolean): void;
|
|
16382
16381
|
/**
|
|
16383
16382
|
* **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)
|
|
16384
16383
|
*
|
|
@@ -16546,14 +16545,14 @@ interface ImageDataExperimental extends Instance {
|
|
|
16546
16545
|
* Tags: ReadOnly, NotReplicated
|
|
16547
16546
|
*/
|
|
16548
16547
|
readonly TemporaryId: string;
|
|
16549
|
-
Clear(this: ImageDataExperimental):
|
|
16550
|
-
DrawCircle(this: ImageDataExperimental, center: Vector2, radius: number, color: Color3, alpha: number):
|
|
16551
|
-
Resize(this: ImageDataExperimental, newSize: Vector2):
|
|
16552
|
-
Rotate(this: ImageDataExperimental, degrees: number, resizeCanvas?: boolean):
|
|
16548
|
+
Clear(this: ImageDataExperimental): void;
|
|
16549
|
+
DrawCircle(this: ImageDataExperimental, center: Vector2, radius: number, color: Color3, alpha: number): void;
|
|
16550
|
+
Resize(this: ImageDataExperimental, newSize: Vector2): void;
|
|
16551
|
+
Rotate(this: ImageDataExperimental, degrees: number, resizeCanvas?: boolean): void;
|
|
16553
16552
|
/**
|
|
16554
16553
|
* Tags: Yields
|
|
16555
16554
|
*/
|
|
16556
|
-
PopulateFromImageAsync(this: ImageDataExperimental, textureId: string):
|
|
16555
|
+
PopulateFromImageAsync(this: ImageDataExperimental, textureId: string): void;
|
|
16557
16556
|
}
|
|
16558
16557
|
|
|
16559
16558
|
interface IncrementalPatchBuilder extends Instance {
|
|
@@ -18221,18 +18220,18 @@ interface InsertService extends Instance {
|
|
|
18221
18220
|
* Tags: Deprecated
|
|
18222
18221
|
* @deprecated
|
|
18223
18222
|
*/
|
|
18224
|
-
ApproveAssetId(this: InsertService, assetId: number):
|
|
18223
|
+
ApproveAssetId(this: InsertService, assetId: number): void;
|
|
18225
18224
|
/**
|
|
18226
18225
|
* Tags: Deprecated
|
|
18227
18226
|
* @deprecated
|
|
18228
18227
|
*/
|
|
18229
|
-
ApproveAssetVersionId(this: InsertService, assetVersionId: number):
|
|
18228
|
+
ApproveAssetVersionId(this: InsertService, assetVersionId: number): void;
|
|
18230
18229
|
/**
|
|
18231
18230
|
* The Insert function is an ancient method used to insert an [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance) into Workspace.
|
|
18232
18231
|
* Tags: Deprecated
|
|
18233
18232
|
* @deprecated
|
|
18234
18233
|
*/
|
|
18235
|
-
Insert(this: InsertService, instance: Instance):
|
|
18234
|
+
Insert(this: InsertService, instance: Instance): void;
|
|
18236
18235
|
/**
|
|
18237
18236
|
* Tags: Yields, Deprecated, [object Object]
|
|
18238
18237
|
* @deprecated
|
|
@@ -18657,7 +18656,7 @@ interface Motor extends JointInstance {
|
|
|
18657
18656
|
/**
|
|
18658
18657
|
* Sets [Motor.DesiredAngle](https://developer.roblox.com/en-us/api-reference/property/Motor/DesiredAngle) of the motor.
|
|
18659
18658
|
*/
|
|
18660
|
-
SetDesiredAngle(this: Motor, value: number):
|
|
18659
|
+
SetDesiredAngle(this: Motor, value: number): void;
|
|
18661
18660
|
}
|
|
18662
18661
|
|
|
18663
18662
|
/** **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).
|
|
@@ -18803,11 +18802,11 @@ interface JointsService extends Instance {
|
|
|
18803
18802
|
/**
|
|
18804
18803
|
* 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.
|
|
18805
18804
|
*/
|
|
18806
|
-
ClearJoinAfterMoveJoints(this: JointsService):
|
|
18805
|
+
ClearJoinAfterMoveJoints(this: JointsService): void;
|
|
18807
18806
|
/**
|
|
18808
18807
|
* 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.
|
|
18809
18808
|
*/
|
|
18810
|
-
CreateJoinAfterMoveJoints(this: JointsService):
|
|
18809
|
+
CreateJoinAfterMoveJoints(this: JointsService): void;
|
|
18811
18810
|
/**
|
|
18812
18811
|
* 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).
|
|
18813
18812
|
*/
|
|
@@ -18819,7 +18818,7 @@ interface JointsService extends Instance {
|
|
|
18819
18818
|
/**
|
|
18820
18819
|
* 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).
|
|
18821
18820
|
*/
|
|
18822
|
-
ShowPermissibleJoints(this: JointsService):
|
|
18821
|
+
ShowPermissibleJoints(this: JointsService): void;
|
|
18823
18822
|
}
|
|
18824
18823
|
|
|
18825
18824
|
/** 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.
|
|
@@ -18878,7 +18877,7 @@ interface Keyframe extends Instance {
|
|
|
18878
18877
|
*
|
|
18879
18878
|
* 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.
|
|
18880
18879
|
*/
|
|
18881
|
-
AddPose(this: Keyframe, pose: Pose):
|
|
18880
|
+
AddPose(this: Keyframe, pose: Pose): void;
|
|
18882
18881
|
/**
|
|
18883
18882
|
* 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.
|
|
18884
18883
|
*
|
|
@@ -18930,7 +18929,7 @@ interface Keyframe extends Instance {
|
|
|
18930
18929
|
*
|
|
18931
18930
|
* 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.
|
|
18932
18931
|
*/
|
|
18933
|
-
RemovePose(this: Keyframe, pose: Pose):
|
|
18932
|
+
RemovePose(this: Keyframe, pose: Pose): void;
|
|
18934
18933
|
}
|
|
18935
18934
|
|
|
18936
18935
|
/** 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.
|
|
@@ -19619,7 +19618,7 @@ interface Lighting extends Instance {
|
|
|
19619
19618
|
* wait()
|
|
19620
19619
|
* end
|
|
19621
19620
|
*/
|
|
19622
|
-
SetMinutesAfterMidnight(this: Lighting, minutes: number):
|
|
19621
|
+
SetMinutesAfterMidnight(this: Lighting, minutes: number): void;
|
|
19623
19622
|
/**
|
|
19624
19623
|
* 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).
|
|
19625
19624
|
*
|
|
@@ -20859,11 +20858,11 @@ interface LocalizationTable extends Instance {
|
|
|
20859
20858
|
/**
|
|
20860
20859
|
* Removes an entry from the LocalizationTable, using the specified _key_, _source_, and _context_ to narrow down the specific entry to be removed.
|
|
20861
20860
|
*/
|
|
20862
|
-
RemoveEntry(this: LocalizationTable, key: string, source: string, context: string):
|
|
20861
|
+
RemoveEntry(this: LocalizationTable, key: string, source: string, context: string): void;
|
|
20863
20862
|
/**
|
|
20864
20863
|
* 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.
|
|
20865
20864
|
*/
|
|
20866
|
-
RemoveEntryValue(this: LocalizationTable, key: string, source: string, context: string, localeId: string):
|
|
20865
|
+
RemoveEntryValue(this: LocalizationTable, key: string, source: string, context: string, localeId: string): void;
|
|
20867
20866
|
/**
|
|
20868
20867
|
* Deprecated in favor of [LocalizationTable:RemoveEntry](https://developer.roblox.com/en-us/api-reference/function/LocalizationTable/RemoveEntry).
|
|
20869
20868
|
*
|
|
@@ -20873,17 +20872,17 @@ interface LocalizationTable extends Instance {
|
|
|
20873
20872
|
* Tags: Deprecated, [object Object]
|
|
20874
20873
|
* @deprecated
|
|
20875
20874
|
*/
|
|
20876
|
-
RemoveKey(this: LocalizationTable, key: string):
|
|
20875
|
+
RemoveKey(this: LocalizationTable, key: string): void;
|
|
20877
20876
|
/**
|
|
20878
20877
|
* Removes all translations from the LocalizationTable with the specified localeId.
|
|
20879
20878
|
*/
|
|
20880
|
-
RemoveTargetLocale(this: LocalizationTable, localeId: string):
|
|
20879
|
+
RemoveTargetLocale(this: LocalizationTable, localeId: string): void;
|
|
20881
20880
|
/**
|
|
20882
20881
|
* The SetContents function sets the contents of the LocalizationTable, via the legacy JSON format.
|
|
20883
20882
|
* Tags: Deprecated, [object Object]
|
|
20884
20883
|
* @deprecated
|
|
20885
20884
|
*/
|
|
20886
|
-
SetContents(this: LocalizationTable, contents: string):
|
|
20885
|
+
SetContents(this: LocalizationTable, contents: string): void;
|
|
20887
20886
|
/**
|
|
20888
20887
|
* Sets the contents of the LocalizationTable.
|
|
20889
20888
|
*
|
|
@@ -20894,27 +20893,27 @@ interface LocalizationTable extends Instance {
|
|
|
20894
20893
|
* Tags: Deprecated, [object Object]
|
|
20895
20894
|
* @deprecated
|
|
20896
20895
|
*/
|
|
20897
|
-
SetEntry(this: LocalizationTable, key: string, targetLocaleId: string, text: string):
|
|
20896
|
+
SetEntry(this: LocalizationTable, key: string, targetLocaleId: string, text: string): void;
|
|
20898
20897
|
/**
|
|
20899
20898
|
* 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.
|
|
20900
20899
|
*/
|
|
20901
|
-
SetEntryContext(this: LocalizationTable, key: string, source: string, context: string, newContext: string):
|
|
20900
|
+
SetEntryContext(this: LocalizationTable, key: string, source: string, context: string, newContext: string): void;
|
|
20902
20901
|
/**
|
|
20903
20902
|
* 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.
|
|
20904
20903
|
*/
|
|
20905
|
-
SetEntryExample(this: LocalizationTable, key: string, source: string, context: string, example: string):
|
|
20904
|
+
SetEntryExample(this: LocalizationTable, key: string, source: string, context: string, example: string): void;
|
|
20906
20905
|
/**
|
|
20907
20906
|
* 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.
|
|
20908
20907
|
*/
|
|
20909
|
-
SetEntryKey(this: LocalizationTable, key: string, source: string, context: string, newKey: string):
|
|
20908
|
+
SetEntryKey(this: LocalizationTable, key: string, source: string, context: string, newKey: string): void;
|
|
20910
20909
|
/**
|
|
20911
20910
|
* 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.
|
|
20912
20911
|
*/
|
|
20913
|
-
SetEntrySource(this: LocalizationTable, key: string, source: string, context: string, newSource: string):
|
|
20912
|
+
SetEntrySource(this: LocalizationTable, key: string, source: string, context: string, newSource: string): void;
|
|
20914
20913
|
/**
|
|
20915
20914
|
* 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.
|
|
20916
20915
|
*/
|
|
20917
|
-
SetEntryValue(this: LocalizationTable, key: string, source: string, context: string, localeId: string, text: string):
|
|
20916
|
+
SetEntryValue(this: LocalizationTable, key: string, source: string, context: string, localeId: string, text: string): void;
|
|
20918
20917
|
}
|
|
20919
20918
|
|
|
20920
20919
|
interface CloudLocalizationTable extends LocalizationTable {
|
|
@@ -21181,11 +21180,11 @@ interface MarketplaceService extends Instance {
|
|
|
21181
21180
|
/**
|
|
21182
21181
|
* Used to prompt a user to purchase a bundle with the given bundleId
|
|
21183
21182
|
*/
|
|
21184
|
-
PromptBundlePurchase(this: MarketplaceService, player: Player, bundleId: number):
|
|
21183
|
+
PromptBundlePurchase(this: MarketplaceService, player: Player, bundleId: number): void;
|
|
21185
21184
|
/**
|
|
21186
21185
|
* Used to prompt a user to purchase a game pass with the given assetId.
|
|
21187
21186
|
*/
|
|
21188
|
-
PromptGamePassPurchase(this: MarketplaceService, player: Player, gamePassId: number):
|
|
21187
|
+
PromptGamePassPurchase(this: MarketplaceService, player: Player, gamePassId: number): void;
|
|
21189
21188
|
/**
|
|
21190
21189
|
* 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.”
|
|
21191
21190
|
*
|
|
@@ -21199,7 +21198,7 @@ interface MarketplaceService extends Instance {
|
|
|
21199
21198
|
* * [MarketplaceService.PromptPremiumPurchaseFinished](https://developer.roblox.com/en-us/api-reference/event/MarketplaceService/PromptPremiumPurchaseFinished), fires when the Premium purchase UI closes
|
|
21200
21199
|
* * [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
|
|
21201
21200
|
*/
|
|
21202
|
-
PromptPremiumPurchase(this: MarketplaceService, player: Player):
|
|
21201
|
+
PromptPremiumPurchase(this: MarketplaceService, player: Player): void;
|
|
21203
21202
|
/**
|
|
21204
21203
|
* Used to prompt a user to purchase a product with the given product id.
|
|
21205
21204
|
*/
|
|
@@ -21228,8 +21227,8 @@ interface MarketplaceService extends Instance {
|
|
|
21228
21227
|
equipIfPurchased?: boolean,
|
|
21229
21228
|
currencyType?: CastsToEnum<Enum.CurrencyType>,
|
|
21230
21229
|
): void;
|
|
21231
|
-
PromptSubscriptionCancellation(this: MarketplaceService, player: Player, subscriptionId: number):
|
|
21232
|
-
PromptSubscriptionPurchase(this: MarketplaceService, player: Player, subscriptionId: number):
|
|
21230
|
+
PromptSubscriptionCancellation(this: MarketplaceService, player: Player, subscriptionId: number): void;
|
|
21231
|
+
PromptSubscriptionPurchase(this: MarketplaceService, player: Player, subscriptionId: number): void;
|
|
21233
21232
|
/**
|
|
21234
21233
|
* 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.
|
|
21235
21234
|
* Tags: Yields
|
|
@@ -21599,7 +21598,7 @@ interface MaterialService extends Instance {
|
|
|
21599
21598
|
readonly _nominal_MaterialService: unique symbol;
|
|
21600
21599
|
GetBaseMaterialOverride(this: MaterialService, material: CastsToEnum<Enum.Material>): string;
|
|
21601
21600
|
GetMaterialVariant(this: MaterialService, material: CastsToEnum<Enum.Material>, name: string): MaterialVariant;
|
|
21602
|
-
SetBaseMaterialOverride(this: MaterialService, material: CastsToEnum<Enum.Material>, name: string):
|
|
21601
|
+
SetBaseMaterialOverride(this: MaterialService, material: CastsToEnum<Enum.Material>, name: string): void;
|
|
21603
21602
|
}
|
|
21604
21603
|
|
|
21605
21604
|
interface MaterialVariant extends Instance {
|
|
@@ -21633,7 +21632,7 @@ interface MemoryStoreQueue extends Instance {
|
|
|
21633
21632
|
* Adds an item to the queue.
|
|
21634
21633
|
* Tags: Yields
|
|
21635
21634
|
*/
|
|
21636
|
-
AddAsync(this: MemoryStoreQueue, value: unknown, expiration: number, priority?: number):
|
|
21635
|
+
AddAsync(this: MemoryStoreQueue, value: unknown, expiration: number, priority?: number): void;
|
|
21637
21636
|
/**
|
|
21638
21637
|
* Reads one or more items from the queue as a single atomic operation.
|
|
21639
21638
|
*
|
|
@@ -21650,7 +21649,7 @@ interface MemoryStoreQueue extends Instance {
|
|
|
21650
21649
|
* 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.
|
|
21651
21650
|
* Tags: Yields
|
|
21652
21651
|
*/
|
|
21653
|
-
RemoveAsync(this: MemoryStoreQueue, id: string):
|
|
21652
|
+
RemoveAsync(this: MemoryStoreQueue, id: string): void;
|
|
21654
21653
|
}
|
|
21655
21654
|
|
|
21656
21655
|
/** 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.
|
|
@@ -21710,7 +21709,7 @@ interface MemoryStoreSortedMap extends Instance {
|
|
|
21710
21709
|
* For a more in-depth look, take a look at the [Memory Store](https://developer.roblox.com/en-us/articles/memory-store) article.
|
|
21711
21710
|
* Tags: Yields
|
|
21712
21711
|
*/
|
|
21713
|
-
RemoveAsync(this: MemoryStoreSortedMap, key: string):
|
|
21712
|
+
RemoveAsync(this: MemoryStoreSortedMap, key: string): void;
|
|
21714
21713
|
/**
|
|
21715
21714
|
* Sets the value of the key overwriting any existing key value.
|
|
21716
21715
|
* Tags: Yields
|
|
@@ -21753,7 +21752,7 @@ interface MeshDataExperimental extends Instance {
|
|
|
21753
21752
|
/**
|
|
21754
21753
|
* Tags: Yields
|
|
21755
21754
|
*/
|
|
21756
|
-
PopulateFromMeshAsync(this: MeshDataExperimental, meshId: string):
|
|
21755
|
+
PopulateFromMeshAsync(this: MeshDataExperimental, meshId: string): void;
|
|
21757
21756
|
}
|
|
21758
21757
|
|
|
21759
21758
|
interface MessageBusConnection extends Instance {
|
|
@@ -21833,7 +21832,7 @@ interface MessagingService extends Instance {
|
|
|
21833
21832
|
* * [MessagingService:SubscribeAsync](https://developer.roblox.com/en-us/api-reference/function/MessagingService/SubscribeAsync), begins listening to the given topic
|
|
21834
21833
|
* Tags: Yields
|
|
21835
21834
|
*/
|
|
21836
|
-
PublishAsync(this: MessagingService, topic: string, message: unknown):
|
|
21835
|
+
PublishAsync(this: MessagingService, topic: string, message: unknown): void;
|
|
21837
21836
|
/**
|
|
21838
21837
|
* 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.
|
|
21839
21838
|
*
|
|
@@ -22449,7 +22448,7 @@ interface PVInstance extends Instance {
|
|
|
22449
22448
|
*
|
|
22450
22449
|
* [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.
|
|
22451
22450
|
*/
|
|
22452
|
-
PivotTo(this: PVInstance, targetCFrame: CFrame):
|
|
22451
|
+
PivotTo(this: PVInstance, targetCFrame: CFrame): void;
|
|
22453
22452
|
}
|
|
22454
22453
|
|
|
22455
22454
|
/** 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).
|
|
@@ -23173,7 +23172,7 @@ interface BasePart extends PVInstance {
|
|
|
23173
23172
|
*
|
|
23174
23173
|
* 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\`\`.
|
|
23175
23174
|
*/
|
|
23176
|
-
ApplyAngularImpulse(this: BasePart, impulse: Vector3):
|
|
23175
|
+
ApplyAngularImpulse(this: BasePart, impulse: Vector3): void;
|
|
23177
23176
|
/**
|
|
23178
23177
|
* This function applies an instant force impulse to this [part's](https://developer.roblox.com/en-us/api-reference/class/BasePart) assembly.
|
|
23179
23178
|
*
|
|
@@ -23183,7 +23182,7 @@ interface BasePart extends PVInstance {
|
|
|
23183
23182
|
*
|
|
23184
23183
|
* 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).
|
|
23185
23184
|
*/
|
|
23186
|
-
ApplyImpulse(this: BasePart, impulse: Vector3):
|
|
23185
|
+
ApplyImpulse(this: BasePart, impulse: Vector3): void;
|
|
23187
23186
|
/**
|
|
23188
23187
|
* 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.
|
|
23189
23188
|
*
|
|
@@ -23193,13 +23192,13 @@ interface BasePart extends PVInstance {
|
|
|
23193
23192
|
*
|
|
23194
23193
|
* 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).
|
|
23195
23194
|
*/
|
|
23196
|
-
ApplyImpulseAtPosition(this: BasePart, impulse: Vector3, position: Vector3):
|
|
23195
|
+
ApplyImpulseAtPosition(this: BasePart, impulse: Vector3, position: Vector3): void;
|
|
23197
23196
|
/**
|
|
23198
23197
|
* 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).
|
|
23199
23198
|
* Tags: Deprecated
|
|
23200
23199
|
* @deprecated
|
|
23201
23200
|
*/
|
|
23202
|
-
BreakJoints(this: BasePart):
|
|
23201
|
+
BreakJoints(this: BasePart): void;
|
|
23203
23202
|
/**
|
|
23204
23203
|
* Returns whether the parts can collide with each other or not. This function takes into account the collision groups of the two parts.
|
|
23205
23204
|
*
|
|
@@ -23309,7 +23308,7 @@ interface BasePart extends PVInstance {
|
|
|
23309
23308
|
* Tags: Deprecated
|
|
23310
23309
|
* @deprecated
|
|
23311
23310
|
*/
|
|
23312
|
-
MakeJoints(this: BasePart):
|
|
23311
|
+
MakeJoints(this: BasePart): void;
|
|
23313
23312
|
/**
|
|
23314
23313
|
* Changes the size of an object just like using the Studio resize tool.
|
|
23315
23314
|
*/
|
|
@@ -23630,7 +23629,7 @@ interface Seat extends Part {
|
|
|
23630
23629
|
/**
|
|
23631
23630
|
* Forces the character with the specified [Humanoid](https://developer.roblox.com/api-reference/class/Humanoid "Humanoid") to sit in the Seat.
|
|
23632
23631
|
*/
|
|
23633
|
-
Sit(this: Seat, humanoid: Humanoid):
|
|
23632
|
+
Sit(this: Seat, humanoid: Humanoid): void;
|
|
23634
23633
|
/**
|
|
23635
23634
|
* Tags: Hidden
|
|
23636
23635
|
*/
|
|
@@ -23676,7 +23675,7 @@ interface SkateboardPlatform extends Part {
|
|
|
23676
23675
|
/**
|
|
23677
23676
|
* Adds ''impulseWorld'' to the SkateboardPlatform's [BasePart.Velocity](https://developer.roblox.com/en-us/api-reference/property/BasePart/Velocity).
|
|
23678
23677
|
*/
|
|
23679
|
-
ApplySpecificImpulse(this: SkateboardPlatform, impulseWorld: Vector3):
|
|
23678
|
+
ApplySpecificImpulse(this: SkateboardPlatform, impulseWorld: Vector3): void;
|
|
23680
23679
|
/**
|
|
23681
23680
|
* Fired when the skateboard is equipped.
|
|
23682
23681
|
*/
|
|
@@ -23839,7 +23838,7 @@ interface Terrain extends BasePart {
|
|
|
23839
23838
|
* Tags: Deprecated
|
|
23840
23839
|
* @deprecated
|
|
23841
23840
|
*/
|
|
23842
|
-
AutowedgeCells(this: Terrain, region: Region3int16):
|
|
23841
|
+
AutowedgeCells(this: Terrain, region: Region3int16): void;
|
|
23843
23842
|
/**
|
|
23844
23843
|
* Returns the world position of the center of the terrain cell (x, y, z).
|
|
23845
23844
|
*/
|
|
@@ -23851,7 +23850,7 @@ interface Terrain extends BasePart {
|
|
|
23851
23850
|
/**
|
|
23852
23851
|
* Clears the terrain.
|
|
23853
23852
|
*/
|
|
23854
|
-
Clear(this: Terrain):
|
|
23853
|
+
Clear(this: Terrain): void;
|
|
23855
23854
|
/**
|
|
23856
23855
|
* 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.
|
|
23857
23856
|
*/
|
|
@@ -23863,11 +23862,11 @@ interface Terrain extends BasePart {
|
|
|
23863
23862
|
/**
|
|
23864
23863
|
* Fills a ball of smooth terrain in a given space.
|
|
23865
23864
|
*/
|
|
23866
|
-
FillBall(this: Terrain, center: Vector3, radius: number, material: CastsToEnum<Enum.Material>):
|
|
23865
|
+
FillBall(this: Terrain, center: Vector3, radius: number, material: CastsToEnum<Enum.Material>): void;
|
|
23867
23866
|
/**
|
|
23868
23867
|
* Fills a block of smooth terrain with a given location, rotation, size, and material.
|
|
23869
23868
|
*/
|
|
23870
|
-
FillBlock(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>):
|
|
23869
|
+
FillBlock(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>): void;
|
|
23871
23870
|
/**
|
|
23872
23871
|
* Fills a cylinder of smooth terrain in a given space. The space is defined using a CFrame, height, and radius.
|
|
23873
23872
|
*
|
|
@@ -23876,11 +23875,11 @@ interface Terrain extends BasePart {
|
|
|
23876
23875
|
*
|
|
23877
23876
|
* workspace.Terrain:FillCylinder(CFrame.new(0, 50, 0), 5, 30, Enum.Material.Asphalt)
|
|
23878
23877
|
*/
|
|
23879
|
-
FillCylinder(this: Terrain, cframe: CFrame, height: number, radius: number, material: CastsToEnum<Enum.Material>):
|
|
23878
|
+
FillCylinder(this: Terrain, cframe: CFrame, height: number, radius: number, material: CastsToEnum<Enum.Material>): void;
|
|
23880
23879
|
/**
|
|
23881
23880
|
* Fills a [Region3](https://developer.roblox.com/api-reference/datatype/Region3 "Region3") space with smooth terrain.
|
|
23882
23881
|
*/
|
|
23883
|
-
FillRegion(this: Terrain, region: Region3, resolution: number, material: CastsToEnum<Enum.Material>):
|
|
23882
|
+
FillRegion(this: Terrain, region: Region3, resolution: number, material: CastsToEnum<Enum.Material>): void;
|
|
23884
23883
|
/**
|
|
23885
23884
|
* **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).
|
|
23886
23885
|
*
|
|
@@ -23890,7 +23889,7 @@ interface Terrain extends BasePart {
|
|
|
23890
23889
|
*
|
|
23891
23890
|
* workspace.Terrain:FillWedge(CFrame.new(0, 50, 0), Vector3.new(20, 20, 20), Enum.Material.Asphalt)
|
|
23892
23891
|
*/
|
|
23893
|
-
FillWedge(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>):
|
|
23892
|
+
FillWedge(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>): void;
|
|
23894
23893
|
/**
|
|
23895
23894
|
* 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''.
|
|
23896
23895
|
* Tags: Deprecated
|
|
@@ -23910,7 +23909,7 @@ interface Terrain extends BasePart {
|
|
|
23910
23909
|
/**
|
|
23911
23910
|
* 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.
|
|
23912
23911
|
*/
|
|
23913
|
-
PasteRegion(this: Terrain, region: TerrainRegion, corner: Vector3int16, pasteEmptyCells: boolean):
|
|
23912
|
+
PasteRegion(this: Terrain, region: TerrainRegion, corner: Vector3int16, pasteEmptyCells: boolean): void;
|
|
23914
23913
|
/**
|
|
23915
23914
|
* 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).
|
|
23916
23915
|
* Tags: CustomLuaState
|
|
@@ -23928,7 +23927,7 @@ interface Terrain extends BasePart {
|
|
|
23928
23927
|
*
|
|
23929
23928
|
* 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.
|
|
23930
23929
|
*/
|
|
23931
|
-
ReplaceMaterial(this: Terrain, region: Region3, resolution: number, sourceMaterial: CastsToEnum<Enum.Material>, targetMaterial: CastsToEnum<Enum.Material>):
|
|
23930
|
+
ReplaceMaterial(this: Terrain, region: Region3, resolution: number, sourceMaterial: CastsToEnum<Enum.Material>, targetMaterial: CastsToEnum<Enum.Material>): void;
|
|
23932
23931
|
/**
|
|
23933
23932
|
* 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.
|
|
23934
23933
|
*
|
|
@@ -23936,7 +23935,7 @@ interface Terrain extends BasePart {
|
|
|
23936
23935
|
* Tags: Deprecated
|
|
23937
23936
|
* @deprecated
|
|
23938
23937
|
*/
|
|
23939
|
-
SetCell(this: Terrain, x: number, y: number, z: number, material: CastsToEnum<Enum.CellMaterial>, block: CastsToEnum<Enum.CellBlock>, orientation: CastsToEnum<Enum.CellOrientation>):
|
|
23938
|
+
SetCell(this: Terrain, x: number, y: number, z: number, material: CastsToEnum<Enum.CellMaterial>, block: CastsToEnum<Enum.CellBlock>, orientation: CastsToEnum<Enum.CellOrientation>): void;
|
|
23940
23939
|
/**
|
|
23941
23940
|
* 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.
|
|
23942
23941
|
*
|
|
@@ -23944,11 +23943,11 @@ interface Terrain extends BasePart {
|
|
|
23944
23943
|
* Tags: Deprecated
|
|
23945
23944
|
* @deprecated
|
|
23946
23945
|
*/
|
|
23947
|
-
SetCells(this: Terrain, region: Region3int16, material: CastsToEnum<Enum.CellMaterial>, block: CastsToEnum<Enum.CellBlock>, orientation: CastsToEnum<Enum.CellOrientation>):
|
|
23946
|
+
SetCells(this: Terrain, region: Region3int16, material: CastsToEnum<Enum.CellMaterial>, block: CastsToEnum<Enum.CellBlock>, orientation: CastsToEnum<Enum.CellOrientation>): void;
|
|
23948
23947
|
/**
|
|
23949
23948
|
* Sets current terrain material color for specified terrain material. Terrain material will shift its base color toward specified color.
|
|
23950
23949
|
*/
|
|
23951
|
-
SetMaterialColor(this: Terrain, material: CastsToEnum<Enum.Material>, value: Color3):
|
|
23950
|
+
SetMaterialColor(this: Terrain, material: CastsToEnum<Enum.Material>, value: Color3): void;
|
|
23952
23951
|
/**
|
|
23953
23952
|
* Sets the specified terrain voxel's material to ''Water'' and sets its occupancy to 1. _WaterDirection_ and _WaterForce_ no longer have any effect.
|
|
23954
23953
|
*
|
|
@@ -23956,7 +23955,7 @@ interface Terrain extends BasePart {
|
|
|
23956
23955
|
* Tags: Deprecated
|
|
23957
23956
|
* @deprecated
|
|
23958
23957
|
*/
|
|
23959
|
-
SetWaterCell(this: Terrain, x: number, y: number, z: number, force: CastsToEnum<Enum.WaterForce>, direction: CastsToEnum<Enum.WaterDirection>):
|
|
23958
|
+
SetWaterCell(this: Terrain, x: number, y: number, z: number, force: CastsToEnum<Enum.WaterForce>, direction: CastsToEnum<Enum.WaterDirection>): void;
|
|
23960
23959
|
/**
|
|
23961
23960
|
* Returns the grid cell location that contains the point **position**.
|
|
23962
23961
|
*/
|
|
@@ -24123,7 +24122,7 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
24123
24122
|
* 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/).
|
|
24124
24123
|
*/
|
|
24125
24124
|
TextureID: string;
|
|
24126
|
-
ApplyMesh(this: MeshPart, meshPart: MeshPart):
|
|
24125
|
+
ApplyMesh(this: MeshPart, meshPart: MeshPart): void;
|
|
24127
24126
|
}
|
|
24128
24127
|
|
|
24129
24128
|
/** An abstract class that all parts based on [solid modeling](https://developer.roblox.com/en-us/articles/3d-modeling-with-parts) inherit from. */
|
|
@@ -24311,7 +24310,7 @@ interface VehicleSeat extends BasePart {
|
|
|
24311
24310
|
/**
|
|
24312
24311
|
* Forces the character with the specified [Humanoid](https://developer.roblox.com/api-reference/class/Humanoid "Humanoid") to sit in the VehicleSeat.
|
|
24313
24312
|
*/
|
|
24314
|
-
Sit(this: VehicleSeat, humanoid: Humanoid):
|
|
24313
|
+
Sit(this: VehicleSeat, humanoid: Humanoid): void;
|
|
24315
24314
|
/**
|
|
24316
24315
|
* Tags: Hidden
|
|
24317
24316
|
*/
|
|
@@ -24374,7 +24373,7 @@ interface Model extends PVInstance {
|
|
|
24374
24373
|
* Tags: NotReplicated
|
|
24375
24374
|
*/
|
|
24376
24375
|
WorldPivot: CFrame;
|
|
24377
|
-
AddPersistentPlayer(this: Model, playerInstance?: Player):
|
|
24376
|
+
AddPersistentPlayer(this: Model, playerInstance?: Player): void;
|
|
24378
24377
|
/**
|
|
24379
24378
|
* 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.
|
|
24380
24379
|
*
|
|
@@ -24384,7 +24383,7 @@ interface Model extends PVInstance {
|
|
|
24384
24383
|
* Tags: Deprecated
|
|
24385
24384
|
* @deprecated
|
|
24386
24385
|
*/
|
|
24387
|
-
BreakJoints(this: Model):
|
|
24386
|
+
BreakJoints(this: Model): void;
|
|
24388
24387
|
/**
|
|
24389
24388
|
* 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**.
|
|
24390
24389
|
*
|
|
@@ -24465,7 +24464,7 @@ interface Model extends PVInstance {
|
|
|
24465
24464
|
* Tags: Deprecated
|
|
24466
24465
|
* @deprecated
|
|
24467
24466
|
*/
|
|
24468
|
-
MakeJoints(this: Model):
|
|
24467
|
+
MakeJoints(this: Model): void;
|
|
24469
24468
|
/**
|
|
24470
24469
|
* 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.
|
|
24471
24470
|
*
|
|
@@ -24473,21 +24472,21 @@ interface Model extends PVInstance {
|
|
|
24473
24472
|
*
|
|
24474
24473
|
* 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.
|
|
24475
24474
|
*/
|
|
24476
|
-
MoveTo(this: Model, position: Vector3):
|
|
24477
|
-
RemovePersistentPlayer(this: Model, playerInstance?: Player):
|
|
24475
|
+
MoveTo(this: Model, position: Vector3): void;
|
|
24476
|
+
RemovePersistentPlayer(this: Model, playerInstance?: Player): void;
|
|
24478
24477
|
/**
|
|
24479
24478
|
* 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.
|
|
24480
24479
|
* Tags: Deprecated, [object Object]
|
|
24481
24480
|
* @deprecated
|
|
24482
24481
|
*/
|
|
24483
|
-
ResetOrientationToIdentity(this: Model):
|
|
24484
|
-
ScaleTo(this: Model, newScaleFactor: number):
|
|
24482
|
+
ResetOrientationToIdentity(this: Model): void;
|
|
24483
|
+
ScaleTo(this: Model, newScaleFactor: number): void;
|
|
24485
24484
|
/**
|
|
24486
24485
|
* 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.
|
|
24487
24486
|
* Tags: Deprecated, [object Object]
|
|
24488
24487
|
* @deprecated
|
|
24489
24488
|
*/
|
|
24490
|
-
SetIdentityOrientation(this: Model):
|
|
24489
|
+
SetIdentityOrientation(this: Model): void;
|
|
24491
24490
|
/**
|
|
24492
24491
|
* 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.
|
|
24493
24492
|
*
|
|
@@ -24505,13 +24504,13 @@ interface Model extends PVInstance {
|
|
|
24505
24504
|
* Tags: Deprecated, [object Object]
|
|
24506
24505
|
* @deprecated
|
|
24507
24506
|
*/
|
|
24508
|
-
SetPrimaryPartCFrame(this: Model, cframe: CFrame):
|
|
24507
|
+
SetPrimaryPartCFrame(this: Model, cframe: CFrame): void;
|
|
24509
24508
|
/**
|
|
24510
24509
|
* 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.
|
|
24511
24510
|
*
|
|
24512
24511
|
* 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.
|
|
24513
24512
|
*/
|
|
24514
|
-
TranslateBy(this: Model, delta: Vector3):
|
|
24513
|
+
TranslateBy(this: Model, delta: Vector3): void;
|
|
24515
24514
|
}
|
|
24516
24515
|
|
|
24517
24516
|
/** This is the Actor Class */
|
|
@@ -24526,7 +24525,7 @@ interface Actor extends Model {
|
|
|
24526
24525
|
readonly _nominal_Actor: unique symbol;
|
|
24527
24526
|
BindToMessage(this: Actor, topic: string, callback: Callback): RBXScriptConnection;
|
|
24528
24527
|
BindToMessageParallel(this: Actor, topic: string, callback: Callback): RBXScriptConnection;
|
|
24529
|
-
SendMessage(this: Actor, topic: string, message: Array<any>):
|
|
24528
|
+
SendMessage(this: Actor, topic: string, message: Array<any>): void;
|
|
24530
24529
|
}
|
|
24531
24530
|
|
|
24532
24531
|
/** BackpackItem is an abstract class for backpack items such as HopperBins and Tools. */
|
|
@@ -24681,7 +24680,7 @@ interface Tool extends BackpackItem {
|
|
|
24681
24680
|
*
|
|
24682
24681
|
* tool.Activated:Connect(toolActivated)
|
|
24683
24682
|
*/
|
|
24684
|
-
Activate(this: Tool):
|
|
24683
|
+
Activate(this: Tool): void;
|
|
24685
24684
|
/**
|
|
24686
24685
|
* 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.
|
|
24687
24686
|
*
|
|
@@ -24703,7 +24702,7 @@ interface Tool extends BackpackItem {
|
|
|
24703
24702
|
*
|
|
24704
24703
|
* tool.Deactivated:Connect(toolDeactivated)
|
|
24705
24704
|
*/
|
|
24706
|
-
Deactivate(this: Tool):
|
|
24705
|
+
Deactivate(this: Tool): void;
|
|
24707
24706
|
/**
|
|
24708
24707
|
* **Activated** is not called if the Ctrl key is pressed during a click.
|
|
24709
24708
|
*
|
|
@@ -24790,7 +24789,7 @@ interface WorldRoot extends Model {
|
|
|
24790
24789
|
*
|
|
24791
24790
|
* 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.
|
|
24792
24791
|
*/
|
|
24793
|
-
BulkMoveTo(this: WorldRoot, partList: Array<Instance>, cframeList: Array<any>, eventMode?: CastsToEnum<Enum.BulkMoveMode>):
|
|
24792
|
+
BulkMoveTo(this: WorldRoot, partList: Array<Instance>, cframeList: Array<any>, eventMode?: CastsToEnum<Enum.BulkMoveMode>): void;
|
|
24794
24793
|
/**
|
|
24795
24794
|
* **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.
|
|
24796
24795
|
*
|
|
@@ -25339,7 +25338,7 @@ interface Workspace extends WorldRoot {
|
|
|
25339
25338
|
*
|
|
25340
25339
|
* 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).
|
|
25341
25340
|
*/
|
|
25342
|
-
JoinToOutsiders(this: Workspace, objects: Array<Instance>, jointType: CastsToEnum<Enum.JointCreationMode>):
|
|
25341
|
+
JoinToOutsiders(this: Workspace, objects: Array<Instance>, jointType: CastsToEnum<Enum.JointCreationMode>): void;
|
|
25343
25342
|
/**
|
|
25344
25343
|
* Returns true if the game has the PGS Physics solver enabled.
|
|
25345
25344
|
*
|
|
@@ -25376,7 +25375,7 @@ interface Workspace extends WorldRoot {
|
|
|
25376
25375
|
*
|
|
25377
25376
|
* 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).
|
|
25378
25377
|
*/
|
|
25379
|
-
UnjoinFromOutsiders(this: Workspace, objects: Array<Instance>):
|
|
25378
|
+
UnjoinFromOutsiders(this: Workspace, objects: Array<Instance>): void;
|
|
25380
25379
|
readonly PersistentLoaded: RBXScriptSignal<(player: Player) => void>;
|
|
25381
25380
|
}
|
|
25382
25381
|
|
|
@@ -25482,7 +25481,7 @@ interface Pages<T = unknown> extends Instance {
|
|
|
25482
25481
|
* Iterates to the next page in the pages object, if possible.
|
|
25483
25482
|
* Tags: Yields
|
|
25484
25483
|
*/
|
|
25485
|
-
AdvanceToNextPageAsync(this: Pages):
|
|
25484
|
+
AdvanceToNextPageAsync(this: Pages): void;
|
|
25486
25485
|
}
|
|
25487
25486
|
|
|
25488
25487
|
interface AudioPages extends Pages {
|
|
@@ -25917,13 +25916,13 @@ interface ParticleEmitter extends Instance {
|
|
|
25917
25916
|
*
|
|
25918
25917
|
* 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).
|
|
25919
25918
|
*/
|
|
25920
|
-
Clear(this: ParticleEmitter):
|
|
25919
|
+
Clear(this: ParticleEmitter): void;
|
|
25921
25920
|
/**
|
|
25922
25921
|
* 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.
|
|
25923
25922
|
*
|
|
25924
25923
|
* To clear any emit particles, use [ParticleEmitter:Clear](https://developer.roblox.com/en-us/api-reference/function/ParticleEmitter/Clear).
|
|
25925
25924
|
*/
|
|
25926
|
-
Emit(this: ParticleEmitter, particleCount?: number):
|
|
25925
|
+
Emit(this: ParticleEmitter, particleCount?: number): void;
|
|
25927
25926
|
/**
|
|
25928
25927
|
* Tags: Hidden
|
|
25929
25928
|
*/
|
|
@@ -26015,7 +26014,7 @@ interface Path extends Instance {
|
|
|
26015
26014
|
* * [Pathfinding](https://developer.roblox.com/en-us/articles/pathfinding), provides an in-depth pathfinding walkthrough
|
|
26016
26015
|
* Tags: Yields
|
|
26017
26016
|
*/
|
|
26018
|
-
ComputeAsync(this: Path, start: Vector3, finish: Vector3):
|
|
26017
|
+
ComputeAsync(this: Path, start: Vector3, finish: Vector3): void;
|
|
26019
26018
|
readonly Blocked: RBXScriptSignal<(blockedWaypointIdx: number) => void>;
|
|
26020
26019
|
readonly Unblocked: RBXScriptSignal<(unblockedWaypointIdx: number) => void>;
|
|
26021
26020
|
}
|
|
@@ -26274,7 +26273,7 @@ interface PhysicsService extends Instance {
|
|
|
26274
26273
|
*
|
|
26275
26274
|
* This function will throw an error if either of the groups do not exist.
|
|
26276
26275
|
*/
|
|
26277
|
-
CollisionGroupSetCollidable(this: PhysicsService, name1: string, name2: string, collidable: boolean):
|
|
26276
|
+
CollisionGroupSetCollidable(this: PhysicsService, name1: string, name2: string, collidable: boolean): void;
|
|
26278
26277
|
/**
|
|
26279
26278
|
* Returns whether the two specified collision groups will collide.
|
|
26280
26279
|
*
|
|
@@ -26339,7 +26338,7 @@ interface PhysicsService extends Instance {
|
|
|
26339
26338
|
GetMaxCollisionGroups(this: PhysicsService): number;
|
|
26340
26339
|
GetRegisteredCollisionGroups(this: PhysicsService): unknown;
|
|
26341
26340
|
IsCollisionGroupRegistered(this: PhysicsService, name: string): boolean;
|
|
26342
|
-
RegisterCollisionGroup(this: PhysicsService, name: string):
|
|
26341
|
+
RegisterCollisionGroup(this: PhysicsService, name: string): void;
|
|
26343
26342
|
/**
|
|
26344
26343
|
* 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.
|
|
26345
26344
|
*
|
|
@@ -26352,7 +26351,7 @@ interface PhysicsService extends Instance {
|
|
|
26352
26351
|
* Tags: Deprecated, [object Object]
|
|
26353
26352
|
* @deprecated
|
|
26354
26353
|
*/
|
|
26355
|
-
RemoveCollisionGroup(this: PhysicsService, name: string):
|
|
26354
|
+
RemoveCollisionGroup(this: PhysicsService, name: string): void;
|
|
26356
26355
|
/**
|
|
26357
26356
|
* 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.
|
|
26358
26357
|
*
|
|
@@ -26363,7 +26362,7 @@ interface PhysicsService extends Instance {
|
|
|
26363
26362
|
* * Invalid or empty name provided for either argument.
|
|
26364
26363
|
* * The function is called from a client.
|
|
26365
26364
|
*/
|
|
26366
|
-
RenameCollisionGroup(this: PhysicsService, from: string, to: string):
|
|
26365
|
+
RenameCollisionGroup(this: PhysicsService, from: string, to: string): void;
|
|
26367
26366
|
/**
|
|
26368
26367
|
* The SetPartCollisionGroup function sets the collision group of the specified part to the group with the specified name.
|
|
26369
26368
|
*
|
|
@@ -26378,8 +26377,8 @@ interface PhysicsService extends Instance {
|
|
|
26378
26377
|
* Tags: Deprecated, [object Object]
|
|
26379
26378
|
* @deprecated
|
|
26380
26379
|
*/
|
|
26381
|
-
SetPartCollisionGroup(this: PhysicsService, part: BasePart, name: string):
|
|
26382
|
-
UnregisterCollisionGroup(this: PhysicsService, name: string):
|
|
26380
|
+
SetPartCollisionGroup(this: PhysicsService, part: BasePart, name: string): void;
|
|
26381
|
+
UnregisterCollisionGroup(this: PhysicsService, name: string): void;
|
|
26383
26382
|
}
|
|
26384
26383
|
|
|
26385
26384
|
/** 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.
|
|
@@ -26728,7 +26727,7 @@ interface Player extends Instance {
|
|
|
26728
26727
|
*
|
|
26729
26728
|
* It does not remove [t-shirts](https://developer.roblox.com/en-us/api-reference/class/ShirtGraphic), head meshes, or faces.
|
|
26730
26729
|
*/
|
|
26731
|
-
ClearCharacterAppearance(this: Player):
|
|
26730
|
+
ClearCharacterAppearance(this: Player): void;
|
|
26732
26731
|
/**
|
|
26733
26732
|
* 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).
|
|
26734
26733
|
*
|
|
@@ -26838,7 +26837,7 @@ interface Player extends Instance {
|
|
|
26838
26837
|
*
|
|
26839
26838
|
* 
|
|
26840
26839
|
*/
|
|
26841
|
-
Kick(this: Player, message?: string):
|
|
26840
|
+
Kick(this: Player, message?: string): void;
|
|
26842
26841
|
/**
|
|
26843
26842
|
* 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.
|
|
26844
26843
|
* Tags: Deprecated
|
|
@@ -26862,7 +26861,7 @@ interface Player extends Instance {
|
|
|
26862
26861
|
* Tags: Deprecated
|
|
26863
26862
|
* @deprecated
|
|
26864
26863
|
*/
|
|
26865
|
-
LoadCharacterAppearance(this: Player, assetInstance: Instance):
|
|
26864
|
+
LoadCharacterAppearance(this: Player, assetInstance: Instance): void;
|
|
26866
26865
|
/**
|
|
26867
26866
|
* 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.
|
|
26868
26867
|
* Tags: Deprecated
|
|
@@ -26888,31 +26887,31 @@ interface Player extends Instance {
|
|
|
26888
26887
|
*
|
|
26889
26888
|
* 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_).
|
|
26890
26889
|
*/
|
|
26891
|
-
Move(this: Player, walkDirection: Vector3, relativeToCamera?: boolean):
|
|
26890
|
+
Move(this: Player, walkDirection: Vector3, relativeToCamera?: boolean): void;
|
|
26892
26891
|
/**
|
|
26893
26892
|
* 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).
|
|
26894
26893
|
* Tags: Deprecated
|
|
26895
26894
|
* @deprecated
|
|
26896
26895
|
*/
|
|
26897
|
-
SaveBoolean(this: Player, key: string, value: boolean):
|
|
26896
|
+
SaveBoolean(this: Player, key: string, value: boolean): void;
|
|
26898
26897
|
/**
|
|
26899
26898
|
* 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)…
|
|
26900
26899
|
* Tags: Deprecated
|
|
26901
26900
|
* @deprecated
|
|
26902
26901
|
*/
|
|
26903
|
-
SaveInstance(this: Player, key: string, value: Instance):
|
|
26902
|
+
SaveInstance(this: Player, key: string, value: Instance): void;
|
|
26904
26903
|
/**
|
|
26905
26904
|
* 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).
|
|
26906
26905
|
* Tags: Deprecated
|
|
26907
26906
|
* @deprecated
|
|
26908
26907
|
*/
|
|
26909
|
-
SaveNumber(this: Player, key: string, value: number):
|
|
26908
|
+
SaveNumber(this: Player, key: string, value: number): void;
|
|
26910
26909
|
/**
|
|
26911
26910
|
* 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).
|
|
26912
26911
|
* Tags: Deprecated
|
|
26913
26912
|
* @deprecated
|
|
26914
26913
|
*/
|
|
26915
|
-
SaveString(this: Player, key: string, value: string):
|
|
26914
|
+
SaveString(this: Player, key: string, value: string): void;
|
|
26916
26915
|
/**
|
|
26917
26916
|
* This function returns a dictionary array of online friends, limited by the `maxFriends` value.
|
|
26918
26917
|
*
|
|
@@ -27108,7 +27107,7 @@ interface Player extends Instance {
|
|
|
27108
27107
|
* For more details, see the [Game Content Streaming](https://developer.roblox.com/en-us/articles/content-streaming) article.
|
|
27109
27108
|
* Tags: Yields
|
|
27110
27109
|
*/
|
|
27111
|
-
RequestStreamAroundAsync(this: Player, position: Vector3, timeOut?: number):
|
|
27110
|
+
RequestStreamAroundAsync(this: Player, position: Vector3, timeOut?: number): void;
|
|
27112
27111
|
/**
|
|
27113
27112
|
* 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
|
|
27114
27113
|
* Tags: Yields, Deprecated
|
|
@@ -27211,35 +27210,35 @@ interface PlayerScripts extends Instance {
|
|
|
27211
27210
|
/**
|
|
27212
27211
|
* Unregisters all ComputerCameraMovementMode enums from the game settings menu.
|
|
27213
27212
|
*/
|
|
27214
|
-
ClearComputerCameraMovementModes(this: PlayerScripts):
|
|
27213
|
+
ClearComputerCameraMovementModes(this: PlayerScripts): void;
|
|
27215
27214
|
/**
|
|
27216
27215
|
* Unregisters all ComputerMovementMode enums from the game settings menu.
|
|
27217
27216
|
*/
|
|
27218
|
-
ClearComputerMovementModes(this: PlayerScripts):
|
|
27217
|
+
ClearComputerMovementModes(this: PlayerScripts): void;
|
|
27219
27218
|
/**
|
|
27220
27219
|
* Unregisters all TouchCameraMovementMode enums from the game settings menu.
|
|
27221
27220
|
*/
|
|
27222
|
-
ClearTouchCameraMovementModes(this: PlayerScripts):
|
|
27221
|
+
ClearTouchCameraMovementModes(this: PlayerScripts): void;
|
|
27223
27222
|
/**
|
|
27224
27223
|
* Unregisters all TouchMovementMode enums from the game settings menu.
|
|
27225
27224
|
*/
|
|
27226
|
-
ClearTouchMovementModes(this: PlayerScripts):
|
|
27225
|
+
ClearTouchMovementModes(this: PlayerScripts): void;
|
|
27227
27226
|
/**
|
|
27228
27227
|
* Registers that a computer camera movement mode is available to be selected from the game menu.
|
|
27229
27228
|
*/
|
|
27230
|
-
RegisterComputerCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.ComputerCameraMovementMode>):
|
|
27229
|
+
RegisterComputerCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.ComputerCameraMovementMode>): void;
|
|
27231
27230
|
/**
|
|
27232
27231
|
* Registers that a computer movement mode is available to be selected from the game menu.
|
|
27233
27232
|
*/
|
|
27234
|
-
RegisterComputerMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.ComputerMovementMode>):
|
|
27233
|
+
RegisterComputerMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.ComputerMovementMode>): void;
|
|
27235
27234
|
/**
|
|
27236
27235
|
* Registers that a touch camera movement mode is available to be selected from the game menu.
|
|
27237
27236
|
*/
|
|
27238
|
-
RegisterTouchCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.TouchCameraMovementMode>):
|
|
27237
|
+
RegisterTouchCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.TouchCameraMovementMode>): void;
|
|
27239
27238
|
/**
|
|
27240
27239
|
* Registers that a touch movement mode is available to be selected from the game menu.
|
|
27241
27240
|
*/
|
|
27242
|
-
RegisterTouchMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.TouchMovementMode>):
|
|
27241
|
+
RegisterTouchMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.TouchMovementMode>): void;
|
|
27243
27242
|
}
|
|
27244
27243
|
|
|
27245
27244
|
/** 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. */
|
|
@@ -27879,7 +27878,7 @@ interface Pose extends PoseBase {
|
|
|
27879
27878
|
*
|
|
27880
27879
|
* 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.
|
|
27881
27880
|
*/
|
|
27882
|
-
AddSubPose(this: Pose, pose: Pose):
|
|
27881
|
+
AddSubPose(this: Pose, pose: Pose): void;
|
|
27883
27882
|
/**
|
|
27884
27883
|
* 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).
|
|
27885
27884
|
*
|
|
@@ -27891,7 +27890,7 @@ interface Pose extends PoseBase {
|
|
|
27891
27890
|
*
|
|
27892
27891
|
* 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.
|
|
27893
27892
|
*/
|
|
27894
|
-
RemoveSubPose(this: Pose, pose: Pose):
|
|
27893
|
+
RemoveSubPose(this: Pose, pose: Pose): void;
|
|
27895
27894
|
}
|
|
27896
27895
|
|
|
27897
27896
|
/** 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.
|
|
@@ -28182,11 +28181,11 @@ interface ProximityPrompt extends Instance {
|
|
|
28182
28181
|
/**
|
|
28183
28182
|
* 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.
|
|
28184
28183
|
*/
|
|
28185
|
-
InputHoldBegin(this: ProximityPrompt):
|
|
28184
|
+
InputHoldBegin(this: ProximityPrompt): void;
|
|
28186
28185
|
/**
|
|
28187
28186
|
* 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.
|
|
28188
28187
|
*/
|
|
28189
|
-
InputHoldEnd(this: ProximityPrompt):
|
|
28188
|
+
InputHoldEnd(this: ProximityPrompt): void;
|
|
28190
28189
|
/**
|
|
28191
28190
|
* 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.
|
|
28192
28191
|
*/
|
|
@@ -28508,7 +28507,7 @@ interface ReplicatedFirst extends Instance {
|
|
|
28508
28507
|
*
|
|
28509
28508
|
* 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.
|
|
28510
28509
|
*/
|
|
28511
|
-
RemoveDefaultLoadingScreen(this: ReplicatedFirst):
|
|
28510
|
+
RemoveDefaultLoadingScreen(this: ReplicatedFirst): void;
|
|
28512
28511
|
}
|
|
28513
28512
|
|
|
28514
28513
|
/** **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).
|
|
@@ -28882,7 +28881,7 @@ interface RunService extends Instance {
|
|
|
28882
28881
|
* print("An error occurred: "..message)
|
|
28883
28882
|
* end
|
|
28884
28883
|
*/
|
|
28885
|
-
UnbindFromRenderStep(this: RunService, name: string):
|
|
28884
|
+
UnbindFromRenderStep(this: RunService, name: string): void;
|
|
28886
28885
|
/**
|
|
28887
28886
|
* 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.
|
|
28888
28887
|
*
|
|
@@ -29121,7 +29120,7 @@ interface SensorBase extends Instance {
|
|
|
29121
29120
|
* Tags: Deprecated
|
|
29122
29121
|
* @deprecated
|
|
29123
29122
|
*/
|
|
29124
|
-
Sense(this: SensorBase):
|
|
29123
|
+
Sense(this: SensorBase): void;
|
|
29125
29124
|
readonly OnSensorOutputChanged: RBXScriptSignal<() => void>;
|
|
29126
29125
|
}
|
|
29127
29126
|
|
|
@@ -29592,7 +29591,7 @@ interface UserSettings extends GenericSettings<{ UserGameSettings: UserGameSetti
|
|
|
29592
29591
|
/**
|
|
29593
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.
|
|
29594
29593
|
*/
|
|
29595
|
-
Reset(this: UserSettings):
|
|
29594
|
+
Reset(this: UserSettings): void;
|
|
29596
29595
|
}
|
|
29597
29596
|
|
|
29598
29597
|
interface ServiceVisibilityService extends Instance {
|
|
@@ -29627,7 +29626,7 @@ interface SharedTableRegistry extends Instance {
|
|
|
29627
29626
|
*/
|
|
29628
29627
|
readonly _nominal_SharedTableRegistry: unique symbol;
|
|
29629
29628
|
GetSharedTable(this: SharedTableRegistry, name: string): SharedTable;
|
|
29630
|
-
SetSharedTable(this: SharedTableRegistry, name: string, st: SharedTable | undefined):
|
|
29629
|
+
SetSharedTable(this: SharedTableRegistry, name: string, st: SharedTable | undefined): void;
|
|
29631
29630
|
}
|
|
29632
29631
|
|
|
29633
29632
|
interface ShorelineUpgraderService extends Instance {
|
|
@@ -29815,7 +29814,7 @@ interface SocialService extends Instance {
|
|
|
29815
29814
|
*
|
|
29816
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.\`
|
|
29817
29816
|
*/
|
|
29818
|
-
PromptGameInvite(this: SocialService, player: Player, experienceInviteOptions?: ExperienceInviteOptions):
|
|
29817
|
+
PromptGameInvite(this: SocialService, player: Player, experienceInviteOptions?: ExperienceInviteOptions): void;
|
|
29819
29818
|
/**
|
|
29820
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.
|
|
29821
29820
|
*
|
|
@@ -30134,7 +30133,7 @@ interface Sound extends Instance {
|
|
|
30134
30133
|
*
|
|
30135
30134
|
* 0
|
|
30136
30135
|
*/
|
|
30137
|
-
Pause(this: Sound):
|
|
30136
|
+
Pause(this: Sound): void;
|
|
30138
30137
|
/**
|
|
30139
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.
|
|
30140
30139
|
*
|
|
@@ -30170,7 +30169,7 @@ interface Sound extends Instance {
|
|
|
30170
30169
|
*
|
|
30171
30170
|
* 0
|
|
30172
30171
|
*/
|
|
30173
|
-
Play(this: Sound):
|
|
30172
|
+
Play(this: Sound): void;
|
|
30174
30173
|
/**
|
|
30175
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).
|
|
30176
30175
|
*
|
|
@@ -30206,7 +30205,7 @@ interface Sound extends Instance {
|
|
|
30206
30205
|
*
|
|
30207
30206
|
* 0
|
|
30208
30207
|
*/
|
|
30209
|
-
Resume(this: Sound):
|
|
30208
|
+
Resume(this: Sound): void;
|
|
30210
30209
|
/**
|
|
30211
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.
|
|
30212
30211
|
*
|
|
@@ -30242,7 +30241,7 @@ interface Sound extends Instance {
|
|
|
30242
30241
|
*
|
|
30243
30242
|
* 0
|
|
30244
30243
|
*/
|
|
30245
|
-
Stop(this: Sound):
|
|
30244
|
+
Stop(this: Sound): void;
|
|
30246
30245
|
/**
|
|
30247
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.
|
|
30248
30247
|
*
|
|
@@ -30946,37 +30945,6 @@ interface Sparkles extends Instance {
|
|
|
30946
30945
|
TimeScale: number;
|
|
30947
30946
|
}
|
|
30948
30947
|
|
|
30949
|
-
interface Speaker extends Instance {
|
|
30950
|
-
/**
|
|
30951
|
-
* **DO NOT USE!**
|
|
30952
|
-
*
|
|
30953
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
30954
|
-
* @hidden
|
|
30955
|
-
* @deprecated
|
|
30956
|
-
*/
|
|
30957
|
-
readonly _nominal_Speaker: unique symbol;
|
|
30958
|
-
/**
|
|
30959
|
-
* Tags: ReadOnly, NotReplicated, NotBrowsable
|
|
30960
|
-
*/
|
|
30961
|
-
readonly ChannelCount: number;
|
|
30962
|
-
/**
|
|
30963
|
-
* Tags: ReadOnly, NotReplicated
|
|
30964
|
-
*/
|
|
30965
|
-
readonly PlaybackLoudness: number;
|
|
30966
|
-
/**
|
|
30967
|
-
* Tags: NotReplicated
|
|
30968
|
-
*/
|
|
30969
|
-
RollOffMaxDistance: number;
|
|
30970
|
-
/**
|
|
30971
|
-
* Tags: NotReplicated
|
|
30972
|
-
*/
|
|
30973
|
-
RollOffMinDistance: number;
|
|
30974
|
-
RollOffMode: Enum.RollOffMode;
|
|
30975
|
-
SoundGroup: SoundGroup | undefined;
|
|
30976
|
-
Source: Instance | undefined;
|
|
30977
|
-
Volume: number;
|
|
30978
|
-
}
|
|
30979
|
-
|
|
30980
30948
|
interface StackFrame extends Instance {
|
|
30981
30949
|
/**
|
|
30982
30950
|
* **DO NOT USE!**
|
|
@@ -31688,7 +31656,7 @@ interface Teams extends Instance {
|
|
|
31688
31656
|
* Tags: Deprecated
|
|
31689
31657
|
* @deprecated
|
|
31690
31658
|
*/
|
|
31691
|
-
RebalanceTeams(this: Teams):
|
|
31659
|
+
RebalanceTeams(this: Teams): void;
|
|
31692
31660
|
}
|
|
31693
31661
|
|
|
31694
31662
|
/** This class is an instance that is returned by the `TeleportAsync` function with information about the teleport. */
|
|
@@ -31817,7 +31785,7 @@ interface TeleportOptions extends Instance {
|
|
|
31817
31785
|
*
|
|
31818
31786
|
* For more information on how to teleport players between servers, take a look at the [Telporting Between Places](../../../articles/Teleporting-Between-Places) article.
|
|
31819
31787
|
*/
|
|
31820
|
-
SetTeleportData(this: TeleportOptions, teleportData: unknown):
|
|
31788
|
+
SetTeleportData(this: TeleportOptions, teleportData: unknown): void;
|
|
31821
31789
|
}
|
|
31822
31790
|
|
|
31823
31791
|
/** 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.
|
|
@@ -32732,9 +32700,6 @@ interface ChatInputBarConfiguration extends TextChatConfigurations {
|
|
|
32732
32700
|
* Tags: ReadOnly, NotReplicated
|
|
32733
32701
|
*/
|
|
32734
32702
|
readonly IsFocused: boolean;
|
|
32735
|
-
/**
|
|
32736
|
-
* Tags: Hidden
|
|
32737
|
-
*/
|
|
32738
32703
|
KeyboardKeyCode: Enum.KeyCode;
|
|
32739
32704
|
PlaceholderColor3: Color3;
|
|
32740
32705
|
TargetTextChannel: TextChannel | undefined;
|
|
@@ -33254,7 +33219,7 @@ interface Trail extends Instance {
|
|
|
33254
33219
|
*
|
|
33255
33220
|
* 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.
|
|
33256
33221
|
*/
|
|
33257
|
-
Clear(this: Trail):
|
|
33222
|
+
Clear(this: Trail): void;
|
|
33258
33223
|
/**
|
|
33259
33224
|
* Tags: Hidden
|
|
33260
33225
|
*/
|
|
@@ -33408,7 +33373,7 @@ interface TweenBase extends Instance {
|
|
|
33408
33373
|
*
|
|
33409
33374
|
* 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.
|
|
33410
33375
|
*/
|
|
33411
|
-
Cancel(this: TweenBase):
|
|
33376
|
+
Cancel(this: TweenBase): void;
|
|
33412
33377
|
/**
|
|
33413
33378
|
* 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.
|
|
33414
33379
|
*
|
|
@@ -33416,13 +33381,13 @@ interface TweenBase extends Instance {
|
|
|
33416
33381
|
*
|
|
33417
33382
|
* This means a tween paused half way through its animation will take half of its duration to complete when resumed.
|
|
33418
33383
|
*/
|
|
33419
|
-
Pause(this: TweenBase):
|
|
33384
|
+
Pause(this: TweenBase): void;
|
|
33420
33385
|
/**
|
|
33421
33386
|
* 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)).
|
|
33422
33387
|
*
|
|
33423
33388
|
* 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).
|
|
33424
33389
|
*/
|
|
33425
|
-
Play(this: TweenBase):
|
|
33390
|
+
Play(this: TweenBase): void;
|
|
33426
33391
|
/**
|
|
33427
33392
|
* 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).
|
|
33428
33393
|
*
|
|
@@ -33885,7 +33850,7 @@ interface UIGridStyleLayout extends UILayout {
|
|
|
33885
33850
|
* Tags: Deprecated
|
|
33886
33851
|
* @deprecated
|
|
33887
33852
|
*/
|
|
33888
|
-
ApplyLayout(this: UIGridStyleLayout):
|
|
33853
|
+
ApplyLayout(this: UIGridStyleLayout): void;
|
|
33889
33854
|
/**
|
|
33890
33855
|
* This method is deprecated. Use [UIGridStyleLayout.SortOrder](https://developer.roblox.com/en-us/api-reference/property/UIGridStyleLayout/SortOrder) instead.
|
|
33891
33856
|
*
|
|
@@ -33894,7 +33859,7 @@ interface UIGridStyleLayout extends UILayout {
|
|
|
33894
33859
|
* Tags: Deprecated
|
|
33895
33860
|
* @deprecated
|
|
33896
33861
|
*/
|
|
33897
|
-
SetCustomSortFunction(this: UIGridStyleLayout, callback?: Callback):
|
|
33862
|
+
SetCustomSortFunction(this: UIGridStyleLayout, callback?: Callback): void;
|
|
33898
33863
|
}
|
|
33899
33864
|
|
|
33900
33865
|
/** 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.
|
|
@@ -34040,15 +34005,15 @@ interface UIPageLayout extends UIGridStyleLayout {
|
|
|
34040
34005
|
/**
|
|
34041
34006
|
* 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.
|
|
34042
34007
|
*/
|
|
34043
|
-
JumpToIndex(this: UIPageLayout, index: number):
|
|
34008
|
+
JumpToIndex(this: UIPageLayout, index: number): void;
|
|
34044
34009
|
/**
|
|
34045
34010
|
* 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.
|
|
34046
34011
|
*/
|
|
34047
|
-
Next(this: UIPageLayout):
|
|
34012
|
+
Next(this: UIPageLayout): void;
|
|
34048
34013
|
/**
|
|
34049
34014
|
* 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.
|
|
34050
34015
|
*/
|
|
34051
|
-
Previous(this: UIPageLayout):
|
|
34016
|
+
Previous(this: UIPageLayout): void;
|
|
34052
34017
|
/**
|
|
34053
34018
|
* Fires when a page comes into view, and is going to be rendered.
|
|
34054
34019
|
*/
|
|
@@ -34422,11 +34387,11 @@ interface UserGameSettings extends Instance {
|
|
|
34422
34387
|
/**
|
|
34423
34388
|
* If called, Roblox toggles the menu option to invert the user's camera y axis.
|
|
34424
34389
|
*/
|
|
34425
|
-
SetCameraYInvertVisible(this: UserGameSettings):
|
|
34390
|
+
SetCameraYInvertVisible(this: UserGameSettings): void;
|
|
34426
34391
|
/**
|
|
34427
34392
|
* If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.
|
|
34428
34393
|
*/
|
|
34429
|
-
SetGamepadCameraSensitivityVisible(this: UserGameSettings):
|
|
34394
|
+
SetGamepadCameraSensitivityVisible(this: UserGameSettings): void;
|
|
34430
34395
|
/**
|
|
34431
34396
|
* Sets the given onboarding as completed, so it won't be shown again to the user the next time they play.
|
|
34432
34397
|
*
|
|
@@ -34439,7 +34404,7 @@ interface UserGameSettings extends Instance {
|
|
|
34439
34404
|
*
|
|
34440
34405
|
* * [UserGameSettings:GetOnboardingCompleted](https://developer.roblox.com/en-us/api-reference/function/UserGameSettings/GetOnboardingCompleted), checks if onboarding has been completed
|
|
34441
34406
|
*/
|
|
34442
|
-
SetOnboardingCompleted(this: UserGameSettings, onboardingId: string):
|
|
34407
|
+
SetOnboardingCompleted(this: UserGameSettings, onboardingId: string): void;
|
|
34443
34408
|
/**
|
|
34444
34409
|
* Fires if the user's full screen mode is changed.
|
|
34445
34410
|
* 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.
|
|
@@ -35280,7 +35245,7 @@ interface UserInputService extends Instance {
|
|
|
35280
35245
|
*
|
|
35281
35246
|
* 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).
|
|
35282
35247
|
*/
|
|
35283
|
-
RecenterUserHeadCFrame(this: UserInputService):
|
|
35248
|
+
RecenterUserHeadCFrame(this: UserInputService): void;
|
|
35284
35249
|
/**
|
|
35285
35250
|
* 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_.
|
|
35286
35251
|
*
|
|
@@ -35307,7 +35272,7 @@ interface UserInputService extends Instance {
|
|
|
35307
35272
|
* * [UserInputService:GamepadSupports](https://developer.roblox.com/en-us/api-reference/function/UserInputService/GamepadSupports)
|
|
35308
35273
|
* * [UserInputService.GamepadEnabled](https://developer.roblox.com/en-us/api-reference/property/UserInputService/GamepadEnabled)
|
|
35309
35274
|
*/
|
|
35310
|
-
SetNavigationGamepad(this: UserInputService, gamepadEnum: CastsToEnum<Enum.UserInputType>, enabled: boolean):
|
|
35275
|
+
SetNavigationGamepad(this: UserInputService, gamepadEnum: CastsToEnum<Enum.UserInputType>, enabled: boolean): void;
|
|
35311
35276
|
/**
|
|
35312
35277
|
* The DeviceAccelerationChanged event fires when a user moves a device that has an accelerometer.
|
|
35313
35278
|
*
|
|
@@ -36044,7 +36009,7 @@ interface VRService extends Instance {
|
|
|
36044
36009
|
*
|
|
36045
36010
|
* Since `/VRServiceService` only runs client-side, this function will only work when used in a `/LocalScript`.
|
|
36046
36011
|
*/
|
|
36047
|
-
RecenterUserHeadCFrame(this: VRService):
|
|
36012
|
+
RecenterUserHeadCFrame(this: VRService): void;
|
|
36048
36013
|
/**
|
|
36049
36014
|
* 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.
|
|
36050
36015
|
*
|
|
@@ -36054,7 +36019,7 @@ interface VRService extends Instance {
|
|
|
36054
36019
|
*
|
|
36055
36020
|
* Since VRService only runs client-side, this function will only work when used in a `/LocalScript`.
|
|
36056
36021
|
*/
|
|
36057
|
-
RequestNavigation(this: VRService, cframe: CFrame, inputUserCFrame: CastsToEnum<Enum.UserCFrame>):
|
|
36022
|
+
RequestNavigation(this: VRService, cframe: CFrame, inputUserCFrame: CastsToEnum<Enum.UserCFrame>): void;
|
|
36058
36023
|
/**
|
|
36059
36024
|
* 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).
|
|
36060
36025
|
*
|
|
@@ -36064,7 +36029,7 @@ interface VRService extends Instance {
|
|
|
36064
36029
|
*
|
|
36065
36030
|
* Since `/VRService` only runs client-side, this function will only work when used in a `/LocalScript`.
|
|
36066
36031
|
*/
|
|
36067
|
-
SetTouchpadMode(this: VRService, pad: CastsToEnum<Enum.VRTouchpad>, mode: CastsToEnum<Enum.VRTouchpadMode>):
|
|
36032
|
+
SetTouchpadMode(this: VRService, pad: CastsToEnum<Enum.VRTouchpad>, mode: CastsToEnum<Enum.VRTouchpadMode>): void;
|
|
36068
36033
|
/**
|
|
36069
36034
|
* 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.
|
|
36070
36035
|
*
|
|
@@ -36626,7 +36591,7 @@ interface VoiceChatInternal extends Instance {
|
|
|
36626
36591
|
* Tags: Deprecated
|
|
36627
36592
|
* @deprecated
|
|
36628
36593
|
*/
|
|
36629
|
-
Leave(this: VoiceChatInternal):
|
|
36594
|
+
Leave(this: VoiceChatInternal): void;
|
|
36630
36595
|
/**
|
|
36631
36596
|
* Tags: Deprecated
|
|
36632
36597
|
* @deprecated
|
|
@@ -36636,12 +36601,12 @@ interface VoiceChatInternal extends Instance {
|
|
|
36636
36601
|
* Tags: Deprecated
|
|
36637
36602
|
* @deprecated
|
|
36638
36603
|
*/
|
|
36639
|
-
SetMicDevice(this: VoiceChatInternal, micDeviceName: string, micDeviceGuid: string):
|
|
36604
|
+
SetMicDevice(this: VoiceChatInternal, micDeviceName: string, micDeviceGuid: string): void;
|
|
36640
36605
|
/**
|
|
36641
36606
|
* Tags: Deprecated
|
|
36642
36607
|
* @deprecated
|
|
36643
36608
|
*/
|
|
36644
|
-
SetSpeakerDevice(this: VoiceChatInternal, speakerDeviceName: string, speakerDeviceGuid: string):
|
|
36609
|
+
SetSpeakerDevice(this: VoiceChatInternal, speakerDeviceName: string, speakerDeviceGuid: string): void;
|
|
36645
36610
|
/**
|
|
36646
36611
|
* Tags: Deprecated
|
|
36647
36612
|
* @deprecated
|