Skip to content

mission_task_check_entities

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

Notes

Task that checks that all entities referenced by the mission params exist.

MissionTaskCheckEntities

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

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

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

Notes

Task (check_entities) that checks that every entity in a mission params table exists (keys entity_*, entityList_*, entityListBulldozable_*, entityMap_*). It completes only if all exist; otherwise an error is logged and it stays open.

Example

-- urbangames_campaign_mission_01
if taskKey == "check_entities" then
    return {
        taskScript = check_entities as MissionInterface.TaskScript<any, any>,
        taskParams = { params = params },
    }
end

MissionTaskCheckEntities.Params

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

record Params

Notes

Params of the task.

Used in the base game: 2 times in 1 file

base/content/mission/mission/tasks/utility/check_entities.tl:36

onSpawn = function(params : MissionTaskCheckEntities.Params) : MissionTaskCheckEntities.State

Fields

Name Type Description
params table Mission params table to check.

MissionTaskCheckEntities.State

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

record State

Notes

State of the task.

Used in the base game: 2 times in 1 file

base/content/mission/mission/tasks/utility/check_entities.tl:36

onSpawn = function(params : MissionTaskCheckEntities.Params) : MissionTaskCheckEntities.State

Fields

Name Type Description
pass boolean All entities exist.