Decal

When set to true, the decal's image asset is eligible for automatic localization through the Automatic Asset Capture system. The LocalizationService uses this property to determine whether the decal's ColorMapContent should be captured and potentially replaced with a localized version.

This property only applies to non-PBR decals. If any PBR maps (NormalMapContent, RoughnessMapContent, or MetalnessMapContent) are set, automatic localization capture is suppressed to avoid inconsistent rendering.

The Color3 tint of the Decal. Note that this property only sets the tint of the decal rather than the color; unless the image associated with the Decal was originally pure white, then the color cannot be freely changed using this property.

This property takes a content ID to determine the color and opacity of the surface. This texture is sometimes called the albedo texture.

This property takes a Content object to determine the color and opacity of the surface. This texture is sometimes called the albedo texture.

Acts as a multiplier for the decal's Transparency property. The effect is only visible to the LocalPlayer and will not replicate to the server.

When this property is set to 1, the Decal will be completely invisible regardless of its original transparency. When it is set to 0, the decal's rendered transparency will match the Transparency value.

This property takes a content ID that determines the metalness map applied to the surface. A metalness map controls how metallic the surface appears at each point, blending between a dielectric (non-metal) and a metallic response to light. It defaults to an empty content, in which case no metalness map is applied.

Assigning a normal, roughness, or metalness map makes the Decal a physically based rendering (PBR) surface. To assign this map from a Content object, use MetalnessMapContent.

This property takes a Content object that determines the metalness map applied to the surface. A metalness map controls how metallic the surface appears at each point, blending between a dielectric (non-metal) and a metallic response to light. It defaults to an empty content, in which case no metalness map is applied.

Assigning a normal, roughness, or metalness map makes the Decal a physically based rendering (PBR) surface.

This property takes a content ID that determines the normal map applied to the surface. A normal map perturbs the surface normals used in lighting calculations, adding the appearance of fine detail such as bumps and grooves without changing the underlying geometry. It defaults to an empty content, in which case no normal map is applied.

Assigning a normal, roughness, or metalness map makes the Decal a physically based rendering (PBR) surface. To assign this map from a Content object, use NormalMapContent.

This property takes a Content object that determines the normal map applied to the surface. A normal map perturbs the surface normals used in lighting calculations, adding the appearance of fine detail such as bumps and grooves without changing the underlying geometry. It defaults to an empty content, in which case no normal map is applied.

Assigning a normal, roughness, or metalness map makes the Decal a physically based rendering (PBR) surface.

This property controls the rotation angle of the decal texture in degrees. Rotation is applied to the UV coordinates in the clockwise direction.

This property takes a content ID that determines the roughness map applied to the surface. A roughness map controls how rough or smooth the surface appears at each point, which in turn determines how sharp or blurry its reflections are. It defaults to an empty content, in which case no roughness map is applied.

Assigning a normal, roughness, or metalness map makes the Decal a physically based rendering (PBR) surface. To assign this map from a Content object, use RoughnessMapContent.

This property takes a Content object that determines the roughness map applied to the surface. A roughness map controls how rough or smooth the surface appears at each point, which in turn determines how sharp or blurry its reflections are. It defaults to an empty content, in which case no roughness map is applied.

Assigning a normal, roughness, or metalness map makes the Decal a physically based rendering (PBR) surface.

This property dictates how shiny the decal is. It takes a value between 0 and 1, where 1 is "fully shiny."

Sets the specularity, which is how the surface responds to light being shined on it.

The content ID of the image to be applied by the Decal.

The texture content displayed by the Decal. Supports asset URIs and EditableImage objects.

Managed by the engine and not accessible from scripts. A Content that holds the decal's compressed runtime texture data. When the Decal is a physically based rendering (PBR) surface, the engine packs its color, normal, roughness, and metalness maps into a single texture-pack asset and references it here. Defaults to an empty content.

Determines the transparency of the Decal with 0 being completely opaque and 1 completely transparent.

Note that LocalTransparencyModifier acts as a multiplier for this transparency level and should be used when the transparency of the decal is likely to be changed by another script.

This property controls the UV coordinate translation. The X value (U offset) and Y value (V offset) are added to every corresponding UV coordinate during texture mapping.

This property controls the scale applied to the horizontal and vertical coordinates. The X value (U scale) and Y value (V scale) are multiplied by every corresponding UV coordinate during texture mapping.

This property determines the order in which decals on the same Face of a BasePart are rendered. Lower values are rendered first, so a decal with a higher ZIndex renders on top of those with a lower ZIndex.

If you're unsure whether you'll need to layer a decal between two already-existing decals in the future, use larger separations between ZIndex values such as 10 or 100 to ensure space for future decals between.