mission_task_spawn_entity¶

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

Notes

Task that spawns custom entities for the player to collect.

MissionTaskSpawnEntity¶

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

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

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

Notes

Task (spawn_entity) that spawns one custom entity per position, names it with tooltip and completes at once.

Example

-- urbangames_campaign_mission_01: alligators to catch
taskScript = spawn_entity as MissionInterface.TaskScript<any, any>,
taskParams = {
    models = params.crocodileModels,
    positions = params.crocodilePositions,
    alignTerrain = true,
    tooltip = _("Catch Me!"),
},

MissionTaskSpawnEntity.Params¶

record base/tealdef/mission/tasks/click_and_collect_custom_entity/mission_task_spawn_entity.d.tl:4

record Params

Notes

Params of the task.

Used in the base game: 10 times in 4 files

base/content/mission/mission/tasks/click_and_collect_custom_entity/spawn_entity.tl:10

isComplete = function(_ctx : TaskContext<MissionTaskSpawnEntity.State, MissionTaskSpawnEntity.Params>) : boolean

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

local getTaskState = function() : MissionInterface.TaskState<MissionTaskSpawnEntity.State, MissionTaskSpawnEntity.Params>

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

local getTaskState = function() : MissionInterface.TaskState<MissionTaskSpawnEntity.State, MissionTaskSpawnEntity.Params>

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

local getTaskState = function() : MissionInterface.TaskState<MissionTaskSpawnEntity.State, MissionTaskSpawnEntity.Params>

Fields

Name	Type	Description
`models`	`{string}`	Model per position (same length as `positions`).
`positions`	`{{number, number, number}}`	Spawn positions `{x, y, z}`.
`alignTerrain`	`boolean`	Places the entities on the terrain instead of at the given height.
`tooltip`	`string`	Name shown for the entities (default "Select Me!").
`rotateZ`	`number`	Rotation around the vertical axis, in radians.

MissionTaskSpawnEntity.State¶

record base/tealdef/mission/tasks/click_and_collect_custom_entity/mission_task_spawn_entity.d.tl:12

record State

Notes

State of the task.

Used in the base game: 10 times in 4 files

base/content/mission/mission/tasks/click_and_collect_custom_entity/spawn_entity.tl:10

isComplete = function(_ctx : TaskContext<MissionTaskSpawnEntity.State, MissionTaskSpawnEntity.Params>) : boolean

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

local getTaskState = function() : MissionInterface.TaskState<MissionTaskSpawnEntity.State, MissionTaskSpawnEntity.Params>

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

local getTaskState = function() : MissionInterface.TaskState<MissionTaskSpawnEntity.State, MissionTaskSpawnEntity.Params>

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

local getTaskState = function() : MissionInterface.TaskState<MissionTaskSpawnEntity.State, MissionTaskSpawnEntity.Params>

Fields

Name	Type	Description
`runtimeEntityIds`	`{Engine.Entity}`	Spawned entities, in the order of `positions`.