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,
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, SDF, textures, and data points.
Module Info
| Key | Value |
|---|---|
| File | extensions/editor/dynamicDecals/layerTypes/brushStroke.lua |
| logTag | editor_dynamicDecals_layerTypes_brushStroke |
| Dependencies | editor_api_dynamicDecals, editor_dynamicDecals_helper, editor_dynamicDecals_gizmo, editor_dynamicDecals_inspector, editor_dynamicDecals_inspector_utils, editor_dynamicDecals_docs, editor_dynamicDecals_widgets |
Public API
| Function | Signature | Description |
|---|---|---|
M.registerEditorPreferences | (prefsRegistry) | Stub |
M.editorPreferenceValueChanged | (path, value) | Stub |
M.setup | (tool_in) | Registers "Brush Stroke Properties" section (priority 1070), inspector GUI, and documentation |
Inspector Properties
The brush stroke inspector exposes these layer properties in a two-column layout:
| Property | Type | Description |
|---|---|---|
camPosition | vec3 | Camera position when stroke was recorded |
colorPaletteMapId | int (combo) | Vehicle color palette mapping (0=custom, 1-3=vehicle palettes) |
decalUseGradientColor | bool | Use gradient vs flat color |
color | Point4F | Flat decal color |
decalScale | vec3 | Decal scale (slider 0.05–6.0) |
decalRotation | float | Rotation in degrees |
decalUv | Point2F | Horizontal/vertical flip |
decalSkew | Point2F | Skew values |
mirrored / flipMirroredDecal | bool | Mirror settings |
colorTextureScale | Point2F | Color texture tiling scale |
alphaMask* | various | Alpha mask channel, blend mode, scale, rotation, intensity, wrap, invert |
interpolationSteps | int | Number of interpolated decals between stroke points |
sdf* | various | SDF thickness, softness, outline color/thickness/softness |
decal*TexturePath | string | Paths for color, alpha, normal, metallic, roughness textures |
dataPoints | table | Editable list of stroke sample points with move gizmo support |
Usage Example
-- Brush stroke layers are created by painting with the tool active
-- Interpolation steps control smoothness:
local api = extensions.editor_api_dynamicDecals
api.setBrushStrokeInterpolationSteps(5)See Also
- Dynamic Decals Layer Type: Decal - Related reference
- Dynamic Decals Layer Type: Fill - Related reference
- Dynamic Decals Layer Type: Group - Related reference
- World Editor Guide - Guide
Dynamic Decals Inspector Utils
Utility functions for the Dynamic Decals inspector. Provides reusable ImGui widgets for editing decal texture paths and gradient colors within layer inspectors.
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