Difference between revisions of "Description Mission - atom description"

From Nebuchadnezzar Modding Wiki
Jump to navigation Jump to search
(Created page with "<- back to all classes === General description === *City atom represent other citites in the world you can trade with. *It also used to define player city on th...")
 
 
(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 ===
−
*City atom represent other citites in the world you can trade with.
+
*Contains mission description used in the mission screens.
−
*It also used to define player city on the world map.
 
  
 
=== Properties description ===
 
=== Properties description ===
Line 8: Line 7:
 
! Name || Type || Default value /<br>Obligatory || Description
 
! Name || Type || Default value /<br>Obligatory || Description
 
|-
 
|-
−
|name || locale string || obligatory || Name of the city.
+
|title || locale&nbsp;string || obligatory || Mission title.
 
|-
 
|-
−
|position || vec_1D'''['''int, 2''']''' || obligatory || Position of the city on the world map.
+
|period || int2 || obligatory || Time period of the mission in years. Use negative numbers for BC years.
 
|-
 
|-
−
|label_alignment || vec_1D'''['''int, 2''']''' || obligatory || Alignment of city label on the world map.
+
|period_in_title || bool || obligatory || Show mission period in it's title.
 
|-
 
|-
−
|label_position || vec_1D'''['''int, 2''']''' || obligatory || Additional offset for city label on the world map.
+
|map || texture || obligatory || Mission description image. Shown in the missions list screen, mission screen and mission Adviser tab.
 
|-
 
|-
−
|home_bezier_offset || vec_1D'''['''int, 2''']'''  || obligatory || Home city offset for open trade bezier curve start position.
+
|short_description || locale&nbsp;string || obligatory || Mission summary description. Shown in the missions list screen.
 
|-
 
|-
−
|this_bezier_offset || vec_1D'''['''int, 2''']''' || obligatory || This city offset for open trade bezier curve end position.
+
|long_description || vec_1D'''['''locale&nbsp;string''']''' || obligatory || Paragraphs of mission full description. Shown in the mission screen and mission Adviser tab.
 
|-
 
|-
−
|control_point || vec_1D'''['''int, 2''']'''  || obligatory || Control point position for open trade bezier curve.
+
|city || locale&nbsp;string || obligatory || Name of the mission city.
 
|-
 
|-
−
|export_goods || vec_1D'''['''atom'''['''[[Goods - atom description|Goods]]''']]''' || obligatory || List of goods player's city can export to this city.
+
|city_description || vec_1D'''['''locale&nbsp;string''']''' || obligatory || Paragraphs of mission city description. Shown in the mission screen and mission Adviser tab.
 
|-
 
|-
−
|import_goods || vec_1D'''['''atom'''['''[[Goods - atom description|Goods]]''']]''' || obligatory || List of goods player's city can import from this city.
+
|victory || texture || obligatory || Mission victory image. Shown im mission completed dialog.
−
|-
 
−
|export_limits || vec_1D'''['''int''']''' || obligatory || Maximal year trade volume for export goods.
 
−
|-
 
−
|import_limits || vec_1D'''['''int''']''' || obligatory || Maximal year trade volume for import goods.
 
−
|-
 
−
|export_prices || vec_1D'''['''int''']''' || obligatory || Base prices for export goods.
 
−
|-
 
−
|import_prices || vec_1D'''['''int''']''' || obligatory || Base prices for import goods.
 
−
|-
 
−
|open_trade_goods || vec_1D'''['''atom'''['''[[Goods - atom description|Goods]]''']]''' || empty vec || List of goods player can choose from to open trade route.
 
−
|-
 
−
|open_trade_count || vec_1D'''['''int''']''' || empty vec || Required amount of goods to open trade goods.
 
−
|-
 
−
|min_prestige || int || 0 || Required prestige to open trade route.
 
−
|-
 
−
|max_prestige || int || 0 || Maximal value of prestige for computation prestige component of city relation.
 
−
|-
 
−
|prestige_reached_event || atom'''['''[[Event - atom description|Event]]''']''' || null || Event when reach city required prestige.
 
−
|-
 
−
|trade_direction || string || obligatory || Direction from city trade ship will arrive.
 
−
|-
 
−
|trade_ship || atom'''['''[[Ship Trade - atom description|Ship Trade]]''']''' || null || Ship used as trade ship with this city.
 
 
|}
 
|}
  
 
=== Properties in detail ===
 
