@rbxts/types 1.0.853 → 1.0.855
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 +388 -104
- package/include/generated/PluginSecurity.d.ts +131 -17
- package/include/generated/enums.d.ts +113 -39
- package/package.json +1 -1
|
@@ -160,6 +160,7 @@ interface Services {
|
|
|
160
160
|
ServiceVisibilityService: ServiceVisibilityService;
|
|
161
161
|
SessionService: SessionService;
|
|
162
162
|
SharedTableRegistry: SharedTableRegistry;
|
|
163
|
+
SlimContentProvider: SlimContentProvider;
|
|
163
164
|
SmoothVoxelsUpgraderService: SmoothVoxelsUpgraderService;
|
|
164
165
|
SnippetService: SnippetService;
|
|
165
166
|
SocialService: SocialService;
|
|
@@ -692,6 +693,10 @@ interface Objects extends Instances {
|
|
|
692
693
|
EditableMesh: EditableMesh;
|
|
693
694
|
Object: RBXObject;
|
|
694
695
|
ScreenshotCapture: ScreenshotCapture;
|
|
696
|
+
TerrainIterateOperation: TerrainIterateOperation;
|
|
697
|
+
TerrainModifyOperation: TerrainModifyOperation;
|
|
698
|
+
TerrainReadOperation: TerrainReadOperation;
|
|
699
|
+
TerrainWriteOperation: TerrainWriteOperation;
|
|
695
700
|
VideoCapture: VideoCapture;
|
|
696
701
|
}
|
|
697
702
|
// GENERATED ROBLOX INSTANCE CLASSES
|
|
@@ -2553,7 +2558,7 @@ interface AnalyticsService extends Instance {
|
|
|
2553
2558
|
* @param currency The currency used. Examples: 'gold', 'gems', 'life.'.
|
|
2554
2559
|
* @param location The event location. A dictionary that each key-value represents an entry of location data. The key-value is a string-string pair. With this you can query which are the most popular "stores" then maybe you want to increase/lower the price for the stores. See the example below:
|
|
2555
2560
|
* ```lua
|
|
2556
|
-
* local location = { ["placeDesc"] = "Dungeon1", ["levelDesc"] = "level2", ["mapDesc"] = "LeftChamberMap", ["storeName"] = "DarkSmith", ["
|
|
2561
|
+
* local location = { ["placeDesc"] = "Dungeon1", ["levelDesc"] = "level2", ["mapDesc"] = "LeftChamberMap", ["storeName"] = "DarkSmith", ["userDefinedKey"] = "0005" }
|
|
2557
2562
|
* ```
|
|
2558
2563
|
* @param customData Optional. User defined data, could be a string, a number or a table.
|
|
2559
2564
|
*
|
|
@@ -2602,11 +2607,11 @@ interface AnalyticsService extends Instance {
|
|
|
2602
2607
|
* @param progressionStatus Indicates the status of the progression.
|
|
2603
2608
|
* @param location The event location. A dictionary that each key-value represents an entry of location data. The key-value is a string-string pair. With this developers can query where is the most frequent location for a specific progression event category. For example, the category could be "LevelUp".
|
|
2604
2609
|
* ```lua
|
|
2605
|
-
* local location = { ["placeDesc"] = "Dungeon1", ["levelDesc"] = "level2", ["mapDesc"] = "LeftChamberMap", ["ProgresionType"] = "LevelUp", ["
|
|
2610
|
+
* local location = { ["placeDesc"] = "Dungeon1", ["levelDesc"] = "level2", ["mapDesc"] = "LeftChamberMap", ["ProgresionType"] = "LevelUp", ["userDefinedKey5"] = "0005" }
|
|
2606
2611
|
* ```
|
|
2607
2612
|
* @param statistics Optional. A dictionary that each key-value represents an entry of statistics data that allows developers to track any specific data that they want to collect as players progress through their game. Key-Value is a string-number pair.
|
|
2608
2613
|
* ```lua
|
|
2609
|
-
* local statistics = { ["numberOfKills"] = 111, ["numberOfExp"] = 222, ["
|
|
2614
|
+
* local statistics = { ["numberOfKills"] = 111, ["numberOfExp"] = 222, ["userDefinedKey3"] = number, ["userDefinedKey4"] = number, ["userDefinedKey5"] = number }
|
|
2610
2615
|
* ```
|
|
2611
2616
|
* @param customData Optional. User defined data, could be a string, a number or a table.
|
|
2612
2617
|
*
|
|
@@ -3607,14 +3612,6 @@ interface AssetService extends Instance {
|
|
|
3607
3612
|
* @param editableMeshOptions Table containing options for the created `EditableMesh`. Currently no options are available since `FixedSize` will always be `false` for empty editable meshes.
|
|
3608
3613
|
*/
|
|
3609
3614
|
CreateEditableMesh(this: AssetService, editableMeshOptions?: object): EditableMesh;
|
|
3610
|
-
/**
|
|
3611
|
-
* - **ThreadSafety**: Unsafe
|
|
3612
|
-
*
|
|
3613
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateSurfaceAppearance)
|
|
3614
|
-
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
3615
|
-
* @param content
|
|
3616
|
-
*/
|
|
3617
|
-
CreateSurfaceAppearance(this: AssetService, content: object): SurfaceAppearance;
|
|
3618
3615
|
/**
|
|
3619
3616
|
* Uploads a new asset to Roblox from the given object.
|
|
3620
3617
|
*
|
|
@@ -3846,7 +3843,7 @@ interface AssetService extends Instance {
|
|
|
3846
3843
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#SavePlaceAsync)
|
|
3847
3844
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
3848
3845
|
*/
|
|
3849
|
-
SavePlaceAsync(this: AssetService): void;
|
|
3846
|
+
SavePlaceAsync(this: AssetService, requestParameters?: object): void;
|
|
3850
3847
|
/**
|
|
3851
3848
|
* Finds audio assets matching a variety of search criteria.
|
|
3852
3849
|
*
|
|
@@ -5786,6 +5783,8 @@ interface AudioPlayer extends Instance {
|
|
|
5786
5783
|
readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
|
|
5787
5784
|
}
|
|
5788
5785
|
/**
|
|
5786
|
+
* Records audio streams in-experience.
|
|
5787
|
+
*
|
|
5789
5788
|
* - **Tags**: NotBrowsable
|
|
5790
5789
|
*
|
|
5791
5790
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder)
|
|
@@ -5816,14 +5815,14 @@ interface AudioRecorder extends Instance {
|
|
|
5816
5815
|
* - **ThreadSafety**: Unsafe
|
|
5817
5816
|
*
|
|
5818
5817
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#Clear)
|
|
5819
|
-
* @param this
|
|
5818
|
+
* @param this Records audio streams in-experience.
|
|
5820
5819
|
*/
|
|
5821
5820
|
Clear(this: AudioRecorder): void;
|
|
5822
5821
|
/**
|
|
5823
5822
|
* - **ThreadSafety**: Unsafe
|
|
5824
5823
|
*
|
|
5825
5824
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetConnectedWires)
|
|
5826
|
-
* @param this
|
|
5825
|
+
* @param this Records audio streams in-experience.
|
|
5827
5826
|
* @param pin
|
|
5828
5827
|
*/
|
|
5829
5828
|
GetConnectedWires(this: AudioRecorder, pin: string): Array<Instance>;
|
|
@@ -5831,28 +5830,28 @@ interface AudioRecorder extends Instance {
|
|
|
5831
5830
|
* - **ThreadSafety**: Unsafe
|
|
5832
5831
|
*
|
|
5833
5832
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetInputPins)
|
|
5834
|
-
* @param this
|
|
5833
|
+
* @param this Records audio streams in-experience.
|
|
5835
5834
|
*/
|
|
5836
5835
|
GetInputPins(this: AudioRecorder): Array<unknown>;
|
|
5837
5836
|
/**
|
|
5838
5837
|
* - **ThreadSafety**: Unsafe
|
|
5839
5838
|
*
|
|
5840
5839
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetOutputPins)
|
|
5841
|
-
* @param this
|
|
5840
|
+
* @param this Records audio streams in-experience.
|
|
5842
5841
|
*/
|
|
5843
5842
|
GetOutputPins(this: AudioRecorder): Array<unknown>;
|
|
5844
5843
|
/**
|
|
5845
5844
|
* - **ThreadSafety**: Unsafe
|
|
5846
5845
|
*
|
|
5847
5846
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetTemporaryContent)
|
|
5848
|
-
* @param this
|
|
5847
|
+
* @param this Records audio streams in-experience.
|
|
5849
5848
|
*/
|
|
5850
5849
|
GetTemporaryContent(this: AudioRecorder): Content;
|
|
5851
5850
|
/**
|
|
5852
5851
|
* - **ThreadSafety**: Unsafe
|
|
5853
5852
|
*
|
|
5854
5853
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#Stop)
|
|
5855
|
-
* @param this
|
|
5854
|
+
* @param this Records audio streams in-experience.
|
|
5856
5855
|
*/
|
|
5857
5856
|
Stop(this: AudioRecorder): void;
|
|
5858
5857
|
/**
|
|
@@ -5860,7 +5859,7 @@ interface AudioRecorder extends Instance {
|
|
|
5860
5859
|
* - **Tags**: Yields
|
|
5861
5860
|
*
|
|
5862
5861
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#CanRecordAsync)
|
|
5863
|
-
* @param this
|
|
5862
|
+
* @param this Records audio streams in-experience.
|
|
5864
5863
|
*/
|
|
5865
5864
|
CanRecordAsync(this: AudioRecorder): boolean;
|
|
5866
5865
|
/**
|
|
@@ -5868,7 +5867,7 @@ interface AudioRecorder extends Instance {
|
|
|
5868
5867
|
* - **Tags**: Yields
|
|
5869
5868
|
*
|
|
5870
5869
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetUnrecordableInstancesAsync)
|
|
5871
|
-
* @param this
|
|
5870
|
+
* @param this Records audio streams in-experience.
|
|
5872
5871
|
*/
|
|
5873
5872
|
GetUnrecordableInstancesAsync(this: AudioRecorder): Array<Instance>;
|
|
5874
5873
|
/**
|
|
@@ -5876,7 +5875,7 @@ interface AudioRecorder extends Instance {
|
|
|
5876
5875
|
* - **Tags**: Yields
|
|
5877
5876
|
*
|
|
5878
5877
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#RecordAsync)
|
|
5879
|
-
* @param this
|
|
5878
|
+
* @param this Records audio streams in-experience.
|
|
5880
5879
|
*/
|
|
5881
5880
|
RecordAsync(this: AudioRecorder): void;
|
|
5882
5881
|
/**
|
|
@@ -6601,13 +6600,18 @@ interface AvatarCreationService extends Instance {
|
|
|
6601
6600
|
* @returns Dictionary of validation rules as detailed above.
|
|
6602
6601
|
*/
|
|
6603
6602
|
GetValidationRules(this: AvatarCreationService): object;
|
|
6603
|
+
/**
|
|
6604
|
+
* - **ThreadSafety**: Unsafe
|
|
6605
|
+
* - **Tags**: Yields
|
|
6606
|
+
*
|
|
6607
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AutoSetupAvatarAsync)
|
|
6608
|
+
*/
|
|
6609
|
+
AutoSetupAvatarAsync(this: AvatarCreationService, player: Player, model: Model): string;
|
|
6604
6610
|
/**
|
|
6605
6611
|
* - **ThreadSafety**: Unsafe
|
|
6606
6612
|
* - **Tags**: Yields
|
|
6607
6613
|
*
|
|
6608
6614
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#GenerateAvatar2DPreviewAsync)
|
|
6609
|
-
* @param this A service to support developer avatar creators.
|
|
6610
|
-
* @param avatarGeneration2dPreviewParams
|
|
6611
6615
|
*/
|
|
6612
6616
|
GenerateAvatar2DPreviewAsync(this: AvatarCreationService, avatarGeneration2dPreviewParams: object): string;
|
|
6613
6617
|
/**
|
|
@@ -6634,8 +6638,6 @@ interface AvatarCreationService extends Instance {
|
|
|
6634
6638
|
* - **Tags**: Yields
|
|
6635
6639
|
*
|
|
6636
6640
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#LoadAvatar2DPreviewAsync)
|
|
6637
|
-
* @param this A service to support developer avatar creators.
|
|
6638
|
-
* @param previewId
|
|
6639
6641
|
*/
|
|
6640
6642
|
LoadAvatar2DPreviewAsync(this: AvatarCreationService, previewId: string): EditableImage;
|
|
6641
6643
|
/**
|
|
@@ -6643,8 +6645,6 @@ interface AvatarCreationService extends Instance {
|
|
|
6643
6645
|
* - **Tags**: Yields
|
|
6644
6646
|
*
|
|
6645
6647
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#LoadGeneratedAvatarAsync)
|
|
6646
|
-
* @param this A service to support developer avatar creators.
|
|
6647
|
-
* @param generationId
|
|
6648
6648
|
*/
|
|
6649
6649
|
LoadGeneratedAvatarAsync(this: AvatarCreationService, generationId: string): HumanoidDescription;
|
|
6650
6650
|
/**
|
|
@@ -8534,9 +8534,9 @@ interface BindableFunction<T extends Callback = Callback> extends Instance {
|
|
|
8534
8534
|
OnInvoke: T | undefined;
|
|
8535
8535
|
}
|
|
8536
8536
|
/**
|
|
8537
|
-
* **Deprecated:** This class has been deprecated.
|
|
8537
|
+
* **Deprecated:** This class has been deprecated. See the [mover constraints](../../../physics/mover-constraints.md) article for an overview of `BodyMover` replacements, as well as the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8538
8538
|
*
|
|
8539
|
-
* Base class for objects that continually exert forces to
|
|
8539
|
+
* Base class for objects that continually exert forces to assemblies.
|
|
8540
8540
|
*
|
|
8541
8541
|
* - **Tags**: NotCreatable
|
|
8542
8542
|
*
|
|
@@ -8555,7 +8555,7 @@ interface BodyMover extends Instance {
|
|
|
8555
8555
|
readonly _nominal_BodyMover: unique symbol;
|
|
8556
8556
|
}
|
|
8557
8557
|
/**
|
|
8558
|
-
* **Deprecated:** This object is deprecated and should not be used for new work. Use `AngularVelocity` instead.
|
|
8558
|
+
* **Deprecated:** This object is deprecated and should not be used for new work. Use `AngularVelocity` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8559
8559
|
*
|
|
8560
8560
|
* Applies a torque to maintain a constant angular velocity.
|
|
8561
8561
|
*
|
|
@@ -8600,7 +8600,7 @@ interface BodyAngularVelocity extends BodyMover {
|
|
|
8600
8600
|
P: number;
|
|
8601
8601
|
}
|
|
8602
8602
|
/**
|
|
8603
|
-
* **Deprecated:** This object is deprecated and should not be used for new work. Use `VectorForce` instead.
|
|
8603
|
+
* **Deprecated:** This object is deprecated and should not be used for new work. Use `VectorForce` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8604
8604
|
*
|
|
8605
8605
|
* Applies a constant force to an object.
|
|
8606
8606
|
*
|
|
@@ -8629,7 +8629,7 @@ interface BodyForce extends BodyMover {
|
|
|
8629
8629
|
Force: Vector3;
|
|
8630
8630
|
}
|
|
8631
8631
|
/**
|
|
8632
|
-
* **Deprecated:** This object is deprecated and should not be used for new work. Use `AlignOrientation` instead.
|
|
8632
|
+
* **Deprecated:** This object is deprecated and should not be used for new work. Use `AlignOrientation` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8633
8633
|
*
|
|
8634
8634
|
* Applies a torque to maintain a constant orientation.
|
|
8635
8635
|
*
|
|
@@ -8682,7 +8682,7 @@ interface BodyGyro extends BodyMover {
|
|
|
8682
8682
|
P: number;
|
|
8683
8683
|
}
|
|
8684
8684
|
/**
|
|
8685
|
-
* **Deprecated:** This object is deprecated and should not be used for new work. Use `AlignPosition` instead.
|
|
8685
|
+
* **Deprecated:** This object is deprecated and should not be used for new work. Use `AlignPosition` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8686
8686
|
*
|
|
8687
8687
|
* Applies a force to maintain a constant position.
|
|
8688
8688
|
*
|
|
@@ -8739,7 +8739,7 @@ interface BodyPosition extends BodyMover {
|
|
|
8739
8739
|
* - **ThreadSafety**: Unsafe
|
|
8740
8740
|
*
|
|
8741
8741
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyPosition#GetLastForce)
|
|
8742
|
-
* @param this **Deprecated:** This object is deprecated and should not be used for new work. Use `AlignPosition` instead.
|
|
8742
|
+
* @param this **Deprecated:** This object is deprecated and should not be used for new work. Use `AlignPosition` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8743
8743
|
*
|
|
8744
8744
|
* Applies a force to maintain a constant position.
|
|
8745
8745
|
*/
|
|
@@ -8754,7 +8754,7 @@ interface BodyPosition extends BodyMover {
|
|
|
8754
8754
|
readonly ReachedTarget: RBXScriptSignal<() => void>;
|
|
8755
8755
|
}
|
|
8756
8756
|
/**
|
|
8757
|
-
* **Deprecated:** This object is deprecated and should not be used for new work. Use `VectorForce` instead.
|
|
8757
|
+
* **Deprecated:** This object is deprecated and should not be used for new work. Use `VectorForce` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8758
8758
|
*
|
|
8759
8759
|
* Applies a constant force to an object at a specific point.
|
|
8760
8760
|
*
|
|
@@ -8774,7 +8774,7 @@ interface BodyThrust extends BodyMover {
|
|
|
8774
8774
|
*/
|
|
8775
8775
|
readonly _nominal_BodyThrust: unique symbol;
|
|
8776
8776
|
/**
|
|
8777
|
-
* Determines the amount of force exerted on each axis relative to the
|
|
8777
|
+
* Determines the amount of force exerted on each axis relative to the assembly.
|
|
8778
8778
|
*
|
|
8779
8779
|
* - **ThreadSafety**: ReadSafe
|
|
8780
8780
|
*
|
|
@@ -8791,7 +8791,7 @@ interface BodyThrust extends BodyMover {
|
|
|
8791
8791
|
Location: Vector3;
|
|
8792
8792
|
}
|
|
8793
8793
|
/**
|
|
8794
|
-
* **Deprecated:** This object is deprecated and should not be used for new work. Use `LinearVelocity` instead.
|
|
8794
|
+
* **Deprecated:** This object is deprecated and should not be used for new work. Use `LinearVelocity` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8795
8795
|
*
|
|
8796
8796
|
* Applies a force to maintain a constant velocity.
|
|
8797
8797
|
*
|
|
@@ -8835,12 +8835,12 @@ interface BodyVelocity extends BodyMover {
|
|
|
8835
8835
|
*/
|
|
8836
8836
|
Velocity: Vector3;
|
|
8837
8837
|
/**
|
|
8838
|
-
* Not implemented and will always return the 0 vector.
|
|
8838
|
+
* Not implemented and will always return the `0` vector.
|
|
8839
8839
|
*
|
|
8840
8840
|
* - **ThreadSafety**: Unsafe
|
|
8841
8841
|
*
|
|
8842
8842
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyVelocity#GetLastForce)
|
|
8843
|
-
* @param this **Deprecated:** This object is deprecated and should not be used for new work. Use `LinearVelocity` instead.
|
|
8843
|
+
* @param this **Deprecated:** This object is deprecated and should not be used for new work. Use `LinearVelocity` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8844
8844
|
*
|
|
8845
8845
|
* Applies a force to maintain a constant velocity.
|
|
8846
8846
|
*/
|
|
@@ -8851,16 +8851,16 @@ interface BodyVelocity extends BodyMover {
|
|
|
8851
8851
|
* - **ThreadSafety**: Unsafe
|
|
8852
8852
|
*
|
|
8853
8853
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyVelocity#lastForce)
|
|
8854
|
-
* @param this **Deprecated:** This object is deprecated and should not be used for new work. Use `LinearVelocity` instead.
|
|
8854
|
+
* @param this **Deprecated:** This object is deprecated and should not be used for new work. Use `LinearVelocity` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8855
8855
|
*
|
|
8856
8856
|
* Applies a force to maintain a constant velocity.
|
|
8857
8857
|
*/
|
|
8858
8858
|
lastForce(this: BodyVelocity): Vector3;
|
|
8859
8859
|
}
|
|
8860
8860
|
/**
|
|
8861
|
-
* **Deprecated:** This object is deprecated and should not be used for new work. Use `LineForce` instead.
|
|
8861
|
+
* **Deprecated:** This object is deprecated and should not be used for new work. Use `LineForce` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8862
8862
|
*
|
|
8863
|
-
* Applies a force so that
|
|
8863
|
+
* Applies a force so that an assembly follows and faces a target part.
|
|
8864
8864
|
*
|
|
8865
8865
|
* - **Tags**:
|
|
8866
8866
|
*
|
|
@@ -8878,7 +8878,7 @@ interface RocketPropulsion extends BodyMover {
|
|
|
8878
8878
|
*/
|
|
8879
8879
|
readonly _nominal_RocketPropulsion: unique symbol;
|
|
8880
8880
|
/**
|
|
8881
|
-
* Determines the tendency of the
|
|
8881
|
+
* Determines the tendency of the assembly to face the `Target`.
|
|
8882
8882
|
*
|
|
8883
8883
|
* - **ThreadSafety**: ReadSafe
|
|
8884
8884
|
*
|
|
@@ -8886,7 +8886,7 @@ interface RocketPropulsion extends BodyMover {
|
|
|
8886
8886
|
*/
|
|
8887
8887
|
CartoonFactor: number;
|
|
8888
8888
|
/**
|
|
8889
|
-
* Determines the maximum speed at which the
|
|
8889
|
+
* Determines the maximum speed at which the assembly will move toward the `Target`.
|
|
8890
8890
|
*
|
|
8891
8891
|
* - **ThreadSafety**: ReadSafe
|
|
8892
8892
|
*
|
|
@@ -8894,7 +8894,7 @@ interface RocketPropulsion extends BodyMover {
|
|
|
8894
8894
|
*/
|
|
8895
8895
|
MaxSpeed: number;
|
|
8896
8896
|
/**
|
|
8897
|
-
* Determines the maximum amount of thrust that will be exerted to move the
|
|
8897
|
+
* Determines the maximum amount of thrust that will be exerted to move the assembly.
|
|
8898
8898
|
*
|
|
8899
8899
|
* - **ThreadSafety**: ReadSafe
|
|
8900
8900
|
*
|
|
@@ -8902,7 +8902,7 @@ interface RocketPropulsion extends BodyMover {
|
|
|
8902
8902
|
*/
|
|
8903
8903
|
MaxThrust: number;
|
|
8904
8904
|
/**
|
|
8905
|
-
* Determines the maximum amount of torque that may be exerted to rotate the
|
|
8905
|
+
* Determines the maximum amount of torque that may be exerted to rotate the assembly towards the `Target`.
|
|
8906
8906
|
*
|
|
8907
8907
|
* - **ThreadSafety**: ReadSafe
|
|
8908
8908
|
*
|
|
@@ -8910,7 +8910,7 @@ interface RocketPropulsion extends BodyMover {
|
|
|
8910
8910
|
*/
|
|
8911
8911
|
MaxTorque: Vector3;
|
|
8912
8912
|
/**
|
|
8913
|
-
* Determines the object towards which the
|
|
8913
|
+
* Determines the object towards which the assembly should follow/face.
|
|
8914
8914
|
*
|
|
8915
8915
|
* - **ThreadSafety**: ReadSafe
|
|
8916
8916
|
*
|
|
@@ -8926,7 +8926,7 @@ interface RocketPropulsion extends BodyMover {
|
|
|
8926
8926
|
*/
|
|
8927
8927
|
TargetOffset: Vector3;
|
|
8928
8928
|
/**
|
|
8929
|
-
* Determines the maximum distance from the `Target` the
|
|
8929
|
+
* Determines the maximum distance from the `Target` at which the assembly must be in order for `ReachedTarget` to be fired.
|
|
8930
8930
|
*
|
|
8931
8931
|
* - **ThreadSafety**: ReadSafe
|
|
8932
8932
|
*
|
|
@@ -8934,7 +8934,7 @@ interface RocketPropulsion extends BodyMover {
|
|
|
8934
8934
|
*/
|
|
8935
8935
|
TargetRadius: number;
|
|
8936
8936
|
/**
|
|
8937
|
-
* Determines the dampening applied to the
|
|
8937
|
+
* Determines the dampening applied to the assembly in order to prevent it from overshooting the `Target`.
|
|
8938
8938
|
*
|
|
8939
8939
|
* - **ThreadSafety**: ReadSafe
|
|
8940
8940
|
*
|
|
@@ -8966,29 +8966,29 @@ interface RocketPropulsion extends BodyMover {
|
|
|
8966
8966
|
*/
|
|
8967
8967
|
TurnP: number;
|
|
8968
8968
|
/**
|
|
8969
|
-
* Causes the
|
|
8969
|
+
* Causes the assembly to stop moving toward its `Target`.
|
|
8970
8970
|
*
|
|
8971
8971
|
* - **ThreadSafety**: Unsafe
|
|
8972
8972
|
*
|
|
8973
8973
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#Abort)
|
|
8974
|
-
* @param this **Deprecated:** This object is deprecated and should not be used for new work. Use `LineForce` instead.
|
|
8974
|
+
* @param this **Deprecated:** This object is deprecated and should not be used for new work. Use `LineForce` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8975
8975
|
*
|
|
8976
|
-
* Applies a force so that
|
|
8976
|
+
* Applies a force so that an assembly follows and faces a target part.
|
|
8977
8977
|
*/
|
|
8978
8978
|
Abort(this: RocketPropulsion): void;
|
|
8979
8979
|
/**
|
|
8980
|
-
* Causes the
|
|
8980
|
+
* Causes the assembly to start moving toward its `Target`.
|
|
8981
8981
|
*
|
|
8982
8982
|
* - **ThreadSafety**: Unsafe
|
|
8983
8983
|
*
|
|
8984
8984
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#Fire)
|
|
8985
|
-
* @param this **Deprecated:** This object is deprecated and should not be used for new work. Use `LineForce` instead.
|
|
8985
|
+
* @param this **Deprecated:** This object is deprecated and should not be used for new work. Use `LineForce` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
|
|
8986
8986
|
*
|
|
8987
|
-
* Applies a force so that
|
|
8987
|
+
* Applies a force so that an assembly follows and faces a target part.
|
|
8988
8988
|
*/
|
|
8989
8989
|
Fire(this: RocketPropulsion): void;
|
|
8990
8990
|
/**
|
|
8991
|
-
*
|
|
8991
|
+
* Fires when the assembly comes within `TargetRadius` of the `Target`.
|
|
8992
8992
|
*
|
|
8993
8993
|
* - **ThreadSafety**: Unsafe
|
|
8994
8994
|
*
|
|
@@ -9088,6 +9088,21 @@ interface BulkImportService extends Instance {
|
|
|
9088
9088
|
*/
|
|
9089
9089
|
readonly _nominal_BulkImportService: unique symbol;
|
|
9090
9090
|
}
|
|
9091
|
+
/**
|
|
9092
|
+
* - **Tags**: NotCreatable, Service
|
|
9093
|
+
*
|
|
9094
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimContentProvider)
|
|
9095
|
+
*/
|
|
9096
|
+
interface SlimContentProvider extends CacheableContentProvider {
|
|
9097
|
+
/**
|
|
9098
|
+
* **DO NOT USE!**
|
|
9099
|
+
*
|
|
9100
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
9101
|
+
* @hidden
|
|
9102
|
+
* @deprecated
|
|
9103
|
+
*/
|
|
9104
|
+
readonly _nominal_SlimContentProvider: unique symbol;
|
|
9105
|
+
}
|
|
9091
9106
|
/**
|
|
9092
9107
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
9093
9108
|
*
|
|
@@ -9104,7 +9119,7 @@ interface CalloutService extends Instance {
|
|
|
9104
9119
|
readonly _nominal_CalloutService: unique symbol;
|
|
9105
9120
|
}
|
|
9106
9121
|
/**
|
|
9107
|
-
* A service which provides control over screenshot capture features.
|
|
9122
|
+
* A service which provides control over screenshot and video capture features.
|
|
9108
9123
|
*
|
|
9109
9124
|
* - **Tags**: NotCreatable, Service
|
|
9110
9125
|
*
|
|
@@ -9125,7 +9140,7 @@ interface CaptureService extends Instance {
|
|
|
9125
9140
|
* - **ThreadSafety**: Unsafe
|
|
9126
9141
|
*
|
|
9127
9142
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureScreenshot)
|
|
9128
|
-
* @param this A service which provides control over screenshot capture features.
|
|
9143
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
9129
9144
|
* @param onCaptureReady A callback function that is called with the `contentId` of the new capture once it is ready.
|
|
9130
9145
|
*/
|
|
9131
9146
|
CaptureScreenshot(this: CaptureService, onCaptureReady: (captureContentId: string) => void): void;
|
|
@@ -9135,18 +9150,18 @@ interface CaptureService extends Instance {
|
|
|
9135
9150
|
* - **ThreadSafety**: Unsafe
|
|
9136
9151
|
*
|
|
9137
9152
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptSaveCapturesToGallery)
|
|
9138
|
-
* @param this A service which provides control over screenshot capture features.
|
|
9153
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
9139
9154
|
* @param captures
|
|
9140
9155
|
* @param resultCallback A callback function that will be invoked with a dictionary mapping each `contentId` to a boolean indicating if the user accepted saving that capture.
|
|
9141
9156
|
*/
|
|
9142
9157
|
PromptSaveCapturesToGallery<T extends string>(this: CaptureService, contentIds: Array<T>, resultCallback: (results: Record<T, boolean>) => void): void;
|
|
9143
9158
|
/**
|
|
9144
|
-
* Prompts the user to share a specified
|
|
9159
|
+
* Prompts the user to share a specified capture.
|
|
9145
9160
|
*
|
|
9146
9161
|
* - **ThreadSafety**: Unsafe
|
|
9147
9162
|
*
|
|
9148
9163
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptShareCapture)
|
|
9149
|
-
* @param this A service which provides control over screenshot capture features.
|
|
9164
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
9150
9165
|
* @param captureContent
|
|
9151
9166
|
* @param launchData An optional string to include as launch data in the invite link.
|
|
9152
9167
|
* @param onAcceptedCallback An optional callback function invoked if the user accepts sharing.
|
|
@@ -9154,25 +9169,33 @@ interface CaptureService extends Instance {
|
|
|
9154
9169
|
*/
|
|
9155
9170
|
PromptShareCapture(this: CaptureService, contentId: string, launchData: string, onAcceptedCallback: () => void, onDeniedCallback: () => void): void;
|
|
9156
9171
|
/**
|
|
9172
|
+
* Ends a video capture initiated by `StartVideoCaptureAsync()`.
|
|
9173
|
+
*
|
|
9157
9174
|
* - **ThreadSafety**: Unsafe
|
|
9158
9175
|
*
|
|
9159
9176
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StopVideoCapture)
|
|
9177
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
9160
9178
|
*/
|
|
9161
9179
|
StopVideoCapture(this: CaptureService): void;
|
|
9162
9180
|
/**
|
|
9163
9181
|
* - **ThreadSafety**: Unsafe
|
|
9164
9182
|
*
|
|
9165
9183
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#TakeCapture)
|
|
9166
|
-
* @param this A service which provides control over screenshot capture features.
|
|
9184
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
9167
9185
|
* @param onCaptureReady
|
|
9168
9186
|
* @param captureParams
|
|
9169
9187
|
*/
|
|
9170
9188
|
TakeCapture(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
|
|
9171
9189
|
/**
|
|
9190
|
+
* Initiates a video capture recording.
|
|
9191
|
+
*
|
|
9172
9192
|
* - **ThreadSafety**: Unsafe
|
|
9173
9193
|
* - **Tags**: Yields
|
|
9174
9194
|
*
|
|
9175
9195
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StartVideoCaptureAsync)
|
|
9196
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
9197
|
+
* @param onCaptureReady A callback function that is called with the `VideoCapture` object and the result of type `VideoCaptureResult` of the video capture once it is ready.
|
|
9198
|
+
* @param captureParams
|
|
9176
9199
|
*/
|
|
9177
9200
|
StartVideoCaptureAsync(this: CaptureService, onCaptureReady: Callback, captureParams?: object): Enum.VideoCaptureResult;
|
|
9178
9201
|
/**
|
|
@@ -9182,7 +9205,7 @@ interface CaptureService extends Instance {
|
|
|
9182
9205
|
*
|
|
9183
9206
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureBegan)
|
|
9184
9207
|
*/
|
|
9185
|
-
readonly CaptureBegan: RBXScriptSignal<() => void>;
|
|
9208
|
+
readonly CaptureBegan: RBXScriptSignal<(captureType: Enum.CaptureType) => void>;
|
|
9186
9209
|
/**
|
|
9187
9210
|
* Fires after a capture finishes.
|
|
9188
9211
|
*
|
|
@@ -9190,7 +9213,7 @@ interface CaptureService extends Instance {
|
|
|
9190
9213
|
*
|
|
9191
9214
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureEnded)
|
|
9192
9215
|
*/
|
|
9193
|
-
readonly CaptureEnded: RBXScriptSignal<() => void>;
|
|
9216
|
+
readonly CaptureEnded: RBXScriptSignal<(captureType: Enum.CaptureType) => void>;
|
|
9194
9217
|
/**
|
|
9195
9218
|
* **Deprecated:** This event has been superseded by the `UserCaptureSaved` event.
|
|
9196
9219
|
*
|
|
@@ -10411,6 +10434,8 @@ interface CommandService extends Instance {
|
|
|
10411
10434
|
readonly _nominal_CommandService: unique symbol;
|
|
10412
10435
|
}
|
|
10413
10436
|
/**
|
|
10437
|
+
* Supports real-world purchases that you can bundle with digital benefits.
|
|
10438
|
+
*
|
|
10414
10439
|
* - **Tags**: NotCreatable, Service
|
|
10415
10440
|
*
|
|
10416
10441
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService)
|
|
@@ -10425,10 +10450,12 @@ interface CommerceService extends Instance {
|
|
|
10425
10450
|
*/
|
|
10426
10451
|
readonly _nominal_CommerceService: unique symbol;
|
|
10427
10452
|
/**
|
|
10453
|
+
* Prompts a user to purchase a commerce product using the provided `commerceProductId`. Opens a webview that guides the user through the purchasing flow.
|
|
10454
|
+
*
|
|
10428
10455
|
* - **ThreadSafety**: Unsafe
|
|
10429
10456
|
*
|
|
10430
10457
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService#PromptCommerceProductPurchase)
|
|
10431
|
-
* @param this
|
|
10458
|
+
* @param this Supports real-world purchases that you can bundle with digital benefits.
|
|
10432
10459
|
* @param user
|
|
10433
10460
|
* @param commerceProductId
|
|
10434
10461
|
*/
|
|
@@ -10437,17 +10464,19 @@ interface CommerceService extends Instance {
|
|
|
10437
10464
|
* - **ThreadSafety**: Unsafe
|
|
10438
10465
|
*
|
|
10439
10466
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService#PromptRealWorldCommerceBrowser)
|
|
10440
|
-
* @param this
|
|
10467
|
+
* @param this Supports real-world purchases that you can bundle with digital benefits.
|
|
10441
10468
|
* @param player
|
|
10442
10469
|
* @param url
|
|
10443
10470
|
*/
|
|
10444
10471
|
PromptRealWorldCommerceBrowser(this: CommerceService, player: Player, url: string): void;
|
|
10445
10472
|
/**
|
|
10473
|
+
* Retrieves information about the commerce products you are selling in experience.
|
|
10474
|
+
*
|
|
10446
10475
|
* - **ThreadSafety**: Unsafe
|
|
10447
10476
|
* - **Tags**: Yields
|
|
10448
10477
|
*
|
|
10449
10478
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService#GetCommerceProductInfoAsync)
|
|
10450
|
-
* @param this
|
|
10479
|
+
* @param this Supports real-world purchases that you can bundle with digital benefits.
|
|
10451
10480
|
* @param commerceProductId
|
|
10452
10481
|
*/
|
|
10453
10482
|
GetCommerceProductInfoAsync(this: CommerceService, commerceProductId: string): object;
|
|
@@ -10456,10 +10485,12 @@ interface CommerceService extends Instance {
|
|
|
10456
10485
|
* - **Tags**: Yields
|
|
10457
10486
|
*
|
|
10458
10487
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService#UserEligibleForRealWorldCommerceAsync)
|
|
10459
|
-
* @param this
|
|
10488
|
+
* @param this Supports real-world purchases that you can bundle with digital benefits.
|
|
10460
10489
|
*/
|
|
10461
10490
|
UserEligibleForRealWorldCommerceAsync(this: CommerceService): boolean;
|
|
10462
10491
|
/**
|
|
10492
|
+
* Fires when commerce purchase webview has closed - not an indicator that a purchase was successful.
|
|
10493
|
+
*
|
|
10463
10494
|
* - **ThreadSafety**: Unsafe
|
|
10464
10495
|
*
|
|
10465
10496
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService#PromptCommerceProductPurchaseFinished)
|
|
@@ -10789,7 +10820,7 @@ interface AlignPosition extends Constraint {
|
|
|
10789
10820
|
*/
|
|
10790
10821
|
ApplyAtCenterOfMass: boolean;
|
|
10791
10822
|
/**
|
|
10792
|
-
* Determines how the constraint force will be limited. Only used if `RigidityEnabled` is false
|
|
10823
|
+
* Determines how the constraint force will be limited. Only used if `RigidityEnabled` is `false`.
|
|
10793
10824
|
*
|
|
10794
10825
|
* - **ThreadSafety**: ReadSafe
|
|
10795
10826
|
*
|
|
@@ -10797,7 +10828,7 @@ interface AlignPosition extends Constraint {
|
|
|
10797
10828
|
*/
|
|
10798
10829
|
ForceLimitMode: Enum.ForceLimitMode;
|
|
10799
10830
|
/**
|
|
10800
|
-
* Determines the axes that the constraint uses to limit the force. Only applies when `RigidityEnabled` is false and `AlignPosition.ForceLimitMode` is `PerAxis`. .
|
|
10831
|
+
* Determines the axes that the constraint uses to limit the force. Only applies when `RigidityEnabled` is `false` and `AlignPosition.ForceLimitMode` is `PerAxis`. .
|
|
10801
10832
|
*
|
|
10802
10833
|
* - **ThreadSafety**: ReadSafe
|
|
10803
10834
|
*
|
|
@@ -10870,7 +10901,7 @@ interface AlignPosition extends Constraint {
|
|
|
10870
10901
|
RigidityEnabled: boolean;
|
|
10871
10902
|
}
|
|
10872
10903
|
/**
|
|
10873
|
-
* Applies torque on an assembly to maintain a
|
|
10904
|
+
* Applies torque on an assembly to maintain a constant angular velocity.
|
|
10874
10905
|
*
|
|
10875
10906
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AngularVelocity)
|
|
10876
10907
|
*/
|
|
@@ -11044,7 +11075,7 @@ interface BallSocketConstraint extends Constraint {
|
|
|
11044
11075
|
*/
|
|
11045
11076
|
Radius: number;
|
|
11046
11077
|
/**
|
|
11047
|
-
* How elastic `Attachments` connected by a `BallSocketConstraint` will be when they reach the end of the range specified by `UpperAngle` when `LimitsEnabled` is true
|
|
11078
|
+
* How elastic `Attachments` connected by a `BallSocketConstraint` will be when they reach the end of the range specified by `UpperAngle` when `LimitsEnabled` is `true`.
|
|
11048
11079
|
*
|
|
11049
11080
|
* - **ThreadSafety**: ReadSafe
|
|
11050
11081
|
*
|
|
@@ -11060,7 +11091,7 @@ interface BallSocketConstraint extends Constraint {
|
|
|
11060
11091
|
*/
|
|
11061
11092
|
TwistLimitsEnabled: boolean;
|
|
11062
11093
|
/**
|
|
11063
|
-
* Sets the lower twist rotation limit of the `BallSocketConstraint`, as long as `TwistLimitsEnabled` is true
|
|
11094
|
+
* Sets the lower twist rotation limit of the `BallSocketConstraint`, as long as `TwistLimitsEnabled` is `true`.
|
|
11064
11095
|
*
|
|
11065
11096
|
* - **ThreadSafety**: ReadSafe
|
|
11066
11097
|
*
|
|
@@ -11068,7 +11099,7 @@ interface BallSocketConstraint extends Constraint {
|
|
|
11068
11099
|
*/
|
|
11069
11100
|
TwistLowerAngle: number;
|
|
11070
11101
|
/**
|
|
11071
|
-
* Sets the upper twist rotation limit of the `BallSocketConstraint`, as long as `TwistLimitsEnabled` is true
|
|
11102
|
+
* Sets the upper twist rotation limit of the `BallSocketConstraint`, as long as `TwistLimitsEnabled` is `true`.
|
|
11072
11103
|
*
|
|
11073
11104
|
* - **ThreadSafety**: ReadSafe
|
|
11074
11105
|
*
|
|
@@ -11076,7 +11107,7 @@ interface BallSocketConstraint extends Constraint {
|
|
|
11076
11107
|
*/
|
|
11077
11108
|
TwistUpperAngle: number;
|
|
11078
11109
|
/**
|
|
11079
|
-
* Sets the upper rotation limit of the `BallSocketConstraint`, as long as `LimitsEnabled` is true
|
|
11110
|
+
* Sets the upper rotation limit of the `BallSocketConstraint`, as long as `LimitsEnabled` is `true`.
|
|
11080
11111
|
*
|
|
11081
11112
|
* - **ThreadSafety**: ReadSafe
|
|
11082
11113
|
*
|
|
@@ -11246,7 +11277,7 @@ interface LineForce extends Constraint {
|
|
|
11246
11277
|
*/
|
|
11247
11278
|
ApplyAtCenterOfMass: boolean;
|
|
11248
11279
|
/**
|
|
11249
|
-
* When true
|
|
11280
|
+
* When `true`, the force magnitude is multiplied by the inverse square of the distance.
|
|
11250
11281
|
*
|
|
11251
11282
|
* - **ThreadSafety**: ReadSafe
|
|
11252
11283
|
*
|
|
@@ -11279,7 +11310,7 @@ interface LineForce extends Constraint {
|
|
|
11279
11310
|
ReactionForceEnabled: boolean;
|
|
11280
11311
|
}
|
|
11281
11312
|
/**
|
|
11282
|
-
* Applies force on an assembly to maintain a
|
|
11313
|
+
* Applies force on an assembly to maintain a constant linear velocity.
|
|
11283
11314
|
*
|
|
11284
11315
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LinearVelocity)
|
|
11285
11316
|
*/
|
|
@@ -11325,7 +11356,7 @@ interface LinearVelocity extends Constraint {
|
|
|
11325
11356
|
*/
|
|
11326
11357
|
LineVelocity: number;
|
|
11327
11358
|
/**
|
|
11328
|
-
* Maximum force along each axis that the constraint can apply to achieve the vector velocity. Only used if `ForceLimitsEnabled` is true
|
|
11359
|
+
* Maximum force along each axis that the constraint can apply to achieve the vector velocity. Only used if `ForceLimitsEnabled` is `true`, `ForceLimitMode` is `PerAxis`, and `VelocityConstraintMode` is `Vector`.
|
|
11329
11360
|
*
|
|
11330
11361
|
* - **ThreadSafety**: ReadSafe
|
|
11331
11362
|
*
|
|
@@ -11341,7 +11372,7 @@ interface LinearVelocity extends Constraint {
|
|
|
11341
11372
|
*/
|
|
11342
11373
|
MaxForce: number;
|
|
11343
11374
|
/**
|
|
11344
|
-
* Maximum force along each axis that the constraint can apply to achieve the plane velocity. Only used if `ForceLimitsEnabled` is true
|
|
11375
|
+
* Maximum force along each axis that the constraint can apply to achieve the plane velocity. Only used if `ForceLimitsEnabled` is `true`, `ForceLimitMode` is `PerAxis`, and `VelocityConstraintMode` is `Plane`.
|
|
11345
11376
|
*
|
|
11346
11377
|
* - **ThreadSafety**: ReadSafe
|
|
11347
11378
|
*
|
|
@@ -11371,7 +11402,7 @@ interface LinearVelocity extends Constraint {
|
|
|
11371
11402
|
*/
|
|
11372
11403
|
ReactionForceEnabled: boolean;
|
|
11373
11404
|
/**
|
|
11374
|
-
* Sets the `ActuatorRelativeTo` property for the
|
|
11405
|
+
* Sets the `ActuatorRelativeTo` property for the constraint.
|
|
11375
11406
|
*
|
|
11376
11407
|
* - **ThreadSafety**: ReadSafe
|
|
11377
11408
|
*
|
|
@@ -11395,7 +11426,7 @@ interface LinearVelocity extends Constraint {
|
|
|
11395
11426
|
*/
|
|
11396
11427
|
VectorVelocity: Vector3;
|
|
11397
11428
|
/**
|
|
11398
|
-
* The mode of the
|
|
11429
|
+
* The mode of the constraint.
|
|
11399
11430
|
*
|
|
11400
11431
|
* - **ThreadSafety**: ReadSafe
|
|
11401
11432
|
*
|
|
@@ -20085,6 +20116,8 @@ interface GuiService extends Instance {
|
|
|
20085
20116
|
readonly MenuOpened: RBXScriptSignal<() => void>;
|
|
20086
20117
|
}
|
|
20087
20118
|
/**
|
|
20119
|
+
* - **Tags**: NotBrowsable
|
|
20120
|
+
*
|
|
20088
20121
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HandRigDescription)
|
|
20089
20122
|
*/
|
|
20090
20123
|
interface HandRigDescription extends Instance {
|
|
@@ -20342,10 +20375,42 @@ interface HandRigDescription extends Instance {
|
|
|
20342
20375
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#ThumbSize)
|
|
20343
20376
|
*/
|
|
20344
20377
|
ThumbSize: number;
|
|
20378
|
+
/**
|
|
20379
|
+
* - **ThreadSafety**: Unsafe
|
|
20380
|
+
*
|
|
20381
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#GetFingerControl)
|
|
20382
|
+
* @param this
|
|
20383
|
+
* @param fingerIndex
|
|
20384
|
+
*/
|
|
20385
|
+
GetFingerControl(this: HandRigDescription, fingerIndex: number): Vector3;
|
|
20386
|
+
/**
|
|
20387
|
+
* - **ThreadSafety**: Unsafe
|
|
20388
|
+
*
|
|
20389
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#GetFingerTip)
|
|
20390
|
+
* @param this
|
|
20391
|
+
* @param fingerIndex
|
|
20392
|
+
*/
|
|
20393
|
+
GetFingerTip(this: HandRigDescription, fingerIndex: number): Vector3;
|
|
20394
|
+
/**
|
|
20395
|
+
* - **ThreadSafety**: Unsafe
|
|
20396
|
+
*
|
|
20397
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#SetFingerControl)
|
|
20398
|
+
* @param this
|
|
20399
|
+
* @param fingerIndex
|
|
20400
|
+
* @param control
|
|
20401
|
+
*/
|
|
20402
|
+
SetFingerControl(this: HandRigDescription, fingerIndex: number, control: Vector3): void;
|
|
20403
|
+
/**
|
|
20404
|
+
* - **ThreadSafety**: Unsafe
|
|
20405
|
+
*
|
|
20406
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#SetFingerTip)
|
|
20407
|
+
* @param this
|
|
20408
|
+
* @param fingerIndex
|
|
20409
|
+
* @param point
|
|
20410
|
+
*/
|
|
20411
|
+
SetFingerTip(this: HandRigDescription, fingerIndex: number, point: Vector3): void;
|
|
20345
20412
|
}
|
|
20346
20413
|
/**
|
|
20347
|
-
* - **Tags**: NotBrowsable
|
|
20348
|
-
*
|
|
20349
20414
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect)
|
|
20350
20415
|
*/
|
|
20351
20416
|
interface HapticEffect extends Instance {
|
|
@@ -22117,33 +22182,33 @@ interface HumanoidRigDescription extends Instance {
|
|
|
22117
22182
|
/**
|
|
22118
22183
|
* - **ThreadSafety**: ReadSafe
|
|
22119
22184
|
*
|
|
22120
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
22185
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBase)
|
|
22121
22186
|
*/
|
|
22122
|
-
|
|
22187
|
+
HeadBase: Instance | undefined;
|
|
22123
22188
|
/**
|
|
22124
22189
|
* - **ThreadSafety**: ReadSafe
|
|
22125
22190
|
*
|
|
22126
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
22191
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBaseRangeMax)
|
|
22127
22192
|
*/
|
|
22128
|
-
|
|
22193
|
+
HeadBaseRangeMax: Vector3;
|
|
22129
22194
|
/**
|
|
22130
22195
|
* - **ThreadSafety**: ReadSafe
|
|
22131
22196
|
*
|
|
22132
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
22197
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBaseRangeMin)
|
|
22133
22198
|
*/
|
|
22134
|
-
|
|
22199
|
+
HeadBaseRangeMin: Vector3;
|
|
22135
22200
|
/**
|
|
22136
22201
|
* - **ThreadSafety**: ReadSafe
|
|
22137
22202
|
*
|
|
22138
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
22203
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBaseSize)
|
|
22139
22204
|
*/
|
|
22140
|
-
|
|
22205
|
+
HeadBaseSize: number;
|
|
22141
22206
|
/**
|
|
22142
22207
|
* - **ThreadSafety**: ReadSafe
|
|
22143
22208
|
*
|
|
22144
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#
|
|
22209
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBaseTposeAdjustment)
|
|
22145
22210
|
*/
|
|
22146
|
-
|
|
22211
|
+
HeadBaseTposeAdjustment: CFrame;
|
|
22147
22212
|
/**
|
|
22148
22213
|
* - **ThreadSafety**: ReadSafe
|
|
22149
22214
|
*
|
|
@@ -22752,6 +22817,14 @@ interface HumanoidRigDescription extends Instance {
|
|
|
22752
22817
|
* @param character
|
|
22753
22818
|
*/
|
|
22754
22819
|
Automap(this: HumanoidRigDescription, character: Instance): void;
|
|
22820
|
+
/**
|
|
22821
|
+
* - **ThreadSafety**: Safe
|
|
22822
|
+
*
|
|
22823
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointFromName)
|
|
22824
|
+
* @param this
|
|
22825
|
+
* @param name
|
|
22826
|
+
*/
|
|
22827
|
+
GetJointFromName(this: HumanoidRigDescription, name: string): Instance | undefined;
|
|
22755
22828
|
/**
|
|
22756
22829
|
* - **ThreadSafety**: Safe
|
|
22757
22830
|
*
|
|
@@ -23054,6 +23127,8 @@ interface IncrementalPatchBuilder extends Instance {
|
|
|
23054
23127
|
ZstdCompression: boolean;
|
|
23055
23128
|
}
|
|
23056
23129
|
/**
|
|
23130
|
+
* Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using `InputBinding`.
|
|
23131
|
+
*
|
|
23057
23132
|
* - **Tags**: NotBrowsable
|
|
23058
23133
|
*
|
|
23059
23134
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction)
|
|
@@ -23068,45 +23143,60 @@ interface InputAction extends Instance {
|
|
|
23068
23143
|
*/
|
|
23069
23144
|
readonly _nominal_InputAction: unique symbol;
|
|
23070
23145
|
/**
|
|
23146
|
+
* Determines if the `InputAction` is enabled or not.
|
|
23147
|
+
*
|
|
23071
23148
|
* - **ThreadSafety**: ReadSafe
|
|
23072
23149
|
*
|
|
23073
23150
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#Enabled)
|
|
23074
23151
|
*/
|
|
23075
23152
|
Enabled: boolean;
|
|
23076
23153
|
/**
|
|
23154
|
+
* Specifies what type of input value the action is expecting.
|
|
23155
|
+
*
|
|
23077
23156
|
* - **ThreadSafety**: ReadSafe
|
|
23078
23157
|
*
|
|
23079
23158
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#Type)
|
|
23080
23159
|
*/
|
|
23081
23160
|
Type: Enum.InputActionType;
|
|
23082
23161
|
/**
|
|
23162
|
+
* Updates the `InputAction` to the given state and fires the appropriate signals.
|
|
23163
|
+
*
|
|
23083
23164
|
* - **ThreadSafety**: Unsafe
|
|
23084
23165
|
*
|
|
23085
23166
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#Fire)
|
|
23086
|
-
* @param this
|
|
23087
|
-
* @param
|
|
23167
|
+
* @param this Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using `InputBinding`.
|
|
23168
|
+
* @param state
|
|
23088
23169
|
*/
|
|
23089
|
-
Fire(this: InputAction,
|
|
23170
|
+
Fire(this: InputAction, state: unknown): void;
|
|
23090
23171
|
/**
|
|
23172
|
+
* Returns the current state of the `InputAction`.
|
|
23173
|
+
*
|
|
23091
23174
|
* - **ThreadSafety**: Unsafe
|
|
23092
23175
|
*
|
|
23093
23176
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#GetState)
|
|
23094
|
-
* @param this
|
|
23177
|
+
* @param this Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using `InputBinding`.
|
|
23178
|
+
* @returns The current state of `InputAction`.
|
|
23095
23179
|
*/
|
|
23096
23180
|
GetState(this: InputAction): unknown;
|
|
23097
23181
|
/**
|
|
23182
|
+
* Fires only when the `InputAction.Type` is set to `Bool` on a state transition from `false` to `true`.
|
|
23183
|
+
*
|
|
23098
23184
|
* - **ThreadSafety**: Unsafe
|
|
23099
23185
|
*
|
|
23100
23186
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#Pressed)
|
|
23101
23187
|
*/
|
|
23102
23188
|
readonly Pressed: RBXScriptSignal<() => void>;
|
|
23103
23189
|
/**
|
|
23190
|
+
* Fires only when the `InputAction.Type` is set to `Bool` on a state transition from `true` to `false`.
|
|
23191
|
+
*
|
|
23104
23192
|
* - **ThreadSafety**: Unsafe
|
|
23105
23193
|
*
|
|
23106
23194
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#Released)
|
|
23107
23195
|
*/
|
|
23108
23196
|
readonly Released: RBXScriptSignal<() => void>;
|
|
23109
23197
|
/**
|
|
23198
|
+
* Fires for all `InputActionType` types whenever the state changes, except if the state attempts to transition to the same state.
|
|
23199
|
+
*
|
|
23110
23200
|
* - **ThreadSafety**: Unsafe
|
|
23111
23201
|
*
|
|
23112
23202
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#StateChanged)
|
|
@@ -23114,6 +23204,8 @@ interface InputAction extends Instance {
|
|
|
23114
23204
|
readonly StateChanged: RBXScriptSignal<(value: unknown) => void>;
|
|
23115
23205
|
}
|
|
23116
23206
|
/**
|
|
23207
|
+
* Defines which hardware binding should trigger the parent `InputAction`.
|
|
23208
|
+
*
|
|
23117
23209
|
* - **Tags**: NotBrowsable
|
|
23118
23210
|
*
|
|
23119
23211
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding)
|
|
@@ -23128,60 +23220,80 @@ interface InputBinding extends Instance {
|
|
|
23128
23220
|
*/
|
|
23129
23221
|
readonly _nominal_InputBinding: unique symbol;
|
|
23130
23222
|
/**
|
|
23223
|
+
* Specifies an alternate `KeyCode` for dispatching directionally "down" inputs to the parent `InputAction`.
|
|
23224
|
+
*
|
|
23131
23225
|
* - **ThreadSafety**: ReadSafe
|
|
23132
23226
|
*
|
|
23133
23227
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Down)
|
|
23134
23228
|
*/
|
|
23135
23229
|
Down: Enum.KeyCode;
|
|
23136
23230
|
/**
|
|
23231
|
+
* Specifies the `KeyCode` which triggers the parent `InputAction`.
|
|
23232
|
+
*
|
|
23137
23233
|
* - **ThreadSafety**: ReadSafe
|
|
23138
23234
|
*
|
|
23139
23235
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#KeyCode)
|
|
23140
23236
|
*/
|
|
23141
23237
|
KeyCode: Enum.KeyCode;
|
|
23142
23238
|
/**
|
|
23239
|
+
* Specifies an alternate `KeyCode` for dispatching directionally "left" inputs to the parent `InputAction`.
|
|
23240
|
+
*
|
|
23143
23241
|
* - **ThreadSafety**: ReadSafe
|
|
23144
23242
|
*
|
|
23145
23243
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Left)
|
|
23146
23244
|
*/
|
|
23147
23245
|
Left: Enum.KeyCode;
|
|
23148
23246
|
/**
|
|
23247
|
+
* Numerical value above which to fire an `InputAction` with a `Type` of `Bool`.
|
|
23248
|
+
*
|
|
23149
23249
|
* - **ThreadSafety**: ReadSafe
|
|
23150
23250
|
*
|
|
23151
23251
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#PressedThreshold)
|
|
23152
23252
|
*/
|
|
23153
23253
|
PressedThreshold: number;
|
|
23154
23254
|
/**
|
|
23255
|
+
* Numerical value below which to fire an `InputAction` with a `Type` of `Bool`.
|
|
23256
|
+
*
|
|
23155
23257
|
* - **ThreadSafety**: ReadSafe
|
|
23156
23258
|
*
|
|
23157
23259
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ReleasedThreshold)
|
|
23158
23260
|
*/
|
|
23159
23261
|
ReleasedThreshold: number;
|
|
23160
23262
|
/**
|
|
23263
|
+
* Specifies an alternate `KeyCode` for dispatching directionally "right" inputs to the parent `InputAction`.
|
|
23264
|
+
*
|
|
23161
23265
|
* - **ThreadSafety**: ReadSafe
|
|
23162
23266
|
*
|
|
23163
23267
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Right)
|
|
23164
23268
|
*/
|
|
23165
23269
|
Right: Enum.KeyCode;
|
|
23166
23270
|
/**
|
|
23271
|
+
* Amount by which to linearly scale the values of a directional `InputAction`.
|
|
23272
|
+
*
|
|
23167
23273
|
* - **ThreadSafety**: ReadSafe
|
|
23168
23274
|
*
|
|
23169
23275
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Scale)
|
|
23170
23276
|
*/
|
|
23171
23277
|
Scale: number;
|
|
23172
23278
|
/**
|
|
23279
|
+
* Connects a `GuiButton` to a boolean action.
|
|
23280
|
+
*
|
|
23173
23281
|
* - **ThreadSafety**: ReadSafe
|
|
23174
23282
|
*
|
|
23175
23283
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#UIButton)
|
|
23176
23284
|
*/
|
|
23177
23285
|
UIButton: GuiButton | undefined;
|
|
23178
23286
|
/**
|
|
23287
|
+
* Specifies an alternate `KeyCode` for dispatching directionally "up" inputs to the parent `InputAction`.
|
|
23288
|
+
*
|
|
23179
23289
|
* - **ThreadSafety**: ReadSafe
|
|
23180
23290
|
*
|
|
23181
23291
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Up)
|
|
23182
23292
|
*/
|
|
23183
23293
|
Up: Enum.KeyCode;
|
|
23184
23294
|
/**
|
|
23295
|
+
* Amount by which to linearly scale the values of a two-directional `InputAction`.
|
|
23296
|
+
*
|
|
23185
23297
|
* - **ThreadSafety**: ReadSafe
|
|
23186
23298
|
*
|
|
23187
23299
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Vector2Scale)
|
|
@@ -23189,6 +23301,8 @@ interface InputBinding extends Instance {
|
|
|
23189
23301
|
Vector2Scale: Vector2;
|
|
23190
23302
|
}
|
|
23191
23303
|
/**
|
|
23304
|
+
* Collection of actions which holds related actions and defines how they interact with other contexts/actions.
|
|
23305
|
+
*
|
|
23192
23306
|
* - **Tags**: NotBrowsable
|
|
23193
23307
|
*
|
|
23194
23308
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputContext)
|
|
@@ -23203,18 +23317,24 @@ interface InputContext extends Instance {
|
|
|
23203
23317
|
*/
|
|
23204
23318
|
readonly _nominal_InputContext: unique symbol;
|
|
23205
23319
|
/**
|
|
23320
|
+
* Determines if this `InputContext` is enabled or not.
|
|
23321
|
+
*
|
|
23206
23322
|
* - **ThreadSafety**: ReadSafe
|
|
23207
23323
|
*
|
|
23208
23324
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputContext#Enabled)
|
|
23209
23325
|
*/
|
|
23210
23326
|
Enabled: boolean;
|
|
23211
23327
|
/**
|
|
23328
|
+
* The priority level at which the context should be run.
|
|
23329
|
+
*
|
|
23212
23330
|
* - **ThreadSafety**: ReadSafe
|
|
23213
23331
|
*
|
|
23214
23332
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputContext#Priority)
|
|
23215
23333
|
*/
|
|
23216
23334
|
Priority: number;
|
|
23217
23335
|
/**
|
|
23336
|
+
* Determines whether input bindings of lower priority will be processed.
|
|
23337
|
+
*
|
|
23218
23338
|
* - **ThreadSafety**: ReadSafe
|
|
23219
23339
|
*
|
|
23220
23340
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputContext#Sink)
|
|
@@ -26027,6 +26147,15 @@ interface MemoryStoreQueue extends Instance {
|
|
|
26027
26147
|
* @param priority Item priority. Items with higher priority are retrieved from the queue before items with lower priority.
|
|
26028
26148
|
*/
|
|
26029
26149
|
AddAsync(this: MemoryStoreQueue, value: unknown, expiration: number, priority?: number): void;
|
|
26150
|
+
/**
|
|
26151
|
+
* - **ThreadSafety**: Unsafe
|
|
26152
|
+
* - **Tags**: Yields
|
|
26153
|
+
*
|
|
26154
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MemoryStoreQueue#GetSizeAsync)
|
|
26155
|
+
* @param this Provides access to a queue within MemoryStore.
|
|
26156
|
+
* @param excludeInvisible
|
|
26157
|
+
*/
|
|
26158
|
+
GetSizeAsync(this: MemoryStoreQueue, excludeInvisible?: boolean): number;
|
|
26030
26159
|
/**
|
|
26031
26160
|
* Reads one or more items from the queue.
|
|
26032
26161
|
*
|
|
@@ -26164,6 +26293,14 @@ interface MemoryStoreSortedMap extends Instance {
|
|
|
26164
26293
|
value: unknown;
|
|
26165
26294
|
sortKey?: string | number;
|
|
26166
26295
|
}>;
|
|
26296
|
+
/**
|
|
26297
|
+
* - **ThreadSafety**: Unsafe
|
|
26298
|
+
* - **Tags**: Yields
|
|
26299
|
+
*
|
|
26300
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MemoryStoreSortedMap#GetSizeAsync)
|
|
26301
|
+
* @param this Provides access to a sorted map within `MemoryStoreService`.
|
|
26302
|
+
*/
|
|
26303
|
+
GetSizeAsync(this: MemoryStoreSortedMap): number;
|
|
26167
26304
|
/**
|
|
26168
26305
|
* Removes the provided key from the sorted map.
|
|
26169
26306
|
*
|
|
@@ -28279,6 +28416,13 @@ interface Terrain extends BasePart {
|
|
|
28279
28416
|
* @param this Terrain lets you to create dynamically morphable environments.
|
|
28280
28417
|
*/
|
|
28281
28418
|
Clear(this: Terrain): void;
|
|
28419
|
+
/**
|
|
28420
|
+
* - **ThreadSafety**: Unsafe
|
|
28421
|
+
* - **Tags**: CustomLuaState
|
|
28422
|
+
*
|
|
28423
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ClearVoxelsAsync_beta)
|
|
28424
|
+
*/
|
|
28425
|
+
ClearVoxelsAsync_beta(this: Terrain, region: Region3, channelIds: Array<unknown>): void;
|
|
28282
28426
|
/**
|
|
28283
28427
|
* Stores a chunk of terrain into a `TerrainRegion` object so it can be loaded back later. Note: `TerrainRegion` data does not replicate between server and client.
|
|
28284
28428
|
*
|
|
@@ -28403,6 +28547,20 @@ interface Terrain extends BasePart {
|
|
|
28403
28547
|
* @deprecated
|
|
28404
28548
|
*/
|
|
28405
28549
|
GetWaterCell(this: Terrain, x: number, y: number, z: number): unknown;
|
|
28550
|
+
/**
|
|
28551
|
+
* - **ThreadSafety**: Unsafe
|
|
28552
|
+
* - **Tags**: CustomLuaState
|
|
28553
|
+
*
|
|
28554
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#IterateVoxelsAsync_beta)
|
|
28555
|
+
*/
|
|
28556
|
+
IterateVoxelsAsync_beta(this: Terrain, region: Region3, resolution: number, channelIds: Array<unknown>): TerrainIterateOperation;
|
|
28557
|
+
/**
|
|
28558
|
+
* - **ThreadSafety**: Unsafe
|
|
28559
|
+
* - **Tags**: CustomLuaState
|
|
28560
|
+
*
|
|
28561
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ModifyVoxelsAsync_beta)
|
|
28562
|
+
*/
|
|
28563
|
+
ModifyVoxelsAsync_beta(this: Terrain, region: Region3, resolution: number, channelIds: Array<unknown>): TerrainModifyOperation;
|
|
28406
28564
|
/**
|
|
28407
28565
|
* Applies a chunk of terrain to the Terrain object. Note: `TerrainRegion` data does not replicate between server and client.
|
|
28408
28566
|
*
|
|
@@ -28450,6 +28608,13 @@ interface Terrain extends BasePart {
|
|
|
28450
28608
|
ReadVoxelsArray<Enum.Material>,
|
|
28451
28609
|
ReadVoxelsArray<number>
|
|
28452
28610
|
]>;
|
|
28611
|
+
/**
|
|
28612
|
+
* - **ThreadSafety**: Unsafe
|
|
28613
|
+
* - **Tags**: CustomLuaState
|
|
28614
|
+
*
|
|
28615
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ReadVoxelsAsync_beta)
|
|
28616
|
+
*/
|
|
28617
|
+
ReadVoxelsAsync_beta(this: Terrain, region: Region3, resolution: number, channelIds: Array<unknown>): TerrainReadOperation;
|
|
28453
28618
|
/**
|
|
28454
28619
|
* Replaces the terrain of a material within a region with another material.
|
|
28455
28620
|
*
|
|
@@ -28590,6 +28755,13 @@ interface Terrain extends BasePart {
|
|
|
28590
28755
|
* @param occupancy 3D array of voxel occupancies (number between 0 and 1). Dimensions must exactly match the size of the target region in voxels.
|
|
28591
28756
|
*/
|
|
28592
28757
|
WriteVoxels(this: Terrain, region: Region3, resolution: number, materials: Array<Array<Array<CastsToEnum<Enum.Material>>>>, occupancy: Array<Array<Array<number>>>): void;
|
|
28758
|
+
/**
|
|
28759
|
+
* - **ThreadSafety**: Unsafe
|
|
28760
|
+
* - **Tags**: CustomLuaState
|
|
28761
|
+
*
|
|
28762
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WriteVoxelsAsync_beta)
|
|
28763
|
+
*/
|
|
28764
|
+
WriteVoxelsAsync_beta(this: Terrain, region: Region3, resolution: number, channelIds: Array<unknown>): TerrainWriteOperation;
|
|
28593
28765
|
}
|
|
28594
28766
|
/**
|
|
28595
28767
|
* Abstract intermediate class that manages physical geometry properties for PartOperations and MeshParts.
|
|
@@ -32648,7 +32820,7 @@ interface PlayerScripts extends Instance {
|
|
|
32648
32820
|
*/
|
|
32649
32821
|
readonly _nominal_PlayerScripts: unique symbol;
|
|
32650
32822
|
/**
|
|
32651
|
-
* Unregisters all ComputerCameraMovementMode enums from the
|
|
32823
|
+
* Unregisters all ComputerCameraMovementMode enums from the experience's settings menu.
|
|
32652
32824
|
*
|
|
32653
32825
|
* - **ThreadSafety**: Unsafe
|
|
32654
32826
|
*
|
|
@@ -32657,7 +32829,7 @@ interface PlayerScripts extends Instance {
|
|
|
32657
32829
|
*/
|
|
32658
32830
|
ClearComputerCameraMovementModes(this: PlayerScripts): void;
|
|
32659
32831
|
/**
|
|
32660
|
-
* Unregisters all ComputerMovementMode enums from the
|
|
32832
|
+
* Unregisters all ComputerMovementMode enums from the experience's settings menu.
|
|
32661
32833
|
*
|
|
32662
32834
|
* - **ThreadSafety**: Unsafe
|
|
32663
32835
|
*
|
|
@@ -32666,7 +32838,7 @@ interface PlayerScripts extends Instance {
|
|
|
32666
32838
|
*/
|
|
32667
32839
|
ClearComputerMovementModes(this: PlayerScripts): void;
|
|
32668
32840
|
/**
|
|
32669
|
-
* Unregisters all TouchCameraMovementMode enums from the
|
|
32841
|
+
* Unregisters all TouchCameraMovementMode enums from the experience's settings menu.
|
|
32670
32842
|
*
|
|
32671
32843
|
* - **ThreadSafety**: Unsafe
|
|
32672
32844
|
*
|
|
@@ -32675,7 +32847,7 @@ interface PlayerScripts extends Instance {
|
|
|
32675
32847
|
*/
|
|
32676
32848
|
ClearTouchCameraMovementModes(this: PlayerScripts): void;
|
|
32677
32849
|
/**
|
|
32678
|
-
* Unregisters all TouchMovementMode enums from the
|
|
32850
|
+
* Unregisters all TouchMovementMode enums from the experience's settings menu.
|
|
32679
32851
|
*
|
|
32680
32852
|
* - **ThreadSafety**: Unsafe
|
|
32681
32853
|
*
|
|
@@ -35385,7 +35557,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
35385
35557
|
/**
|
|
35386
35558
|
* **Deprecated:** This item is deprecated . Do not use it for new work.
|
|
35387
35559
|
*
|
|
35388
|
-
* Fires when SetGearSettings is called with a different value for
|
|
35560
|
+
* Fires when SetGearSettings is called with a different value for `allowedGenres`.
|
|
35389
35561
|
*
|
|
35390
35562
|
* - **ThreadSafety**: Unsafe
|
|
35391
35563
|
* - **Tags**:
|
|
@@ -36330,7 +36502,7 @@ interface CompressorSoundEffect extends SoundEffect {
|
|
|
36330
36502
|
*/
|
|
36331
36503
|
Attack: number;
|
|
36332
36504
|
/**
|
|
36333
|
-
* The overall amplification applied to the effect
|
|
36505
|
+
* The overall amplification applied to the effect's Sound or SoundGroup after attenuation of sounds above the threshold.
|
|
36334
36506
|
*
|
|
36335
36507
|
* - **ThreadSafety**: ReadSafe
|
|
36336
36508
|
*
|
|
@@ -40005,6 +40177,8 @@ interface TextFilterResult extends Instance {
|
|
|
40005
40177
|
* @param this
|
|
40006
40178
|
* @param toUserId `Player.UserId` of the user being chatted.
|
|
40007
40179
|
* @returns Filtered text string.
|
|
40180
|
+
*
|
|
40181
|
+
* @deprecated
|
|
40008
40182
|
*/
|
|
40009
40183
|
GetChatForUserAsync(this: TextFilterResult, toUserId: number): string;
|
|
40010
40184
|
/**
|
|
@@ -41155,7 +41329,7 @@ interface UIDragDetector extends UIComponent {
|
|
|
41155
41329
|
*
|
|
41156
41330
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#SetDragStyleFunction)
|
|
41157
41331
|
* @param this Instance which facilitates and encourages interaction with UI elements in an experience.
|
|
41158
|
-
* @param function Function for monitoring `DragContinue` signals. This function receives the
|
|
41332
|
+
* @param function Function for monitoring `DragContinue` signals. This function receives the signal's screen space input position and returns a `UDim2` and float containing the desired motion of the drag in the desired space and relativity. If this function returns `nil`, the object will not be moved.
|
|
41159
41333
|
*/
|
|
41160
41334
|
SetDragStyleFunction(this: UIDragDetector, callback: (inputPosition: UDim2) => UDim2 | void): void;
|
|
41161
41335
|
/**
|
|
@@ -42219,6 +42393,13 @@ interface UserInputService extends Instance {
|
|
|
42219
42393
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#OnScreenKeyboardVisible)
|
|
42220
42394
|
*/
|
|
42221
42395
|
readonly OnScreenKeyboardVisible: boolean;
|
|
42396
|
+
/**
|
|
42397
|
+
* - **ThreadSafety**: ReadSafe
|
|
42398
|
+
* - **Tags**: NotReplicated
|
|
42399
|
+
*
|
|
42400
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#PreferredInput)
|
|
42401
|
+
*/
|
|
42402
|
+
readonly PreferredInput: Enum.PreferredInput;
|
|
42222
42403
|
/**
|
|
42223
42404
|
* Describes whether the user's current device has a touch-screen available.
|
|
42224
42405
|
*
|
|
@@ -44139,3 +44320,106 @@ interface Wire extends Instance {
|
|
|
44139
44320
|
*/
|
|
44140
44321
|
TargetName: string;
|
|
44141
44322
|
}
|
|
44323
|
+
/**
|
|
44324
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
44325
|
+
*
|
|
44326
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainIterateOperation)
|
|
44327
|
+
*/
|
|
44328
|
+
interface TerrainIterateOperation extends RBXObject {
|
|
44329
|
+
/**
|
|
44330
|
+
* **DO NOT USE!**
|
|
44331
|
+
*
|
|
44332
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
44333
|
+
* @hidden
|
|
44334
|
+
* @deprecated
|
|
44335
|
+
*/
|
|
44336
|
+
readonly _nominal_TerrainIterateOperation: unique symbol;
|
|
44337
|
+
/**
|
|
44338
|
+
* - **ThreadSafety**: Unsafe
|
|
44339
|
+
*
|
|
44340
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainIterateOperation#CommitBlock)
|
|
44341
|
+
*/
|
|
44342
|
+
CommitBlock(this: TerrainIterateOperation, block: object): RBXScriptSignal;
|
|
44343
|
+
/**
|
|
44344
|
+
* - **ThreadSafety**: Unsafe
|
|
44345
|
+
*
|
|
44346
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainIterateOperation#Ready)
|
|
44347
|
+
*/
|
|
44348
|
+
readonly Ready: RBXScriptSignal<(block: object) => void>;
|
|
44349
|
+
}
|
|
44350
|
+
/**
|
|
44351
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
44352
|
+
*
|
|
44353
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainModifyOperation)
|
|
44354
|
+
*/
|
|
44355
|
+
interface TerrainModifyOperation extends RBXObject {
|
|
44356
|
+
/**
|
|
44357
|
+
* **DO NOT USE!**
|
|
44358
|
+
*
|
|
44359
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
44360
|
+
* @hidden
|
|
44361
|
+
* @deprecated
|
|
44362
|
+
*/
|
|
44363
|
+
readonly _nominal_TerrainModifyOperation: unique symbol;
|
|
44364
|
+
/**
|
|
44365
|
+
* - **ThreadSafety**: Unsafe
|
|
44366
|
+
*
|
|
44367
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainModifyOperation#CommitBlock)
|
|
44368
|
+
*/
|
|
44369
|
+
CommitBlock(this: TerrainModifyOperation, block: object): RBXScriptSignal;
|
|
44370
|
+
/**
|
|
44371
|
+
* - **ThreadSafety**: Unsafe
|
|
44372
|
+
*
|
|
44373
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainModifyOperation#Ready)
|
|
44374
|
+
*/
|
|
44375
|
+
readonly Ready: RBXScriptSignal<(block: object) => void>;
|
|
44376
|
+
}
|
|
44377
|
+
/**
|
|
44378
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
44379
|
+
*
|
|
44380
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainReadOperation)
|
|
44381
|
+
*/
|
|
44382
|
+
interface TerrainReadOperation extends RBXObject {
|
|
44383
|
+
/**
|
|
44384
|
+
* **DO NOT USE!**
|
|
44385
|
+
*
|
|
44386
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
44387
|
+
* @hidden
|
|
44388
|
+
* @deprecated
|
|
44389
|
+
*/
|
|
44390
|
+
readonly _nominal_TerrainReadOperation: unique symbol;
|
|
44391
|
+
/**
|
|
44392
|
+
* - **ThreadSafety**: Unsafe
|
|
44393
|
+
*
|
|
44394
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainReadOperation#Ready)
|
|
44395
|
+
*/
|
|
44396
|
+
readonly Ready: RBXScriptSignal<(block: object) => void>;
|
|
44397
|
+
}
|
|
44398
|
+
/**
|
|
44399
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
44400
|
+
*
|
|
44401
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainWriteOperation)
|
|
44402
|
+
*/
|
|
44403
|
+
interface TerrainWriteOperation extends RBXObject {
|
|
44404
|
+
/**
|
|
44405
|
+
* **DO NOT USE!**
|
|
44406
|
+
*
|
|
44407
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
44408
|
+
* @hidden
|
|
44409
|
+
* @deprecated
|
|
44410
|
+
*/
|
|
44411
|
+
readonly _nominal_TerrainWriteOperation: unique symbol;
|
|
44412
|
+
/**
|
|
44413
|
+
* - **ThreadSafety**: Unsafe
|
|
44414
|
+
*
|
|
44415
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainWriteOperation#CommitBlock)
|
|
44416
|
+
*/
|
|
44417
|
+
CommitBlock(this: TerrainWriteOperation, block: object): RBXScriptSignal;
|
|
44418
|
+
/**
|
|
44419
|
+
* - **ThreadSafety**: Unsafe
|
|
44420
|
+
* - **Tags**: CustomLuaState
|
|
44421
|
+
*
|
|
44422
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainWriteOperation#GetBlock)
|
|
44423
|
+
*/
|
|
44424
|
+
GetBlock(this: TerrainWriteOperation): object;
|
|
44425
|
+
}
|