Prototype/Sticker

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.

Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/Sticker

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/Sticker — `sticker`
duration_in_ticks	::	uint32
animation	::	Animation (optional)
damage_interval	::	uint32 (optional)
damage_per_tick	::	DamagePrototype (optional)
fire_spread_cooldown	::	uint8 (optional)
fire_spread_radius	::	float (optional)
force_visibility	::	ForceCondition (optional)
selection_box_type	::	CursorBoxType (optional)
single_particle	::	bool (optional)
spread_fire_entity	::	string (optional)
stickers_per_square_meter	::	float (optional)
target_movement_modifier	::	float (optional)
target_movement_modifier_from	::	float (optional)
target_movement_modifier_to	::	float (optional)
vehicle_friction_modifier	::	float (optional)
vehicle_friction_modifier_from	::	float (optional)
vehicle_friction_modifier_to	::	float (optional)
vehicle_speed_modifier	::	float (optional)
vehicle_speed_modifier_from	::	float (optional)
vehicle_speed_modifier_to	::	float (optional)
Inherited from Prototype/Entity
icons, icon, icon_size (IconSpecification)	::	IconSpecification
additional_pastable_entities	::	table of string (optional)
alert_icon_scale	::	float (optional)
alert_icon_shift	::	vector (optional)
allow_copy_paste	::	bool (optional)
autoplace	::	AutoplaceSpecification (optional)
build_base_evolution_requirement	::	double (optional)
build_grid_size	::	uint8 (optional)
build_sound	::	Sound (optional)
close_sound	::	Sound (optional)
collision_box	::	BoundingBox (optional)
collision_mask	::	CollisionMask (optional)
created_effect	::	Trigger (optional)
created_smoke	::	CreateTrivialSmokeEffectItem (optional)
drawing_box	::	BoundingBox (optional)
emissions_per_second	::	double (optional)
enemy_map_color	::	Color (optional)
fast_replaceable_group	::	string (optional)
flags	::	EntityPrototypeFlags (optional)
friendly_map_color	::	Color (optional)
hit_visualization_box	::	BoundingBox (optional)
map_color	::	Color (optional)
map_generator_bounding_box	::	BoundingBox (optional)
minable	::	MinableProperties (optional)
mined_sound	::	Sound (optional)
mining_sound	::	Sound (optional)
next_upgrade	::	string (optional)
open_sound	::	Sound (optional)
placeable_by	::	ItemToPlace or table of ItemToPlace (optional)
protected_from_tile_building	::	bool (optional)
radius_visualisation_specification	::	RadiusVisualisationSpecification (optional)
remains_when_mined	::	string or table of string (optional)
remove_decoratives	::	string (optional)
rotated_sound	::	Sound (optional)
selectable_in_game	::	bool (optional)
selection_box	::	BoundingBox (optional)
selection_priority	::	uint8 (optional)
shooting_cursor_size	::	double (optional)
sticker_box	::	BoundingBox (optional)
subgroup	::	string (optional)
tile_height	::	uint32 (optional)
tile_width	::	uint32 (optional)
trigger_target_mask	::	TriggerTargetMask (optional)
vehicle_impact_sound	::	Sound (optional)
water_reflection	::	WaterReflectionDefinition (optional)
working_sound	::	WorkingSound (optional)
Inherited from PrototypeBase
name	::	string
type	::	string
localised_description	::	LocalisedString (optional)
localised_name	::	LocalisedString (optional)
order	::	Order (optional)

Mandatory properties

This prototype inherits all the properties from Prototype/Entity.

duration_in_ticks

Type: uint32
Must be > 0.

Optional properties

animation

Type: Animation

damage_interval

Type: uint32
Default: 1
Interval between application of damage_per_tick, in ticks.

spread_fire_entity

Type: string
Name of an entity. If this is given, this sticker is considered a "fire sticker" for some functions, such as BaseAttackParameters#fire_penalty and EntityPrototypeFlags#.22not-flammable.22.

fire_spread_cooldown

Type: uint8
Default: 30

fire_spread_radius

Type: float
Default: 1

stickers_per_square_meter

Type: float
Default: 15

force_visibility

Type: ForceCondition
Default: "all"

single_particle

Type: bool
Default: false

damage_per_tick

Type: DamagePrototype
Applied every damage_interval ticks, so may not necessarily be "per tick".

target_movement_modifier

Type: float
Default: 1
Less than 1 to reduce movement speed, more than 1 to increase it.

target_movement_modifier_from

Type: float
Default: Value of target_movement_modifier
The modifier value when the sticker is attached. It linearly changes over time to reach target_movement_modifier_to.

target_movement_modifier_to

Type: float
Default: Value of target_movement_modifier
The modifier value when the sticker expires. It linearly changes over time starting from target_movement_modifier_from.

vehicle_speed_modifier

Type: float
Default: 1
Less than 1 to reduce vehicle speed, more than 1 to increase it.

vehicle_speed_modifier_from

Type: float
Default: Value of vehicle_speed_modifier
Works similarly to target_movement_modifier_from.

vehicle_speed_modifier_to

Type: float
Default: Value of vehicle_speed_modifier
Works similarly to target_movement_modifier_to.

vehicle_friction_modifier