mission_task_collect_entity

Source: base/tealdef/mission/tasks/click_and_collect_custom_entity/mission_task_collect_entity.d.tl

Notes

Task in which the player collects custom entities by clicking them.

MissionTaskCollectEntity

record global base/tealdef/mission/tasks/click_and_collect_custom_entity/mission_task_collect_entity.d.tl:3

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

Load: local collect_entity = ug_require "::/mission/tasks/click_and_collect_custom_entity/collect_entity.tl"

Notes

Task (collect_entity) in which the player selects custom entities to collect them. A collected entity is removed with a dust effect and an optional sound. The task completes when all are collected; with more than one entity it shows a counter.

Details

The entities must be non-bulldozable. The campaign mods spawn them with MissionTaskSpawnEntity and read their ids from that task in getEntities.

MissionTaskCollectEntity.Params

record base/tealdef/mission/tasks/click_and_collect_custom_entity/mission_task_collect_entity.d.tl:5

record Params

Make sure the entities used here are non-bulldozable!

Used in the base game: 23 times in 8 files

base/content/mission/mission/tasks/guide/guide_collect_entity.tl:3

ctx : MissionInterface.TaskContext<DecoratorState<MissionTaskCollectEntity.State, MissionTaskGuideCollectEntity.State>, DecoratorParam<MissionTaskCollectEntity.

base/content/mission/mission/tasks/click_and_collect_custom_entity/collect_entity.tl:4

local type P = MissionTaskCollectEntity.Params

mods/release/urbangames_campaign_mission_03/content/mission/mission/mission_story_cutscenes_only.tl:14

local collect_entity = ug_require "::/mission/tasks/click_and_collect_custom_entity/collect_entity.tl" as MissionInterface.TaskScript<MissionTaskCollectEntity.S

mods/release/urbangames_campaign_mission_03/content/mission/mission/mission_story.tl:17

local collect_entity = ug_require "::/mission/tasks/click_and_collect_custom_entity/collect_entity.tl" as MissionInterface.TaskScript<MissionTaskCollectEntity.S

mods/release/urbangames_campaign_mission_01/content/mission/mission/mission_story_cutscenes_only.tl:20

local collect_entity = ug_require "::/mission/tasks/click_and_collect_custom_entity/collect_entity.tl" as MissionInterface.TaskScript<MissionTaskCollectEntity.S

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

local collect_entity = ug_require "::/mission/tasks/click_and_collect_custom_entity/collect_entity.tl" as MissionInterface.TaskScript<MissionTaskCollectEntity.S

… and 2 more files.

Fields

Name	Type	Description
markers	{MissionInterface.Marker}
models	{string}
positions	{{number, number, number}}
zones	{MissionInterface.Zone}	Zones shown while the task is open.
entities	{Engine.Entity}	Entities to collect.
justRemove	boolean	Removes all entities at once and completes.
soundEffectFile	string	Sound played when an entity is collected.
terrainHeightCheck	boolean	Ignores clicks on entities below the terrain.
useSelectorEntityFilter	boolean	Only the entities to collect can be selected while the task is open.

Functions

getEntities(readOnlyApi : MissionInterface.MissionTaskReadOnlyApi) : {Engine.Entity} base/tealdef/mission/tasks/click_and_collect_custom_entity/mission_task_collect_entity.d.tl:11

Notes

Returns the entities to collect at the first update; replaces entities.

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

Returns {Engine.Entity}: Entities.

MissionTaskCollectEntity.State

record base/tealdef/mission/tasks/click_and_collect_custom_entity/mission_task_collect_entity.d.tl:18

record State

Notes

State of the task.

Used in the base game: 21 times in 8 files

base/content/mission/mission/tasks/guide/guide_collect_entity.tl:3

ctx : MissionInterface.TaskContext<DecoratorState<MissionTaskCollectEntity.State, MissionTaskGuideCollectEntity.State>, DecoratorParam<MissionTaskCollectEntity.

base/content/mission/mission/tasks/click_and_collect_custom_entity/collect_entity.tl:3

local type S = MissionTaskCollectEntity.State

mods/release/urbangames_campaign_mission_03/content/mission/mission/mission_story_cutscenes_only.tl:14

local collect_entity = ug_require "::/mission/tasks/click_and_collect_custom_entity/collect_entity.tl" as MissionInterface.TaskScript<MissionTaskCollectEntity.S

mods/release/urbangames_campaign_mission_03/content/mission/mission/mission_story.tl:17

local collect_entity = ug_require "::/mission/tasks/click_and_collect_custom_entity/collect_entity.tl" as MissionInterface.TaskScript<MissionTaskCollectEntity.S

mods/release/urbangames_campaign_mission_01/content/mission/mission/mission_story_cutscenes_only.tl:20

local collect_entity = ug_require "::/mission/tasks/click_and_collect_custom_entity/collect_entity.tl" as MissionInterface.TaskScript<MissionTaskCollectEntity.S

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

local collect_entity = ug_require "::/mission/tasks/click_and_collect_custom_entity/collect_entity.tl" as MissionInterface.TaskScript<MissionTaskCollectEntity.S

… and 2 more files.

Fields

Name	Type	Description
observed	{Engine.Entity : boolean}	Entity -> collected.
runtimeEntityIds	{Engine.Entity}	Entities to collect.
removed	{Engine.Entity : boolean}	Entities already removed.