Decal
Applies an image texture to a face of a parent BasePart.
| Memory category | GraphicsTexture |
|---|
Member index 20
Description
The Decal object applies an image texture to a face of a parent BasePart. The affected face is dependent on the Face property, and the size of the decal is dependent on the size of the face.
The applied image texture is determined by its ColorMapContent property. For details on how to upload images, see asset management.
For more information, review textures and decals. See also:
- Texture for repeating surface images.
- MeshPart.TextureContent to apply an image texture to a MeshPart.
- SurfaceGui to apply an ImageLabel or ImageButton to an in-experience 3D object.
History 44
- 690 Add ColorMapContent
- 690 Add ColorMap
- 686 Add
- 686 Add TexturePack
- 683 Add UVScale
- 683 Add UVOffset
- 683 Add RoughnessMapContent
- 683 Add
- 683 Add NormalMapContent
- 683 Add
- 683 Add MetalnessMapContent
- 683 Add
- 664 Change Tags of TextureContent from [Hidden] to []
- 656 Add TextureContent
- 645 Change ValueType of Texture from Content to ContentId
- 553 Change Default of ZIndex from to 1
- 553 Change Default of Transparency from to 0
- 553 Change Default of Specular from to 0
- 553 Change Default of Shiny from to 20
- 553 Change Default of from to 0
- 553 Change Default of Color3 from to Color3(1, 1, 1)
- 486 Change ThreadSafety of ZIndex from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Transparency from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Texture from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Specular from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Shiny from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Color3 from ReadOnly to ReadSafe
- 483 Add ZIndex
- 462 Change ThreadSafety of Transparency from to ReadOnly
- 462 Change ThreadSafety of Texture from to ReadOnly
- 462 Change ThreadSafety of Specular from to ReadOnly
- 462 Change ThreadSafety of Shiny from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of Color3 from to ReadOnly
- 274 Add Color3
- 208 Change Tags of Specular from [NotReplicated] to [NotReplicated, Deprecated]
- 208 Change Tags of Shiny from [NotReplicated] to [NotReplicated, Deprecated]
- 178 Add
- 47 Add Transparency
- 47 Add Texture
- 47 Add Specular
- 47 Add Shiny
- 47 Add Decal
Members 20
Color3
| Type | Default | |
|---|---|---|
| Color3 | 1, 1, 1 | |
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |
ColorMap
| Type | Default | |
|---|---|---|
| ContentId | ||
This property takes a content ID to determine the color and opacity of the surface. This texture is sometimes called the albedo texture.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | false |
ColorMapContent
| Type | Default | |
|---|---|---|
| Content | ||
This property takes a Content object to determine the color and opacity of the surface. This texture is sometimes called the albedo texture.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | false |
History 1
- 690 Add ColorMapContent
MetalnessMapContent
| Type | Default | |
|---|---|---|
| Content | ||
| Write security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Appearance |
| Loaded/Saved | true |
History 1
NormalMapContent
| Type | Default | |
|---|---|---|
| Content | ||
| Write security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Appearance |
| Loaded/Saved | true |
History 1
- 683 Add NormalMapContent
RoughnessMapContent
| Type | Default | |
|---|---|---|
| Content | ||
| Write security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Appearance |
| Loaded/Saved | true |
History 1
Shiny
| Type | Default | |
|---|---|---|
| float | 20 | |
This property dictates how shiny the decal is. It takes a value between 0 and
1, where 1 is "fully shiny."
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true/false |
Specular
| Type | Default | |
|---|---|---|
| float | 0 | |
Sets the specularity, which is how the surface responds to light being shined on it.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true/false |
Texture
| Type | Default | |
|---|---|---|
| ContentId | ||
The content ID of the image to be applied by the Decal.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |
TextureContent
| Type | Default | |
|---|---|---|
| Content | ||
The texture content displayed by the Decal. Supports asset URIs and EditableImage objects.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |
History 2
- 664 Change Tags of TextureContent from [Hidden] to []
- 656 Add TextureContent
TexturePack
| Type | Default | |
|---|---|---|
| ContentId | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Appearance |
| Loaded/Saved | true |
History 1
- 686 Add TexturePack
Transparency
| Type | Default | |
|---|---|---|
| float | 0 | |
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |
History 4
- 553 Change Default of Transparency from to 0
- 486 Change ThreadSafety of Transparency from ReadOnly to ReadSafe
- 462 Change ThreadSafety of Transparency from to ReadOnly
- 47 Add Transparency
UVOffset
| Type | Default | |
|---|---|---|
| Vector2 | 0, 0 | |
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |
UVScale
| Type | Default | |
|---|---|---|
| Vector2 | 1, 1 | |
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |
ZIndex
| Type | Default | |
|---|---|---|
| int | 1 | |
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |