@rbxts/types 1.0.551 → 1.0.555
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 +178 -33
- package/include/generated/PluginSecurity.d.ts +26 -3
- package/include/generated/enums.d.ts +139 -87
- package/include/lua.d.ts +3 -0
- package/include/roblox.d.ts +110 -1
- package/package.json +1 -1
|
@@ -75,6 +75,7 @@ interface Services {
|
|
|
75
75
|
RunService: RunService;
|
|
76
76
|
ScriptChangeService: ScriptChangeService;
|
|
77
77
|
ScriptContext: ScriptContext;
|
|
78
|
+
ScriptRegistrationService: ScriptRegistrationService;
|
|
78
79
|
ServerScriptService: ServerScriptService;
|
|
79
80
|
ServerStorage: ServerStorage;
|
|
80
81
|
SessionService: SessionService;
|
|
@@ -207,6 +208,7 @@ interface CreatableInstances {
|
|
|
207
208
|
LocalScript: LocalScript;
|
|
208
209
|
ManualGlue: ManualGlue;
|
|
209
210
|
ManualWeld: ManualWeld;
|
|
211
|
+
MarkerCurve: MarkerCurve;
|
|
210
212
|
MaterialVariant: MaterialVariant;
|
|
211
213
|
MeshPart: MeshPart;
|
|
212
214
|
Model: Model;
|
|
@@ -235,6 +237,7 @@ interface CreatableInstances {
|
|
|
235
237
|
RemoteEvent: RemoteEvent;
|
|
236
238
|
RemoteFunction: RemoteFunction;
|
|
237
239
|
ReverbSoundEffect: ReverbSoundEffect;
|
|
240
|
+
RigidConstraint: RigidConstraint;
|
|
238
241
|
RocketPropulsion: RocketPropulsion;
|
|
239
242
|
RodConstraint: RodConstraint;
|
|
240
243
|
RopeConstraint: RopeConstraint;
|
|
@@ -1946,7 +1949,9 @@ interface AssetImportService extends Instance {
|
|
|
1946
1949
|
* @deprecated
|
|
1947
1950
|
*/
|
|
1948
1951
|
readonly _nominal_AssetImportService: unique symbol;
|
|
1952
|
+
readonly ProgressUpdate: RBXScriptSignal<(progressRatio: number) => void>;
|
|
1949
1953
|
readonly SettingsChanged: RBXScriptSignal<(property: string) => void>;
|
|
1954
|
+
readonly UploadFinished: RBXScriptSignal<(succeeded: boolean, errorMap: object) => void>;
|
|
1950
1955
|
}
|
|
1951
1956
|
|
|
1952
1957
|
interface AssetManagerService extends Instance {
|
|
@@ -3992,14 +3997,63 @@ interface BaseWrap extends Instance {
|
|
|
3992
3997
|
* @deprecated
|
|
3993
3998
|
*/
|
|
3994
3999
|
readonly _nominal_BaseWrap: unique symbol;
|
|
4000
|
+
/**
|
|
4001
|
+
* This property is set up automatically by the Avatar Importer plugin.
|
|
4002
|
+
*
|
|
4003
|
+
* Asset ID for cage mesh.
|
|
4004
|
+
*/
|
|
3995
4005
|
readonly CageMeshId: string;
|
|
4006
|
+
/**
|
|
4007
|
+
* This property is set up automatically by the Avatar Importer plugin.
|
|
4008
|
+
*
|
|
4009
|
+
* Cage mesh offset relative to parent [MeshPart](https://developer.roblox.com/en-us/api-reference/class/MeshPart).
|
|
4010
|
+
*/
|
|
3996
4011
|
readonly CageOrigin: CFrame;
|
|
3997
4012
|
/**
|
|
4013
|
+
* Cage mesh offset in world space.
|
|
3998
4014
|
* Tags: ReadOnly, NotReplicated
|
|
3999
4015
|
*/
|
|
4000
4016
|
readonly CageOriginWorld: CFrame;
|
|
4017
|
+
/**
|
|
4018
|
+
* This property is set up automatically by the Avatar Importer plugin.
|
|
4019
|
+
*
|
|
4020
|
+
* Describes where a global zero was while authoring the cage mesh in an asset creation tool such as Blender or Maya. This property is not used by the deformer but it is useful for tools/aligning scripts, for example aligning two parts by matching their pivots as follows:
|
|
4021
|
+
*
|
|
4022
|
+
* local function alignWraps()
|
|
4023
|
+
* local selectionService = game:GetService("Selection")
|
|
4024
|
+
* local selectedObjects = selectionService:Get()
|
|
4025
|
+
* local alignObjects = {}
|
|
4026
|
+
* for \_, obj in pairs(selectedObjects) do
|
|
4027
|
+
* if obj:IsA("BaseWrap") then
|
|
4028
|
+
* --print("Wrap: " .. obj.Name)
|
|
4029
|
+
* table.insert(alignObjects, obj)
|
|
4030
|
+
* else
|
|
4031
|
+
* print("Ignore: " .. obj.Name)
|
|
4032
|
+
* end
|
|
4033
|
+
* end
|
|
4034
|
+
*
|
|
4035
|
+
* if #alignObjects < 2 then
|
|
4036
|
+
* warn("You need to select at least two wraps")
|
|
4037
|
+
* return
|
|
4038
|
+
* end
|
|
4039
|
+
*
|
|
4040
|
+
* local anchorWrap = alignObjects\[1\]
|
|
4041
|
+
* local worldA\_from\_Wrap = anchorWrap.ImportOriginWorld
|
|
4042
|
+
* print("Anchor: " .. anchorWrap.Name)
|
|
4043
|
+
* for i = 2, #alignObjects do
|
|
4044
|
+
* local wrapToAlign = alignObjects\[i\]
|
|
4045
|
+
* print("Align: " .. wrapToAlign.Name)
|
|
4046
|
+
* local wrap\_from\_WorldB = wrapToAlign.ImportOriginWorld:Inverse()
|
|
4047
|
+
* local worldA\_from\_WorldB = worldA\_from\_Wrap \* wrap\_from\_WorldB
|
|
4048
|
+
* local worldB = wrapToAlign.Parent.CFrame
|
|
4049
|
+
* -- Note: adjust CFrame of the parent part
|
|
4050
|
+
* wrapToAlign.Parent.CFrame = (worldB\_from\_WorldB \* worldB)
|
|
4051
|
+
* end
|
|
4052
|
+
* end
|
|
4053
|
+
*/
|
|
4001
4054
|
readonly ImportOrigin: CFrame;
|
|
4002
4055
|
/**
|
|
4056
|
+
* Describes where the origin (in world space) was while authoring the cage mesh in an asset creation tool such as Blender or Maya.
|
|
4003
4057
|
* Tags: ReadOnly, NotReplicated
|
|
4004
4058
|
*/
|
|
4005
4059
|
readonly ImportOriginWorld: CFrame;
|
|
@@ -6897,6 +6951,33 @@ interface Plane extends Constraint {
|
|
|
6897
6951
|
readonly _nominal_Plane: unique symbol;
|
|
6898
6952
|
}
|
|
6899
6953
|
|
|
6954
|
+
interface RigidConstraint extends Constraint {
|
|
6955
|
+
/**
|
|
6956
|
+
* **DO NOT USE!**
|
|
6957
|
+
*
|
|
6958
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
6959
|
+
* @hidden
|
|
6960
|
+
* @deprecated
|
|
6961
|
+
*/
|
|
6962
|
+
readonly _nominal_RigidConstraint: unique symbol;
|
|
6963
|
+
/**
|
|
6964
|
+
* Tags: ReadOnly, NotReplicated, NotBrowsable
|
|
6965
|
+
*/
|
|
6966
|
+
readonly Broken: boolean;
|
|
6967
|
+
/**
|
|
6968
|
+
* Tags: NotBrowsable
|
|
6969
|
+
*/
|
|
6970
|
+
DestructionEnabled: boolean;
|
|
6971
|
+
/**
|
|
6972
|
+
* Tags: NotBrowsable
|
|
6973
|
+
*/
|
|
6974
|
+
DestructionForce: number;
|
|
6975
|
+
/**
|
|
6976
|
+
* Tags: NotBrowsable
|
|
6977
|
+
*/
|
|
6978
|
+
DestructionTorque: number;
|
|
6979
|
+
}
|
|
6980
|
+
|
|
6900
6981
|
/** A **RodConstraint** constrains two [Attachments](https://developer.roblox.com/en-us/api-reference/class/Attachment) to remain separated by the value specified by [RodConstraint.Length](https://developer.roblox.com/en-us/api-reference/property/RodConstraint/Length). While the attachments remain at a set distance from one another, they can both rotate freely.
|
|
6901
6982
|
*
|
|
6902
6983
|
* By default, RodConstraints do not have angle constraints and allow each part to rotate without angular constraint. However, setting [LimitsEnabled](https://developer.roblox.com/en-us/api-reference/property/RodConstraint/LimitsEnabled) reveal the [LimitAngle0](https://developer.roblox.com/en-us/api-reference/property/RodConstraint/LimitAngle0) and [LimitAngle1](https://developer.roblox.com/en-us/api-reference/property/RodConstraint/LimitAngle1) properties, which control the maximum angle that either end of the rod may have against the respective attachment. In the image below, the two parts are joined by a RodConstraint with 45 degree limits on each end. The red part is not [Anchored](https://developer.roblox.com/en-us/api-reference/property/BasePart/Anchored).
|
|
@@ -10131,7 +10212,7 @@ interface GroupService extends Instance {
|
|
|
10131
10212
|
*
|
|
10132
10213
|
* A boolean indicating if this is the player's primary group
|
|
10133
10214
|
*
|
|
10134
|
-
* IsInClan
|
|
10215
|
+
* ### IsInClan
|
|
10135
10216
|
*
|
|
10136
10217
|
* A boolean indicating if the player is in this group's clan
|
|
10137
10218
|
*
|
|
@@ -10881,7 +10962,7 @@ interface CanvasGroup extends GuiObject {
|
|
|
10881
10962
|
*/
|
|
10882
10963
|
readonly _nominal_CanvasGroup: unique symbol;
|
|
10883
10964
|
GroupColor: Color3;
|
|
10884
|
-
|
|
10965
|
+
GroupTransparency: number;
|
|
10885
10966
|
}
|
|
10886
10967
|
|
|
10887
10968
|
/** Frame is a [GuiObject](https://developer.roblox.com/en-us/api-reference/class/GuiObject) that renders as a plain rectangle with no other content. They are the simplest concrete example of a [GuiObject](https://developer.roblox.com/en-us/api-reference/class/GuiObject), as they provide very little additional functionality (`Frame.FrameStyle`). Despite this, Frames are useful as containers for other [GuiObject](https://developer.roblox.com/en-us/api-reference/class/GuiObject)s, such as [TextLabel](https://developer.roblox.com/en-us/api-reference/class/TextLabel), [ImageLabel](https://developer.roblox.com/en-us/api-reference/class/ImageLabel). The key benefit to using a Frame over a [Folder](https://developer.roblox.com/en-us/api-reference/class/Folder) as a container object is the ability to further manipulate the `GuiObject.Size` and `GuiObject.Position` of any descendant [GuiObject](https://developer.roblox.com/en-us/api-reference/class/GuiObject)s. */
|
|
@@ -17674,11 +17755,11 @@ interface JointsService extends Instance {
|
|
|
17674
17755
|
*/
|
|
17675
17756
|
CreateJoinAfterMoveJoints(this: JointsService): void;
|
|
17676
17757
|
/**
|
|
17677
|
-
* Sets the PVInstance that will be connected with the target PVInstance specified by [SetJoinAfterMoveTarget](https://developer.roblox.com/api-reference/function/JointsService/SetJoinAfterMoveTarget
|
|
17758
|
+
* Sets the PVInstance that will be connected with the target PVInstance specified by [JointsService:SetJoinAfterMoveTarget](https://developer.roblox.com/en-us/api-reference/function/JointsService/SetJoinAfterMoveTarget).
|
|
17678
17759
|
*/
|
|
17679
17760
|
SetJoinAfterMoveInstance(this: JointsService, joinInstance: PVInstance): void;
|
|
17680
17761
|
/**
|
|
17681
|
-
* Sets the PVInstance that will be connected with the PVInstance specified by [SetJoinAfterMoveInstance](https://developer.roblox.com/api-reference/function/JointsService/SetJoinAfterMoveInstance
|
|
17762
|
+
* Sets the PVInstance that will be connected with the PVInstance specified by [JointsService:SetJoinAfterMoveInstance](https://developer.roblox.com/en-us/api-reference/function/JointsService/SetJoinAfterMoveInstance).
|
|
17682
17763
|
*/
|
|
17683
17764
|
SetJoinAfterMoveTarget(this: JointsService, joinTarget: PVInstance): void;
|
|
17684
17765
|
/**
|
|
@@ -19931,6 +20012,25 @@ interface LuauScriptAnalyzerService extends Instance {
|
|
|
19931
20012
|
readonly _nominal_LuauScriptAnalyzerService: unique symbol;
|
|
19932
20013
|
}
|
|
19933
20014
|
|
|
20015
|
+
interface MarkerCurve extends Instance {
|
|
20016
|
+
/**
|
|
20017
|
+
* **DO NOT USE!**
|
|
20018
|
+
*
|
|
20019
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
20020
|
+
* @hidden
|
|
20021
|
+
* @deprecated
|
|
20022
|
+
*/
|
|
20023
|
+
readonly _nominal_MarkerCurve: unique symbol;
|
|
20024
|
+
/**
|
|
20025
|
+
* Tags: ReadOnly, NotReplicated
|
|
20026
|
+
*/
|
|
20027
|
+
readonly Length: number;
|
|
20028
|
+
GetMarkerAtIndex(this: MarkerCurve, index: number): object;
|
|
20029
|
+
GetMarkers(this: MarkerCurve): unknown;
|
|
20030
|
+
InsertMarkerAtTime(this: MarkerCurve, time: number, marker: string): unknown;
|
|
20031
|
+
RemoveMarkerAtIndex(this: MarkerCurve, startingIndex: number, count?: number): number;
|
|
20032
|
+
}
|
|
20033
|
+
|
|
19934
20034
|
/** MarketplaceService is the game service that is responsible for in-game transactions.
|
|
19935
20035
|
*
|
|
19936
20036
|
* The most notable functions are [PromptProductPurchase](https://developer.roblox.com/en-us/api-reference/function/MarketplaceService/PromptProductPurchase) and [PromptPurchase](https://developer.roblox.com/en-us/api-reference/function/MarketplaceService/PromptPurchase), as well as the callback [ProcessReceipt](https://developer.roblox.com/en-us/api-reference/property/MarketplaceService/ProcessReceipt) which must be well defined so that transactions do not fail.
|
|
@@ -20338,25 +20438,12 @@ interface MaterialService extends Instance {
|
|
|
20338
20438
|
* @deprecated
|
|
20339
20439
|
*/
|
|
20340
20440
|
readonly _nominal_MaterialService: unique symbol;
|
|
20341
|
-
|
|
20342
|
-
|
|
20343
|
-
|
|
20344
|
-
|
|
20345
|
-
|
|
20346
|
-
|
|
20347
|
-
Foil: MaterialVariant | undefined;
|
|
20348
|
-
Granite: MaterialVariant | undefined;
|
|
20349
|
-
Grass: MaterialVariant | undefined;
|
|
20350
|
-
Ice: MaterialVariant | undefined;
|
|
20351
|
-
Marble: MaterialVariant | undefined;
|
|
20352
|
-
Metal: MaterialVariant | undefined;
|
|
20353
|
-
Pebble: MaterialVariant | undefined;
|
|
20354
|
-
Plastic: MaterialVariant | undefined;
|
|
20355
|
-
Sand: MaterialVariant | undefined;
|
|
20356
|
-
Slate: MaterialVariant | undefined;
|
|
20357
|
-
SmoothPlastic: MaterialVariant | undefined;
|
|
20358
|
-
Wood: MaterialVariant | undefined;
|
|
20359
|
-
WoodPlanks: MaterialVariant | undefined;
|
|
20441
|
+
ClearOverridePartMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): void;
|
|
20442
|
+
ClearOverrideTerrainMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): void;
|
|
20443
|
+
GetOverridePartMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): MaterialVariant;
|
|
20444
|
+
GetOverrideTerrainMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): MaterialVariant;
|
|
20445
|
+
SetOverridePartMaterial(this: MaterialService, materialVariant: MaterialVariant): void;
|
|
20446
|
+
SetOverrideTerrainMaterial(this: MaterialService, materialVariant: MaterialVariant): void;
|
|
20360
20447
|
}
|
|
20361
20448
|
|
|
20362
20449
|
interface MaterialVariant extends Instance {
|
|
@@ -20368,6 +20455,7 @@ interface MaterialVariant extends Instance {
|
|
|
20368
20455
|
* @deprecated
|
|
20369
20456
|
*/
|
|
20370
20457
|
readonly _nominal_MaterialVariant: unique symbol;
|
|
20458
|
+
MaterialPattern: Enum.MaterialPattern;
|
|
20371
20459
|
StudsPerTile: number;
|
|
20372
20460
|
}
|
|
20373
20461
|
|
|
@@ -23126,7 +23214,7 @@ interface Model extends PVInstance {
|
|
|
23126
23214
|
TranslateBy(this: Model, delta: Vector3): void;
|
|
23127
23215
|
}
|
|
23128
23216
|
|
|
23129
|
-
/** Actor */
|
|
23217
|
+
/** Actor Class */
|
|
23130
23218
|
interface Actor extends Model {
|
|
23131
23219
|
/**
|
|
23132
23220
|
* **DO NOT USE!**
|
|
@@ -24332,6 +24420,7 @@ interface PathfindingLink extends Instance {
|
|
|
24332
24420
|
Attachment0: Attachment | undefined;
|
|
24333
24421
|
Attachment1: Attachment | undefined;
|
|
24334
24422
|
IsBidirectional: boolean;
|
|
24423
|
+
ModifierId: string;
|
|
24335
24424
|
}
|
|
24336
24425
|
|
|
24337
24426
|
/** **Beta Feature** This class is currently a part of the PathfindingModifier beta feature. Eligible developers must enable the feature within Studio and functionality may change.
|
|
@@ -24563,19 +24652,19 @@ interface PhysicsService extends Instance {
|
|
|
24563
24652
|
* This function will throw a runtime error in the following circumstances:
|
|
24564
24653
|
*
|
|
24565
24654
|
* * The specified group does not exist.
|
|
24566
|
-
* * The specified part is not a BasePart.
|
|
24655
|
+
* * The specified part is not a BasePart.
|
|
24567
24656
|
*/
|
|
24568
24657
|
CollisionGroupContainsPart(this: PhysicsService, name: string, part: BasePart): boolean;
|
|
24569
24658
|
/**
|
|
24570
24659
|
* Sets the collision status between two groups.
|
|
24571
24660
|
*
|
|
24572
|
-
* This function will throw an error if either of the groups do not exist.
|
|
24661
|
+
* This function will throw an error if either of the groups do not exist.
|
|
24573
24662
|
*/
|
|
24574
24663
|
CollisionGroupSetCollidable(this: PhysicsService, name1: string, name2: string, collidable: boolean): void;
|
|
24575
24664
|
/**
|
|
24576
24665
|
* Returns whether the two specified collision groups will collide.
|
|
24577
24666
|
*
|
|
24578
|
-
* This function will throw an error if either of the groups do not exist.
|
|
24667
|
+
* This function will throw an error if either of the groups do not exist.
|
|
24579
24668
|
*/
|
|
24580
24669
|
CollisionGroupsAreCollidable(this: PhysicsService, name1: string, name2: string): boolean;
|
|
24581
24670
|
/**
|
|
@@ -24591,7 +24680,7 @@ interface PhysicsService extends Instance {
|
|
|
24591
24680
|
/**
|
|
24592
24681
|
* Returns the name of the collision group with the corresponding id. This function will return nil if the group with the corresponding id has not been named.
|
|
24593
24682
|
*
|
|
24594
|
-
* This function will throw an error if the id is not in the range of 0 <= id <
|
|
24683
|
+
* This function will throw an error if the id is not in the range of 0 <= id < maxCollisionGroups
|
|
24595
24684
|
*/
|
|
24596
24685
|
GetCollisionGroupName(this: PhysicsService, name: number): string;
|
|
24597
24686
|
/**
|
|
@@ -24634,7 +24723,7 @@ interface PhysicsService extends Instance {
|
|
|
24634
24723
|
* This function will throw a runtime error in the following circumstances:
|
|
24635
24724
|
*
|
|
24636
24725
|
* * The name “Default” is provided.
|
|
24637
|
-
* * The function is called from a client.
|
|
24726
|
+
* * The function is called from a client.
|
|
24638
24727
|
*/
|
|
24639
24728
|
RemoveCollisionGroup(this: PhysicsService, name: string): void;
|
|
24640
24729
|
/**
|
|
@@ -24645,7 +24734,7 @@ interface PhysicsService extends Instance {
|
|
|
24645
24734
|
* This function will throw a runtime error in the following circumstances:
|
|
24646
24735
|
*
|
|
24647
24736
|
* * Invalid or empty name provided for either argument.
|
|
24648
|
-
* * The function is called from a client.
|
|
24737
|
+
* * The function is called from a client.
|
|
24649
24738
|
*/
|
|
24650
24739
|
RenameCollisionGroup(this: PhysicsService, from: string, to: string): void;
|
|
24651
24740
|
/**
|
|
@@ -25088,6 +25177,9 @@ interface Player extends Instance {
|
|
|
25088
25177
|
* * Following an update in July 2014, the mouse's icon can now be set with this method.
|
|
25089
25178
|
*/
|
|
25090
25179
|
GetMouse(this: Player): PlayerMouse;
|
|
25180
|
+
/**
|
|
25181
|
+
* **GetNetworkPing** returns the engine-calculated latency of the [Player](https://developer.roblox.com/en-us/api-reference/class/Player) in seconds. “Ping” is a measurement of the time taken for data to be sent from the client to the server, then back again. For client-side [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript)s, this function may only be called on the [LocalPlayer](https://developer.roblox.com/en-us/api-reference/property/Players/LocalPlayer). This function is useful in identifying and debugging issues that occur in high-latency scenarios. It can also be used in masking latency, such as adjusting the speed of throwing animations for projectiles.
|
|
25182
|
+
*/
|
|
25091
25183
|
GetNetworkPing(this: Player): number;
|
|
25092
25184
|
/**
|
|
25093
25185
|
* The HasAppearanceLoaded [Player](https://developer.roblox.com/en-us/api-reference/class/Player) function returns whether or not the appearance of the player's [Player.Character](https://developer.roblox.com/en-us/api-reference/property/Player/Character) has loaded.
|
|
@@ -26571,7 +26663,9 @@ interface RemoteEvent<T extends Callback = Callback> extends Instance {
|
|
|
26571
26663
|
*
|
|
26572
26664
|
* Since this function is used to communicate from the server to the client, it will only work when used in a [Script](https://developer.roblox.com/en-us/api-reference/class/Script).
|
|
26573
26665
|
*
|
|
26574
|
-
* The
|
|
26666
|
+
* The behavior of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
|
|
26667
|
+
*
|
|
26668
|
+
* There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
|
|
26575
26669
|
*
|
|
26576
26670
|
* Note
|
|
26577
26671
|
* ----
|
|
@@ -26584,6 +26678,8 @@ interface RemoteEvent<T extends Callback = Callback> extends Instance {
|
|
|
26584
26678
|
*
|
|
26585
26679
|
* Since this function is used for communication from server to client, so it will only work when used by a server-side [Script](https://developer.roblox.com/en-us/api-reference/class/Script). For client-to-server communication (the other direction), use [FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer). Direct client-to-client communication not possible on Roblox; however, it can be simulated using a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) that relays information received through some other means, such as [FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer).
|
|
26586
26680
|
*
|
|
26681
|
+
* There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
|
|
26682
|
+
*
|
|
26587
26683
|
* See also
|
|
26588
26684
|
* --------
|
|
26589
26685
|
*
|
|
@@ -26601,7 +26697,9 @@ interface RemoteEvent<T extends Callback = Callback> extends Instance {
|
|
|
26601
26697
|
*
|
|
26602
26698
|
* When firing from the client note that nothing has to be passed in by default (unlike firing to the client from the server - where the player is passed in).
|
|
26603
26699
|
*
|
|
26604
|
-
* The
|
|
26700
|
+
* The behavior of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
|
|
26701
|
+
*
|
|
26702
|
+
* There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
|
|
26605
26703
|
*/
|
|
26606
26704
|
FireServer(this: RemoteEvent, ...args: Parameters<T>): void;
|
|
26607
26705
|
/**
|
|
@@ -26658,7 +26756,9 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
|
|
|
26658
26756
|
* Warning
|
|
26659
26757
|
* -------
|
|
26660
26758
|
*
|
|
26661
|
-
* If a client disconnects or leaves the game while it is being invoked from the server, the InvokeClient function will error. It is therefore recommended to wrap this function in a pcall so it
|
|
26759
|
+
* If a client disconnects or leaves the game while it is being invoked from the server, the InvokeClient function will error. It is therefore recommended to wrap this function in a pcall so it doesn't stop the execution of other code.
|
|
26760
|
+
*
|
|
26761
|
+
* There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
|
|
26662
26762
|
* Tags: Yields
|
|
26663
26763
|
*/
|
|
26664
26764
|
InvokeClient(this: RemoteFunction, player: Player, ...args: Parameters<T>): unknown;
|
|
@@ -26675,6 +26775,8 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
|
|
|
26675
26775
|
* ----
|
|
26676
26776
|
*
|
|
26677
26777
|
* When handling the invocation from the client note that nothing has to be passed in by default (unlike invoking the server where the player is passed in).
|
|
26778
|
+
*
|
|
26779
|
+
* There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
|
|
26678
26780
|
* Tags: Yields
|
|
26679
26781
|
*/
|
|
26680
26782
|
InvokeServer(this: RemoteFunction, ...args: Parameters<T>): ReturnType<T>;
|
|
@@ -26763,15 +26865,38 @@ interface RotationCurve extends Instance {
|
|
|
26763
26865
|
*/
|
|
26764
26866
|
readonly _nominal_RotationCurve: unique symbol;
|
|
26765
26867
|
/**
|
|
26868
|
+
* Number of rotation keys in this curve
|
|
26766
26869
|
* Tags: ReadOnly, NotReplicated
|
|
26767
26870
|
*/
|
|
26768
26871
|
readonly Length: number;
|
|
26872
|
+
/**
|
|
26873
|
+
* Returns a copy of a key at a given index.
|
|
26874
|
+
*/
|
|
26769
26875
|
GetKeyAtIndex(this: RotationCurve, index: number): RotationCurveKey;
|
|
26876
|
+
/**
|
|
26877
|
+
* The first returned value is the index of the last key with key.time <= time (or min(1,length) if no key was found). The second returned value is the index of the first key with key.time >= time (or the length of the curve if no key was found satisfying the inequality).
|
|
26878
|
+
*/
|
|
26770
26879
|
GetKeyIndicesAtTime(this: RotationCurve, time: number): unknown;
|
|
26880
|
+
/**
|
|
26881
|
+
* Returns a copy of all the keys in the RotationCurve as a Lua array of RotationCurveKey.
|
|
26882
|
+
*/
|
|
26771
26883
|
GetKeys(this: RotationCurve): unknown;
|
|
26884
|
+
/**
|
|
26885
|
+
* Samples the RotationCurve at a given time and returns the corresponding rotation. Empty RotationCurves are interpreted as zero.
|
|
26886
|
+
*/
|
|
26772
26887
|
GetValueAtTime(this: RotationCurve, time: number): CoordinateFrame?;
|
|
26888
|
+
/**
|
|
26889
|
+
* Adds the key passed as argument to this curve. If a key at the same time is found it will be replaced. First return value is true if a key was added, false if a previous key was replaced. Second return value is the index at which the marker was added.
|
|
26890
|
+
*/
|
|
26773
26891
|
InsertKey(this: RotationCurve, key: RotationCurveKey): unknown;
|
|
26892
|
+
/**
|
|
26893
|
+
* Removes a given number of Keys starting from a given index. Returns the number of keys that were removed.
|
|
26894
|
+
*/
|
|
26774
26895
|
RemoveKeyAtIndex(this: RotationCurve, startingIndex: number, count?: number): number;
|
|
26896
|
+
/**
|
|
26897
|
+
* Resets this curve keys using the RotationCurveKey array passed as argument. Keys in the keysArray are sorted in ascending time order before insertion. Keys at duplicated times are removed in a stable manner. Returns the number of keys actually inserted.
|
|
26898
|
+
* Keys previously stored in this curve are removed before the keys passed as arguments are added.
|
|
26899
|
+
*/
|
|
26775
26900
|
SetKeys(this: RotationCurve, keys: Array<any>): number;
|
|
26776
26901
|
}
|
|
26777
26902
|
|
|
@@ -27162,6 +27287,17 @@ interface ScriptContext extends Instance {
|
|
|
27162
27287
|
readonly Error: RBXScriptSignal<(message: string, stackTrace: string, script?: LuaSourceContainer) => void>;
|
|
27163
27288
|
}
|
|
27164
27289
|
|
|
27290
|
+
interface ScriptRegistrationService extends Instance {
|
|
27291
|
+
/**
|
|
27292
|
+
* **DO NOT USE!**
|
|
27293
|
+
*
|
|
27294
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
27295
|
+
* @hidden
|
|
27296
|
+
* @deprecated
|
|
27297
|
+
*/
|
|
27298
|
+
readonly _nominal_ScriptRegistrationService: unique symbol;
|
|
27299
|
+
}
|
|
27300
|
+
|
|
27165
27301
|
/** **ServerScriptService** is a container service for [Script](https://developer.roblox.com/en-us/api-reference/class/Script), [ModuleScript](https://developer.roblox.com/en-us/api-reference/class/ModuleScript) and other scripting-related assets that are only meant for server use. The contents are never replicated to player clients at all, which allows for a secure storage of important game logic. Script objects will run if they are within this service and not [Disabled](https://developer.roblox.com/en-us/api-reference/property/BaseScript/Disabled).
|
|
27166
27302
|
*
|
|
27167
27303
|
* This service houses just one property, [LoadStringEnabled](https://developer.roblox.com/en-us/api-reference/property/ServerScriptService/LoadStringEnabled), which determines whether the `loadstring` function in Lua is enabled. It's recommended to keep this disabled for security reasons, as misusing this function can lead to remote code execution vulnerabilities.
|
|
@@ -30463,6 +30599,12 @@ interface TextChannel extends Instance {
|
|
|
30463
30599
|
* @deprecated
|
|
30464
30600
|
*/
|
|
30465
30601
|
readonly _nominal_TextChannel: unique symbol;
|
|
30602
|
+
DisplaySystemMessage(this: TextChannel, systemMessage: string, metadata?: string): TextChatMessage;
|
|
30603
|
+
/**
|
|
30604
|
+
* Tags: Yields
|
|
30605
|
+
*/
|
|
30606
|
+
AddUserAsync(this: TextChannel, userId: number): unknown;
|
|
30607
|
+
readonly MessageReceived: RBXScriptSignal<(textChatMessage: TextChatMessage) => void>;
|
|
30466
30608
|
}
|
|
30467
30609
|
|
|
30468
30610
|
interface TextChatService extends Instance {
|
|
@@ -34135,6 +34277,9 @@ interface Vector3Curve extends Instance {
|
|
|
34135
34277
|
* @deprecated
|
|
34136
34278
|
*/
|
|
34137
34279
|
readonly _nominal_Vector3Curve: unique symbol;
|
|
34280
|
+
/**
|
|
34281
|
+
* Samples the 3 FloatCurves (X, Y, Z) at the time passed as argument. Returns the 3 samples as a tuple of 3 numbers. If a channel curve is missing or no key is found in the curve the channel is evaluated as nil.
|
|
34282
|
+
*/
|
|
34138
34283
|
GetValueAtTime(this: Vector3Curve, time: number): unknown;
|
|
34139
34284
|
/**
|
|
34140
34285
|
* Returns the FloatCurve controlling the X channel. It is the first child instance of type FloatCurve named `X`. If none is found an empty FloatCurve is created.
|
|
@@ -3212,8 +3212,13 @@ interface Studio extends Instance {
|
|
|
3212
3212
|
*/
|
|
3213
3213
|
DeprecatedObjectsShown: boolean;
|
|
3214
3214
|
readonly DisplayLanguage: string;
|
|
3215
|
+
/**
|
|
3216
|
+
* Tags: Hidden, NotReplicated
|
|
3217
|
+
*/
|
|
3218
|
+
readonly ["Doc View Code Background Color"]: Color3;
|
|
3215
3219
|
["Drag Multiple Parts As Single Part"]: boolean;
|
|
3216
3220
|
["Enable Autocomplete"]: boolean;
|
|
3221
|
+
readonly ["Enable Autocomplete Doc View"]: boolean;
|
|
3217
3222
|
["Enable CoreScript Debugger"]: boolean;
|
|
3218
3223
|
["Enable Http Sandboxing"]: boolean;
|
|
3219
3224
|
["Enable Internal Beta Features"]: boolean;
|
|
@@ -3221,6 +3226,7 @@ interface Studio extends Instance {
|
|
|
3221
3226
|
readonly ["Enable Script Analysis"]: boolean;
|
|
3222
3227
|
readonly ["Enable Scrollbar Markers"]: boolean;
|
|
3223
3228
|
readonly ["Enable Signature Help"]: boolean;
|
|
3229
|
+
readonly ["Enable Signature Help Doc View"]: boolean;
|
|
3224
3230
|
["Enable Temporary Tabs"]: boolean;
|
|
3225
3231
|
["Enable Temporary Tabs In Explorer"]: boolean;
|
|
3226
3232
|
readonly ["Enable Type Hover"]: boolean;
|
|
@@ -3609,6 +3615,7 @@ interface StudioService extends Instance {
|
|
|
3609
3615
|
AnimationIdSelected(this: StudioService, id: number): void;
|
|
3610
3616
|
ConvertToPackageUpload(this: StudioService, uploadUrl: string): void;
|
|
3611
3617
|
CopyToClipboard(this: StudioService, stringToCopy: string): void;
|
|
3618
|
+
DEPRECATED_SetDocumentDisplayName(this: StudioService, newName: string): void;
|
|
3612
3619
|
EmitPlacePublishedSignal(this: StudioService): void;
|
|
3613
3620
|
GetBadgeConfigureUrl(this: StudioService, badgeId: number): string;
|
|
3614
3621
|
GetBadgeUploadUrl(this: StudioService): string;
|
|
@@ -3648,11 +3655,9 @@ interface StudioService extends Instance {
|
|
|
3648
3655
|
IsPluginInstalled(this: StudioService, assetId: number): boolean;
|
|
3649
3656
|
IsPluginUpToDate(this: StudioService, assetId: number, currentAssetVersion: number): boolean;
|
|
3650
3657
|
OpenInBrowser_DONOTUSE(this: StudioService, url: string): void;
|
|
3651
|
-
PromptForLocalSave(this: StudioService): void;
|
|
3652
3658
|
PublishAs(this: StudioService, universeId: number, placeId: number, groupId: number): void;
|
|
3653
3659
|
RequestClose(this: StudioService, closeMode: CastsToEnum<Enum.StudioCloseMode>): void;
|
|
3654
3660
|
SerializeInstances(this: StudioService, instances: Array<Instance>): string;
|
|
3655
|
-
SetDocumentDisplayName(this: StudioService, newName: string): void;
|
|
3656
3661
|
SetPluginEnabled(this: StudioService, assetId: number, state: boolean): void;
|
|
3657
3662
|
SetUniverseDisplayName(this: StudioService, newName: string): void;
|
|
3658
3663
|
ShowPlaceVersionHistoryDialog(this: StudioService, placeId: number): void;
|
|
@@ -3686,7 +3691,6 @@ interface StudioService extends Instance {
|
|
|
3686
3691
|
* Tags: Yields
|
|
3687
3692
|
*/
|
|
3688
3693
|
TryInstallPlugin(this: StudioService, assetId: number, assetVersionId: number): void;
|
|
3689
|
-
readonly FirstPublishOfCloudPlace: RBXScriptSignal<(universeId: number, placeId: number) => void>;
|
|
3690
3694
|
readonly GameNameUpdated: RBXScriptSignal<(name: string) => void>;
|
|
3691
3695
|
readonly GamePublishFinished: RBXScriptSignal<(success: boolean, gameId: number) => void>;
|
|
3692
3696
|
readonly OnConvertToPackageResult: RBXScriptSignal<(isSuccessful: boolean, errorMessage: string) => void>;
|
|
@@ -4076,5 +4080,24 @@ interface VersionControlService extends Instance {
|
|
|
4076
4080
|
* @deprecated
|
|
4077
4081
|
*/
|
|
4078
4082
|
readonly _nominal_VersionControlService: unique symbol;
|
|
4083
|
+
/**
|
|
4084
|
+
* Tags: Hidden
|
|
4085
|
+
*/
|
|
4086
|
+
readonly ScriptCollabEnabled: boolean;
|
|
4087
|
+
}
|
|
4088
|
+
|
|
4089
|
+
interface VoiceChatService extends Instance {
|
|
4090
|
+
/**
|
|
4091
|
+
* **DO NOT USE!**
|
|
4092
|
+
*
|
|
4093
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
4094
|
+
* @hidden
|
|
4095
|
+
* @deprecated
|
|
4096
|
+
*/
|
|
4097
|
+
readonly _nominal_VoiceChatService: unique symbol;
|
|
4098
|
+
/**
|
|
4099
|
+
* Tags: NotBrowsable
|
|
4100
|
+
*/
|
|
4101
|
+
GenerateDefaultChannel: boolean;
|
|
4079
4102
|
}
|
|
4080
4103
|
|