Difference between revisions of "Documentation/Engine/Units/accessory paint job data"
< Documentation | Engine | Units
Jump to navigation
Jump to search
(→Attributes: Added descriptions for most flipflake attributes) |
|||
| Line 24: | Line 24: | ||
|mask_r_color | |mask_r_color | ||
|rowspan="3"|float3 | |rowspan="3"|float3 | ||
| − | | | + | |(1, 0, 0) |
|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. | ||
|- | |- | ||
|mask_g_color | |mask_g_color | ||
| + | |(0, 1, 0) | ||
|- | |- | ||
|mask_b_color | |mask_b_color | ||
| + | |(0, 0, 1) | ||
|- | |- | ||
|base_color | |base_color | ||
|float3 | |float3 | ||
| − | | | + | |(1, 1, 1) |
|all | |all | ||
|Defines the default color of the paint job. | |Defines the default color of the paint job. | ||
| Line 40: | Line 42: | ||
|mask_r_locked | |mask_r_locked | ||
|rowspan="3"|bool | |rowspan="3"|bool | ||
| − | | | + | |true |
|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. | ||
|- | |- | ||
|mask_g_locked | |mask_g_locked | ||
| + | |true | ||
|- | |- | ||
|mask_b_locked | |mask_b_locked | ||
| + | |true | ||
|- | |- | ||
|base_color_locked | |base_color_locked | ||
|bool | |bool | ||
| − | | | + | |true |
|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 56: | Line 60: | ||
|flip_color_locked | |flip_color_locked | ||
|bool | |bool | ||
| − | | | + | |true |
|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 62: | Line 66: | ||
|flake_color_locked | |flake_color_locked | ||
|bool | |bool | ||
| − | | | + | |true |
|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 68: | Line 72: | ||
|flip_color | |flip_color | ||
|float3 | |float3 | ||
| − | | | + | |(1, 0, 0) |
|flipflake | |flipflake | ||
|Defines the color of the flip effect. | |Defines the color of the flip effect. | ||
| Line 74: | Line 78: | ||
|flip_strength | |flip_strength | ||
|float | |float | ||
| − | | | + | |0.27 |
|flipflake | |flipflake | ||
|Defines the relative strength of the flip effect. | |Defines the relative strength of the flip effect. | ||
| Line 80: | Line 84: | ||
|flake_color | |flake_color | ||
|float3 | |float3 | ||
| − | | | + | |(0, 1, 0) |
|flipflake | |flipflake | ||
|Defines the color of the flake effect. | |Defines the color of the flake effect. | ||
| Line 86: | Line 90: | ||
|flake_uvscale | |flake_uvscale | ||
|float | |float | ||
| − | | | + | |32.0 |
|flipflake | |flipflake | ||
|Defines how many times the flake_noise texture repeats within one UV tile. (Another way to think of this is that the UV coordinates are divided by this factor when addressing flake_noise.) | |Defines how many times the flake_noise texture repeats within one UV tile. (Another way to think of this is that the UV coordinates are divided by this factor when addressing flake_noise.) | ||
| Line 92: | Line 96: | ||
|flake_density | |flake_density | ||
|float | |float | ||
| − | | | + | |1.0 |
|flipflake | |flipflake | ||
|Defines how 'tight' the flake effect is to the specular highlight. Higher values result in a smaller area of the flake effect, while smaller values result in a broad area having it. | |Defines how 'tight' the flake effect is to the specular highlight. Higher values result in a smaller area of the flake effect, while smaller values result in a broad area having it. | ||
| Line 98: | Line 102: | ||
|flake_shininess | |flake_shininess | ||
|float | |float | ||
| − | | | + | |50.0 |
|flipflake | |flipflake | ||
| | | | ||
| Line 104: | Line 108: | ||
|flake_clearcoat_rolloff | |flake_clearcoat_rolloff | ||
|float | |float | ||
| − | | | + | |2.2 |
|flipflake | |flipflake | ||
|Adjusts the sharpness of the clearcoat specular highlight. Higher values yield sharper edges. | |Adjusts the sharpness of the clearcoat specular highlight. Higher values yield sharper edges. | ||
| Line 110: | Line 114: | ||
|flake_noise | |flake_noise | ||
|string | |string | ||
| − | | | + | |"/material/custom/flake_noise.tobj" |
|flipflake | |flipflake | ||
|Path to the flipflake texture. The RGB component multiplies the flake_color, and the A component masks the flake effect. | |Path to the flipflake texture. The RGB component multiplies the flake_color, and the A component masks the flake effect. | ||
| Line 116: | Line 120: | ||
|flipflake | |flipflake | ||
|bool | |bool | ||
| − | | | + | |false |
| | | | ||
|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 122: | Line 126: | ||
|airbrush | |airbrush | ||
|bool | |bool | ||
| − | | | + | |false |
| | | | ||
|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 128: | Line 132: | ||
|alternate_uvset | |alternate_uvset | ||
|bool | |bool | ||
| − | | | + | |false |
|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 134: | Line 138: | ||
|stock | |stock | ||
|bool | |bool | ||
| − | | | + | |false |
|all | |all | ||
| − | |Defaults to ''' | + | |Defaults to '''false'''. 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 | |paint_job_mask | ||
|string | |string | ||
| − | | | + | |"" |
| − | | | + | |all |
| − | |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). If empty mask is ignored and final result is composed purely from color attributes. |
| + | <!-- | ||
|- | |- | ||
|base_texture | |base_texture | ||
| Line 149: | Line 154: | ||
|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 12:01, 20 June 2017
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).
Contents
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).
Attributes
Many common attributes are inherited from accessory_data.
| Name | Type | Default Value | Modes | Description |
|---|---|---|---|---|
| mask_r_color | float3 | (1, 0, 0) | colormask | Defines the default color applied to each channel of the color mask. |
| mask_g_color | (0, 1, 0) | |||
| mask_b_color | (0, 0, 1) | |||
| base_color | float3 | (1, 1, 1) | all | Defines the default color of the paint job. |
| mask_r_locked | bool | true | colormask | When false, the player may change each channel's color via the color picker. |
| mask_g_locked | true | |||
| mask_b_locked | true | |||
| base_color_locked | bool | true | all | When false, the player may change the base color via the color picker. |
| flip_color_locked | bool | true | flipflake | When false, the player may change the flip color via the color picker. |
| flake_color_locked | bool | true | flipflake | When false, the player may change the flake color via the color picker. |
| flip_color | float3 | (1, 0, 0) | flipflake | Defines the color of the flip effect. |
| flip_strength | float | 0.27 | flipflake | Defines the relative strength of the flip effect. |
| flake_color | float3 | (0, 1, 0) | flipflake | Defines the color of the flake effect. |
| flake_uvscale | float | 32.0 | flipflake | Defines how many times the flake_noise texture repeats within one UV tile. (Another way to think of this is that the UV coordinates are divided by this factor when addressing flake_noise.) |
| flake_density | float | 1.0 | flipflake | Defines how 'tight' the flake effect is to the specular highlight. Higher values result in a smaller area of the flake effect, while smaller values result in a broad area having it. |
| flake_shininess | float | 50.0 | flipflake | |
| flake_clearcoat_rolloff | float | 2.2 | flipflake | Adjusts the sharpness of the clearcoat specular highlight. Higher values yield sharper edges. |
| flake_noise | string | "/material/custom/flake_noise.tobj" | flipflake | Path to the flipflake texture. The RGB component multiplies the flake_color, and the A component masks the flake effect. |
| flipflake | bool | false | When true, flipflake (metallic/pearlescent) behavior and attributes are enabled. Cannot be used with colormask. | |
| airbrush | bool | false | When true, airbrush behavior and attributes are enabled. Cannot be used with colormask. | |
| alternate_uvset | bool | false | all | When true, the resulting material will have the altuv flavor. This triggers usage of the alternate UV layout, if configured. |
| stock | bool | false | all | Defaults to false. 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 | "" | all | Defines the path to the texture resource (.tobj) to be used for color masking (colormask) or for blending (airbrush). If empty mask is ignored and final result is composed purely from color attributes. |
