`collection`¶

Hosts the Collection, which is used as parent classes for others, such as Blueprint and Group.

class Collection( *, entities: EntityList = NOTHING, tiles: TileList = NOTHING, groups: CollectionList = NOTHING, schedules: ScheduleList = NOTHING, wires=NOTHING, parameters: list[IDParameter | NumberParameter] = NOTHING, stock_connections: list[StockConnection] = NOTHING, )¶

Abstract class used to describe an object that can contain a list of EntityLike and Tile instances.

entities : EntityList¶

Serialized

This attribute is imported/exported from blueprint strings.

The list containing this collection’s entities.

Supports inserting/appending new entities via a string name, as well as any keyword arguments to pass to that entity’s constructor:

blueprint.entities.append("wooden-chest", bar=10)
assert type(blueprint.entities[-1]) is Container
assert blueprint.entities[-1].name == "wooden-chest"
assert blueprint.entities[-1].bar == 10

In addition to indexing by integer location, EntityList also supports indexing via string, corresponding to the id of the entity:

blueprint.entities.insert(0, "wooden-chest", id="example")
assert blueprint.entities["example"] is blueprint.entities[0]

property flippable : bool¶: Whether or not this collection can be flipped or not. This is determined by whether or not any of the entities contained can be flipped or not. Read only.

groups : CollectionList¶

A list of child Group objects that this collection contains.

Like EntityList, Groups added to this list with populated IDs can be accessed via those IDs:

>>> from draftsman.blueprintable import Blueprint, Group
>>> blueprint = Blueprint()
>>> new_group = Group(id="something")
>>> blueprint.groups.append(new_group)
Group(...)
>>> assert blueprint.groups["something"] == new_group

This attribute is not exported. Instead, all entities/tiles that are contained within it are “flattened” to the root-most entity/tile lists, with their positions and associations preserved.

Added in version 3.0.0.

parameters : list[IDParameter | NumberParameter]¶

Serialized

This attribute is imported/exported from blueprint strings.

A list of all Parameter s that this blueprint implements.

Parameters are evaluated sequentially from the beginning of the list to the end.

Added in version 3.1.0: (Factorio 2.0)

property rotatable : bool¶: Whether or not this collection can be rotated or not. Included for posterity; always returns True, even when containing entities that have no direction component. Read only.

schedules : ScheduleList¶: Serialized

This attribute is imported/exported from blueprint strings.

A list of the Collections’s Schedule s.

stock_connections : list[StockConnection]¶: Serialized

This attribute is imported/exported from blueprint strings.

A list of connections between train cars, documenting exactly which ones are connected to what. Prior to Factorio 2.0, train car connections were inferred and automatically generated on blueprint import; this field allows for manual control over this behavior.

Added in version 3.0.0: (Factorio 2.0)

tiles : TileList¶

Serialized

This attribute is imported/exported from blueprint strings.

The list containing this collection’s tiles.

Supports inserting/appending new tiles via a string name, as well as any keyword arguments to pass to that entity’s constructor:

blueprint.tiles.append("landfill")
assert type(blueprint.tiles[-1]) is Tile
assert blueprint.tiles[-1].name == "landfill"

wires : list[list[Association, WireConnectorID, Association, WireConnectorID]]¶

Serialized

This attribute is imported/exported from blueprint strings.

A list of all the wire connections in this blueprint.

Wires are specified as two pairs of Association and WireConnectorID; the first pair represents the first entity, and the second pair represents the second entity. The association points to the corresponding entity in this collection, and the wire type enum indicates what type of connection it is.

When exported to JSON, the associations and enums in each wire are resolved to integers corresponding to the given entity_number in the resulting entities list.

Added in version 3.0.0: (Factorio 2.0)

Adds a circuit wire connection between two entities. Each entity can be either a reference to the original entity to connect, the index of the entity in the entities list, or it’s string ID. Color specifies the color of the wire to make the connection with, and is either "red" or "green". side1 specifies which side of the first entity to connect to (if applicable), and side2 specifies which side of the second entity to connect to (if applicable). Does nothing if the connection already exists.

Raises ConnectionSideWarning if the side of either of the entities is 2 when the entity is not dual-circuit-connectable.

Raises ConnectionRangeWarning if the distance between the two entities exceeds the maximum wire distance between the two.

Parameters:

color: 'red' | 'green'¶: Color of the wire to make the connection with. Must be either "red" or "green".
entity_1: EntityLike | int | str | Sequence[int | str]¶: ID or index of the first entity to join.
entity_2: EntityLike | int | str | Sequence[int | str]¶: ID or index of the second entity to join.
side_1: 'input' | 'output' = 'input'¶: Which side of entity_1 to connect to. Only necessary to specify for entities that are Entity.dual_circuit_connectable.
side_2: 'input' | 'output' = 'input'¶: Which side of entity_2 to connect to. Only necessary to specify for entities that are Entity.dual_circuit_connectable.

Raises:

KeyError, IndexError – If entity_1 and/or entity_2 are invalid ID’s or indices to the parent Collection.
InvalidAssociationError – If entity_1 and/or entity_2 are not inside the parent Collection.
InvalidWireTypeError – If color is neither "red" nor "green".
InvalidConnectionSideError – If side_1 or side_2 are neither "input" nor "output".
EntityNotCircuitConnectableError – If either entity_1 or entity_2 do not have the capability to be circuit wire connected.

Adds a copper wire power connection between two entities. Each entity can be either a reference to the original entity to connect, the index of the entity in the entities list, or it’s string ID. Tuples of strings and ints mean to recursively search through the Collection ‘s groups for an entity at that tree “path”. For example:

blueprint.entities.append("small-electric-pole")
group = Group("group") # A type of `Collection`
group.entities.append("small-electric-pole", tile_position=(5, 0))
blueprint.groups.append(group)

# Add a connection between the first power pole and the first entity
# in the group
blueprint.add_power_connection(blueprint.entities[0], ("group", 0))

Side specifies which side to connect to when establishing a connection to a dual-power-connectable entity (usually a power-switch). Does nothing if the connection already exists.

Raises ConnectionRangeWarning if the distance between the two entities exceeds the maximum wire distance between the two.

Raises TooManyConnectionsWarning if either of the power poles exceed 5 connections when this connection is added.

Parameters:

entity_1: EntityLike | int | str | Sequence[int | str]¶: EntityLike, ID, or index of the first entity to join.
entity_2: EntityLike | int | str | Sequence[int | str]¶: EntityLike, ID or index of the second entity to join.
side_1: 'input' | 'output' = 'input'¶: Which side of entity_1 to connect power to. Only necessary to specify for entities that are Entity.dual_power_connectable.
side_2: 'input' | 'output' = 'input'¶: Which side of entity_2 to connect power to. Only necessary to specify for entities that are Entity.dual_power_connectable.

Raises:

KeyError, IndexError – If entity_1 and/or entity_2 are invalid ID’s or indices to the parent Collection.
InvalidAssociationError – If entity_1 and/or entity_2 are not inside the parent Collection.
EntityNotPowerConnectableError – If either entity_1 or entity_2 do not have the capability to be copper wire connected.
DraftsmanError – If both entity_1 and entity_2 are dual-power-connectable, of which a connection is forbidden.

add_train_at_position( config: TrainConfiguration, position: Vector | tuple[int | float, int | float], direction: Direction, schedule: Schedule | None = None, ) → None¶

Adds a train with a specified configuration and schedule at a position facing a particular direction. Allows you to place a fully configured train in a single function call.

If schedule is specified, then it’s checked if that schedule already exists within the collection’s schedules. If found, all the locomotives in the added train are added to that schedule’s locomotives; if not, a new schedule is appended to the list and the locomotives are added to that entry instead.

Parameters:

config: TrainConfiguration¶: The TrainConfiguration to use as a template for the created train, or a str that will be converted into one.
position: Vector | tuple[int | float, int | float]¶: A Vector specifying the center of the starting wagon.
direction: Direction¶: A Direction enum or int specifying which direction the train is “facing”.
schedule: Schedule | None = None¶: A Schedule object specifying the schedule that the newly created train should inherit.

add_train_at_station( config: TrainConfiguration, station: EntityLike | str | int, schedule: Schedule | None = None, ) → None¶

Adds a train with a specified configuration and schedule behind a specified train stop.

Parameters:

config: TrainConfiguration¶: The TrainConfiguration to use as a template for the created train, or a str that will be converted into one.
station: EntityLike | str | int¶: The ID or index of the train entity stop to spawn behind. Note that station names cannot be used; if you want to place a train behind a stop with a specific station name use find_entities_filtered() to find candidates and then pick ones from there.
schedule: Schedule | None = None¶: A Schedule object specifying the schedule that the newly created train should inherit.

