Unit.Convert (Civ5 API)

From Civilization Modding Wiki
Jump to: navigation, search

This page is a part of the Lua and UI Reference (Civ5).


Function.png This function is a member of Unit.

This is an instance method, invoke it with a colon.

Copies the attributes of one unit to another before removing the former unit. Useful for replacing units such as when upgrading. Note that this function does not create the unit to copy to, however. To do this, first use InitUnit.

Usage

void Unit:Convert(Unit unit)


Parameters

unit: The unit to be copied from and then removed.


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.