@rbxts/types 1.0.924 → 1.0.927
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 +584 -754
- package/include/generated/PluginSecurity.d.ts +1265 -381
- package/include/generated/enums.d.ts +423 -12
- package/package.json +1 -1
|
@@ -23,8 +23,6 @@ interface Services {
|
|
|
23
23
|
AssetQualityService: AssetQualityService;
|
|
24
24
|
AssetService: AssetService;
|
|
25
25
|
AudioFocusService: AudioFocusService;
|
|
26
|
-
AuroraScriptService: AuroraScriptService;
|
|
27
|
-
AuroraService: AuroraService;
|
|
28
26
|
AvatarChatService: AvatarChatService;
|
|
29
27
|
AvatarCreationService: AvatarCreationService;
|
|
30
28
|
AvatarEditorService: AvatarEditorService;
|
|
@@ -38,6 +36,7 @@ interface Services {
|
|
|
38
36
|
CaptureService: CaptureService;
|
|
39
37
|
ChangeHistoryStreamingService: ChangeHistoryStreamingService;
|
|
40
38
|
Chat: Chat;
|
|
39
|
+
ClientStorageService: ClientStorageService;
|
|
41
40
|
CloudCRUDService: CloudCRUDService;
|
|
42
41
|
CloudExecutionService: CloudExecutionService;
|
|
43
42
|
CollaboratorsService: CollaboratorsService;
|
|
@@ -61,6 +60,7 @@ interface Services {
|
|
|
61
60
|
DebuggerConnectionManager: DebuggerConnectionManager;
|
|
62
61
|
DebuggerUIService: DebuggerUIService;
|
|
63
62
|
DeferredAssetManagerService: DeferredAssetManagerService;
|
|
63
|
+
DesignFoundationsService: DesignFoundationsService;
|
|
64
64
|
DeviceIdService: DeviceIdService;
|
|
65
65
|
DraggerService: DraggerService;
|
|
66
66
|
EditableService: EditableService;
|
|
@@ -103,7 +103,6 @@ interface Services {
|
|
|
103
103
|
InstanceFileSyncService: InstanceFileSyncService;
|
|
104
104
|
InternalMessagingService: InternalMessagingService;
|
|
105
105
|
InternalMessagingServiceVerifier: InternalMessagingServiceVerifier;
|
|
106
|
-
InternalSyncService: InternalSyncService;
|
|
107
106
|
IXPService: IXPService;
|
|
108
107
|
JointsService: JointsService;
|
|
109
108
|
KeyframeSequenceProvider: KeyframeSequenceProvider;
|
|
@@ -117,7 +116,6 @@ interface Services {
|
|
|
117
116
|
LodDataService: LodDataService;
|
|
118
117
|
LogReporterService: LogReporterService;
|
|
119
118
|
LogService: LogService;
|
|
120
|
-
LSPFileSyncService: LSPFileSyncService;
|
|
121
119
|
LuauScriptAnalyzerService: LuauScriptAnalyzerService;
|
|
122
120
|
MarketplaceService: MarketplaceService;
|
|
123
121
|
MatchmakingService: MatchmakingService;
|
|
@@ -194,6 +192,7 @@ interface Services {
|
|
|
194
192
|
SharedTableRegistry: SharedTableRegistry;
|
|
195
193
|
SlimAnimationReplicationService: SlimAnimationReplicationService;
|
|
196
194
|
SlimContentProvider: SlimContentProvider;
|
|
195
|
+
SlimDebugSettings: SlimDebugSettings;
|
|
197
196
|
SlimReplicationService: SlimReplicationService;
|
|
198
197
|
SlimService: SlimService;
|
|
199
198
|
SmoothVoxelsUpgraderService: SmoothVoxelsUpgraderService;
|
|
@@ -307,7 +306,6 @@ interface CreatableInstances {
|
|
|
307
306
|
AudioSpeechToText: AudioSpeechToText;
|
|
308
307
|
AudioTextToSpeech: AudioTextToSpeech;
|
|
309
308
|
AudioTremolo: AudioTremolo;
|
|
310
|
-
AuroraScript: AuroraScript;
|
|
311
309
|
AvatarAbilityRules: AvatarAbilityRules;
|
|
312
310
|
AvatarAccessoryRules: AvatarAccessoryRules;
|
|
313
311
|
AvatarAnimationRules: AvatarAnimationRules;
|
|
@@ -414,7 +412,6 @@ interface CreatableInstances {
|
|
|
414
412
|
InputBinding: InputBinding;
|
|
415
413
|
InputContext: InputContext;
|
|
416
414
|
IntConstrainedValue: IntConstrainedValue;
|
|
417
|
-
InternalSyncItem: InternalSyncItem;
|
|
418
415
|
IntersectOperation: IntersectOperation;
|
|
419
416
|
IntValue: IntValue;
|
|
420
417
|
Keyframe: Keyframe;
|
|
@@ -520,6 +517,7 @@ interface CreatableInstances {
|
|
|
520
517
|
TextBox: TextBox;
|
|
521
518
|
TextButton: TextButton;
|
|
522
519
|
TextChannel: TextChannel;
|
|
520
|
+
TextChannelWindow: TextChannelWindow;
|
|
523
521
|
TextChatCommand: TextChatCommand;
|
|
524
522
|
TextChatMessageProperties: TextChatMessageProperties;
|
|
525
523
|
TextGenerator: TextGenerator;
|
|
@@ -762,6 +760,7 @@ interface Objects extends Instances {
|
|
|
762
760
|
OutputLink: OutputLink;
|
|
763
761
|
PluginConnection: PluginConnection;
|
|
764
762
|
ScreenshotCapture: ScreenshotCapture;
|
|
763
|
+
StudioActionOverride: StudioActionOverride;
|
|
765
764
|
TerrainIterateOperation: TerrainIterateOperation;
|
|
766
765
|
TerrainModifyOperation: TerrainModifyOperation;
|
|
767
766
|
TerrainReadOperation: TerrainReadOperation;
|
|
@@ -1013,7 +1012,7 @@ interface ConfigSnapshot extends RBXObject {
|
|
|
1013
1012
|
readonly UpdateAvailable: RBXScriptSignal<() => void>;
|
|
1014
1013
|
}
|
|
1015
1014
|
/**
|
|
1016
|
-
*
|
|
1015
|
+
* Object which allows for the runtime creation and manipulation of images.
|
|
1017
1016
|
*
|
|
1018
1017
|
* - **Tags**: NotCreatable
|
|
1019
1018
|
*
|
|
@@ -1041,7 +1040,7 @@ interface EditableImage extends RBXObject {
|
|
|
1041
1040
|
* - **ThreadSafety**: Unsafe
|
|
1042
1041
|
*
|
|
1043
1042
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#Destroy)
|
|
1044
|
-
* @param this
|
|
1043
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1045
1044
|
*/
|
|
1046
1045
|
Destroy(this: EditableImage): void;
|
|
1047
1046
|
/**
|
|
@@ -1050,7 +1049,7 @@ interface EditableImage extends RBXObject {
|
|
|
1050
1049
|
* - **ThreadSafety**: Unsafe
|
|
1051
1050
|
*
|
|
1052
1051
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawCircle)
|
|
1053
|
-
* @param this
|
|
1052
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1054
1053
|
* @param center Center of the circle, relative to the top-left corner of the `EditableImage`. Positions outside the canvas bounds are allowed.
|
|
1055
1054
|
* @param radius Radius of the circle in pixels.
|
|
1056
1055
|
* @param color Color of the circle.
|
|
@@ -1065,7 +1064,7 @@ interface EditableImage extends RBXObject {
|
|
|
1065
1064
|
* - **ThreadSafety**: Unsafe
|
|
1066
1065
|
*
|
|
1067
1066
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImage)
|
|
1068
|
-
* @param this
|
|
1067
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1069
1068
|
* @param position Position at which the top-left corner of the added image will be drawn.
|
|
1070
1069
|
* @param image The `EditableImage` to draw into this `EditableImage`.
|
|
1071
1070
|
* @param combineType How the pixels of the source image should be blended with the pixels of the added image.
|
|
@@ -1077,7 +1076,7 @@ interface EditableImage extends RBXObject {
|
|
|
1077
1076
|
* - **ThreadSafety**: Unsafe
|
|
1078
1077
|
*
|
|
1079
1078
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImageProjected)
|
|
1080
|
-
* @param this
|
|
1079
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1081
1080
|
* @param mesh The `EditableMesh` used to project into.
|
|
1082
1081
|
* @param projection Projection configuration dictionary including the following key-value pairs: - `Direction` (`Vector3`) where the projector is facing.
|
|
1083
1082
|
* - `Position` (`Vector3`) as the position in local space with respect to the mesh.
|
|
@@ -1098,7 +1097,7 @@ interface EditableImage extends RBXObject {
|
|
|
1098
1097
|
* - **ThreadSafety**: Unsafe
|
|
1099
1098
|
*
|
|
1100
1099
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImageTransformed)
|
|
1101
|
-
* @param this
|
|
1100
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1102
1101
|
* @param position Position in pixels where the pivot point of the source image will be placed on this image.
|
|
1103
1102
|
* @param scale Scaling factors for the source image along the X and Y axes.
|
|
1104
1103
|
* @param rotation The rotation angle in degrees, applied around the pivot point of the source image.
|
|
@@ -1114,7 +1113,7 @@ interface EditableImage extends RBXObject {
|
|
|
1114
1113
|
* - **ThreadSafety**: Unsafe
|
|
1115
1114
|
*
|
|
1116
1115
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawLine)
|
|
1117
|
-
* @param this
|
|
1116
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1118
1117
|
* @param p1 Start point of the line.
|
|
1119
1118
|
* @param p2 End point of the line.
|
|
1120
1119
|
* @param color Color of the line.
|
|
@@ -1129,7 +1128,7 @@ interface EditableImage extends RBXObject {
|
|
|
1129
1128
|
* - **ThreadSafety**: Unsafe
|
|
1130
1129
|
*
|
|
1131
1130
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawRectangle)
|
|
1132
|
-
* @param this
|
|
1131
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1133
1132
|
* @param position Position of the top-left of the rectangle. Unlike other drawing methods, this cannot be outside the canvas bounds of the `EditableImage`.
|
|
1134
1133
|
* @param size Size of the rectangle to draw, in pixels.
|
|
1135
1134
|
* @param color Color of the rectangle.
|
|
@@ -1144,7 +1143,7 @@ interface EditableImage extends RBXObject {
|
|
|
1144
1143
|
* - **Tags**: CustomLuaState
|
|
1145
1144
|
*
|
|
1146
1145
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#ReadPixelsBuffer)
|
|
1147
|
-
* @param this
|
|
1146
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1148
1147
|
* @param position Top-left corner of the rectangular region of pixels to read.
|
|
1149
1148
|
* @param size Size of the rectangular region of pixels to read.
|
|
1150
1149
|
* @returns Buffer where each pixel is represented by four bytes (red, green, blue and alpha respectively). The length of the buffer can be calculated as `X * Size.Y * 4` bytes.
|
|
@@ -1157,7 +1156,7 @@ interface EditableImage extends RBXObject {
|
|
|
1157
1156
|
* - **Tags**: CustomLuaState
|
|
1158
1157
|
*
|
|
1159
1158
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#WritePixelsBuffer)
|
|
1160
|
-
* @param this
|
|
1159
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1161
1160
|
* @param position Top-left corner of the rectangular region to draw the pixels into.
|
|
1162
1161
|
* @param size Size of the rectangular region of pixels to write.
|
|
1163
1162
|
* @param buffer A buffer where each pixel is represented by four bytes (red, green, blue, and alpha respectively). The length of the buffer should be `X * Size.Y * 4` bytes.
|
|
@@ -1165,7 +1164,7 @@ interface EditableImage extends RBXObject {
|
|
|
1165
1164
|
WritePixelsBuffer(this: EditableImage, position: Vector2, size: Vector2, buffer: buffer): void;
|
|
1166
1165
|
}
|
|
1167
1166
|
/**
|
|
1168
|
-
*
|
|
1167
|
+
* Object which allows for the runtime creation and manipulation of meshes.
|
|
1169
1168
|
*
|
|
1170
1169
|
* - **Tags**: NotCreatable
|
|
1171
1170
|
*
|
|
@@ -1189,24 +1188,13 @@ interface EditableMesh extends RBXObject {
|
|
|
1189
1188
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FixedSize)
|
|
1190
1189
|
*/
|
|
1191
1190
|
get FixedSize(): boolean;
|
|
1192
|
-
/**
|
|
1193
|
-
* **Deprecated:**
|
|
1194
|
-
*
|
|
1195
|
-
* - **ThreadSafety**: ReadSafe
|
|
1196
|
-
* - **Tags**:
|
|
1197
|
-
*
|
|
1198
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SkinningEnabled)
|
|
1199
|
-
*
|
|
1200
|
-
* @deprecated
|
|
1201
|
-
*/
|
|
1202
|
-
SkinningEnabled: boolean;
|
|
1203
1191
|
/**
|
|
1204
1192
|
* Adds a new bone and returns a stable bone ID.
|
|
1205
1193
|
*
|
|
1206
1194
|
* - **ThreadSafety**: Unsafe
|
|
1207
1195
|
*
|
|
1208
1196
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddBone)
|
|
1209
|
-
* @param this
|
|
1197
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1210
1198
|
* @param boneProperties Options table containing bone parameters: - `Name` — A string that specifies the bone name. Note that all bone names in a mesh must be unique.
|
|
1211
1199
|
* - `ParentId` — Optional bone ID of the new bone's parent.
|
|
1212
1200
|
* - `CFrame` — Initial `CFrame` of the bone in the bind pose of the mesh, in the mesh's local space.
|
|
@@ -1222,7 +1210,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1222
1210
|
* - **ThreadSafety**: Unsafe
|
|
1223
1211
|
*
|
|
1224
1212
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddColor)
|
|
1225
|
-
* @param this
|
|
1213
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1226
1214
|
* @param color The new color.
|
|
1227
1215
|
* @param alpha The color alpha (transparency).
|
|
1228
1216
|
* @returns Stable color ID of the new color.
|
|
@@ -1240,7 +1228,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1240
1228
|
* - **ThreadSafety**: Unsafe
|
|
1241
1229
|
*
|
|
1242
1230
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddNormal)
|
|
1243
|
-
* @param this
|
|
1231
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1244
1232
|
* @param normal The normal vector. If the normal value isn't specified, the normal will be automatically calculated.
|
|
1245
1233
|
* @returns Stable normal ID of the new normal.
|
|
1246
1234
|
*/
|
|
@@ -1251,7 +1239,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1251
1239
|
* - **ThreadSafety**: Unsafe
|
|
1252
1240
|
*
|
|
1253
1241
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddTriangle)
|
|
1254
|
-
* @param this
|
|
1242
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1255
1243
|
* @param vertexId0 ID of the first vertex of the triangle.
|
|
1256
1244
|
* @param vertexId1 ID of the second vertex of the triangle.
|
|
1257
1245
|
* @param vertexId2 ID of the third vertex of the triangle.
|
|
@@ -1264,7 +1252,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1264
1252
|
* - **ThreadSafety**: Unsafe
|
|
1265
1253
|
*
|
|
1266
1254
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddUV)
|
|
1267
|
-
* @param this
|
|
1255
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1268
1256
|
* @param uv The new UV coordinate.
|
|
1269
1257
|
* @returns Stable UV ID of the new UV.
|
|
1270
1258
|
*/
|
|
@@ -1275,18 +1263,25 @@ interface EditableMesh extends RBXObject {
|
|
|
1275
1263
|
* - **ThreadSafety**: Unsafe
|
|
1276
1264
|
*
|
|
1277
1265
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddVertex)
|
|
1278
|
-
* @param this
|
|
1266
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1279
1267
|
* @param p Position in the mesh's local object space.
|
|
1280
1268
|
* @returns Stable vertex ID of the new vertex.
|
|
1281
1269
|
*/
|
|
1282
1270
|
AddVertex(this: EditableMesh, p: Vector3): number;
|
|
1271
|
+
/**
|
|
1272
|
+
* - **ThreadSafety**: Unsafe
|
|
1273
|
+
* - **Tags**: NotBrowsable
|
|
1274
|
+
*
|
|
1275
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#Clear)
|
|
1276
|
+
*/
|
|
1277
|
+
Clear(this: EditableMesh): void;
|
|
1283
1278
|
/**
|
|
1284
1279
|
* Destroys the mesh.
|
|
1285
1280
|
*
|
|
1286
1281
|
* - **ThreadSafety**: Unsafe
|
|
1287
1282
|
*
|
|
1288
1283
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#Destroy)
|
|
1289
|
-
* @param this
|
|
1284
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1290
1285
|
*/
|
|
1291
1286
|
Destroy(this: EditableMesh): void;
|
|
1292
1287
|
/**
|
|
@@ -1295,7 +1290,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1295
1290
|
* - **ThreadSafety**: Unsafe
|
|
1296
1291
|
*
|
|
1297
1292
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindClosestPointOnSurface)
|
|
1298
|
-
* @param this
|
|
1293
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1299
1294
|
* @param point Point position in the mesh's local object space.
|
|
1300
1295
|
* @returns Tuple of the face ID, point on the mesh in local object space, and the barycentric coordinate of the position within the face.
|
|
1301
1296
|
*/
|
|
@@ -1310,7 +1305,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1310
1305
|
* - **ThreadSafety**: Unsafe
|
|
1311
1306
|
*
|
|
1312
1307
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindClosestVertex)
|
|
1313
|
-
* @param this
|
|
1308
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1314
1309
|
* @param toThisPoint Point position in the mesh's local object space.
|
|
1315
1310
|
* @returns Closest stable vertex ID to the specified point in space.
|
|
1316
1311
|
*/
|
|
@@ -1321,7 +1316,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1321
1316
|
* - **ThreadSafety**: Unsafe
|
|
1322
1317
|
*
|
|
1323
1318
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindVerticesWithinSphere)
|
|
1324
|
-
* @param this
|
|
1319
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1325
1320
|
* @param center Center of the sphere in the mesh's local object space.
|
|
1326
1321
|
* @param radius Radius of the sphere.
|
|
1327
1322
|
* @returns List of stable vertex IDs within the requested sphere.
|
|
@@ -1333,7 +1328,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1333
1328
|
* - **ThreadSafety**: Unsafe
|
|
1334
1329
|
*
|
|
1335
1330
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetAdjacentFaces)
|
|
1336
|
-
* @param this
|
|
1331
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1337
1332
|
* @param faceId
|
|
1338
1333
|
* @returns List of face IDs adjacent to the given face.
|
|
1339
1334
|
*/
|
|
@@ -1344,7 +1339,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1344
1339
|
* - **ThreadSafety**: Unsafe
|
|
1345
1340
|
*
|
|
1346
1341
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetAdjacentVertices)
|
|
1347
|
-
* @param this
|
|
1342
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1348
1343
|
* @param vertexId Vertex ID around which to get adjacent vertices.
|
|
1349
1344
|
* @returns List of IDs of adjacent vertices around the given vertex ID.
|
|
1350
1345
|
*/
|
|
@@ -1355,7 +1350,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1355
1350
|
* - **ThreadSafety**: Unsafe
|
|
1356
1351
|
*
|
|
1357
1352
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneByName)
|
|
1358
|
-
* @param this
|
|
1353
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1359
1354
|
* @param boneName Bone name to search for.
|
|
1360
1355
|
* @returns Bone ID of the bone with the given name.
|
|
1361
1356
|
*/
|
|
@@ -1366,7 +1361,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1366
1361
|
* - **ThreadSafety**: Unsafe
|
|
1367
1362
|
*
|
|
1368
1363
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneCFrame)
|
|
1369
|
-
* @param this
|
|
1364
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1370
1365
|
* @param boneId Bone ID for which to get the `CFrame`.
|
|
1371
1366
|
* @returns Initial `CFrame` of the bone in the bind pose of the mesh, in the mesh's local space.
|
|
1372
1367
|
*/
|
|
@@ -1377,7 +1372,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1377
1372
|
* - **ThreadSafety**: Unsafe
|
|
1378
1373
|
*
|
|
1379
1374
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneIsVirtual)
|
|
1380
|
-
* @param this
|
|
1375
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1381
1376
|
* @param boneId Bone ID for which to get whether the bone is virtual.
|
|
1382
1377
|
* @returns Whether the bone with the given bone ID is virtual. Virtual bones can only be bound to a `FaceControls` instance.
|
|
1383
1378
|
*/
|
|
@@ -1388,7 +1383,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1388
1383
|
* - **ThreadSafety**: Unsafe
|
|
1389
1384
|
*
|
|
1390
1385
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneName)
|
|
1391
|
-
* @param this
|
|
1386
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1392
1387
|
* @param boneId Bone ID for which to get the name.
|
|
1393
1388
|
* @returns Name of the bone with the given bone ID.
|
|
1394
1389
|
*/
|
|
@@ -1399,7 +1394,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1399
1394
|
* - **ThreadSafety**: Unsafe
|
|
1400
1395
|
*
|
|
1401
1396
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneParent)
|
|
1402
|
-
* @param this
|
|
1397
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1403
1398
|
* @param boneId Bone ID for which to get the parent.
|
|
1404
1399
|
* @returns Bone ID for the parent of the bone with the given bone ID. If there is no parent, returns `0`.
|
|
1405
1400
|
*/
|
|
@@ -1410,7 +1405,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1410
1405
|
* - **ThreadSafety**: Unsafe
|
|
1411
1406
|
*
|
|
1412
1407
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBones)
|
|
1413
|
-
* @param this
|
|
1408
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1414
1409
|
* @returns List of stable bone IDs.
|
|
1415
1410
|
*/
|
|
1416
1411
|
GetBones(this: EditableMesh): Array<unknown>;
|
|
@@ -1418,7 +1413,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1418
1413
|
* - **ThreadSafety**: Unsafe
|
|
1419
1414
|
*
|
|
1420
1415
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetCenter)
|
|
1421
|
-
* @param this
|
|
1416
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1422
1417
|
* @returns Center of the bounding box of the `EditableMesh`.
|
|
1423
1418
|
*/
|
|
1424
1419
|
GetCenter(this: EditableMesh): Vector3;
|
|
@@ -1428,7 +1423,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1428
1423
|
* - **ThreadSafety**: Unsafe
|
|
1429
1424
|
*
|
|
1430
1425
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetColor)
|
|
1431
|
-
* @param this
|
|
1426
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1432
1427
|
* @param colorId Color ID for which to get the color.
|
|
1433
1428
|
* @returns Color for the requested stable color ID.
|
|
1434
1429
|
*/
|
|
@@ -1439,7 +1434,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1439
1434
|
* - **ThreadSafety**: Unsafe
|
|
1440
1435
|
*
|
|
1441
1436
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetColorAlpha)
|
|
1442
|
-
* @param this
|
|
1437
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1443
1438
|
* @param colorId Color ID for which to get the alpha.
|
|
1444
1439
|
* @returns Color alpha at the request stable color ID.
|
|
1445
1440
|
*/
|
|
@@ -1451,7 +1446,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1451
1446
|
* - **Tags**: CustomLuaState
|
|
1452
1447
|
*
|
|
1453
1448
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetColors)
|
|
1454
|
-
* @param this
|
|
1449
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1455
1450
|
* @returns List of stable color IDs.
|
|
1456
1451
|
*/
|
|
1457
1452
|
GetColors(this: EditableMesh): Array<unknown>;
|
|
@@ -1462,7 +1457,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1462
1457
|
* - **Tags**: CustomLuaState
|
|
1463
1458
|
*
|
|
1464
1459
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceColors)
|
|
1465
|
-
* @param this
|
|
1460
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1466
1461
|
* @param faceId Face ID for which to get the color IDs.
|
|
1467
1462
|
* @returns List of color IDs used for the vertices on the given face.
|
|
1468
1463
|
*/
|
|
@@ -1474,7 +1469,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1474
1469
|
* - **Tags**: CustomLuaState
|
|
1475
1470
|
*
|
|
1476
1471
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceNormals)
|
|
1477
|
-
* @param this
|
|
1472
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1478
1473
|
* @param faceId Face ID for which to get the normal IDs.
|
|
1479
1474
|
* @returns List of normal IDs used for the vertices on the given face.
|
|
1480
1475
|
*/
|
|
@@ -1486,7 +1481,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1486
1481
|
* - **Tags**: CustomLuaState
|
|
1487
1482
|
*
|
|
1488
1483
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceUVs)
|
|
1489
|
-
* @param this
|
|
1484
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1490
1485
|
* @param faceId Face ID for which to get the UV IDs.
|
|
1491
1486
|
* @returns List of UV IDs used for the vertices on the given face.
|
|
1492
1487
|
*/
|
|
@@ -1498,7 +1493,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1498
1493
|
* - **Tags**: CustomLuaState
|
|
1499
1494
|
*
|
|
1500
1495
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceVertices)
|
|
1501
|
-
* @param this
|
|
1496
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1502
1497
|
* @param faceId
|
|
1503
1498
|
* @returns List of vertex IDs around the given face.
|
|
1504
1499
|
*/
|
|
@@ -1510,7 +1505,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1510
1505
|
* - **Tags**: CustomLuaState
|
|
1511
1506
|
*
|
|
1512
1507
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaces)
|
|
1513
|
-
* @param this
|
|
1508
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1514
1509
|
* @returns List of stable face IDs.
|
|
1515
1510
|
*/
|
|
1516
1511
|
GetFaces(this: EditableMesh): Array<unknown>;
|
|
@@ -1523,7 +1518,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1523
1518
|
* - **Tags**:
|
|
1524
1519
|
*
|
|
1525
1520
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithAttribute)
|
|
1526
|
-
* @param this
|
|
1521
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1527
1522
|
* @param id Attribute ID for which to find faces that use it.
|
|
1528
1523
|
* @returns List of face IDs which use the given attribute ID.
|
|
1529
1524
|
*
|
|
@@ -1537,7 +1532,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1537
1532
|
* - **Tags**: CustomLuaState
|
|
1538
1533
|
*
|
|
1539
1534
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithColor)
|
|
1540
|
-
* @param this
|
|
1535
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1541
1536
|
* @param colorId Color ID to find faces for.
|
|
1542
1537
|
* @returns List of face IDs that use the provided color ID.
|
|
1543
1538
|
*/
|
|
@@ -1549,7 +1544,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1549
1544
|
* - **Tags**: CustomLuaState
|
|
1550
1545
|
*
|
|
1551
1546
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithNormal)
|
|
1552
|
-
* @param this
|
|
1547
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1553
1548
|
* @param normalId Normal ID to find faces for.
|
|
1554
1549
|
* @returns List of face IDs that use the provided normal ID.
|
|
1555
1550
|
*/
|
|
@@ -1561,7 +1556,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1561
1556
|
* - **Tags**: CustomLuaState
|
|
1562
1557
|
*
|
|
1563
1558
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithUV)
|
|
1564
|
-
* @param this
|
|
1559
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1565
1560
|
* @param uvId UV ID to find faces for.
|
|
1566
1561
|
* @returns List of face IDs that use the provided UV ID.
|
|
1567
1562
|
*/
|
|
@@ -1572,7 +1567,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1572
1567
|
* - **ThreadSafety**: Unsafe
|
|
1573
1568
|
*
|
|
1574
1569
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsCorrectivePose)
|
|
1575
|
-
* @param this
|
|
1570
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1576
1571
|
* @param actions Array or 2 or 3 `FacsActionUnit` values that specify a corrective pose.
|
|
1577
1572
|
* @returns Array of bone IDs and corresponding array of bone `CFrames`.
|
|
1578
1573
|
*/
|
|
@@ -1583,7 +1578,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1583
1578
|
* - **ThreadSafety**: Unsafe
|
|
1584
1579
|
*
|
|
1585
1580
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsCorrectivePoses)
|
|
1586
|
-
* @param this
|
|
1581
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1587
1582
|
* @returns Array of corrective poses. Each corrective pose is specified by a small array of 2 or 3 `FacsActionUnit` values.
|
|
1588
1583
|
*/
|
|
1589
1584
|
GetFacsCorrectivePoses(this: EditableMesh): Array<unknown>;
|
|
@@ -1593,7 +1588,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1593
1588
|
* - **ThreadSafety**: Unsafe
|
|
1594
1589
|
*
|
|
1595
1590
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsPose)
|
|
1596
|
-
* @param this
|
|
1591
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1597
1592
|
* @param action FACS action unit for which to get the pose.
|
|
1598
1593
|
* @returns Array of bone IDs and corresponding array of bone `CFrame`.
|
|
1599
1594
|
*/
|
|
@@ -1604,7 +1599,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1604
1599
|
* - **ThreadSafety**: Unsafe
|
|
1605
1600
|
*
|
|
1606
1601
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsPoses)
|
|
1607
|
-
* @param this
|
|
1602
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1608
1603
|
* @returns Array of `FacsActionUnit`, one for each FACS action unit that has a pose defined.
|
|
1609
1604
|
*/
|
|
1610
1605
|
GetFacsPoses(this: EditableMesh): Array<unknown>;
|
|
@@ -1614,7 +1609,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1614
1609
|
* - **ThreadSafety**: Unsafe
|
|
1615
1610
|
*
|
|
1616
1611
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetNormal)
|
|
1617
|
-
* @param this
|
|
1612
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1618
1613
|
* @param normalId Normal ID for which to get the normal vector.
|
|
1619
1614
|
* @returns Normal vector at the requested normal ID.
|
|
1620
1615
|
*/
|
|
@@ -1626,7 +1621,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1626
1621
|
* - **Tags**: CustomLuaState
|
|
1627
1622
|
*
|
|
1628
1623
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetNormals)
|
|
1629
|
-
* @param this
|
|
1624
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1630
1625
|
* @returns List of stable normal IDs.
|
|
1631
1626
|
*/
|
|
1632
1627
|
GetNormals(this: EditableMesh): Array<unknown>;
|
|
@@ -1636,7 +1631,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1636
1631
|
* - **ThreadSafety**: Unsafe
|
|
1637
1632
|
*
|
|
1638
1633
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetPosition)
|
|
1639
|
-
* @param this
|
|
1634
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1640
1635
|
* @param vertexId Stable vertex ID for which to get the position.
|
|
1641
1636
|
* @returns Position of a vertex in the mesh's local object space.
|
|
1642
1637
|
*/
|
|
@@ -1645,7 +1640,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1645
1640
|
* - **ThreadSafety**: Unsafe
|
|
1646
1641
|
*
|
|
1647
1642
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetSize)
|
|
1648
|
-
* @param this
|
|
1643
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1649
1644
|
* @returns Size of the `EditableMesh`.
|
|
1650
1645
|
*/
|
|
1651
1646
|
GetSize(this: EditableMesh): Vector3;
|
|
@@ -1655,7 +1650,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1655
1650
|
* - **ThreadSafety**: Unsafe
|
|
1656
1651
|
*
|
|
1657
1652
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetUV)
|
|
1658
|
-
* @param this
|
|
1653
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1659
1654
|
* @param uvId UV ID for which to get the UV coordinate.
|
|
1660
1655
|
* @returns UV coordinates at the requested UV ID.
|
|
1661
1656
|
*/
|
|
@@ -1667,7 +1662,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1667
1662
|
* - **Tags**: CustomLuaState
|
|
1668
1663
|
*
|
|
1669
1664
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetUVs)
|
|
1670
|
-
* @param this
|
|
1665
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1671
1666
|
* @returns List of stable UV IDs.
|
|
1672
1667
|
*/
|
|
1673
1668
|
GetUVs(this: EditableMesh): Array<unknown>;
|
|
@@ -1677,7 +1672,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1677
1672
|
* - **ThreadSafety**: Unsafe
|
|
1678
1673
|
*
|
|
1679
1674
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexBoneWeights)
|
|
1680
|
-
* @param this
|
|
1675
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1681
1676
|
* @param vertexId Vertex ID for which to get the associated bone weights.
|
|
1682
1677
|
* @returns Skinning blend weights for each bone that is associated with the vertex.
|
|
1683
1678
|
*/
|
|
@@ -1688,7 +1683,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1688
1683
|
* - **ThreadSafety**: Unsafe
|
|
1689
1684
|
*
|
|
1690
1685
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexBones)
|
|
1691
|
-
* @param this
|
|
1686
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1692
1687
|
* @param vertexId Vertex ID for which to get the associated bones.
|
|
1693
1688
|
* @returns Bone IDs associated with the vertex for skinning.
|
|
1694
1689
|
*/
|
|
@@ -1700,7 +1695,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1700
1695
|
* - **Tags**: CustomLuaState
|
|
1701
1696
|
*
|
|
1702
1697
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexColors)
|
|
1703
|
-
* @param this
|
|
1698
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1704
1699
|
* @param vertexId Stable vertex ID to find color IDs.
|
|
1705
1700
|
* @returns Array of color IDs of faces attached to the given vertex.
|
|
1706
1701
|
*/
|
|
@@ -1711,7 +1706,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1711
1706
|
* - **ThreadSafety**: Unsafe
|
|
1712
1707
|
*
|
|
1713
1708
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceColor)
|
|
1714
|
-
* @param this
|
|
1709
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1715
1710
|
* @param vertexId Stable vertex ID.
|
|
1716
1711
|
* @param faceId Stable face ID.
|
|
1717
1712
|
* @returns Stable color ID of the vertex/face pair.
|
|
@@ -1723,7 +1718,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1723
1718
|
* - **ThreadSafety**: Unsafe
|
|
1724
1719
|
*
|
|
1725
1720
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceNormal)
|
|
1726
|
-
* @param this
|
|
1721
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1727
1722
|
* @param vertexId Stable vertex ID.
|
|
1728
1723
|
* @param faceId Stable face ID.
|
|
1729
1724
|
* @returns Stable normal ID of the vertex/face pair.
|
|
@@ -1735,7 +1730,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1735
1730
|
* - **ThreadSafety**: Unsafe
|
|
1736
1731
|
*
|
|
1737
1732
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceUV)
|
|
1738
|
-
* @param this
|
|
1733
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1739
1734
|
* @param vertexId Stable vertex ID.
|
|
1740
1735
|
* @param faceId Stable face ID.
|
|
1741
1736
|
* @returns Stable UV ID of the vertex/face pair.
|
|
@@ -1748,7 +1743,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1748
1743
|
* - **Tags**: CustomLuaState
|
|
1749
1744
|
*
|
|
1750
1745
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaces)
|
|
1751
|
-
* @param this
|
|
1746
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1752
1747
|
* @param vertexId Stable vertex ID to find faces for.
|
|
1753
1748
|
* @returns Array of face IDs attached to the given vertex.
|
|
1754
1749
|
*/
|
|
@@ -1760,7 +1755,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1760
1755
|
* - **Tags**: CustomLuaState
|
|
1761
1756
|
*
|
|
1762
1757
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexNormals)
|
|
1763
|
-
* @param this
|
|
1758
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1764
1759
|
* @param vertexId Stable vertex ID to find normal IDs.
|
|
1765
1760
|
* @returns Array of normal IDs of faces attached to the given vertex.
|
|
1766
1761
|
*/
|
|
@@ -1772,7 +1767,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1772
1767
|
* - **Tags**: CustomLuaState
|
|
1773
1768
|
*
|
|
1774
1769
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexUVs)
|
|
1775
|
-
* @param this
|
|
1770
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1776
1771
|
* @param vertexId Stable vertex ID to find UV IDs.
|
|
1777
1772
|
* @returns Array of UV IDs of faces attached to the given vertex.
|
|
1778
1773
|
*/
|
|
@@ -1783,7 +1778,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1783
1778
|
* - **ThreadSafety**: Unsafe
|
|
1784
1779
|
*
|
|
1785
1780
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertices)
|
|
1786
|
-
* @param this
|
|
1781
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1787
1782
|
* @returns List of stable vertex IDs.
|
|
1788
1783
|
*/
|
|
1789
1784
|
GetVertices(this: EditableMesh): Array<number>;
|
|
@@ -1796,7 +1791,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1796
1791
|
* - **Tags**:
|
|
1797
1792
|
*
|
|
1798
1793
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithAttribute)
|
|
1799
|
-
* @param this
|
|
1794
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1800
1795
|
* @param id Attribute ID for which to find vertices that use it.
|
|
1801
1796
|
* @returns List of vertex IDs which use the given attribute ID.
|
|
1802
1797
|
*
|
|
@@ -1810,7 +1805,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1810
1805
|
* - **Tags**: CustomLuaState
|
|
1811
1806
|
*
|
|
1812
1807
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithColor)
|
|
1813
|
-
* @param this
|
|
1808
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1814
1809
|
* @param colorId Color ID to find faces for.
|
|
1815
1810
|
* @returns List of face IDs that use the provided color ID.
|
|
1816
1811
|
*/
|
|
@@ -1822,7 +1817,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1822
1817
|
* - **Tags**: CustomLuaState
|
|
1823
1818
|
*
|
|
1824
1819
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithNormal)
|
|
1825
|
-
* @param this
|
|
1820
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1826
1821
|
* @param normalId Normal ID to find vertices for.
|
|
1827
1822
|
* @returns List of vertex IDs that use the provided normal ID.
|
|
1828
1823
|
*/
|
|
@@ -1834,7 +1829,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1834
1829
|
* - **Tags**: CustomLuaState
|
|
1835
1830
|
*
|
|
1836
1831
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithUV)
|
|
1837
|
-
* @param this
|
|
1832
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1838
1833
|
* @param uvId UV ID to find vertices for.
|
|
1839
1834
|
* @returns List of vertex IDs that use the provided UV ID.
|
|
1840
1835
|
*/
|
|
@@ -1845,7 +1840,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1845
1840
|
* - **ThreadSafety**: Unsafe
|
|
1846
1841
|
*
|
|
1847
1842
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#IdDebugString)
|
|
1848
|
-
* @param this
|
|
1843
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1849
1844
|
* @param id ID for which to return a debugging information string.
|
|
1850
1845
|
* @returns String that describes the ID in human-readable format.
|
|
1851
1846
|
*/
|
|
@@ -1856,7 +1851,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1856
1851
|
* - **ThreadSafety**: Unsafe
|
|
1857
1852
|
*
|
|
1858
1853
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#MergeVertices)
|
|
1859
|
-
* @param this
|
|
1854
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1860
1855
|
* @param mergeTolerance The distance at which the vertices are considered to touch each other.
|
|
1861
1856
|
* @returns A mapping of old vertex ID to new vertex ID for vertices that have been merged.
|
|
1862
1857
|
*/
|
|
@@ -1865,7 +1860,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1865
1860
|
* - **ThreadSafety**: Unsafe
|
|
1866
1861
|
*
|
|
1867
1862
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RaycastLocal)
|
|
1868
|
-
* @param this
|
|
1863
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1869
1864
|
* @param origin Origin of the ray in the mesh's local object space.
|
|
1870
1865
|
* @param direction Direction of the ray.
|
|
1871
1866
|
* @returns Tuple of the point of intersection, face ID, and barycentric coordinates.
|
|
@@ -1881,7 +1876,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1881
1876
|
* - **ThreadSafety**: Unsafe
|
|
1882
1877
|
*
|
|
1883
1878
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveBone)
|
|
1884
|
-
* @param this
|
|
1879
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1885
1880
|
* @param boneId
|
|
1886
1881
|
*/
|
|
1887
1882
|
RemoveBone(this: EditableMesh, boneId: number): void;
|
|
@@ -1891,7 +1886,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1891
1886
|
* - **ThreadSafety**: Unsafe
|
|
1892
1887
|
*
|
|
1893
1888
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveFace)
|
|
1894
|
-
* @param this
|
|
1889
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1895
1890
|
* @param faceId
|
|
1896
1891
|
*/
|
|
1897
1892
|
RemoveFace(this: EditableMesh, faceId: number): void;
|
|
@@ -1901,7 +1896,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1901
1896
|
* - **ThreadSafety**: Unsafe
|
|
1902
1897
|
*
|
|
1903
1898
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveUnused)
|
|
1904
|
-
* @param this
|
|
1899
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1905
1900
|
* @returns All of the removed stable IDs.
|
|
1906
1901
|
*/
|
|
1907
1902
|
RemoveUnused(this: EditableMesh): Array<unknown>;
|
|
@@ -1911,7 +1906,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1911
1906
|
* - **ThreadSafety**: Unsafe
|
|
1912
1907
|
*
|
|
1913
1908
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#ResetNormal)
|
|
1914
|
-
* @param this
|
|
1909
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1915
1910
|
* @param normalId Stable normal ID to reset.
|
|
1916
1911
|
*/
|
|
1917
1912
|
ResetNormal(this: EditableMesh, normalId: number): void;
|
|
@@ -1921,7 +1916,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1921
1916
|
* - **ThreadSafety**: Unsafe
|
|
1922
1917
|
*
|
|
1923
1918
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneCFrame)
|
|
1924
|
-
* @param this
|
|
1919
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1925
1920
|
* @param boneId Bone ID for which to set the initial `CFrame`.
|
|
1926
1921
|
* @param cframe Initial `CFrame` for the bone in the mesh's bind pose, in the mesh's local space.
|
|
1927
1922
|
*/
|
|
@@ -1932,7 +1927,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1932
1927
|
* - **ThreadSafety**: Unsafe
|
|
1933
1928
|
*
|
|
1934
1929
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneIsVirtual)
|
|
1935
|
-
* @param this
|
|
1930
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1936
1931
|
* @param boneId Bone ID for which to set whether the bone is virtual.
|
|
1937
1932
|
* @param virtual Whether the bone should be virtual.
|
|
1938
1933
|
*/
|
|
@@ -1943,7 +1938,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1943
1938
|
* - **ThreadSafety**: Unsafe
|
|
1944
1939
|
*
|
|
1945
1940
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneName)
|
|
1946
|
-
* @param this
|
|
1941
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1947
1942
|
* @param boneId Bone ID for which to set the name.
|
|
1948
1943
|
* @param name Bone name to set.
|
|
1949
1944
|
*/
|
|
@@ -1954,7 +1949,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1954
1949
|
* - **ThreadSafety**: Unsafe
|
|
1955
1950
|
*
|
|
1956
1951
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneParent)
|
|
1957
|
-
* @param this
|
|
1952
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1958
1953
|
* @param boneId Bone ID for which to set the parent.
|
|
1959
1954
|
* @param parentBoneId Parent bone ID.
|
|
1960
1955
|
*/
|
|
@@ -1965,7 +1960,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1965
1960
|
* - **ThreadSafety**: Unsafe
|
|
1966
1961
|
*
|
|
1967
1962
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetColor)
|
|
1968
|
-
* @param this
|
|
1963
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1969
1964
|
* @param colorId Stable color ID for which to set the color.
|
|
1970
1965
|
* @param color Color to set.
|
|
1971
1966
|
*/
|
|
@@ -1976,7 +1971,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1976
1971
|
* - **ThreadSafety**: Unsafe
|
|
1977
1972
|
*
|
|
1978
1973
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetColorAlpha)
|
|
1979
|
-
* @param this
|
|
1974
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1980
1975
|
* @param colorId Stable color ID for which to set the color alpha.
|
|
1981
1976
|
* @param alpha Alpha to set.
|
|
1982
1977
|
*/
|
|
@@ -1988,7 +1983,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1988
1983
|
* - **Tags**: CustomLuaState
|
|
1989
1984
|
*
|
|
1990
1985
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceColors)
|
|
1991
|
-
* @param this
|
|
1986
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1992
1987
|
* @param faceId Face ID for which to update the vertex colors.
|
|
1993
1988
|
* @param ids List of new stable color IDs to use for the given face's vertices.
|
|
1994
1989
|
*/
|
|
@@ -2000,7 +1995,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2000
1995
|
* - **Tags**: CustomLuaState
|
|
2001
1996
|
*
|
|
2002
1997
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceNormals)
|
|
2003
|
-
* @param this
|
|
1998
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2004
1999
|
* @param faceId Face ID for which to update the vertex normals.
|
|
2005
2000
|
* @param ids List of new stable normal IDs to use for the given face's vertices.
|
|
2006
2001
|
*/
|
|
@@ -2012,7 +2007,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2012
2007
|
* - **Tags**: CustomLuaState
|
|
2013
2008
|
*
|
|
2014
2009
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceUVs)
|
|
2015
|
-
* @param this
|
|
2010
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2016
2011
|
* @param faceId Face ID for which to update the vertex UVs.
|
|
2017
2012
|
* @param ids List of new stable UV IDs to use for the given face's vertices.
|
|
2018
2013
|
*/
|
|
@@ -2024,7 +2019,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2024
2019
|
* - **Tags**: CustomLuaState
|
|
2025
2020
|
*
|
|
2026
2021
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceVertices)
|
|
2027
|
-
* @param this
|
|
2022
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2028
2023
|
* @param faceId Face ID for which to update the vertices.
|
|
2029
2024
|
* @param ids List of new stable vertex IDs to use for the given face.
|
|
2030
2025
|
*/
|
|
@@ -2035,7 +2030,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2035
2030
|
* - **ThreadSafety**: Unsafe
|
|
2036
2031
|
*
|
|
2037
2032
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsBonePose)
|
|
2038
|
-
* @param this
|
|
2033
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2039
2034
|
* @param action FACS action unit for which to set the pose.
|
|
2040
2035
|
* @param boneId Bone to set a `CFrame` for this pose.
|
|
2041
2036
|
* @param cframe `CFrame` which transforms the bone from the initial bone `CFrame` in the bind pose of the mesh to the combined bone `CFrame` for this pose. All `CFrames` are in the mesh's local space.
|
|
@@ -2047,7 +2042,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2047
2042
|
* - **ThreadSafety**: Unsafe
|
|
2048
2043
|
*
|
|
2049
2044
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsCorrectivePose)
|
|
2050
|
-
* @param this
|
|
2045
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2051
2046
|
* @param actions Array or 2 or 3 `FacsActionUnit` values to apply as a corrective pose.
|
|
2052
2047
|
* @param boneIds Bones to set a `CFrame` for this pose.
|
|
2053
2048
|
* @param cframes `CFrame` transforms for the bones in this corrective pose. Each bone `CFrame` transforms the bone from the initial bone `CFrame` in the bind pose of the mesh to the combined bone `CFrame` for this pose. All `CFrames` are in the mesh's local space.
|
|
@@ -2059,7 +2054,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2059
2054
|
* - **ThreadSafety**: Unsafe
|
|
2060
2055
|
*
|
|
2061
2056
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsPose)
|
|
2062
|
-
* @param this
|
|
2057
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2063
2058
|
* @param action FACS action unit to set the pose for.
|
|
2064
2059
|
* @param boneIds Bones for which to set a `CFrame` for this pose.
|
|
2065
2060
|
* @param cframes `CFrame` transforms for the bones in this pose. Each bone `CFrame` transforms the bone from the initial bone `CFrame` in the bind pose of the mesh to the combined bone `CFrame` for this pose. All `CFrames` are in the mesh's local space.
|
|
@@ -2071,7 +2066,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2071
2066
|
* - **ThreadSafety**: Unsafe
|
|
2072
2067
|
*
|
|
2073
2068
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetNormal)
|
|
2074
|
-
* @param this
|
|
2069
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2075
2070
|
* @param normalId Stable normal ID for which to set the normal vector.
|
|
2076
2071
|
* @param normal Normal vector to set.
|
|
2077
2072
|
*/
|
|
@@ -2082,7 +2077,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2082
2077
|
* - **ThreadSafety**: Unsafe
|
|
2083
2078
|
*
|
|
2084
2079
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetPosition)
|
|
2085
|
-
* @param this
|
|
2080
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2086
2081
|
* @param vertexId Stable vertex ID of the vertex to position.
|
|
2087
2082
|
* @param p Position in the mesh's local object space.
|
|
2088
2083
|
*/
|
|
@@ -2093,7 +2088,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2093
2088
|
* - **ThreadSafety**: Unsafe
|
|
2094
2089
|
*
|
|
2095
2090
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetUV)
|
|
2096
|
-
* @param this
|
|
2091
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2097
2092
|
* @param uvId UV ID for which to set the UV coordinates.
|
|
2098
2093
|
* @param uv UV coordinates.
|
|
2099
2094
|
*/
|
|
@@ -2104,7 +2099,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2104
2099
|
* - **ThreadSafety**: Unsafe
|
|
2105
2100
|
*
|
|
2106
2101
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexBoneWeights)
|
|
2107
|
-
* @param this
|
|
2102
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2108
2103
|
* @param vertexId Vertex ID on which to set skinning blend weights.
|
|
2109
2104
|
* @param boneWeights Skinning blend weights to set on the vertex.
|
|
2110
2105
|
*/
|
|
@@ -2115,7 +2110,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2115
2110
|
* - **ThreadSafety**: Unsafe
|
|
2116
2111
|
*
|
|
2117
2112
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexBones)
|
|
2118
|
-
* @param this
|
|
2113
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2119
2114
|
* @param vertexId Vertex ID to set vertex skinning bones.
|
|
2120
2115
|
* @param boneIDs Bone IDs to use with this vertex for skinning.
|
|
2121
2116
|
*/
|
|
@@ -2126,7 +2121,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2126
2121
|
* - **ThreadSafety**: Unsafe
|
|
2127
2122
|
*
|
|
2128
2123
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceColor)
|
|
2129
|
-
* @param this
|
|
2124
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2130
2125
|
* @param vertexId Stable vertex ID.
|
|
2131
2126
|
* @param faceId Stable face ID.
|
|
2132
2127
|
* @param colorId Stable color ID to set for the vertex/face pair.
|
|
@@ -2138,7 +2133,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2138
2133
|
* - **ThreadSafety**: Unsafe
|
|
2139
2134
|
*
|
|
2140
2135
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceNormal)
|
|
2141
|
-
* @param this
|
|
2136
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2142
2137
|
* @param vertexId Stable vertex ID.
|
|
2143
2138
|
* @param faceId Stable face ID.
|
|
2144
2139
|
* @param normalId Stable normal ID to set for the vertex/face pair.
|
|
@@ -2150,7 +2145,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2150
2145
|
* - **ThreadSafety**: Unsafe
|
|
2151
2146
|
*
|
|
2152
2147
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceUV)
|
|
2153
|
-
* @param this
|
|
2148
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2154
2149
|
* @param vertexId Stable vertex ID.
|
|
2155
2150
|
* @param faceId Stable face ID.
|
|
2156
2151
|
* @param uvId Stable UV ID to set for the vertex/face pair.
|
|
@@ -2162,7 +2157,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2162
2157
|
* - **ThreadSafety**: Unsafe
|
|
2163
2158
|
*
|
|
2164
2159
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#Triangulate)
|
|
2165
|
-
* @param this
|
|
2160
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2166
2161
|
*/
|
|
2167
2162
|
Triangulate(this: EditableMesh): void;
|
|
2168
2163
|
}
|
|
@@ -3297,6 +3292,12 @@ interface Animation extends Instance {
|
|
|
3297
3292
|
* @deprecated
|
|
3298
3293
|
*/
|
|
3299
3294
|
readonly _nominal_Animation: unique symbol;
|
|
3295
|
+
/**
|
|
3296
|
+
* - **ThreadSafety**: ReadSafe
|
|
3297
|
+
*
|
|
3298
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animation#AnimationContent)
|
|
3299
|
+
*/
|
|
3300
|
+
AnimationContent: Content;
|
|
3300
3301
|
/**
|
|
3301
3302
|
* Asset ID of the animation an `Animation` object is referencing.
|
|
3302
3303
|
*
|
|
@@ -3484,9 +3485,9 @@ interface AnimationClipProvider extends Instance {
|
|
|
3484
3485
|
* @param userId The user ID of the user.
|
|
3485
3486
|
* @returns An `InventoryPages` of animations.
|
|
3486
3487
|
*
|
|
3487
|
-
* @deprecated
|
|
3488
|
+
* @deprecated
|
|
3488
3489
|
*/
|
|
3489
|
-
GetAnimations(this: AnimationClipProvider, userId:
|
|
3490
|
+
GetAnimations(this: AnimationClipProvider, userId: User): Instance | undefined;
|
|
3490
3491
|
/**
|
|
3491
3492
|
* This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
|
|
3492
3493
|
*
|
|
@@ -3498,7 +3499,7 @@ interface AnimationClipProvider extends Instance {
|
|
|
3498
3499
|
* @param userId The user ID of the user.
|
|
3499
3500
|
* @returns An `InventoryPages` of animations.
|
|
3500
3501
|
*/
|
|
3501
|
-
GetAnimationsAsync(this: AnimationClipProvider, userId:
|
|
3502
|
+
GetAnimationsAsync(this: AnimationClipProvider, userId: User): Instance | undefined;
|
|
3502
3503
|
/**
|
|
3503
3504
|
* - **ThreadSafety**: Unsafe
|
|
3504
3505
|
* - **Tags**: Yields
|
|
@@ -4395,7 +4396,7 @@ interface AssetService extends Instance {
|
|
|
4395
4396
|
* @param editableMeshOptions Options table containing controls for the method: - `FixedSize` – A `bool`. Default value is `true`, and the returned `EditableMesh` will not allow you to add or remove vertices, only modify their values. Set to `false` if the ability to change the mesh topology is required, at the expense of using more memory.
|
|
4396
4397
|
*
|
|
4397
4398
|
*
|
|
4398
|
-
* @returns The new `EditableMesh`
|
|
4399
|
+
* @returns The new `EditableMesh` object.
|
|
4399
4400
|
*/
|
|
4400
4401
|
CreateEditableMeshAsync(this: AssetService, content: Content, editableMeshOptions?: object): EditableMesh;
|
|
4401
4402
|
/**
|
|
@@ -4471,7 +4472,7 @@ interface AssetService extends Instance {
|
|
|
4471
4472
|
* @param packageAssetId
|
|
4472
4473
|
* @returns Asset IDs that are contained in a specified package.
|
|
4473
4474
|
*
|
|
4474
|
-
* @deprecated
|
|
4475
|
+
* @deprecated
|
|
4475
4476
|
*/
|
|
4476
4477
|
GetAssetIdsForPackage(this: AssetService, packageAssetId: number): Array<number>;
|
|
4477
4478
|
/**
|
|
@@ -4537,7 +4538,7 @@ interface AssetService extends Instance {
|
|
|
4537
4538
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4538
4539
|
* @param creationID
|
|
4539
4540
|
*
|
|
4540
|
-
* @deprecated
|
|
4541
|
+
* @deprecated
|
|
4541
4542
|
*/
|
|
4542
4543
|
GetCreatorAssetID(this: AssetService, creationID: number): number;
|
|
4543
4544
|
/**
|
|
@@ -4612,7 +4613,7 @@ interface AssetService extends Instance {
|
|
|
4612
4613
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4613
4614
|
* @param searchParameters
|
|
4614
4615
|
*
|
|
4615
|
-
* @deprecated
|
|
4616
|
+
* @deprecated
|
|
4616
4617
|
*/
|
|
4617
4618
|
SearchAudio(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
|
|
4618
4619
|
/**
|
|
@@ -4749,7 +4750,7 @@ interface Attachment extends Instance {
|
|
|
4749
4750
|
*
|
|
4750
4751
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#Rotation)
|
|
4751
4752
|
*
|
|
4752
|
-
* @deprecated
|
|
4753
|
+
* @deprecated
|
|
4753
4754
|
*/
|
|
4754
4755
|
Rotation: Vector3;
|
|
4755
4756
|
/**
|
|
@@ -4815,7 +4816,7 @@ interface Attachment extends Instance {
|
|
|
4815
4816
|
*
|
|
4816
4817
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#WorldRotation)
|
|
4817
4818
|
*
|
|
4818
|
-
* @deprecated
|
|
4819
|
+
* @deprecated
|
|
4819
4820
|
*/
|
|
4820
4821
|
readonly WorldRotation: Vector3;
|
|
4821
4822
|
/**
|
|
@@ -4838,7 +4839,7 @@ interface Attachment extends Instance {
|
|
|
4838
4839
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetAxis)
|
|
4839
4840
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4840
4841
|
*
|
|
4841
|
-
* @deprecated
|
|
4842
|
+
* @deprecated
|
|
4842
4843
|
*/
|
|
4843
4844
|
GetAxis(this: Attachment): Vector3;
|
|
4844
4845
|
/**
|
|
@@ -4861,7 +4862,7 @@ interface Attachment extends Instance {
|
|
|
4861
4862
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetSecondaryAxis)
|
|
4862
4863
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4863
4864
|
*
|
|
4864
|
-
* @deprecated
|
|
4865
|
+
* @deprecated
|
|
4865
4866
|
*/
|
|
4866
4867
|
GetSecondaryAxis(this: Attachment): Vector3;
|
|
4867
4868
|
/**
|
|
@@ -4876,7 +4877,7 @@ interface Attachment extends Instance {
|
|
|
4876
4877
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4877
4878
|
* @param axis
|
|
4878
4879
|
*
|
|
4879
|
-
* @deprecated
|
|
4880
|
+
* @deprecated
|
|
4880
4881
|
*/
|
|
4881
4882
|
SetAxis(this: Attachment, axis: Vector3): void;
|
|
4882
4883
|
/**
|
|
@@ -4891,7 +4892,7 @@ interface Attachment extends Instance {
|
|
|
4891
4892
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4892
4893
|
* @param axis
|
|
4893
4894
|
*
|
|
4894
|
-
* @deprecated
|
|
4895
|
+
* @deprecated
|
|
4895
4896
|
*/
|
|
4896
4897
|
SetSecondaryAxis(this: Attachment, axis: Vector3): void;
|
|
4897
4898
|
}
|
|
@@ -5735,7 +5736,7 @@ interface AudioEmitter extends Instance {
|
|
|
5735
5736
|
*
|
|
5736
5737
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#SimulationFidelity)
|
|
5737
5738
|
*
|
|
5738
|
-
* @deprecated
|
|
5739
|
+
* @deprecated
|
|
5739
5740
|
*/
|
|
5740
5741
|
SimulationFidelity: Enum.AudioSimulationFidelity;
|
|
5741
5742
|
/**
|
|
@@ -6414,7 +6415,7 @@ interface AudioListener extends Instance {
|
|
|
6414
6415
|
*
|
|
6415
6416
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#SimulationFidelity)
|
|
6416
6417
|
*
|
|
6417
|
-
* @deprecated
|
|
6418
|
+
* @deprecated
|
|
6418
6419
|
*/
|
|
6419
6420
|
SimulationFidelity: Enum.AudioSimulationFidelity;
|
|
6420
6421
|
/**
|
|
@@ -6629,7 +6630,7 @@ interface AudioPlayer extends Instance {
|
|
|
6629
6630
|
*
|
|
6630
6631
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AssetId)
|
|
6631
6632
|
*
|
|
6632
|
-
* @deprecated
|
|
6633
|
+
* @deprecated
|
|
6633
6634
|
*/
|
|
6634
6635
|
AssetId: string;
|
|
6635
6636
|
/**
|
|
@@ -7174,7 +7175,7 @@ interface AudioSearchParams extends Instance {
|
|
|
7174
7175
|
*
|
|
7175
7176
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#AudioSubtype)
|
|
7176
7177
|
*
|
|
7177
|
-
* @deprecated
|
|
7178
|
+
* @deprecated
|
|
7178
7179
|
*/
|
|
7179
7180
|
AudioSubtype: Enum.AudioSubType;
|
|
7180
7181
|
/**
|
|
@@ -7612,216 +7613,6 @@ interface AuroraScriptObject extends Instance {
|
|
|
7612
7613
|
*/
|
|
7613
7614
|
PriorFrameInvoked: number;
|
|
7614
7615
|
}
|
|
7615
|
-
/**
|
|
7616
|
-
* - **Tags**: NotCreatable, Service
|
|
7617
|
-
*
|
|
7618
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService)
|
|
7619
|
-
*
|
|
7620
|
-
* @deprecated
|
|
7621
|
-
*/
|
|
7622
|
-
interface AuroraScriptService extends Instance {
|
|
7623
|
-
/**
|
|
7624
|
-
* **DO NOT USE!**
|
|
7625
|
-
*
|
|
7626
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
7627
|
-
* @hidden
|
|
7628
|
-
* @deprecated
|
|
7629
|
-
*/
|
|
7630
|
-
readonly _nominal_AuroraScriptService: unique symbol;
|
|
7631
|
-
/**
|
|
7632
|
-
* - **ThreadSafety**: Unsafe
|
|
7633
|
-
*
|
|
7634
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#CreateCollection)
|
|
7635
|
-
*/
|
|
7636
|
-
CreateCollection(this: AuroraScriptService, query: string, root?: Instance): CollectionHandle;
|
|
7637
|
-
/**
|
|
7638
|
-
* - **ThreadSafety**: Safe
|
|
7639
|
-
* - **Tags**: CustomLuaState
|
|
7640
|
-
*
|
|
7641
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#FindBinding)
|
|
7642
|
-
*/
|
|
7643
|
-
FindBinding(this: AuroraScriptService, instance: Instance, scriptName: string): RBXObject;
|
|
7644
|
-
/**
|
|
7645
|
-
* - **ThreadSafety**: Safe
|
|
7646
|
-
* - **Tags**: CustomLuaState
|
|
7647
|
-
*
|
|
7648
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#FindBindings)
|
|
7649
|
-
*/
|
|
7650
|
-
FindBindings(this: AuroraScriptService, instance: Instance): object;
|
|
7651
|
-
/**
|
|
7652
|
-
* - **ThreadSafety**: Unsafe
|
|
7653
|
-
*
|
|
7654
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#GetAllCollections)
|
|
7655
|
-
*/
|
|
7656
|
-
GetAllCollections(this: AuroraScriptService): Array<unknown>;
|
|
7657
|
-
/**
|
|
7658
|
-
* - **ThreadSafety**: Safe
|
|
7659
|
-
*
|
|
7660
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#GetLocalFrameId)
|
|
7661
|
-
*/
|
|
7662
|
-
GetLocalFrameId(this: AuroraScriptService): number;
|
|
7663
|
-
/**
|
|
7664
|
-
* - **ThreadSafety**: Safe
|
|
7665
|
-
*
|
|
7666
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#SendMessage)
|
|
7667
|
-
*/
|
|
7668
|
-
SendMessage(this: AuroraScriptService, instance: Instance, behaviorName: string, functionName: string, args: unknown): void;
|
|
7669
|
-
/**
|
|
7670
|
-
* - **ThreadSafety**: Unsafe
|
|
7671
|
-
*
|
|
7672
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#getBehaviors)
|
|
7673
|
-
*/
|
|
7674
|
-
getBehaviors(this: AuroraScriptService): Array<Instance>;
|
|
7675
|
-
/**
|
|
7676
|
-
* - **ThreadSafety**: Unsafe
|
|
7677
|
-
*
|
|
7678
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#getBehaviorsForInstance)
|
|
7679
|
-
*/
|
|
7680
|
-
getBehaviorsForInstance(this: AuroraScriptService, instance: Instance): Array<Instance>;
|
|
7681
|
-
/**
|
|
7682
|
-
* - **ThreadSafety**: Unsafe
|
|
7683
|
-
*
|
|
7684
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#getInstancesForBehavior)
|
|
7685
|
-
*/
|
|
7686
|
-
getInstancesForBehavior(this: AuroraScriptService, behavior: AuroraScript): Array<Instance>;
|
|
7687
|
-
}
|
|
7688
|
-
/**
|
|
7689
|
-
* - **Tags**: NotCreatable, Service
|
|
7690
|
-
*
|
|
7691
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService)
|
|
7692
|
-
*
|
|
7693
|
-
* @deprecated
|
|
7694
|
-
*/
|
|
7695
|
-
interface AuroraService extends Instance {
|
|
7696
|
-
/**
|
|
7697
|
-
* **DO NOT USE!**
|
|
7698
|
-
*
|
|
7699
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
7700
|
-
* @hidden
|
|
7701
|
-
* @deprecated
|
|
7702
|
-
*/
|
|
7703
|
-
readonly _nominal_AuroraService: unique symbol;
|
|
7704
|
-
/**
|
|
7705
|
-
* - **ThreadSafety**: ReadSafe
|
|
7706
|
-
*
|
|
7707
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#HashRoundingPoint)
|
|
7708
|
-
*/
|
|
7709
|
-
HashRoundingPoint: number;
|
|
7710
|
-
/**
|
|
7711
|
-
* - **ThreadSafety**: ReadSafe
|
|
7712
|
-
*
|
|
7713
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IgnoreRotation)
|
|
7714
|
-
*/
|
|
7715
|
-
IgnoreRotation: boolean;
|
|
7716
|
-
/**
|
|
7717
|
-
* - **ThreadSafety**: ReadSafe
|
|
7718
|
-
*
|
|
7719
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#LockStepIdOffset)
|
|
7720
|
-
*/
|
|
7721
|
-
LockStepIdOffset: boolean;
|
|
7722
|
-
/**
|
|
7723
|
-
* - **ThreadSafety**: ReadSafe
|
|
7724
|
-
*
|
|
7725
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#RollbackOffset)
|
|
7726
|
-
*/
|
|
7727
|
-
RollbackOffset: number;
|
|
7728
|
-
/**
|
|
7729
|
-
* - **ThreadSafety**: Unsafe
|
|
7730
|
-
*
|
|
7731
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetPredictedInstances)
|
|
7732
|
-
*/
|
|
7733
|
-
GetPredictedInstances(this: AuroraService): Array<unknown>;
|
|
7734
|
-
/**
|
|
7735
|
-
* - **ThreadSafety**: Unsafe
|
|
7736
|
-
*
|
|
7737
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetRemoteWorldStepId)
|
|
7738
|
-
*/
|
|
7739
|
-
GetRemoteWorldStepId(this: AuroraService): number;
|
|
7740
|
-
/**
|
|
7741
|
-
* - **ThreadSafety**: Unsafe
|
|
7742
|
-
*
|
|
7743
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetServerView)
|
|
7744
|
-
*/
|
|
7745
|
-
GetServerView(this: AuroraService, target: Instance): Instance | undefined;
|
|
7746
|
-
/**
|
|
7747
|
-
* - **ThreadSafety**: Unsafe
|
|
7748
|
-
*
|
|
7749
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetWorldStepId)
|
|
7750
|
-
*/
|
|
7751
|
-
GetWorldStepId(this: AuroraService): number;
|
|
7752
|
-
/**
|
|
7753
|
-
* - **ThreadSafety**: Unsafe
|
|
7754
|
-
*
|
|
7755
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsInstancePredicted)
|
|
7756
|
-
*/
|
|
7757
|
-
IsInstancePredicted(this: AuroraService, target: Instance): boolean;
|
|
7758
|
-
/**
|
|
7759
|
-
* - **ThreadSafety**: Unsafe
|
|
7760
|
-
*
|
|
7761
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#PlayInputRecording)
|
|
7762
|
-
*/
|
|
7763
|
-
PlayInputRecording(this: AuroraService): void;
|
|
7764
|
-
/**
|
|
7765
|
-
* - **ThreadSafety**: Unsafe
|
|
7766
|
-
*
|
|
7767
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#SetReplicationLag)
|
|
7768
|
-
*/
|
|
7769
|
-
SetReplicationLag(this: AuroraService, seconds: number): void;
|
|
7770
|
-
/**
|
|
7771
|
-
* - **ThreadSafety**: Unsafe
|
|
7772
|
-
*
|
|
7773
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#ShowDebugVisualizer)
|
|
7774
|
-
*/
|
|
7775
|
-
ShowDebugVisualizer(this: AuroraService, state: boolean): void;
|
|
7776
|
-
/**
|
|
7777
|
-
* - **ThreadSafety**: Unsafe
|
|
7778
|
-
*
|
|
7779
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StartInputRecording)
|
|
7780
|
-
*/
|
|
7781
|
-
StartInputRecording(this: AuroraService): void;
|
|
7782
|
-
/**
|
|
7783
|
-
* - **ThreadSafety**: Unsafe
|
|
7784
|
-
*
|
|
7785
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StartPrediction)
|
|
7786
|
-
*/
|
|
7787
|
-
StartPrediction(this: AuroraService, target: Instance): void;
|
|
7788
|
-
/**
|
|
7789
|
-
* - **ThreadSafety**: Unsafe
|
|
7790
|
-
*
|
|
7791
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StepPhysics)
|
|
7792
|
-
*/
|
|
7793
|
-
StepPhysics(this: AuroraService, worldSteps: number, parts?: Array<Instance>): void;
|
|
7794
|
-
/**
|
|
7795
|
-
* - **ThreadSafety**: Unsafe
|
|
7796
|
-
*
|
|
7797
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StopInputRecording)
|
|
7798
|
-
*/
|
|
7799
|
-
StopInputRecording(this: AuroraService): void;
|
|
7800
|
-
/**
|
|
7801
|
-
* - **ThreadSafety**: Unsafe
|
|
7802
|
-
*
|
|
7803
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StopPrediction)
|
|
7804
|
-
*/
|
|
7805
|
-
StopPrediction(this: AuroraService, target: Instance): void;
|
|
7806
|
-
/**
|
|
7807
|
-
* - **ThreadSafety**: Unsafe
|
|
7808
|
-
*
|
|
7809
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#UpdateProperties)
|
|
7810
|
-
*/
|
|
7811
|
-
UpdateProperties(this: AuroraService, target: Instance): void;
|
|
7812
|
-
/**
|
|
7813
|
-
* - **ThreadSafety**: Unsafe
|
|
7814
|
-
*
|
|
7815
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#FixedRateTick)
|
|
7816
|
-
*/
|
|
7817
|
-
readonly FixedRateTick: RBXScriptSignal<(deltaTime: number, worldStepId: number) => void>;
|
|
7818
|
-
/**
|
|
7819
|
-
* - **ThreadSafety**: Unsafe
|
|
7820
|
-
*
|
|
7821
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Step)
|
|
7822
|
-
*/
|
|
7823
|
-
readonly Step: RBXScriptSignal<() => void>;
|
|
7824
|
-
}
|
|
7825
7616
|
/**
|
|
7826
7617
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarAbilityRules)
|
|
7827
7618
|
*/
|
|
@@ -8187,8 +7978,10 @@ interface AvatarEditorService extends Instance {
|
|
|
8187
7978
|
* @param this A service to support developer Avatar Editors.
|
|
8188
7979
|
* @param outfit The `Outfit` that the player will be prompted to created.
|
|
8189
7980
|
* @param rigType The `RigType` that the outfit will be created for if the player confirms the prompt.
|
|
7981
|
+
* @param outfitOptions Reserved for future options. Must be empty or omitted.
|
|
7982
|
+
* @param outfitType Optional `OutfitType`. Only `Avatar` and `Makeup` values are accepted. When omitted, the type is inferred from the description.
|
|
8190
7983
|
*/
|
|
8191
|
-
PromptCreateOutfit(this: AvatarEditorService, outfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType
|
|
7984
|
+
PromptCreateOutfit(this: AvatarEditorService, outfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, outfitOptions: object, outfitType: unknown): void;
|
|
8192
7985
|
/**
|
|
8193
7986
|
* Prompts the `Players.LocalPlayer` to delete the given outfit.
|
|
8194
7987
|
*
|
|
@@ -8257,7 +8050,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8257
8050
|
* @param humanoidDescription The HumanoidDescription to check if default clothing is required.
|
|
8258
8051
|
* @returns Returns a HumanoidDescription if default clothing was necessary. Otherwise returns `nil`.
|
|
8259
8052
|
*
|
|
8260
|
-
* @deprecated
|
|
8053
|
+
* @deprecated
|
|
8261
8054
|
*/
|
|
8262
8055
|
CheckApplyDefaultClothing(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription | undefined;
|
|
8263
8056
|
/**
|
|
@@ -8282,7 +8075,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8282
8075
|
* @param this A service to support developer Avatar Editors.
|
|
8283
8076
|
* @param humanoidDescription
|
|
8284
8077
|
*
|
|
8285
|
-
* @deprecated
|
|
8078
|
+
* @deprecated
|
|
8286
8079
|
*/
|
|
8287
8080
|
ConformToAvatarRules(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
|
|
8288
8081
|
/**
|
|
@@ -8309,7 +8102,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8309
8102
|
* @param this A service to support developer Avatar Editors.
|
|
8310
8103
|
* @returns A dictionary containing the platform Avatar rules for things like scaling, default shirts and pants, number of wearable assets, ect. See the example return in the main description above.
|
|
8311
8104
|
*
|
|
8312
|
-
* @deprecated
|
|
8105
|
+
* @deprecated
|
|
8313
8106
|
*/
|
|
8314
8107
|
GetAvatarRules(this: AvatarEditorService): AvatarRules;
|
|
8315
8108
|
/**
|
|
@@ -8337,7 +8130,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8337
8130
|
* @param itemType The type of the item ids provided.
|
|
8338
8131
|
* @returns Returns an array of item details. See `AvatarEditorService:GetBatchItemDetailsAsync()` for the response format.
|
|
8339
8132
|
*
|
|
8340
|
-
* @deprecated
|
|
8133
|
+
* @deprecated
|
|
8341
8134
|
*/
|
|
8342
8135
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Asset>): ReadonlyArray<AssetItemDetails>;
|
|
8343
8136
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): ReadonlyArray<BundleItemDetails>;
|
|
@@ -8376,7 +8169,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8376
8169
|
* @param itemType The `AvatarItemType` of the specified asset or bundle.
|
|
8377
8170
|
* @returns Whether the `LocalPlayer` has favorited the given bundle or asset.
|
|
8378
8171
|
*
|
|
8379
|
-
* @deprecated
|
|
8172
|
+
* @deprecated
|
|
8380
8173
|
*/
|
|
8381
8174
|
GetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
|
|
8382
8175
|
/**
|
|
@@ -8415,7 +8208,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8415
8208
|
* @param this A service to support developer Avatar Editors.
|
|
8416
8209
|
* @param assetTypes The `AvatarAssetType` that can will be checked for in the player's inventory.
|
|
8417
8210
|
*
|
|
8418
|
-
* @deprecated
|
|
8211
|
+
* @deprecated
|
|
8419
8212
|
*/
|
|
8420
8213
|
GetInventory(this: AvatarEditorService, assetTypes: ReadonlyArray<Enum.AvatarAssetType>): InventoryPages<{
|
|
8421
8214
|
AssetId: number;
|
|
@@ -8448,7 +8241,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8448
8241
|
* @param itemType An enum value indicating the type of item whose details are being retrieved.
|
|
8449
8242
|
* @returns A table containing the item info for the retrieved item. See above for a sample table.
|
|
8450
8243
|
*
|
|
8451
|
-
* @deprecated
|
|
8244
|
+
* @deprecated
|
|
8452
8245
|
*/
|
|
8453
8246
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Asset>): AssetItemDetails;
|
|
8454
8247
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): BundleItemDetails;
|
|
@@ -8479,7 +8272,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8479
8272
|
* @param outfitId The ID of the outfit whose details are being retrieved.
|
|
8480
8273
|
* @returns A table containing the outfit info for the retrieved outfit. See above for a sample table.
|
|
8481
8274
|
*
|
|
8482
|
-
* @deprecated
|
|
8275
|
+
* @deprecated
|
|
8483
8276
|
*/
|
|
8484
8277
|
GetOutfitDetails(this: AvatarEditorService, outfitId: number): object;
|
|
8485
8278
|
/**
|
|
@@ -8507,7 +8300,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8507
8300
|
* @param outfitSource
|
|
8508
8301
|
* @param outfitType
|
|
8509
8302
|
*
|
|
8510
|
-
* @deprecated
|
|
8303
|
+
* @deprecated
|
|
8511
8304
|
*/
|
|
8512
8305
|
GetOutfits(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
|
|
8513
8306
|
/**
|
|
@@ -8536,7 +8329,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8536
8329
|
* @param contextAssetId The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.
|
|
8537
8330
|
* @returns A list of recommendations based on the given `AssetType`.
|
|
8538
8331
|
*
|
|
8539
|
-
* @deprecated
|
|
8332
|
+
* @deprecated
|
|
8540
8333
|
*/
|
|
8541
8334
|
GetRecommendedAssets(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): ReadonlyArray<RecommendedAsset>;
|
|
8542
8335
|
/**
|
|
@@ -8565,7 +8358,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8565
8358
|
* @param bundleId A list of recommended bundles.
|
|
8566
8359
|
* @returns The bundle ID that the recommended bundles will be returned for.
|
|
8567
8360
|
*
|
|
8568
|
-
* @deprecated
|
|
8361
|
+
* @deprecated
|
|
8569
8362
|
*/
|
|
8570
8363
|
GetRecommendedBundles(this: AvatarEditorService, bundleId: number): ReadonlyArray<RecommendedBundle>;
|
|
8571
8364
|
/**
|
|
@@ -8592,7 +8385,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8592
8385
|
* @param this A service to support developer Avatar Editors.
|
|
8593
8386
|
* @param searchParameters An object containing the parameters used for the search.
|
|
8594
8387
|
*
|
|
8595
|
-
* @deprecated
|
|
8388
|
+
* @deprecated
|
|
8596
8389
|
*/
|
|
8597
8390
|
SearchCatalog(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
|
|
8598
8391
|
/**
|
|
@@ -8752,7 +8545,7 @@ interface BadgeService extends Instance {
|
|
|
8752
8545
|
* @param badgeId The ID of the badge to be awarded.
|
|
8753
8546
|
* @returns Boolean of `true` if the badge was awarded successfully.
|
|
8754
8547
|
*
|
|
8755
|
-
* @deprecated
|
|
8548
|
+
* @deprecated
|
|
8756
8549
|
*/
|
|
8757
8550
|
AwardBadge(this: BadgeService, userId: number, badgeId: number): boolean;
|
|
8758
8551
|
/**
|
|
@@ -8767,7 +8560,7 @@ interface BadgeService extends Instance {
|
|
|
8767
8560
|
* @param badgeId The ID of the badge to be awarded.
|
|
8768
8561
|
* @returns Boolean of `true` if the badge was awarded successfully.
|
|
8769
8562
|
*/
|
|
8770
|
-
AwardBadgeAsync(this: BadgeService, userId:
|
|
8563
|
+
AwardBadgeAsync(this: BadgeService, userId: User, badgeId: number): boolean;
|
|
8771
8564
|
/**
|
|
8772
8565
|
* Checks a list of badge IDs against a `UserId` and returns a list of badge IDs that the player owns.
|
|
8773
8566
|
*
|
|
@@ -8780,7 +8573,7 @@ interface BadgeService extends Instance {
|
|
|
8780
8573
|
* @param badgeIds The list of IDs of the badges to check ownership of. Maximum length of 10.
|
|
8781
8574
|
* @returns The list of badge IDs the given user owns out of the provided badge IDs. Empty if none of the provided badges are owned by the given user. Not guaranteed to be in the same order as the input list. Some badge IDs may be omitted if the user with the target `userId` has not recently been in the server and the badge IDs are not associated with the requesting experience.
|
|
8782
8575
|
*/
|
|
8783
|
-
CheckUserBadgesAsync(this: BadgeService, userId:
|
|
8576
|
+
CheckUserBadgesAsync(this: BadgeService, userId: User, badgeIds: Array<unknown>): Array<unknown>;
|
|
8784
8577
|
/**
|
|
8785
8578
|
* Fetch information about a badge given its ID.
|
|
8786
8579
|
*
|
|
@@ -8826,7 +8619,7 @@ interface BadgeService extends Instance {
|
|
|
8826
8619
|
*/
|
|
8827
8620
|
IsLegal(this: BadgeService, badgeId: number): boolean;
|
|
8828
8621
|
/**
|
|
8829
|
-
* **Deprecated:** This method has been superseded by `BadgeService:UserHasBadgeAsync()` which should be used for new instead.
|
|
8622
|
+
* **Deprecated:** This method has been superseded by `BadgeService:UserHasBadgeAsync()` which should be used for new work instead.
|
|
8830
8623
|
*
|
|
8831
8624
|
* Checks whether a user has the badge given the `Player.UserId` and the badge ID.
|
|
8832
8625
|
*
|
|
@@ -8841,7 +8634,7 @@ interface BadgeService extends Instance {
|
|
|
8841
8634
|
*
|
|
8842
8635
|
* @deprecated
|
|
8843
8636
|
*/
|
|
8844
|
-
UserHasBadge(this: BadgeService, userId:
|
|
8637
|
+
UserHasBadge(this: BadgeService, userId: User, badgeId: number): boolean;
|
|
8845
8638
|
/**
|
|
8846
8639
|
* Checks whether a player has the badge given the `Player.UserId` and the badge ID.
|
|
8847
8640
|
*
|
|
@@ -9440,7 +9233,7 @@ interface RootImportData extends BaseImportData {
|
|
|
9440
9233
|
WorldUp: Enum.NormalId;
|
|
9441
9234
|
}
|
|
9442
9235
|
/**
|
|
9443
|
-
*
|
|
9236
|
+
* `BasePlayerGui` is an abstract class which the GUI drawing storage classes inherit from.
|
|
9444
9237
|
*
|
|
9445
9238
|
* - **Tags**: NotCreatable
|
|
9446
9239
|
*
|
|
@@ -9461,9 +9254,9 @@ interface BasePlayerGui extends Instance {
|
|
|
9461
9254
|
* - **ThreadSafety**: Unsafe
|
|
9462
9255
|
*
|
|
9463
9256
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePlayerGui#GetGuiObjectsAtPosition)
|
|
9464
|
-
* @param this
|
|
9465
|
-
* @param x The
|
|
9466
|
-
* @param y The
|
|
9257
|
+
* @param this `BasePlayerGui` is an abstract class which the GUI drawing storage classes inherit from.
|
|
9258
|
+
* @param x The **X** position on the screen relative to the top-left corner after the GUI inset is applied (see `GuiService:GetGuiInset()`).
|
|
9259
|
+
* @param y The **Y** position on the screen relative to the top-left corner after the GUI inset is applied (see `GuiService:GetGuiInset()`).
|
|
9467
9260
|
* @returns A table of the `GuiObject` instances that occupy the given screen space.
|
|
9468
9261
|
*/
|
|
9469
9262
|
GetGuiObjectsAtPosition(this: BasePlayerGui, x: number, y: number): Array<GuiObject>;
|
|
@@ -10123,6 +9916,12 @@ interface Beam extends Instance {
|
|
|
10123
9916
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Beam#Texture)
|
|
10124
9917
|
*/
|
|
10125
9918
|
Texture: ContentId;
|
|
9919
|
+
/**
|
|
9920
|
+
* - **ThreadSafety**: ReadSafe
|
|
9921
|
+
*
|
|
9922
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Beam#TextureContent)
|
|
9923
|
+
*/
|
|
9924
|
+
TextureContent: Content;
|
|
10126
9925
|
/**
|
|
10127
9926
|
* Sets the length of the beam's texture, dependent on `TextureMode`.
|
|
10128
9927
|
*
|
|
@@ -10290,7 +10089,7 @@ interface BodyMover extends Instance {
|
|
|
10290
10089
|
*
|
|
10291
10090
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyAngularVelocity)
|
|
10292
10091
|
*
|
|
10293
|
-
* @deprecated
|
|
10092
|
+
* @deprecated
|
|
10294
10093
|
*/
|
|
10295
10094
|
interface BodyAngularVelocity extends BodyMover {
|
|
10296
10095
|
/**
|
|
@@ -10335,7 +10134,7 @@ interface BodyAngularVelocity extends BodyMover {
|
|
|
10335
10134
|
*
|
|
10336
10135
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyForce)
|
|
10337
10136
|
*
|
|
10338
|
-
* @deprecated
|
|
10137
|
+
* @deprecated
|
|
10339
10138
|
*/
|
|
10340
10139
|
interface BodyForce extends BodyMover {
|
|
10341
10140
|
/**
|
|
@@ -10364,7 +10163,7 @@ interface BodyForce extends BodyMover {
|
|
|
10364
10163
|
*
|
|
10365
10164
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyGyro)
|
|
10366
10165
|
*
|
|
10367
|
-
* @deprecated
|
|
10166
|
+
* @deprecated
|
|
10368
10167
|
*/
|
|
10369
10168
|
interface BodyGyro extends BodyMover {
|
|
10370
10169
|
/**
|
|
@@ -10417,7 +10216,7 @@ interface BodyGyro extends BodyMover {
|
|
|
10417
10216
|
*
|
|
10418
10217
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyPosition)
|
|
10419
10218
|
*
|
|
10420
|
-
* @deprecated
|
|
10219
|
+
* @deprecated
|
|
10421
10220
|
*/
|
|
10422
10221
|
interface BodyPosition extends BodyMover {
|
|
10423
10222
|
/**
|
|
@@ -10489,7 +10288,7 @@ interface BodyPosition extends BodyMover {
|
|
|
10489
10288
|
*
|
|
10490
10289
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyThrust)
|
|
10491
10290
|
*
|
|
10492
|
-
* @deprecated
|
|
10291
|
+
* @deprecated
|
|
10493
10292
|
*/
|
|
10494
10293
|
interface BodyThrust extends BodyMover {
|
|
10495
10294
|
/**
|
|
@@ -10526,7 +10325,7 @@ interface BodyThrust extends BodyMover {
|
|
|
10526
10325
|
*
|
|
10527
10326
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyVelocity)
|
|
10528
10327
|
*
|
|
10529
|
-
* @deprecated
|
|
10328
|
+
* @deprecated
|
|
10530
10329
|
*/
|
|
10531
10330
|
interface BodyVelocity extends BodyMover {
|
|
10532
10331
|
/**
|
|
@@ -10593,7 +10392,7 @@ interface BodyVelocity extends BodyMover {
|
|
|
10593
10392
|
*
|
|
10594
10393
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion)
|
|
10595
10394
|
*
|
|
10596
|
-
* @deprecated
|
|
10395
|
+
* @deprecated
|
|
10597
10396
|
*/
|
|
10598
10397
|
interface RocketPropulsion extends BodyMover {
|
|
10599
10398
|
/**
|
|
@@ -11045,7 +10844,7 @@ interface CaptureService extends Instance {
|
|
|
11045
10844
|
*
|
|
11046
10845
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureSaved)
|
|
11047
10846
|
*
|
|
11048
|
-
* @deprecated
|
|
10847
|
+
* @deprecated
|
|
11049
10848
|
*/
|
|
11050
10849
|
readonly CaptureSaved: RBXScriptSignal<(captureInfo: Record<string, unknown>) => void>;
|
|
11051
10850
|
/**
|
|
@@ -11312,6 +11111,12 @@ interface Pants extends Clothing {
|
|
|
11312
11111
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Pants#PantsTemplate)
|
|
11313
11112
|
*/
|
|
11314
11113
|
PantsTemplate: ContentId;
|
|
11114
|
+
/**
|
|
11115
|
+
* - **ThreadSafety**: ReadSafe
|
|
11116
|
+
*
|
|
11117
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Pants#PantsTemplateContent)
|
|
11118
|
+
*/
|
|
11119
|
+
PantsTemplateContent: Content;
|
|
11315
11120
|
}
|
|
11316
11121
|
/**
|
|
11317
11122
|
* Displays a shirt texture on a `Humanoid` rig.
|
|
@@ -11335,6 +11140,12 @@ interface Shirt extends Clothing {
|
|
|
11335
11140
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Shirt#ShirtTemplate)
|
|
11336
11141
|
*/
|
|
11337
11142
|
ShirtTemplate: ContentId;
|
|
11143
|
+
/**
|
|
11144
|
+
* - **ThreadSafety**: ReadSafe
|
|
11145
|
+
*
|
|
11146
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Shirt#ShirtTemplateContent)
|
|
11147
|
+
*/
|
|
11148
|
+
ShirtTemplateContent: Content;
|
|
11338
11149
|
}
|
|
11339
11150
|
/**
|
|
11340
11151
|
* Applies a texture to the front surface of a character's torso, used to display t-shirts.
|
|
@@ -11366,6 +11177,12 @@ interface ShirtGraphic extends CharacterAppearance {
|
|
|
11366
11177
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ShirtGraphic#Graphic)
|
|
11367
11178
|
*/
|
|
11368
11179
|
Graphic: ContentId;
|
|
11180
|
+
/**
|
|
11181
|
+
* - **ThreadSafety**: ReadSafe
|
|
11182
|
+
*
|
|
11183
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ShirtGraphic#TextureContent)
|
|
11184
|
+
*/
|
|
11185
|
+
TextureContent: Content;
|
|
11369
11186
|
}
|
|
11370
11187
|
/**
|
|
11371
11188
|
* Houses the Luau code responsible for running the legacy chat system.
|
|
@@ -11507,7 +11324,7 @@ interface Chat extends Instance {
|
|
|
11507
11324
|
* @param playerToFilterFor Player that the string is being filtered for.
|
|
11508
11325
|
* @returns Filtered string result.
|
|
11509
11326
|
*
|
|
11510
|
-
* @deprecated
|
|
11327
|
+
* @deprecated
|
|
11511
11328
|
*/
|
|
11512
11329
|
FilterStringForPlayerAsync(this: Chat, stringToFilter: string, playerToFilterFor: Player): string;
|
|
11513
11330
|
/**
|
|
@@ -11883,13 +11700,6 @@ interface DragDetector extends ClickDetector {
|
|
|
11883
11700
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragContinue)
|
|
11884
11701
|
*/
|
|
11885
11702
|
readonly DragContinue: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
11886
|
-
/**
|
|
11887
|
-
* - **ThreadSafety**: Unsafe
|
|
11888
|
-
* - **Tags**: Hidden
|
|
11889
|
-
*
|
|
11890
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragContinueReplicate)
|
|
11891
|
-
*/
|
|
11892
|
-
readonly DragContinueReplicate: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
11893
11703
|
/**
|
|
11894
11704
|
* Fires when a user stops dragging the object.
|
|
11895
11705
|
*
|
|
@@ -11898,13 +11708,6 @@ interface DragDetector extends ClickDetector {
|
|
|
11898
11708
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragEnd)
|
|
11899
11709
|
*/
|
|
11900
11710
|
readonly DragEnd: RBXScriptSignal<(playerWhoDragged: Player) => void>;
|
|
11901
|
-
/**
|
|
11902
|
-
* - **ThreadSafety**: Unsafe
|
|
11903
|
-
* - **Tags**: Hidden
|
|
11904
|
-
*
|
|
11905
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragEndReplicate)
|
|
11906
|
-
*/
|
|
11907
|
-
readonly DragEndReplicate: RBXScriptSignal<(playerWhoDragged: Player) => void>;
|
|
11908
11711
|
/**
|
|
11909
11712
|
* Fires when a user starts dragging the object.
|
|
11910
11713
|
*
|
|
@@ -11913,20 +11716,21 @@ interface DragDetector extends ClickDetector {
|
|
|
11913
11716
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragStart)
|
|
11914
11717
|
*/
|
|
11915
11718
|
readonly DragStart: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, hitFrame: CFrame, clickedPart: BasePart, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
11719
|
+
}
|
|
11720
|
+
/**
|
|
11721
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
11722
|
+
*
|
|
11723
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ClientStorageService)
|
|
11724
|
+
*/
|
|
11725
|
+
interface ClientStorageService extends Instance {
|
|
11916
11726
|
/**
|
|
11917
|
-
*
|
|
11918
|
-
* - **Tags**: Hidden
|
|
11919
|
-
*
|
|
11920
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragStartReplicate)
|
|
11921
|
-
*/
|
|
11922
|
-
readonly DragStartReplicate: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, hitFrame: CFrame, clickedPart: BasePart, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
11923
|
-
/**
|
|
11924
|
-
* - **ThreadSafety**: Unsafe
|
|
11925
|
-
* - **Tags**: Hidden
|
|
11727
|
+
* **DO NOT USE!**
|
|
11926
11728
|
*
|
|
11927
|
-
*
|
|
11729
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
11730
|
+
* @hidden
|
|
11731
|
+
* @deprecated
|
|
11928
11732
|
*/
|
|
11929
|
-
readonly
|
|
11733
|
+
readonly _nominal_ClientStorageService: unique symbol;
|
|
11930
11734
|
}
|
|
11931
11735
|
/**
|
|
11932
11736
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -12032,7 +11836,7 @@ interface Collaborator extends Instance {
|
|
|
12032
11836
|
*
|
|
12033
11837
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Collaborator#CollaboratorColor)
|
|
12034
11838
|
*
|
|
12035
|
-
* @deprecated
|
|
11839
|
+
* @deprecated
|
|
12036
11840
|
*/
|
|
12037
11841
|
CollaboratorColor: number;
|
|
12038
11842
|
/**
|
|
@@ -12221,7 +12025,7 @@ interface CollectionService extends Instance {
|
|
|
12221
12025
|
*
|
|
12222
12026
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CollectionService#ItemAdded)
|
|
12223
12027
|
*
|
|
12224
|
-
* @deprecated
|
|
12028
|
+
* @deprecated
|
|
12225
12029
|
*/
|
|
12226
12030
|
readonly ItemAdded: RBXScriptSignal<(instance: Instance) => void>;
|
|
12227
12031
|
/**
|
|
@@ -12234,7 +12038,7 @@ interface CollectionService extends Instance {
|
|
|
12234
12038
|
*
|
|
12235
12039
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CollectionService#ItemRemoved)
|
|
12236
12040
|
*
|
|
12237
|
-
* @deprecated
|
|
12041
|
+
* @deprecated
|
|
12238
12042
|
*/
|
|
12239
12043
|
readonly ItemRemoved: RBXScriptSignal<(instance: Instance) => void>;
|
|
12240
12044
|
/**
|
|
@@ -13350,7 +13154,7 @@ interface PlaneConstraint extends Constraint {
|
|
|
13350
13154
|
*
|
|
13351
13155
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plane)
|
|
13352
13156
|
*
|
|
13353
|
-
* @deprecated
|
|
13157
|
+
* @deprecated
|
|
13354
13158
|
*/
|
|
13355
13159
|
interface Plane extends PlaneConstraint {
|
|
13356
13160
|
/**
|
|
@@ -14023,7 +13827,7 @@ interface TorsionSpringConstraint extends Constraint {
|
|
|
14023
13827
|
*
|
|
14024
13828
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#LimitEnabled)
|
|
14025
13829
|
*
|
|
14026
|
-
* @deprecated
|
|
13830
|
+
* @deprecated
|
|
14027
13831
|
*/
|
|
14028
13832
|
LimitEnabled: boolean;
|
|
14029
13833
|
/**
|
|
@@ -14235,7 +14039,7 @@ interface ContentProvider extends Instance {
|
|
|
14235
14039
|
* @param this Service that is used to load content, or assets, into a game.
|
|
14236
14040
|
* @param contentId
|
|
14237
14041
|
*
|
|
14238
|
-
* @deprecated
|
|
14042
|
+
* @deprecated
|
|
14239
14043
|
*/
|
|
14240
14044
|
Preload(this: ContentProvider, contentId: ContentId): void;
|
|
14241
14045
|
/**
|
|
@@ -14364,7 +14168,7 @@ interface ContextActionService extends Instance {
|
|
|
14364
14168
|
* @param createTouchButton
|
|
14365
14169
|
* @param inputTypes
|
|
14366
14170
|
*
|
|
14367
|
-
* @deprecated
|
|
14171
|
+
* @deprecated
|
|
14368
14172
|
*/
|
|
14369
14173
|
BindActionToInputTypes(this: ContextActionService, actionName: string, functionToBind: Callback, createTouchButton: boolean, inputTypes: unknown): void;
|
|
14370
14174
|
/**
|
|
@@ -15285,6 +15089,12 @@ interface FileMesh extends DataModelMesh {
|
|
|
15285
15089
|
* @deprecated
|
|
15286
15090
|
*/
|
|
15287
15091
|
readonly _nominal_FileMesh: unique symbol;
|
|
15092
|
+
/**
|
|
15093
|
+
* - **ThreadSafety**: ReadSafe
|
|
15094
|
+
*
|
|
15095
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FileMesh#MeshContent)
|
|
15096
|
+
*/
|
|
15097
|
+
MeshContent: Content;
|
|
15288
15098
|
/**
|
|
15289
15099
|
* The MeshId is the content ID of the mesh that is to be displayed.
|
|
15290
15100
|
*
|
|
@@ -15293,6 +15103,12 @@ interface FileMesh extends DataModelMesh {
|
|
|
15293
15103
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FileMesh#MeshId)
|
|
15294
15104
|
*/
|
|
15295
15105
|
MeshId: ContentId;
|
|
15106
|
+
/**
|
|
15107
|
+
* - **ThreadSafety**: ReadSafe
|
|
15108
|
+
*
|
|
15109
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FileMesh#TextureContent)
|
|
15110
|
+
*/
|
|
15111
|
+
TextureContent: Content;
|
|
15296
15112
|
/**
|
|
15297
15113
|
* The TextureId is the content ID of the texture that is to be applied to the mesh.
|
|
15298
15114
|
*
|
|
@@ -15880,6 +15696,21 @@ interface DeferredAssetManagerService extends Instance {
|
|
|
15880
15696
|
*/
|
|
15881
15697
|
readonly _nominal_DeferredAssetManagerService: unique symbol;
|
|
15882
15698
|
}
|
|
15699
|
+
/**
|
|
15700
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
15701
|
+
*
|
|
15702
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DesignFoundationsService)
|
|
15703
|
+
*/
|
|
15704
|
+
interface DesignFoundationsService extends Instance {
|
|
15705
|
+
/**
|
|
15706
|
+
* **DO NOT USE!**
|
|
15707
|
+
*
|
|
15708
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
15709
|
+
* @hidden
|
|
15710
|
+
* @deprecated
|
|
15711
|
+
*/
|
|
15712
|
+
readonly _nominal_DesignFoundationsService: unique symbol;
|
|
15713
|
+
}
|
|
15883
15714
|
/**
|
|
15884
15715
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
15885
15716
|
*
|
|
@@ -17841,13 +17672,17 @@ interface GenerationService extends Instance {
|
|
|
17841
17672
|
*
|
|
17842
17673
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateModelAsync)
|
|
17843
17674
|
* @param this Service that allows developers to generate 3D objects from text prompts.
|
|
17844
|
-
* @param inputs A table representing conditioning inputs with the following keys: - `TextPrompt` — String description of the object to generate.
|
|
17675
|
+
* @param inputs A table representing conditioning inputs with the following keys: - `TextPrompt` — String description of the object to generate. Required unless an `Image` is provided; you must supply at least one of `TextPrompt` or `Image`.
|
|
17676
|
+
* - `Image` — Optional `Content` referencing an image asset (for example, the result of `Content.fromAssetId()`) used to visually condition the generation. Supply it together with or instead of `TextPrompt`.
|
|
17845
17677
|
* - `Size` — Optional `Vector3` describing the object size to generate. This is only approximate; scale the model extents post‑generation if you need a specific size.
|
|
17846
17678
|
* - `MaxTriangles` — Optional integer describing the maximum number of triangles that the returned model will contain. Lower values result in more faceted and low-poly generations.
|
|
17847
17679
|
* - `GenerateTextures` — `true` (default) textures the resulting generation, while `false` will not generate textures.
|
|
17848
17680
|
*
|
|
17849
17681
|
*
|
|
17850
|
-
* @param schema Table representing the generation schema.
|
|
17682
|
+
* @param schema Table representing the generation schema. Provide exactly one of the following keys: - `PredefinedSchema` — String selecting a built-in schema. Current valid options are `Car5` for a basic vehicle chassis consisting of five `Models`, or `Body1` which results in a single mesh output.
|
|
17683
|
+
* - `SchemaDefinition` — Table describing a custom multi-part structure. It contains a `Groups` array of part-name strings (one entry per desired part); the returned `Model` is organized to match the named groups. Use this instead of `PredefinedSchema` when you need a structure the predefined schemas don't cover.
|
|
17684
|
+
*
|
|
17685
|
+
*
|
|
17851
17686
|
* @param options Currently not used; reserved for future customization options.
|
|
17852
17687
|
* @returns Tuple with the following elements: - A standard `Model` container instance that is compliant with the specified `schema`.
|
|
17853
17688
|
* - A table containing a UUID and other metadata about the generation.
|
|
@@ -18467,12 +18302,18 @@ interface GroupService extends Instance {
|
|
|
18467
18302
|
*/
|
|
18468
18303
|
GetGroupsAsync(this: GroupService, userId: number): Array<GetGroupsAsyncResult>;
|
|
18469
18304
|
/**
|
|
18305
|
+
* Returns all roles held by the specified user in the specified group, supporting multi-role group membership.
|
|
18306
|
+
*
|
|
18470
18307
|
* - **ThreadSafety**: Unsafe
|
|
18471
18308
|
* - **Tags**: Yields
|
|
18472
18309
|
*
|
|
18473
18310
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GroupService#GetRolesInGroupAsync)
|
|
18311
|
+
* @param this GroupService is a service that allows developers to fetch information about a Roblox group from within a game.
|
|
18312
|
+
* @param userId The user's ID.
|
|
18313
|
+
* @param groupId The group's ID.
|
|
18314
|
+
* @returns A table with two fields: `IsMember` (boolean) and `Roles` (array of public role tables). Each role table contains `Id` (int64), `Name` (string), and `Rank` (int). The array is ordered as returned by the backend.
|
|
18474
18315
|
*/
|
|
18475
|
-
GetRolesInGroupAsync(this: GroupService, userId:
|
|
18316
|
+
GetRolesInGroupAsync(this: GroupService, userId: User, groupId: number): unknown;
|
|
18476
18317
|
/**
|
|
18477
18318
|
* Prompts the local `Player` to join a specified Roblox group via a native modal.
|
|
18478
18319
|
*
|
|
@@ -18564,7 +18405,7 @@ interface GuiBase2d extends GuiBase {
|
|
|
18564
18405
|
*
|
|
18565
18406
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#Localize)
|
|
18566
18407
|
*
|
|
18567
|
-
* @deprecated
|
|
18408
|
+
* @deprecated
|
|
18568
18409
|
*/
|
|
18569
18410
|
Localize: boolean;
|
|
18570
18411
|
/**
|
|
@@ -19474,7 +19315,7 @@ interface TextButton extends GuiButton {
|
|
|
19474
19315
|
*
|
|
19475
19316
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextButton#FontSize)
|
|
19476
19317
|
*
|
|
19477
|
-
* @deprecated
|
|
19318
|
+
* @deprecated
|
|
19478
19319
|
*/
|
|
19479
19320
|
FontSize: Enum.FontSize;
|
|
19480
19321
|
/**
|
|
@@ -19636,7 +19477,7 @@ interface TextButton extends GuiButton {
|
|
|
19636
19477
|
*
|
|
19637
19478
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextButton#TextWrap)
|
|
19638
19479
|
*
|
|
19639
|
-
* @deprecated
|
|
19480
|
+
* @deprecated
|
|
19640
19481
|
*/
|
|
19641
19482
|
TextWrap: boolean;
|
|
19642
19483
|
/**
|
|
@@ -19843,7 +19684,7 @@ interface TextLabel extends GuiLabel {
|
|
|
19843
19684
|
*
|
|
19844
19685
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextLabel#FontSize)
|
|
19845
19686
|
*
|
|
19846
|
-
* @deprecated
|
|
19687
|
+
* @deprecated
|
|
19847
19688
|
*/
|
|
19848
19689
|
FontSize: Enum.FontSize;
|
|
19849
19690
|
/**
|
|
@@ -20005,7 +19846,7 @@ interface TextLabel extends GuiLabel {
|
|
|
20005
19846
|
*
|
|
20006
19847
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextWrap)
|
|
20007
19848
|
*
|
|
20008
|
-
* @deprecated
|
|
19849
|
+
* @deprecated
|
|
20009
19850
|
*/
|
|
20010
19851
|
TextWrap: boolean;
|
|
20011
19852
|
/**
|
|
@@ -20305,7 +20146,7 @@ interface TextBox extends GuiObject {
|
|
|
20305
20146
|
*
|
|
20306
20147
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#FontSize)
|
|
20307
20148
|
*
|
|
20308
|
-
* @deprecated
|
|
20149
|
+
* @deprecated
|
|
20309
20150
|
*/
|
|
20310
20151
|
FontSize: Enum.FontSize;
|
|
20311
20152
|
/**
|
|
@@ -20428,7 +20269,7 @@ interface TextBox extends GuiObject {
|
|
|
20428
20269
|
*/
|
|
20429
20270
|
TextDirection: Enum.TextDirection;
|
|
20430
20271
|
/**
|
|
20431
|
-
* Determines whether the
|
|
20272
|
+
* Determines whether the player can change the `Text`.
|
|
20432
20273
|
*
|
|
20433
20274
|
* - **ThreadSafety**: ReadSafe
|
|
20434
20275
|
*
|
|
@@ -20500,7 +20341,7 @@ interface TextBox extends GuiObject {
|
|
|
20500
20341
|
*
|
|
20501
20342
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#TextWrap)
|
|
20502
20343
|
*
|
|
20503
|
-
* @deprecated
|
|
20344
|
+
* @deprecated
|
|
20504
20345
|
*/
|
|
20505
20346
|
TextWrap: boolean;
|
|
20506
20347
|
/**
|
|
@@ -20572,12 +20413,35 @@ interface TextBox extends GuiObject {
|
|
|
20572
20413
|
*/
|
|
20573
20414
|
readonly Focused: RBXScriptSignal<() => void>;
|
|
20574
20415
|
/**
|
|
20416
|
+
* Fires when the `TextBox` is focused and the player presses the on-screen keyboard's return/enter button.
|
|
20417
|
+
*
|
|
20575
20418
|
* - **ThreadSafety**: Unsafe
|
|
20576
20419
|
*
|
|
20577
20420
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#ReturnPressedFromOnScreenKeyboard)
|
|
20578
20421
|
*/
|
|
20579
20422
|
readonly ReturnPressedFromOnScreenKeyboard: RBXScriptSignal<() => void>;
|
|
20580
20423
|
}
|
|
20424
|
+
/**
|
|
20425
|
+
* - **Tags**: NotBrowsable
|
|
20426
|
+
*
|
|
20427
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChannelWindow)
|
|
20428
|
+
*/
|
|
20429
|
+
interface TextChannelWindow extends GuiObject {
|
|
20430
|
+
/**
|
|
20431
|
+
* **DO NOT USE!**
|
|
20432
|
+
*
|
|
20433
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
20434
|
+
* @hidden
|
|
20435
|
+
* @deprecated
|
|
20436
|
+
*/
|
|
20437
|
+
readonly _nominal_TextChannelWindow: unique symbol;
|
|
20438
|
+
/**
|
|
20439
|
+
* - **ThreadSafety**: ReadSafe
|
|
20440
|
+
*
|
|
20441
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChannelWindow#Target)
|
|
20442
|
+
*/
|
|
20443
|
+
Target: TextChannel | undefined;
|
|
20444
|
+
}
|
|
20581
20445
|
/**
|
|
20582
20446
|
* A GUI object that displays video content from a connected `VideoPlayer`.
|
|
20583
20447
|
*
|
|
@@ -20700,6 +20564,12 @@ interface VideoFrame extends GuiObject {
|
|
|
20700
20564
|
* @deprecated
|
|
20701
20565
|
*/
|
|
20702
20566
|
readonly _nominal_VideoFrame: unique symbol;
|
|
20567
|
+
/**
|
|
20568
|
+
* - **ThreadSafety**: ReadSafe
|
|
20569
|
+
*
|
|
20570
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#InternalVideoUsage)
|
|
20571
|
+
*/
|
|
20572
|
+
InternalVideoUsage: Enum.InternalVideoUsage;
|
|
20703
20573
|
/**
|
|
20704
20574
|
* Indicates when the `VideoFrame.Video` has loaded from Roblox servers and is ready to play.
|
|
20705
20575
|
*
|
|
@@ -21259,6 +21129,12 @@ interface AdGui extends SurfaceGuiBase {
|
|
|
21259
21129
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdGui#FallbackImage)
|
|
21260
21130
|
*/
|
|
21261
21131
|
FallbackImage: ContentId;
|
|
21132
|
+
/**
|
|
21133
|
+
* - **ThreadSafety**: ReadSafe
|
|
21134
|
+
*
|
|
21135
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdGui#FallbackImageContent)
|
|
21136
|
+
*/
|
|
21137
|
+
FallbackImageContent: Content;
|
|
21262
21138
|
/**
|
|
21263
21139
|
* - **ThreadSafety**: ReadSafe
|
|
21264
21140
|
* - **Tags**: NotReplicated
|
|
@@ -21558,7 +21434,7 @@ interface SelectionBox extends InstanceAdornment {
|
|
|
21558
21434
|
*
|
|
21559
21435
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelectionBox#SurfaceColor)
|
|
21560
21436
|
*
|
|
21561
|
-
* @deprecated
|
|
21437
|
+
* @deprecated
|
|
21562
21438
|
*/
|
|
21563
21439
|
SurfaceColor: BrickColor;
|
|
21564
21440
|
/**
|
|
@@ -21839,6 +21715,12 @@ interface ImageHandleAdornment extends HandleAdornment {
|
|
|
21839
21715
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImageHandleAdornment#Image)
|
|
21840
21716
|
*/
|
|
21841
21717
|
Image: ContentId;
|
|
21718
|
+
/**
|
|
21719
|
+
* - **ThreadSafety**: ReadSafe
|
|
21720
|
+
*
|
|
21721
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImageHandleAdornment#ImageContent)
|
|
21722
|
+
*/
|
|
21723
|
+
ImageContent: Content;
|
|
21842
21724
|
/**
|
|
21843
21725
|
* Size of the image in studs.
|
|
21844
21726
|
*
|
|
@@ -22074,7 +21956,7 @@ interface SelectionSphere extends PVAdornment {
|
|
|
22074
21956
|
*
|
|
22075
21957
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelectionSphere#SurfaceColor)
|
|
22076
21958
|
*
|
|
22077
|
-
* @deprecated
|
|
21959
|
+
* @deprecated
|
|
22078
21960
|
*/
|
|
22079
21961
|
SurfaceColor: BrickColor;
|
|
22080
21962
|
/**
|
|
@@ -22718,7 +22600,7 @@ interface GuiService extends Instance {
|
|
|
22718
22600
|
* @param selectionName
|
|
22719
22601
|
* @param selectionParent
|
|
22720
22602
|
*
|
|
22721
|
-
* @deprecated
|
|
22603
|
+
* @deprecated
|
|
22722
22604
|
*/
|
|
22723
22605
|
AddSelectionParent(this: GuiService, selectionName: string, selectionParent: GuiObject): void;
|
|
22724
22606
|
/**
|
|
@@ -22737,7 +22619,7 @@ interface GuiService extends Instance {
|
|
|
22737
22619
|
* @param selectionName The name of the added selection.
|
|
22738
22620
|
* @param selections The selection(s) added.
|
|
22739
22621
|
*
|
|
22740
|
-
* @deprecated
|
|
22622
|
+
* @deprecated
|
|
22741
22623
|
*/
|
|
22742
22624
|
AddSelectionTuple(this: GuiService, selectionName: string, selections: Array<GuiObject>): void;
|
|
22743
22625
|
/**
|
|
@@ -22791,7 +22673,7 @@ interface GuiService extends Instance {
|
|
|
22791
22673
|
Vector2
|
|
22792
22674
|
]>;
|
|
22793
22675
|
/**
|
|
22794
|
-
* Takes an `ScreenInsets` value and returns a `
|
|
22676
|
+
* Takes an `ScreenInsets` value and returns a `Rect` describing the inset region, relative to the `CoreUISafeInsets` area.
|
|
22795
22677
|
*
|
|
22796
22678
|
* - **ThreadSafety**: Unsafe
|
|
22797
22679
|
*
|
|
@@ -22830,7 +22712,7 @@ interface GuiService extends Instance {
|
|
|
22830
22712
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
22831
22713
|
* @param userId The `UserId` of the player to inspect.
|
|
22832
22714
|
*/
|
|
22833
|
-
InspectPlayerFromUserId(this: GuiService, userId:
|
|
22715
|
+
InspectPlayerFromUserId(this: GuiService, userId: User): void;
|
|
22834
22716
|
/**
|
|
22835
22717
|
* Returns `true` if the client is using the ten foot interface, a special version of Roblox's UI exclusive to consoles.
|
|
22836
22718
|
*
|
|
@@ -22852,7 +22734,7 @@ interface GuiService extends Instance {
|
|
|
22852
22734
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
22853
22735
|
* @param selectionName
|
|
22854
22736
|
*
|
|
22855
|
-
* @deprecated
|
|
22737
|
+
* @deprecated
|
|
22856
22738
|
*/
|
|
22857
22739
|
RemoveSelectionGroup(this: GuiService, selectionName: string): void;
|
|
22858
22740
|
/**
|
|
@@ -24023,7 +23905,7 @@ interface Humanoid extends Instance {
|
|
|
24023
23905
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
24024
23906
|
* @param assetTypeVerification The asset type verification mode.
|
|
24025
23907
|
*
|
|
24026
|
-
* @deprecated
|
|
23908
|
+
* @deprecated
|
|
24027
23909
|
*/
|
|
24028
23910
|
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
24029
23911
|
/**
|
|
@@ -24051,7 +23933,7 @@ interface Humanoid extends Instance {
|
|
|
24051
23933
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
24052
23934
|
* @param assetTypeVerification The asset type verification mode.
|
|
24053
23935
|
*
|
|
24054
|
-
* @deprecated
|
|
23936
|
+
* @deprecated
|
|
24055
23937
|
*/
|
|
24056
23938
|
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
24057
23939
|
/**
|
|
@@ -24079,7 +23961,7 @@ interface Humanoid extends Instance {
|
|
|
24079
23961
|
* @param emoteName name of the emote to play.
|
|
24080
23962
|
* @returns successfully played.
|
|
24081
23963
|
*
|
|
24082
|
-
* @deprecated
|
|
23964
|
+
* @deprecated
|
|
24083
23965
|
*/
|
|
24084
23966
|
PlayEmote(this: Humanoid, emoteName: string): boolean;
|
|
24085
23967
|
/**
|
|
@@ -25872,6 +25754,8 @@ interface InputBinding extends Instance {
|
|
|
25872
25754
|
*/
|
|
25873
25755
|
Backward: Enum.KeyCode;
|
|
25874
25756
|
/**
|
|
25757
|
+
* Specifies how the binding normalizes composite directional input to a maximum magnitude of `1`.
|
|
25758
|
+
*
|
|
25875
25759
|
* - **ThreadSafety**: ReadSafe
|
|
25876
25760
|
*
|
|
25877
25761
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ClampMagnitudeToOne)
|
|
@@ -25956,7 +25840,7 @@ interface InputBinding extends Instance {
|
|
|
25956
25840
|
*/
|
|
25957
25841
|
Right: Enum.KeyCode;
|
|
25958
25842
|
/**
|
|
25959
|
-
*
|
|
25843
|
+
* Scalar multiplier applied uniformly to all components of a directional `InputAction`'s output.
|
|
25960
25844
|
*
|
|
25961
25845
|
* - **ThreadSafety**: ReadSafe
|
|
25962
25846
|
*
|
|
@@ -25980,6 +25864,8 @@ interface InputBinding extends Instance {
|
|
|
25980
25864
|
*/
|
|
25981
25865
|
UIButton: GuiButton | undefined;
|
|
25982
25866
|
/**
|
|
25867
|
+
* Specifies a `GuiButton` that must be active for the binding to activate.
|
|
25868
|
+
*
|
|
25983
25869
|
* - **ThreadSafety**: ReadSafe
|
|
25984
25870
|
*
|
|
25985
25871
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#UIModifier)
|
|
@@ -25994,7 +25880,7 @@ interface InputBinding extends Instance {
|
|
|
25994
25880
|
*/
|
|
25995
25881
|
Up: Enum.KeyCode;
|
|
25996
25882
|
/**
|
|
25997
|
-
*
|
|
25883
|
+
* Per-component scale applied to the output of a `Direction2D` action.
|
|
25998
25884
|
*
|
|
25999
25885
|
* - **ThreadSafety**: ReadSafe
|
|
26000
25886
|
*
|
|
@@ -26002,6 +25888,8 @@ interface InputBinding extends Instance {
|
|
|
26002
25888
|
*/
|
|
26003
25889
|
Vector2Scale: Vector2;
|
|
26004
25890
|
/**
|
|
25891
|
+
* Per-component scale applied to the output of a `Direction3D` action.
|
|
25892
|
+
*
|
|
26005
25893
|
* - **ThreadSafety**: ReadSafe
|
|
26006
25894
|
*
|
|
26007
25895
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Vector3Scale)
|
|
@@ -26208,7 +26096,7 @@ interface InsertService extends Instance {
|
|
|
26208
26096
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetBaseCategories)
|
|
26209
26097
|
* @param this Used to insert assets from the Roblox website.
|
|
26210
26098
|
*
|
|
26211
|
-
* @deprecated
|
|
26099
|
+
* @deprecated
|
|
26212
26100
|
*/
|
|
26213
26101
|
GetBaseCategories(this: InsertService): Array<unknown>;
|
|
26214
26102
|
/**
|
|
@@ -26254,7 +26142,7 @@ interface InsertService extends Instance {
|
|
|
26254
26142
|
* @param pageNum The page number in the Catalog to return.
|
|
26255
26143
|
* @returns A single table (of returned free decals) wrapped in a table.
|
|
26256
26144
|
*
|
|
26257
|
-
* @deprecated
|
|
26145
|
+
* @deprecated
|
|
26258
26146
|
*/
|
|
26259
26147
|
GetFreeDecals(this: InsertService, searchText: string, pageNum: number): [
|
|
26260
26148
|
Array<FreeSearchResult>
|
|
@@ -26286,7 +26174,7 @@ interface InsertService extends Instance {
|
|
|
26286
26174
|
* @param pageNum The page number in the Catalog to return.
|
|
26287
26175
|
* @returns A single table (of returned free models) wrapped in a table.
|
|
26288
26176
|
*
|
|
26289
|
-
* @deprecated
|
|
26177
|
+
* @deprecated
|
|
26290
26178
|
*/
|
|
26291
26179
|
GetFreeModels(this: InsertService, searchText: string, pageNum: number): [
|
|
26292
26180
|
Array<FreeSearchResult>
|
|
@@ -26325,9 +26213,9 @@ interface InsertService extends Instance {
|
|
|
26325
26213
|
* @param this Used to insert assets from the Roblox website.
|
|
26326
26214
|
* @param userId
|
|
26327
26215
|
*
|
|
26328
|
-
* @deprecated
|
|
26216
|
+
* @deprecated
|
|
26329
26217
|
*/
|
|
26330
|
-
GetUserCategories(this: InsertService, userId:
|
|
26218
|
+
GetUserCategories(this: InsertService, userId: User): Array<unknown>;
|
|
26331
26219
|
/**
|
|
26332
26220
|
* **Deprecated:** [Sets have been removed](https://devforum.roblox.com/t/sunsetting-sets/189402) from Roblox.
|
|
26333
26221
|
*
|
|
@@ -26366,13 +26254,6 @@ interface InsertService extends Instance {
|
|
|
26366
26254
|
* @param assetVersionId
|
|
26367
26255
|
*/
|
|
26368
26256
|
LoadAssetVersion(this: InsertService, assetVersionId: number): Model;
|
|
26369
|
-
/**
|
|
26370
|
-
* - **ThreadSafety**: Unsafe
|
|
26371
|
-
* - **Tags**: Hidden
|
|
26372
|
-
*
|
|
26373
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#InternalDelete)
|
|
26374
|
-
*/
|
|
26375
|
-
readonly InternalDelete: RBXScriptSignal<(instance: Instance) => void>;
|
|
26376
26257
|
}
|
|
26377
26258
|
/**
|
|
26378
26259
|
* - **Tags**: NotCreatable, Service
|
|
@@ -26436,36 +26317,6 @@ interface InternalMessagingServiceVerifier extends Instance {
|
|
|
26436
26317
|
*/
|
|
26437
26318
|
readonly _nominal_InternalMessagingServiceVerifier: unique symbol;
|
|
26438
26319
|
}
|
|
26439
|
-
/**
|
|
26440
|
-
* - **Tags**: NotReplicated
|
|
26441
|
-
*
|
|
26442
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InternalSyncItem)
|
|
26443
|
-
*/
|
|
26444
|
-
interface InternalSyncItem extends Instance {
|
|
26445
|
-
/**
|
|
26446
|
-
* **DO NOT USE!**
|
|
26447
|
-
*
|
|
26448
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26449
|
-
* @hidden
|
|
26450
|
-
* @deprecated
|
|
26451
|
-
*/
|
|
26452
|
-
readonly _nominal_InternalSyncItem: unique symbol;
|
|
26453
|
-
}
|
|
26454
|
-
/**
|
|
26455
|
-
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
26456
|
-
*
|
|
26457
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InternalSyncService)
|
|
26458
|
-
*/
|
|
26459
|
-
interface InternalSyncService extends Instance {
|
|
26460
|
-
/**
|
|
26461
|
-
* **DO NOT USE!**
|
|
26462
|
-
*
|
|
26463
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26464
|
-
* @hidden
|
|
26465
|
-
* @deprecated
|
|
26466
|
-
*/
|
|
26467
|
-
readonly _nominal_InternalSyncService: unique symbol;
|
|
26468
|
-
}
|
|
26469
26320
|
/**
|
|
26470
26321
|
* The base class for joints.
|
|
26471
26322
|
*
|
|
@@ -26564,7 +26415,7 @@ interface DynamicRotate extends JointInstance {
|
|
|
26564
26415
|
*
|
|
26565
26416
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotateP)
|
|
26566
26417
|
*
|
|
26567
|
-
* @deprecated
|
|
26418
|
+
* @deprecated
|
|
26568
26419
|
*/
|
|
26569
26420
|
interface RotateP extends DynamicRotate {
|
|
26570
26421
|
/**
|
|
@@ -26583,7 +26434,7 @@ interface RotateP extends DynamicRotate {
|
|
|
26583
26434
|
*
|
|
26584
26435
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotateV)
|
|
26585
26436
|
*
|
|
26586
|
-
* @deprecated
|
|
26437
|
+
* @deprecated
|
|
26587
26438
|
*/
|
|
26588
26439
|
interface RotateV extends DynamicRotate {
|
|
26589
26440
|
/**
|
|
@@ -26604,7 +26455,7 @@ interface RotateV extends DynamicRotate {
|
|
|
26604
26455
|
*
|
|
26605
26456
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Glue)
|
|
26606
26457
|
*
|
|
26607
|
-
* @deprecated
|
|
26458
|
+
* @deprecated
|
|
26608
26459
|
*/
|
|
26609
26460
|
interface Glue extends JointInstance {
|
|
26610
26461
|
/**
|
|
@@ -26657,7 +26508,7 @@ interface Glue extends JointInstance {
|
|
|
26657
26508
|
*
|
|
26658
26509
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ManualSurfaceJointInstance)
|
|
26659
26510
|
*
|
|
26660
|
-
* @deprecated
|
|
26511
|
+
* @deprecated
|
|
26661
26512
|
*/
|
|
26662
26513
|
interface ManualSurfaceJointInstance extends JointInstance {
|
|
26663
26514
|
/**
|
|
@@ -26678,7 +26529,7 @@ interface ManualSurfaceJointInstance extends JointInstance {
|
|
|
26678
26529
|
*
|
|
26679
26530
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ManualGlue)
|
|
26680
26531
|
*
|
|
26681
|
-
* @deprecated
|
|
26532
|
+
* @deprecated
|
|
26682
26533
|
*/
|
|
26683
26534
|
interface ManualGlue extends ManualSurfaceJointInstance {
|
|
26684
26535
|
/**
|
|
@@ -26699,7 +26550,7 @@ interface ManualGlue extends ManualSurfaceJointInstance {
|
|
|
26699
26550
|
*
|
|
26700
26551
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ManualWeld)
|
|
26701
26552
|
*
|
|
26702
|
-
* @deprecated
|
|
26553
|
+
* @deprecated
|
|
26703
26554
|
*/
|
|
26704
26555
|
interface ManualWeld extends ManualSurfaceJointInstance {
|
|
26705
26556
|
/**
|
|
@@ -26792,7 +26643,7 @@ interface Motor6D extends Motor {
|
|
|
26792
26643
|
*
|
|
26793
26644
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Rotate)
|
|
26794
26645
|
*
|
|
26795
|
-
* @deprecated
|
|
26646
|
+
* @deprecated
|
|
26796
26647
|
*/
|
|
26797
26648
|
interface Rotate extends JointInstance {
|
|
26798
26649
|
/**
|
|
@@ -26813,7 +26664,7 @@ interface Rotate extends JointInstance {
|
|
|
26813
26664
|
*
|
|
26814
26665
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Snap)
|
|
26815
26666
|
*
|
|
26816
|
-
* @deprecated
|
|
26667
|
+
* @deprecated
|
|
26817
26668
|
*/
|
|
26818
26669
|
interface Snap extends JointInstance {
|
|
26819
26670
|
/**
|
|
@@ -27118,7 +26969,7 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
27118
26969
|
* @param userId The user ID of the user.
|
|
27119
26970
|
* @returns An `InventoryPages` of animations.
|
|
27120
26971
|
*
|
|
27121
|
-
* @deprecated
|
|
26972
|
+
* @deprecated
|
|
27122
26973
|
*/
|
|
27123
26974
|
GetAnimations(this: KeyframeSequenceProvider, userId: number): InventoryPages<number>;
|
|
27124
26975
|
/**
|
|
@@ -27132,7 +26983,7 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
27132
26983
|
* @param userId The user ID of the user.
|
|
27133
26984
|
* @returns An `InventoryPages` of animations.
|
|
27134
26985
|
*/
|
|
27135
|
-
GetAnimationsAsync(this: KeyframeSequenceProvider, userId:
|
|
26986
|
+
GetAnimationsAsync(this: KeyframeSequenceProvider, userId: User): Instance | undefined;
|
|
27136
26987
|
/**
|
|
27137
26988
|
* Returns a KeyframeSequence based on the specified assetId asynchronously.
|
|
27138
26989
|
*
|
|
@@ -27146,21 +26997,6 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
27146
26997
|
*/
|
|
27147
26998
|
GetKeyframeSequenceAsync(this: KeyframeSequenceProvider, assetId: string): KeyframeSequence;
|
|
27148
26999
|
}
|
|
27149
|
-
/**
|
|
27150
|
-
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
27151
|
-
*
|
|
27152
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LSPFileSyncService)
|
|
27153
|
-
*/
|
|
27154
|
-
interface LSPFileSyncService extends Instance {
|
|
27155
|
-
/**
|
|
27156
|
-
* **DO NOT USE!**
|
|
27157
|
-
*
|
|
27158
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
27159
|
-
* @hidden
|
|
27160
|
-
* @deprecated
|
|
27161
|
-
*/
|
|
27162
|
-
readonly _nominal_LSPFileSyncService: unique symbol;
|
|
27163
|
-
}
|
|
27164
27000
|
/**
|
|
27165
27001
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
27166
27002
|
*
|
|
@@ -27768,7 +27604,7 @@ interface LocalizationTable extends Instance {
|
|
|
27768
27604
|
*
|
|
27769
27605
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#DevelopmentLanguage)
|
|
27770
27606
|
*
|
|
27771
|
-
* @deprecated
|
|
27607
|
+
* @deprecated
|
|
27772
27608
|
*/
|
|
27773
27609
|
DevelopmentLanguage: string;
|
|
27774
27610
|
/**
|
|
@@ -27781,7 +27617,7 @@ interface LocalizationTable extends Instance {
|
|
|
27781
27617
|
*
|
|
27782
27618
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#Root)
|
|
27783
27619
|
*
|
|
27784
|
-
* @deprecated
|
|
27620
|
+
* @deprecated
|
|
27785
27621
|
*/
|
|
27786
27622
|
Root: Instance | undefined;
|
|
27787
27623
|
/**
|
|
@@ -27801,7 +27637,7 @@ interface LocalizationTable extends Instance {
|
|
|
27801
27637
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#GetContents)
|
|
27802
27638
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27803
27639
|
*
|
|
27804
|
-
* @deprecated
|
|
27640
|
+
* @deprecated
|
|
27805
27641
|
*/
|
|
27806
27642
|
GetContents(this: LocalizationTable): string;
|
|
27807
27643
|
/**
|
|
@@ -27828,7 +27664,7 @@ interface LocalizationTable extends Instance {
|
|
|
27828
27664
|
* @param key An optional unique key for fast hash lookups in code. If it is non-empty it must be unique in the table.
|
|
27829
27665
|
* @returns Translated string.
|
|
27830
27666
|
*
|
|
27831
|
-
* @deprecated
|
|
27667
|
+
* @deprecated
|
|
27832
27668
|
*/
|
|
27833
27669
|
GetString(this: LocalizationTable, targetLocaleId: string, key: string): string;
|
|
27834
27670
|
/**
|
|
@@ -27879,7 +27715,7 @@ interface LocalizationTable extends Instance {
|
|
|
27879
27715
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27880
27716
|
* @param key
|
|
27881
27717
|
*
|
|
27882
|
-
* @deprecated
|
|
27718
|
+
* @deprecated
|
|
27883
27719
|
*/
|
|
27884
27720
|
RemoveKey(this: LocalizationTable, key: string): void;
|
|
27885
27721
|
/**
|
|
@@ -27904,7 +27740,7 @@ interface LocalizationTable extends Instance {
|
|
|
27904
27740
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27905
27741
|
* @param contents
|
|
27906
27742
|
*
|
|
27907
|
-
* @deprecated
|
|
27743
|
+
* @deprecated
|
|
27908
27744
|
*/
|
|
27909
27745
|
SetContents(this: LocalizationTable, contents: string): void;
|
|
27910
27746
|
/**
|
|
@@ -27929,7 +27765,7 @@ interface LocalizationTable extends Instance {
|
|
|
27929
27765
|
* @param targetLocaleId
|
|
27930
27766
|
* @param text
|
|
27931
27767
|
*
|
|
27932
|
-
* @deprecated
|
|
27768
|
+
* @deprecated
|
|
27933
27769
|
*/
|
|
27934
27770
|
SetEntry(this: LocalizationTable, key: string, targetLocaleId: string, text: string): void;
|
|
27935
27771
|
/**
|
|
@@ -28187,47 +28023,6 @@ interface LuaSourceContainer extends Instance {
|
|
|
28187
28023
|
*/
|
|
28188
28024
|
readonly _nominal_LuaSourceContainer: unique symbol;
|
|
28189
28025
|
}
|
|
28190
|
-
/**
|
|
28191
|
-
* - **Tags**:
|
|
28192
|
-
*
|
|
28193
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript)
|
|
28194
|
-
*
|
|
28195
|
-
* @deprecated
|
|
28196
|
-
*/
|
|
28197
|
-
interface AuroraScript extends LuaSourceContainer {
|
|
28198
|
-
/**
|
|
28199
|
-
* **DO NOT USE!**
|
|
28200
|
-
*
|
|
28201
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
28202
|
-
* @hidden
|
|
28203
|
-
* @deprecated
|
|
28204
|
-
*/
|
|
28205
|
-
readonly _nominal_AuroraScript: unique symbol;
|
|
28206
|
-
/**
|
|
28207
|
-
* - **ThreadSafety**: Unsafe
|
|
28208
|
-
*
|
|
28209
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#AddTo)
|
|
28210
|
-
*/
|
|
28211
|
-
AddTo(this: AuroraScript, instance: Instance, parameters?: object): void;
|
|
28212
|
-
/**
|
|
28213
|
-
* - **ThreadSafety**: Unsafe
|
|
28214
|
-
*
|
|
28215
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#IsOnInstance)
|
|
28216
|
-
*/
|
|
28217
|
-
IsOnInstance(this: AuroraScript, instance: Instance): boolean;
|
|
28218
|
-
/**
|
|
28219
|
-
* - **ThreadSafety**: Unsafe
|
|
28220
|
-
*
|
|
28221
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#RemoveFrom)
|
|
28222
|
-
*/
|
|
28223
|
-
RemoveFrom(this: AuroraScript, instance: Instance): void;
|
|
28224
|
-
/**
|
|
28225
|
-
* - **ThreadSafety**: Unsafe
|
|
28226
|
-
*
|
|
28227
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#SignalFired)
|
|
28228
|
-
*/
|
|
28229
|
-
SignalFired(this: AuroraScript, instance: Instance, topic: string): RBXScriptSignal;
|
|
28230
|
-
}
|
|
28231
28026
|
/**
|
|
28232
28027
|
* The base class for all script objects which run automatically.
|
|
28233
28028
|
*
|
|
@@ -28653,7 +28448,7 @@ interface MarketplaceService extends Instance {
|
|
|
28653
28448
|
* @param this The service responsible for in-experience transactions.
|
|
28654
28449
|
* @param player The user being prompted to purchase Premium.
|
|
28655
28450
|
*
|
|
28656
|
-
* @deprecated
|
|
28451
|
+
* @deprecated
|
|
28657
28452
|
*/
|
|
28658
28453
|
PromptPremiumPurchase(this: MarketplaceService, player: Player): void;
|
|
28659
28454
|
/**
|
|
@@ -28733,7 +28528,7 @@ interface MarketplaceService extends Instance {
|
|
|
28733
28528
|
* @param infoType An `InfoType` enum value specifying the type of information being retrieved.
|
|
28734
28529
|
* @returns A dictionary containing information about the queried item, described in the previous tables.
|
|
28735
28530
|
*
|
|
28736
|
-
* @deprecated
|
|
28531
|
+
* @deprecated
|
|
28737
28532
|
*/
|
|
28738
28533
|
GetProductInfo(this: MarketplaceService, id: number): AssetProductInfo;
|
|
28739
28534
|
GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Asset>): AssetProductInfo;
|
|
@@ -28815,7 +28610,7 @@ interface MarketplaceService extends Instance {
|
|
|
28815
28610
|
*/
|
|
28816
28611
|
GetUserSubscriptionStatusAsync(this: MarketplaceService, user: Player, subscriptionId: string): UserSubscriptionStatus;
|
|
28817
28612
|
/**
|
|
28818
|
-
* Returns the regionalized price
|
|
28613
|
+
* Returns the regionalized price levels of users, representing the recommended price for an item in each user's regional market.
|
|
28819
28614
|
*
|
|
28820
28615
|
* - **ThreadSafety**: Unsafe
|
|
28821
28616
|
* - **Tags**: Yields
|
|
@@ -28840,7 +28635,7 @@ interface MarketplaceService extends Instance {
|
|
|
28840
28635
|
* @param assetId The asset ID for which the given player's inventory is tested.
|
|
28841
28636
|
* @returns Indicates whether the given player's inventory contains the given asset.
|
|
28842
28637
|
*
|
|
28843
|
-
* @deprecated
|
|
28638
|
+
* @deprecated
|
|
28844
28639
|
*/
|
|
28845
28640
|
PlayerOwnsAsset(this: MarketplaceService, player: Player, assetId: number): boolean;
|
|
28846
28641
|
/**
|
|
@@ -28870,7 +28665,7 @@ interface MarketplaceService extends Instance {
|
|
|
28870
28665
|
* @param bundleId The bundle ID for which the given player's inventory is tested.
|
|
28871
28666
|
* @returns Indicates whether the given player's inventory contains the given bundle.
|
|
28872
28667
|
*
|
|
28873
|
-
* @deprecated
|
|
28668
|
+
* @deprecated
|
|
28874
28669
|
*/
|
|
28875
28670
|
PlayerOwnsBundle(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
28876
28671
|
/**
|
|
@@ -28949,7 +28744,7 @@ interface MarketplaceService extends Instance {
|
|
|
28949
28744
|
* @param userId The `UserId` of the `Player` whose inventory you're checking.
|
|
28950
28745
|
* @param gamePassId The pass ID you want to check for. Not to be confused with an asset ID.
|
|
28951
28746
|
*/
|
|
28952
|
-
UserOwnsGamePassAsync(this: MarketplaceService, userId:
|
|
28747
|
+
UserOwnsGamePassAsync(this: MarketplaceService, userId: User, gamePassId: number): boolean;
|
|
28953
28748
|
/**
|
|
28954
28749
|
* Fires when a purchase prompt for bulk avatar items is closed.
|
|
28955
28750
|
*
|
|
@@ -29909,7 +29704,7 @@ interface Mouse extends Instance {
|
|
|
29909
29704
|
*
|
|
29910
29705
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Mouse#KeyDown)
|
|
29911
29706
|
*
|
|
29912
|
-
* @deprecated
|
|
29707
|
+
* @deprecated
|
|
29913
29708
|
*/
|
|
29914
29709
|
readonly KeyDown: RBXScriptSignal<(key: string) => void>;
|
|
29915
29710
|
/**
|
|
@@ -29922,7 +29717,7 @@ interface Mouse extends Instance {
|
|
|
29922
29717
|
*
|
|
29923
29718
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Mouse#KeyUp)
|
|
29924
29719
|
*
|
|
29925
|
-
* @deprecated
|
|
29720
|
+
* @deprecated
|
|
29926
29721
|
*/
|
|
29927
29722
|
readonly KeyUp: RBXScriptSignal<(key: string) => void>;
|
|
29928
29723
|
/**
|
|
@@ -30068,7 +29863,7 @@ interface OmniRecommendationsService extends Instance {
|
|
|
30068
29863
|
*
|
|
30069
29864
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1)
|
|
30070
29865
|
*
|
|
30071
|
-
* @deprecated
|
|
29866
|
+
* @deprecated
|
|
30072
29867
|
*/
|
|
30073
29868
|
interface OpenCloudApiV1 extends Instance {
|
|
30074
29869
|
/**
|
|
@@ -30114,7 +29909,7 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
30114
29909
|
*
|
|
30115
29910
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudService)
|
|
30116
29911
|
*
|
|
30117
|
-
* @deprecated
|
|
29912
|
+
* @deprecated
|
|
30118
29913
|
*/
|
|
30119
29914
|
interface OpenCloudService extends Instance {
|
|
30120
29915
|
/**
|
|
@@ -30451,7 +30246,7 @@ interface BasePart extends PVInstance {
|
|
|
30451
30246
|
*
|
|
30452
30247
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#CollisionGroupId)
|
|
30453
30248
|
*
|
|
30454
|
-
* @deprecated
|
|
30249
|
+
* @deprecated
|
|
30455
30250
|
*/
|
|
30456
30251
|
CollisionGroupId: number;
|
|
30457
30252
|
/**
|
|
@@ -30803,7 +30598,7 @@ interface BasePart extends PVInstance {
|
|
|
30803
30598
|
*
|
|
30804
30599
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#RotVelocity)
|
|
30805
30600
|
*
|
|
30806
|
-
* @deprecated
|
|
30601
|
+
* @deprecated
|
|
30807
30602
|
*/
|
|
30808
30603
|
RotVelocity: Vector3;
|
|
30809
30604
|
/**
|
|
@@ -30902,7 +30697,7 @@ interface BasePart extends PVInstance {
|
|
|
30902
30697
|
*
|
|
30903
30698
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#Velocity)
|
|
30904
30699
|
*
|
|
30905
|
-
* @deprecated
|
|
30700
|
+
* @deprecated
|
|
30906
30701
|
*/
|
|
30907
30702
|
Velocity: Vector3;
|
|
30908
30703
|
/**
|
|
@@ -30987,11 +30782,14 @@ interface BasePart extends PVInstance {
|
|
|
30987
30782
|
string | undefined
|
|
30988
30783
|
]>;
|
|
30989
30784
|
/**
|
|
30785
|
+
* Returns the closest point on the part's surface to the given point.
|
|
30786
|
+
*
|
|
30990
30787
|
* - **ThreadSafety**: Unsafe
|
|
30991
30788
|
*
|
|
30992
30789
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#GetClosestPointOnSurface)
|
|
30993
30790
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
30994
|
-
* @param position
|
|
30791
|
+
* @param position The world-space point to find the closest surface point to.
|
|
30792
|
+
* @returns The closest point on the part's surface in world space.
|
|
30995
30793
|
*/
|
|
30996
30794
|
GetClosestPointOnSurface(this: BasePart, position: Vector3): Vector3;
|
|
30997
30795
|
/**
|
|
@@ -31077,7 +30875,7 @@ interface BasePart extends PVInstance {
|
|
|
31077
30875
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
31078
30876
|
* @returns The base part of an assembly (a collection of parts connected together).
|
|
31079
30877
|
*
|
|
31080
|
-
* @deprecated
|
|
30878
|
+
* @deprecated
|
|
31081
30879
|
*/
|
|
31082
30880
|
GetRootPart(this: BasePart): BasePart;
|
|
31083
30881
|
/**
|
|
@@ -31249,7 +31047,7 @@ interface BasePart extends PVInstance {
|
|
|
31249
31047
|
*
|
|
31250
31048
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#StoppedTouching)
|
|
31251
31049
|
*
|
|
31252
|
-
* @deprecated
|
|
31050
|
+
* @deprecated
|
|
31253
31051
|
*/
|
|
31254
31052
|
readonly StoppedTouching: RBXScriptSignal<(otherPart: BasePart) => void>;
|
|
31255
31053
|
/**
|
|
@@ -31350,20 +31148,6 @@ interface Platform extends Part {
|
|
|
31350
31148
|
* @deprecated
|
|
31351
31149
|
*/
|
|
31352
31150
|
readonly _nominal_Platform: unique symbol;
|
|
31353
|
-
/**
|
|
31354
|
-
* - **ThreadSafety**: Unsafe
|
|
31355
|
-
* - **Tags**: Hidden
|
|
31356
|
-
*
|
|
31357
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Platform#RemoteCreateMotor6D)
|
|
31358
|
-
*/
|
|
31359
|
-
readonly RemoteCreateMotor6D: RBXScriptSignal<(humanoid: Humanoid) => void>;
|
|
31360
|
-
/**
|
|
31361
|
-
* - **ThreadSafety**: Unsafe
|
|
31362
|
-
* - **Tags**: Hidden
|
|
31363
|
-
*
|
|
31364
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Platform#RemoteDestroyMotor6D)
|
|
31365
|
-
*/
|
|
31366
|
-
readonly RemoteDestroyMotor6D: RBXScriptSignal<() => void>;
|
|
31367
31151
|
}
|
|
31368
31152
|
/**
|
|
31369
31153
|
* A type of `BasePart` that characters can 'sit' in. When a character touches an enabled Seat object, it will be attached to the part by a `Weld` and the default character scripts will play a sitting animation.
|
|
@@ -31406,20 +31190,6 @@ interface Seat extends Part {
|
|
|
31406
31190
|
* @param humanoid
|
|
31407
31191
|
*/
|
|
31408
31192
|
Sit(this: Seat, humanoid: Humanoid | undefined): void;
|
|
31409
|
-
/**
|
|
31410
|
-
* - **ThreadSafety**: Unsafe
|
|
31411
|
-
* - **Tags**: Hidden
|
|
31412
|
-
*
|
|
31413
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Seat#RemoteCreateSeatWeld)
|
|
31414
|
-
*/
|
|
31415
|
-
readonly RemoteCreateSeatWeld: RBXScriptSignal<(humanoid: Humanoid) => void>;
|
|
31416
|
-
/**
|
|
31417
|
-
* - **ThreadSafety**: Unsafe
|
|
31418
|
-
* - **Tags**: Hidden
|
|
31419
|
-
*
|
|
31420
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Seat#RemoteDestroySeatWeld)
|
|
31421
|
-
*/
|
|
31422
|
-
readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
|
|
31423
31193
|
}
|
|
31424
31194
|
/**
|
|
31425
31195
|
* **Deprecated:** The SkateboardPlatform object has been deprecated and is no longer supported by Roblox. Developers looking to create skateboards or similar vehicles are advised to program their own systems. Additionally, the `VehicleSeat` object can be used to quickly create simple vehicles.
|
|
@@ -31511,20 +31281,6 @@ interface SkateboardPlatform extends Part {
|
|
|
31511
31281
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#MoveStateChanged)
|
|
31512
31282
|
*/
|
|
31513
31283
|
readonly MoveStateChanged: RBXScriptSignal<(newState: Enum.MoveState, oldState: Enum.MoveState) => void>;
|
|
31514
|
-
/**
|
|
31515
|
-
* - **ThreadSafety**: Unsafe
|
|
31516
|
-
* - **Tags**: Hidden
|
|
31517
|
-
*
|
|
31518
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#RemoteCreateMotor6D)
|
|
31519
|
-
*/
|
|
31520
|
-
readonly RemoteCreateMotor6D: RBXScriptSignal<(humanoid: Humanoid) => void>;
|
|
31521
|
-
/**
|
|
31522
|
-
* - **ThreadSafety**: Unsafe
|
|
31523
|
-
* - **Tags**: Hidden
|
|
31524
|
-
*
|
|
31525
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#RemoteDestroyMotor6D)
|
|
31526
|
-
*/
|
|
31527
|
-
readonly RemoteDestroyMotor6D: RBXScriptSignal<() => void>;
|
|
31528
31284
|
/**
|
|
31529
31285
|
* Fired whenever the skateboard is unequipped.
|
|
31530
31286
|
*
|
|
@@ -31834,12 +31590,6 @@ interface Terrain extends BasePart {
|
|
|
31834
31590
|
* @param material The material with which the wedge will be filled.
|
|
31835
31591
|
*/
|
|
31836
31592
|
FillWedge(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>): void;
|
|
31837
|
-
/**
|
|
31838
|
-
* - **ThreadSafety**: Unsafe
|
|
31839
|
-
*
|
|
31840
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetBaseMaterialSlotIndex)
|
|
31841
|
-
*/
|
|
31842
|
-
GetBaseMaterialSlotIndex(this: Terrain, baseMaterial: CastsToEnum<Enum.Material>): number | undefined;
|
|
31843
31593
|
/**
|
|
31844
31594
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31845
31595
|
*
|
|
@@ -31857,12 +31607,6 @@ interface Terrain extends BasePart {
|
|
|
31857
31607
|
* @deprecated
|
|
31858
31608
|
*/
|
|
31859
31609
|
GetCell(this: Terrain, x: number, y: number, z: number): unknown;
|
|
31860
|
-
/**
|
|
31861
|
-
* - **ThreadSafety**: Unsafe
|
|
31862
|
-
*
|
|
31863
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetFirstCustomMaterialSlotIndex)
|
|
31864
|
-
*/
|
|
31865
|
-
GetFirstCustomMaterialSlotIndex(this: Terrain): number;
|
|
31866
31610
|
/**
|
|
31867
31611
|
* Returns current terrain material color for specified terrain material.
|
|
31868
31612
|
*
|
|
@@ -32303,11 +32047,10 @@ interface PartOperation extends TriangleMeshPart {
|
|
|
32303
32047
|
* The number of polygons in this solid model.
|
|
32304
32048
|
*
|
|
32305
32049
|
* - **ThreadSafety**: ReadSafe
|
|
32306
|
-
* - **Tags**: NotReplicated
|
|
32307
32050
|
*
|
|
32308
32051
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PartOperation#TriangleCount)
|
|
32309
32052
|
*/
|
|
32310
|
-
|
|
32053
|
+
get TriangleCount(): number;
|
|
32311
32054
|
/**
|
|
32312
32055
|
* Sets whether the `PartOperation` can be recolored using inherited color properties.
|
|
32313
32056
|
*
|
|
@@ -32512,20 +32255,6 @@ interface VehicleSeat extends BasePart {
|
|
|
32512
32255
|
* @param humanoid The `Humanoid` being forced to sit in the `VehicleSeat`.
|
|
32513
32256
|
*/
|
|
32514
32257
|
Sit(this: VehicleSeat, humanoid: Instance): void;
|
|
32515
|
-
/**
|
|
32516
|
-
* - **ThreadSafety**: Unsafe
|
|
32517
|
-
* - **Tags**: Hidden
|
|
32518
|
-
*
|
|
32519
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#RemoteCreateSeatWeld)
|
|
32520
|
-
*/
|
|
32521
|
-
readonly RemoteCreateSeatWeld: RBXScriptSignal<(humanoid: Instance) => void>;
|
|
32522
|
-
/**
|
|
32523
|
-
* - **ThreadSafety**: Unsafe
|
|
32524
|
-
* - **Tags**: Hidden
|
|
32525
|
-
*
|
|
32526
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#RemoteDestroySeatWeld)
|
|
32527
|
-
*/
|
|
32528
|
-
readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
|
|
32529
32258
|
}
|
|
32530
32259
|
/**
|
|
32531
32260
|
* A class which defines a view of the 3D world.
|
|
@@ -32575,7 +32304,7 @@ interface Camera extends PVInstance {
|
|
|
32575
32304
|
*
|
|
32576
32305
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CoordinateFrame)
|
|
32577
32306
|
*
|
|
32578
|
-
* @deprecated
|
|
32307
|
+
* @deprecated
|
|
32579
32308
|
*/
|
|
32580
32309
|
CoordinateFrame: CFrame;
|
|
32581
32310
|
/**
|
|
@@ -32986,7 +32715,7 @@ interface Model extends PVInstance {
|
|
|
32986
32715
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetModelCFrame)
|
|
32987
32716
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
32988
32717
|
*
|
|
32989
|
-
* @deprecated
|
|
32718
|
+
* @deprecated
|
|
32990
32719
|
*/
|
|
32991
32720
|
GetModelCFrame(this: Model): CFrame;
|
|
32992
32721
|
/**
|
|
@@ -33000,7 +32729,7 @@ interface Model extends PVInstance {
|
|
|
33000
32729
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetModelSize)
|
|
33001
32730
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
33002
32731
|
*
|
|
33003
|
-
* @deprecated
|
|
32732
|
+
* @deprecated
|
|
33004
32733
|
*/
|
|
33005
32734
|
GetModelSize(this: Model): Vector3;
|
|
33006
32735
|
/**
|
|
@@ -33024,7 +32753,7 @@ interface Model extends PVInstance {
|
|
|
33024
32753
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetPrimaryPartCFrame)
|
|
33025
32754
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
33026
32755
|
*
|
|
33027
|
-
* @deprecated
|
|
32756
|
+
* @deprecated
|
|
33028
32757
|
*/
|
|
33029
32758
|
GetPrimaryPartCFrame(this: Model): CFrame;
|
|
33030
32759
|
/**
|
|
@@ -33082,7 +32811,7 @@ interface Model extends PVInstance {
|
|
|
33082
32811
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#ResetOrientationToIdentity)
|
|
33083
32812
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
33084
32813
|
*
|
|
33085
|
-
* @deprecated
|
|
32814
|
+
* @deprecated
|
|
33086
32815
|
*/
|
|
33087
32816
|
ResetOrientationToIdentity(this: Model): void;
|
|
33088
32817
|
/**
|
|
@@ -33106,7 +32835,7 @@ interface Model extends PVInstance {
|
|
|
33106
32835
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#SetIdentityOrientation)
|
|
33107
32836
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
33108
32837
|
*
|
|
33109
|
-
* @deprecated
|
|
32838
|
+
* @deprecated
|
|
33110
32839
|
*/
|
|
33111
32840
|
SetIdentityOrientation(this: Model): void;
|
|
33112
32841
|
/**
|
|
@@ -33121,7 +32850,7 @@ interface Model extends PVInstance {
|
|
|
33121
32850
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
33122
32851
|
* @param cframe The `CFrame` to be set.
|
|
33123
32852
|
*
|
|
33124
|
-
* @deprecated
|
|
32853
|
+
* @deprecated
|
|
33125
32854
|
*/
|
|
33126
32855
|
SetPrimaryPartCFrame(this: Model, cframe: CFrame): void;
|
|
33127
32856
|
/**
|
|
@@ -33495,7 +33224,7 @@ interface WorldRoot extends Model {
|
|
|
33495
33224
|
* @param ignoreWater
|
|
33496
33225
|
* @returns The `BasePart` or `Terrain` cell hit, the `Vector3` point of intersection, the `Vector3` surface normal at the point of intersection, and the `Material` of the `BasePart` or terrain cell hit.
|
|
33497
33226
|
*
|
|
33498
|
-
* @deprecated
|
|
33227
|
+
* @deprecated
|
|
33499
33228
|
*/
|
|
33500
33229
|
FindPartOnRay(this: WorldRoot, ray: Ray, ignoreDescendantsInstance?: Instance, terrainCellsAreCubes?: boolean, ignoreWater?: boolean): LuaTuple<[
|
|
33501
33230
|
BasePart | undefined,
|
|
@@ -33519,7 +33248,7 @@ interface WorldRoot extends Model {
|
|
|
33519
33248
|
* @param ignoreWater
|
|
33520
33249
|
* @returns The `BasePart` or `Terrain` cell hit, the `Vector3` point of intersection, the `Vector3` surface normal at the point of intersection, and the `Material` of the `BasePart` or terrain cell hit.
|
|
33521
33250
|
*
|
|
33522
|
-
* @deprecated
|
|
33251
|
+
* @deprecated
|
|
33523
33252
|
*/
|
|
33524
33253
|
FindPartOnRayWithIgnoreList(this: WorldRoot, ray: Ray, ignoreDescendantsTable: Array<Instance>, terrainCellsAreCubes?: boolean, ignoreWater?: boolean): LuaTuple<[
|
|
33525
33254
|
BasePart | undefined,
|
|
@@ -33542,7 +33271,7 @@ interface WorldRoot extends Model {
|
|
|
33542
33271
|
* @param ignoreWater
|
|
33543
33272
|
* @returns The `BasePart` or `Terrain` cell hit, the `Vector3` point of intersection, the `Vector3` surface normal at the point of intersection, and the `Material` of the `BasePart` or terrain cell hit.
|
|
33544
33273
|
*
|
|
33545
|
-
* @deprecated
|
|
33274
|
+
* @deprecated
|
|
33546
33275
|
*/
|
|
33547
33276
|
FindPartOnRayWithWhitelist(this: WorldRoot, ray: Ray, whitelistDescendantsTable: Array<Instance>, ignoreWater?: boolean): LuaTuple<[
|
|
33548
33277
|
BasePart | undefined,
|
|
@@ -33565,7 +33294,7 @@ interface WorldRoot extends Model {
|
|
|
33565
33294
|
* @param maxParts The maximum amount of `BaseParts` to be returned.
|
|
33566
33295
|
* @returns An array of `BaseParts` within the `Region3`.
|
|
33567
33296
|
*
|
|
33568
|
-
* @deprecated
|
|
33297
|
+
* @deprecated
|
|
33569
33298
|
*/
|
|
33570
33299
|
FindPartsInRegion3(this: WorldRoot, region: Region3, ignoreDescendantsInstance?: Instance, maxParts?: number): Array<BasePart>;
|
|
33571
33300
|
/**
|
|
@@ -33583,7 +33312,7 @@ interface WorldRoot extends Model {
|
|
|
33583
33312
|
* @param maxParts The maximum number of `BaseParts` to be returned.
|
|
33584
33313
|
* @returns An array of `BaseParts` found within the `Region3`.
|
|
33585
33314
|
*
|
|
33586
|
-
* @deprecated
|
|
33315
|
+
* @deprecated
|
|
33587
33316
|
*/
|
|
33588
33317
|
FindPartsInRegion3WithIgnoreList(this: WorldRoot, region: Region3, ignoreDescendantsTable: Array<Instance>, maxParts?: number): Array<BasePart>;
|
|
33589
33318
|
/**
|
|
@@ -33601,7 +33330,7 @@ interface WorldRoot extends Model {
|
|
|
33601
33330
|
* @param maxParts The maximum number of `BaseParts` to be returned.
|
|
33602
33331
|
* @returns An array of `BaseParts` within the `Region3`.
|
|
33603
33332
|
*
|
|
33604
|
-
* @deprecated
|
|
33333
|
+
* @deprecated
|
|
33605
33334
|
*/
|
|
33606
33335
|
FindPartsInRegion3WithWhiteList(this: WorldRoot, region: Region3, whitelistDescendantsTable: Array<Instance>, maxParts?: number): Array<BasePart>;
|
|
33607
33336
|
/**
|
|
@@ -33659,7 +33388,7 @@ interface WorldRoot extends Model {
|
|
|
33659
33388
|
* @param ignoreDescendentsInstance An `Instance` to be ignored.
|
|
33660
33389
|
* @returns True if the `Region3` is empty.
|
|
33661
33390
|
*
|
|
33662
|
-
* @deprecated
|
|
33391
|
+
* @deprecated
|
|
33663
33392
|
*/
|
|
33664
33393
|
IsRegion3Empty(this: WorldRoot, region: Region3, ignoreDescendentsInstance?: Instance): boolean;
|
|
33665
33394
|
/**
|
|
@@ -33676,7 +33405,7 @@ interface WorldRoot extends Model {
|
|
|
33676
33405
|
* @param ignoreDescendentsTable An array of objects to be ignored.
|
|
33677
33406
|
* @returns True if the `Region3` is empty.
|
|
33678
33407
|
*
|
|
33679
|
-
* @deprecated
|
|
33408
|
+
* @deprecated
|
|
33680
33409
|
*/
|
|
33681
33410
|
IsRegion3EmptyWithIgnoreList(this: WorldRoot, region: Region3, ignoreDescendentsTable: Array<Instance>): boolean;
|
|
33682
33411
|
/**
|
|
@@ -33718,7 +33447,7 @@ interface WorldRoot extends Model {
|
|
|
33718
33447
|
Spherecast(this: WorldRoot, position: Vector3, radius: number, direction: Vector3, raycastParams?: RaycastParams): RaycastResult | undefined;
|
|
33719
33448
|
}
|
|
33720
33449
|
/**
|
|
33721
|
-
*
|
|
33450
|
+
* `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33722
33451
|
*
|
|
33723
33452
|
* - **Tags**: NotCreatable, Service
|
|
33724
33453
|
*
|
|
@@ -33867,7 +33596,7 @@ interface Workspace extends WorldRoot {
|
|
|
33867
33596
|
* - **ThreadSafety**: Safe
|
|
33868
33597
|
*
|
|
33869
33598
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#GetNumAwakeParts)
|
|
33870
|
-
* @param this
|
|
33599
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33871
33600
|
* @returns The number of awake parts.
|
|
33872
33601
|
*/
|
|
33873
33602
|
GetNumAwakeParts(this: Workspace): number;
|
|
@@ -33877,7 +33606,7 @@ interface Workspace extends WorldRoot {
|
|
|
33877
33606
|
* - **ThreadSafety**: Safe
|
|
33878
33607
|
*
|
|
33879
33608
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#GetPhysicsThrottling)
|
|
33880
|
-
* @param this
|
|
33609
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33881
33610
|
* @returns The percentage of real time that physics simulation is currently being throttled to.
|
|
33882
33611
|
*/
|
|
33883
33612
|
GetPhysicsThrottling(this: Workspace): number;
|
|
@@ -33887,7 +33616,7 @@ interface Workspace extends WorldRoot {
|
|
|
33887
33616
|
* - **ThreadSafety**: Safe
|
|
33888
33617
|
*
|
|
33889
33618
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#GetRealPhysicsFPS)
|
|
33890
|
-
* @param this
|
|
33619
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33891
33620
|
* @returns Returns the number of frames per second that physics is currently being simulated at.
|
|
33892
33621
|
*/
|
|
33893
33622
|
GetRealPhysicsFPS(this: Workspace): number;
|
|
@@ -33897,7 +33626,7 @@ interface Workspace extends WorldRoot {
|
|
|
33897
33626
|
* - **ThreadSafety**: Safe
|
|
33898
33627
|
*
|
|
33899
33628
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#GetServerTimeNow)
|
|
33900
|
-
* @param this
|
|
33629
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33901
33630
|
* @returns The estimated Unix timestamp on the server.
|
|
33902
33631
|
*/
|
|
33903
33632
|
GetServerTimeNow(this: Workspace): number;
|
|
@@ -33907,7 +33636,7 @@ interface Workspace extends WorldRoot {
|
|
|
33907
33636
|
* - **ThreadSafety**: Unsafe
|
|
33908
33637
|
*
|
|
33909
33638
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#JoinToOutsiders)
|
|
33910
|
-
* @param this
|
|
33639
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33911
33640
|
* @param objects An array of `BaseParts` for whom joints are to be made.
|
|
33912
33641
|
* @param jointType The `JointCreationMode` to be used. Passing in `Enum.JointCreationMode.All` or `Enum.JointCreationMode.Surface` has the same behavior which equates to Join Always.
|
|
33913
33642
|
*/
|
|
@@ -33918,7 +33647,7 @@ interface Workspace extends WorldRoot {
|
|
|
33918
33647
|
* - **ThreadSafety**: Unsafe
|
|
33919
33648
|
*
|
|
33920
33649
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#PGSIsEnabled)
|
|
33921
|
-
* @param this
|
|
33650
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33922
33651
|
* @returns True if the PGS solver is enabled.
|
|
33923
33652
|
*/
|
|
33924
33653
|
PGSIsEnabled(this: Workspace): boolean;
|
|
@@ -33928,7 +33657,7 @@ interface Workspace extends WorldRoot {
|
|
|
33928
33657
|
* - **ThreadSafety**: Unsafe
|
|
33929
33658
|
*
|
|
33930
33659
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#UnjoinFromOutsiders)
|
|
33931
|
-
* @param this
|
|
33660
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33932
33661
|
* @param objects An array of `BaseParts` for whom joints are to be broken.
|
|
33933
33662
|
*/
|
|
33934
33663
|
UnjoinFromOutsiders(this: Workspace, objects: Array<Instance>): void;
|
|
@@ -33978,6 +33707,13 @@ interface PackageLink extends Instance {
|
|
|
33978
33707
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PackageLink#DefaultName)
|
|
33979
33708
|
*/
|
|
33980
33709
|
get DefaultName(): string;
|
|
33710
|
+
/**
|
|
33711
|
+
* - **ThreadSafety**: ReadSafe
|
|
33712
|
+
* - **Tags**: NotReplicated
|
|
33713
|
+
*
|
|
33714
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PackageLink#PackageContent)
|
|
33715
|
+
*/
|
|
33716
|
+
readonly PackageContent: Content;
|
|
33981
33717
|
/**
|
|
33982
33718
|
* The ID of the asset this package corresponds to.
|
|
33983
33719
|
*
|
|
@@ -34600,6 +34336,12 @@ interface ParticleEmitter extends Instance {
|
|
|
34600
34336
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Texture)
|
|
34601
34337
|
*/
|
|
34602
34338
|
Texture: ContentId;
|
|
34339
|
+
/**
|
|
34340
|
+
* - **ThreadSafety**: ReadSafe
|
|
34341
|
+
*
|
|
34342
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#TextureContent)
|
|
34343
|
+
*/
|
|
34344
|
+
TextureContent: Content;
|
|
34603
34345
|
/**
|
|
34604
34346
|
* Value between 0 and 1 that controls the speed of the particle effect.
|
|
34605
34347
|
*
|
|
@@ -34634,7 +34376,7 @@ interface ParticleEmitter extends Instance {
|
|
|
34634
34376
|
*
|
|
34635
34377
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#VelocitySpread)
|
|
34636
34378
|
*
|
|
34637
|
-
* @deprecated
|
|
34379
|
+
* @deprecated
|
|
34638
34380
|
*/
|
|
34639
34381
|
VelocitySpread: number;
|
|
34640
34382
|
/**
|
|
@@ -34672,20 +34414,6 @@ interface ParticleEmitter extends Instance {
|
|
|
34672
34414
|
* @param particleCount The number of particles to emit.
|
|
34673
34415
|
*/
|
|
34674
34416
|
Emit(this: ParticleEmitter, particleCount?: number): void;
|
|
34675
|
-
/**
|
|
34676
|
-
* - **ThreadSafety**: Unsafe
|
|
34677
|
-
* - **Tags**: Hidden
|
|
34678
|
-
*
|
|
34679
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#OnClearRequested)
|
|
34680
|
-
*/
|
|
34681
|
-
readonly OnClearRequested: RBXScriptSignal<() => void>;
|
|
34682
|
-
/**
|
|
34683
|
-
* - **ThreadSafety**: Unsafe
|
|
34684
|
-
* - **Tags**: Hidden
|
|
34685
|
-
*
|
|
34686
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#OnEmitRequested)
|
|
34687
|
-
*/
|
|
34688
|
-
readonly OnEmitRequested: RBXScriptSignal<(particleCount: number) => void>;
|
|
34689
34417
|
}
|
|
34690
34418
|
/**
|
|
34691
34419
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -34786,7 +34514,7 @@ interface Path extends Instance {
|
|
|
34786
34514
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path#GetPointCoordinates)
|
|
34787
34515
|
* @param this Stores the result of paths created by `PathfindingService:CreatePath()`.
|
|
34788
34516
|
*
|
|
34789
|
-
* @deprecated
|
|
34517
|
+
* @deprecated
|
|
34790
34518
|
*/
|
|
34791
34519
|
GetPointCoordinates(this: Path): Array<unknown>;
|
|
34792
34520
|
/**
|
|
@@ -34970,7 +34698,7 @@ interface PathfindingService extends Instance {
|
|
|
34970
34698
|
* @param maxDistance
|
|
34971
34699
|
* @returns A `Path` object.
|
|
34972
34700
|
*
|
|
34973
|
-
* @deprecated
|
|
34701
|
+
* @deprecated
|
|
34974
34702
|
*/
|
|
34975
34703
|
ComputeRawPathAsync(this: PathfindingService, start: Vector3, finish: Vector3, maxDistance: number): Path;
|
|
34976
34704
|
/**
|
|
@@ -34987,7 +34715,7 @@ interface PathfindingService extends Instance {
|
|
|
34987
34715
|
* @param finish
|
|
34988
34716
|
* @param maxDistance
|
|
34989
34717
|
*
|
|
34990
|
-
* @deprecated
|
|
34718
|
+
* @deprecated
|
|
34991
34719
|
*/
|
|
34992
34720
|
ComputeSmoothPathAsync(this: PathfindingService, start: Vector3, finish: Vector3, maxDistance: number): Path;
|
|
34993
34721
|
/**
|
|
@@ -35091,7 +34819,7 @@ interface PhysicsService extends Instance {
|
|
|
35091
34819
|
* @param name
|
|
35092
34820
|
* @param part
|
|
35093
34821
|
*
|
|
35094
|
-
* @deprecated
|
|
34822
|
+
* @deprecated
|
|
35095
34823
|
*/
|
|
35096
34824
|
CollisionGroupContainsPart(this: PhysicsService, name: string, part: BasePart): boolean;
|
|
35097
34825
|
/**
|
|
@@ -35129,7 +34857,7 @@ interface PhysicsService extends Instance {
|
|
|
35129
34857
|
* @param this
|
|
35130
34858
|
* @param name
|
|
35131
34859
|
*
|
|
35132
|
-
* @deprecated
|
|
34860
|
+
* @deprecated
|
|
35133
34861
|
*/
|
|
35134
34862
|
CreateCollisionGroup(this: PhysicsService, name: string): number;
|
|
35135
34863
|
/**
|
|
@@ -35145,7 +34873,7 @@ interface PhysicsService extends Instance {
|
|
|
35145
34873
|
* @param name The name of the collision group being retrieved.
|
|
35146
34874
|
* @returns The ID of the retrieved collision group, or `nil` if no such group exists.
|
|
35147
34875
|
*
|
|
35148
|
-
* @deprecated
|
|
34876
|
+
* @deprecated
|
|
35149
34877
|
*/
|
|
35150
34878
|
GetCollisionGroupId(this: PhysicsService, name: string): number;
|
|
35151
34879
|
/**
|
|
@@ -35160,7 +34888,7 @@ interface PhysicsService extends Instance {
|
|
|
35160
34888
|
* @param this
|
|
35161
34889
|
* @param name
|
|
35162
34890
|
*
|
|
35163
|
-
* @deprecated
|
|
34891
|
+
* @deprecated
|
|
35164
34892
|
*/
|
|
35165
34893
|
GetCollisionGroupName(this: PhysicsService, name: number): string;
|
|
35166
34894
|
/**
|
|
@@ -35174,7 +34902,7 @@ interface PhysicsService extends Instance {
|
|
|
35174
34902
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetCollisionGroups)
|
|
35175
34903
|
* @param this
|
|
35176
34904
|
*
|
|
35177
|
-
* @deprecated
|
|
34905
|
+
* @deprecated
|
|
35178
34906
|
*/
|
|
35179
34907
|
GetCollisionGroups(this: PhysicsService): Array<CollisionGroupInfo & {
|
|
35180
34908
|
id: number;
|
|
@@ -35229,7 +34957,7 @@ interface PhysicsService extends Instance {
|
|
|
35229
34957
|
* @param this
|
|
35230
34958
|
* @param name
|
|
35231
34959
|
*
|
|
35232
|
-
* @deprecated
|
|
34960
|
+
* @deprecated
|
|
35233
34961
|
*/
|
|
35234
34962
|
RemoveCollisionGroup(this: PhysicsService, name: string): void;
|
|
35235
34963
|
/**
|
|
@@ -35256,7 +34984,7 @@ interface PhysicsService extends Instance {
|
|
|
35256
34984
|
* @param part The part being set.
|
|
35257
34985
|
* @param name The name of collision group that the part's collision group is being set to.
|
|
35258
34986
|
*
|
|
35259
|
-
* @deprecated
|
|
34987
|
+
* @deprecated
|
|
35260
34988
|
*/
|
|
35261
34989
|
SetPartCollisionGroup(this: PhysicsService, part: BasePart, name: string): void;
|
|
35262
34990
|
/**
|
|
@@ -35383,6 +35111,12 @@ interface Player extends Instance {
|
|
|
35383
35111
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#AccountAge)
|
|
35384
35112
|
*/
|
|
35385
35113
|
readonly AccountAge: number;
|
|
35114
|
+
/**
|
|
35115
|
+
* - **ThreadSafety**: ReadSafe
|
|
35116
|
+
*
|
|
35117
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#AgeChecked)
|
|
35118
|
+
*/
|
|
35119
|
+
get AgeChecked(): Enum.AgeCheckStatus;
|
|
35386
35120
|
/**
|
|
35387
35121
|
* Determines whether the character of a player using a mobile device will automatically jump upon hitting an obstacle.
|
|
35388
35122
|
*
|
|
@@ -35441,7 +35175,7 @@ interface Player extends Instance {
|
|
|
35441
35175
|
*
|
|
35442
35176
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#CharacterAppearance)
|
|
35443
35177
|
*
|
|
35444
|
-
* @deprecated
|
|
35178
|
+
* @deprecated
|
|
35445
35179
|
*/
|
|
35446
35180
|
CharacterAppearance: string;
|
|
35447
35181
|
/**
|
|
@@ -35652,6 +35386,14 @@ interface Player extends Instance {
|
|
|
35652
35386
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#TeamColor)
|
|
35653
35387
|
*/
|
|
35654
35388
|
TeamColor: BrickColor;
|
|
35389
|
+
/**
|
|
35390
|
+
* The `User` representing this player's domain-scoped identity within the current experience.
|
|
35391
|
+
*
|
|
35392
|
+
* - **ThreadSafety**: ReadSafe
|
|
35393
|
+
*
|
|
35394
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#User)
|
|
35395
|
+
*/
|
|
35396
|
+
get User(): User;
|
|
35655
35397
|
/**
|
|
35656
35398
|
* A unique identifying integer assigned to all user accounts.
|
|
35657
35399
|
*
|
|
@@ -35671,9 +35413,12 @@ interface Player extends Instance {
|
|
|
35671
35413
|
*/
|
|
35672
35414
|
AddReplicationFocus(this: Player, part: BasePart): void;
|
|
35673
35415
|
/**
|
|
35416
|
+
* Clears the cached avatar appearance for the player, forcing a fresh fetch from the backend on the next respawn.
|
|
35417
|
+
*
|
|
35674
35418
|
* - **ThreadSafety**: Unsafe
|
|
35675
35419
|
*
|
|
35676
35420
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#ClearCachedAvatarAppearance)
|
|
35421
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
35677
35422
|
*/
|
|
35678
35423
|
ClearCachedAvatarAppearance(this: Player): void;
|
|
35679
35424
|
/**
|
|
@@ -35847,6 +35592,12 @@ interface Player extends Instance {
|
|
|
35847
35592
|
* @param relativeToCamera A boolean indicating whether the player should move relative to the player's camera.
|
|
35848
35593
|
*/
|
|
35849
35594
|
Move(this: Player, walkDirection: Vector3, relativeToCamera?: boolean): void;
|
|
35595
|
+
/**
|
|
35596
|
+
* - **ThreadSafety**: Unsafe
|
|
35597
|
+
*
|
|
35598
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#PromptAgeCheck)
|
|
35599
|
+
*/
|
|
35600
|
+
PromptAgeCheck(this: Player): void;
|
|
35850
35601
|
/**
|
|
35851
35602
|
* Removes a previously added replication focus.
|
|
35852
35603
|
*
|
|
@@ -35934,7 +35685,7 @@ interface Player extends Instance {
|
|
|
35934
35685
|
* @param maxFriends The maximum number of online friends to return.
|
|
35935
35686
|
* @returns A dictionary of online friends (see the table above).
|
|
35936
35687
|
*
|
|
35937
|
-
* @deprecated
|
|
35688
|
+
* @deprecated
|
|
35938
35689
|
*/
|
|
35939
35690
|
GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
|
|
35940
35691
|
/**
|
|
@@ -35971,10 +35722,12 @@ interface Player extends Instance {
|
|
|
35971
35722
|
* @param groupId The `groupId` of the specified group.
|
|
35972
35723
|
* @returns The player's rank in the group.
|
|
35973
35724
|
*
|
|
35974
|
-
* @deprecated
|
|
35725
|
+
* @deprecated
|
|
35975
35726
|
*/
|
|
35976
35727
|
GetRankInGroup(this: Player, groupId: number): number;
|
|
35977
35728
|
/**
|
|
35729
|
+
* **Deprecated:** This method only returns a single role rank and may produce arbitrary results when a user holds multiple roles. Use `GroupService:GetRolesInGroupAsync()` instead, which returns all roles.
|
|
35730
|
+
*
|
|
35978
35731
|
* Returns the player's rank in the group as an integer.
|
|
35979
35732
|
*
|
|
35980
35733
|
* - **ThreadSafety**: Unsafe
|
|
@@ -35985,7 +35738,7 @@ interface Player extends Instance {
|
|
|
35985
35738
|
* @param groupId The `groupId` of the specified group.
|
|
35986
35739
|
* @returns The player's rank in the group.
|
|
35987
35740
|
*
|
|
35988
|
-
* @deprecated
|
|
35741
|
+
* @deprecated
|
|
35989
35742
|
*/
|
|
35990
35743
|
GetRankInGroupAsync(this: Player, groupId: number): number;
|
|
35991
35744
|
/**
|
|
@@ -36001,10 +35754,12 @@ interface Player extends Instance {
|
|
|
36001
35754
|
* @param groupId The group ID of the specified group.
|
|
36002
35755
|
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
36003
35756
|
*
|
|
36004
|
-
* @deprecated
|
|
35757
|
+
* @deprecated
|
|
36005
35758
|
*/
|
|
36006
35759
|
GetRoleInGroup(this: Player, groupId: number): string;
|
|
36007
35760
|
/**
|
|
35761
|
+
* **Deprecated:** This method only returns a single role name and may produce arbitrary results when a user holds multiple roles. Use `GroupService:GetRolesInGroupAsync()` instead, which returns all roles.
|
|
35762
|
+
*
|
|
36008
35763
|
* Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
|
|
36009
35764
|
*
|
|
36010
35765
|
* - **ThreadSafety**: Unsafe
|
|
@@ -36015,7 +35770,7 @@ interface Player extends Instance {
|
|
|
36015
35770
|
* @param groupId The group ID of the specified group.
|
|
36016
35771
|
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
36017
35772
|
*
|
|
36018
|
-
* @deprecated
|
|
35773
|
+
* @deprecated
|
|
36019
35774
|
*/
|
|
36020
35775
|
GetRoleInGroupAsync(this: Player, groupId: number): string;
|
|
36021
35776
|
/**
|
|
@@ -36032,7 +35787,7 @@ interface Player extends Instance {
|
|
|
36032
35787
|
*
|
|
36033
35788
|
* @deprecated
|
|
36034
35789
|
*/
|
|
36035
|
-
IsBestFriendsWith(this: Player, userId:
|
|
35790
|
+
IsBestFriendsWith(this: Player, userId: User): boolean;
|
|
36036
35791
|
/**
|
|
36037
35792
|
* **Deprecated:** This method has been superseded by the `Player:IsFriendsWithAsync()` method which should be used for new work.
|
|
36038
35793
|
*
|
|
@@ -36046,9 +35801,9 @@ interface Player extends Instance {
|
|
|
36046
35801
|
* @param userId The `Player.UserId` of the specified player.
|
|
36047
35802
|
* @returns A boolean indicating whether a player is a friend of the specified user.
|
|
36048
35803
|
*
|
|
36049
|
-
* @deprecated
|
|
35804
|
+
* @deprecated
|
|
36050
35805
|
*/
|
|
36051
|
-
IsFriendsWith(this: Player, userId:
|
|
35806
|
+
IsFriendsWith(this: Player, userId: User): boolean;
|
|
36052
35807
|
/**
|
|
36053
35808
|
* Checks whether a player is a friend of the user with the given `Player.UserId`.
|
|
36054
35809
|
*
|
|
@@ -36060,7 +35815,7 @@ interface Player extends Instance {
|
|
|
36060
35815
|
* @param userId The `Player.UserId` of the specified player.
|
|
36061
35816
|
* @returns A boolean indicating whether a player is a friend of the specified user.
|
|
36062
35817
|
*/
|
|
36063
|
-
IsFriendsWithAsync(this: Player, userId:
|
|
35818
|
+
IsFriendsWithAsync(this: Player, userId: User): boolean;
|
|
36064
35819
|
/**
|
|
36065
35820
|
* **Deprecated:** This method has been superseded by `IsInGroupAsync()`.
|
|
36066
35821
|
*
|
|
@@ -36074,7 +35829,7 @@ interface Player extends Instance {
|
|
|
36074
35829
|
* @param groupId The group ID of the specified group.
|
|
36075
35830
|
* @returns A boolean indicating whether the player is in the specified group.
|
|
36076
35831
|
*
|
|
36077
|
-
* @deprecated
|
|
35832
|
+
* @deprecated
|
|
36078
35833
|
*/
|
|
36079
35834
|
IsInGroup(this: Player, groupId: number): boolean;
|
|
36080
35835
|
/**
|
|
@@ -36100,7 +35855,7 @@ interface Player extends Instance {
|
|
|
36100
35855
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacter)
|
|
36101
35856
|
* @param this An object that represents a presently connected client to the experience.
|
|
36102
35857
|
*
|
|
36103
|
-
* @deprecated
|
|
35858
|
+
* @deprecated
|
|
36104
35859
|
*/
|
|
36105
35860
|
LoadCharacter(this: Player): void;
|
|
36106
35861
|
/**
|
|
@@ -36126,7 +35881,7 @@ interface Player extends Instance {
|
|
|
36126
35881
|
* @param humanoidDescription A `HumanoidDescription` containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character.
|
|
36127
35882
|
* @param assetTypeVerification The asset type verification mode.
|
|
36128
35883
|
*
|
|
36129
|
-
* @deprecated
|
|
35884
|
+
* @deprecated
|
|
36130
35885
|
*/
|
|
36131
35886
|
LoadCharacterWithHumanoidDescription(this: Player, humanoidDescription: HumanoidDescription): void;
|
|
36132
35887
|
/**
|
|
@@ -36667,7 +36422,7 @@ interface Players extends Instance {
|
|
|
36667
36422
|
*
|
|
36668
36423
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#NumPlayers)
|
|
36669
36424
|
*
|
|
36670
|
-
* @deprecated
|
|
36425
|
+
* @deprecated
|
|
36671
36426
|
*/
|
|
36672
36427
|
readonly NumPlayers: number;
|
|
36673
36428
|
/**
|
|
@@ -36730,7 +36485,8 @@ interface Players extends Instance {
|
|
|
36730
36485
|
* - `Duration` (required; integer) — Duration of the ban, in seconds. Permanent bans should have a value of `-1`. `0` and all other negative values are invalid.
|
|
36731
36486
|
* - `DisplayReason` (required; string) — The message that will be displayed to users when they attempt to and fail to join an experience. Maximum string length is `400`.
|
|
36732
36487
|
* - `PrivateReason` (required; string) — Internal messaging that will be returned when querying the user's ban history. Maximum string length is `1000`.
|
|
36733
|
-
* - `ExcludeAltAccounts` (optional; boolean) — When `true`, Roblox does not attempt to ban
|
|
36488
|
+
* - `ExcludeAltAccounts` (optional; boolean) — When `true`, Roblox does not attempt to ban alternate accounts. Default is `false`.
|
|
36489
|
+
* - `ApplyDeviceBlock` (optional; boolean) — When `true`, Roblox will block banned users' devices from rejoining the experience for 24 hours after the ban is applied. Default is `false`.
|
|
36734
36490
|
*/
|
|
36735
36491
|
BanAsync(this: Players, config: BanAsyncConfig): void;
|
|
36736
36492
|
/**
|
|
@@ -36748,7 +36504,7 @@ interface Players extends Instance {
|
|
|
36748
36504
|
* @param assetTypeVerification The asset type verification mode.
|
|
36749
36505
|
* @returns A `Humanoid` character `Model`.
|
|
36750
36506
|
*
|
|
36751
|
-
* @deprecated
|
|
36507
|
+
* @deprecated
|
|
36752
36508
|
*/
|
|
36753
36509
|
CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
36754
36510
|
/**
|
|
@@ -36778,9 +36534,9 @@ interface Players extends Instance {
|
|
|
36778
36534
|
* @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
|
|
36779
36535
|
* @returns A Humanoid character Model.
|
|
36780
36536
|
*
|
|
36781
|
-
* @deprecated
|
|
36537
|
+
* @deprecated
|
|
36782
36538
|
*/
|
|
36783
|
-
CreateHumanoidModelFromUserId(this: Players, userId:
|
|
36539
|
+
CreateHumanoidModelFromUserId(this: Players, userId: User): Model;
|
|
36784
36540
|
/**
|
|
36785
36541
|
* Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.
|
|
36786
36542
|
*
|
|
@@ -36792,7 +36548,7 @@ interface Players extends Instance {
|
|
|
36792
36548
|
* @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
|
|
36793
36549
|
* @returns A Humanoid character Model.
|
|
36794
36550
|
*/
|
|
36795
|
-
CreateHumanoidModelFromUserIdAsync(this: Players, userId:
|
|
36551
|
+
CreateHumanoidModelFromUserIdAsync(this: Players, userId: User): Model;
|
|
36796
36552
|
/**
|
|
36797
36553
|
* Retrieves the ban and unban history of any user within the experience's universe. This method is enabled and disabled by the `Players.BanningEnabled` property, which you can toggle in Studio.
|
|
36798
36554
|
*
|
|
@@ -36804,7 +36560,7 @@ interface Players extends Instance {
|
|
|
36804
36560
|
* @param userId
|
|
36805
36561
|
* @returns See `BanHistoryPages` for return reference.
|
|
36806
36562
|
*/
|
|
36807
|
-
GetBanHistoryAsync(this: Players, userId:
|
|
36563
|
+
GetBanHistoryAsync(this: Players, userId: User): BanHistoryPages;
|
|
36808
36564
|
/**
|
|
36809
36565
|
* **Deprecated:**
|
|
36810
36566
|
*
|
|
@@ -36819,7 +36575,7 @@ interface Players extends Instance {
|
|
|
36819
36575
|
*
|
|
36820
36576
|
* @deprecated
|
|
36821
36577
|
*/
|
|
36822
|
-
GetCharacterAppearanceAsync(this: Players, userId:
|
|
36578
|
+
GetCharacterAppearanceAsync(this: Players, userId: User): Model;
|
|
36823
36579
|
/**
|
|
36824
36580
|
* Returns information about the character appearance of a given user.
|
|
36825
36581
|
*
|
|
@@ -36842,7 +36598,7 @@ interface Players extends Instance {
|
|
|
36842
36598
|
* @param this A service that contains presently connected `Player` objects.
|
|
36843
36599
|
* @param userId The user ID of the player being specified.
|
|
36844
36600
|
*/
|
|
36845
|
-
GetFriendsAsync(this: Players, userId:
|
|
36601
|
+
GetFriendsAsync(this: Players, userId: User): FriendPages;
|
|
36846
36602
|
/**
|
|
36847
36603
|
* **Deprecated:** This method has been superseded by `GetHumanoidDescriptionFromOutfitIdAsync()`.
|
|
36848
36604
|
*
|
|
@@ -36856,7 +36612,7 @@ interface Players extends Instance {
|
|
|
36856
36612
|
* @param outfitId The ID of the outfit for which the HumanoidDescription is sought.
|
|
36857
36613
|
* @returns HumanoidDescription initialized with the specification for the passed in outfitId.
|
|
36858
36614
|
*
|
|
36859
|
-
* @deprecated
|
|
36615
|
+
* @deprecated
|
|
36860
36616
|
*/
|
|
36861
36617
|
GetHumanoidDescriptionFromOutfitId(this: Players, outfitId: number): HumanoidDescription;
|
|
36862
36618
|
/**
|
|
@@ -36884,9 +36640,9 @@ interface Players extends Instance {
|
|
|
36884
36640
|
* @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
|
|
36885
36641
|
* @returns HumanoidDescription initialized with the passed in user's avatar specification.
|
|
36886
36642
|
*
|
|
36887
|
-
* @deprecated
|
|
36643
|
+
* @deprecated
|
|
36888
36644
|
*/
|
|
36889
|
-
GetHumanoidDescriptionFromUserId(this: Players, userId:
|
|
36645
|
+
GetHumanoidDescriptionFromUserId(this: Players, userId: User): HumanoidDescription;
|
|
36890
36646
|
/**
|
|
36891
36647
|
* Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.
|
|
36892
36648
|
*
|
|
@@ -36898,7 +36654,7 @@ interface Players extends Instance {
|
|
|
36898
36654
|
* @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
|
|
36899
36655
|
* @returns HumanoidDescription initialized with the passed in user's avatar specification.
|
|
36900
36656
|
*/
|
|
36901
|
-
GetHumanoidDescriptionFromUserIdAsync(this: Players, userId:
|
|
36657
|
+
GetHumanoidDescriptionFromUserIdAsync(this: Players, userId: User): HumanoidDescription;
|
|
36902
36658
|
/**
|
|
36903
36659
|
* Sends a query to the Roblox website for the username of an account with a given `UserId`.
|
|
36904
36660
|
*
|
|
@@ -36910,7 +36666,7 @@ interface Players extends Instance {
|
|
|
36910
36666
|
* @param userId The `Player.UserId` of the player being specified.
|
|
36911
36667
|
* @returns The name of a user with the specified `Player.UserId`.
|
|
36912
36668
|
*/
|
|
36913
|
-
GetNameFromUserIdAsync(this: Players, userId:
|
|
36669
|
+
GetNameFromUserIdAsync(this: Players, userId: User): string;
|
|
36914
36670
|
/**
|
|
36915
36671
|
* Sends a query to the Roblox website for the `userId` of an account with a given username.
|
|
36916
36672
|
*
|
|
@@ -38066,7 +37822,7 @@ interface RecommendationService extends Instance {
|
|
|
38066
37822
|
* - `ReferenceId` — The developer-defined string that uniquely identifies the item.
|
|
38067
37823
|
* - `Duration` — The duration of the content in seconds.
|
|
38068
37824
|
* - `Attributes` — The table of attributes for the item, such as `AssetId` or `Description`.
|
|
38069
|
-
* - `CustomTags` — The list of string tags for filtering and boosting.
|
|
37825
|
+
* - `CustomTags` — The list of string tags for filtering and boosting. Individual custom tags can't contain commas.
|
|
38070
37826
|
* - `Visibility` — The `RecommendationItemVisibility` enum that controls the item's visibility, such as `Public` or `Private`.
|
|
38071
37827
|
*
|
|
38072
37828
|
*
|
|
@@ -38094,7 +37850,7 @@ interface RecommendationService extends Instance {
|
|
|
38094
37850
|
* - `Duration` — The new duration for the content in seconds.
|
|
38095
37851
|
* - `Visibility` — The new visibility setting for the item.
|
|
38096
37852
|
* - `Attributes` — The new table of attributes for the item.
|
|
38097
|
-
* - `CustomTags` — The new list of string tags.
|
|
37853
|
+
* - `CustomTags` — The new list of string tags. Individual custom tags can't contain commas.
|
|
38098
37854
|
*/
|
|
38099
37855
|
UpdateItemAsync(this: RecommendationService, updateRecommendationItemRequest: object): void;
|
|
38100
37856
|
}
|
|
@@ -38290,34 +38046,6 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
|
|
|
38290
38046
|
* @returns Values returned from the `OnServerInvoke` callback.
|
|
38291
38047
|
*/
|
|
38292
38048
|
InvokeServer(this: RemoteFunction, ...args: Parameters<T>): ReturnType<T>;
|
|
38293
|
-
/**
|
|
38294
|
-
* - **ThreadSafety**: Unsafe
|
|
38295
|
-
* - **Tags**: Hidden
|
|
38296
|
-
*
|
|
38297
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeClient)
|
|
38298
|
-
*/
|
|
38299
|
-
readonly RemoteOnInvokeClient: RBXScriptSignal<(id: number, arguments: unknown) => void>;
|
|
38300
|
-
/**
|
|
38301
|
-
* - **ThreadSafety**: Unsafe
|
|
38302
|
-
* - **Tags**: Hidden
|
|
38303
|
-
*
|
|
38304
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeError)
|
|
38305
|
-
*/
|
|
38306
|
-
readonly RemoteOnInvokeError: RBXScriptSignal<(id: number, arguments: string) => void>;
|
|
38307
|
-
/**
|
|
38308
|
-
* - **ThreadSafety**: Unsafe
|
|
38309
|
-
* - **Tags**: Hidden
|
|
38310
|
-
*
|
|
38311
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeServer)
|
|
38312
|
-
*/
|
|
38313
|
-
readonly RemoteOnInvokeServer: RBXScriptSignal<(id: number, player: Player, arguments: unknown) => void>;
|
|
38314
|
-
/**
|
|
38315
|
-
* - **ThreadSafety**: Unsafe
|
|
38316
|
-
* - **Tags**: Hidden
|
|
38317
|
-
*
|
|
38318
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeSuccess)
|
|
38319
|
-
*/
|
|
38320
|
-
readonly RemoteOnInvokeSuccess: RBXScriptSignal<(id: number, arguments: unknown) => void>;
|
|
38321
38049
|
/**
|
|
38322
38050
|
* Callback for when the `RemoteFunction` is invoked with `InvokeClient()`.
|
|
38323
38051
|
*
|
|
@@ -38675,6 +38403,12 @@ interface RunService extends Instance {
|
|
|
38675
38403
|
* @returns Whether the current environment is running the client.
|
|
38676
38404
|
*/
|
|
38677
38405
|
IsClient(this: RunService): boolean;
|
|
38406
|
+
/**
|
|
38407
|
+
* - **ThreadSafety**: Safe
|
|
38408
|
+
*
|
|
38409
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#IsResimulating)
|
|
38410
|
+
*/
|
|
38411
|
+
IsResimulating(this: RunService): boolean;
|
|
38678
38412
|
/**
|
|
38679
38413
|
* Returns whether a **Run** playtest has been initiated in Studio.
|
|
38680
38414
|
*
|
|
@@ -38956,6 +38690,12 @@ interface ScreenshotHud extends Instance {
|
|
|
38956
38690
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#CameraButtonIcon)
|
|
38957
38691
|
*/
|
|
38958
38692
|
CameraButtonIcon: ContentId;
|
|
38693
|
+
/**
|
|
38694
|
+
* - **ThreadSafety**: ReadSafe
|
|
38695
|
+
*
|
|
38696
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#CameraButtonIconContent)
|
|
38697
|
+
*/
|
|
38698
|
+
CameraButtonIconContent: Content;
|
|
38959
38699
|
/**
|
|
38960
38700
|
* Screen location of the camera button.
|
|
38961
38701
|
*
|
|
@@ -39101,7 +38841,7 @@ interface SyncScriptBuilder extends ScriptBuilder {
|
|
|
39101
38841
|
*
|
|
39102
38842
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SyncScriptBuilder#RawBytecode)
|
|
39103
38843
|
*
|
|
39104
|
-
* @deprecated
|
|
38844
|
+
* @deprecated
|
|
39105
38845
|
*/
|
|
39106
38846
|
RawBytecode: boolean;
|
|
39107
38847
|
}
|
|
@@ -39799,7 +39539,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39799
39539
|
*
|
|
39800
39540
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#VIPServerId)
|
|
39801
39541
|
*
|
|
39802
|
-
* @deprecated
|
|
39542
|
+
* @deprecated
|
|
39803
39543
|
*/
|
|
39804
39544
|
readonly VIPServerId: string;
|
|
39805
39545
|
/**
|
|
@@ -39812,7 +39552,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39812
39552
|
*
|
|
39813
39553
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#VIPServerOwnerId)
|
|
39814
39554
|
*
|
|
39815
|
-
* @deprecated
|
|
39555
|
+
* @deprecated
|
|
39816
39556
|
*/
|
|
39817
39557
|
readonly VIPServerOwnerId: number;
|
|
39818
39558
|
/**
|
|
@@ -39951,6 +39691,12 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39951
39691
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#ServerLifecycleChanged)
|
|
39952
39692
|
*/
|
|
39953
39693
|
readonly ServerLifecycleChanged: RBXScriptSignal<(serverLifecycleChangedEvent: object) => void>;
|
|
39694
|
+
/**
|
|
39695
|
+
* - **ThreadSafety**: Unsafe
|
|
39696
|
+
*
|
|
39697
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#ServerRestartScheduled)
|
|
39698
|
+
*/
|
|
39699
|
+
readonly ServerRestartScheduled: RBXScriptSignal<(restartTime: DateTime, source: Enum.CloseReason, attributes: object) => void>;
|
|
39954
39700
|
/**
|
|
39955
39701
|
* **Deprecated:** This function is deprecated. It is recommended to use `DataModel:BindToClose()` instead.
|
|
39956
39702
|
*
|
|
@@ -39961,7 +39707,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39961
39707
|
*
|
|
39962
39708
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#OnClose)
|
|
39963
39709
|
*
|
|
39964
|
-
* @deprecated
|
|
39710
|
+
* @deprecated
|
|
39965
39711
|
*/
|
|
39966
39712
|
OnClose: (() => unknown) | undefined;
|
|
39967
39713
|
}
|
|
@@ -40300,6 +40046,21 @@ interface SlimAnimationReplicationService extends Instance {
|
|
|
40300
40046
|
*/
|
|
40301
40047
|
readonly _nominal_SlimAnimationReplicationService: unique symbol;
|
|
40302
40048
|
}
|
|
40049
|
+
/**
|
|
40050
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
40051
|
+
*
|
|
40052
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimDebugSettings)
|
|
40053
|
+
*/
|
|
40054
|
+
interface SlimDebugSettings extends Instance {
|
|
40055
|
+
/**
|
|
40056
|
+
* **DO NOT USE!**
|
|
40057
|
+
*
|
|
40058
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
40059
|
+
* @hidden
|
|
40060
|
+
* @deprecated
|
|
40061
|
+
*/
|
|
40062
|
+
readonly _nominal_SlimDebugSettings: unique symbol;
|
|
40063
|
+
}
|
|
40303
40064
|
/**
|
|
40304
40065
|
* - **Tags**: NotCreatable, Service
|
|
40305
40066
|
*
|
|
@@ -40603,7 +40364,7 @@ interface SocialService extends Instance {
|
|
|
40603
40364
|
*
|
|
40604
40365
|
* @returns A tuple containing an `PromptLinkSharingResult` indicating the result of the link sharing prompt.
|
|
40605
40366
|
*
|
|
40606
|
-
* @deprecated
|
|
40367
|
+
* @deprecated
|
|
40607
40368
|
*/
|
|
40608
40369
|
PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
|
|
40609
40370
|
/**
|
|
@@ -40717,7 +40478,7 @@ interface Sound extends Instance {
|
|
|
40717
40478
|
*
|
|
40718
40479
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#EmitterSize)
|
|
40719
40480
|
*
|
|
40720
|
-
* @deprecated
|
|
40481
|
+
* @deprecated
|
|
40721
40482
|
*/
|
|
40722
40483
|
EmitterSize: number;
|
|
40723
40484
|
/**
|
|
@@ -40773,7 +40534,7 @@ interface Sound extends Instance {
|
|
|
40773
40534
|
*
|
|
40774
40535
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#MaxDistance)
|
|
40775
40536
|
*
|
|
40776
|
-
* @deprecated
|
|
40537
|
+
* @deprecated
|
|
40777
40538
|
*/
|
|
40778
40539
|
MaxDistance: number;
|
|
40779
40540
|
/**
|
|
@@ -40786,7 +40547,7 @@ interface Sound extends Instance {
|
|
|
40786
40547
|
*
|
|
40787
40548
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#MinDistance)
|
|
40788
40549
|
*
|
|
40789
|
-
* @deprecated
|
|
40550
|
+
* @deprecated
|
|
40790
40551
|
*/
|
|
40791
40552
|
MinDistance: number;
|
|
40792
40553
|
/**
|
|
@@ -40799,7 +40560,7 @@ interface Sound extends Instance {
|
|
|
40799
40560
|
*
|
|
40800
40561
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#Pitch)
|
|
40801
40562
|
*
|
|
40802
|
-
* @deprecated
|
|
40563
|
+
* @deprecated
|
|
40803
40564
|
*/
|
|
40804
40565
|
Pitch: number;
|
|
40805
40566
|
/**
|
|
@@ -41542,6 +41303,24 @@ interface SoundService extends Instance {
|
|
|
41542
41303
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#DopplerScale)
|
|
41543
41304
|
*/
|
|
41544
41305
|
DopplerScale: number;
|
|
41306
|
+
/**
|
|
41307
|
+
* - **ThreadSafety**: ReadSafe
|
|
41308
|
+
*
|
|
41309
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#ListenerCFrame)
|
|
41310
|
+
*/
|
|
41311
|
+
ListenerCFrame: CFrame;
|
|
41312
|
+
/**
|
|
41313
|
+
* - **ThreadSafety**: ReadSafe
|
|
41314
|
+
*
|
|
41315
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#ListenerObject)
|
|
41316
|
+
*/
|
|
41317
|
+
ListenerObject: Instance | undefined;
|
|
41318
|
+
/**
|
|
41319
|
+
* - **ThreadSafety**: ReadSafe
|
|
41320
|
+
*
|
|
41321
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#ListenerType)
|
|
41322
|
+
*/
|
|
41323
|
+
ListenerType: Enum.ListenerType;
|
|
41545
41324
|
/**
|
|
41546
41325
|
* Sets whether `Sound` playback from a client will replicate to the server.
|
|
41547
41326
|
*
|
|
@@ -43530,7 +43309,7 @@ interface TeleportService extends Instance {
|
|
|
43530
43309
|
* @param placeId The `DataModel.PlaceId` of the place the reserved server is being created for.
|
|
43531
43310
|
* @returns The server access code required by `TeleportService:TeleportToPrivateServer()` and the `DataModel.PrivateServerId` for the reserved server.
|
|
43532
43311
|
*
|
|
43533
|
-
* @deprecated
|
|
43312
|
+
* @deprecated
|
|
43534
43313
|
*/
|
|
43535
43314
|
ReserveServer(this: TeleportService, placeId: number): LuaTuple<[
|
|
43536
43315
|
string,
|
|
@@ -43812,7 +43591,7 @@ interface TestService extends Instance {
|
|
|
43812
43591
|
*
|
|
43813
43592
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Is30FpsThrottleEnabled)
|
|
43814
43593
|
*
|
|
43815
|
-
* @deprecated
|
|
43594
|
+
* @deprecated
|
|
43816
43595
|
*/
|
|
43817
43596
|
Is30FpsThrottleEnabled: boolean;
|
|
43818
43597
|
/**
|
|
@@ -45132,7 +44911,7 @@ interface TextChatService extends Instance {
|
|
|
45132
44911
|
* @param this A service handling in-experience text chat.
|
|
45133
44912
|
* @param userId
|
|
45134
44913
|
*/
|
|
45135
|
-
CanUserChatAsync(this: TextChatService, userId:
|
|
44914
|
+
CanUserChatAsync(this: TextChatService, userId: User): boolean;
|
|
45136
44915
|
/**
|
|
45137
44916
|
* Determines whether or not two users can receive messages from each other.
|
|
45138
44917
|
*
|
|
@@ -45144,7 +44923,7 @@ interface TextChatService extends Instance {
|
|
|
45144
44923
|
* @param userIdFrom
|
|
45145
44924
|
* @param userIdTo
|
|
45146
44925
|
*/
|
|
45147
|
-
CanUsersChatAsync(this: TextChatService, userIdFrom:
|
|
44926
|
+
CanUsersChatAsync(this: TextChatService, userIdFrom: User, userIdTo: User): boolean;
|
|
45148
44927
|
/**
|
|
45149
44928
|
* Determines whether a user has permission to chat directly with other users in experiences based on factors such as their parental control settings.
|
|
45150
44929
|
*
|
|
@@ -45157,7 +44936,7 @@ interface TextChatService extends Instance {
|
|
|
45157
44936
|
* @param userIds A list of users who the `requesterUserId` would like to chat with directly. Users not in the current server are ignored.
|
|
45158
44937
|
* @returns A list of users who could participate in the direct chat request. If none of the users can direct chat with the `requesterUserId`, the result is an empty array.
|
|
45159
44938
|
*/
|
|
45160
|
-
CanUsersDirectChatAsync(this: TextChatService, requesterUserId:
|
|
44939
|
+
CanUsersDirectChatAsync(this: TextChatService, requesterUserId: User, userIds: Array<unknown>): Array<unknown>;
|
|
45161
44940
|
/**
|
|
45162
44941
|
* Returns chat group IDs that indicate which players can synchronously text chat together.
|
|
45163
44942
|
*
|
|
@@ -45804,6 +45583,12 @@ interface Trail extends Instance {
|
|
|
45804
45583
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Trail#Texture)
|
|
45805
45584
|
*/
|
|
45806
45585
|
Texture: ContentId;
|
|
45586
|
+
/**
|
|
45587
|
+
* - **ThreadSafety**: ReadSafe
|
|
45588
|
+
*
|
|
45589
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Trail#TextureContent)
|
|
45590
|
+
*/
|
|
45591
|
+
TextureContent: Content;
|
|
45807
45592
|
/**
|
|
45808
45593
|
* Sets the length of the trail's texture, dependent on `TextureMode`.
|
|
45809
45594
|
*
|
|
@@ -45845,13 +45630,6 @@ interface Trail extends Instance {
|
|
|
45845
45630
|
* @param this Used to create a trail effect between two attachments.
|
|
45846
45631
|
*/
|
|
45847
45632
|
Clear(this: Trail): void;
|
|
45848
|
-
/**
|
|
45849
|
-
* - **ThreadSafety**: Unsafe
|
|
45850
|
-
* - **Tags**: Hidden
|
|
45851
|
-
*
|
|
45852
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Trail#OnClearRequested)
|
|
45853
|
-
*/
|
|
45854
|
-
readonly OnClearRequested: RBXScriptSignal<() => void>;
|
|
45855
45633
|
}
|
|
45856
45634
|
/**
|
|
45857
45635
|
* The role of a Translator is to manufacture/return strings localized for the viewing player.
|
|
@@ -46650,6 +46428,18 @@ interface UIGradient extends UIComponent {
|
|
|
46650
46428
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#Rotation)
|
|
46651
46429
|
*/
|
|
46652
46430
|
Rotation: number;
|
|
46431
|
+
/**
|
|
46432
|
+
* - **ThreadSafety**: ReadSafe
|
|
46433
|
+
*
|
|
46434
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#Scale)
|
|
46435
|
+
*/
|
|
46436
|
+
Scale: number;
|
|
46437
|
+
/**
|
|
46438
|
+
* - **ThreadSafety**: ReadSafe
|
|
46439
|
+
*
|
|
46440
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#TileMode)
|
|
46441
|
+
*/
|
|
46442
|
+
TileMode: Enum.GradientTileMode;
|
|
46653
46443
|
/**
|
|
46654
46444
|
* Determines how much the parent GuiObject can be seen through along the length of the gradient.
|
|
46655
46445
|
*
|
|
@@ -46658,6 +46448,12 @@ interface UIGradient extends UIComponent {
|
|
|
46658
46448
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#Transparency)
|
|
46659
46449
|
*/
|
|
46660
46450
|
Transparency: NumberSequence;
|
|
46451
|
+
/**
|
|
46452
|
+
* - **ThreadSafety**: ReadSafe
|
|
46453
|
+
*
|
|
46454
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#Type)
|
|
46455
|
+
*/
|
|
46456
|
+
Type: Enum.GradientType;
|
|
46661
46457
|
}
|
|
46662
46458
|
/**
|
|
46663
46459
|
* The base class for UI layout classes.
|
|
@@ -47188,6 +46984,14 @@ interface UIShadow extends UIComponent {
|
|
|
47188
46984
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Color)
|
|
47189
46985
|
*/
|
|
47190
46986
|
Color: Color3;
|
|
46987
|
+
/**
|
|
46988
|
+
* Determines whether the `UIShadow` is visible.
|
|
46989
|
+
*
|
|
46990
|
+
* - **ThreadSafety**: ReadSafe
|
|
46991
|
+
*
|
|
46992
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Enabled)
|
|
46993
|
+
*/
|
|
46994
|
+
Enabled: boolean;
|
|
47191
46995
|
/**
|
|
47192
46996
|
* Moves the shadow relative to the parent's position.
|
|
47193
46997
|
*
|
|
@@ -47634,7 +47438,7 @@ interface UserInputService extends Instance {
|
|
|
47634
47438
|
*
|
|
47635
47439
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#ModalEnabled)
|
|
47636
47440
|
*
|
|
47637
|
-
* @deprecated
|
|
47441
|
+
* @deprecated
|
|
47638
47442
|
*/
|
|
47639
47443
|
ModalEnabled: boolean;
|
|
47640
47444
|
/**
|
|
@@ -48260,10 +48064,15 @@ interface UserService extends Instance {
|
|
|
48260
48064
|
*/
|
|
48261
48065
|
readonly _nominal_UserService: unique symbol;
|
|
48262
48066
|
/**
|
|
48067
|
+
* Returns a `User` for the given global user ID within the current experience.
|
|
48068
|
+
*
|
|
48263
48069
|
* - **ThreadSafety**: Unsafe
|
|
48264
48070
|
* - **Tags**: Yields
|
|
48265
48071
|
*
|
|
48266
48072
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserService#GetUserFromGlobalUserIdAsync)
|
|
48073
|
+
* @param this A service that handles queries regarding users on the Roblox platform.
|
|
48074
|
+
* @param userId The global user ID to resolve.
|
|
48075
|
+
* @returns User: The `User` representing the resolved domain-scoped identity.
|
|
48267
48076
|
*/
|
|
48268
48077
|
GetUserFromGlobalUserIdAsync(this: UserService, userId: number): User;
|
|
48269
48078
|
/**
|
|
@@ -49167,6 +48976,12 @@ interface VideoPlayer extends Instance {
|
|
|
49167
48976
|
* @deprecated
|
|
49168
48977
|
*/
|
|
49169
48978
|
readonly _nominal_VideoPlayer: unique symbol;
|
|
48979
|
+
/**
|
|
48980
|
+
* - **ThreadSafety**: ReadSafe
|
|
48981
|
+
*
|
|
48982
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#InternalVideoUsage)
|
|
48983
|
+
*/
|
|
48984
|
+
InternalVideoUsage: Enum.InternalVideoUsage;
|
|
49170
48985
|
/**
|
|
49171
48986
|
* Indicates when the `VideoContent` has loaded and is ready to play.
|
|
49172
48987
|
*
|
|
@@ -49656,7 +49471,7 @@ interface VoiceChatService extends Instance {
|
|
|
49656
49471
|
* @param userId The `Player.UserId` to check.
|
|
49657
49472
|
* @returns If that user has voice enabled.
|
|
49658
49473
|
*/
|
|
49659
|
-
IsVoiceEnabledForUserIdAsync(this: VoiceChatService, userId:
|
|
49474
|
+
IsVoiceEnabledForUserIdAsync(this: VoiceChatService, userId: User): boolean;
|
|
49660
49475
|
}
|
|
49661
49476
|
/**
|
|
49662
49477
|
* - **Tags**: NotCreatable, NotReplicated
|
|
@@ -49963,6 +49778,21 @@ interface PluginConnection extends RBXObject {
|
|
|
49963
49778
|
*/
|
|
49964
49779
|
readonly _nominal_PluginConnection: unique symbol;
|
|
49965
49780
|
}
|
|
49781
|
+
/**
|
|
49782
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
49783
|
+
*
|
|
49784
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioActionOverride)
|
|
49785
|
+
*/
|
|
49786
|
+
interface StudioActionOverride extends RBXObject {
|
|
49787
|
+
/**
|
|
49788
|
+
* **DO NOT USE!**
|
|
49789
|
+
*
|
|
49790
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
49791
|
+
* @hidden
|
|
49792
|
+
* @deprecated
|
|
49793
|
+
*/
|
|
49794
|
+
readonly _nominal_StudioActionOverride: unique symbol;
|
|
49795
|
+
}
|
|
49966
49796
|
/**
|
|
49967
49797
|
* - **Tags**: NotCreatable, NotReplicated
|
|
49968
49798
|
*
|