Types/AttackParameters: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Updated styling of prototype doc migration note)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Basics==
<div class="stub"><p>'''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/types/AttackParameters.html https://lua-api.factorio.com/latest/types/AttackParameters.html]
Definition of combat actions performed by combat robots, units, turrets and weapons.


</p><p>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 [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>


== Mandatory properties ==
=== type ===
'''Type''': [[Types/string]]


Specification of the type. Values are:
    "projectile"
    "beam"
    "stream"


===cooldown===
A [[types/table]]. The table is loaded as one of the extensions of [[Types/BaseAttackParameters]], depending on the value of the <code>type</code> key.
'''Type''': [[Types/int]]


Interval between consecutive attacks.
== type ==
 
'''Type''': [[Types/string]]
=== range ===
'''Type''': [[Types/double]]
 
Distance of attack. Overrides one defined in ammo.
 
== Semi-mandatory properties ==
Depending on actual type of entity the following might or might not be needed.
 
=== ammo_category ===
'''Type''': [[Prototype/AmmoCategory]]
 
Mandatory for [[Prototype/Gun]] and [[Prototype/AmmoTurret]].
Describes which ammo should be used in attack.
 
=== ammo_type ===
'''Type''': [[Types/AmmoType]]
 
Mandatory for [[Prototype/ElectricTurret]], [[Prototype/CombatRobot]] and [[Prototype/Unit]].
Defines the ammo entities of those types use when attacking.
 
== Optional properties ==
=== projectile_center ===
'''Type''': [[Types/Position]]
 
=== projectile_creation_distance ===
'''Type''': [[Types/double]]
 
Distance from the attacking entity, at which effects of ammo are applied (source_effects).
 
=== damage_modifier ===
'''Type''': [[Types/double]]
 
Provides damage multiplier for[[Prototype/Gun]] and [[Prototype/AmmoTurret]].
 
=== sound ===
'''Type''': [[Lua/table]]


Sound the entity emits when it attacks.
Mandatory member. Either "projectile", "beam" or "stream".
Table fields:
* If this is <code>"projectile"</code>, this table is loaded as a [[Types/ProjectileAttackParameters]],
Filename [[Types/FileName]]
* if this is <code>"beam"</code>, this table is loaded as a [[Types/BeamAttackParameters]],
volume [[Types/double]]
* if this is <code>"stream"</code>, this table is loaded as a [[Types/StreamAttackParameters]].

Latest revision as of 10:42, 21 September 2023

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/types/AttackParameters.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.


A types/table. The table is loaded as one of the extensions of Types/BaseAttackParameters, depending on the value of the type key.

type

Type: Types/string

Mandatory member. Either "projectile", "beam" or "stream".

Retrieved from "https://wiki.factorio.com/index.php?title=Types/AttackParameters&oldid=193546"