mission_task_store_any¶

Source: base/tealdef/mission/tasks/utility/mission_task_store_any.d.tl

Notes

Task that stores a value computed at runtime for other tasks to read.

MissionTaskStoreAny¶

record global base/tealdef/mission/tasks/utility/mission_task_store_any.d.tl:3

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

Load: local store_any = ug_require "::/mission/tasks/utility/store_any.tl"

Notes

Task (store_any) that stores the first non-nil result of storeFn in its state and then completes. Other tasks read it through getTaskState(key).specific.data.

Details

The base-game tutorial stores its capital this way (store_capital) and reads it with TutorialStoryUtil.getCapital.

MissionTaskStoreAny.Params¶

record base/tealdef/mission/tasks/utility/mission_task_store_any.d.tl:4

record Params

Notes

Params of the task.

Used in the base game: 12 times in 5 files

base/content/mission/mission/tutorial/tutorial_story_branch_b.tl:46

local storeAny = task as MissionInterface.TaskState<MissionTaskStoreAny.State, MissionTaskStoreAny.Params>

base/content/mission/mission/tutorial/tutorial_story_branch_a.tl:46

local storeAny = task as MissionInterface.TaskState<MissionTaskStoreAny.State, MissionTaskStoreAny.Params>

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

local storeAny = task as MissionInterface.TaskState<MissionTaskStoreAny.State, MissionTaskStoreAny.Params>

base/content/mission/mission/tasks/utility/store_any.tl:3

local type P = MissionTaskStoreAny.Params

mods/release/urbangames_campaign_mission_01/content/mission/mission/mission_story.tl:1562

local storeAny = getTaskState("store_decision") as MissionInterface.TaskState<MissionTaskStoreAny.State, MissionTaskStoreAny.Params>

Functions

storeFn(readOnlyApi : MissionInterface.MissionTaskReadOnlyApi) : any base/tealdef/mission/tasks/utility/mission_task_store_any.d.tl:5

Notes

Computes the value to store; called every update until it returns a value.

Parameter	Type	Description
`readOnlyApi`	`MissionInterface.MissionTaskReadOnlyApi`	Read-only mission API.

Returns any: Value to store, or nil to try again.

MissionTaskStoreAny.State¶

record base/tealdef/mission/tasks/utility/mission_task_store_any.d.tl:7

record State

Notes

State of the task.

Used in the base game: 12 times in 5 files

base/content/mission/mission/tutorial/tutorial_story_branch_b.tl:46

local storeAny = task as MissionInterface.TaskState<MissionTaskStoreAny.State, MissionTaskStoreAny.Params>

base/content/mission/mission/tutorial/tutorial_story_branch_a.tl:46

local storeAny = task as MissionInterface.TaskState<MissionTaskStoreAny.State, MissionTaskStoreAny.Params>

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

local storeAny = task as MissionInterface.TaskState<MissionTaskStoreAny.State, MissionTaskStoreAny.Params>

base/content/mission/mission/tasks/utility/store_any.tl:2

local type S = MissionTaskStoreAny.State

mods/release/urbangames_campaign_mission_01/content/mission/mission/mission_story.tl:1562

local storeAny = getTaskState("store_decision") as MissionInterface.TaskState<MissionTaskStoreAny.State, MissionTaskStoreAny.Params>

Fields

Name	Type	Description
`data`	`any`	Stored value.
`waitForEngineSwap`	`boolean`	Delays completion by one update after the value was stored.