Difference between revisions of "Description Mission - atom description"

From Nebuchadnezzar Modding Wiki
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 9: Line 9:
 
|title || locale string || obligatory || Mission title.
 
|title || locale string || obligatory || Mission title.
 
|-
 
|-
|period || int2 || obligatory || Time period of the mission. Use negative number of BC.
+
|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.
 
|period_in_title || bool || obligatory || Show mission period in it's title.
Line 23: Line 23:
 
|city_description || vec_1D'''['''locale string''']''' || obligatory || Paragraphs of mission city description. Shown in the mission screen and mission Adviser tab.
 
|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.
+
|victory || texture || obligatory || Mission victory image. Shown im mission completed dialog.
 
|}
 
|}
  
Line 31: Line 31:
 
*Size should be <code>637 x 464</code>
 
*Size should be <code>637 x 464</code>
 
==== Victory ====
 
==== Victory ====
*Mission description image. Shown in the missions list screen, mission screen and mission Adviser tab.
+
*Mission victory image. Shown im mission completed dialog.
 
*Size should be <code>489 x 247</code>
 
*Size should be <code>489 x 247</code>
  

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",
})