Unit.Kill (Civ5 API): Difference between revisions
(Bot update) |
(parameters from source comments) |
||
| Line 8: | Line 8: | ||
}} | }} | ||
Removes a unit from the game. | |||
=Usage= | =Usage= | ||
<code>'''void''' Unit:Kill<b>(</b>'''bool''' delay, {{Type5|PlayerID}} player = NO_PLAYER<b>)</b></code> | <code>'''void''' Unit:Kill<b>(</b>'''bool''' delay = false, {{Type5|PlayerID}} player = NO_PLAYER<b>)</b></code> | ||
| Line 17: | Line 18: | ||
|- | |- | ||
|valign="top" style="padding-right:6px;"|delay: | |valign="top" style="padding-right:6px;"|delay: | ||
|valign="top"| '' | |valign="top"| ''If true, the unit will be partially cleaned up, but its final removal will happen at the end of the frame. But what use does this have?'' | ||
|- | |- | ||
|valign="top" style="padding-right:6px;"|player: | |valign="top" style="padding-right:6px;"|player: | ||
|valign="top"| '' | |valign="top"| ''Player ID of the player that has killed this unit or -1 for no player.'' | ||
|} | |} | ||
=Source code samples= | =Source code samples= | ||
Latest revision as of 01:20, 21 February 2014
This page is a part of the Lua and UI Reference (Civ5).
|
This function is a member of Unit. This is an instance method, invoke it with a colon. |
Removes a unit from the game.
Usage
void Unit:Kill(bool delay = false, PlayerID player = NO_PLAYER)
Parameters
delay: If true, the unit will be partially cleaned up, but its final removal will happen at the end of the frame. But what use does this have? player: Player ID of the player that has killed this unit or -1 for no player.
Source code samples
Redundant occurences have been removed.
TurnsRemaining.lua - DLC_02 DLC
DLC/DLC_02/Scenarios/NewWorldScenario/TurnsRemaining.lua
0156
|
unit:Kill(true, -1); |
TurnsRemaining.lua - DLC_04 DLC
DLC/DLC_04/Scenarios/1066Scenario/TurnsRemaining.lua
0207
|
unit:Kill(); |
0470
|
pPlot:GetUnit(0):Kill(true, -1); |
TurnsRemaining.lua (G&K)
DLC/Expansion/Scenarios/FallOfRomeScenario/TurnsRemaining.lua
1043
|
pPlot:GetUnit(0):Kill(false, -1); |
TurnsRemaining.lua (G&K)
DLC/Expansion/Scenarios/MedievalScenario/TurnsRemaining.lua
1078
|
pUnit:Kill(); |
The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.
