Prototype/Radar: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Changed links going to the redirect Types/uint to go to Types/uint32.)
(1.1.51: Prototype/EntityWithOwner added)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Basics ==
{{Prototype parent|Prototype/EntityWithOwner}}
A [[radar]]. Based on [[Prototype/EntityWithHealth]].
A [[radar]].
 
{{Prototype TOC|radar}}


== Mandatory properties ==
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
This prototype inherits all the properties from [[Prototype/EntityWithOwner]].
 
=== energy_usage ===
'''Type''': [[Types/Energy]]


{{Prototype property|energy_usage|[[Types/Energy|Energy]]}}
The amount of energy this radar uses.
The amount of energy this radar uses.


=== energy_per_sector ===
{{Prototype property|energy_per_sector|[[Types/Energy|Energy]]}}
'''Type''': [[Types/Energy]]
The amount of energy it takes to scan a sector. This value doesn't have any effect on nearby scanning.


The amount of energy it takes to scan a sector.
{{Prototype property|energy_per_nearby_scan|[[Types/Energy|Energy]]}}
The amount of energy the radar has to consume for nearby scan to be performed.
Performance warning: nearby scan causes recharting of many chunks, which is expensive operation. If you want to make a radar that updates map more in real time, you should keep its range low. If you are making radar with high range, you should set this value such that nearby scan is performed once a second or so. For example if you set energy_usage to 100kW, setting energy_per_nearby_scan to 100kJ will cause nearby scan happen once per second. This value doesn't have any effect on sector scanning.


=== energy_per_nearby_scan ===
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
'''Type''': [[Types/Energy]]
The energy source for this radar.


=== energy_source ===
{{Prototype property|pictures|[[Types/RotatedSprite|RotatedSprite]]}}
'''Type''': [[Types/EnergySource]]


The energy source for this radar. Must be an electric energy source.
{{Prototype property|max_distance_of_sector_revealed|[[Types/uint32|uint32]]}}
The radius of the area this radar can chart, in chunks.


=== pictures ===
{{Prototype property|max_distance_of_nearby_sector_revealed|[[Types/uint32|uint32]]}}
'''Type''': [[Types/RotatedSprite]]
The radius of the area constantly revealed by this radar, in chunks.


=== max_distance_of_sector_revealed ===
== Optional properties ==
'''Type''': [[Types/uint32]]


=== max_distance_of_nearby_sector_revealed ===
{{Prototype property|radius_minimap_visualisation_color|[[Types/Color|Color]]|optional=true}}
'''Type''': [[Types/uint32]]


== Optional properties ==
{{Prototype property|rotation_speed|[[Types/double|double]]|0.01|optional=true}}
=== radius_minimap_visualisation_color ===
'''Type''': [[Types/Color]]

Latest revision as of 19:27, 21 January 2022

Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/EntityWithHealth » Prototype/EntityWithOwner » Prototype/Radar


A radar.


Prototype/Radar — radar
energy_per_nearby_scan::Energy
energy_per_sector::Energy
energy_source::EnergySource
energy_usage::Energy
max_distance_of_nearby_sector_revealed::uint32
max_distance_of_sector_revealed::uint32
pictures::RotatedSprite
radius_minimap_visualisation_color::Color (optional)
rotation_speed::double (optional)
Inherited from Prototype/EntityWithOwner
allow_run_time_change_of_is_military_target::bool (optional)
is_military_target::bool (optional)
Inherited from Prototype/EntityWithHealth
alert_when_damaged::bool (optional)
attack_reaction::AttackReaction (optional)
corpse::string or table of strings (optional)
create_ghost_on_death::bool (optional)
damaged_trigger_effect::TriggerEffect (optional)
dying_explosion::ExplosionDefinition or table of ExplosionDefinition (optional)
dying_trigger_effect::TriggerEffect (optional)
healing_per_tick::float (optional)
hide_resistances::bool (optional)
integration_patch::Sprite4Way (optional)
integration_patch_render_layer::RenderLayer (optional)
loot::Loot (optional)
max_health::float (optional)
random_corpse_variation::bool (optional)
repair_sound::Sound (optional)
repair_speed_modifier::float (optional)
resistances::Resistances (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/EntityWithOwner.

energy_usage

Type: Energy
The amount of energy this radar uses.

energy_per_sector

Type: Energy
The amount of energy it takes to scan a sector. This value doesn't have any effect on nearby scanning.

energy_per_nearby_scan

Type: Energy
The amount of energy the radar has to consume for nearby scan to be performed. Performance warning: nearby scan causes recharting of many chunks, which is expensive operation. If you want to make a radar that updates map more in real time, you should keep its range low. If you are making radar with high range, you should set this value such that nearby scan is performed once a second or so. For example if you set energy_usage to 100kW, setting energy_per_nearby_scan to 100kJ will cause nearby scan happen once per second. This value doesn't have any effect on sector scanning.

energy_source

Type: EnergySource
The energy source for this radar.

pictures

Type: RotatedSprite

max_distance_of_sector_revealed

Type: uint32
The radius of the area this radar can chart, in chunks.

max_distance_of_nearby_sector_revealed

Type: uint32
The radius of the area constantly revealed by this radar, in chunks.

Optional properties

radius_minimap_visualisation_color

Type: Color

rotation_speed

Type: double
Default: 0.01

Retrieved from "https://testing-wiki.factorio.com/index.php?title=Prototype/Radar&oldid=187978"