Difference between revisions of "Documentation/Engine/Units/accessory paint job data"

From SCS Modding Wiki
Jump to navigation Jump to search
(...Still WIP. Not much time for wiki-ing today.)
(Required/Optional column replaced with Default Value; To be populated when I have more complete info from Max (when he is done hosting the plague))
Line 15: Line 15:
 
!Name
 
!Name
 
![[Documentation/Engine/Units#Attribute_types|Type]]
 
![[Documentation/Engine/Units#Attribute_types|Type]]
!Required/Optional
+
!Default Value
 
!Modes
 
!Modes
 
!Description
 
!Description
Line 21: Line 21:
 
|mask_r_color
 
|mask_r_color
 
|rowspan="3"|float3
 
|rowspan="3"|float3
|rowspan="3"|optional
+
|rowspan="3"|
 
|rowspan="3"|colormask
 
|rowspan="3"|colormask
 
|rowspan="3"|Defines the default color applied to each channel of the color mask.
 
|rowspan="3"|Defines the default color applied to each channel of the color mask.
Line 31: Line 31:
 
|base_color
 
|base_color
 
|float3
 
|float3
|required
+
|
 
|all
 
|all
 
|Defines the default color of the paint job.
 
|Defines the default color of the paint job.
Line 37: Line 37:
 
|mask_r_locked
 
|mask_r_locked
 
|rowspan="3"|bool
 
|rowspan="3"|bool
|rowspan="3"|optional
+
|rowspan="3"|
 
|rowspan="3"|colormask
 
|rowspan="3"|colormask
 
|rowspan="3"|When false, the player may change each channel's color via the color picker.
 
|rowspan="3"|When false, the player may change each channel's color via the color picker.
Line 47: Line 47:
 
|base_color_locked
 
|base_color_locked
 
|bool
 
|bool
|required
+
|
 
|all
 
|all
 
|When false, the player may change the base color via the color picker.
 
|When false, the player may change the base color via the color picker.
Line 53: Line 53:
 
|flip_color_locked
 
|flip_color_locked
 
|bool
 
|bool
|optional
+
|
 
|flipflake
 
|flipflake
 
|When false, the player may change the flip color via the color picker.
 
|When false, the player may change the flip color via the color picker.
Line 59: Line 59:
 
|flake_color_locked
 
|flake_color_locked
 
|bool
 
|bool
|optional
+
|
 
|flipflake
 
|flipflake
 
|When false, the player may change the flake color via the color picker.
 
|When false, the player may change the flake color via the color picker.
Line 65: Line 65:
 
|flip_color
 
|flip_color
 
|float3
 
|float3
|optional
+
|
 
|flipflake
 
|flipflake
 
|
 
|
Line 71: Line 71:
 
|flip_strength
 
|flip_strength
 
|float
 
|float
|optional
+
|
 
|flipflake
 
|flipflake
 
|
 
|
Line 77: Line 77:
 
|flake_color
 
|flake_color
 
|float3
 
|float3
|optional
+
|
 
|flipflake
 
|flipflake
 
|
 
|
Line 83: Line 83:
 
|flake_uvscale
 
|flake_uvscale
 
|float
 
|float
|optional
+
|
 
|flipflake
 
|flipflake
 
|
 
|
Line 89: Line 89:
 
|flake_density
 
|flake_density
 
|float
 
|float
|optional
+
|
 
|flipflake
 
|flipflake
 
|
 
|
Line 95: Line 95:
 
|flake_shininess
 
|flake_shininess
 
|float
 
|float
|optional
+
|
 
|flipflake
 
|flipflake
 
|
 
|
Line 101: Line 101:
 
|flake_clearcoat_rolloff
 
|flake_clearcoat_rolloff
 
|float
 
|float
|optional
+
|
 
|flipflake
 
|flipflake
 
|
 
|
Line 107: Line 107:
 
|flake_noise
 
|flake_noise
 
|string
 
|string
|optional
+
|
 
|flipflake
 
|flipflake
 
|Path to the flipflake texture.
 
|Path to the flipflake texture.
Line 113: Line 113:
 
|flipflake
 
|flipflake
 
|bool
 
|bool
|optional
+
|
 
|
 
|
 
|When true, flipflake (metallic/pearlescent) behavior and attributes are enabled. Cannot be used with colormask.
 
|When true, flipflake (metallic/pearlescent) behavior and attributes are enabled. Cannot be used with colormask.
Line 119: Line 119:
 
|airbrush
 
|airbrush
 
|bool
 
|bool
|optional
+
|
 
|
 
|
 
|When true, airbrush behavior and attributes are enabled. Cannot be used with colormask.
 
|When true, airbrush behavior and attributes are enabled. Cannot be used with colormask.
Line 125: Line 125:
 
|alternate_uvset
 
|alternate_uvset
 
|bool
 
|bool
|optional
+
|
 
|all
 
|all
 
|When true, the resulting material will have the ''altuv'' flavor. This triggers usage of the alternate UV layout, if configured.
 
|When true, the resulting material will have the ''altuv'' flavor. This triggers usage of the alternate UV layout, if configured.
Line 131: Line 131:
 
|stock
 
|stock
 
|bool
 
|bool
|required
+
|
 
|all
 
|all
 
|Defaults to '''true'''. This was previously used to mark paintjobs available when purchasing a truck when true, and only available from the upgrade shop when false. Currently must be set to '''false''' to avoid undesirable behavior.
 
|Defaults to '''true'''. This was previously used to mark paintjobs available when purchasing a truck when true, and only available from the upgrade shop when false. Currently must be set to '''false''' to avoid undesirable behavior.
Line 137: Line 137:
 
|paint_job_mask
 
|paint_job_mask
 
|string
 
|string
|optional
+
|
 
|colormask, airbrush
 
|colormask, airbrush
 
|Defines the path to the texture resource (.tobj) to be used for color masking (colormask) or for blending (airbrush).
 
|Defines the path to the texture resource (.tobj) to be used for color masking (colormask) or for blending (airbrush).
Line 143: Line 143:
 
|base_texture
 
|base_texture
 
|string
 
|string
|optional
+
|
 
|all
 
|all
 
|Can be used to override the base texture of the truckpaint material. Requires that all truckpaint materials on the vehicle use the same base texture in the first place.
 
|Can be used to override the base texture of the truckpaint material. Requires that all truckpaint materials on the vehicle use the same base texture in the first place.

Revision as of 18:46, 22 September 2016

The accessory_paint_job_data unit class is used to define paint jobs for trucks and trailers (as of ETS2 1.25/ATS 1.4).

Usage

Airbrush

In the airbrush mode, the RGB of paint_job_mask is blended with the base color, using the alpha channel as the blend factor. This mode is active when the attribute airbrush is true.

Colormask

In the colormask mode, each of paint_job_mask's color channels (RGB) acts as a mask for a color being blended over the base texture. They are applied in the order blue, green, and red. So the red channel has the highest “priority”, followed by green and then blue.

TIP: Texture compression can lead to some minor aliasing at sharp boundaries between the mask channels. To avoid colors ‘bleeding through’ at these boundaries, try blending some of the lower-priority channel ‘under’ the higher-priority channel along their shared boundary. For example, at a sharp boundary between the red (255, 0, 0) and green (0, 255, 0) channels, a thin line of the base color may be visible. This can be mitigated by extending the edge of the lower-priority mask ‘under’ the higher-priority mask. So in the case where there is a sharp line between the red mask and the green mask, the green mask should be extended slightly into the area of the red mask. The resultant color looking at the RGB image would be yellow (255, 255, 0).

Flipflake

Attributes

Many common attributes are inherited from accessory_data.

Name Type Default Value Modes Description
mask_r_color float3 colormask Defines the default color applied to each channel of the color mask.
mask_g_color
mask_b_color
base_color float3 all Defines the default color of the paint job.
mask_r_locked bool colormask When false, the player may change each channel's color via the color picker.
mask_g_locked
mask_b_locked
base_color_locked bool all When false, the player may change the base color via the color picker.
flip_color_locked bool flipflake When false, the player may change the flip color via the color picker.
flake_color_locked bool flipflake When false, the player may change the flake color via the color picker.
flip_color float3 flipflake
flip_strength float flipflake
flake_color float3 flipflake
flake_uvscale float flipflake
flake_density float flipflake
flake_shininess float flipflake
flake_clearcoat_rolloff float flipflake
flake_noise string flipflake Path to the flipflake texture.
flipflake bool When true, flipflake (metallic/pearlescent) behavior and attributes are enabled. Cannot be used with colormask.
airbrush bool When true, airbrush behavior and attributes are enabled. Cannot be used with colormask.
alternate_uvset bool all When true, the resulting material will have the altuv flavor. This triggers usage of the alternate UV layout, if configured.
stock bool all Defaults to true. This was previously used to mark paintjobs available when purchasing a truck when true, and only available from the upgrade shop when false. Currently must be set to false to avoid undesirable behavior.
paint_job_mask string colormask, airbrush Defines the path to the texture resource (.tobj) to be used for color masking (colormask) or for blending (airbrush).
base_texture string all Can be used to override the base texture of the truckpaint material. Requires that all truckpaint materials on the vehicle use the same base texture in the first place.

Raw Unit Definition

  "accessory_paint_job_data":{
   "superclass":"accessory_data",
   "attrs":{
    "name":{
     "type": "string"
    },
    "short_name":{
     "type": "string"
    },
    "icon":{
     "type": "string"
    },
    "info":{
     "type": "string_array"
    },
    "price":{
     "type": "s64"
    },
    "unlock":{
     "type": "uint"
    },
    "suitable_for":{
     "type": "string_array"
    },
    "conflict_with":{
     "type": "string_array"
    },
    "defaults":{
     "type": "string_array"
    },
    "require":{
     "type": "token_array"
    },
    "mask_r_color":{
     "type": "float3"
    },
    "mask_g_color":{
     "type": "float3"
    },
    "mask_b_color":{
     "type": "float3"
    },
    "base_color":{
     "type": "float3"
    },
    "mask_r_locked":{
     "type": "bool"
    },
    "mask_g_locked":{
     "type": "bool"
    },
    "mask_b_locked":{
     "type": "bool"
    },
    "base_color_locked":{
     "type": "bool"
    },
    "flip_color_locked":{
     "type": "bool"
    },
    "flake_color_locked":{
     "type": "bool"
    },
    "flip_color":{
     "type": "float3"
    },
    "flip_strength":{
     "type": "float"
    },
    "flake_color":{
     "type": "float3"
    },
    "flake_uvscale":{
     "type": "float"
    },
    "flake_density":{
     "type": "float"
    },
    "flake_shininess":{
     "type": "float"
    },
    "flake_clearcoat_rolloff":{
     "type": "float"
    },
    "flake_noise":{
     "type": "string"
    },
    "flipflake":{
     "type": "bool"
    },
    "airbrush":{
     "type": "bool"
    },
    "alternate_uvset":{
     "type": "bool"
    },
    "stock":{
     "type": "bool"
    },
    "paint_job_mask":{
     "type": "string"
    },
    "base_texture":{
     "type": "string"
    }
   }
  },