mission_task_subsidies¶
Source: base/tealdef/mission/tasks/subsidies/mission_task_subsidies.d.tl
Notes
Task that offers subsidies (subventions) and waits until all are completed or failed.
MissionTaskSubsidies¶
record global base/tealdef/mission/tasks/subsidies/mission_task_subsidies.d.tl:3
global record MissionTaskSubsidies is MissionInterface.TaskScript<MissionTaskSubsidies.State, MissionTaskSubsidies.Params>
Load: local subsidies = ug_require "::/mission/tasks/subsidies/subsidies.tl"
Notes
Task (subsidies) that spawns subventions through the Subvention script and completes when none of them is still proposed or being verified. Its progress counts completed subsidies against those not failed.
MissionTaskSubsidies.Params¶
record base/tealdef/mission/tasks/subsidies/mission_task_subsidies.d.tl:4
record Params
Notes
Params of the task.
Used in the base game: 22 times in 4 files
base/content/mission/mission/tasks/subsidies/subsidies.tl:4
base/content/mission/mission/tasks/subsidies/guide_subsidies.tl:3
local ret : MissionInterface.TaskScript<DecoratorState<MissionTaskSubsidies.State, MissionTaskGuideSubsidies.State>, DecoratorParam<MissionTaskSubsidies.Params,
mods/release/urbangames_campaign_mission_06/content/mission/mission/mission_story_cutscene_only.tl:21
local subsidies = ug_require "::/mission/tasks/subsidies/subsidies.tl" as MissionInterface.TaskScript<MissionTaskSubsidies.State, MissionTaskSubsidies.Params>
mods/release/urbangames_campaign_mission_06/content/mission/mission/mission_story.tl:19
Fields
| Name | Type | Description |
|---|---|---|
subsidies |
{{ResName, ISubvention.ISpecificSubventionParam}} |
List of { subvention type, specific params } to spawn at start. |
Functions
getOptionalSubsidies(readOnlyApi : MissionInterface.MissionTaskReadOnlyApi) : {{ResName, ISubvention.ISpecificSubventionParam}} base/tealdef/mission/tasks/subsidies/mission_task_subsidies.d.tl:6
Notes
Returns more subsidies to spawn once; the task waits until it has returned a list.
| Parameter | Type | Description |
|---|---|---|
readOnlyApi |
MissionInterface.MissionTaskReadOnlyApi |
Read-only mission API. |
Returns {{ResName, ISubvention.ISpecificSubventionParam}}: List of { subvention type, specific params }, or nil to try again.
MissionTaskSubsidies.Status¶
enum base/tealdef/mission/tasks/subsidies/mission_task_subsidies.d.tl:8
enum Status
Notes
Status of one spawned subsidy.
Used in the base game: 4 times in 2 files
base/content/mission/mission/tasks/subsidies/subsidies.tl:26
local getSubsidyIndex = function(subsidies : {{number, MissionTaskSubsidies.Status}}, uid : number) : integer
mods/release/urbangames_campaign_mission_06/content/mission/mission/mission_story.tl:169
MissionTaskSubsidies.State¶
record base/tealdef/mission/tasks/subsidies/mission_task_subsidies.d.tl:14
record State
Notes
State of the task.
Used in the base game: 19 times in 4 files
base/content/mission/mission/tasks/subsidies/subsidies.tl:3
base/content/mission/mission/tasks/subsidies/guide_subsidies.tl:3
local ret : MissionInterface.TaskScript<DecoratorState<MissionTaskSubsidies.State, MissionTaskGuideSubsidies.State>, DecoratorParam<MissionTaskSubsidies.Params,
mods/release/urbangames_campaign_mission_06/content/mission/mission/mission_story_cutscene_only.tl:21
local subsidies = ug_require "::/mission/tasks/subsidies/subsidies.tl" as MissionInterface.TaskScript<MissionTaskSubsidies.State, MissionTaskSubsidies.Params>
mods/release/urbangames_campaign_mission_06/content/mission/mission/mission_story.tl:19
Fields
| Name | Type | Description |
|---|---|---|
subsidies |
{{number, Status}} |
List of { uid, status } of the spawned subsidies. |
optionalSubsidiesSpawned |
boolean |
The optional subsidies were spawned. |