Prototype/Unit

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/UnitPrototype.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.

Template:Prototype parent Entity that moves around and attacks players, for example biters and spitters.

Usage in base

• biters/spitters

Mandatory properties

This prototype inherits all the properties from Prototype/EntityWithOwner.

Template:Prototype property Requires animation in attack_parameters. Requires ammo_type in attack_parameters.

Template:Prototype property Movement speed of the unit in the world, in tiles per tick. Must be equal to or greater than 0.

Template:Prototype property How fast the run_animation frames are advanced. The animations are advanced animation_speed frames per distance_per_frame that the unit moves.

frames_advanced = (distance_moved ÷ distance_per_frame) * animation_speed

Template:Prototype property The amount of pollution that has to be absorbed by the unit's spawner before the unit will leave the spawner and attack the source of the pollution.

Template:Prototype property Max is 100.

Note: Setting to 50 or above can lead to undocumented behavior of individual units creating groups on their own when attacking or being attacked.

Optional properties

Template:Prototype property The sound file to play when entity dies.

Template:Prototype property If the unit is immune to movement by belts.

Template:Prototype property Table with the following mandatory properties:

• warmup_frame_sequence - Array of uint16 - Indices of frames from the attack parameter animation.
• warmup2_frame_sequence - Array of uint16 - Indices of frames from the attack parameter animation.
• attacking_frame_sequence - Array of uint16 - Indices of frames from the attack parameter animation.
• cooldown_frame_sequence - Array of uint16 - Indices of frames from the attack parameter animation.
• prepared_frame_sequence - Array of uint16 - Indices of frames from the attack parameter animation.
• back_to_walk_frame_sequence - Array of uint16 - Indices of frames from the attack parameter animation.
• warmup_animation_speed - float
• attacking_animation_speed - float
• cooldown_animation_speed - float
• prepared_animation_speed - float
• back_to_walk_animation_speed - float

Template:Prototype property Ignored if walking_sounds is not defined.

Mandatory values

Units have additional requirements for the properties inherited from Prototype/EntityWithOwner:

• Prototype/EntityWithOwner#is_military_target must be true.
• Prototype/EntityWithOwner#allow_run_time_change_of_is_military_target must be false.