Dynamic Decals Layer Type: Decal
Editor module for the Decal layer type - the primary building block of the Dynamic Decals tool. Provides the "Decal Properties" section, inspector GUI, SDF introduction window, font character selectio
Editor module for the Decal layer type - the primary building block of the Dynamic Decals tool. Provides the "Decal Properties" section, inspector GUI, SDF introduction window, font character selection, and extensive property editing for scale, rotation, color, gradient, textures, masks, mirroring, mesh filtering, and SDF effects.
Module Info
| Key | Value |
|---|---|
| File | extensions/editor/dynamicDecals/layerTypes/decal.lua |
| logTag | editor_dynamicDecals_layerTypes_decal |
| Dependencies | editor_api_dynamicDecals, editor_api_dynamicDecals_textures, editor_dynamicDecals_brushes, editor_dynamicDecals_inspector, editor_dynamicDecals_inspector_utils, editor_dynamicDecals_helper, editor_dynamicDecals_docs, editor_dynamicDecals_widgets, editor_dynamicDecals_fonts |
Public API
| Function | Signature | Description |
|---|---|---|
M.isTexturesSdfCompatible | (texturePath?) | Checks if a texture's sidecar metadata marks it as SDF-compatible |
M.checkColorDecalTexturesSdfCompatible | () | Checks current color texture and shows SDF intro window if compatible |
M.showSdfIntroWindow | () | Opens the SDF introduction editor window |
M.hideSdfIntroWindow | () | Hides the SDF introduction window |
M.registerEditorPreferences | (prefsRegistry) | Registers decal and inspector preferences |
M.editorPreferenceValueChanged | (path, value) | Stub |
M.setup | (tool_in) | Registers "Decal Properties" section (priority 60), inspector GUI, docs, editor windows |
M.editModeUpdate | (dtReal, dtSim, dtRaw) | Updates SDF highlight timer |
Preferences
| Path | Type | Default | Description |
|---|---|---|---|
dynamicDecalsTool.decalProperties.scaleStep | float | 0.025 | Scale increment step |
dynamicDecalsTool.decalProperties.rotationStep | float | 15 | Rotation step in degrees |
dynamicDecalsTool.decalProperties.texturePreviewSize | float | 128 | Texture thumbnail max width |
dynamicDecalsTool.decalProperties.doNotShowSdfIntroAgain | bool | false | Suppress SDF intro popup |
dynamicDecalsTool.inspector.applyMirroredPropertyToChildren | bool | true | Propagate mirror changes to children |
Section GUI Features
- Save as brush, scale/rotation/flip/skew controls
- Mirror toggle with offset slider and debug visualization
- Surface normal projection toggle
- Texture tree: font path, font character, color/alpha textures, gradient color
- SDF properties: enable, thickness, softness, outline color/thickness/softness, preview
- Alpha mask: channel, blend mode, intensity, rotation, scale, wrap, invert, offset
- Metallic/roughness intensity
- Color palette mapping with vehicle color preview button
Usage Example
local api = extensions.editor_api_dynamicDecals
local decal = extensions.editor_dynamicDecals_layerTypes_decal
-- Set a texture and check SDF compatibility
api.setDecalTexturePath("color", "/art/dynamicDecals/textures/star.png")
decal.checkColorDecalTexturesSdfCompatible()
-- Toggle SDF
api.setSdfEnabled(true)
api.setSdfThickness(0.5)
api.setSdfOutlineThickness(0.2)See Also
- Dynamic Decals Layer Type: Brush Stroke - Related reference
- Dynamic Decals Layer Type: Fill - Related reference
- Dynamic Decals Layer Type: Group - Related reference
- World Editor Guide - Guide
Dynamic Decals Layer Type: Brush Stroke
Editor module for the Brush Stroke layer type in the Dynamic Decals tool. Provides inspector GUI and section GUI for configuring brush stroke properties such as interpolation, color, scale, rotation,
Dynamic Decals Layer Type: Fill
Editor module for the Fill layer type. Fill layers apply a single solid color across the entire vehicle surface. Provides a modal "Add Fill Layer" window, color palette mapping, inspector GUI, and a t