@rbxts/types 1.0.572 → 1.0.573

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.
@@ -287,6 +287,7 @@ interface CreatableInstances {
287
287
  SurfaceSelection: SurfaceSelection;
288
288
  Team: Team;
289
289
  TeleportOptions: TeleportOptions;
290
+ TerrainDetail: TerrainDetail;
290
291
  TerrainRegion: TerrainRegion;
291
292
  TextBox: TextBox;
292
293
  TextButton: TextButton;
@@ -31306,6 +31307,20 @@ interface TemporaryScriptService extends Instance {
31306
31307
  readonly _nominal_TemporaryScriptService: unique symbol;
31307
31308
  }
31308
31309
 
31310
+ interface TerrainDetail extends Instance {
31311
+ /**
31312
+ * **DO NOT USE!**
31313
+ *
31314
+ * This field exists to force TypeScript to recognize this as a nominal type
31315
+ * @hidden
31316
+ * @deprecated
31317
+ */
31318
+ readonly _nominal_TerrainDetail: unique symbol;
31319
+ Face: Enum.TerrainFace;
31320
+ MaterialPattern: Enum.MaterialPattern;
31321
+ StudsPerTile: number;
31322
+ }
31323
+
31309
31324
  /** A TerrainRegion is a snapshot of [Terrain](https://developer.roblox.com/en-us/api-reference/class/Terrain) retrieved from the [CopyRegion](https://developer.roblox.com/api-reference/function/Terrain/CopyRegion "CopyRegion") method. Can be later pasted into the Terrain using [PasteRegion](https://developer.roblox.com/api-reference/function/Terrain/PasteRegion "PasteRegion"). */
31310
31325
  interface TerrainRegion extends Instance {
31311
31326
  /**
@@ -3592,7 +3592,6 @@ interface StudioService extends Instance {
3592
3592
  */
3593
3593
  UseLocalSpace: boolean;
3594
3594
  AnimationIdSelected(this: StudioService, id: number): void;
3595
- ConvertToPackageUpload(this: StudioService, uploadUrl: string): void;
3596
3595
  CopyToClipboard(this: StudioService, stringToCopy: string): void;
3597
3596
  DEPRECATED_SetTurnOnTeamCreateOnPublish(this: StudioService, turnOn: boolean): void;
3598
3597
  EmitPlacePublishedSignal(this: StudioService): void;
@@ -3675,9 +3674,7 @@ interface StudioService extends Instance {
3675
3674
  TryInstallPlugin(this: StudioService, assetId: number, assetVersionId: number): void;
3676
3675
  readonly GameNameUpdated: RBXScriptSignal<(name: string) => void>;
3677
3676
  readonly GamePublishFinished: RBXScriptSignal<(success: boolean, gameId: number) => void>;
3678
- readonly OnConvertToPackageResult: RBXScriptSignal<(isSuccessful: boolean, errorMessage: string) => void>;
3679
3677
  readonly OnImportFromRoblox: RBXScriptSignal<() => void>;
3680
- readonly OnOpenConvertToPackagePlugin: RBXScriptSignal<(instances: Array<Instance>, name: string) => void>;
3681
3678
  readonly OnOpenGameSettings: RBXScriptSignal<(pageIdentifier: string) => void>;
3682
3679
  readonly OnOpenManagePackagePlugin: RBXScriptSignal<(userId: number, assetId: number) => void>;
3683
3680
  readonly OnPluginInstalledFromToolbox: RBXScriptSignal<() => void>;
@@ -3709,6 +3706,75 @@ interface StudioTheme extends Instance {
3709
3706
  GetColor(this: StudioTheme, styleguideitem: CastsToEnum<Enum.StudioStyleGuideColor>, modifier?: CastsToEnum<Enum.StudioStyleGuideModifier>): Color3;
3710
3707
  }
3711
3708
 
3709
+ interface SurfaceAppearance extends Instance {
3710
+ /**
3711
+ * **DO NOT USE!**
3712
+ *
3713
+ * This field exists to force TypeScript to recognize this as a nominal type
3714
+ * @hidden
3715
+ * @deprecated
3716
+ */
3717
+ readonly _nominal_SurfaceAppearance: unique symbol;
3718
+ /**
3719
+ * This property determines how the alpha channel of the [SurfaceAppearance.ColorMap](https://developer.roblox.com/en-us/api-reference/property/SurfaceAppearance/ColorMap) of a [SurfaceAppearance](https://developer.roblox.com/en-us/api-reference/class/SurfaceAppearance) is used.
3720
+ *
3721
+ * When AlphaMode is set to [Transparency](https://developer.roblox.com/en-us/api-reference/enum/AlphaMode) and the [MeshPart.Transparency](https://developer.roblox.com/en-us/api-reference/property/BasePart/Transparency) is set to 0, opaque pixels in the SurfaceAppearance's ColorMap will render as completely opaque in the 3D scene. This solves various problems for textures with different transparent and opaque areas, such as foliage. When parts of the surface are fully opaque, the Roblox engine can render them with proper depth-based occlusion. Opaque surfaces also generally work better with depth-based effects like DepthOfField, glass and water refraction, and water reflection.
3722
+ *
3723
+ * MeshPart.TextureId vs SurfaceAppearance:
3724
+ *
3725
+ * ![Foliage comparison](https://developer.roblox.com/assets/bltc11b6d62483163b0/leaves-comparison.gif)
3726
+ *
3727
+ * Here is an example of a fern color map. Only the pixels on the leaves have full alpha.
3728
+ *
3729
+ * ![Alpha fern](https://developer.roblox.com/assets/blt1a2e3175d2522842/fern-color.png)
3730
+ */
3731
+ AlphaMode: Enum.AlphaMode;
3732
+ /**
3733
+ * This property determines the color and opacity of the surface. This texture is sometimes called the albedo texture. The alpha channel of this texture controls its opacity, which behaves differently based on the [SurfaceAppearance.AlphaMode](https://developer.roblox.com/en-us/api-reference/property/SurfaceAppearance/AlphaMode) setting.
3734
+ */
3735
+ ColorMap: string;
3736
+ /**
3737
+ * This property determines which parts of the surface are metal and are non-metal. A metalness map is a grayscale image where black pixels correspond to non-metals and white pixels correspond to metals.
3738
+ *
3739
+ * Metals only reflect light the same color as the metal, and they reflect much more light than non-metals. Most materials in the real world can be categorized either metals or non-metals. For this reason, most pixels in a metalness map will be either pure black or pure white. Values in between are typically used to simulate dirt or grunge on top of an underlying metal area.
3740
+ *
3741
+ * Here's an example of a piece of metal with a layer of paint on top. Most paints are non-metallic, so the metalness map is black everywhere except on unpainted metal parts and spots where the paint has chipped away and the underlying metal is visible.
3742
+ *
3743
+ * ![Metalness jetpack](https://developer.roblox.com/assets/blt0a658c7367d5cdab/jetpack.gif)
3744
+ *
3745
+ * ![Map explanation](https://developer.roblox.com/assets/blt96558be20f7b7a1a/metalness-explained.png)
3746
+ *
3747
+ * Note
3748
+ * ----
3749
+ *
3750
+ * * When [Lighting.EnvironmentSpecularScale](https://developer.roblox.com/en-us/api-reference/property/Lighting/EnvironmentSpecularScale) is 0, metalness has no effect. For the most realistic reflections, setting EnvironmentSpecularScale and [Lighting.EnvironmentDiffuseScale](https://developer.roblox.com/en-us/api-reference/property/Lighting/EnvironmentDiffuseScale) to 1, and [Lighting.Ambient](https://developer.roblox.com/en-us/api-reference/property/Lighting/Ambient) and [Lighting.OutdoorAmbient](https://developer.roblox.com/en-us/api-reference/property/Lighting/OutdoorAmbient) to (0,0,0) is recommended.
3751
+ */
3752
+ MetalnessMap: string;
3753
+ /**
3754
+ * This property modifies the lighting of the surface by adding bumps, dents, cracks, and curves without adding more polygons.
3755
+ *
3756
+ * Normal maps are RGB images that modify the surface's normal vector used for lighting calculations. The R, G, and B channels of the NormalMap correspond to the X, Y, and Z components of the local surface vector respectively, and byte values of 0 and 255 for each channel correspond linearly to normal vector components of -1 and 1.016 respectively. This range is stretched slightly from -1 to 1 so that a byte value of 127 maps to exactly 0. The normal vector's Z axis is always defined as the direction of the underlying mesh's normal. A uniform (127,127,255) image translates to a completely flat normal map where the normal is everywhere perpendicular to the mesh surface. This format is called “tangent space” normal maps. Roblox does not support world space or object space normal maps.
3757
+ *
3758
+ * Incorrectly flipped normal components can make bumps appear like indents. If you import a normal map and notice the lighting looks off, you may need to invert the G channel of the image. The X and Y axes of the tangent space frame correspond to the X and Y directions in the image after it's transformed by the mesh UVs. If you view your normal map in an image editor as if it were displayed on a surface, normals pointing towards the right side of the screen should appear more red, and normals pointing towards the top side of your screen should appear more green.
3759
+ *
3760
+ * ![Bread normal map](https://developer.roblox.com/assets/blt013e67a5f211cd0d/bread-nmap.png)
3761
+ *
3762
+ * The terms “DirectX format” and “OpenGL format” are sometimes used to describe whether the G channel of the normal map is inverted or not. Roblox expects the OpenGL format.
3763
+ *
3764
+ * Note
3765
+ * ----
3766
+ *
3767
+ * Roblox expects imported meshes to include tangents. Modeling software may also refer to this as “tangent space” information. If you apply a normal map and it does not seem to make any visual difference, you may need to re-export your mesh along with its tangent information from modeling software.
3768
+ */
3769
+ NormalMap: string;
3770
+ /**
3771
+ * This property determines the apparent roughness across the surface. A roughness map is a grayscale image where black pixels correspond to a maximally smooth surface, and white pixels correspond to a maximally rough surface.
3772
+ *
3773
+ * Roughness refers to how much variation the surface has on a very small scale. Reflections on smooth surfaces are sharp and concentrated. Reflections on rough surfaces are more blurry and dispersed.
3774
+ */
3775
+ RoughnessMap: string;
3776
+ }
3777
+
3712
3778
  /** TaskScheduler is a read-only settings class responsible for the Task Scheduler feature.
3713
3779
  * Can be found in Roblox Studio's settings with the name _Task Scheduler_.
3714
3780
  */
@@ -3742,6 +3808,21 @@ interface TaskScheduler extends Instance {
3742
3808
  readonly ThreadPoolSize: number;
3743
3809
  }
3744
3810
 
3811
+ interface TerrainDetail extends Instance {
3812
+ /**
3813
+ * **DO NOT USE!**
3814
+ *
3815
+ * This field exists to force TypeScript to recognize this as a nominal type
3816
+ * @hidden
3817
+ * @deprecated
3818
+ */
3819
+ readonly _nominal_TerrainDetail: unique symbol;
3820
+ ColorMap: string;
3821
+ MetalnessMap: string;
3822
+ NormalMap: string;
3823
+ RoughnessMap: string;
3824
+ }
3825
+
3745
3826
  interface TerrainRegion extends Instance {
3746
3827
  /**
3747
3828
  * **DO NOT USE!**
@@ -12970,25 +12970,17 @@ declare namespace Enum {
12970
12970
 
12971
12971
  export const PlayServer: PlayServer;
12972
12972
 
12973
- export interface RobloxPlugin {
12974
- Name: "RobloxPlugin";
12973
+ export interface Standalone {
12974
+ Name: "Standalone";
12975
12975
  Value: 3;
12976
12976
  EnumType: EnumType<StudioDataModelType>;
12977
12977
  }
12978
12978
 
12979
- export const RobloxPlugin: RobloxPlugin;
12980
-
12981
- export interface UserPlugin {
12982
- Name: "UserPlugin";
12983
- Value: 4;
12984
- EnumType: EnumType<StudioDataModelType>;
12985
- }
12986
-
12987
- export const UserPlugin: UserPlugin;
12979
+ export const Standalone: Standalone;
12988
12980
 
12989
12981
  export interface None {
12990
12982
  Name: "None";
12991
- Value: 5;
12983
+ Value: 4;
12992
12984
  EnumType: EnumType<StudioDataModelType>;
12993
12985
  }
12994
12986
 
@@ -12996,7 +12988,7 @@ declare namespace Enum {
12996
12988
 
12997
12989
  export function GetEnumItems(this: defined): Array<StudioDataModelType>
12998
12990
  }
12999
- export type StudioDataModelType = StudioDataModelType.Edit | StudioDataModelType.PlayClient | StudioDataModelType.PlayServer | StudioDataModelType.RobloxPlugin | StudioDataModelType.UserPlugin | StudioDataModelType.None;
12991
+ export type StudioDataModelType = StudioDataModelType.Edit | StudioDataModelType.PlayClient | StudioDataModelType.PlayServer | StudioDataModelType.Standalone | StudioDataModelType.None;
13000
12992
  export namespace StudioScriptEditorColorCategories {
13001
12993
  export interface Default {
13002
12994
  Name: "Default";
@@ -14901,6 +14893,34 @@ declare namespace Enum {
14901
14893
  export function GetEnumItems(this: defined): Array<TerrainAcquisitionMethod>
14902
14894
  }
14903
14895
  export type TerrainAcquisitionMethod = TerrainAcquisitionMethod.None | TerrainAcquisitionMethod.Legacy | TerrainAcquisitionMethod.Template | TerrainAcquisitionMethod.Generate | TerrainAcquisitionMethod.Import | TerrainAcquisitionMethod.Convert | TerrainAcquisitionMethod.EditAddTool | TerrainAcquisitionMethod.EditSeaLevelTool | TerrainAcquisitionMethod.EditReplaceTool | TerrainAcquisitionMethod.RegionFillTool | TerrainAcquisitionMethod.RegionPasteTool | TerrainAcquisitionMethod.Other;
14896
+ export namespace TerrainFace {
14897
+ export interface Top {
14898
+ Name: "Top";
14899
+ Value: 0;
14900
+ EnumType: EnumType<TerrainFace>;
14901
+ }
14902
+
14903
+ export const Top: Top;
14904
+
14905
+ export interface Side {
14906
+ Name: "Side";
14907
+ Value: 1;
14908
+ EnumType: EnumType<TerrainFace>;
14909
+ }
14910
+
14911
+ export const Side: Side;
14912
+
14913
+ export interface Bottom {
14914
+ Name: "Bottom";
14915
+ Value: 2;
14916
+ EnumType: EnumType<TerrainFace>;
14917
+ }
14918
+
14919
+ export const Bottom: Bottom;
14920
+
14921
+ export function GetEnumItems(this: defined): Array<TerrainFace>
14922
+ }
14923
+ export type TerrainFace = TerrainFace.Top | TerrainFace.Side | TerrainFace.Bottom;
14904
14924
  export namespace TextChatMessageStatus {
14905
14925
  export interface Unknown {
14906
14926
  Name: "Unknown";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.572",
3
+ "version": "1.0.573",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },