Prototype/Sticker: Difference between revisions
(Added prototype type to page) |
(Stickers can be attached to spider vehicles) |
||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Prototype parent|Prototype/Entity}} | |||
Prototype | 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}} | |||
== Mandatory properties == | == Mandatory properties == | ||
This prototype inherits all the properties from [[Prototype/Entity]]. | 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. | 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}} | ||
{{Prototype property|target_movement_modifier_to|[[Types/float|float]]|Value of <code>target_movement_modifier</code>|optional=true}} | |||
{{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}} | |||
{{Prototype property|vehicle_speed_modifier_to|[[Types/float|float]]|Value of <code>vehicle_speed_modifier</code>|optional=true}} | |||
{{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}} | |||
{{Prototype property|vehicle_friction_modifier_to|[[Types/float|float]]|Value of <code>vehicle_friction_modifier</code>|optional=true}} | |||
{{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:37, 7 February 2022
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.
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
target_movement_modifier_to
Type: float
Default: Value of target_movement_modifier
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
vehicle_speed_modifier_to
Type: float
Default: Value of vehicle_speed_modifier
vehicle_friction_modifier
Type: float
Default: 1
vehicle_friction_modifier_from
Type: float
Default: Value of vehicle_friction_modifier
vehicle_friction_modifier_to
Type: float
Default: Value of vehicle_friction_modifier
selection_box_type
Type: CursorBoxType
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.