@rbxts/types 1.0.922 → 1.0.924
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 +251 -159
- package/include/generated/PluginSecurity.d.ts +50 -12
- package/include/generated/enums.d.ts +270 -17
- package/package.json +1 -1
|
@@ -79,6 +79,7 @@ interface Services {
|
|
|
79
79
|
FacialAnimationStreamingServiceV2: FacialAnimationStreamingServiceV2;
|
|
80
80
|
FeatureRestrictionManager: FeatureRestrictionManager;
|
|
81
81
|
FileManagerService: FileManagerService;
|
|
82
|
+
FileSyncReplicationService: FileSyncReplicationService;
|
|
82
83
|
GamepadService: GamepadService;
|
|
83
84
|
GamePassService: GamePassService;
|
|
84
85
|
GenerationService: GenerationService;
|
|
@@ -90,6 +91,7 @@ interface Services {
|
|
|
90
91
|
HapticService: HapticService;
|
|
91
92
|
HarmonyService: HarmonyService;
|
|
92
93
|
HeapProfilerService: HeapProfilerService;
|
|
94
|
+
HeatmapQueryService: HeatmapQueryService;
|
|
93
95
|
HeatmapService: HeatmapService;
|
|
94
96
|
HeightmapImporterService: HeightmapImporterService;
|
|
95
97
|
HttpService: HttpService;
|
|
@@ -7955,7 +7957,7 @@ interface AvatarCreationService extends Instance {
|
|
|
7955
7957
|
*/
|
|
7956
7958
|
AutoSetupAvatarAsync(this: AvatarCreationService, player: Player, autoSetupParams: object, progressCallback?: Callback): string;
|
|
7957
7959
|
/**
|
|
7958
|
-
* Creates a 2D avatar preview and returns a previewId
|
|
7960
|
+
* Creates a 2D avatar preview and returns a `previewId`.
|
|
7959
7961
|
*
|
|
7960
7962
|
* - **ThreadSafety**: Unsafe
|
|
7961
7963
|
* - **Tags**: Yields
|
|
@@ -8353,6 +8355,13 @@ interface AvatarEditorService extends Instance {
|
|
|
8353
8355
|
* @returns Returns an array of item details.
|
|
8354
8356
|
*/
|
|
8355
8357
|
GetBatchItemDetailsAsync(this: AvatarEditorService, itemIds: Array<unknown>, itemType: CastsToEnum<Enum.AvatarItemType>): Array<unknown>;
|
|
8358
|
+
/**
|
|
8359
|
+
* - **ThreadSafety**: Unsafe
|
|
8360
|
+
* - **Tags**: Yields
|
|
8361
|
+
*
|
|
8362
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetBundlesByAssetIdAsync)
|
|
8363
|
+
*/
|
|
8364
|
+
GetBundlesByAssetIdAsync(this: AvatarEditorService, assetId: number, limit?: number): CatalogPages;
|
|
8356
8365
|
/**
|
|
8357
8366
|
* **Deprecated:**
|
|
8358
8367
|
*
|
|
@@ -8699,7 +8708,7 @@ interface AvatarSettings extends Instance {
|
|
|
8699
8708
|
readonly _nominal_AvatarSettings: unique symbol;
|
|
8700
8709
|
}
|
|
8701
8710
|
/**
|
|
8702
|
-
* A container object that holds a player's inventory. Any `Tool` in a player's Backpack will be displayed in their inventory at the bottom of
|
|
8711
|
+
* A container object that holds a player's inventory. Any `Tool` in a player's `Backpack` will be displayed in their inventory at the bottom of the screen.
|
|
8703
8712
|
*
|
|
8704
8713
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Backpack)
|
|
8705
8714
|
*/
|
|
@@ -9460,7 +9469,7 @@ interface BasePlayerGui extends Instance {
|
|
|
9460
9469
|
GetGuiObjectsAtPosition(this: BasePlayerGui, x: number, y: number): Array<GuiObject>;
|
|
9461
9470
|
}
|
|
9462
9471
|
/**
|
|
9463
|
-
* A container
|
|
9472
|
+
* A container that holds a player's UI.
|
|
9464
9473
|
*
|
|
9465
9474
|
* - **Tags**: NotCreatable, PlayerReplicated
|
|
9466
9475
|
*
|
|
@@ -9509,7 +9518,7 @@ interface PlayerGui extends BasePlayerGui {
|
|
|
9509
9518
|
* - **Tags**:
|
|
9510
9519
|
*
|
|
9511
9520
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerGui#GetTopbarTransparency)
|
|
9512
|
-
* @param this A container
|
|
9521
|
+
* @param this A container that holds a player's UI.
|
|
9513
9522
|
*
|
|
9514
9523
|
* @deprecated
|
|
9515
9524
|
*/
|
|
@@ -9523,7 +9532,7 @@ interface PlayerGui extends BasePlayerGui {
|
|
|
9523
9532
|
* - **Tags**:
|
|
9524
9533
|
*
|
|
9525
9534
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerGui#SetTopbarTransparency)
|
|
9526
|
-
* @param this A container
|
|
9535
|
+
* @param this A container that holds a player's UI.
|
|
9527
9536
|
* @param transparency
|
|
9528
9537
|
*
|
|
9529
9538
|
* @deprecated
|
|
@@ -12414,7 +12423,7 @@ interface ConfigService extends Instance {
|
|
|
12414
12423
|
GetConfigForPlayerAsync(this: ConfigService, player: Player): ConfigSnapshot;
|
|
12415
12424
|
}
|
|
12416
12425
|
/**
|
|
12417
|
-
*
|
|
12426
|
+
* A container object designed to hold value objects. Makes values used in `Tools` or any model using `Scripts` more accessible.
|
|
12418
12427
|
*
|
|
12419
12428
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Configuration)
|
|
12420
12429
|
*/
|
|
@@ -12826,6 +12835,18 @@ interface AnimationConstraint extends Constraint {
|
|
|
12826
12835
|
* @deprecated
|
|
12827
12836
|
*/
|
|
12828
12837
|
readonly _nominal_AnimationConstraint: unique symbol;
|
|
12838
|
+
/**
|
|
12839
|
+
* - **ThreadSafety**: ReadSafe
|
|
12840
|
+
*
|
|
12841
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#AngularDamping)
|
|
12842
|
+
*/
|
|
12843
|
+
AngularDamping: number;
|
|
12844
|
+
/**
|
|
12845
|
+
* - **ThreadSafety**: ReadSafe
|
|
12846
|
+
*
|
|
12847
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#AngularStrength)
|
|
12848
|
+
*/
|
|
12849
|
+
AngularStrength: number;
|
|
12829
12850
|
/**
|
|
12830
12851
|
* - **ThreadSafety**: ReadSafe
|
|
12831
12852
|
* - **Tags**: Hidden, NotReplicated
|
|
@@ -12852,6 +12873,18 @@ interface AnimationConstraint extends Constraint {
|
|
|
12852
12873
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#IsKinematic)
|
|
12853
12874
|
*/
|
|
12854
12875
|
IsKinematic: boolean;
|
|
12876
|
+
/**
|
|
12877
|
+
* - **ThreadSafety**: ReadSafe
|
|
12878
|
+
*
|
|
12879
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#LinearDamping)
|
|
12880
|
+
*/
|
|
12881
|
+
LinearDamping: number;
|
|
12882
|
+
/**
|
|
12883
|
+
* - **ThreadSafety**: ReadSafe
|
|
12884
|
+
*
|
|
12885
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#LinearStrength)
|
|
12886
|
+
*/
|
|
12887
|
+
LinearStrength: number;
|
|
12855
12888
|
/**
|
|
12856
12889
|
* Maximum force magnitude the constraint can apply to achieve its goal.
|
|
12857
12890
|
*
|
|
@@ -16831,7 +16864,7 @@ interface ExperienceStateCaptureService extends Instance {
|
|
|
16831
16864
|
readonly _nominal_ExperienceStateCaptureService: unique symbol;
|
|
16832
16865
|
}
|
|
16833
16866
|
/**
|
|
16834
|
-
* - **Tags**: NotCreatable, Service
|
|
16867
|
+
* - **Tags**: NotCreatable, Service
|
|
16835
16868
|
*
|
|
16836
16869
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExperienceStateRecordingService)
|
|
16837
16870
|
*/
|
|
@@ -17420,6 +17453,21 @@ interface FileManagerService extends Instance {
|
|
|
17420
17453
|
*/
|
|
17421
17454
|
readonly _nominal_FileManagerService: unique symbol;
|
|
17422
17455
|
}
|
|
17456
|
+
/**
|
|
17457
|
+
* - **Tags**: NotCreatable, Service
|
|
17458
|
+
*
|
|
17459
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FileSyncReplicationService)
|
|
17460
|
+
*/
|
|
17461
|
+
interface FileSyncReplicationService extends Instance {
|
|
17462
|
+
/**
|
|
17463
|
+
* **DO NOT USE!**
|
|
17464
|
+
*
|
|
17465
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
17466
|
+
* @hidden
|
|
17467
|
+
* @deprecated
|
|
17468
|
+
*/
|
|
17469
|
+
readonly _nominal_FileSyncReplicationService: unique symbol;
|
|
17470
|
+
}
|
|
17423
17471
|
/**
|
|
17424
17472
|
* A preconfigured particle emitter with the visual aesthetic of fire.
|
|
17425
17473
|
*
|
|
@@ -18418,6 +18466,13 @@ interface GroupService extends Instance {
|
|
|
18418
18466
|
* @returns An array of dictionaries containing information on the group's the `Player` is a member of.
|
|
18419
18467
|
*/
|
|
18420
18468
|
GetGroupsAsync(this: GroupService, userId: number): Array<GetGroupsAsyncResult>;
|
|
18469
|
+
/**
|
|
18470
|
+
* - **ThreadSafety**: Unsafe
|
|
18471
|
+
* - **Tags**: Yields
|
|
18472
|
+
*
|
|
18473
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GroupService#GetRolesInGroupAsync)
|
|
18474
|
+
*/
|
|
18475
|
+
GetRolesInGroupAsync(this: GroupService, userId: number, groupId: number): unknown;
|
|
18421
18476
|
/**
|
|
18422
18477
|
* Prompts the local `Player` to join a specified Roblox group via a native modal.
|
|
18423
18478
|
*
|
|
@@ -20168,6 +20223,8 @@ interface ScrollingFrame extends GuiObject {
|
|
|
20168
20223
|
*/
|
|
20169
20224
|
VerticalScrollBarPosition: Enum.VerticalScrollBarPosition;
|
|
20170
20225
|
/**
|
|
20226
|
+
* Returns a `Vector2` representing the current inertial scroll velocity after the user stops their input.
|
|
20227
|
+
*
|
|
20171
20228
|
* - **ThreadSafety**: Unsafe
|
|
20172
20229
|
*
|
|
20173
20230
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#GetScrollVelocity)
|
|
@@ -20175,6 +20232,8 @@ interface ScrollingFrame extends GuiObject {
|
|
|
20175
20232
|
*/
|
|
20176
20233
|
GetScrollVelocity(this: ScrollingFrame): Vector2;
|
|
20177
20234
|
/**
|
|
20235
|
+
* Resets the inertial scroll velocity of the `ScrollingFrame` to `0` on both axes.
|
|
20236
|
+
*
|
|
20178
20237
|
* - **ThreadSafety**: Unsafe
|
|
20179
20238
|
*
|
|
20180
20239
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#ResetScrollVelocity)
|
|
@@ -22732,6 +22791,8 @@ interface GuiService extends Instance {
|
|
|
22732
22791
|
Vector2
|
|
22733
22792
|
]>;
|
|
22734
22793
|
/**
|
|
22794
|
+
* Takes an `ScreenInsets` value and returns a `Rect2D` describing the inset region, relative to the `CoreUISafeInsets` area.
|
|
22795
|
+
*
|
|
22735
22796
|
* - **ThreadSafety**: Unsafe
|
|
22736
22797
|
*
|
|
22737
22798
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetInsetArea)
|
|
@@ -23034,6 +23095,21 @@ interface HeapProfilerService extends Instance {
|
|
|
23034
23095
|
*/
|
|
23035
23096
|
readonly _nominal_HeapProfilerService: unique symbol;
|
|
23036
23097
|
}
|
|
23098
|
+
/**
|
|
23099
|
+
* - **Tags**: NotCreatable, Service
|
|
23100
|
+
*
|
|
23101
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HeatmapQueryService)
|
|
23102
|
+
*/
|
|
23103
|
+
interface HeatmapQueryService extends Instance {
|
|
23104
|
+
/**
|
|
23105
|
+
* **DO NOT USE!**
|
|
23106
|
+
*
|
|
23107
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
23108
|
+
* @hidden
|
|
23109
|
+
* @deprecated
|
|
23110
|
+
*/
|
|
23111
|
+
readonly _nominal_HeatmapQueryService: unique symbol;
|
|
23112
|
+
}
|
|
23037
23113
|
/**
|
|
23038
23114
|
* - **Tags**: NotCreatable, Service
|
|
23039
23115
|
*
|
|
@@ -25369,7 +25445,8 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25369
25445
|
*
|
|
25370
25446
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointFromName)
|
|
25371
25447
|
* @param this
|
|
25372
|
-
* @param name
|
|
25448
|
+
* @param name string
|
|
25449
|
+
* @returns Instance
|
|
25373
25450
|
*/
|
|
25374
25451
|
GetJointFromName(this: HumanoidRigDescription, name: string): Instance | undefined;
|
|
25375
25452
|
/**
|
|
@@ -25377,6 +25454,7 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25377
25454
|
*
|
|
25378
25455
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointNames)
|
|
25379
25456
|
* @param this
|
|
25457
|
+
* @returns Array
|
|
25380
25458
|
*/
|
|
25381
25459
|
GetJointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
25382
25460
|
/**
|
|
@@ -25384,6 +25462,7 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25384
25462
|
*
|
|
25385
25463
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR15JointNames)
|
|
25386
25464
|
* @param this
|
|
25465
|
+
* @returns Array
|
|
25387
25466
|
*/
|
|
25388
25467
|
GetR15JointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
25389
25468
|
/**
|
|
@@ -25391,6 +25470,7 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25391
25470
|
*
|
|
25392
25471
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR6JointNames)
|
|
25393
25472
|
* @param this
|
|
25473
|
+
* @returns Array
|
|
25394
25474
|
*/
|
|
25395
25475
|
GetR6JointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
25396
25476
|
}
|
|
@@ -25899,6 +25979,12 @@ interface InputBinding extends Instance {
|
|
|
25899
25979
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#UIButton)
|
|
25900
25980
|
*/
|
|
25901
25981
|
UIButton: GuiButton | undefined;
|
|
25982
|
+
/**
|
|
25983
|
+
* - **ThreadSafety**: ReadSafe
|
|
25984
|
+
*
|
|
25985
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#UIModifier)
|
|
25986
|
+
*/
|
|
25987
|
+
UIModifier: GuiButton | undefined;
|
|
25902
25988
|
/**
|
|
25903
25989
|
* Specifies an alternate `KeyCode` for dispatching directionally "up" inputs to the parent `InputAction`.
|
|
25904
25990
|
*
|
|
@@ -28502,8 +28588,6 @@ interface MarketplaceService extends Instance {
|
|
|
28502
28588
|
* - **ThreadSafety**: Unsafe
|
|
28503
28589
|
*
|
|
28504
28590
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#OpenShop)
|
|
28505
|
-
* @param this The service responsible for in-experience transactions.
|
|
28506
|
-
* @param player
|
|
28507
28591
|
*/
|
|
28508
28592
|
OpenShop(this: MarketplaceService, player: Player): void;
|
|
28509
28593
|
/**
|
|
@@ -29577,6 +29661,32 @@ interface MicroProfilerService extends Instance {
|
|
|
29577
29661
|
* @deprecated
|
|
29578
29662
|
*/
|
|
29579
29663
|
readonly _nominal_MicroProfilerService: unique symbol;
|
|
29664
|
+
/**
|
|
29665
|
+
* - **ThreadSafety**: Unsafe
|
|
29666
|
+
* - **Tags**: CustomLuaState
|
|
29667
|
+
*
|
|
29668
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#GetDataInRange)
|
|
29669
|
+
*/
|
|
29670
|
+
GetDataInRange(this: MicroProfilerService, slotId: number, offset: number, size: number, destBuffer: buffer, destBufferOffset: number): number;
|
|
29671
|
+
/**
|
|
29672
|
+
* - **ThreadSafety**: Unsafe
|
|
29673
|
+
*
|
|
29674
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#GetDataSize)
|
|
29675
|
+
*/
|
|
29676
|
+
GetDataSize(this: MicroProfilerService, slotId: number): number;
|
|
29677
|
+
/**
|
|
29678
|
+
* - **ThreadSafety**: Unsafe
|
|
29679
|
+
* - **Tags**: CustomLuaState
|
|
29680
|
+
*
|
|
29681
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#ProcessCommand)
|
|
29682
|
+
*/
|
|
29683
|
+
ProcessCommand(this: MicroProfilerService, cmdBuf: buffer, cmdOffset: number, cmdSize: number, respBuf: buffer, respOffset: number, respSize: number): number;
|
|
29684
|
+
/**
|
|
29685
|
+
* - **ThreadSafety**: Unsafe
|
|
29686
|
+
*
|
|
29687
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#DataChanged)
|
|
29688
|
+
*/
|
|
29689
|
+
readonly DataChanged: RBXScriptSignal<(slotId: number, flags: number) => void>;
|
|
29580
29690
|
}
|
|
29581
29691
|
/**
|
|
29582
29692
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -30796,12 +30906,15 @@ interface BasePart extends PVInstance {
|
|
|
30796
30906
|
*/
|
|
30797
30907
|
Velocity: Vector3;
|
|
30798
30908
|
/**
|
|
30909
|
+
* Returns the torque needed to achieve a given angular acceleration on this part's assembly, optionally accounting for gyroscopic effects.
|
|
30910
|
+
*
|
|
30799
30911
|
* - **ThreadSafety**: Unsafe
|
|
30800
30912
|
*
|
|
30801
30913
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#AngularAccelerationToTorque)
|
|
30802
30914
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
30803
|
-
* @param angAcceleration
|
|
30804
|
-
* @param angVelocity
|
|
30915
|
+
* @param angAcceleration The desired angular acceleration vector in world space.
|
|
30916
|
+
* @param angVelocity The current angular velocity of the assembly in world space. Defaults to `(0, 0, 0)`. Supply the assembly's angular velocity to account for gyroscopic effects.
|
|
30917
|
+
* @returns A `Vector3` representing the world-space torque required to produce the specified angular acceleration.
|
|
30805
30918
|
*/
|
|
30806
30919
|
AngularAccelerationToTorque(this: BasePart, angAcceleration: Vector3, angVelocity?: Vector3): Vector3;
|
|
30807
30920
|
/**
|
|
@@ -31043,12 +31156,15 @@ interface BasePart extends PVInstance {
|
|
|
31043
31156
|
*/
|
|
31044
31157
|
SetNetworkOwnershipAuto(this: BasePart): void;
|
|
31045
31158
|
/**
|
|
31159
|
+
* Returns the angular acceleration that would result from applying a given torque to this part's assembly, optionally accounting for gyroscopic effects.
|
|
31160
|
+
*
|
|
31046
31161
|
* - **ThreadSafety**: Unsafe
|
|
31047
31162
|
*
|
|
31048
31163
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#TorqueToAngularAcceleration)
|
|
31049
31164
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
31050
|
-
* @param torque
|
|
31051
|
-
* @param angVelocity
|
|
31165
|
+
* @param torque The torque vector applied to the assembly in world space.
|
|
31166
|
+
* @param angVelocity The current angular velocity of the assembly in world space. Defaults to `(0, 0, 0)`. Supply the assembly's angular velocity to account for gyroscopic effects.
|
|
31167
|
+
* @returns A `Vector3` representing the resulting angular acceleration in world space.
|
|
31052
31168
|
*/
|
|
31053
31169
|
TorqueToAngularAcceleration(this: BasePart, torque: Vector3, angVelocity?: Vector3): Vector3;
|
|
31054
31170
|
/**
|
|
@@ -31489,7 +31605,7 @@ interface WedgePart extends FormFactorPart {
|
|
|
31489
31605
|
readonly _nominal_WedgePart: unique symbol;
|
|
31490
31606
|
}
|
|
31491
31607
|
/**
|
|
31492
|
-
* Terrain lets you to create dynamically morphable environments.
|
|
31608
|
+
* `Terrain` lets you to create dynamically morphable environments.
|
|
31493
31609
|
*
|
|
31494
31610
|
* - **Tags**: NotCreatable
|
|
31495
31611
|
*
|
|
@@ -31505,9 +31621,9 @@ interface Terrain extends BasePart {
|
|
|
31505
31621
|
*/
|
|
31506
31622
|
readonly _nominal_Terrain: unique symbol;
|
|
31507
31623
|
/**
|
|
31508
|
-
* **Deprecated:**
|
|
31624
|
+
* **Deprecated:** The legacy terrain engine has been removed, so this property will always be `true`.
|
|
31509
31625
|
*
|
|
31510
|
-
* Returns true if the
|
|
31626
|
+
* Returns `true` if the game is using the smooth terrain system.
|
|
31511
31627
|
*
|
|
31512
31628
|
* - **ThreadSafety**: ReadSafe
|
|
31513
31629
|
* - **Tags**: NotReplicated
|
|
@@ -31527,7 +31643,7 @@ interface Terrain extends BasePart {
|
|
|
31527
31643
|
*/
|
|
31528
31644
|
readonly MaxExtents: Region3int16;
|
|
31529
31645
|
/**
|
|
31530
|
-
* The tint of
|
|
31646
|
+
* The tint of `Terrain` water.
|
|
31531
31647
|
*
|
|
31532
31648
|
* - **ThreadSafety**: ReadSafe
|
|
31533
31649
|
*
|
|
@@ -31535,7 +31651,7 @@ interface Terrain extends BasePart {
|
|
|
31535
31651
|
*/
|
|
31536
31652
|
WaterColor: Color3;
|
|
31537
31653
|
/**
|
|
31538
|
-
* Controls how opaque
|
|
31654
|
+
* Controls how opaque `Terrain` water reflections are.
|
|
31539
31655
|
*
|
|
31540
31656
|
* - **ThreadSafety**: ReadSafe
|
|
31541
31657
|
*
|
|
@@ -31543,7 +31659,7 @@ interface Terrain extends BasePart {
|
|
|
31543
31659
|
*/
|
|
31544
31660
|
WaterReflectance: number;
|
|
31545
31661
|
/**
|
|
31546
|
-
* The transparency of
|
|
31662
|
+
* The transparency of `Terrain` water.
|
|
31547
31663
|
*
|
|
31548
31664
|
* - **ThreadSafety**: ReadSafe
|
|
31549
31665
|
*
|
|
@@ -31551,7 +31667,7 @@ interface Terrain extends BasePart {
|
|
|
31551
31667
|
*/
|
|
31552
31668
|
WaterTransparency: number;
|
|
31553
31669
|
/**
|
|
31554
|
-
* Sets the maximum height of
|
|
31670
|
+
* Sets the maximum height of `Terrain` water waves in studs.
|
|
31555
31671
|
*
|
|
31556
31672
|
* - **ThreadSafety**: ReadSafe
|
|
31557
31673
|
*
|
|
@@ -31559,7 +31675,7 @@ interface Terrain extends BasePart {
|
|
|
31559
31675
|
*/
|
|
31560
31676
|
WaterWaveSize: number;
|
|
31561
31677
|
/**
|
|
31562
|
-
* Sets how many times
|
|
31678
|
+
* Sets how many times `Terrain` water waves will move up and down per minute.
|
|
31563
31679
|
*
|
|
31564
31680
|
* - **ThreadSafety**: ReadSafe
|
|
31565
31681
|
*
|
|
@@ -31569,13 +31685,13 @@ interface Terrain extends BasePart {
|
|
|
31569
31685
|
/**
|
|
31570
31686
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31571
31687
|
*
|
|
31572
|
-
*
|
|
31688
|
+
* Obsolete function which no longer does anything.
|
|
31573
31689
|
*
|
|
31574
31690
|
* - **ThreadSafety**: Unsafe
|
|
31575
31691
|
* - **Tags**:
|
|
31576
31692
|
*
|
|
31577
31693
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#AutowedgeCell)
|
|
31578
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31694
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31579
31695
|
* @param x
|
|
31580
31696
|
* @param y
|
|
31581
31697
|
* @param z
|
|
@@ -31586,49 +31702,49 @@ interface Terrain extends BasePart {
|
|
|
31586
31702
|
/**
|
|
31587
31703
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31588
31704
|
*
|
|
31589
|
-
*
|
|
31705
|
+
* Obsolete function which no longer does anything.
|
|
31590
31706
|
*
|
|
31591
31707
|
* - **ThreadSafety**: Unsafe
|
|
31592
31708
|
* - **Tags**:
|
|
31593
31709
|
*
|
|
31594
31710
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#AutowedgeCells)
|
|
31595
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31711
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31596
31712
|
* @param region
|
|
31597
31713
|
*
|
|
31598
31714
|
* @deprecated
|
|
31599
31715
|
*/
|
|
31600
31716
|
AutowedgeCells(this: Terrain, region: Region3int16): void;
|
|
31601
31717
|
/**
|
|
31602
|
-
* Returns the world position of the center of the terrain cell
|
|
31718
|
+
* Returns the world position of the center of the terrain cell.
|
|
31603
31719
|
*
|
|
31604
31720
|
* - **ThreadSafety**: Unsafe
|
|
31605
31721
|
*
|
|
31606
31722
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#CellCenterToWorld)
|
|
31607
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31723
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31608
31724
|
* @param x
|
|
31609
31725
|
* @param y
|
|
31610
31726
|
* @param z
|
|
31611
31727
|
*/
|
|
31612
31728
|
CellCenterToWorld(this: Terrain, x: number, y: number, z: number): Vector3;
|
|
31613
31729
|
/**
|
|
31614
|
-
* Returns the position of the lower-left-forward corner of the grid cell
|
|
31730
|
+
* Returns the position of the lower-left-forward corner of the grid cell.
|
|
31615
31731
|
*
|
|
31616
31732
|
* - **ThreadSafety**: Unsafe
|
|
31617
31733
|
*
|
|
31618
31734
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#CellCornerToWorld)
|
|
31619
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31735
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31620
31736
|
* @param x
|
|
31621
31737
|
* @param y
|
|
31622
31738
|
* @param z
|
|
31623
31739
|
*/
|
|
31624
31740
|
CellCornerToWorld(this: Terrain, x: number, y: number, z: number): Vector3;
|
|
31625
31741
|
/**
|
|
31626
|
-
* Clears
|
|
31742
|
+
* Clears all terrain.
|
|
31627
31743
|
*
|
|
31628
31744
|
* - **ThreadSafety**: Unsafe
|
|
31629
31745
|
*
|
|
31630
31746
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#Clear)
|
|
31631
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31747
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31632
31748
|
*/
|
|
31633
31749
|
Clear(this: Terrain): void;
|
|
31634
31750
|
/**
|
|
@@ -31636,28 +31752,25 @@ interface Terrain extends BasePart {
|
|
|
31636
31752
|
* - **Tags**: CustomLuaState
|
|
31637
31753
|
*
|
|
31638
31754
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ClearVoxelsAsync_beta)
|
|
31639
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31640
|
-
* @param region
|
|
31641
|
-
* @param channelIds
|
|
31642
31755
|
*/
|
|
31643
31756
|
ClearVoxelsAsync_beta(this: Terrain, region: Region3, channelIds: Array<unknown>): void;
|
|
31644
31757
|
/**
|
|
31645
|
-
* Stores a chunk of terrain into a `TerrainRegion` object so it can be loaded back later.
|
|
31758
|
+
* Stores a chunk of terrain into a `TerrainRegion` object so it can be loaded back later.
|
|
31646
31759
|
*
|
|
31647
31760
|
* - **ThreadSafety**: Unsafe
|
|
31648
31761
|
*
|
|
31649
31762
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#CopyRegion)
|
|
31650
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31763
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31651
31764
|
* @param region
|
|
31652
31765
|
*/
|
|
31653
31766
|
CopyRegion(this: Terrain, region: Region3int16): TerrainRegion;
|
|
31654
31767
|
/**
|
|
31655
|
-
* Returns the number of non-empty cells in the
|
|
31768
|
+
* Returns the number of non-empty cells in the terrain.
|
|
31656
31769
|
*
|
|
31657
31770
|
* - **ThreadSafety**: Unsafe
|
|
31658
31771
|
*
|
|
31659
31772
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#CountCells)
|
|
31660
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31773
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31661
31774
|
*/
|
|
31662
31775
|
CountCells(this: Terrain): number;
|
|
31663
31776
|
/**
|
|
@@ -31666,7 +31779,7 @@ interface Terrain extends BasePart {
|
|
|
31666
31779
|
* - **ThreadSafety**: Unsafe
|
|
31667
31780
|
*
|
|
31668
31781
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#FillBall)
|
|
31669
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31782
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31670
31783
|
* @param center The position of the center of the terrain ball.
|
|
31671
31784
|
* @param radius The radius in studs of the terrain ball.
|
|
31672
31785
|
* @param material The `Material` of the terrain ball.
|
|
@@ -31678,9 +31791,9 @@ interface Terrain extends BasePart {
|
|
|
31678
31791
|
* - **ThreadSafety**: Unsafe
|
|
31679
31792
|
*
|
|
31680
31793
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#FillBlock)
|
|
31681
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31794
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31682
31795
|
* @param cframe The position and orientation of the terrain block.
|
|
31683
|
-
* @param size The size in studs of the square block
|
|
31796
|
+
* @param size The size in studs of the square block (both the height and width).
|
|
31684
31797
|
* @param material The `Material` of the terrain block.
|
|
31685
31798
|
*/
|
|
31686
31799
|
FillBlock(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>): void;
|
|
@@ -31690,7 +31803,7 @@ interface Terrain extends BasePart {
|
|
|
31690
31803
|
* - **ThreadSafety**: Unsafe
|
|
31691
31804
|
*
|
|
31692
31805
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#FillCylinder)
|
|
31693
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31806
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31694
31807
|
* @param cframe The position and orientation of the terrain cylinder.
|
|
31695
31808
|
* @param height The height in studs of the terrain cylinder.
|
|
31696
31809
|
* @param radius The radius in studs of the terrain cylinder.
|
|
@@ -31703,19 +31816,19 @@ interface Terrain extends BasePart {
|
|
|
31703
31816
|
* - **ThreadSafety**: Unsafe
|
|
31704
31817
|
*
|
|
31705
31818
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#FillRegion)
|
|
31706
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31819
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31707
31820
|
* @param region
|
|
31708
31821
|
* @param resolution
|
|
31709
31822
|
* @param material
|
|
31710
31823
|
*/
|
|
31711
31824
|
FillRegion(this: Terrain, region: Region3, resolution: number, material: CastsToEnum<Enum.Material>): void;
|
|
31712
31825
|
/**
|
|
31713
|
-
* Fills a wedge-shaped volume of
|
|
31826
|
+
* Fills a wedge-shaped volume of terrain with the given `Material`.
|
|
31714
31827
|
*
|
|
31715
31828
|
* - **ThreadSafety**: Unsafe
|
|
31716
31829
|
*
|
|
31717
31830
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#FillWedge)
|
|
31718
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31831
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31719
31832
|
* @param cframe The position and orientation of the wedge to fill.
|
|
31720
31833
|
* @param size The size of the wedge to fill.
|
|
31721
31834
|
* @param material The material with which the wedge will be filled.
|
|
@@ -31730,13 +31843,13 @@ interface Terrain extends BasePart {
|
|
|
31730
31843
|
/**
|
|
31731
31844
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31732
31845
|
*
|
|
31733
|
-
* Returns the closest
|
|
31846
|
+
* Returns the closest cell material from the legacy terrain engine that matches the smooth terrain voxel specified.
|
|
31734
31847
|
*
|
|
31735
31848
|
* - **ThreadSafety**: Unsafe
|
|
31736
31849
|
* - **Tags**:
|
|
31737
31850
|
*
|
|
31738
31851
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetCell)
|
|
31739
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31852
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31740
31853
|
* @param x
|
|
31741
31854
|
* @param y
|
|
31742
31855
|
* @param z
|
|
@@ -31756,7 +31869,7 @@ interface Terrain extends BasePart {
|
|
|
31756
31869
|
* - **ThreadSafety**: Safe
|
|
31757
31870
|
*
|
|
31758
31871
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetMaterialColor)
|
|
31759
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31872
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31760
31873
|
* @param material
|
|
31761
31874
|
*/
|
|
31762
31875
|
GetMaterialColor(this: Terrain, material: CastsToEnum<Enum.Material>): Color3;
|
|
@@ -31769,13 +31882,13 @@ interface Terrain extends BasePart {
|
|
|
31769
31882
|
/**
|
|
31770
31883
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31771
31884
|
*
|
|
31772
|
-
* Returns if the cell is a water cell.
|
|
31885
|
+
* Returns `true` if the cell is a water cell.
|
|
31773
31886
|
*
|
|
31774
31887
|
* - **ThreadSafety**: Unsafe
|
|
31775
31888
|
* - **Tags**:
|
|
31776
31889
|
*
|
|
31777
31890
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetWaterCell)
|
|
31778
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31891
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31779
31892
|
* @param x
|
|
31780
31893
|
* @param y
|
|
31781
31894
|
* @param z
|
|
@@ -31788,10 +31901,6 @@ interface Terrain extends BasePart {
|
|
|
31788
31901
|
* - **Tags**: CustomLuaState
|
|
31789
31902
|
*
|
|
31790
31903
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#IterateVoxelsAsync_beta)
|
|
31791
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31792
|
-
* @param region
|
|
31793
|
-
* @param resolution
|
|
31794
|
-
* @param channelIds
|
|
31795
31904
|
*/
|
|
31796
31905
|
IterateVoxelsAsync_beta(this: Terrain, region: Region3, resolution: number, channelIds: Array<unknown>): TerrainIterateOperation;
|
|
31797
31906
|
/**
|
|
@@ -31799,19 +31908,15 @@ interface Terrain extends BasePart {
|
|
|
31799
31908
|
* - **Tags**: CustomLuaState
|
|
31800
31909
|
*
|
|
31801
31910
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ModifyVoxelsAsync_beta)
|
|
31802
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31803
|
-
* @param region
|
|
31804
|
-
* @param resolution
|
|
31805
|
-
* @param channelIds
|
|
31806
31911
|
*/
|
|
31807
31912
|
ModifyVoxelsAsync_beta(this: Terrain, region: Region3, resolution: number, channelIds: Array<unknown>): TerrainModifyOperation;
|
|
31808
31913
|
/**
|
|
31809
|
-
* Applies a chunk of terrain to the Terrain object.
|
|
31914
|
+
* Applies a chunk of terrain to the `Terrain` object.
|
|
31810
31915
|
*
|
|
31811
31916
|
* - **ThreadSafety**: Unsafe
|
|
31812
31917
|
*
|
|
31813
31918
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#PasteRegion)
|
|
31814
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31919
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31815
31920
|
* @param region
|
|
31816
31921
|
* @param corner
|
|
31817
31922
|
* @param pasteEmptyCells
|
|
@@ -31824,7 +31929,7 @@ interface Terrain extends BasePart {
|
|
|
31824
31929
|
* - **Tags**: CustomLuaState
|
|
31825
31930
|
*
|
|
31826
31931
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ReadVoxelChannels)
|
|
31827
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31932
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31828
31933
|
* @param region Target region to read from. Must be aligned to the voxel grid. Will throw an error if region is too large; limit is currently 4194304 voxels³.
|
|
31829
31934
|
* @param resolution Voxel resolution. Must be 4.
|
|
31830
31935
|
* @param channelIds Array of channel IDs (strings) that need to be accessed from the voxel data. Each channel ID represents a type of data that's stored in voxel. Current supported IDs are `{"SolidMaterial", "SolidOccupancy", "LiquidOccupancy"}`.
|
|
@@ -31842,9 +31947,9 @@ interface Terrain extends BasePart {
|
|
|
31842
31947
|
* - **Tags**: CustomLuaState
|
|
31843
31948
|
*
|
|
31844
31949
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ReadVoxels)
|
|
31845
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31846
|
-
* @param region Target region to read from. Must be aligned to the voxel grid. Will throw an error if region is too large. The limit is currently 4194304 voxels
|
|
31847
|
-
* @param resolution Voxel resolution. Must be 4
|
|
31950
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31951
|
+
* @param region Target region to read from. Must be aligned to the voxel grid. Will throw an error if region is too large. The limit is currently 4194304 voxels³.
|
|
31952
|
+
* @param resolution Voxel resolution. Must be `4`.
|
|
31848
31953
|
* @returns Returns raw voxel data as two 3D arrays. - `materials` - 3D array of `Material` from the target area. Also contains a Size field, equal to the dimensions of the nested arrays.
|
|
31849
31954
|
* - `occupancies` - 3D array of occupancy values from the target area. Also contains a Size field, equal to the dimensions of the nested arrays.
|
|
31850
31955
|
*/
|
|
@@ -31857,10 +31962,6 @@ interface Terrain extends BasePart {
|
|
|
31857
31962
|
* - **Tags**: CustomLuaState
|
|
31858
31963
|
*
|
|
31859
31964
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ReadVoxelsAsync_beta)
|
|
31860
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31861
|
-
* @param region
|
|
31862
|
-
* @param resolution
|
|
31863
|
-
* @param channelIds
|
|
31864
31965
|
*/
|
|
31865
31966
|
ReadVoxelsAsync_beta(this: Terrain, region: Region3, resolution: number, channelIds: Array<unknown>): TerrainReadOperation;
|
|
31866
31967
|
/**
|
|
@@ -31869,9 +31970,9 @@ interface Terrain extends BasePart {
|
|
|
31869
31970
|
* - **ThreadSafety**: Unsafe
|
|
31870
31971
|
*
|
|
31871
31972
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ReplaceMaterial)
|
|
31872
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31973
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31873
31974
|
* @param region The region in which the replacement operation will occur.
|
|
31874
|
-
* @param resolution The resolution at which the replacement operation will take place; at the moment this must be exactly 4
|
|
31975
|
+
* @param resolution The resolution at which the replacement operation will take place; at the moment this must be exactly `4`.
|
|
31875
31976
|
* @param sourceMaterial The old material that shall be replaced.
|
|
31876
31977
|
* @param targetMaterial The new material.
|
|
31877
31978
|
*/
|
|
@@ -31891,7 +31992,7 @@ interface Terrain extends BasePart {
|
|
|
31891
31992
|
* - **Tags**:
|
|
31892
31993
|
*
|
|
31893
31994
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetCell)
|
|
31894
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31995
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31895
31996
|
* @param x
|
|
31896
31997
|
* @param y
|
|
31897
31998
|
* @param z
|
|
@@ -31911,7 +32012,7 @@ interface Terrain extends BasePart {
|
|
|
31911
32012
|
* - **Tags**:
|
|
31912
32013
|
*
|
|
31913
32014
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetCells)
|
|
31914
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32015
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31915
32016
|
* @param region
|
|
31916
32017
|
* @param material
|
|
31917
32018
|
* @param block
|
|
@@ -31926,7 +32027,7 @@ interface Terrain extends BasePart {
|
|
|
31926
32027
|
* - **ThreadSafety**: Unsafe
|
|
31927
32028
|
*
|
|
31928
32029
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetMaterialColor)
|
|
31929
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32030
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31930
32031
|
* @param material
|
|
31931
32032
|
* @param value
|
|
31932
32033
|
*/
|
|
@@ -31940,13 +32041,13 @@ interface Terrain extends BasePart {
|
|
|
31940
32041
|
/**
|
|
31941
32042
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31942
32043
|
*
|
|
31943
|
-
* Sets the specified terrain voxel's material to
|
|
32044
|
+
* Sets the specified terrain voxel's material to water and sets its occupancy to `1`.
|
|
31944
32045
|
*
|
|
31945
32046
|
* - **ThreadSafety**: Unsafe
|
|
31946
32047
|
* - **Tags**:
|
|
31947
32048
|
*
|
|
31948
32049
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetWaterCell)
|
|
31949
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32050
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31950
32051
|
* @param x
|
|
31951
32052
|
* @param y
|
|
31952
32053
|
* @param z
|
|
@@ -31957,22 +32058,22 @@ interface Terrain extends BasePart {
|
|
|
31957
32058
|
*/
|
|
31958
32059
|
SetWaterCell(this: Terrain, x: number, y: number, z: number, force: CastsToEnum<Enum.WaterForce>, direction: CastsToEnum<Enum.WaterDirection>): void;
|
|
31959
32060
|
/**
|
|
31960
|
-
* Returns the grid cell location that contains the point
|
|
32061
|
+
* Returns the grid cell location that contains the position point.
|
|
31961
32062
|
*
|
|
31962
32063
|
* - **ThreadSafety**: Unsafe
|
|
31963
32064
|
*
|
|
31964
32065
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WorldToCell)
|
|
31965
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32066
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31966
32067
|
* @param position
|
|
31967
32068
|
*/
|
|
31968
32069
|
WorldToCell(this: Terrain, position: Vector3): Vector3;
|
|
31969
32070
|
/**
|
|
31970
|
-
* Returns the grid cell location that contains the point
|
|
32071
|
+
* Returns the grid cell location that contains the position point, preferring empty grid cells when position is on a grid edge.
|
|
31971
32072
|
*
|
|
31972
32073
|
* - **ThreadSafety**: Unsafe
|
|
31973
32074
|
*
|
|
31974
32075
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WorldToCellPreferEmpty)
|
|
31975
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32076
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31976
32077
|
* @param position
|
|
31977
32078
|
*/
|
|
31978
32079
|
WorldToCellPreferEmpty(this: Terrain, position: Vector3): Vector3;
|
|
@@ -31982,7 +32083,7 @@ interface Terrain extends BasePart {
|
|
|
31982
32083
|
* - **ThreadSafety**: Unsafe
|
|
31983
32084
|
*
|
|
31984
32085
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WorldToCellPreferSolid)
|
|
31985
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32086
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31986
32087
|
* @param position
|
|
31987
32088
|
*/
|
|
31988
32089
|
WorldToCellPreferSolid(this: Terrain, position: Vector3): Vector3;
|
|
@@ -31993,12 +32094,12 @@ interface Terrain extends BasePart {
|
|
|
31993
32094
|
* - **Tags**: CustomLuaState
|
|
31994
32095
|
*
|
|
31995
32096
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WriteVoxelChannels)
|
|
31996
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32097
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31997
32098
|
* @param region Target region to write to. Must be aligned to the voxel grid. Will throw an error if region is too large; limit is currently 4194304 voxels³.
|
|
31998
|
-
* @param resolution Voxel resolution. Must be 4
|
|
31999
|
-
* @param channels Dictionary of voxel data similar to the return value of `ReadVoxelChannels()`. Keys represent each channel ID with their respective value as an array of 3D data. The dictionary can support single or multiple channel inputs. - `SolidMaterial` — The `Material` material of the voxel. Note that `Water` is not supported anymore; instead, a voxel that contains only water should be entered as `SolidMaterial = Enum.Material.Air, LiquidOccupancy = x`, where `x` is a number between 0 (exclusive) and 1 (inclusive).
|
|
32000
|
-
* - `SolidOccupancy` — The occupancy of the voxel's material as specified in the `SolidMaterial` channel. This should be a value between 0 (empty) and 1 (full).
|
|
32001
|
-
* - `LiquidOccupancy` — Specifies the occupancy of the `Water` material in a voxel as a value between 0 (no water) and 1 (full of water). If the `SolidOccupancy` is 1 and the `SolidMaterial` is not `Air`, this will be 0
|
|
32099
|
+
* @param resolution Voxel resolution. Must be `4`.
|
|
32100
|
+
* @param channels Dictionary of voxel data similar to the return value of `ReadVoxelChannels()`. Keys represent each channel ID with their respective value as an array of 3D data. The dictionary can support single or multiple channel inputs. - `SolidMaterial` — The `Material` material of the voxel. Note that `Water` is not supported anymore; instead, a voxel that contains only water should be entered as `SolidMaterial = Enum.Material.Air, LiquidOccupancy = x`, where `x` is a number between `0` (exclusive) and `1` (inclusive).
|
|
32101
|
+
* - `SolidOccupancy` — The occupancy of the voxel's material as specified in the `SolidMaterial` channel. This should be a value between `0` (empty) and `1` (full).
|
|
32102
|
+
* - `LiquidOccupancy` — Specifies the occupancy of the `Water` material in a voxel as a value between `0` (no water) and `1` (full of water). If the `SolidOccupancy` is 1 and the `SolidMaterial` is not `Air`, this will be `0`.
|
|
32002
32103
|
*/
|
|
32003
32104
|
WriteVoxelChannels(this: Terrain, region: Region3, resolution: number, channels: VoxelChannels): void;
|
|
32004
32105
|
/**
|
|
@@ -32008,11 +32109,11 @@ interface Terrain extends BasePart {
|
|
|
32008
32109
|
* - **Tags**: CustomLuaState
|
|
32009
32110
|
*
|
|
32010
32111
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WriteVoxels)
|
|
32011
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32112
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32012
32113
|
* @param region Target region to write to. Must be aligned to the voxel grid. Will throw an error if region is too large.
|
|
32013
|
-
* @param resolution Voxel resolution. Must be 4
|
|
32014
|
-
* @param materials 3D array of
|
|
32015
|
-
* @param occupancy 3D array of voxel occupancies (number between 0 and 1). Dimensions must exactly match the size of the target region in voxels.
|
|
32114
|
+
* @param resolution Voxel resolution. Must be `4`.
|
|
32115
|
+
* @param materials 3D array of `Material`. Dimensions must exactly match the size of the target region in voxels.
|
|
32116
|
+
* @param occupancy 3D array of voxel occupancies (number between `0` and `1`). Dimensions must exactly match the size of the target region in voxels.
|
|
32016
32117
|
*/
|
|
32017
32118
|
WriteVoxels(this: Terrain, region: Region3, resolution: number, materials: Array<Array<Array<CastsToEnum<Enum.Material>>>>, occupancy: Array<Array<Array<number>>>): void;
|
|
32018
32119
|
/**
|
|
@@ -32020,10 +32121,6 @@ interface Terrain extends BasePart {
|
|
|
32020
32121
|
* - **Tags**: CustomLuaState
|
|
32021
32122
|
*
|
|
32022
32123
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WriteVoxelsAsync_beta)
|
|
32023
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32024
|
-
* @param region
|
|
32025
|
-
* @param resolution
|
|
32026
|
-
* @param channelIds
|
|
32027
32124
|
*/
|
|
32028
32125
|
WriteVoxelsAsync_beta(this: Terrain, region: Region3, resolution: number, channelIds: Array<unknown>): TerrainWriteOperation;
|
|
32029
32126
|
}
|
|
@@ -32314,7 +32411,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32314
32411
|
*/
|
|
32315
32412
|
readonly _nominal_VehicleSeat: unique symbol;
|
|
32316
32413
|
/**
|
|
32317
|
-
* Displays how many hinges are detected by the VehicleSeat
|
|
32414
|
+
* Displays how many hinges are detected by the `VehicleSeat`. Useful for debugging vehicle designs.
|
|
32318
32415
|
*
|
|
32319
32416
|
* - **ThreadSafety**: ReadSafe
|
|
32320
32417
|
* - **Tags**: NotReplicated
|
|
@@ -32331,7 +32428,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32331
32428
|
*/
|
|
32332
32429
|
Disabled: boolean;
|
|
32333
32430
|
/**
|
|
32334
|
-
* If true
|
|
32431
|
+
* If `true`, a UI speed bar will be displayed on screen that tells you what speed the vehicle is moving at.
|
|
32335
32432
|
*
|
|
32336
32433
|
* - **ThreadSafety**: ReadSafe
|
|
32337
32434
|
*
|
|
@@ -32347,7 +32444,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32347
32444
|
*/
|
|
32348
32445
|
MaxSpeed: number;
|
|
32349
32446
|
/**
|
|
32350
|
-
* The
|
|
32447
|
+
* The `Humanoid` that is sitting in the seat.
|
|
32351
32448
|
*
|
|
32352
32449
|
* - **ThreadSafety**: ReadSafe
|
|
32353
32450
|
* - **Tags**: NotReplicated
|
|
@@ -32356,7 +32453,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32356
32453
|
*/
|
|
32357
32454
|
readonly Occupant: Humanoid | undefined;
|
|
32358
32455
|
/**
|
|
32359
|
-
* The direction of movement, tied to
|
|
32456
|
+
* The direction of movement, tied to left and right movement inputs.
|
|
32360
32457
|
*
|
|
32361
32458
|
* - **ThreadSafety**: ReadSafe
|
|
32362
32459
|
* - **Tags**: NotReplicated
|
|
@@ -32365,7 +32462,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32365
32462
|
*/
|
|
32366
32463
|
Steer: number;
|
|
32367
32464
|
/**
|
|
32368
|
-
*
|
|
32465
|
+
* The left-to-right movement float, tied to left and right movement inputs.
|
|
32369
32466
|
*
|
|
32370
32467
|
* - **ThreadSafety**: ReadSafe
|
|
32371
32468
|
*
|
|
@@ -32373,7 +32470,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32373
32470
|
*/
|
|
32374
32471
|
SteerFloat: number;
|
|
32375
32472
|
/**
|
|
32376
|
-
* The direction of
|
|
32473
|
+
* The direction of throttle, tied to forward and backward movement inputs.
|
|
32377
32474
|
*
|
|
32378
32475
|
* - **ThreadSafety**: ReadSafe
|
|
32379
32476
|
* - **Tags**: NotReplicated
|
|
@@ -32382,7 +32479,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32382
32479
|
*/
|
|
32383
32480
|
Throttle: number;
|
|
32384
32481
|
/**
|
|
32385
|
-
*
|
|
32482
|
+
* The forward-to-reverse throttle float, tied to forward and backward movement inputs.
|
|
32386
32483
|
*
|
|
32387
32484
|
* - **ThreadSafety**: ReadSafe
|
|
32388
32485
|
*
|
|
@@ -32390,7 +32487,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32390
32487
|
*/
|
|
32391
32488
|
ThrottleFloat: number;
|
|
32392
32489
|
/**
|
|
32393
|
-
* How fast the
|
|
32490
|
+
* How fast the vehicle will be able to attain `MaxSpeed`.
|
|
32394
32491
|
*
|
|
32395
32492
|
* - **ThreadSafety**: ReadSafe
|
|
32396
32493
|
*
|
|
@@ -32406,13 +32503,13 @@ interface VehicleSeat extends BasePart {
|
|
|
32406
32503
|
*/
|
|
32407
32504
|
TurnSpeed: number;
|
|
32408
32505
|
/**
|
|
32409
|
-
* Forces the character with the specified `Humanoid` to sit in the VehicleSeat
|
|
32506
|
+
* Forces the character with the specified `Humanoid` to sit in the `VehicleSeat`.
|
|
32410
32507
|
*
|
|
32411
32508
|
* - **ThreadSafety**: Unsafe
|
|
32412
32509
|
*
|
|
32413
32510
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#Sit)
|
|
32414
32511
|
* @param this A seat object that can be used to control a vehicle.
|
|
32415
|
-
* @param humanoid The
|
|
32512
|
+
* @param humanoid The `Humanoid` being forced to sit in the `VehicleSeat`.
|
|
32416
32513
|
*/
|
|
32417
32514
|
Sit(this: VehicleSeat, humanoid: Instance): void;
|
|
32418
32515
|
/**
|
|
@@ -35887,6 +35984,8 @@ interface Player extends Instance {
|
|
|
35887
35984
|
* @param this An object that represents a presently connected client to the experience.
|
|
35888
35985
|
* @param groupId The `groupId` of the specified group.
|
|
35889
35986
|
* @returns The player's rank in the group.
|
|
35987
|
+
*
|
|
35988
|
+
* @deprecated GetRolesInGroupAsync
|
|
35890
35989
|
*/
|
|
35891
35990
|
GetRankInGroupAsync(this: Player, groupId: number): number;
|
|
35892
35991
|
/**
|
|
@@ -35915,6 +36014,8 @@ interface Player extends Instance {
|
|
|
35915
36014
|
* @param this An object that represents a presently connected client to the experience.
|
|
35916
36015
|
* @param groupId The group ID of the specified group.
|
|
35917
36016
|
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
36017
|
+
*
|
|
36018
|
+
* @deprecated GetRolesInGroupAsync
|
|
35918
36019
|
*/
|
|
35919
36020
|
GetRoleInGroupAsync(this: Player, groupId: number): string;
|
|
35920
36021
|
/**
|
|
@@ -36375,7 +36476,7 @@ interface PlayerHydrationService extends Instance {
|
|
|
36375
36476
|
readonly _nominal_PlayerHydrationService: unique symbol;
|
|
36376
36477
|
}
|
|
36377
36478
|
/**
|
|
36378
|
-
* A container for
|
|
36479
|
+
* A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36379
36480
|
*
|
|
36380
36481
|
* - **Tags**: NotCreatable, NotReplicated
|
|
36381
36482
|
*
|
|
@@ -36391,39 +36492,39 @@ interface PlayerScripts extends Instance {
|
|
|
36391
36492
|
*/
|
|
36392
36493
|
readonly _nominal_PlayerScripts: unique symbol;
|
|
36393
36494
|
/**
|
|
36394
|
-
* Unregisters all ComputerCameraMovementMode enums from the
|
|
36495
|
+
* Unregisters all `ComputerCameraMovementMode` enums from the game's settings menu.
|
|
36395
36496
|
*
|
|
36396
36497
|
* - **ThreadSafety**: Unsafe
|
|
36397
36498
|
*
|
|
36398
36499
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#ClearComputerCameraMovementModes)
|
|
36399
|
-
* @param this A container for
|
|
36500
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36400
36501
|
*/
|
|
36401
36502
|
ClearComputerCameraMovementModes(this: PlayerScripts): void;
|
|
36402
36503
|
/**
|
|
36403
|
-
* Unregisters all ComputerMovementMode enums from the
|
|
36504
|
+
* Unregisters all `ComputerMovementMode` enums from the game's settings menu.
|
|
36404
36505
|
*
|
|
36405
36506
|
* - **ThreadSafety**: Unsafe
|
|
36406
36507
|
*
|
|
36407
36508
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#ClearComputerMovementModes)
|
|
36408
|
-
* @param this A container for
|
|
36509
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36409
36510
|
*/
|
|
36410
36511
|
ClearComputerMovementModes(this: PlayerScripts): void;
|
|
36411
36512
|
/**
|
|
36412
|
-
* Unregisters all TouchCameraMovementMode enums from the
|
|
36513
|
+
* Unregisters all `TouchCameraMovementMode` enums from the game's settings menu.
|
|
36413
36514
|
*
|
|
36414
36515
|
* - **ThreadSafety**: Unsafe
|
|
36415
36516
|
*
|
|
36416
36517
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#ClearTouchCameraMovementModes)
|
|
36417
|
-
* @param this A container for
|
|
36518
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36418
36519
|
*/
|
|
36419
36520
|
ClearTouchCameraMovementModes(this: PlayerScripts): void;
|
|
36420
36521
|
/**
|
|
36421
|
-
* Unregisters all TouchMovementMode enums from the
|
|
36522
|
+
* Unregisters all `TouchMovementMode` enums from the game's settings menu.
|
|
36422
36523
|
*
|
|
36423
36524
|
* - **ThreadSafety**: Unsafe
|
|
36424
36525
|
*
|
|
36425
36526
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#ClearTouchMovementModes)
|
|
36426
|
-
* @param this A container for
|
|
36527
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36427
36528
|
*/
|
|
36428
36529
|
ClearTouchMovementModes(this: PlayerScripts): void;
|
|
36429
36530
|
/**
|
|
@@ -36432,7 +36533,7 @@ interface PlayerScripts extends Instance {
|
|
|
36432
36533
|
* - **ThreadSafety**: Unsafe
|
|
36433
36534
|
*
|
|
36434
36535
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterComputerCameraMovementMode)
|
|
36435
|
-
* @param this A container for
|
|
36536
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36436
36537
|
* @param cameraMovementMode
|
|
36437
36538
|
*/
|
|
36438
36539
|
RegisterComputerCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.ComputerCameraMovementMode>): void;
|
|
@@ -36442,7 +36543,7 @@ interface PlayerScripts extends Instance {
|
|
|
36442
36543
|
* - **ThreadSafety**: Unsafe
|
|
36443
36544
|
*
|
|
36444
36545
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterComputerMovementMode)
|
|
36445
|
-
* @param this A container for
|
|
36546
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36446
36547
|
* @param movementMode
|
|
36447
36548
|
*/
|
|
36448
36549
|
RegisterComputerMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.ComputerMovementMode>): void;
|
|
@@ -36452,7 +36553,7 @@ interface PlayerScripts extends Instance {
|
|
|
36452
36553
|
* - **ThreadSafety**: Unsafe
|
|
36453
36554
|
*
|
|
36454
36555
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterTouchCameraMovementMode)
|
|
36455
|
-
* @param this A container for
|
|
36556
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36456
36557
|
* @param cameraMovementMode
|
|
36457
36558
|
*/
|
|
36458
36559
|
RegisterTouchCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.TouchCameraMovementMode>): void;
|
|
@@ -36462,7 +36563,7 @@ interface PlayerScripts extends Instance {
|
|
|
36462
36563
|
* - **ThreadSafety**: Unsafe
|
|
36463
36564
|
*
|
|
36464
36565
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterTouchMovementMode)
|
|
36465
|
-
* @param this A container for
|
|
36566
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36466
36567
|
* @param movementMode
|
|
36467
36568
|
*/
|
|
36468
36569
|
RegisterTouchMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.TouchMovementMode>): void;
|
|
@@ -37918,11 +38019,11 @@ interface RecommendationService extends Instance {
|
|
|
37918
38019
|
*
|
|
37919
38020
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogPreferenceEvent)
|
|
37920
38021
|
* @param this A service that provides an interface for you to manage and display personalized content recommendations.
|
|
37921
|
-
* @param preferenceType
|
|
37922
|
-
* @param targetType
|
|
37923
|
-
* @param targetId
|
|
37924
|
-
* @param tracingId
|
|
37925
|
-
* @param itemId
|
|
38022
|
+
* @param preferenceType The enum for the type of preference.
|
|
38023
|
+
* @param targetType The enum for the type of target.
|
|
38024
|
+
* @param targetId The identifier of the preference target. The format depends on `targetType`.
|
|
38025
|
+
* @param tracingId The tracing ID returned from the `GenerateItemListAsync` response. Pass an empty string if the preference originates outside a recommendation feed.
|
|
38026
|
+
* @param itemId The item ID returned from the `GenerateItemListAsync` response. Pass an empty string if the preference originates outside a recommendation feed.
|
|
37926
38027
|
*/
|
|
37927
38028
|
LogPreferenceEvent(this: RecommendationService, preferenceType: CastsToEnum<Enum.RecommendationPreferenceType>, targetType: CastsToEnum<Enum.RecommendationPreferenceTargetType>, targetId: string, tracingId?: string, itemId?: string): void;
|
|
37928
38029
|
/**
|
|
@@ -40480,8 +40581,9 @@ interface SocialService extends Instance {
|
|
|
40480
40581
|
*
|
|
40481
40582
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptFeedbackSubmissionAsync)
|
|
40482
40583
|
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
40584
|
+
* @param options Optional `Dictionary` configuring the prompt. Supported keys: - `FeedbackType` (`FeedbackType`). Selects which feedback flow to display. Defaults to `FeedbackType.Feedback`.
|
|
40483
40585
|
*/
|
|
40484
|
-
PromptFeedbackSubmissionAsync(this: SocialService): void;
|
|
40586
|
+
PromptFeedbackSubmissionAsync(this: SocialService, options?: object): void;
|
|
40485
40587
|
/**
|
|
40486
40588
|
* **Deprecated:**
|
|
40487
40589
|
*
|
|
@@ -41076,7 +41178,7 @@ interface AssetSoundEffect extends CustomSoundEffect {
|
|
|
41076
41178
|
readonly _nominal_AssetSoundEffect: unique symbol;
|
|
41077
41179
|
}
|
|
41078
41180
|
/**
|
|
41079
|
-
* - **Tags**: NotCreatable
|
|
41181
|
+
* - **Tags**: NotCreatable
|
|
41080
41182
|
*
|
|
41081
41183
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChannelSelectorSoundEffect)
|
|
41082
41184
|
*/
|
|
@@ -41623,7 +41725,7 @@ interface StartPageService extends Instance {
|
|
|
41623
41725
|
readonly _nominal_StartPageService: unique symbol;
|
|
41624
41726
|
}
|
|
41625
41727
|
/**
|
|
41626
|
-
* If the game allows gear, StarterGear
|
|
41728
|
+
* If the game allows gear, `StarterGear` is a container automatically inserted into each `Player` object when the player joins the game. Whenever the player's character spawns, the contents of that player's `StarterGear` are copied into the player's `Backpack`.
|
|
41627
41729
|
*
|
|
41628
41730
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StarterGear)
|
|
41629
41731
|
*/
|
|
@@ -41638,7 +41740,7 @@ interface StarterGear extends Instance {
|
|
|
41638
41740
|
readonly _nominal_StarterGear: unique symbol;
|
|
41639
41741
|
}
|
|
41640
41742
|
/**
|
|
41641
|
-
* A
|
|
41743
|
+
* A container whose contents are copied into each player's `Backpack` when their player character spawns. It is generally used to hold `Tools`.
|
|
41642
41744
|
*
|
|
41643
41745
|
* - **Tags**: NotCreatable, Service
|
|
41644
41746
|
*
|
|
@@ -47324,12 +47426,16 @@ interface UserGameSettings extends Instance {
|
|
|
47324
47426
|
*/
|
|
47325
47427
|
MouseSensitivity: number;
|
|
47326
47428
|
/**
|
|
47429
|
+
* Internal MicroProfiler setting specifying the frame rate used when capturing server-side RCC profiler data.
|
|
47430
|
+
*
|
|
47327
47431
|
* - **ThreadSafety**: ReadSafe
|
|
47328
47432
|
*
|
|
47329
47433
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#RCCProfilerRecordFrameRate)
|
|
47330
47434
|
*/
|
|
47331
47435
|
RCCProfilerRecordFrameRate: number;
|
|
47332
47436
|
/**
|
|
47437
|
+
* Internal MicroProfiler setting specifying the duration over which server-side RCC profiler data is captured.
|
|
47438
|
+
*
|
|
47333
47439
|
* - **ThreadSafety**: ReadSafe
|
|
47334
47440
|
*
|
|
47335
47441
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#RCCProfilerRecordTimeFrame)
|
|
@@ -47368,12 +47474,16 @@ interface UserGameSettings extends Instance {
|
|
|
47368
47474
|
*/
|
|
47369
47475
|
TouchMovementMode: Enum.TouchMovementMode;
|
|
47370
47476
|
/**
|
|
47477
|
+
* Indicates whether smooth rotation is used instead of snap rotation in VR.
|
|
47478
|
+
*
|
|
47371
47479
|
* - **ThreadSafety**: ReadSafe
|
|
47372
47480
|
*
|
|
47373
47481
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#VRSmoothRotationEnabled)
|
|
47374
47482
|
*/
|
|
47375
47483
|
get VRSmoothRotationEnabled(): boolean;
|
|
47376
47484
|
/**
|
|
47485
|
+
* Indicates whether the VR vignette comfort effect is enabled.
|
|
47486
|
+
*
|
|
47377
47487
|
* - **ThreadSafety**: ReadSafe
|
|
47378
47488
|
*
|
|
47379
47489
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#VignetteEnabled)
|
|
@@ -47645,7 +47755,7 @@ interface UserInputService extends Instance {
|
|
|
47645
47755
|
*/
|
|
47646
47756
|
readonly VREnabled: boolean;
|
|
47647
47757
|
/**
|
|
47648
|
-
* Creates a `VirtualInput` object
|
|
47758
|
+
* Creates a `VirtualInput` object for simulating mouse, keyboard, and pointer input.
|
|
47649
47759
|
*
|
|
47650
47760
|
* - **ThreadSafety**: Unsafe
|
|
47651
47761
|
*
|
|
@@ -48149,6 +48259,13 @@ interface UserService extends Instance {
|
|
|
48149
48259
|
* @deprecated
|
|
48150
48260
|
*/
|
|
48151
48261
|
readonly _nominal_UserService: unique symbol;
|
|
48262
|
+
/**
|
|
48263
|
+
* - **ThreadSafety**: Unsafe
|
|
48264
|
+
* - **Tags**: Yields
|
|
48265
|
+
*
|
|
48266
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserService#GetUserFromGlobalUserIdAsync)
|
|
48267
|
+
*/
|
|
48268
|
+
GetUserFromGlobalUserIdAsync(this: UserService, userId: number): User;
|
|
48152
48269
|
/**
|
|
48153
48270
|
* Returns an array of user information including user name and display name.
|
|
48154
48271
|
*
|
|
@@ -49384,15 +49501,6 @@ interface VoiceChatInternal extends Instance {
|
|
|
49384
49501
|
* @deprecated
|
|
49385
49502
|
*/
|
|
49386
49503
|
GetParticipants(this: VoiceChatInternal): Array<unknown>;
|
|
49387
|
-
/**
|
|
49388
|
-
* - **ThreadSafety**: Unsafe
|
|
49389
|
-
* - **Tags**:
|
|
49390
|
-
*
|
|
49391
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VoiceChatInternal#GetSpeakerDevices)
|
|
49392
|
-
*
|
|
49393
|
-
* @deprecated
|
|
49394
|
-
*/
|
|
49395
|
-
GetSpeakerDevices(this: VoiceChatInternal): unknown;
|
|
49396
49504
|
/**
|
|
49397
49505
|
* - **ThreadSafety**: Unsafe
|
|
49398
49506
|
* - **Tags**:
|
|
@@ -49474,15 +49582,6 @@ interface VoiceChatInternal extends Instance {
|
|
|
49474
49582
|
* @deprecated
|
|
49475
49583
|
*/
|
|
49476
49584
|
SetMicDevice(this: VoiceChatInternal, micDeviceName: string, micDeviceGuid: string): void;
|
|
49477
|
-
/**
|
|
49478
|
-
* - **ThreadSafety**: Unsafe
|
|
49479
|
-
* - **Tags**:
|
|
49480
|
-
*
|
|
49481
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VoiceChatInternal#SetSpeakerDevice)
|
|
49482
|
-
*
|
|
49483
|
-
* @deprecated
|
|
49484
|
-
*/
|
|
49485
|
-
SetSpeakerDevice(this: VoiceChatInternal, speakerDeviceName: string, speakerDeviceGuid: string): void;
|
|
49486
49585
|
/**
|
|
49487
49586
|
* - **ThreadSafety**: Unsafe
|
|
49488
49587
|
* - **Tags**:
|
|
@@ -49882,8 +49981,6 @@ interface TerrainIterateOperation extends RBXObject {
|
|
|
49882
49981
|
* - **ThreadSafety**: Unsafe
|
|
49883
49982
|
*
|
|
49884
49983
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainIterateOperation#CommitBlock)
|
|
49885
|
-
* @param this
|
|
49886
|
-
* @param block
|
|
49887
49984
|
*/
|
|
49888
49985
|
CommitBlock(this: TerrainIterateOperation, block: object): RBXScriptSignal;
|
|
49889
49986
|
/**
|
|
@@ -49911,8 +50008,6 @@ interface TerrainModifyOperation extends RBXObject {
|
|
|
49911
50008
|
* - **ThreadSafety**: Unsafe
|
|
49912
50009
|
*
|
|
49913
50010
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainModifyOperation#CommitBlock)
|
|
49914
|
-
* @param this
|
|
49915
|
-
* @param block
|
|
49916
50011
|
*/
|
|
49917
50012
|
CommitBlock(this: TerrainModifyOperation, block: object): RBXScriptSignal;
|
|
49918
50013
|
/**
|
|
@@ -49961,8 +50056,6 @@ interface TerrainWriteOperation extends RBXObject {
|
|
|
49961
50056
|
* - **ThreadSafety**: Unsafe
|
|
49962
50057
|
*
|
|
49963
50058
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainWriteOperation#CommitBlock)
|
|
49964
|
-
* @param this
|
|
49965
|
-
* @param block
|
|
49966
50059
|
*/
|
|
49967
50060
|
CommitBlock(this: TerrainWriteOperation, block: object): RBXScriptSignal;
|
|
49968
50061
|
/**
|
|
@@ -49970,7 +50063,6 @@ interface TerrainWriteOperation extends RBXObject {
|
|
|
49970
50063
|
* - **Tags**: CustomLuaState
|
|
49971
50064
|
*
|
|
49972
50065
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainWriteOperation#GetBlock)
|
|
49973
|
-
* @param this
|
|
49974
50066
|
*/
|
|
49975
50067
|
GetBlock(this: TerrainWriteOperation): object;
|
|
49976
50068
|
}
|
|
@@ -50023,7 +50115,7 @@ interface VideoSampler extends RBXObject {
|
|
|
50023
50115
|
GetSamplesAtTimesAsync(this: VideoSampler, times: Array<unknown>): Array<unknown>;
|
|
50024
50116
|
}
|
|
50025
50117
|
/**
|
|
50026
|
-
*
|
|
50118
|
+
* Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50027
50119
|
*
|
|
50028
50120
|
* - **Tags**: NotCreatable, NotReplicated
|
|
50029
50121
|
*
|
|
@@ -50044,7 +50136,7 @@ interface VirtualInput extends RBXObject {
|
|
|
50044
50136
|
* - **ThreadSafety**: Unsafe
|
|
50045
50137
|
*
|
|
50046
50138
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendKey)
|
|
50047
|
-
* @param this
|
|
50139
|
+
* @param this Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50048
50140
|
* @param isPressed Whether to simulate a key press (`true`) or a key release (`false`).
|
|
50049
50141
|
* @param keyCode The `KeyCode` of the key to inject.
|
|
50050
50142
|
* @param isRepeatedKey Whether this is an auto-repeat event, as occurs when a key is held down. Only valid for text-manipulation keys such as `KeyCode.Backspace`, `KeyCode.Delete`, and the arrow keys. Defaults to `false`.
|
|
@@ -50056,7 +50148,7 @@ interface VirtualInput extends RBXObject {
|
|
|
50056
50148
|
* - **ThreadSafety**: Unsafe
|
|
50057
50149
|
*
|
|
50058
50150
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMouseButton)
|
|
50059
|
-
* @param this
|
|
50151
|
+
* @param this Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50060
50152
|
* @param position The screen-space position in pixels at which to inject the event.
|
|
50061
50153
|
* @param button The mouse button to use. Supported values are `UserInputType.MouseButton1`, `UserInputType.MouseButton2`, and `UserInputType.MouseButton3`.
|
|
50062
50154
|
* @param isDown Whether to simulate a button press (`true`) or a button release (`false`).
|
|
@@ -50069,7 +50161,7 @@ interface VirtualInput extends RBXObject {
|
|
|
50069
50161
|
* - **ThreadSafety**: Unsafe
|
|
50070
50162
|
*
|
|
50071
50163
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMouseDelta)
|
|
50072
|
-
* @param this
|
|
50164
|
+
* @param this Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50073
50165
|
* @param positionDelta The relative mouse movement in pixels along each axis.
|
|
50074
50166
|
*/
|
|
50075
50167
|
SendMouseDelta(this: VirtualInput, positionDelta: Vector2): void;
|
|
@@ -50079,7 +50171,7 @@ interface VirtualInput extends RBXObject {
|
|
|
50079
50171
|
* - **ThreadSafety**: Unsafe
|
|
50080
50172
|
*
|
|
50081
50173
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMousePosition)
|
|
50082
|
-
* @param this
|
|
50174
|
+
* @param this Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50083
50175
|
* @param position The target screen-space position in pixels.
|
|
50084
50176
|
*/
|
|
50085
50177
|
SendMousePosition(this: VirtualInput, position: Vector2): void;
|
|
@@ -50089,7 +50181,7 @@ interface VirtualInput extends RBXObject {
|
|
|
50089
50181
|
* - **ThreadSafety**: Unsafe
|
|
50090
50182
|
*
|
|
50091
50183
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendPointerAction)
|
|
50092
|
-
* @param this
|
|
50184
|
+
* @param this Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50093
50185
|
* @param position The screen-space position in pixels at which to inject the event.
|
|
50094
50186
|
* @param pointerAction A dictionary describing the pointer action to inject. Accepted keys are `Wheel` (number), `Pan` (`Vector2`), and `Pinch` (number). At least one key must have a non-zero value.
|
|
50095
50187
|
*/
|
|
@@ -50100,7 +50192,7 @@ interface VirtualInput extends RBXObject {
|
|
|
50100
50192
|
* - **ThreadSafety**: Unsafe
|
|
50101
50193
|
*
|
|
50102
50194
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendTextInput)
|
|
50103
|
-
* @param this
|
|
50195
|
+
* @param this Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50104
50196
|
* @param text The string to inject as text input.
|
|
50105
50197
|
*/
|
|
50106
50198
|
SendTextInput(this: VirtualInput, text: string): void;
|