Types/AmmoType: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(→‎range_modifier: clarify that this affects the max range and not the min range.)
(Removed old prototype docs)
 
(6 intermediate revisions by 3 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/AmmoType.html https://lua-api.factorio.com/latest/types/AmmoType.html]
Definition of actual parameters used in attack.


== Mandatory properties ==
</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>
 
=== category ===
'''Type''': [[Types/string]]
 
Name of a [[Prototype/AmmoCategory]]. Defines whether the attack will be affected by upgrades.
 
== Optional properties ==
 
=== action ===
'''Type''': [[Types/Trigger]]
 
Describes actions taken upon attack happening.
 
=== clamp_position ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
When true, the gun will be able to shoot even when the target is out of range. Only applies when target_type is position. The gun will fire at the maximum range in the direction of the target position. Defaults to false.
 
=== energy_consumption ===
'''Type''': [[Types/Energy]]
 
Energy consumption of a single shot, if applicable.
 
=== range_modifier ===
'''Type''': [[Types/double]]
 
'''Default''': 1
 
Affects the <code>range</code> value of the shooting gun prototype's <code>BaseAttackParameters</code> to give a modified maximum range. The <code>min_range</code> value of the gun is unaffected.
 
=== cooldown_modifier ===
'''Type''': [[Types/double]]
 
'''Default''': 1
 
=== consumption_modifier ===
'''Type''': [[Types/float]]
 
'''Default''': 1
 
=== target_type ===
'''Type''': [[Types/string]]
 
'''Default''': "entity"
 
Either "entity", "position" or "direction". If this is "entity", <code>clamp_position</code> is forced to be false.
"entity" fires at an entity, "position" fires directly at a position, "direction" fires in a direction.

Latest revision as of 14:32, 25 October 2024

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/AmmoType.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.