Data/Abilities/Warp Train

## Warp Train

### Description

Ability for warping in units with the commands to select from multiple units to warp.

### Hints

* Uses the Warpable Ability on the created units to determine placement and to enforce construction.
* Unit's without Warpable will be created instantly regardless of **Ability: Info - Time** and will not have to be placed in a power source.
* It is actually not a Train ability, the event is a construct ability.
* A unit that is time scaled by a buff with **Unit: Modification - Timescale** will increase it's warp progress rate to finish time but not it's progress vital rate (unit will finish without full health). A better approach is to use a buff's **Behavior: Modification - Rate Multiplier Array** for **Progress**.

## Example Usage

### Warp Gate

A good example is the Protoss Warp Gate's ability to warp units with Warp Gate - Train (Warp Gate).

## Fields Description

### Ability - Alignment

* Whether the ability is recognized as Negative, Neutral or Positive.

### Ability - Info - Alert

* (Unknown)Editor describes it as Parameters relating to specific commands of the ability.

### Ability - Info - Button - Default Button

* The button associated to the specific unit for warping on the command card of the unit with this ability.

### Ability - Info - Button - Flags

**Hidden:** (Unknown)
**Send to Selection:** (Unknown)
**Show in Glossary:** (Unknown)

### Ability - Info - Button - State

* (Unsure)Doesn't appear to affect the button as it is displayed on the command card.
* **Available:** (Unknown)
* **Restricted:** (Unknown)
* **Suppressed:** (Unknown)

### Ability - Info - Cooldown - Link

* Allows each unit to have it's own cooldown link as an Ability ID so the ability can warp different units on different cooldowns.

### Ability - Info - Cooldown - Location

* Scope of how the cooldown is shared among units, abilities, and behaviors with the cooldown link:
* **Global:** Everything with the cooldown link.
* **Unit:** Everything on the unit with the cooldown link.
* **Ability:** The specific ability rather than shared cooldown link.
* **Player:** Everything owned by the player with the cooldown link.
* **Behavior:** (unsure)possibly everything with the same cooldown link on units with the behaviors that have the cooldown link.

### Ability - Info - Cooldown - Time Start

* Time before the ability can be used for the first time.

### Ability - Info - Cost Display

* If enabled shows the unit cost in the ability tooltip.

### Ability - Info - Technology Resource Cost

* (Unsure) The additonal cost of warping the unit along with the unit's cost. Also probably the sole cost of warping the unit if Stats - Flags Ignore Cost is set to true.

### Ability - Info - Time

* Time it takes for the unit to finish warping(constructing progress).

### Ability - Info - Vital Fraction

* The percentage of shield, health, energy that it costs to warp the specific unit.

### Ability - Info - Vitals

* The cost in shield, health, energy to warp the specific unit.

### Ability - Set ID

* Link this ability to other abilities for when a unit is instructed to use one that it doesn't have.

### Cost - Refund Fraction - Charge

* How much is refunded in charges. (Needs More)

### Cost - Refund Fraction - Cooldown

* Cooldown that is refunded.
* -1 Removes cooldown completely.

### Cost - Refund Fraction - Resource

* How much is refunded in resources.
* -1 gives full refund.

### Cost - Refund Fraction - Vital Fraction

* How much is refunded of the fraction vitals cost.

### Stats - Flags

* **Ignore Unit Cost:** (Unsure) Probably ignores the original costs of the units.
* **Warp Trainers Button:** If enabled, counts this unit as a Warp Gate for the "Select All Warp Gates (W)" button in the UI.

### UI - Tooltip Priority

* (Unknown)

Related

* Warpable
* Train