transfer_ownership_util¶
Source: base/tealdef/mission/tasks/transfer_ownership/transfer_ownership_util.d.tl
Notes
Ownership helpers used by mission tasks.
TransferOwnershipUtil¶
record global base/tealdef/mission/tasks/transfer_ownership/transfer_ownership_util.d.tl:3
global record TransferOwnershipUtil
Load: local transfer_ownership_util = ug_require "::/mission/tasks/transfer_ownership/transfer_ownership_util.tl"
Notes
Ownership helpers used by mission tasks.
Functions
spawnAiPlayer(callback : function(Engine.Entity)) base/tealdef/mission/tasks/transfer_ownership/transfer_ownership_util.d.tl:4
Call as transfer_ownership_util.spawnAiPlayer
Notes
Adds a new player named aiPlayer.
| Parameter | Type | Description |
|---|---|---|
callback |
function(Engine.Entity) |
Called with the new player entity. |
Used in the base game: 9 times in 6 files
base/content/mission/mission/tasks/transfer_ownership/transfer_ownership.tl:18
base/content/mission/mission/tasks/vehicle_util/mission_vehicle_util.tl:34
base/content/gui/gui/debug_panel/make_entity_debug_panel.tl:281
mods/release/urbangames_campaign_mission_03/content/mission/mission/tasks/fatal_maintenance/fatal_maintenance.tl:121
mods/release/urbangames_campaign_mission_05/content/mission/mission/mission_story.tl:177
mods/release/urbangames_campaign_mission_05/content/mission/mission/tasks/drilling/send_vehicle.tl:125
transferLineEntities(entity : Engine.Entity, targetPlayer : Engine.Entity) base/tealdef/mission/tasks/transfer_ownership/transfer_ownership_util.d.tl:5
Call as transfer_ownership_util.transferLineEntities
Notes
Gives a line, its vehicles, its stop station groups, their stations and their constructions to a player.
| Parameter | Type | Description |
|---|---|---|
entity |
Engine.Entity |
Line entity. |
targetPlayer |
Engine.Entity |
New owner. |
Used in the base game: 5 times in 2 files
base/content/mission/mission/tasks/transfer_ownership/transfer_ownership.tl:20
mods/release/urbangames_campaign_mission_05/content/mission/mission/tasks/drilling/send_vehicle.tl:126
transferEntity(entity : Engine.Entity, targetPlayer : Engine.Entity) base/tealdef/mission/tasks/transfer_ownership/transfer_ownership_util.d.tl:6
Call as transfer_ownership_util.transferEntity
Notes
Gives an entity, its construction and the construction's stations and station groups to a player.
| Parameter | Type | Description |
|---|---|---|
entity |
Engine.Entity |
Entity. |
targetPlayer |
Engine.Entity |
New owner. |
Used in the base game: 9 times in 5 files
base/content/mission/mission/tasks/utility/substitute_constructions.tl:76
base/content/mission/mission/tasks/transfer_ownership/transfer_ownership.tl:31
base/content/mission/mission/tasks/vehicle_util/mission_vehicle_util.tl:35
base/content/gui/gui/debug_panel/make_entity_debug_panel.tl:400
mods/release/urbangames_campaign_mission_03/content/mission/mission/tasks/fatal_maintenance/fatal_maintenance.tl:122