mission_task_observe_entity¶

Source: base/tealdef/mission/tasks/observe_entity/mission_task_observe_entity.d.tl

Notes

Task that waits until a condition holds for each of a set of entities.

MissionTaskObserveEntity¶

record global base/tealdef/mission/tasks/observe_entity/mission_task_observe_entity.d.tl:3

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

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

Notes

Task (observe_entity) that completes when observe has returned true once for every entity. The entities and marked entities cannot be bulldozed meanwhile.

MissionTaskObserveEntity.Params¶

record base/tealdef/mission/tasks/observe_entity/mission_task_observe_entity.d.tl:4

record Params

Notes

Params of the task.

Used in the base game: 2 times in 2 files

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

local type P = MissionTaskObserveEntity.Params

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

taskParams : MissionTaskObserveEntity.Params = {

Fields

Name	Type	Description
`markers`	`{MissionInterface.Marker}`	Markers shown while waiting.
`entities`	`{Engine.Entity}`	Entities to observe.
`allowEntityBulldoze`	`boolean`	Lets the player bulldoze the entities.

Functions

observe(Engine.Entity) : boolean base/tealdef/mission/tasks/observe_entity/mission_task_observe_entity.d.tl:7

Notes

Condition checked per entity every update until it is met.

Parameter	Type	Description
`#1`	`Engine.Entity`	Entity.

Returns boolean: true when the entity is done.

MissionTaskObserveEntity.State¶

record base/tealdef/mission/tasks/observe_entity/mission_task_observe_entity.d.tl:11

record State

Notes

State of the task.

Used in the base game: 1 time in 1 file

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

local type S = MissionTaskObserveEntity.State

Fields

Name	Type	Description
`observed`	`{Engine.Entity : boolean}`	Entity -> condition met.