Prototype/Entity: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(remove_decoratives automatic explanation)
(→‎Optional properties: additional_pastable_entities: make clear it is list of entity names, not types)
Line 327: Line 327:


{{Prototype property|additional_pastable_entities|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
{{Prototype property|additional_pastable_entities|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
Entities this entity prototype can be pasted on to in addition to the standard supported types.
Names of the entity prototypes this entity prototype can be pasted on to in addition to the standard supported types.
This is used to allow copying between types that aren't compatible on the C++ code side, by allowing mods to receive the [https://lua-api.factorio.com/latest/events.html#on_entity_settings_pasted on_entity_settings_pasted] event for the given entity and do the setting pasting via script.
This is used to allow copying between types that aren't compatible on the C++ code side, by allowing mods to receive the [https://lua-api.factorio.com/latest/events.html#on_entity_settings_pasted on_entity_settings_pasted] event for the given entity and do the setting pasting via script.<br>
Note that this is a list of prototype names (e.g. "steel-chest"), not prototype types (e.g. "container").


{{Prototype property|tile_width|[[Types/uint32|uint32]]|calculated by the collision box width rounded up.|optional=true}}
{{Prototype property|tile_width|[[Types/uint32|uint32]]|calculated by the collision box width rounded up.|optional=true}}

Revision as of 11:44, 19 August 2021

Prototype definitions » PrototypeBase » Prototype/Entity


Abstract base of all entities in the game. Entity is basically everything that can be on the map (except tiles). For in game script access to entity, take a look at LuaEntity


Prototype/Entity — abstract
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

Inherits all properties from PrototypeBase.

icons, icon, icon_size (IconSpecification)

Type: IconSpecification
An icon is mandatory for entities that have at least one of these flags active: placeable-neutral, placeable-player, placeable-enemy.

The icon will be used in the editor building selection and the bonus gui. 

icon = "__base__/graphics/icons/wooden-chest.png"

Optional properties

order

See PrototypeBase#order

Inherited from PrototypeBase.

The order string is taken from the items in placeable_by if they exist, or from an item that has its place_result set to this entity if it exists.

collision_box

Type: BoundingBox
Specification of the entity collision boundaries.

Empty collision box is used for smoke, projectiles, particles, explosions etc. 

collision_box = {{-0.4, -0.4}, {0.4, 0.4}}

The {0,0} coordinate in the collision box will match the entity position.

It should be near the center of the collision box, to keep correct entity drawing order. It must include the {0,0} coordinate.

Note, that for buildings, it is customary to leave 0.1 wide border between the edge of the tile and the edge of the building, this lets the player move between the building and electric poles/inserters etc.

collision_mask

Type: CollisionMask
Default: {"item-layer", "object-layer", "player-layer", "water-tile"}

Two entities can collide only if they share a layer from the collision mask.

NOTE: Some entity types have their own default that differs from the above default. They are listed here:

map_generator_bounding_box

Type: BoundingBox
Default: The value of collision box.
Used instead of the collision box during map generation. Allows space entities differently during map generation, for example if the box is bigger, the entities will be placed farther apart.

selection_box

Type: BoundingBox
Default: Empty = {{0, 0}, {0, 0}}
Specification of the entity selection area. When empty the entity will have no selection area (and thus is not selectable). 

selection_box = {{-0.5, -0.5}, {0.5, 0.5}}

The selection box is usually a little bit bigger than the collision box, for tilable entities (like buildings) it should match the tile size of the building.

drawing_box

Type: BoundingBox
Default: Empty = {{0, 0}, {0, 0}} (selection_box is used instead)
Specification of space needed to see the whole entity.

This is used to calculate the correct zoom and positioning in the entity info gui. 

drawing_box = {{-0.5, -0.5}, {0.5, 0.5}}

sticker_box

Type: BoundingBox
Default: The value of collision box.
Used to set the area of the entity that can have stickers on it, currently only used for units to specify the area where the green slow down stickers can appear. It is optional and the collision box is used when not specified. 

sticker_box = {{-0.5, -0.5}, {0.5, 0.5}}

hit_visualization_box

Type: BoundingBox
Default: Empty = {{0, 0}, {0, 0}}
Where beams should hit the entity. Useful if the bounding box only covers part of the entity (e.g. feet of the character) and beams only hitting there would look weird.

trigger_target_mask

Type: TriggerTargetMask

flags

Type: EntityPrototypeFlags

minable

Type: MinableProperties
Default: not minable

subgroup

Type: string
The name of the subgroup this entity should be sorted into in the map editor building selection.

allow_copy_paste

Type: bool
Default: true

selectable_in_game

Type: bool
Default: true

selection_priority

Type: uint8
Default: 50
The entity with the higher number is selectable before the entity with the lower number.

remove_decoratives

Type: string
Default: "automatic"
Either "automatic", "true" or "false". Whether this entity should remove decoratives that collide with it when this entity is built. When set to "automatic", if the entity type is considered a building (e.g. an assembling machine or a wall) it will remove decoratives.

emissions_per_second

Type: double
Default: 0
Amount of emissions created (positive number) or cleaned (negative number) every second by the entity. This is passive, and it is independent concept of the emissions of machines, these are created actively depending on the power consumption. Currently used just for trees. 

emissions_per_second = -0.001 -- cleaning effect of big tree

shooting_cursor_size

Type: double
The cursor size used when shooting at this entity.

created_smoke

Type: CreateTrivialSmokeEffectItem
Default: The "smoke-building"-smoke
The smoke that is shown when the entity is placed.

working_sound

Type: WorkingSound
Will also work on entities that don't actually do work.

created_effect

Type: Trigger
The effect/trigger that happens when the entity is placed.

build_sound

Type: Sound

mined_sound

Type: Sound

mining_sound

Type: Sound

rotated_sound

Type: Sound

vehicle_impact_sound

Type: Sound
When playing this sound, the volume is scaled by the speed of the vehicle when colliding with this entity.

open_sound

Type: Sound

close_sound

Type: Sound

radius_visualisation_specification

Type: RadiusVisualisationSpecification

build_base_evolution_requirement

Type: double
Default: 0

alert_icon_shift

Type: vector

alert_icon_scale

Type: float

fast_replaceable_group

Type: string
Default: ""
This allows you to replace an entity that's already placed, with a different one in your inventory. For example, replacing a burner inserter with a fast inserter.

This is simply a string, so any string can be used here. The entity that should be replaced simply has to use the same string here.

The ones the game uses are: 

   "container"
   "furnace"
   "transport-belt"
   "electric-pole"
   "steam-engine"
   "inserter"
   "long-handed-inserter"
   "pipe"
   "assembling-machine"
   "wall"
   "loader"
   "rail-signal"
   "mining-drill"
   "pumpjack"

next_upgrade

Type: string
Name of the entity that will be automatically selected as the upgrade of this entity when using the upgrade planner without configuration.

This entity may not have 'not-upgradable' flag set and must be minable. This entity mining result must not contain item product with "hidden" flag set. Mining results with no item products are allowed. The entity may not be a Prototype/RollingStock.
The upgrade target entity needs to have the same bounding box, collision mask, and fast replaceable group as this entity. The upgrade target entity must have least 1 item that builds it that isn't hidden.

placeable_by

Type: ItemToPlace or table of ItemToPlace
Item that when placed creates this entity. Determines which item is picked when "Q" (smart pipette) is used on the entity, determines which item is needed in a blueprint of this entity.

The item count specified here can't be larger than the stack size of that item.

remains_when_mined

Type: string or table of string
The entity that remains when this one is mined, deconstructed or fast-replaced. The entity wont actually be spawned if it would collide with the entity that is in the process of being mined.

additional_pastable_entities

Type: table of string
Names of the entity prototypes this entity prototype can be pasted on to in addition to the standard supported types. This is used to allow copying between types that aren't compatible on the C++ code side, by allowing mods to receive the on_entity_settings_pasted event for the given entity and do the setting pasting via script.
Note that this is a list of prototype names (e.g. "steel-chest"), not prototype types (e.g. "container").

tile_width

Type: uint32
Default: calculated by the collision box width rounded up.
Used to determine how the center of the entity should be positioned when building (unless the offgrid flag is specified). When the tile width is odd, the center will be in the center of the tile, when it is even, the center is on the tile transition.

tile_height

Type: uint32
Default: calculated by the collision box height rounded up.

autoplace

Type: AutoplaceSpecification
Default: nil (entity is not autoplacable)
Used to specify the rules for placing this entity during map generation.

map_color

Type: Color

friendly_map_color

Type: Color

enemy_map_color

Type: Color

water_reflection

Type: WaterReflectionDefinition
May also be defined inside graphics_set instead of directly in the entity prototype. This is useful for entities that use the a graphics_set property to define their graphics, becausen then all graphics can be in defined one place.

Example

{
    type = "container",
    name = "wooden-chest",
    icon = "__base__/graphics/icons/wooden-chest.png",
    flags = {"placeable-neutral", "player-creation"},
    minable = {mining_time = 1, result = "wooden-chest"},
    max_health = 100,
    corpse = "small-remnants",
    collision_box = {{-0.35, -0.35}, {0.35, 0.35}},
    fast_replaceable_group = "container",
    selection_box = {{-0.5, -0.5}, {0.5, 0.5}},
    inventory_size = 16,
    open_sound = { filename = "__base__/sound/wooden-chest-open.ogg" },
    close_sound = { filename = "__base__/sound/wooden-chest-close.ogg" },
    vehicle_impact_sound =  { filename = "__base__/sound/car-wood-impact.ogg", volume = 1.0 },
    picture =
    {
      filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",
      priority = "extra-high",
      width = 46,
      height = 33,
      shift = {0.25, 0.015625}
    },
    circuit_wire_connection_point =
    {
      shadow =
      {
        red = {0.734375, 0.453125},
        green = {0.609375, 0.515625},
      },
      wire =
      {
        red = {0.40625, 0.21875},
        green = {0.40625, 0.375},
      }
    },
    circuit_connector_sprites = get_circuit_connector_sprites({0.1875, 0.15625}, nil, 18),
    circuit_wire_max_distance = 9
  }
Retrieved from "https://testing-wiki.factorio.com/index.php?title=Prototype/Entity&oldid=186822"