Factorio.com|Forums|Wiki|Mod Portal|API Docs Prototype|Runtime|Auxiliary

# Factorio Prototype Docs Version 2.0.7

## RailPlannerPrototype 'rail-planner' changed

A rail planner.

Inherits from ItemPrototype « Prototype « PrototypeBase

## Properties

- default
- sorted

rails new | :: array[EntityID] | May not be an empty array. [...]
May not be an empty array. [...]
support new optional | :: EntityID | Name of a rail support.
Name of a rail support.
manual_length_limit new optional | :: double |

Inherited from ItemPrototype

stack_size | :: ItemCountType | Count of items of the same name that can be stored in one inventory slot. [...]
Count of items of the same name that can be stored in one inventory slot. [...]
icons optional | :: array[IconData] | Can't be an empty array.
Can't be an empty array.
icon optional | :: FileName | Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional | :: SpriteSizeType | The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
dark_background_icons optional | :: array[IconData] | Can't be an empty array.
Can't be an empty array.
dark_background_icon optional | :: FileName | If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]
If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]
dark_background_icon_size new optional | :: SpriteSizeType | The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
place_result optional | :: EntityID | Name of the EntityPrototype that can be built using this item. [...]
Name of the EntityPrototype that can be built using this item. [...]
place_as_equipment_result new optional | :: EquipmentID |
fuel_category optional | :: FuelCategoryID | Must exist when a nonzero fuel_value is defined.
Must exist when a nonzero fuel_value is defined.
burnt_result optional | :: ItemID | The item that is the result when this item gets burned as fuel.
The item that is the result when this item gets burned as fuel.
spoil_result new optional | :: ItemID |
plant_result new optional | :: EntityID |
place_as_tile optional | :: PlaceAsTile |
pictures optional | :: SpriteVariations | Used to give the item multiple different icons so that they look less uniform on belts. [...]
Used to give the item multiple different icons so that they look less uniform on belts. [...]
flags optional | :: ItemPrototypeFlags | Specifies some properties of the item.
Specifies some properties of the item.
spoil_ticks new optional | :: uint32 |
fuel_value optional | :: Energy | Amount of energy the item gives when used as fuel. [...]
Amount of energy the item gives when used as fuel. [...]
fuel_acceleration_multiplier optional | :: double | Must be 0 or positive.
Must be 0 or positive.
fuel_top_speed_multiplier optional | :: double | Must be 0 or positive.
Must be 0 or positive.
fuel_emissions_multiplier optional | :: double |
fuel_acceleration_multiplier_quality_bonus new optional | :: double | Additional fuel acceleration multiplier per quality level. [...]
Additional fuel acceleration multiplier per quality level. [...]
fuel_top_speed_multiplier_quality_bonus new optional | :: double | Additional fuel top speed multiplier per quality level. [...]
Additional fuel top speed multiplier per quality level. [...]
weight new optional | :: Weight | The default weight is calculated automatically from recipes and falls back to UtilityConstants::default_item_weight.
The default weight is calculated automatically from recipes and falls back to UtilityConstants::default_item_weight.
ingredient_to_weight_coefficient new optional | :: double |
fuel_glow_color optional | :: Color | Colors the glow of the burner energy source when this fuel is burned. [...]
Colors the glow of the burner energy source when this fuel is burned. [...]
open_sound optional | :: Sound |
close_sound optional | :: Sound |
pick_sound new optional | :: Sound |
drop_sound new optional | :: Sound |
inventory_move_sound new optional | :: Sound |
default_import_location new optional | :: SpaceLocationID |
color_hint new optional | :: ColorHintSpecification | Only used by hidden setting, support may be limited.
Only used by hidden setting, support may be limited.
has_random_tint new optional | :: bool |
spoil_to_trigger_result new optional | :: SpoilToTriggerResult | Only loaded if `spoil_result` is not defined.
Only loaded if `spoil_result` is not defined.
destroyed_by_dropping_trigger new optional | :: Trigger | The effect/trigger that happens when an item is destroyed by being dropped on a TilePrototype marked as destroying dropped items. [...]
The effect/trigger that happens when an item is destroyed by being dropped on a TilePrototype marked as destroying dropped items. [...]
rocket_launch_products optional | :: array[ItemProductPrototype] |
send_to_orbit_mode new optional | :: SendToOrbitMode | The way this item works when we try to send it to the orbit on its own. [...]
The way this item works when we try to send it to the orbit on its own. [...]
random_tint_color new optional | :: Color | Randomly tints item instances on belts and in the world. [...]
Randomly tints item instances on belts and in the world. [...]

Inherited from Prototype

factoriopedia_alternative optional | :: string | The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]

Inherited from PrototypeBase

type | :: string | Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
name | :: string | Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
order optional | :: Order | Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
localised_name optional | :: LocalisedString | Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
localised_description optional | :: LocalisedString | Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
factoriopedia_description new optional | :: LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
subgroup new optional | :: ItemSubGroupID | The name of an ItemSubGroup.
The name of an ItemSubGroup.
hidden new optional | :: bool |
hidden_in_factoriopedia new optional | :: bool |
parameter new optional | :: bool | Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
factoriopedia_simulation new optional | :: SimulationDefinition | The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.

