Prototype/FireFlame: Difference between revisions
(0.17) |
m (→Optional properties: doc fixes) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Prototype parent|Prototype/Entity}} | |||
A fire. | |||
{{Prototype TOC|fire}} | |||
== Mandatory properties == | == Mandatory properties == | ||
This prototype inherits all the properties from [[Prototype/Entity]]. | This prototype inherits all the properties from [[Prototype/Entity]]. | ||
{{Prototype property|damage_per_tick|[[Types/DamagePrototype|DamagePrototype]]}} | |||
{{Prototype property|spread_delay|[[Types/uint32|uint32]]}} | |||
{{Prototype property|spread_delay_deviation|[[Types/uint32|uint32]]}} | |||
== Optional properties == | == Optional properties == | ||
{{Prototype property|render_layer|[[Types/RenderLayer|RenderLayer]]|"object"|optional=true}} | |||
{{Prototype property|initial_render_layer|[[Types/RenderLayer|RenderLayer]]|"object"|optional=true}} | |||
{{Prototype property|secondary_render_layer|[[Types/RenderLayer|RenderLayer]]|"object"|optional=true}} | |||
{{Prototype property|small_tree_fire_pictures|[[Types/AnimationVariations|AnimationVariations]]|optional=true}} | |||
{{Prototype property|pictures|[[Types/AnimationVariations|AnimationVariations]]|optional=true}} | |||
{{Prototype property|smoke_source_pictures|[[Types/AnimationVariations|AnimationVariations]]|optional=true}} | |||
{{Prototype property|secondary_pictures|[[Types/AnimationVariations|AnimationVariations]]|optional=true}} | |||
{{Prototype property|burnt_patch_pictures|[[Types/SpriteVariations|SpriteVariations]]|optional=true}} | |||
{{Prototype property|secondary_picture_fade_out_start|[[Types/uint32|uint32]]|0|optional=true}} | |||
{{Prototype property|secondary_picture_fade_out_duration|[[Types/uint32|uint32]]|30|optional=true}} | |||
{{Prototype property|spawn_entity|[[Types/string|string]]|optional=true}} | |||
The name of an entity. | The name of an entity. | ||
{{Prototype property|smoke|[[Types/table|Array]] of [[Types/SmokeSource|SmokeSource]]|optional=true}} | |||
{{Prototype property|maximum_spread_count|[[Types/uint16|uint16]]|200|optional=true}} | |||
{{Prototype property|initial_flame_count|[[Types/uint8|uint8]]|0|optional=true}} | |||
{{Prototype property|uses_alternative_behavior|[[Types/bool|bool]]|false|optional=true}} | |||
{{Prototype property|limit_overlapping_particles|[[Types/bool|bool]]|false|optional=true}} | |||
{{Prototype property|tree_dying_factor|[[Types/float|float]]|0|optional=true}} | |||
{{Prototype property|fade_in_duration|[[Types/uint32|uint32]]|30|optional=true}} | |||
{{Prototype property|fade_out_duration|[[Types/uint32|uint32]]|30|optional=true}} | |||
{{Prototype property|initial_lifetime|[[Types/uint32|uint32]]|300|optional=true}} | |||
{{Prototype property|damage_multiplier_decrease_per_tick|[[Types/float|float]]|0.0|optional=true}} | |||
{{Prototype property|damage_multiplier_increase_per_added_fuel|[[Types/float|float]]|0.0|optional=true}} | |||
{{Prototype property|maximum_damage_multiplier|[[Types/float|float]]|1.0|optional=true}} | |||
{{Prototype property|lifetime_increase_by|[[Types/uint32|uint32]]|20|optional=true}} | |||
{{Prototype property|lifetime_increase_cooldown|[[Types/uint32|uint32]]|10|optional=true}} | |||
{{Prototype property|maximum_lifetime|[[Types/uint32|uint32]]|Max uint32|optional=true}} | |||
{{Prototype property|add_fuel_cooldown|[[Types/uint32|uint32]]|10|optional=true}} | |||
{{Prototype property|delay_between_initial_flames|[[Types/uint32|uint32]]|10|optional=true}} | |||
{{Prototype property|smoke_fade_in_duration|[[Types/uint32|uint32]]|30|optional=true}} | |||
{{Prototype property|smoke_fade_out_duration|[[Types/uint32|uint32]]|30|optional=true}} | |||
{{Prototype property|on_fuel_added_action|[[Types/Trigger|Trigger]]|optional=true}} | |||
{{Prototype property|on_damage_tick_effect|[[Types/Trigger|Trigger]]|optional=true}} | |||
{{Prototype property|light|[[Types/LightDefinition|LightDefinition]]|optional=true}} | |||
{{Prototype property|particle_alpha_blend_duration|[[Types/uint16|uint16]]|0|optional=true}} | |||
{{Prototype property|burnt_patch_lifetime|[[Types/uint32|uint32]]|1800|optional=true}} | |||
{{Prototype property|burnt_patch_alpha_default|[[Types/float|float]]|1|optional=true}} | |||
= | |||
{{Prototype property|particle_alpha|[[Types/float|float]]|1|optional=true}} | |||
Only loaded if <code>uses_alternative_behavior</code> is true. | Only loaded if <code>uses_alternative_behavior</code> is true. | ||
{{Prototype property|particle_alpha_deviation|[[Types/float|float]]|0|optional=true}} | |||
Only loaded if <code>uses_alternative_behavior</code> is true. | Only loaded if <code>uses_alternative_behavior</code> is true. | ||
{{Prototype property|flame_alpha|[[Types/float|float]]|1|optional=true}} | |||
Only loaded if <code>uses_alternative_behavior</code> is false. | Only loaded if <code>uses_alternative_behavior</code> is false. | ||
{{Prototype property|flame_alpha_deviation|[[Types/float|float]]|0|optional=true}} | |||
Only loaded if <code>uses_alternative_behavior</code> is false. | Only loaded if <code>uses_alternative_behavior</code> is false. | ||
{{Prototype property|burnt_patch_alpha_variations|[[Types/table|table]]|optional=true}} | |||
Array of tables with the following mandatory members: | Array of tables with the following mandatory members: | ||
* tile - [[Types/string]] - Name of a tile. | * tile - [[Types/string|string]] - Name of a tile. | ||
* alpha - [[Types/float]] | * alpha - [[Types/float|float]] |
Latest revision as of 17:10, 3 November 2019
Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/FireFlame
A fire.
Mandatory properties
This prototype inherits all the properties from Prototype/Entity.
damage_per_tick
Type: DamagePrototype
spread_delay
Type: uint32
spread_delay_deviation
Type: uint32
Optional properties
render_layer
Type: RenderLayer
Default: "object"
initial_render_layer
Type: RenderLayer
Default: "object"
secondary_render_layer
Type: RenderLayer
Default: "object"
small_tree_fire_pictures
Type: AnimationVariations
pictures
Type: AnimationVariations
smoke_source_pictures
Type: AnimationVariations
secondary_pictures
Type: AnimationVariations
burnt_patch_pictures
Type: SpriteVariations
secondary_picture_fade_out_start
Type: uint32
Default: 0
secondary_picture_fade_out_duration
Type: uint32
Default: 30
spawn_entity
Type: string
The name of an entity.
smoke
Type: Array of SmokeSource
maximum_spread_count
Type: uint16
Default: 200
initial_flame_count
Type: uint8
Default: 0
uses_alternative_behavior
Type: bool
Default: false
limit_overlapping_particles
Type: bool
Default: false
tree_dying_factor
Type: float
Default: 0
fade_in_duration
Type: uint32
Default: 30
fade_out_duration
Type: uint32
Default: 30
initial_lifetime
Type: uint32
Default: 300
damage_multiplier_decrease_per_tick
Type: float
Default: 0.0
damage_multiplier_increase_per_added_fuel
Type: float
Default: 0.0
maximum_damage_multiplier
Type: float
Default: 1.0
lifetime_increase_by
Type: uint32
Default: 20
lifetime_increase_cooldown
Type: uint32
Default: 10
maximum_lifetime
Type: uint32
Default: Max uint32
add_fuel_cooldown
Type: uint32
Default: 10
delay_between_initial_flames
Type: uint32
Default: 10
smoke_fade_in_duration
Type: uint32
Default: 30
smoke_fade_out_duration
Type: uint32
Default: 30
on_fuel_added_action
Type: Trigger
on_damage_tick_effect
Type: Trigger
light
Type: LightDefinition
particle_alpha_blend_duration
Type: uint16
Default: 0
burnt_patch_lifetime
Type: uint32
Default: 1800
burnt_patch_alpha_default
Type: float
Default: 1
particle_alpha
Type: float
Default: 1
Only loaded if uses_alternative_behavior
is true.
particle_alpha_deviation
Type: float
Default: 0
Only loaded if uses_alternative_behavior
is true.
flame_alpha
Type: float
Default: 1
Only loaded if uses_alternative_behavior
is false.
flame_alpha_deviation
Type: float
Default: 0
Only loaded if uses_alternative_behavior
is false.
burnt_patch_alpha_variations
Type: table
Array of tables with the following mandatory members: