Official Factorio Wiki - User contributions [en]

Prototype/SimpleEntityWithForce

2019-08-04T16:54:56Z

Slippycheeze:

{{Prototype parent|Prototype/EntityWithHealth}}

== Basics ==
Prototype type: '''simple-entity-with-force'''

Extends [[Prototype/EntityWithHealth]].

This entity will be a priority target for units/turrets, who will choose to attack it even if it does not block their path. Use [[Prototype/SimpleEntityWithOwner]] for entities that are only attacked when they block enemies.

== Optional properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].

=== render_layer ===
'''Type''': [[Types/RenderLayer]]

'''Default''': "object"

=== force_visibility ===
'''Type''': [[Types/ForceCondition]]

'''Default''': "all"

=== random_animation_offset ===
'''Type''': [[Types/bool]]

'''Default''': false

=== pictures ===
'''Type''': [[Types/SpriteVariations]]

Must have one of 'picture', 'pictures' or 'animations' defined.

=== picture ===
'''Type''': [[Types/Sprite]]

Must have one of 'picture', 'pictures' or 'animations' defined.

=== animations ===
'''Type''': [[Types/AnimationVariations]]

Must have one of 'picture', 'pictures' or 'animations' defined.

Talk:PrototypeBase

2019-08-04T16:07:10Z

Slippycheeze: /* proposed update along with redirection of 'prototype' to the list */

== proposed update along with redirection of 'prototype' to the list ==

=== why ===

Per bilka, [[Prototype]] used to go to the page that is now [[PrototypeBase]] -- and so folks who have used that for a long time will expect that relationship.

On the other hand, I believe that the full list of prototypes is vastly more valuable to most users, and makes a lot more sense as the target of the redirect.

To make that transition, but ease the pain of older users while they get used to it, I propose altering the text of the list page as follows, as well as updating the redirect (or just making the [[Prototype]] page the content of) the current [[Prototype_definitions]] page.

=== what ===

This is an attempt to emulate the upstream mediawiki [https://en.wikipedia.org/w/index.php?title=Template:Did_you_mean_box&action=edit Template:Did you mean box]

Using that, which has a parameter for the destination page, highly advised. :)

In any case this is intended to be displayed on the [[Prototype_definitions]] page, so that people who expect [[Prototype]] to show up here at [[PrototypeBase]] get pointed in the right direction.

=== inlined header and demo content ===

This is a list of all available prototype types in the game. Each point lists the link to the prototype page which is named after the class in the code, and the string that is used as the type name. Prototypes that have the type name <code><abstract></code> cannot be directly created, they simple exist as classes that multiple prototypes can inherit properties from. '''This list is updated to 0.17. All existing prototype pages are for 0.17. Pages with the Types/ prefix are not guaranteed to be up to date.'''

<div style="margin-left: 20%; margin-right: 20%; border: medium solid OrangeRed;">
<span style="float: left">{{Icon|Programmable speaker}}</span>
'''Prototype''' previously redirected to [[PrototypeBase]], the abstract base for all prototypes.
</div>
{{Clear}}

