# This file is automatically generated. Please don't edit it manually. # To submit a bug report on the content, see # https://devforum.roblox.com/c/bug-reports/documentation-issues/72 name: Decal type: class memory_category: GraphicsTexture summary: | Applies an image texture to a face of a parent `Class.BasePart`. description: | The `Class.Decal` object applies an image texture to a face of a parent `Class.BasePart`. The affected face is dependent on the `Class.Decal.Face|Face` property, and the size of the decal is dependent on the size of the face. The applied image texture is determined by its `Class.Decal.ColorMapContent|ColorMapContent` property. For details on how to upload images, see [asset management](../../../projects/assets/index.md#asset-management). For more information, review [textures and decals](../../../parts/textures-decals.md). See also: - `Class.Texture` for repeating surface images. - `Class.MeshPart.TextureContent` to apply an image texture to a `Class.MeshPart`. - `Class.SurfaceGui` to apply an `Class.ImageLabel` or `Class.ImageButton` to an in-experience 3D object. code_samples: [] inherits: - FaceInstance descendants: - Texture tags: [] deprecation_message: '' properties: - name: Decal.Color3 summary: | The `Datatype.Color3` tint of the `Class.Decal`. description: | The `Datatype.Color3` tint of the `Class.Decal`. Note that this property only sets the **tint** of the decal rather than the color; unless the image associated with the `Class.Decal` was originally pure white, then the color cannot be freely changed using this property. code_samples: - Decal-Color3 type: Color3 tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.ColorMap summary: | Content ID that determines the color and opacity of the surface. description: | This property takes a content ID to determine the color and opacity of the surface. This texture is sometimes called the **albedo** texture. code_samples: [] type: ContentId tags: - NotReplicated deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Appearance serialization: can_load: false can_save: false capabilities: - Basic - name: Decal.ColorMapContent summary: | `Datatype.Content` object that determines the color and opacity of the surface. description: | This property takes a `Datatype.Content` object to determine the color and opacity of the surface. This texture is sometimes called the **albedo** texture. code_samples: [] type: Content tags: - NotReplicated deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Appearance serialization: can_load: false can_save: false capabilities: - Basic - name: Decal.LocalTransparencyModifier summary: | Acts as a multiplier for the decal's `Class.Decal.Transparency|Transparency` property. The effects are only visible to the local player. description: | Acts as a multiplier for the decal's `Class.Decal.Transparency|Transparency` property. The effect is only visible to the `Class.Players.LocalPlayer|LocalPlayer` and will not replicate to the server. When this property is set to `1`, the `Class.Decal` will be completely invisible regardless of its original transparency. When it is set to `0`, the decal's rendered transparency will match the `Class.Decal.Transparency|Transparency` value. code_samples: [] type: float tags: - Hidden - NotReplicated deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Appearance serialization: can_load: false can_save: false capabilities: - Basic - name: Decal.MetalnessMap summary: '' description: '' code_samples: [] type: ContentId tags: - Hidden deprecation_message: '' security: read: PluginSecurity write: PluginSecurity thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.MetalnessMapContent summary: '' description: '' code_samples: [] type: Content tags: [] deprecation_message: '' security: read: None write: PluginSecurity thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.NormalMap summary: '' description: '' code_samples: [] type: ContentId tags: - Hidden deprecation_message: '' security: read: PluginSecurity write: PluginSecurity thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.NormalMapContent summary: '' description: '' code_samples: [] type: Content tags: [] deprecation_message: '' security: read: None write: PluginSecurity thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.RoughnessMap summary: '' description: '' code_samples: [] type: ContentId tags: - Hidden deprecation_message: '' security: read: PluginSecurity write: PluginSecurity thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.RoughnessMapContent summary: '' description: '' code_samples: [] type: Content tags: [] deprecation_message: '' security: read: None write: PluginSecurity thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.Shiny summary: '' description: | This property dictates how shiny the decal is. It takes a value between `0` and `1`, where `1` is "fully shiny." code_samples: [] type: float tags: - NotReplicated - Deprecated deprecation_message: | This non-functional property is deprecated and should not be used in new work. security: read: None write: None thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: false capabilities: - Basic - name: Decal.Specular summary: '' description: | Sets the specularity, which is how the surface responds to light being shined on it. code_samples: [] type: float tags: - NotReplicated - Deprecated deprecation_message: | This property no longer functions correctly and is deprecated. It should not be used in new work. security: read: None write: None thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: false capabilities: - Basic - name: Decal.Texture summary: | The content ID of the image to be applied by the `Class.Decal`. description: | The content ID of the image to be applied by the `Class.Decal`. code_samples: [] type: ContentId tags: [] deprecation_message: | This property has been deprecated. Use `Class.Decal.ColorMapContent|ColorMapContent` for future work. security: read: None write: None thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.TextureContent summary: | The texture content displayed by the `Class.Decal`. description: | The texture content displayed by the `Class.Decal`. Supports [asset URIs](../../../projects/assets/index.md#asset-uris) and `Class.EditableImage` objects. code_samples: [] type: Content tags: [] deprecation_message: | This property has been deprecated. Use `Class.Decal.ColorMapContent|ColorMapContent` for future work. security: read: None write: None thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.TexturePack summary: '' description: '' code_samples: [] type: ContentId tags: [] deprecation_message: '' security: read: RobloxEngineSecurity write: RobloxEngineSecurity thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.Transparency summary: | Determines the transparency of the `Class.Decal`. description: | Determines the transparency of the `Class.Decal` with `0` being completely opaque and `1` completely transparent. Note that `Class.Decal.LocalTransparencyModifier|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. code_samples: [] type: float tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.UVOffset summary: | Shifts the UV coordinates by adding an offset before texture mapping. description: | This property controls the UV coordinate translation. The `Datatype.Vector2.X|X` value (**U** offset) and `Datatype.Vector2.Y|Y` value (**V** offset) are added to every corresponding UV coordinate during texture mapping. code_samples: [] type: Vector2 tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.UVScale summary: | Stretches or compresses the UV coordinates by multiplying a scale factor. description: | This property controls the scale applied to the horizontal and vertical coordinates. The `Datatype.Vector2.X|X` value (**U** scale) and `Datatype.Vector2.Y|Y` value (**V** scale) are multiplied by every corresponding UV coordinate during texture mapping. code_samples: [] type: Vector2 tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic - name: Decal.ZIndex summary: | Determines the rendering order when multiple decals are assigned the same face. description: | This property determines the order in which decals on the same `Class.Decal.Face|Face` of a `Class.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. code_samples: [] type: int tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Appearance serialization: can_load: true can_save: true capabilities: - Basic methods: [] events: [] callbacks: []