=== Properties in detail ===
−
==== position ====
+
==== Map ====
−
*It's position in pixels from the top left cornder of map texture.
+
*Mission description image. Shown in the missions list screen, mission screen and mission Adviser tab.
−
==== label alignment ====
+
*Size should be <code>637 x 464</code>
−
*Use ''-1'' for left/top alignment
+
==== Victory ====
−
*Use ''0'' for center alignment
+
*Mission victory image. Shown im mission completed dialog.
−
*Use ''1'' for right/bottom alignment
+
*Size should be <code>489 x 247</code>
−
==== max_prestige ====
 
−
*If defined then the prestige component of city relation is computed as ratio between current prestige and this max prestige multiply by maximal value of prestige relation component.
 
  
 
=== Example ===
 
=== Example ===
 
<pre>
 
<pre>
−
atom ('city.nz.13.jerusalem',
+
atom ('mission.description.nz.11',
 
{
 
{
−
     name = "@city.jerusalem",
+
     title = "@mission.nz.11",
−
     position = {170, 210},
+
     period = {-722, -705},
−
    label_position = {-10, 13},
+
     period_in_title = true,
−
     label_alignment = {1, 0},
+
     map = "images/ui/maps/mission_11.png",
−
 
+
     short_description = "@mission.nz.11.desc",
−
     control_point = {218, 183},
+
     long_description = {
−
     home_bezier_offset = {0, 0},
+
         "@mission.nz.11.a",
−
    this_bezier_offset = {0, 0},
+
         "@mission.nz.11.b",
−
 
+
         "@mission.nz.11.c",
−
     import_goods = {
+
         "@mission.nz.11.d",
−
         'goods.brick',
 
−
         'goods.dye',
 
−
    },
 
−
    import_limits = {
 
−
         90,
 
−
         100,
 
−
    },
 
−
    import_prices = {
 
−
        15,
 
−
        35,
 
−
    },
 
−
 
 
−
    export_goods = {
 
−
        'goods.gold_jewels',
 
−
        'goods.grapes',
 
 
     },
 
     },
−
     export_limits = {
+
     city = "@mission.nz.11.city",
−
         60,
+
    city_description = {
−
        30,
+
         "@mission.nz.11.city.a",
 
     },
 
     },
−
     export_prices = {
+
     victory = "images/ui/victory_image.png",
−
        85,
 
−
        40,
 
−
    },
 
−
 
 
−
    open_trade_goods = {
 
−
        'goods.gold_jewels',
 
−
        'goods.grapes',
 
−
        'goods.ceramic',
 
−
    },
 
−
    open_trade_count = {
 
−
        20,
 
−
        35,
 
−
        35,
 
−
    },
 
−
 
 
−
    trade_direction = "north",
 
−
    trade_ship = 'ship.trade',
 
−
 
 
−
    prestige_reached_event = 'event.city_reached',
 
−
    min_prestige = 550,
 
−
    max_prestige = 1800,
 
 
})
 
})
 
</pre>
 
</pre>

Latest revision as of 17:49, 16 April 2021

<- back to all classes

General description[edit]

  • Contains mission description used in the mission screens.

Properties description[edit]

Name Type Default value /
Obligatory		 Description
title locale string obligatory Mission title.
period int2 obligatory Time period of the mission in years. Use negative numbers for BC years.
period_in_title bool obligatory Show mission period in it's title.
map texture obligatory Mission description image. Shown in the missions list screen, mission screen and mission Adviser tab.
short_description locale string obligatory Mission summary description. Shown in the missions list screen.
long_description vec_1D[locale string] obligatory Paragraphs of mission full description. Shown in the mission screen and mission Adviser tab.
city locale string obligatory Name of the mission city.
city_description vec_1D[locale string] obligatory Paragraphs of mission city description. Shown in the mission screen and mission Adviser tab.
victory texture obligatory Mission victory image. Shown im mission completed dialog.

Properties in detail[edit]

Map[edit]

  • Mission description image. Shown in the missions list screen, mission screen and mission Adviser tab.
  • Size should be 637 x 464

Victory[edit]

  • Mission victory image. Shown im mission completed dialog.
  • Size should be 489 x 247

Example[edit]

atom ('mission.description.nz.11',
{
    title = "@mission.nz.11",
    period = {-722, -705},
    period_in_title = true,
    map = "images/ui/maps/mission_11.png",
    short_description = "@mission.nz.11.desc",
    long_description = {
        "@mission.nz.11.a",
        "@mission.nz.11.b",
        "@mission.nz.11.c",
        "@mission.nz.11.d",
    },
    city = "@mission.nz.11.city",
    city_description = {
        "@mission.nz.11.city.a",
    },
    victory = "images/ui/victory_image.png",
})
Retrieved from "https://modding.nepos.games/subdom/modding/index.php?title=Description_Mission_-_atom_description&oldid=463"