Decal¶
Applies an image texture to a face of a parent BasePart.
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.
Inheritance¶
Object → Instance → FaceInstance → Decal
Nova inheritance: Instance → FaceInstance → Decal
Known subclasses: Texture
Properties¶
Color Supported Property
Color3 Supported Property The Color3 tint of the Decal.
LocalTransparencyModifier Supported Property Acts as a multiplier for the decal's Transparency property. The effects are only visible to the local player.
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.
Shiny Supported Property Deprecated Legacy decal shininess. Nova stores it, but the renderer does not use it.
Legacy decal shininess. Nova stores it, but the renderer does not use it.
The property is still scriptable and serialized, but Nova's decal renderer does not consume the stored shininess value.
Specular Supported Property Deprecated Legacy decal specularity. Nova stores it, but the renderer does not use it.
Legacy decal specularity. Nova stores it, but the renderer does not use it.
The property is still scriptable and serialized, but Nova's decal renderer does not consume the stored specular value.
Texture Supported Property Deprecated The content ID of the image to be applied by the Decal.
The content ID of the image to be applied by the Decal.
Transparency Supported Property Determines the transparency of the Decal.
Determines the transparency of the Decal.
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.
ZIndex Supported Property Determines the rendering order when multiple decals are assigned the same face.
Determines the rendering order when multiple decals are assigned the same face.
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.
Inherited members¶
Inherited from FaceInstance: 9 properties, 36 methods, 7 events. They are documented on the base class page.
16 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's Decal class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
AutoLocalize |
AutoLocalize: bool |
Not yet | When set to true, the decal's image asset is eligible for automatic localization capture. |
— |
ColorMap |
ColorMap: ContentId |
Not yet | Content ID that determines the color and opacity of the surface. | NotReplicated |
ColorMapContent |
ColorMapContent: Content |
Not yet | Content object that determines the color and opacity of the surface. | NotReplicated |
EmissiveMaskContent |
EmissiveMaskContent: Content |
Not yet | Content object that determines the emissivity across the surface. | read None / write PluginSecurity |
EmissiveStrength |
EmissiveStrength: float |
Not yet | Determines the strength of the emissive contribution. | — |
EmissiveTint |
EmissiveTint: Color3 |
Not yet | Determines the tinting color for the emissive contribution. | — |
LocalizedTextureContent |
LocalizedTextureContent: Content |
Not yet | — | ReadOnly, NotReplicated, RobloxScriptSecurity |
MetalnessMapContent |
MetalnessMapContent: Content |
Not yet | Content object that determines the metalness map of the surface. | read None / write PluginSecurity |
NormalMapContent |
NormalMapContent: Content |
Not yet | Content object that determines the normal map of the surface. | read None / write PluginSecurity |
Rotation |
Rotation: float |
Not yet | Rotates the decal texture. | — |
RoughnessMapContent |
RoughnessMapContent: Content |
Not yet | Content object that determines the roughness map of the surface. | read None / write PluginSecurity |
TextureContent |
TextureContent: Content |
Not yet | The texture content displayed by the Decal. | — |
TexturePack |
TexturePack: ContentId |
Not yet | — | RobloxSecurity |
TexturePackContent |
TexturePackContent: Content |
Not yet | Engine-managed Content that stores the compressed runtime texture-pack data for PBR decals. | RobloxSecurity |
UVOffset |
UVOffset: Vector2 |
Not yet | Shifts the UV coordinates by adding an offset before texture mapping. | — |
UVScale |
UVScale: Vector2 |
Not yet | Stretches or compresses the UV coordinates by multiplying a scale factor. | — |
Roblox reference: Decal
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.