Editing Unit states

Most units and buildings have 'behavior states' that can be set by the player to modify unit behavior on the fly. The state settings are set per-unit to allow different behavior of the same unit types.

Some unit states are hidden by default, you can display them under Settings/Interface/Commands.

[[File:Factory commands.png]]

The right side of the menu displays the settings of the selected units. This display is used to edit the settings. Clicking on a state toggles it. Most states with more than two settings can be toggled backwards with right click.

There is a subtlety in the use of this display: When multiple units in the selection have the same settings different states the display only shows one of the states. A displayed state does not guarantee all units in the selection have that state. Clicking on a state guarantees that every selected unit has the setting displayed after clicking.

== Factory States ==
Factories have many states that usually make no sense for an unarmed structure. Units produced by a factory inherit most of the factory's states if the units have no other default.

== Default States ==
Units can be set to adopt a particular state upon creation from the menu (under Settings/Unit Behaviour/Default). For instance, an artillery unit could be set to Hold Position by default.

== State List ==
Following is a list that explains each state and it's settings.

=== Fire State ===
Firestate controls a unit's automatic targeting behaviour. This state is available for all armed units and structures. Player given commands and guard retaliation overrides firestate. As in a unit set to Hold Fire will still fire if it is given a direct order to attack. Units do not lose their current target when firestate changes.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/fire_atwill.png" height="24" width="24"/> '''Fire at Will''' — Fire at any/all enemies within range.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/fire_return.png" height="24" width="24"/> '''Return fire''' — Fire back at enemies that hurt the unit.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/fire_hold.png" height="24" width="24"/> '''Hold Fire''' — Will not fire unless ordered to.

=== Move State ===
Movestate controls how freely a unit can move in pursuit of it's target. All mobile units have movestate.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/move_roam.png" height="24" width="24"/> '''Roam''' — The unit will move to attack nearby targets and chase them if they run away. Constructors will only assist ally construction if set to Roam.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/move_engage.png" height="24" width="24"/> '''Maneuver''' — This behaves similarly to Roam, but with a shorter "leash".

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/move_hold.png" height="24" width="24"/> '''Hold Position''' — Unit will not automatically chase enemies or use unit AI. Units will chase with an attack command and use unit AI if they have an Attack Move command.

=== Repeat ===
Repeat causes a unit's order queue to loop. Upon completing an order the order is added to the end of the queue. This is particularly useful for factories because a production queue can be repeated.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/repeat_on.png" height="24" width="24"/> '''Repeat On'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/repeat_off.png" height="24" width="24"/> '''Repeat Off'''

=== Overkill Prevention ===
Some units have ''overkill prevention'' (OKP), such that if only one unit needs to fire to kill the target, other units will try to find a different target instead. This reduces wasted shots, useful for long-reload units such as [[Scalpel]]s.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/overkill_on.png" height="24" width="24"/> '''Overkill Prevention On'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/overkill_off.png" height="24" width="24"/> '''Overkill Prevention Off'''

=== Retreat ===

Sets the retreat level. See [[Retreat]].

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/retreat_90.png" height="24" width="24"/> '''Max Retreat''' — Unit retreats to the closest retreat position when health drops below 99%.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/retreat_60.png" height="24" width="24"/> '''2/3 Retreat''' — Unit retreats to the closest retreat position when health drops below 65%.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/retreat_30.png" height="24" width="24"/> '''1/3 Retreat''' — Unit retreats to the closest retreat position when health drops below 30%.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/retreat_off.png" height="24" width="24"/> '''No Retreat''' — Unit does not auto-retreat.

=== Selection Rank ===
<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/selection_rank_0.png" height="24" width="24"/>
<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/selection_rank_1.png" height="24" width="24"/>
<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/selection_rank_2.png" height="24" width="24"/>
<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/selection_rank_3.png" height="24" width="24"/>

See [[Selection#Selection_Rank|Selection Rank]]

=== Build Priority ===

Priority lets you control resource spending more accurately when spending exceeds income. See [[Economy_Guide#Priority |Economy Guide Priority]]

See also [[Resources Reserve]]

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/wrench_high.png" height="24" width="24"/> '''High Priority''' — Constructors are always funded.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/wrench_med.png" height="24" width="24"/> '''Normal Priority''' — This is the default. Constructors with this set have their priority overridden by the nanoframe they are constructing.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/wrench_low.png" height="24" width="24"/> '''Low Priority''' — Constructors use any resources left over to construct.

==== Misc Priority ====
Misc. priority is used for the unit's personal, non-construction resource consumption, i.e. from abilities like [[commander]] upgrades or [[Trinity]] stockpiling.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/wrench_high_other.png" height="24" width="24"/> '''High Priority'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/wrench_med_other.png" height="24" width="24"/> '''Normal Priority'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/wrench_low_other.png" height="24" width="24"/> '''Low Priority'''

=== Factory Assist ===

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/autoassist_on.png" height="24" width="24"/> '''Auto-assist Factory''' — Constructor do not follow the factory rally point. Instead they assist the factory that created them.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/autoassist_off.png" height="24" width="24"/> '''Default Behaviour''' — Constructor will continue to rally point when exiting factory.

=== Cloak ===

Toggles unit cloak. See [[Cloak]]

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/cloak_on.png" height="24" width="24"/> '''Enable Cloak'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/cloak_off.png" height="24" width="24"/> '''Disable Cloak'''

=== Unit AI ===

Toggles smart AI for the unit. See [[Unit AI]]

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/bulb_on.png" height="24" width="24"/> '''Unit AI ON''' — Turn ON the game's default unit AI for this unit (skirm, skirmish, and/or Anti-Air AI).

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/bulb_off.png" height="24" width="24"/> '''Unit AI OFF''' — Turn OFF the game's default unit AI for this unit.

=== On/Off ===
On/Off controls various miscellaneous unit states. It is used to toggle activation on radar, sonar and cloakers. It also toggles the armour ability of the [[Solar Collector]], [[Lucifer]] and [[Desolator]]. 

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/on.png" height="24" width="24"/> '''On'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/off.png" height="24" width="24"/> ''' Off'''

=== Idle State ===

Aircraft can be told to fly in a holding pattern or land when idle.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/fly_on.png" height="24" width="24"/> '''Free Flying''' — Unit continues flying when idle.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/fly_off.png" height="24" width="24"/> '''Land on Idle''' — Unit lands when idle.

=== Float State ===

Some amphibious units can float to the surface of the ocean to fire their weapons. They are immobile when floating

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/amph_float.png" height="24" width="24"/> '''Always Float''' — Unit automatically floats when idle.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/amph_attack.png" height="24" width="24"/> '''Float to Fire''' — Unit automatically floats if an enemy is in range and sinks otherwise. Units with long reload time sink between shots.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/amph_sink.png" height="24" width="24"/> '''Always Sink''' — Unit does not float.

=== Trajectory ===

Certain long range artillery units can be toggled between high and low trajectory firing.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/traj_high.png" height="24" width="24"/> '''High Trajectory''' — Shoot with a high arcing shot. This is useful for shooting over terrain that blocks direct line of sight, though it does moderately reduce accuracy.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/traj_low.png" height="24" width="24"/> '''Low Trajectory''' — Unit fire directly toward the enemy. This can be useful because directly fired projectiles are more accurate and spend less time in flight.

=== Fire at Radar ===
Some units with long-range precision weapons, like the Phantom and Lance, can be ordered not to fire on radar dots (i.e. targets inside radar range but outside visual range). Note that these units will still fire on buildings outside line of sight if the target position is known precisely (indicated by the "ghost" building).

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/stealth_on.png" height="24" width="24"/> '''Fire at Radar Dots'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/stealth_off.png" height="24" width="24"/> '''Don't Fire at Radar Dots'''

