Prototype/Inserter: Difference between revisions

Latest revision as of 19:27, 21 January 2022

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

An inserter.

Prototype/Inserter — `inserter`
energy_source	::	EnergySource
extension_speed	::	double
hand_base_picture	::	Sprite
hand_base_shadow	::	Sprite
hand_closed_picture	::	Sprite
hand_closed_shadow	::	Sprite
hand_open_picture	::	Sprite
hand_open_shadow	::	Sprite
insert_position	::	vector
pickup_position	::	vector
platform_picture	::	Sprite4Way
rotation_speed	::	double
allow_burner_leech	::	bool (optional)
allow_custom_vectors	::	bool (optional)
chases_belt_items	::	bool (optional)
circuit_connector_sprites	::	table of CircuitConnectorSprites (optional)
circuit_wire_connection_points	::	table of WireConnectionPoint (optional)
circuit_wire_max_distance	::	double (optional)
default_stack_control_input_signal	::	SignalIDConnector (optional)
draw_circuit_wires	::	bool (optional)
draw_copper_wires	::	bool (optional)
draw_held_item	::	bool (optional)
draw_inserter_arrow	::	bool (optional)
energy_per_movement	::	Energy (optional)
energy_per_rotation	::	Energy (optional)
filter_count	::	uint8 (optional)
hand_size	::	double (optional)
stack	::	bool (optional)
stack_size_bonus	::	ItemCountType (optional)
use_easter_egg	::	bool (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.

extension_speed

Type: double

rotation_speed

Type: double

insert_position

Type: vector

pickup_position

Type: vector

platform_picture

Type: Sprite4Way

hand_base_picture

Type: Sprite

hand_open_picture

Type: Sprite

hand_closed_picture

Type: Sprite

energy_source

Type: EnergySource
Defines how this inserter gets energy. The emissions set on the energy source are ignored so inserters cannot produce pollution.

Optional properties

energy_per_movement

Type: Energy
Default: 0

energy_per_rotation

Type: Energy
Default: 0

stack

Type: bool
Default: false
Whether this inserter is considered a stack inserter. Relevant for determining how Inserter capacity bonus (research) applies to the inserter.

allow_custom_vectors

Type: bool
Default: false
Whether pickup and insert position can be set run-time.

allow_burner_leech

Type: bool
Default: false
Whether this burner inserter can fuel itself from the fuel inventory of the entity it is picking up items from.

draw_held_item

Type: bool
Default: true
Whether the item that the inserter is holding should be drawn.

use_easter_egg

Type: bool
Default: true
Whether the inserter should be able to fish fish.

filter_count

Type: uint8
Default: 0
How many filters this inserter has. Maximum count of filtered items in inserter is 5.

hand_base_shadow

Type: Sprite

hand_open_shadow

Type: Sprite

hand_closed_shadow

Type: Sprite

hand_size

Type: double
Default: 0.75
Used to determine how long the arm of the inserter is when drawing it. Does not affect gameplay. The lower the value, the straighter the arm. Increasing the value will give the inserter a bigger bend due to its longer parts.

circuit_wire_max_distance

Type: double
Default: 0
The maximum circuit wire distance for this entity.

draw_copper_wires

Type: bool
Default: true

draw_circuit_wires

Type: bool
Default: true

default_stack_control_input_signal

Type: SignalIDConnector

draw_inserter_arrow

Type: bool
Default: true
Whether the yellow arrow that indicates the drop point of the inserter and the line that indicates the pickup position should be drawn.

chases_belt_items

Type: bool
Default: true
Whether the inserter hand should move to the items it picks up from belts, leading to item chasing behaviour. If this is off, the inserter hand will stay in the center of the belt and any items picked up from the edges of the belt "teleport" to the inserter hand.

stack_size_bonus

Type: ItemCountType
Default: 0
Stack size bonus that is inherent to the prototype without having to be researched.

circuit_wire_connection_points

Type: table of WireConnectionPoint

circuit_connector_sprites

Type: table of CircuitConnectorSprites

@@ Line 1: / Line 1: @@
-== Basics ==
+{{Prototype parent|Prototype/EntityWithOwner}}
-Prototype type: '''inserter'''
+An [[inserter]].
-An [[inserter]]. Based on [[Prototype/EntityWithHealth]].
+{{Prototype TOC|inserter}}
 == Mandatory properties ==
-This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
+This prototype inherits all the properties from [[Prototype/EntityWithOwner]].
-=== extension_speed ===
+{{Prototype property|extension_speed|[[Types/double|double]]|}}
-'''Type''': [[Types/double]]
-=== rotation_speed ===
+{{Prototype property|rotation_speed|[[Types/double|double]]}}
-'''Type''': [[Types/double]]
-=== energy_per_movement ===
+{{Prototype property|insert_position|[[Types/vector|vector]]}}
-'''Type''': [[Types/double]]
-=== energy_per_rotation ===
+{{Prototype property|pickup_position|[[Types/vector|vector]]}}
-'''Type''': [[Types/double]]
-=== insert_position ===
+{{Prototype property|platform_picture|[[Types/Sprite4Way|Sprite4Way]]}}
-'''Type''': [[Types/vector]]
-=== pickup_position ===
+{{Prototype property|hand_base_picture|[[Types/Sprite|Sprite]]}}
-'''Type''': [[Types/vector]]
-=== platform_picture ===
+{{Prototype property|hand_open_picture|[[Types/Sprite|Sprite]]}}
-'''Type''': [[Types/Sprite4Way]]
-=== hand_base_picture ===
+{{Prototype property|hand_closed_picture|[[Types/Sprite|Sprite]]}}
-'''Type''': [[Types/Sprite]]
-=== hand_open_picture ===
+{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
-'''Type''': [[Types/Sprite]]
+Defines how this inserter gets energy. The emissions set on the energy source are ignored so inserters cannot produce pollution.
-=== hand_closed_picture ===
+== Optional properties ==
-'''Type''': [[Types/Sprite]]
-=== hand_base_shadow ===
+{{Prototype property|energy_per_movement|[[Types/Energy|Energy]]|0|optional=true}}
-'''Type''': [[Types/Sprite]]
-=== hand_open_shadow ===
+{{Prototype property|energy_per_rotation|[[Types/Energy|Energy]]|0|optional=true}}
-'''Type''': [[Types/Sprite]]
-=== hand_closed_shadow ===
+{{Prototype property|stack|[[Types/bool|bool]]|false|optional=true}}
-'''Type''': [[Types/Sprite]]
+Whether this inserter is considered a stack inserter. Relevant for determining how [[Inserter capacity bonus (research)]] applies to the inserter.
-=== energy_source ===
+{{Prototype property|allow_custom_vectors|[[Types/bool|bool]]|false|optional=true}}
-'''Type''': [[Types/EnergySource]]
+Whether pickup and insert position can be set run-time.
-Defines how this inserter gets energy.
+{{Prototype property|allow_burner_leech|[[Types/bool|bool]]|false|optional=true}}
+Whether this burner inserter can fuel itself from the fuel inventory of the entity it is picking up items from.
-== Optional properties ==
+{{Prototype property|draw_held_item|[[Types/bool|bool]]|true|optional=true}}
-=== stack ===
+Whether the item that the inserter is holding should be drawn.
-'''Type''': [[Types/bool]]
-'''Default''': false
+{{Prototype property|use_easter_egg|[[Types/bool|bool]]|true|optional=true}}
+Whether the inserter should be able to fish [[raw fish|fish]].
-=== allow_custom_vectors ===
+{{Prototype property|filter_count|[[Types/uint8|uint8]]|0|optional=true}}
-'''Type''': [[Types/bool]]
+How many filters this inserter has. Maximum count of filtered items in inserter is 5.
-'''Default''': false
+{{Prototype property|hand_base_shadow|[[Types/Sprite|Sprite]]}}
-Whether pickup and insert position can be set run-time.
-=== draw_held_item ===
+{{Prototype property|hand_open_shadow|[[Types/Sprite|Sprite]]}}
-'''Type''': [[Types/bool]]
-'''Default''': true
+{{Prototype property|hand_closed_shadow|[[Types/Sprite|Sprite]]}}
-=== filter_count ===
+{{Prototype property|hand_size|[[Types/double|double]]|0.75|optional=true}}
-'''Type''': [[Types/uint8]]
+Used to determine how long the arm of the inserter is when drawing it. Does not affect gameplay. The lower the value, the straighter the arm. Increasing the value will give the inserter a bigger bend due to its longer parts.
-'''Default''': 0
+{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
+The maximum circuit wire distance for this entity.
-Maximum count of filtered items in inserter is 5.
+{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}
-=== hand_size ===
+{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}}
-'''Type''': [[Types/double]]
-'''Default''': 0.75
+{{Prototype property|default_stack_control_input_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}
-=== circuit_wire_max_distance ===
+{{Prototype property|draw_inserter_arrow|[[Types/bool|bool]]|true|optional=true}}
-'''Type''': [[Types/double]]
+Whether the yellow arrow that indicates the drop point of the inserter and the line that indicates the pickup position should be drawn.
-'''Default''': 0
+{{Prototype property|chases_belt_items|[[Types/bool|bool]]|true|optional=true}}
+Whether the inserter hand should move to the items it picks up from belts, leading to item chasing behaviour. If this is off, the inserter hand will stay in the center of the belt and any items picked up from the edges of the belt "teleport" to the inserter hand.
-=== default_stack_control_input_signal ===
+{{Prototype property|stack_size_bonus|[[Types/ItemCountType|ItemCountType]]|0|optional=true}}
-'''Type''': [[Types/SignalIDConnector]]
+Stack size bonus that is inherent to the prototype without having to be researched.
-=== circuit_wire_connection_points ===
+{{Prototype property|circuit_wire_connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
-'''Type''': [[Types/table]] of [[Types/WireConnectionPoint]]
-=== circuit_connector_sprites ===
+{{Prototype property|circuit_connector_sprites|[[Types/table|table]] of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
-'''Type''': [[Types/table]] of [[Types/CircuitConnectorSprites]]

Prototype/Inserter: Difference between revisions

Latest revision as of 19:27, 21 January 2022

Mandatory properties

extension_speed

rotation_speed

insert_position

pickup_position

platform_picture

hand_base_picture

hand_open_picture

hand_closed_picture

energy_source

Optional properties

energy_per_movement

energy_per_rotation

stack

allow_custom_vectors

allow_burner_leech

draw_held_item

use_easter_egg

filter_count

hand_base_shadow

hand_open_shadow

hand_closed_shadow

hand_size

circuit_wire_max_distance

draw_copper_wires

draw_circuit_wires

default_stack_control_input_signal

draw_inserter_arrow

chases_belt_items

stack_size_bonus

circuit_wire_connection_points

circuit_connector_sprites

Navigation menu

Search