mission_task_click_entity

Source: base/tealdef/mission/tasks/click_entity/mission_task_click_entity.d.tl

Notes

Task that waits until the player clicks given entities or markers.

MissionTaskClickEntity

record global base/tealdef/mission/tasks/click_entity/mission_task_click_entity.d.tl:3

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

Load: local click_entity = ug_require "::/mission/tasks/click_entity/click_entity.tl"

Notes

Task (click_entity) that completes when the player has selected every candidate entity or clicked every marker (or one of them with clickJustOne). The candidates cannot be bulldozed meanwhile.

MissionTaskClickEntity.Params

record base/tealdef/mission/tasks/click_entity/mission_task_click_entity.d.tl:4

record Params

Notes

Params of the task. Use either markers or candidates.

Used in the base game: 2 times in 2 files

base/content/mission/mission/tasks/click_entity/click_entity.tl:3

local type P = MissionTaskClickEntity.Params

mods/release/urbangames_campaign_mission_05/content/mission/mission/tasks/drilling/observe_drilling.tl:91

local state = (readOnlyApi.getTaskState(ctx.params.clickEntityTask) as MissionInterface.TaskState<MissionTaskClickEntity.State, MissionTaskClickEntity.Params>).

Fields

Name	Type	Description
markers	{MissionInterface.Marker}	at the moment: either markers or candidates can be provided.
candidates	{Engine.Entity}	Entities to select.
allowEntityBulldoze	boolean	Lets the player bulldoze the candidates.
clickJustOne	boolean	Completes after the first click.

Functions

getMarkers() : {MissionInterface.Marker} base/tealdef/mission/tasks/click_entity/mission_task_click_entity.d.tl:6

Notes

Returns the markers; takes precedence over markers.

Returns {MissionInterface.Marker}: Markers.

getCandidates() : {Engine.Entity} base/tealdef/mission/tasks/click_entity/mission_task_click_entity.d.tl:8

Notes

Returns the entities to select; takes precedence over candidates.

Returns {Engine.Entity}: Entities.

MissionTaskClickEntity.State

record base/tealdef/mission/tasks/click_entity/mission_task_click_entity.d.tl:13

record State

Notes

State of the task.

Used in the base game: 2 times in 2 files

base/content/mission/mission/tasks/click_entity/click_entity.tl:2

local type S = MissionTaskClickEntity.State

mods/release/urbangames_campaign_mission_05/content/mission/mission/tasks/drilling/observe_drilling.tl:91

local state = (readOnlyApi.getTaskState(ctx.params.clickEntityTask) as MissionInterface.TaskState<MissionTaskClickEntity.State, MissionTaskClickEntity.Params>).

Fields

Name	Type	Description
observed	{Result}	Clicks so far, without duplicates.
error	boolean	A candidate did not exist at spawn; the task completes at once.

MissionTaskClickEntity.State.Result

record base/tealdef/mission/tasks/click_entity/mission_task_click_entity.d.tl:14

record Result

Notes

One click.

Used in the base game: 2 times in 1 file

base/content/mission/mission/tasks/click_entity/click_entity.tl:7

local isAlreadyObserved = function(observed : { MissionTaskClickEntity.State.Result }, entity? : Engine.Entity, markerKey? : string) : boolean

Fields

Name	Type	Description
entity	Engine.Entity	Selected entity.
marker	string	Clicked marker.