Decal

Show Deprecated

The Decal object is an object which applies an image to a face of a BasePart.

How does a Decal work?

A Decal will apply an image to the BasePart it is parented to. The surface this image is applied to is dependent on the FaceInstance.Face property. The size of the decal is dependent on the size of the face, meaning the size and aspect ratio of a decal can be changed by changing its parent's BasePart.Size.

The image a Decal applies is determined by its Decal.Texture property. Images can be uploaded to Roblox provided they adhere to the community guidelines.For information on how to upload images, see Textures and Decals.

Alternatives to Decals

Although Decals have a wide variety of applications, in some cases developers may wish to pick one of the following classes instead.

  • For repeated tiled textures, the Texture object should be used
  • To apply GUI elements, the SurfaceGui object should be used
  • If the effect of lighting on the image needs to be altered, the SurfaceGui object should be used

Code Samples

The following code will create a Part on the ground with a Decal applied to its top face. When something hits the part, such as when a player walks over it, the texture applied to the decal will change and a sound will play.

Changing Decal Texture
-- create part

local part = Instance.new("Part")

part.Size = Vector3.new(5, 1, 5)

part.Position = Vector3.new(0, 0.5, 0)

part.Anchored = true

part.TopSurface = Enum.SurfaceType.Smooth

part.BrickColor = BrickColor.new("Toothpaste")



-- create decal

local decal = Instance.new("Decal")

decal.Face = Enum.NormalId.Top

decal.Parent = part



-- create sound

local sound = Instance.new("Sound")

sound.SoundId = "rbxasset://sounds/uuhhh.mp3" -- oof

sound.Parent = part



-- define faces

local happyFace = "http://www.roblox.com/asset/?id=26424652"

local sadFace = "http://www.roblox.com/asset/?id=147144198"



decal.Texture = happyFace



-- touched event

local cooldown = false

part.Touched:Connect(function(hit)

	if not cooldown then

		if hit and hit.Parent then

			cooldown = true

			sound:Play()

			decal.Texture = sadFace

			task.wait(1)

			decal.Texture = happyFace

			task.wait(0.2)

			cooldown = false

		end

	end

end)



-- add to workspace

part.Parent = workspace

Summary

Properties

Properties inherited from FaceInstance

Properties

View all inherited from Instance
View all inherited from Object

Properties

Color3

Color3
Read Parallel

Code Samples

Decal Color3
local TweenService = game:GetService("TweenService")



local part = Instance.new("Part")

part.Size = Vector3.new(10, 10, 1)

part.Position = Vector3.new(0, 5, 0)

part.Anchored = true

part.Transparency = 1



local decal = Instance.new("Decal")

decal.Face = Enum.NormalId.Front

decal.Texture = "http://www.roblox.com/asset/?id=1145367640" -- white circle

decal.Parent = part



part.Parent = workspace



local redTween = TweenService:Create(

	decal,

	TweenInfo.new(1, Enum.EasingStyle.Linear, Enum.EasingDirection.Out),

	{ Color3 = Color3.new(1, 0, 0) }

)

local greenTween = TweenService:Create(

	decal,

	TweenInfo.new(1, Enum.EasingStyle.Linear, Enum.EasingDirection.Out),

	{ Color3 = Color3.new(0, 1, 0) }

)

local blueTween = TweenService:Create(

	decal,

	TweenInfo.new(1, Enum.EasingStyle.Linear, Enum.EasingDirection.Out),

	{ Color3 = Color3.new(0, 0, 1) }

)



while true do

	redTween:Play()

	redTween.Completed:Wait()

	greenTween:Play()

	greenTween.Completed:Wait()

	blueTween:Play()

	blueTween.Completed:Wait()

end

LocalTransparencyModifier

number
Hidden
Not Replicated
Read Parallel

Texture

ContentId
Read Parallel

Code Samples

Changing Decal Texture
-- create part

local part = Instance.new("Part")

part.Size = Vector3.new(5, 1, 5)

part.Position = Vector3.new(0, 0.5, 0)

part.Anchored = true

part.TopSurface = Enum.SurfaceType.Smooth

part.BrickColor = BrickColor.new("Toothpaste")



-- create decal

local decal = Instance.new("Decal")

decal.Face = Enum.NormalId.Top

decal.Parent = part



-- create sound

local sound = Instance.new("Sound")

sound.SoundId = "rbxasset://sounds/uuhhh.mp3" -- oof

sound.Parent = part



-- define faces

local happyFace = "http://www.roblox.com/asset/?id=26424652"

local sadFace = "http://www.roblox.com/asset/?id=147144198"



decal.Texture = happyFace



-- touched event

local cooldown = false

part.Touched:Connect(function(hit)

	if not cooldown then

		if hit and hit.Parent then

			cooldown = true

			sound:Play()

			decal.Texture = sadFace

			task.wait(1)

			decal.Texture = happyFace

			task.wait(0.2)

			cooldown = false

		end

	end

end)



-- add to workspace

part.Parent = workspace

TextureContent

Content
Read Parallel

Transparency

number
Read Parallel

Code Samples

Fading Decal
local TweenService = game:GetService("TweenService")



local part = Instance.new("Part")

part.Size = Vector3.new(10, 10, 1)

part.Position = Vector3.new(0, 5, 0)

part.Anchored = true

part.Transparency = 1



local decal = Instance.new("Decal")

decal.Face = Enum.NormalId.Front

decal.Texture = "http://www.roblox.com/asset/?id=699259085" -- roblox logo

decal.Parent = part



part.Parent = workspace



local tween = TweenService:Create(

	decal,

	TweenInfo.new(1, Enum.EasingStyle.Linear, Enum.EasingDirection.Out, -1, true),

	{ Transparency = 1 }

)



tween:Play()

ZIndex

number
Read Parallel
View all inherited from Instance
View all inherited from Object

Methods

View all inherited from Instance
View all inherited from Object

Events

View all inherited from Instance
View all inherited from Object