mission_task_tutorial_init

Source: base/tealdef/mission/tutorial/tasks/mission_task_tutorial_init.d.tl

Notes

Task that prepares the map at the start of the tutorial.

MissionTaskTutorialInit

record global base/tealdef/mission/tutorial/tasks/mission_task_tutorial_init.d.tl:3

global record MissionTaskTutorialInit is MissionInterface.TaskScript<MissionTaskTutorialInit.State, MissionTaskTutorialInit.Params>

Load: local tutorial_init = ug_require "::/mission/tutorial/tasks/tutorial_init.tl" as MissionTaskTutorialInit

Notes

First task of the base-game tutorial. Picks a story branch from the industries on the map, adjusts the capital's cargo needs, spawns missing industries and removes the road of the industry the player must connect.

MissionTaskTutorialInit.BranchId

enum base/tealdef/mission/tutorial/tasks/mission_task_tutorial_init.d.tl:4

enum BranchId

Notes

Tutorial story branch.

Used in the base game: 1 time in 1 file

base/content/mission/mission/tutorial/tasks/tutorial_init.tl:161

local getIndustryConName = function(branch : MissionTaskTutorialInit.BranchId) : ResName

Value	Description
"A"	Branch for maps with an oil platform (farm, oil refinery; vegetables and fuel).
"B"	Branch for maps with fishing grounds (forest, saw mill; fish and planks).

MissionTaskTutorialInit.PreparationState

enum base/tealdef/mission/tutorial/tasks/mission_task_tutorial_init.d.tl:8

enum PreparationState

Notes

Progress of the map preparation.

Value	Description
"Waiting"	Industries were requested; waiting one update.
"Ready"	Subventions paused; roads are removed next.
"Finished"	Preparation done; the task completes.
"Error"	The map does not support the tutorial; the task completes.

MissionTaskTutorialInit.Params

record base/tealdef/mission/tutorial/tasks/mission_task_tutorial_init.d.tl:14

record Params

Notes

Params of the tutorial init task.

Used in the base game: 15 times in 3 files

base/content/mission/mission/tutorial/tasks/tutorial_init.tl:6

local type P = MissionTaskTutorialInit.Params

base/content/mission/mission/tutorial/tutorial_story.tl:255

local init = getTaskState("init") as MissionInterface.TaskState<MissionTaskTutorialInit.State, MissionTaskTutorialInit.Params>

base/content/mission/mission/tutorial/tutorial_story_util.tl:284

local task = findTask("init") as MissionInterface.TaskState<MissionTaskTutorialInit.State, MissionTaskTutorialInit.Params>

Fields

Name	Type	Description
capital	Engine.Entity	Town in which the tutorial takes place.

MissionTaskTutorialInit.State

record base/tealdef/mission/tutorial/tasks/mission_task_tutorial_init.d.tl:17

record State

Notes

State of the tutorial init task.

Used in the base game: 15 times in 3 files

base/content/mission/mission/tutorial/tasks/tutorial_init.tl:5

local type S = MissionTaskTutorialInit.State

base/content/mission/mission/tutorial/tutorial_story.tl:255

local init = getTaskState("init") as MissionInterface.TaskState<MissionTaskTutorialInit.State, MissionTaskTutorialInit.Params>

base/content/mission/mission/tutorial/tutorial_story_util.tl:284

local task = findTask("init") as MissionInterface.TaskState<MissionTaskTutorialInit.State, MissionTaskTutorialInit.Params>

Fields

Name	Type	Description
branch	BranchId	Chosen story branch.
preparationState	PreparationState	Progress of the preparation.
industrySnapshot	EntityUtil.EntityAndRevision	The industry whose road was removed (farm or saw mill), with its revision. TutorialStoryUtil.getIndustryToConnect reads it.
industryResolved	boolean	true once the industry was picked, even if the snapshot is nil because the industry is gone.