rails new | :: array[EntityID] | May not be an empty array. [...]
May not be an empty array. [...]
manual_length_limit new optional | :: double |
support new optional | :: EntityID | Name of a rail support.
Name of a rail support.

Inherited from ItemPrototype

stack_size | :: ItemCountType | Count of items of the same name that can be stored in one inventory slot. [...]
Count of items of the same name that can be stored in one inventory slot. [...]
burnt_result optional | :: ItemID | The item that is the result when this item gets burned as fuel.
The item that is the result when this item gets burned as fuel.
close_sound optional | :: Sound |
color_hint new optional | :: ColorHintSpecification | Only used by hidden setting, support may be limited.
Only used by hidden setting, support may be limited.
dark_background_icon optional | :: FileName | If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]
If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]
dark_background_icon_size new optional | :: SpriteSizeType | The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
dark_background_icons optional | :: array[IconData] | Can't be an empty array.
Can't be an empty array.
default_import_location new optional | :: SpaceLocationID |
destroyed_by_dropping_trigger new optional | :: Trigger | The effect/trigger that happens when an item is destroyed by being dropped on a TilePrototype marked as destroying dropped items. [...]
The effect/trigger that happens when an item is destroyed by being dropped on a TilePrototype marked as destroying dropped items. [...]
drop_sound new optional | :: Sound |
flags optional | :: ItemPrototypeFlags | Specifies some properties of the item.
Specifies some properties of the item.
fuel_acceleration_multiplier optional | :: double | Must be 0 or positive.
Must be 0 or positive.
fuel_acceleration_multiplier_quality_bonus new optional | :: double | Additional fuel acceleration multiplier per quality level. [...]
Additional fuel acceleration multiplier per quality level. [...]
fuel_category optional | :: FuelCategoryID | Must exist when a nonzero fuel_value is defined.
Must exist when a nonzero fuel_value is defined.
fuel_emissions_multiplier optional | :: double |
fuel_glow_color optional | :: Color | Colors the glow of the burner energy source when this fuel is burned. [...]
Colors the glow of the burner energy source when this fuel is burned. [...]
fuel_top_speed_multiplier optional | :: double | Must be 0 or positive.
Must be 0 or positive.
fuel_top_speed_multiplier_quality_bonus new optional | :: double | Additional fuel top speed multiplier per quality level. [...]
Additional fuel top speed multiplier per quality level. [...]
fuel_value optional | :: Energy | Amount of energy the item gives when used as fuel. [...]
Amount of energy the item gives when used as fuel. [...]
has_random_tint new optional | :: bool |
icon optional | :: FileName | Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional | :: SpriteSizeType | The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
icons optional | :: array[IconData] | Can't be an empty array.
Can't be an empty array.
ingredient_to_weight_coefficient new optional | :: double |
inventory_move_sound new optional | :: Sound |
open_sound optional | :: Sound |
pick_sound new optional | :: Sound |
pictures optional | :: SpriteVariations | Used to give the item multiple different icons so that they look less uniform on belts. [...]
Used to give the item multiple different icons so that they look less uniform on belts. [...]
place_as_equipment_result new optional | :: EquipmentID |
place_as_tile optional | :: PlaceAsTile |
place_result optional | :: EntityID | Name of the EntityPrototype that can be built using this item. [...]
Name of the EntityPrototype that can be built using this item. [...]
plant_result new optional | :: EntityID |
random_tint_color new optional | :: Color | Randomly tints item instances on belts and in the world. [...]
Randomly tints item instances on belts and in the world. [...]
rocket_launch_products optional | :: array[ItemProductPrototype] |
send_to_orbit_mode new optional | :: SendToOrbitMode | The way this item works when we try to send it to the orbit on its own. [...]
The way this item works when we try to send it to the orbit on its own. [...]
spoil_result new optional | :: ItemID |
spoil_ticks new optional | :: uint32 |
spoil_to_trigger_result new optional | :: SpoilToTriggerResult | Only loaded if `spoil_result` is not defined.
Only loaded if `spoil_result` is not defined.
weight new optional | :: Weight | The default weight is calculated automatically from recipes and falls back to UtilityConstants::default_item_weight.
The default weight is calculated automatically from recipes and falls back to UtilityConstants::default_item_weight.

Inherited from Prototype

factoriopedia_alternative optional | :: string | The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]

Inherited from PrototypeBase

name | :: string | Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
type | :: string | Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
factoriopedia_description new optional | :: LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
factoriopedia_simulation new optional | :: SimulationDefinition | The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.
hidden new optional | :: bool |
hidden_in_factoriopedia new optional | :: bool |
localised_description optional | :: LocalisedString | Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
localised_name optional | :: LocalisedString | Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
order optional | :: Order | Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
parameter new optional | :: bool | Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
subgroup new optional | :: ItemSubGroupID | The name of an ItemSubGroup.
The name of an ItemSubGroup.

## Properties

### rails :: array[EntityID] new

May not be an empty array. Entities must be rails and their first item-to-place must be this item.

### support :: EntityID optional new

Name of a rail support.

### manual_length_limit :: double optional new

Default: 8 * 2 + 1.41 + 0.5