KIND Texture

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(Example Config.txt: annotate, tablize approximating config.txt spacings)
(Rewrite.)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[KIND Texture]] exposes a simple texture as an asset. These can be referenced by [[KUID]] for use as a custom corona, for example.
+
[[KIND Texture]] defines a single texture as an asset that can be referenced from another asset or via scripting.
 +
 
 +
Making a texture available as an asset may reduce resource requirements where the texture is used by a number of assets, and may assist in maintaining consistency between different variations of the same basic asset. [[KIND Texture-group]] serves a similar function where there are multiple textures associated with a group of assets.
  
=KIND Hierarchy=
 
 
==Parent Classes==
 
==Parent Classes==
 
* [[KIND TrainzBaseSpec]]
 
* [[KIND TrainzBaseSpec]]
 
==Child Classes==
 
==Child Classes==
* ''none.''
+
* [[KIND Groundtexture]]
  
 
==Supported Tags==
 
==Supported Tags==
TBD.
+
The KIND Texture config.txt file supports the following tags. Each tag is shown here with its default value.
 +
 
 +
texture <null>
 +
subblend 0
 +
subrotation 0
 +
 
 +
====texture====
 +
:Type: [[Texture file]]
 +
:Compulsory: 3.4
 +
:Default: None
 +
:Description:  Name of texture. Note that this is a [[texture file]], not an image file.  See example below.
 +
 
 +
====subblend====
 +
:Type: Float
 +
:Compulsory: No
 +
:Default: 0.00
 +
:Description:  ''TBD''
 +
 
 +
====subrotation====
 +
:Type: Float
 +
:Compulsory: No
 +
:Default: 0.00
 +
:Description:  ''TBD''
  
 
==Example Config.txt==
 
==Example Config.txt==
*'''[[Texture file]]s''' are ASCII specification files (text format) instructing ContentManager (CM) how to render each single texture.
+
 
*Texture files have a ".texture.txt" name extension within the assets' folder
+
kuid                                    <kuid:101046:104687>
*Texture files within a config.txt file such as the below ''MUST NOT'' have the ''''.txt'''' extension, or CM will generate an error.
+
username                                "Corona Red diffuse"
<tt>
+
kind                                    "texture"
{|width="100%" text-align="center" float="center" bgcolor="#E6E6FA"<!--#F0F8FF" --->
+
trainz-build                           3.5
|- border="1"
+
texture                                "orange.texture"
| '''Tag or structure braces''' || '''Data fields'''
+
category-class                          "JC"
|-
+
category-era                           "1800s"
| kuid ||<kuid:56113:1267>
+
category-region                        "AU"
|-
+
description                            "A Red corona.
| trainz-build || 2.5
+
subblend                                0.50
|-
+
subrotation                            45.00
| category-class || "JO"
+
thumbnails
|-
+
{
| category-region|| "AU"
+
  0
|-
+
  {
| category-era || "2000s;2010s"
+
    image                               "$screenshot$.jpg"
|-
+
    width                               240
| username || "testTexture"
+
    height                             180
|-
+
  }
| kind || "texture"
+
}
|-
+
 
| '''texture || "eg.texture"'''
+
The above "texture" tag value 'orange.texture' specifies a [[Texture file]] which contains the information about the image to be used for the texture.
|-
+
 
| thumbnails||
+
==See Also==
|-
+
* [[KIND Texture-group]]
| { ||
+
* [[KIND Groundtexture]]
|-
+
0||
+
|-
+
|  &nbsp; &nbsp; &nbsp; {||
+
|-
+
|  &nbsp; &nbsp; &nbsp;  image || "thumb.jpg"
+
|-
+
|  &nbsp; &nbsp; &nbsp;  width || 240
+
|-
+
|  &nbsp; &nbsp; &nbsp;  height || 180
+
|-
+
| &nbsp; &nbsp; &nbsp; }||
+
|-
+
| }||
+
|}
+
</tt>
+
The above "texture" tag specifies a [[Texture file]] located within the asset folder.
+
  
 
==Categories==
 
==Categories==
[[Category:Asset KIND]]
+
[[Category:Asset KIND|Texture]]
[[Category:TBD]]
+
[[Category:TBD|Texture]]

Latest revision as of 15:49, 28 April 2019

KIND Texture defines a single texture as an asset that can be referenced from another asset or via scripting.

Making a texture available as an asset may reduce resource requirements where the texture is used by a number of assets, and may assist in maintaining consistency between different variations of the same basic asset. KIND Texture-group serves a similar function where there are multiple textures associated with a group of assets.

Contents

[edit] Parent Classes

[edit] Child Classes

[edit] Supported Tags

The KIND Texture config.txt file supports the following tags. Each tag is shown here with its default value.

texture <null>
subblend 0
subrotation 0 

[edit] texture

Type: Texture file
Compulsory: 3.4
Default: None
Description: Name of texture. Note that this is a texture file, not an image file. See example below.

[edit] subblend

Type: Float
Compulsory: No
Default: 0.00
Description: TBD

[edit] subrotation

Type: Float
Compulsory: No
Default: 0.00
Description: TBD

[edit] Example Config.txt

kuid                                    <kuid:101046:104687>
username                                "Corona Red diffuse"
kind                                    "texture"
trainz-build                            3.5
texture                                 "orange.texture"
category-class                          "JC"
category-era                            "1800s"
category-region                         "AU"
description                             "A Red corona.
subblend                                0.50
subrotation                             45.00
thumbnails
{
  0
  {
    image                               "$screenshot$.jpg"
    width                               240
    height                              180
  }
}

The above "texture" tag value 'orange.texture' specifies a Texture file which contains the information about the image to be used for the texture.

[edit] See Also

[edit] Categories

Personal tools