Decal
Renders a 2D image in 3D space, Supports editable images, Parented under a BasePart.
Properties
| Property | Type | Default |
|---|---|---|
Transparency | number | 0 |
Color3 | Color3 | Color3.new(1, 1, 1) |
Texture | string | "./src/assets/images/placeholder.png" |
ColorMapContent | string | "./src/assets/images/placeholder.png" |
Face | EnumItem | Enum.NormalId.Top |
Adornee | any | nil |
Position | Vector3 | Vector3.new(0, 0, 0) |
Wrap | boolean | false |
Depth | number | 0.1 |
NormalThreshold | number | 0 |
FadeWidth | number | 0 |
Functions
`getFaceSize`
`getFaceCFrame`
`buildBaseDecal`
`resolveTextureSource`
`loadAlbedoMap`
`loadAlbedoMapFromEditable`
`applyAlbedoColor`
`applyDecalSettings`
`applyFaceOffset`
`syncAlbedo`
getFaceSize
Arguments
size, faceReturns
This function returns nothing.
getFaceCFrame
Arguments
cf, size, faceReturns
This function returns nothing.
buildBaseDecal
Arguments
This function takes no arguments.
Returns
This function returns nothing.
resolveTextureSource
Arguments
instanceReturns
This function returns nothing.
loadAlbedoMap
Arguments
path, colorReturns
This function returns nothing.
loadAlbedoMapFromEditable
Arguments
editableImage, colorReturns
This function returns nothing.
applyAlbedoColor
Arguments
decal, color, transparencyReturns
This function returns nothing.
applyDecalSettings
Arguments
instance, decalReturns
This function returns nothing.
applyFaceOffset
Arguments
cf, offsetReturns
This function returns nothing.
syncAlbedo
Arguments
forceReturns
This function returns nothing.
API
instance:getFaceSize(size, face)
instance:getFaceCFrame(cf, size, face)
instance:buildBaseDecal()
instance:resolveTextureSource(instance)
instance:loadAlbedoMap(path, color)
instance:loadAlbedoMapFromEditable(editableImage, color)
instance:applyAlbedoColor(decal, color, transparency)
instance:applyDecalSettings(instance, decal)
instance:applyFaceOffset(cf, offset)
instance:syncAlbedo(force)