=== Dive State ===

[[Raven]] by default dive bombs to attack units under area shields, and moving targets. It can also dive bomb normally or constantly fly at a lower altitude.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/divebomb_shield.png" height="24" width="24"/> '''Dive Bomb Shield or Mobile'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/divebomb_attack.png" height="24" width="24"/> '''Dive Bomb Mobile'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/divebomb_always.png" height="24" width="24"/> '''Always Fly Low''' — This causes it to fly at a lowered altitude all the time. It is weak to ground units in this state.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/divebomb_off.png" height="24" width="24"/> '''Always Fly High''' — Will not use dive bomb. This can make it difficult to hit moving or shielded targets.

=== Area Cloak ===

Toggles an area cloaker. Area cloak is also disabled if the unit's On/Off state is set to Off. See [[Cloak]]

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/areacloak_on.png" height="24" width="24"/> '''Activate Cloaking Field''' — Cloak all allied units within cloaking field radius.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/areacloak_off.png" height="24" width="24"/> '''Disengage Cloaking Field''' — Do not emit cloaking field.

=== Gunship Strafe ===
Most gunships can circle-strafe their target when attacking.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/strafe_on.png" height="24" width="24"/> '''Strafe''' — Dodge ground projectiles by circling over the targeted enemy.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/strafe_off.png" height="24" width="24"/> '''No Strafe''' — Deactivate strafing for gunships. Use this to keep out of range of static AA.

=== Kill Captured ===

[[Dominatrix]] can be set to automatically destroy units that it captures.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/capturekill_on.png" height="24" width="24"/> '''Auto-Self Destruct''' — Immediately self-destruct the captured units.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/capturekill_off.png" height="24" width="24"/> '''No Self Destruct''' — Maintain normal control over captured units, no self-destruct.

=== Drone Construction ===
Units capable of drone production can switch it on or off.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/drones_on.png" height="24" width="24"/> '''Production of drones is ongoing'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/drones_off.png" height="24" width="24"/> '''Production of drones is stopped'''

=== Impulse Mode ===
[[Newton]] and [[Jugglenaut]] can be set to push or pull units with their gravity guns.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/push_alt.png" height="24" width="24"/> '''Push'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/pull_alt.png" height="24" width="24"/> '''Pull'''

=== Ward Fire ===
Shoot at the shields of Thugs, Felons and Convicts when nothing else is in range.

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/ward_on.png" height="24" width="24"/> '''Ward Fire Enabled'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/ward_off.png" height="24" width="24"/> '''Ward Fire Disabled'''

=== Allow Attack Commands ===
State for [[Lobster]] to ignore attack commands and only respond to [[Fire_Special_Weapon_Command |'D' commands]].

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/disableattack_off.png" height="24" width="24"/> '''Disable Attack Off'''

<img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/commands/states/disableattack_on.png" height="24" width="24"/> '''Disable Attack On'''

{{Navbox manual}}