Prototype/Sticker: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Removed old prototype docs)
 
(10 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/prototypes/StickerPrototype.html https://lua-api.factorio.com/latest/prototypes/StickerPrototype.html]
Prototype type: '''sticker'''


Entity that sticks to another entity, and damages/slows it. Currently stickers can only be attached to [[Prototype/Unit]] and [[Prototype/Character]]. Extends [[Prototype/Entity]].
</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 ==
This prototype inherits all the properties from [[Prototype/Entity]].
 
=== duration_in_ticks ===
'''Type''': [[Types/uint32]]
 
Must be > 0.
 
== Optional properties ==
 
=== animation ===
'''Type''': [[Types/Animation]]
 
=== spread_fire_entity ===
'''Type''': [[Types/string]]
 
Name of an entity. If this is given, this sticker is considered a "fire sticker" for some functions, such as [[Types/BaseAttackParameters#fire_penalty]] and [[Types/EntityPrototypeFlags#.22not-flammable.22]].
 
=== fire_spread_cooldown ===
'''Type''': [[Types/uint8]]
 
'''Default''': 30
 
=== fire_spread_radius ===
'''Type''': [[Types/float]]
 
'''Default''': 1
 
=== stickers_per_square_meter ===
'''Type''': [[Types/float]]
 
'''Default''': 15
 
=== force_visibility ===
'''Type''': [[Types/ForceCondition]]
 
'''Default''': "all"
 
=== single_particle ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== damage_per_tick ===
'''Type''': [[Types/DamagePrototype]]
 
=== target_movement_modifier ===
'''Type''': [[Types/float]]
 
'''Default''': 1
 
Less than 1 to reduce movement speed, more than 1 to increase it.
 
=== target_movement_modifier_from ===
'''Type''': [[Types/float]]
 
'''Default''': Value of <code>target_movement_modifier</code>
 
=== target_movement_modifier_to ===
'''Type''': [[Types/float]]
 
'''Default''': Value of <code>target_movement_modifier</code>
 
=== vehicle_speed_modifier ===
'''Type''': [[Types/float]]
 
'''Default''': 1
 
Less than 1 to reduce vehicle speed, more than 1 to increase it.
 
=== vehicle_speed_modifier_from ===
'''Type''': [[Types/float]]
 
'''Default''': Value of <code>vehicle_speed_modifier</code>
 
=== vehicle_speed_modifier_to ===
'''Type''': [[Types/float]]
 
'''Default''': Value of <code>vehicle_speed_modifier</code>
 
=== vehicle_friction_modifier ===
'''Type''': [[Types/float]]
 
'''Default''': 1
 
=== vehicle_friction_modifier_from ===
'''Type''': [[Types/float]]
 
'''Default''': Value of <code>vehicle_friction_modifier</code>
 
=== vehicle_friction_modifier_to ===
'''Type''': [[Types/float]]
 
'''Default''': Value of <code>vehicle_friction_modifier</code>
 
=== selection_box_type ===
'''Type''': [[Types/string]]
 
'''Default''': "entity"
 
Using this property marks the sticker as a "selection sticker", meaning that the selection box will be rendered around the entity when the sticker is on it.
 
Possible values are:
{| class="wikitable"
|-
! Flag !! meaning
|-
| entity  || The normal entity selection box. Yellow by default.
|-
| electricity || The selection box used to specify electric poles an entity is connected to. Light blue by default.
|-
| copy || The selection box used when doing entity copy-paste. Green by default.
|-
| not-allowed || The selection box used when specifying colliding entities. Red by default.
|-
| pair ||
|-
| logistics ||
|-
| train-visualization ||
|}

Latest revision as of 14:33, 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/prototypes/StickerPrototype.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.