Prototype/Sticker: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(according to Klonan on discord)
(Removed old prototype docs)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Prototype parent|Prototype/Entity}}
<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]
Entity that sticks to another entity, and damages/slows it. Stickers can only be attached to [[Prototype/Unit]], [[Prototype/Character]], [[Prototype/Car]] and [[Prototype/SpiderVehicle]].


{{Prototype TOC|sticker}}
</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]].
 
{{Prototype property|duration_in_ticks|[[Types/uint32|uint32]]}}
Must be > 0.
 
== Optional properties ==
 
{{Prototype property|animation|[[Types/Animation|Animation]]|optional=true}}
 
{{Prototype property|damage_interval|[[Types/uint32|uint32]]|1|optional=true}}
Interval between application of <code>damage_per_tick</code>, in ticks.
 
{{Prototype property|spread_fire_entity|[[Types/string|string]]|optional=true}}
Name of an entity. If this is given, this sticker is considered a "fire sticker" for some functions, such as [[Types/BaseAttackParameters#fire_penalty|BaseAttackParameters#fire_penalty]] and [[Types/EntityPrototypeFlags#.22not-flammable.22|EntityPrototypeFlags#.22not-flammable.22]].
 
{{Prototype property|fire_spread_cooldown|[[Types/uint8|uint8]]|30|optional=true}}
 
{{Prototype property|fire_spread_radius|[[Types/float|float]]|1|optional=true}}
 
{{Prototype property|stickers_per_square_meter|[[Types/float|float]]|15|optional=true}}
 
{{Prototype property|force_visibility|[[Types/ForceCondition|ForceCondition]]|"all"|optional=true}}
 
{{Prototype property|single_particle|[[Types/bool|bool]]|false|optional=true}}
 
{{Prototype property|damage_per_tick|[[Types/DamagePrototype|DamagePrototype]]||optional=true}}
Applied every <code>damage_interval</code> ticks, so may not necessarily be "per tick".
 
{{Prototype property|target_movement_modifier|[[Types/float|float]]|1|optional=true}}
Less than 1 to reduce movement speed, more than 1 to increase it.
 
{{Prototype property|target_movement_modifier_from|[[Types/float|float]]|Value of <code>target_movement_modifier</code>|optional=true}}
The modifier value when the sticker is attached. It linearly changes over time to reach <code>target_movement_modifier_to</code>.
 
{{Prototype property|target_movement_modifier_to|[[Types/float|float]]|Value of <code>target_movement_modifier</code>|optional=true}}
The modifier value when the sticker expires. It linearly changes over time starting from <code>target_movement_modifier_from</code>.
 
{{Prototype property|vehicle_speed_modifier|[[Types/float|float]]|1|optional=true}}
Less than 1 to reduce vehicle speed, more than 1 to increase it.
 
{{Prototype property|vehicle_speed_modifier_from|[[Types/float|float]]|Value of <code>vehicle_speed_modifier</code>|optional=true}}
Works similarly to <code>target_movement_modifier_from</code>.
 
{{Prototype property|vehicle_speed_modifier_to|[[Types/float|float]]|Value of <code>vehicle_speed_modifier</code>|optional=true}}
Works similarly to <code>target_movement_modifier_to</code>.
 
{{Prototype property|vehicle_friction_modifier|[[Types/float|float]]|1|optional=true}}
 
{{Prototype property|vehicle_friction_modifier_from|[[Types/float|float]]|Value of <code>vehicle_friction_modifier</code>|optional=true}}
Works similarly to <code>target_movement_modifier_from</code>.
 
{{Prototype property|vehicle_friction_modifier_to|[[Types/float|float]]|Value of <code>vehicle_friction_modifier</code>|optional=true}}
Works similarly to <code>target_movement_modifier_to</code>.
 
{{Prototype property|selection_box_type|[[Types/CursorBoxType|CursorBoxType]]|"entity"|optional=true}}
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.

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.