Returns a list of all entities within the area aabb. Works similiarly to LuaSurface.find_entities. If no aabb is provided then the method simply returns all the entities in the blueprint.

Parameters:

aabb: AABB | tuple[tuple[int | float, int | float], tuple[int | float, int | float]] | None = None¶: An AABB, or a Sequence of 4 floats, usually a list or tuple.

Returns:

A regular list of EntityLikes whose collision_box overlaps the queried AABB.

Returns a filtered list of entities within the Collection. Works similarly to LuaSurface.find_entities_filtered.

Keywords are organized into two main categrories: region and criteria:

Region keywords¶
Name	Type	Description
`position`	`Vector` or `PrimitiveVector`	Grid position to search.
`radius`	`float`	Radius of the circle around position to search.
`area`	`AABB` or `PrimitiveAABB`	AABB to search in.

If none of the above are specified, then the search area becomes the entire Collection. If radius is specified but position is not, the search area also becomes the entire Collection.

Criteria keywords¶
Name	Type	Description
`name`	`str` or `set{str}`	The name(s) of the entities that you want to search for.
`type`	`str` or `set{str}`	The type(s) of the entities that you want to search for.
`direction`	`Direction` or `set{Direction}`	The direction(s) of the entities that you want to search for. Excludes entities that have no direction.
`limit`	`int`	Limit the maximum size of the returned list to this amount. Unlimited by default.
`invert`	`bool`	Whether or not to return the inverse of the search. False by default.

Parameters:

position: Vector | None = None¶: The global position to search the source Collection. Can be used in conjunction with radius to search a circle instead of a single point. Takes precedence over area.
radius: float | None = None¶: The radius of the circle centered around position to search. Must be defined alongside position in order to search in a circular area.
area: AABB | tuple[tuple[int | float, int | float], tuple[int | float, int | float]] | None = None¶: The AABB or PrimitiveAABB to search in.
name: str | set[str] | None = None¶: Either a str, or a set[str] where each entry is a name of an entity to be returned.
type: str | set[str] | None = None¶: Either a str, or a set[str] where each entry is a type of an entity to be returned.
direction: Direction | None = None¶: Either a Direction enum (or corresponding int), or a set[Direction] where each entry is a valid direction for each returned entity to match. Excludes entities that have no direction attribute.
invert: bool = False¶: Whether or not to return the inversion of the search criteria.
limit: int | None = None¶: The total number of matching entities to return. Unlimited by default.

Returns:

A list of Entity references inside the searched collection that satisfy the search criteria.

find_entity( name: str, position: Vector | tuple[int | float, int | float], ) → EntityLike¶

Finds an entity with name at a position position. If multiple entities exist at the queried position, the one that was first placed is returned.

Parameters:

name: str¶: The name of the entity to look for.
position: Vector | tuple[int | float, int | float]¶: The position to search, either a PrimitiveVector or a Vector.

Retuns:

The EntityLike at position, or None of none were found.

find_entity_at_position( position: Vector | tuple[int | float, int | float], ) → EntityLike¶

Finds any entity at the position position. If multiple entities exist at the queried position, the one that was first placed is returned.

Parameters:

position: Vector | tuple[int | float, int | float]¶: The position to search, either a PrimitiveVector or a Vector.

Retuns:

The EntityLike at position, or None of none were found.

find_tile( position: Vector | tuple[int | float, int | float], ) → list[Tile]¶

Returns a list containing all the tiles at the tile coordinate position. If there are no tiles at that position, an empty list is returned.

Parameters:

position: Vector | tuple[int | float, int | float]¶: The position to search, either a PrimitiveVector or a Vector.

Returns:

A list of all tiles at position.

Returns a filtered list of tiles within the blueprint. Works similarly to LuaSurface.find_tiles_filtered.

Keywords are organized into two main categrories: region and criteria:

Region keywords¶
Name	Type	Description
`position`	`Vector` or `PrimitiveVector`	Grid position to search.
`radius`	`float`	Radius of the circle around position to search.
`area`	`AABB` or `PrimitiveAABB`	AABB to search in.

Criteria keywords¶
Name	Type	Description
`name`	`str` or `set{str}`	The name(s) of the entities that you want to search for.
`limit`	`int`	Limit the maximum size of the returned list to this amount. Unlimited by default.
`invert`	`bool`	Whether or not to return the inverse of the search. `False` by default.