General info for prototype creation:
* Prototype objects are specified in the data phase: [http://lua-api.factorio.com/latest/Data-Lifecycle.html]
* Only the properties listed on the page of a prototype, and the properties the prototype inherits, are recognized by the game. Any additional code will be discarded at the end of the data phase.

[[User:Slippycheeze|Slippycheeze]] ([[User talk:Slippycheeze|talk]]) 16:01, 4 August 2019 (UTC)

Talk:PrototypeBase

2019-08-04T16:01:35Z

Slippycheeze: /* proposed update along with redirection of 'prototype' to the list */

== proposed update along with redirection of 'prototype' to the list ==

This is an attempt to emulate the upstream mediawiki [https://en.wikipedia.org/w/index.php?title=Template:Did_you_mean_box&action=edit Template:Did you mean box]

Using that, which has a parameter for the destination page, highly advised. :)

In any case this is intended to be displayed on the [[Prototype_definitions]] page, so that people who expect [[Prototype]] to show up here at [[PrototypeBase]] get pointed in the right direction.

=== inlined header and demo content ===

This is a list of all available prototype types in the game. Each point lists the link to the prototype page which is named after the class in the code, and the string that is used as the type name. Prototypes that have the type name <code><abstract></code> cannot be directly created, they simple exist as classes that multiple prototypes can inherit properties from. '''This list is updated to 0.17. All existing prototype pages are for 0.17. Pages with the Types/ prefix are not guaranteed to be up to date.'''

<div style="margin-left: 20%; margin-right: 20%; border: medium solid OrangeRed;">
<span style="float: left">{{Icon|Programmable speaker}}</span>
'''Prototype''' previously redirected to [[PrototypeBase]], the abstract base for all prototypes.
</div>
{{Clear}}

General info for prototype creation:
* Prototype objects are specified in the data phase: [http://lua-api.factorio.com/latest/Data-Lifecycle.html]
* Only the properties listed on the page of a prototype, and the properties the prototype inherits, are recognized by the game. Any additional code will be discarded at the end of the data phase.

[[User:Slippycheeze|Slippycheeze]] ([[User talk:Slippycheeze|talk]]) 16:01, 4 August 2019 (UTC)

Talk:PrototypeBase

2019-08-04T15:07:08Z

Slippycheeze: /* proposed update along with redirection of 'prototype' to the list */

== proposed update along with redirection of 'prototype' to the list ==
This is an attempt to emulate the upstream mediawiki [https://en.wikipedia.org/w/index.php?title=Template:Did_you_mean_box&action=edit Template:Did you mean box]

Using that, which has a parameter for the destination page, highly advised. :)

In any case this is intended to be displayed on the [[Prototype_definitions]] page, so that people who expect [[Prototype]] to show up here at [[PrototypeBase]] get pointed in the right direction.

=== inlined header and demo content ===

This is a list of all available prototype types in the game. Each point lists the link to the prototype page which is named after the class in the code, and the string that is used as the type name. Prototypes that have the type name <code><abstract></code> cannot be directly created, they simple exist as classes that multiple prototypes can inherit properties from. '''This list is updated to 0.17. All existing prototype pages are for 0.17. Pages with the Types/ prefix are not guaranteed to be up to date.'''

<div style="margin-left: 20%; margin-right: 20%; border: medium solid OrangeRed;">
<span style="float: left">{{Icon|Programmable speaker}}</span>
'''Prototype''' previously redirected to [[PrototypeBase]], the abstract base for all prototypes.
</div>
{{Clear}}

General info for prototype creation:
* Prototype objects are specified in the data phase: [http://lua-api.factorio.com/latest/Data-Lifecycle.html]
* Only the properties listed on the page of a prototype, and the properties the prototype inherits, are recognized by the game. Any additional code will be discarded at the end of the data phase.

Talk:PrototypeBase

2019-08-04T15:03:37Z

Slippycheeze: demo the suggested redirection notice for making `prototype` point to the list of prototypes, not PrototypeBase page.

== proposed update along with redirection of 'prototype' to the list ==
This is an attempt to emulate the upstream mediawiki [https://en.wikipedia.org/w/index.php?title=Template:Did_you_mean_box&action=edit Template:Did you mean box]

Using that, which has a parameter for the destination page, highly advised. :)

=== inlined header and demo content ===

This is a list of all available prototype types in the game. Each point lists the link to the prototype page which is named after the class in the code, and the string that is used as the type name. Prototypes that have the type name <code><abstract></code> cannot be directly created, they simple exist as classes that multiple prototypes can inherit properties from. '''This list is updated to 0.17. All existing prototype pages are for 0.17. Pages with the Types/ prefix are not guaranteed to be up to date.'''

<div style="margin-left: 20%; margin-right: 20%; border: medium solid OrangeRed;">
<span style="float: left">{{Icon|Programmable speaker}}</span>
'''Prototype''' previously redirected to [[PrototypeBase]], the abstract base for all prototypes.
</div>
{{Clear}}

General info for prototype creation:
* Prototype objects are specified in the data phase: [http://lua-api.factorio.com/latest/Data-Lifecycle.html]
* Only the properties listed on the page of a prototype, and the properties the prototype inherits, are recognized by the game. Any additional code will be discarded at the end of the data phase.

Types/HeatBuffer

2019-07-27T22:50:15Z

Slippycheeze: Blanked the page

Types/HeatBuffer

2019-07-27T22:46:46Z

Slippycheeze: redirect to the definition of the energy source for heat.

#REDIRECT [[Types/EnergySource#Heat_energy_source]]

Blueprint string format

2019-07-26T03:14:27Z

Slippycheeze: Add a pointer to an online codec for blueprint strings vs JSON.

{{Languages}} [[Category:Technical]]
This is a technical description of the blueprint string format, used to share blueprints with other users.

A blueprint string is a JSON representation of the blueprint, compressed with zlib deflate using compression level 9 and then encoded using base64 with a version byte in front of the encoded string. The version byte is currently 0 for vanilla 0.15, 0.16 and 0.17.
So to get the JSON representation of a blueprint from a blueprint string, skip the first byte, base64 decode the string, and finally decompress using zlib inflate.

== JSON encoder / decoder for blueprint and blueprint book strings ==

An online encoder and decoder for blueprint and blueprint book strings is available at https://factorio.tmin10.ru/

== Json representation of a blueprint/blueprint book ==

The json representation of a blueprint or blueprint book is one large object inside another "wrapping" object, its key inside that object is either blueprint or blueprint-book.

=== Blueprint book object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| item
| String, the name of the item that was saved ("blueprint-book" in vanilla).
| String
|-
| label
| String, the name of the blueprint set by the user.
| String
|-
| label_color
| The color of the label of this blueprint. Optional. [[#Color object]].
| Object
|-
| blueprints
| The actual content of the blueprint book, array of objects containing an "index" key and 0-based value and a "blueprint" key with a [[#Blueprint object]] as the value.
| Array
|-
| active_index
| Index of the currently selected blueprint, 0-based.
| Integer
|-
| version
| The map version of the map the blueprint was created in.
| Integer (long)
|}

=== Blueprint object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| item
| String, the name of the item that was saved ("blueprint" in vanilla).
| String
|-
| label
| String, the name of the blueprint set by the user.
| String
|-
| label_color
| The color of the label of this blueprint. Optional. [[#Color object]].
| Object
|-
| entities
| The actual content of the blueprint, array of [[#Entity object]]s.
| Array
|-
| tiles
| The tiles included in the blueprint, array of [[#Tile object]]s.
| Array
|-
| icons
| The icons of the blueprint set by the user, array of [[#Icon object]]s.
| Array
|-
| version
| The map version of the map the blueprint was created in.
| Integer (long)
|}

=== Icon object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| index
| Index of the icon, 1-based.
| Integer
|-
| signal
| The icon that is displayed, [[#SignalID object]].
| Object
|}

=== SignalID object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the signal prototype this signal is set to.
| String
|-
| type
| Type of the signal. Either "item", "fluid" or "virtual".
| String
|}

=== Entity object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| entity_number
| Index of the entity, 1-based.
| Integer
|-
| name
| Prototype name of the entity (e.g. "offshore-pump").
| String
|-
| position
| [[#Position object]], position of the entity within the blueprint.
| Object
|-
| direction
| Direction of the entity, uint (optional).
| Integer
|-
| connections
| Circuit connection, object with keys starting from 1, values are [[#Connection object]]s (optional).
| Object
|-
| control_behaviour
|
| Object
|-
| items
| Item requests by this entity, this is what defines the item-request-proxy when the blueprint is placed, optional. [[#Item request object]]
| Object
|-
| recipe
| Name of the recipe prototype this assembling machine is set to, optional, string.
|String
|-
| bar
| Used by [[Prototype/Container]], optional. The index of the first inaccessible item slot due to limiting with the red "bar". 0-based [[Types/ItemStackIndex]].
| Integer
|-
| infinity_settings
| Used by [[Prototype/InfinityContainer]], optional. [[#Infinity settings object]]
| Object
|-
| type
| Type of the underground belt or loader, optional. Either "input" or "output".
| String
|-
| input_priority
| Input priority of the splitter, optional. Either "right" or "left", "none" is omitted.
| String
|-
| output_priority
| Output priority of the splitter, optional. Either "right" or "left", "none" is omitted.
| String
|-
| filter
| Filter of the splitter, optional. Name of the item prototype the filter is set to, string.
| String
|-
| filters
| Filters of the filter inserter or loader, optional. Array of [[#Item filter object]]s.
| Array
|-
| override_stack_size
| The stack size the inserter is set to, optional. [[Types/uint8]].
| Integer
|-
| drop_position
| The drop position the inserter is set to, optional. [[#Position object]].
| Object
|-
| pickup_position
| The pickup position the inserter is set to, optional. [[#Position object]].
| Object
|-
| request_filters
| Used by [[Prototype/LogisticContainer]], optional. [[#Logistic filter object]].
| Array
|-
| request_from_buffers
| Boolean. Whether this requester chest can request from buffer chests.
| Boolean
|-
| parameters
| Used by [[Programmable speaker]], optional. [[#Speaker parameter object]].
| Object
|-
| alert_parameters
| Used by [[Programmable speaker]], optional. [[#Speaker alert parameter object]]
| Object
|-
| auto_launch
| Used by the rocket silo, optional. Boolean, whether auto launch is enabled.
| Boolean
|-
| variation
| Used by [[Prototype/SimpleEntityWithForce]] or [[Prototype/SimpleEntityWithOwner]], optional. [[Types/GraphicsVariation]]
|
|-
| color
| Color of the [[Prototype/SimpleEntityWithForce]], [[Prototype/SimpleEntityWithOwner]], or train station, optional. [[#Color object]].
| Object
|-
| station
| The name of the train station, optional.
| String
|}

=== Tile object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Prototype name of the tile (e.g. "concrete")
| String
|-
| position
| [[#Position object]], position of the entity within the blueprint.
| Object
|}

=== Position object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| x
| X position within the blueprint, 0 is the center.
| Floating point
|-
| y
| Y position within the blueprint, 0 is the center.
| Floating point
|}

=== Connection object ===
Object containing information about the connections to other entities formed by red or green wires.

{| class="wikitable"
! Key !! Description !! Data type
|-
| 1
| First connection point. The default for everything that doesn't have multiple connection points.[[#Connection point object]]
| Object
|-
| 2
| Second connection point. For example, the "output" part of an arithmetic combinator.[[#Connection point object]]
| Object
|}

=== Connection point object ===
The actual point where a wire is connected to. Contains information about where it is connected to.

{| class="wikitable"
! Key !! Description !! Data type
|-
| red
| An array of [[#Connection data object]] containing all the connections from this point created by red wire.
| Array
|-
| green
| An array of [[#Connection data object]] containing all the connections from this point created by green wire.
| Array
|}

=== Connection data object ===
Information about a single connection between two connection points.

{| class="wikitable"
! Key !! Description !! Data type
|-
| entity_id
| ID of the entity this connection is connected with.
| Integer
|-
| circuit_id
| The circuit connector id of the entity this connection is connected to, see [https://lua-api.factorio.com/latest/defines.html#defines.circuit_connector_id defines.circuit_connector_id].
| Integer
|}

=== Item request object ===
1 or more instances of key/value pairs.
Key is the name of the item, string.
Value is the amount of items to be requested, [[Types/ItemCountType]].

=== Item filter object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the item prototype this filter is set to.
| String
|-
| index
| Index of the filter, 1-based.
| Integer
|}

=== Infinity settings object ===
{| class="wikitable"
! Key !! Description
|-
| remove_unfiltered_items
| Boolean. Whether the "remove unfiltered items" checkbox is checked.
| Boolean
|-
| filters
| Filters of the infinity container, optional. Array of [[#Infinity filter object]]s.
| Array
|}

=== Infinity filter object ===
{| class="wikitable"
! Key !! Description
|-
| name
| Name of the item prototype the filter is set to, string.
| String
|-
| count
| Number the filter is set to, [[Types/ItemCountType]].
| Integer
|-
| mode
| Mode of the filter. Either "at-least", "at-most", or "exactly".
| String
|-
| index
| Index of the filter, 1-based.
| Integer
|}

=== Logistic filter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the item prototype this filter is set to.
| String
|-
| index
| Index of the filter, 1-based.
| Integer
|-
| count
| Number the filter is set to, [[Types/ItemCountType]]. Is 0 for storage chests.
| Integer
|}

=== Speaker parameter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| playback_volume
| [[Types/double]]. Volume of the speaker.
| Floating point
|-
| playback_globally
| Boolean, whether global playback is enabled.
| Boolean
|-
| allow_polyphony
| Boolean, whether polyphony is allowed.
| Boolean
|}

=== Speaker alert parameter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| show_alert
| Boolean, whether an alert is shown.
| Boolean
|-
| show_on_map
| Boolean, whether an alert icon is shown on the map.
| Boolean
|-
| icon_signal_id
| The icon that is displayed with the alert, [[#SignalID object]].
| Object
|-
| alert_message
| String, message of the alert.
| String
|}

=== Color object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| r
| red, number from 0 to 1.
| Floating point
|-
| g
| green, number from 0 to 1.
| Floating point
|-
| b
| blue, number from 0 to 1.
| Floating point
|-
| a
| transparency, number from 0 to 1.
| Floating point
|}