Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Prototype Docs Version 2.0.77

# ProcessionPrototype - Prototype Docs

## ProcessionPrototype 'procession'

Describes the duration and visuals of a departure, arrival or an intermezzo while traveling between surfaces. Usually provided inside of a ProcessionSet.

Inherits from Prototype « PrototypeBase

## Properties

- default
- sorted

timeline | :: ProcessionTimeline | Used when leaving or arriving to a station.
Used when leaving or arriving to a station.
ground_timeline optional | :: ProcessionTimeline | Used alternatively when landing to ground.
Used alternatively when landing to ground.
usage | :: `"departure"` or `"arrival"` or `"intermezzo"` | Arrival and Departure are to be referenced by name. [...]
Arrival and Departure are to be referenced by name. [...]
procession_style | :: uint32 or array[uint32] | Indexes used to match transitions from different surfaces together. [...]
Indexes used to match transitions from different surfaces together. [...]

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. [...]
custom_tooltip_fields optional | :: array[CustomTooltipField] | Allows to add extra description items to the tooltip and Factoriopedia.
Allows to add extra description items to the tooltip and Factoriopedia.

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 optional | :: LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
subgroup optional | :: ItemSubGroupID | The name of an ItemSubGroup.
The name of an ItemSubGroup.
hidden optional | :: boolean |
hidden_in_factoriopedia optional | :: boolean |
parameter optional | :: boolean | 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 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.

procession_style | :: uint32 or array[uint32] | Indexes used to match transitions from different surfaces together. [...]
Indexes used to match transitions from different surfaces together. [...]
timeline | :: ProcessionTimeline | Used when leaving or arriving to a station.
Used when leaving or arriving to a station.
usage | :: `"departure"` or `"arrival"` or `"intermezzo"` | Arrival and Departure are to be referenced by name. [...]
Arrival and Departure are to be referenced by name. [...]
ground_timeline optional | :: ProcessionTimeline | Used alternatively when landing to ground.
Used alternatively when landing to ground.

Inherited from Prototype

custom_tooltip_fields optional | :: array[CustomTooltipField] | Allows to add extra description items to the tooltip and Factoriopedia.
Allows to add extra description items to the tooltip and Factoriopedia.
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 optional | :: LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
factoriopedia_simulation 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 optional | :: boolean |
hidden_in_factoriopedia optional | :: boolean |
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 optional | :: boolean | 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 optional | :: ItemSubGroupID | The name of an ItemSubGroup.
The name of an ItemSubGroup.

## Properties

### timeline :: ProcessionTimeline

Used when leaving or arriving to a station.

### ground_timeline :: ProcessionTimeline optional

Used alternatively when landing to ground.

### usage :: `"departure"` or `"arrival"` or `"intermezzo"`

Arrival and Departure are to be referenced by name. All intermezzos are collected during loading and filled in by `procession_style`.

### procession_style :: uint32 or array[uint32]

Indexes used to match transitions from different surfaces together. Only a single intermezzo of a given procession_style may exist.

#### Example

    Going from Surface A -> Surface B
    Surface A has departures: [1, 3, 4]
    Surface B has arrivals:   [2, 3, 5]
    This trip will select:
    Departure 3 -> (Intermezzo 3) -> Arrival 3