mission_task_guide_collect_entity¶

Source: base/tealdef/mission/tasks/guide/mission_task_guide_collect_entity.d.tl

Notes

Decorator for the collect-entity task that points the player to one entity after the other.

MissionTaskGuideCollectEntity¶

record global base/tealdef/mission/tasks/guide/mission_task_guide_collect_entity.d.tl:3

global record MissionTaskGuideCollectEntity is MissionInterface.TaskScript<DecoratorState<MissionTaskCollectEntity.State, MissionTaskGuideCollectEntity.State>, DecoratorParam<MissionTaskCollectEntity.Params, MissionTaskGuideCollectEntity.Param>>

Notes

Decorator for MissionTaskCollectEntity. After delay seconds it shows the zone and marker of the first entity not collected yet and queues its instruction; the next hint follows once that entity is collected. It pauses while a voice-over or the guide window is visible.

Details

Combine with TaskDecorator.decorate(collect_entity, guide_collect_entity). The n-th config belongs to the n-th entity.

MissionTaskGuideCollectEntity.Param¶

record base/tealdef/mission/tasks/guide/mission_task_guide_collect_entity.d.tl:4

record Param

Notes

Decorator params.

Used in the base game: 17 times in 5 files

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

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

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

local guide_collect_entity = ug_require "::/mission/tasks/guide/guide_collect_entity.tl" as MissionInterface.TaskScript<DecoratorState<MissionTaskCollectEntity.

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

local guide_collect_entity = ug_require "::/mission/tasks/guide/guide_collect_entity.tl" as MissionInterface.TaskScript<DecoratorState<MissionTaskCollectEntity.

mods/release/urbangames_campaign_mission_04/content/mission/mission/mission_story_cutscenes_only.tl:27

local guide_collect_entity = ug_require "::/mission/tasks/guide/guide_collect_entity.tl" as MissionInterface.TaskScript<DecoratorState<MissionTaskCollectEntity.

mods/release/urbangames_campaign_mission_04/content/mission/mission/mission_story.tl:27

local guide_collect_entity = ug_require "::/mission/tasks/guide/guide_collect_entity.tl" as MissionInterface.TaskScript<DecoratorState<MissionTaskCollectEntity.

Fields

Name	Type	Description
`delay`	`number`	GUI seconds after spawn before the first hint.
`configs`	`{GuideConfig}`	Hints in entity order.
`delayBetweenGuides`	`number`	GUI seconds between a collect and the next hint (default 2).

MissionTaskGuideCollectEntity.Param.GuideConfig¶

record base/tealdef/mission/tasks/guide/mission_task_guide_collect_entity.d.tl:5

record GuideConfig

Notes

Hint for one entity.

Used in the base game: 1 time in 1 file

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

local guide : { Engine.Entity : MissionTaskGuideCollectEntity.Param.GuideConfig } = {}

Fields

Name	Type	Description
`instructionData`	`MissionDialogueData.InstructionData`	Instruction of the hint.
`zone`	`MissionInterface.Zone`	Zone shown with the hint.
`marker`	`MissionInterface.Marker`	Marker shown with the hint; its `key` is the instruction key.

MissionTaskGuideCollectEntity.State¶

record base/tealdef/mission/tasks/guide/mission_task_guide_collect_entity.d.tl:15

record State

Notes

Decorator state.

Used in the base game: 13 times in 5 files

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

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

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

local guide_collect_entity = ug_require "::/mission/tasks/guide/guide_collect_entity.tl" as MissionInterface.TaskScript<DecoratorState<MissionTaskCollectEntity.

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

local guide_collect_entity = ug_require "::/mission/tasks/guide/guide_collect_entity.tl" as MissionInterface.TaskScript<DecoratorState<MissionTaskCollectEntity.

mods/release/urbangames_campaign_mission_04/content/mission/mission/mission_story_cutscenes_only.tl:27

local guide_collect_entity = ug_require "::/mission/tasks/guide/guide_collect_entity.tl" as MissionInterface.TaskScript<DecoratorState<MissionTaskCollectEntity.

mods/release/urbangames_campaign_mission_04/content/mission/mission/mission_story.tl:27

local guide_collect_entity = ug_require "::/mission/tasks/guide/guide_collect_entity.tl" as MissionInterface.TaskScript<DecoratorState<MissionTaskCollectEntity.

Fields

Name	Type	Description
`guide`	`{Engine.Entity : Param.GuideConfig}`	Entity -> hint.
`triggered`	`{Engine.Entity : boolean}`	Entity -> hint shown.
`isInitialized`	`boolean`	Hints were assigned to entities.
`orderedEntities`	`{Engine.Entity}`	Entities in hint order.
`lastNumberObserved`	`integer`	Number of collected entities at the last update.
`timeStamp`	`number`	GUI time of the last collect.
`lock`	`boolean`	Hints are paused (voice-over or guide window visible).