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

# Factorio Prototype Docs Version 2.0.77

# CargoHatchDefinition - Prototype Docs

## CargoHatchDefinition :: struct

## Properties

- default
- sorted

hatch_graphics optional | :: Animation |
hatch_render_layer optional | :: RenderLayer | render layer for the hatch itself.
render layer for the hatch itself.
entering_render_layer optional | :: RenderLayer | render layer for objects entering the hatch.
render layer for objects entering the hatch.
offset optional | :: Vector |
pod_shadow_offset optional | :: Vector |
sky_slice_height optional | :: float | y height relative to hatch position where the pod art gets clipped from sky to regular sorting layer.
y height relative to hatch position where the pod art gets clipped from sky to regular sorting layer.
slice_height optional | :: float | y height relative to hatch position where the pod art gets cut off.
y height relative to hatch position where the pod art gets cut off.
travel_height optional | :: float | y height relative to hatch position where the pod travels to during preparing and parking.
y height relative to hatch position where the pod travels to during preparing and parking.
busy_timeout_ticks optional | :: uint32 |
hatch_opening_ticks optional | :: uint32 |
opening_sound optional | :: InterruptibleSound | Cannot use `fade_ticks`.
Cannot use `fade_ticks`.
closing_sound optional | :: InterruptibleSound | Cannot use `fade_ticks`.
Cannot use `fade_ticks`.
cargo_unit_entity_to_spawn optional | :: EntityID |
illumination_graphic_index optional | :: uint32 | ProcessionGraphic index pointing to the ProcessionGraphicCatalogue inside the current SpaceLocationPrototype.
ProcessionGraphic index pointing to the ProcessionGraphicCatalogue inside the current SpaceLocationPrototype.
receiving_cargo_units optional | :: array[EntityID] |

busy_timeout_ticks optional | :: uint32 |
cargo_unit_entity_to_spawn optional | :: EntityID |
closing_sound optional | :: InterruptibleSound | Cannot use `fade_ticks`.
Cannot use `fade_ticks`.
entering_render_layer optional | :: RenderLayer | render layer for objects entering the hatch.
render layer for objects entering the hatch.
hatch_graphics optional | :: Animation |
hatch_opening_ticks optional | :: uint32 |
hatch_render_layer optional | :: RenderLayer | render layer for the hatch itself.
render layer for the hatch itself.
illumination_graphic_index optional | :: uint32 | ProcessionGraphic index pointing to the ProcessionGraphicCatalogue inside the current SpaceLocationPrototype.
ProcessionGraphic index pointing to the ProcessionGraphicCatalogue inside the current SpaceLocationPrototype.
offset optional | :: Vector |
opening_sound optional | :: InterruptibleSound | Cannot use `fade_ticks`.
Cannot use `fade_ticks`.
pod_shadow_offset optional | :: Vector |
receiving_cargo_units optional | :: array[EntityID] |
sky_slice_height optional | :: float | y height relative to hatch position where the pod art gets clipped from sky to regular sorting layer.
y height relative to hatch position where the pod art gets clipped from sky to regular sorting layer.
slice_height optional | :: float | y height relative to hatch position where the pod art gets cut off.
y height relative to hatch position where the pod art gets cut off.
travel_height optional | :: float | y height relative to hatch position where the pod travels to during preparing and parking.
y height relative to hatch position where the pod travels to during preparing and parking.

## Properties

### hatch_graphics :: Animation optional

### hatch_render_layer :: RenderLayer optional

Default: `"cargo-hatch"`

render layer for the hatch itself.

### entering_render_layer :: RenderLayer optional

Default: `"cargo-hatch"`

render layer for objects entering the hatch.

### offset :: Vector optional

Default: `{0, 0}`

### pod_shadow_offset :: Vector optional

Default: `{0, 0}`

### sky_slice_height :: float optional

Default: `-1.0`

y height relative to hatch position where the pod art gets clipped from sky to regular sorting layer.

### slice_height :: float optional

Default: `1.0`

y height relative to hatch position where the pod art gets cut off.

### travel_height :: float optional

Default: `1.0`

y height relative to hatch position where the pod travels to during preparing and parking.

### busy_timeout_ticks :: uint32 optional

Default: `120`

### hatch_opening_ticks :: uint32 optional

Default: `80`

### opening_sound :: InterruptibleSound optional

Cannot use `fade_ticks`.

### closing_sound :: InterruptibleSound optional

Cannot use `fade_ticks`.

### cargo_unit_entity_to_spawn :: EntityID optional

### illumination_graphic_index :: uint32 optional

Default: MAX_UINT32

ProcessionGraphic index pointing to the ProcessionGraphicCatalogue inside the current SpaceLocationPrototype.

### receiving_cargo_units :: array[EntityID] optional

Type used in

- CargoBayPrototype::hatch_definitions
- CargoStationParameters::hatch_definitions