Difference between revisions of "Grass - atom description"

From Nebuchadnezzar Modding Wiki
Jump to navigation Jump to search
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[Atom types|<- back to all classes]]
 
[[Atom types|<- back to all classes]]
 
=== General description ===
 
=== General description ===
[[File:grid_surface2.png]]
+
[[File:grass.png]]
*Surface atoms represent '''graphical representation''' of each tile.
+
*Grass represent addition graphics which visualize irrigated tiles.
*Type of Surface on specific tile is '''determined by set [[Grid - atom description|Grid]] atoms''' of its four vertices.
+
*Similar to Surface graphics it may (must) represent trnsition between different degree of irrigation.
*In the image above you can see single Surface in the '''cyan rhombus''' and its four Grid in the '''red rects'''.
 
**Left and bottom Grit atoms are of type ''soil'' and top and right are of type ''desert'', so the result Surface atom is transition from ''soil'' to ''desert''.
 
  
 
=== Properties description ===
 
=== Properties description ===
Line 11: Line 9:
 
! Name || Type || Default value /<br>Obligatory || Description
 
! Name || Type || Default value /<br>Obligatory || Description
 
|-
 
|-
|grid || atom<Grid> || obligatory || Main Grid of this Surface
+
|masques || vec_1D'''['''masque, 15''']''' || obligatory || Vector of masques for all 15 transtions.
 
|-
 
|-
|masque || masque || obligatory || Surface masque.
+
|transition || vec_1D'''['''int, 2''']''' || obligatory || Transition type.
|-
 
|transition_grid || atom<Grid> || null || Transition Grid of this Surface
 
|-
 
|transition_type || int || obligatory if<br>transition_grid set || Transition type between ''grid'' and ''transition_grid''
 
|-
 
|grass || atom<Grass> || null || Grass representation atom.
 
|-
 
|grass_ending || atom<Grass> || null || Grass ending representation atom.
 
 
|}
 
|}
  
 
=== Properties in detail ===
 
=== Properties in detail ===
==== grid ====
+
==== masques ====
*Grid atom for which this Surface is representant.
+
*Masques vector must contains 15 masques for 15 types of transition in the same way how it's described in [[Surface - atom description|Surface]] atom.
*When all vertices of a tile has this Grid type, then this Surface is used.
+
*First type is 1 (''0001'') and the last type is 15 (''1111''), which is strictly speaking not a transition.
*It also serves as on of two transition Grids for transition tiles.
+
 
 +
==== transition ====
 +
*It's a vector of two numbers, which determines the degrees of irrigation between which this grass is used.
  
==== transition_grid ====
+
=== Example ===
*Second Grid if this Surface serves as transition tile.
+
<pre>
 +
atom ('grass.1_0',
 +
{
 +
    masques = {{
 +
        {"images/surface/grass/grass_d_5.png"},
 +
        {"images/surface/grass/grass_d1_5.png"},
 +
        {"images/surface/grass/grass_d2_5.png"},
 +
        {"images/surface/grass/grass_d3_5.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_6.png"},
 +
        {"images/surface/grass/grass_d1_6.png"},
 +
        {"images/surface/grass/grass_d2_6.png"},
 +
        {"images/surface/grass/grass_d3_6.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_1.png"},
 +
        {"images/surface/grass/grass_d1_1.png"},
 +
        {"images/surface/grass/grass_d2_1.png"},
 +
        {"images/surface/grass/grass_d3_1.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_7.png"},
 +
        {"images/surface/grass/grass_d1_7.png"},
 +
        {"images/surface/grass/grass_d2_7.png"},
 +
        {"images/surface/grass/grass_d3_7.png"},
 +
    }, {
 +
        {"images/surface/grass/grass_d_13.png"},
 +
        {"images/surface/grass/grass_d1_13.png"},
 +
        {"images/surface/grass/grass_d2_13.png"},
 +
        {"images/surface/grass/grass_d3_13.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_2.png"},
 +
        {"images/surface/grass/grass_d1_2.png"},
 +
        {"images/surface/grass/grass_d2_2.png"},
 +
        {"images/surface/grass/grass_d3_2.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_10.png"},
 +
        {"images/surface/grass/grass_d1_10.png"},
 +
        {"images/surface/grass/grass_d2_10.png"},
 +
        {"images/surface/grass/grass_d3_10.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_8.png"},
 +
        {"images/surface/grass/grass_d1_8.png"},
 +
        {"images/surface/grass/grass_d2_8.png"},
 +
        {"images/surface/grass/grass_d3_8.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_4.png"},
 +
        {"images/surface/grass/grass_d1_4.png"},
 +
        {"images/surface/grass/grass_d2_4.png"},
 +
        {"images/surface/grass/grass_d3_4.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_14.png"},
 +
        {"images/surface/grass/grass_d1_14.png"},
 +
        {"images/surface/grass/grass_d2_14.png"},
 +
        {"images/surface/grass/grass_d3_14.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_9.png"},
 +
        {"images/surface/grass/grass_d1_9.png"},
 +
        {"images/surface/grass/grass_d2_9.png"},
 +
        {"images/surface/grass/grass_d3_9.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_3.png"},
 +
        {"images/surface/grass/grass_d1_3.png"},
 +
        {"images/surface/grass/grass_d2_3.png"},
 +
        {"images/surface/grass/grass_d3_3.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_12.png"},
 +
        {"images/surface/grass/grass_d1_12.png"},
 +
        {"images/surface/grass/grass_d2_12.png"},
 +
        {"images/surface/grass/grass_d3_12.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_11.png"},
 +
        {"images/surface/grass/grass_d1_11.png"},
 +
        {"images/surface/grass/grass_d2_11.png"},
 +
        {"images/surface/grass/grass_d3_11.png"},
 +
    },{
 +
        {"images/surface/grass/grass_d_15.png"},
 +
        {"images/surface/grass/grass_d1_15.png"},
 +
        {"images/surface/grass/grass_d2_15.png"},
 +
        {"images/surface/grass/grass_d3_15.png"},
 +
    }},
  
==== transition_type ====
+
    transition = {1, 0},
*Type of transition between ''grid'' and ''transition_grid''.
+
})
*It's a number which describe which vertices have ''grid'' and which have ''transtion_grid'' by it's binary format.
+
</pre>
**Vertices are counted in clockwise order starting with the top vertex.
 
**It means that meaningful values here are numbers between 1 and 14.
 
*For example value ''3'', in binary ''0011'' means that top and right vertices must have ''grid'' type and bottom and left vertices must have ''transition_grid''.
 
**As in the image above.
 
==== grass ====
 
*Addition graphics when the tile is irrigated.
 
==== grass_ending ====
 
*Addition graphics when the tile is irrigated but at the same time it's on the border of area which do not show grass.
 
*For example tile under some buildings or grid type which does not allow irrigation.
 

Latest revision as of 15:31, 17 February 2021

<- back to all classes

General description[edit]

Grass.png

  • Grass represent addition graphics which visualize irrigated tiles.
  • Similar to Surface graphics it may (must) represent trnsition between different degree of irrigation.

Properties description[edit]

Name Type Default value /
Obligatory
Description
masques vec_1D[masque, 15] obligatory Vector of masques for all 15 transtions.
transition vec_1D[int, 2] obligatory Transition type.

Properties in detail[edit]

masques[edit]

  • Masques vector must contains 15 masques for 15 types of transition in the same way how it's described in Surface atom.
  • First type is 1 (0001) and the last type is 15 (1111), which is strictly speaking not a transition.

transition[edit]

  • It's a vector of two numbers, which determines the degrees of irrigation between which this grass is used.

Example[edit]

atom ('grass.1_0',
{
    masques = {{
        {"images/surface/grass/grass_d_5.png"},
        {"images/surface/grass/grass_d1_5.png"},
        {"images/surface/grass/grass_d2_5.png"},
        {"images/surface/grass/grass_d3_5.png"},
    },{
        {"images/surface/grass/grass_d_6.png"},
        {"images/surface/grass/grass_d1_6.png"},
        {"images/surface/grass/grass_d2_6.png"},
        {"images/surface/grass/grass_d3_6.png"},
    },{
        {"images/surface/grass/grass_d_1.png"},
        {"images/surface/grass/grass_d1_1.png"},
        {"images/surface/grass/grass_d2_1.png"},
        {"images/surface/grass/grass_d3_1.png"},
    },{
        {"images/surface/grass/grass_d_7.png"},
        {"images/surface/grass/grass_d1_7.png"},
        {"images/surface/grass/grass_d2_7.png"},
        {"images/surface/grass/grass_d3_7.png"},
    }, {
        {"images/surface/grass/grass_d_13.png"},
        {"images/surface/grass/grass_d1_13.png"},
        {"images/surface/grass/grass_d2_13.png"},
        {"images/surface/grass/grass_d3_13.png"},
    },{
        {"images/surface/grass/grass_d_2.png"},
        {"images/surface/grass/grass_d1_2.png"},
        {"images/surface/grass/grass_d2_2.png"},
        {"images/surface/grass/grass_d3_2.png"},
    },{
        {"images/surface/grass/grass_d_10.png"},
        {"images/surface/grass/grass_d1_10.png"},
        {"images/surface/grass/grass_d2_10.png"},
        {"images/surface/grass/grass_d3_10.png"},
    },{
        {"images/surface/grass/grass_d_8.png"},
        {"images/surface/grass/grass_d1_8.png"},
        {"images/surface/grass/grass_d2_8.png"},
        {"images/surface/grass/grass_d3_8.png"},
    },{
        {"images/surface/grass/grass_d_4.png"},
        {"images/surface/grass/grass_d1_4.png"},
        {"images/surface/grass/grass_d2_4.png"},
        {"images/surface/grass/grass_d3_4.png"},
    },{
        {"images/surface/grass/grass_d_14.png"},
        {"images/surface/grass/grass_d1_14.png"},
        {"images/surface/grass/grass_d2_14.png"},
        {"images/surface/grass/grass_d3_14.png"},
    },{
        {"images/surface/grass/grass_d_9.png"},
        {"images/surface/grass/grass_d1_9.png"},
        {"images/surface/grass/grass_d2_9.png"},
        {"images/surface/grass/grass_d3_9.png"},
    },{
        {"images/surface/grass/grass_d_3.png"},
        {"images/surface/grass/grass_d1_3.png"},
        {"images/surface/grass/grass_d2_3.png"},
        {"images/surface/grass/grass_d3_3.png"},
    },{
        {"images/surface/grass/grass_d_12.png"},
        {"images/surface/grass/grass_d1_12.png"},
        {"images/surface/grass/grass_d2_12.png"},
        {"images/surface/grass/grass_d3_12.png"},
    },{
        {"images/surface/grass/grass_d_11.png"},
        {"images/surface/grass/grass_d1_11.png"},
        {"images/surface/grass/grass_d2_11.png"},
        {"images/surface/grass/grass_d3_11.png"},
    },{
        {"images/surface/grass/grass_d_15.png"},
        {"images/surface/grass/grass_d1_15.png"},
        {"images/surface/grass/grass_d2_15.png"},
        {"images/surface/grass/grass_d3_15.png"},
    }},

    transition = {1, 0},
})