Parameters:

position: Vector | tuple[int | float, int | float] | None = None¶: The global position to search the source Collection. Can be used in conjunction with radius to search a circle instead of a single point. Takes precedence over area.
radius: float | None = None¶: The radius of the circle centered around position to search. Must be defined alongside position in order to search in a circular area.
area: AABB | tuple[tuple[int | float, int | float], tuple[int | float, int | float]] | None = None¶: The AABB or PrimitiveAABB to search in.
name: str | None = None¶: Either a str, or a set[str] where each entry is a name of an entity to be returned.
invert: bool = False¶: Whether or not to return the inversion of the search criteria.
limit: int | None = None¶: The total number of matching entities to return. Unlimited by default.

Returns:

A list of Tile references inside the searched collection that match the specified criteria.

Returns a list of rolling stock connected together. Allows you to grab all connected cars to a particular wagon if you know where one is, such as when iterating through the locomotives in a particular Schedule object, cargo wagons with a particular item filter returned from find_entities_filtered(), etc.

Note that this function may return a working train (rolling stock with at least one connected locomotive), but it also may not, since it’s only criteria is connection.

Warning

This function might also return false positives if rolling stock is located right next to each other in a fully-compresssed rail setups. PR’s to mitigate this are welcome.

Parameters:

wagon: Locomotive | CargoWagon | FluidWagon | ArtilleryWagon¶: The ID of the wagon or the wagon itself to search for neighbours.

Returns:

A list of references to all connected wagons in the Collection, including wagon itself. The order of wagons is listed from end to end, where the first entry in the list is the outermost car in the direction that wagon points.

Finds a set of trains that match the passed in parameters. Formally, a “train” in this context is a connected set of wagons which may or may not contain a locomotive. This is done so that the user can search a blueprint for unconnected rolling stock if any exists, and can filter for regular trains more broadly.

Note

When using the config parameter, equality is strictly checked; which means that if a returned train doesn’t _exactly_ match the specified argument, the train is filtered from the result. This includes things like fuel requests and cargo wagon item filters, so check these values in the blueprints you’re searching and adjust config accordingly.

Parameters:

train_length: int | tuple | None = None¶: Can either be specified as an int representing the exact length of trains to return, or as a Sequence of 2 int``s representing the minimum and maximum length of trains to return (inclusive). Either the min or the max can also be set to ``None which indicates no minimum length and no maxiumum length respectively.
orientation: Orientation | None = None¶: A Orientation (or equivalent float) that describes the orientation that every car in the returned train list should have. Note that trains placed on curved rails will not be returned by this parameter, as _all_ train cars must equal orientation.
at_station: bool | set = False¶: Can be specified as a bool value which will return all trains at any station, a str value where it will return all trains at any station with that name, or as a set[str] where all of the trains behind any station with one of those names is returned.
num_type: dict | None = None¶: A dict of wagon types where each key is the str type of the wagon and the value is an int representing the desired number of those wagons in the returned train. Allows to search for trains of a particular composition without regards to contents, order, or orientation. Also supports swapping the int with a Sequence of 2 int``s representing the minimum and maximum tolerable value of a wagon of that type, along with ``None for no particular min or max.
num_name: dict | None = None¶: Identical to num_type, except that instead of wagon type it’s wagon name, in case there happen to be more than one Locomotive, CargoWagon, FluidWagon, or ArtilleryWagon. Useful for blueprints with modded trains, where you might want to distinguish between them.
config: TrainConfiguration | None = None¶: A TrainConfiguration object to filter against. Performs a equality check between each of the train configuration’s cars and the cars in the returned trains.
schedule: Schedule | None = None¶: A Schedule that the returned trains should match. Only trains who’s schedules match this one exactly will be returned.
invert: bool = False¶: Whether or not to return the inversion of the search criteria.
limit: int | None = None¶: A maximum number of unique trains to return.

Returns:

A list of list s, where each sub-list represents a contiguous train. Trains are ordered such that the first index is the “front” of the train, as chosen by the orientation of the first found wagon in that group.

generate_power_connections( prefer_axis: bool = True, only_axis: bool = False, ) → None¶

Automatically create power connections between all electric poles.

