Prototype/Explosion: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(animation is mandatory and the game errors on startup for an explosion without one)
(1.0.0)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Basics ==
{{Prototype parent|Prototype/Entity}}
Prototype type: '''explosion'''
Used to play an animation and a sound.


Extends [[Prototype/Entity]].
{{Prototype TOC|explosion}}


== Extensions ==
== Extensions ==
Line 10: Line 10:
This prototype inherits all the properties from [[Prototype/Entity]].
This prototype inherits all the properties from [[Prototype/Entity]].


=== animations ===
{{Prototype property|animations|[[Types/AnimationVariations|AnimationVariations]]}}
'''Type''': [[Types/AnimationVariations]]


Must have at least 1 animation frame.
== Optional properties ==
 
{{Prototype property|sound|[[Types/Sound|Sound]]|optional=true}}
 
{{Prototype property|smoke|[[Types/string|string]]|optional=true}}
Name of a trivial-smoke prototype. Mandatory if <code>smoke_count</code> > 0.
 
{{Prototype property|height|[[Types/float|float]]|1|optional=true}}
 
{{Prototype property|smoke_slow_down_factor|[[Types/float|float]]|0|optional=true}}
 
{{Prototype property|smoke_count|[[Types/uint16|uint16]]|0|optional=true}}
 
{{Prototype property|rotate|[[Types/bool|bool]]|false|optional=true}}
 
{{Prototype property|beam|[[Types/bool|bool]]|false|optional=true}}
 
{{Prototype property|correct_rotation|[[Types/bool|bool]]|false|optional=true}}
 
{{Prototype property|scale_animation_speed|[[Types/bool|bool]]|false|optional=true}}
 
{{Prototype property|fade_in_duration|[[Types/uint8|uint8]]|0|optional=true}}
 
{{Prototype property|fade_out_duration|[[Types/uint8|uint8]]|0|optional=true}}
 
{{Prototype property|render_layer|[[Types/RenderLayer|RenderLayer]]|"explosion"|optional=true}}


== Optional properties ==
{{Prototype property|scale_in_duration|[[Types/uint8|uint8]]|0|optional=true}}


=== sound ===
{{Prototype property|scale_out_duration|[[Types/uint8|uint8]]|0|optional=true}}
'''Type''': [[Types/Sound]]


=== rotate ===
{{Prototype property|scale_end|[[Types/float|float]]|1|optional=true}}
'''Type''': [[Types/bool]]


'''Default''': false
{{Prototype property|scale_increment_per_tick|[[Types/float|float]]|0|optional=true}}


=== beam ===
{{Prototype property|light_intensity_factor_initial|[[Types/float|float]]|0.0f|optional=true}}
'''Type''': [[Types/bool]]
Silently clamped to be between 0 and 1.


'''Default''': false
{{Prototype property|light_intensity_factor_final|[[Types/float|float]]|0.0f|optional=true}}
Silently clamped to be between 0 and 1.


=== height ===
{{Prototype property|light_size_factor_initial|[[Types/float|float]]|0.05f|optional=true}}
'''Type''': [[Types/float]]
Silently clamped to be between 0 and 1.


'''Default''': 1
{{Prototype property|light_size_factor_final|[[Types/float|float]]|0.1f|optional=true}}
Silently clamped to be between 0 and 1.


=== correct_rotation ===
{{Prototype property|light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
'''Type''': [[Types/bool]]


'''Default''': false
{{Prototype property|light_intensity_peak_start_progress|[[Types/float|float]]|0.0f|optional=true}}


=== smoke ===
{{Prototype property|light_intensity_peak_end_progress|[[Types/float|float]]|0.9f|optional=true}}
'''Type''': [[Types/string]]


Name of a trivial-smoke prototype. Mandatory if <code>smoke_count</code> > 0.
{{Prototype property|light_size_peak_start_progress|[[Types/float|float]]|0.1f|optional=true}}


=== smoke_count ===
{{Prototype property|light_size_peak_end_progress|[[Types/float|float]]|0.5f|optional=true}}
'''Type''': [[Types/uint16]]


'''Default''': 0
{{Prototype property|scale_initial|[[Types/float|float]]|1|optional=true}}


=== smoke_slow_down_factor ===
{{Prototype property|scale_initial_deviation|[[Types/float|float]]|0|optional=true}}
'''Type''': [[Types/float]]


'''Default''': 0
{{Prototype property|scale|[[Types/float|float]]|1|optional=true}}


=== light ===
{{Prototype property|scale_deviation|[[Types/float|float]]|0|optional=true}}
'''Type''': [[Types/LightDefinition]]

Latest revision as of 12:09, 8 September 2020

Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/Explosion


Used to play an animation and a sound.


Prototype/Explosion — explosion
animations::AnimationVariations
beam::bool (optional)
correct_rotation::bool (optional)
fade_in_duration::uint8 (optional)
fade_out_duration::uint8 (optional)
height::float (optional)
light::LightDefinition (optional)
light_intensity_factor_final::float (optional)
light_intensity_factor_initial::float (optional)
light_intensity_peak_end_progress::float (optional)
light_intensity_peak_start_progress::float (optional)
light_size_factor_final::float (optional)
light_size_factor_initial::float (optional)
light_size_peak_end_progress::float (optional)
light_size_peak_start_progress::float (optional)
render_layer::RenderLayer (optional)
rotate::bool (optional)
scale::float (optional)
scale_animation_speed::bool (optional)
scale_deviation::float (optional)
scale_end::float (optional)
scale_in_duration::uint8 (optional)
scale_increment_per_tick::float (optional)
scale_initial::float (optional)
scale_initial_deviation::float (optional)
scale_out_duration::uint8 (optional)
smoke::string (optional)
smoke_count::uint16 (optional)
smoke_slow_down_factor::float (optional)
sound::Sound (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)

Extensions

Mandatory properties

This prototype inherits all the properties from Prototype/Entity.

animations

Type: AnimationVariations

Optional properties

sound

Type: Sound

smoke

Type: string
Name of a trivial-smoke prototype. Mandatory if smoke_count > 0.

height

Type: float
Default: 1

smoke_slow_down_factor

Type: float
Default: 0

smoke_count

Type: uint16
Default: 0

rotate

Type: bool
Default: false

beam

Type: bool
Default: false

correct_rotation

Type: bool
Default: false

scale_animation_speed

Type: bool
Default: false

fade_in_duration

Type: uint8
Default: 0

fade_out_duration

Type: uint8
Default: 0

render_layer

Type: RenderLayer
Default: "explosion"

scale_in_duration

Type: uint8
Default: 0

scale_out_duration

Type: uint8
Default: 0

scale_end

Type: float
Default: 1

scale_increment_per_tick

Type: float
Default: 0

light_intensity_factor_initial

Type: float
Default: 0.0f
Silently clamped to be between 0 and 1.

light_intensity_factor_final

Type: float
Default: 0.0f
Silently clamped to be between 0 and 1.

light_size_factor_initial

Type: float
Default: 0.05f
Silently clamped to be between 0 and 1.

light_size_factor_final

Type: float
Default: 0.1f
Silently clamped to be between 0 and 1.

light

Type: LightDefinition

light_intensity_peak_start_progress

Type: float
Default: 0.0f

light_intensity_peak_end_progress

Type: float
Default: 0.9f

light_size_peak_start_progress

Type: float
Default: 0.1f

light_size_peak_end_progress

Type: float
Default: 0.5f

scale_initial

Type: float
Default: 1

scale_initial_deviation

Type: float
Default: 0

scale

Type: float
Default: 1

scale_deviation

Type: float
Default: 0