Difference between revisions of "Grid Feature - atom description"

From Nebuchadnezzar Modding Wiki
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 8: Line 8:
 
! Name || Type || Default value /<br>Obligatory || Description
 
! Name || Type || Default value /<br>Obligatory || Description
 
|-
 
|-
|name || locale string || obligatory || Name of the grid type. Shown only in map editor.
+
|basic_ground_feature || bool || false || Feature representing basic ground.
 
|-
 
|-
|water_power || int || 0 || Determines how big is the surroundings in which this tile can irrigate other tiles.
+
|basic_water_feature || bool || false || Feature representing basic water.
|-
 
|water_repellent || bool || false || Water repelent tiles cannot be irrigated by no means.
 
|-
 
|features || vec_1D'''['''atom'''['''Grid_Feature''']]''' || obligatory || List of grid features.
 
|-
 
|surface_representant || atom'''['''Grid''']''' || null || Grid atom which is used, instead of this atom, for determination of Surface type.
 
 
|}
 
|}
  
 
=== Properties in detail ===
 
=== Properties in detail ===
==== features ====
+
==== basic_ground_feature ====
*Each Grid can support multiple "features".
+
*All buildings without defined required grid features are allowed to build on this feature.
*These features then describe additional properties.
 
  
==== surface_representant ====
+
==== basic_water_feature ====
*Sometimes you can have multiple Grid atoms which are different is some properties, but which do not influence which Surface should be used with them. For example ''soil'' without water power and ''soil'' with water power in base mod.
+
*All ships can move though tiles which have all 4 grids with this feature.
*In such cases is best to choose one of them as a representant because it reduces number of required surface atoms.
 
  
 
=== Example ===
 
=== Example ===
 
<pre>
 
<pre>
atom ('grid.stone',
+
-- ground
 +
atom ('gf.G',
 
{
 
{
     name = "@grid.stone",
+
     basic_ground_feature = true,
    features = {'gf.A', 'gf.G', 'gf.Si'},
 
    water_repellent = true,
 
 
})
 
})
  
atom ('grid.river',
+
-- water
 +
atom ('gf.W',
 
{
 
{
     name = "@grid.river",
+
     basic_water_feature = true,
    features = {'gf.A', 'gf.W'},
 
    water_power = 4,
 
 
})
 
})
 +
 +
-- fertile
 +
atom ('gf.F',
 +
{})
 +
 +
-- copper
 +
atom ('gf.Cu',
 +
{})
 +
 +
-- gold
 +
atom ('gf.Au',
 +
{})
 +
 +
-- stone
 +
atom ('gf.Si',
 +
{})
 +
 +
-- all
 +
atom ('gf.A',
 +
{})
 
</pre>
 
</pre>

Latest revision as of 11:58, 15 April 2021

<- back to all classes

General description[edit]

  • Grid Feature atoms represent additional properties of Grid atoms which can be referenced by buildings to limit construction only on tiles with specific Surface or Grid.
  • For example Grid Feature can represent water or metal deposits.

Properties description[edit]

Name Type Default value /
Obligatory
Description
basic_ground_feature bool false Feature representing basic ground.
basic_water_feature bool false Feature representing basic water.

Properties in detail[edit]

basic_ground_feature[edit]

  • All buildings without defined required grid features are allowed to build on this feature.

basic_water_feature[edit]

  • All ships can move though tiles which have all 4 grids with this feature.

Example[edit]

-- ground
atom ('gf.G',
{
    basic_ground_feature = true,
})

-- water
atom ('gf.W',
{
    basic_water_feature = true,
})

-- fertile
atom ('gf.F',
{})

-- copper
atom ('gf.Cu',
{})

-- gold
atom ('gf.Au',
{})

-- stone
atom ('gf.Si',
{})

-- all
atom ('gf.A',
{})