The algorithm used is similar to demi-pixel’s generateElectricalConnections() function, but with some slight differences. Power poles are still prioritized closest first, but can be selected to prefer to connect neighbours on the same axis, as well as only connect to neighbours on the same axis. This function will only connect power poles that have less than 5 power connections already made, preserving power connections that were manually specified. This function does not generate connections between power-switches.

Parameters:

prefer_axis: bool = True¶: Determines whether or not to rank power-poles on the same x or y coordinate higher than poles that are closer, but not on either axis. Used to prefer creating neat, regular grids when possible.
only_axis: bool = False¶: Removes any neighbour that does not lie on the same x or y axis from the candidate pool, preventing non-grid connections.

Removes a circuit wire connection between two entities. Each entity can be either a reference to the original entity to connect, the index of the entity in the entities list, or it’s string ID. side1 specifies which side of the first entity to remove the connection from (if applicable), and side2 specifies which side of the second entity to remove the connection from (if applicable). Does nothing if the specified connection doesn’t exist.

Parameters:

color: 'red' | 'green'¶: Color of the wire to remove. Either "red" or "green".
entity_1: EntityLike | int | str | Sequence[int | str]¶: ID or index of the first entity to remove the connection to.
entity_2: EntityLike | int | str | Sequence[int | str]¶: ID or index of the second entity to remove the connection to.
side_1: 'input' | 'output' = 'input'¶: Which side of entity_1 to remove the connection from. Only necessary to specify for entities that are Entity.dual_circuit_connectable.
side_2: 'input' | 'output' = 'input'¶: Which side of entity_2 to remove the connection from. Only necessary to specify for entities that are Entity.dual_circuit_connectable.

Raises:

KeyError, IndexError – If entity_1 and/or entity_2 are invalid ID’s or indices to the parent Collection.
InvalidAssociationError – If entity_1 and/or entity_2 are not inside the parent Collection.

remove_circuit_connections() → None¶: Remove all circuit connections in the Collection. Recurses through all subgroups and removes circuit connections from them as well. Does nothing if there are no circuit connections in the Collection to remove.

Removes a copper wire power connection between two entities. Each entity can be either a reference to the original entity to connect, the index of the entity in the entities list, or it’s string ID. side specifies which side to remove the connection from when removing a connection to a dual-power-connectable entity (usually a power-switch). Does nothing if the specified connection does not exist.

Parameters:

entity_1: EntityLike | int | str | Sequence[int | str]¶: EntityLike, ID or index of the first entity to remove the connection to.
entity_2: EntityLike | int | str | Sequence[int | str]¶: EntityLike, ID or index of the second entity to remove the connection to.
side_1: 'input' | 'output' = 'input'¶: Which side of entity_1 to remove a power connection from. Only necessary to specify for entities that are Entity.dual_power_connectable.
side_2: 'input' | 'output' = 'input'¶: Which side of entity_2 to remove a power connection from. Only necessary to specify for entities that are Entity.dual_power_connectable.

Raises:

KeyError, IndexError – If entity_1 and/or entity_2 are invalid ID’s or indices to the parent Collection.
InvalidAssociationError – If entity_1 and/or entity_2 are not inside the parent Collection.

remove_power_connections() → None¶: Remove all power connections in the Collection, including any power connections between power switches. Recurses through any subgroups, and removes power connections from them as well. Does nothing if there are no power connections in the Collection.

remove_train(cars: list[EntityLike]) → None¶

Removes all of the rolling stock specified as the list cars, and also takes care of removing any locomotive associations in any corresponding Schedule object(s). Does nothing if cars is empty.

Parameters:

cars: list[EntityLike]¶: A list of references to EntityLike s within the collection.

Raises:

KeyError – If the specified entities within the list do not exist within the collection being accessed.

Sets the schedule of a particular locomotive, or an entire list of RollingStock. The list of rolling stock can include non-locomotive cars, they will just be skipped when setting schedules. The list of rolling stock can also include locomotives across multiple trains; in this case all connected train cars from every touched train will be given the new schedule. If schedule is set to None, then any touched locomotive will have their schedule cleared instead of set.

Parameters:

train_cars: Locomotive | list[Locomotive | CargoWagon | FluidWagon | ArtilleryWagon]¶: The single Locomotive, or a list of RollingStock.
schedule: Schedule | None¶: The Schedule to give each connected train, or None to remove the schedule from each connected train.

collection¶

`collection`¶