Skip to content
Back to top
View this page

# `journey`

Module with structures to process data about Journey Mode powers, out of which the main one is `JourneySettingsCollection`.

## `journey_settings_collection`

Submodule containing `JourneySettingsCollection`.

class lihzahrd.terraria.world.journey.journey_settings_collection.JourneySettingsCollection(items: list[Item])

  Bases: `PackFlagArray`[`JourneySetting`]

  `PackFlagArray` which groups each possible Journey Mode setting.

  ITEM

    alias of `JourneySetting`

## `journey_setting`

Submodule containing `JourneySetting`.

class lihzahrd.terraria.world.journey.journey_setting.JourneySetting(value: Value)

  Bases: `PackPrimitive`[`JourneySettingData`]

  `lihzahrd.terraria.utils.pack.primitive.primitive.PackPrimitive` processing a single Journey Mode setting.

  exception ReadUnknownJourneySettingError(kind: int)

    Bases: `ReadError`

    The tile entity could not be read because its kind is unknown.

    If this happens, there’s no way to determine how the journey setting should be read, and so no way to determine which data belongs to it and which to a different one, so reading cannot continue.

    kind: int

      The ID of the unknown Journey setting.

  exception WriteUnknownJourneySettingError(data: JourneySettingData)

    Bases: `WriteError`

    The tile entity could not be written because its kind is unknown.

    If this happens, there’s no way to determine how the journey setting should be written, and so no way to determine which data belongs to it and which to a different one, so reading cannot continue.

    data: JourneySettingData

      The data of the unknown Journey setting.

## `journey_setting_data`

Submodule containing `JourneySettingData`.

class lihzahrd.terraria.world.journey.journey_setting_data.JourneySettingData

  Base class for Journey setting data.

  Todo

  Like with `lihzahrd.terraria.world.tile_entities.tile_entity_data.TileEntityData.extra`, a better, more extensible way to implement this would be via a ClassEnum and inheritance, as that would allow new kinds of journey settings to be registered without having to edit `lihzahrd`.

  abstractmethod static kind() → int
    Returns:

      The ID of the associated Journey setting.

## `time_frozen_data`

Submodule containing `TimeFrozenData`.

class lihzahrd.terraria.world.journey.time_frozen_data.TimeFrozenData(frozen: bool)

  Data about the Freeze Time power.

  frozen: bool

    Whether time is currently frozen and cannot advance.

## `time_scale_data`

Submodule containing `TimeScaleData`.

class lihzahrd.terraria.world.journey.time_scale_data.TimeScaleData(scale: float)

  Data about the timescale setting.

  scale: float

    The speed at which time is currently flowing (`1.0`-`24.0`).

## `rain_frozen_data`

Submodule containing `RainFrozenData`.

class lihzahrd.terraria.world.journey.rain_frozen_data.RainFrozenData(frozen: bool)

  Data about the Freeze Rain power.

  frozen: bool

    Whether rain is currently frozen and cannot change.

## `wind_frozen_data`

Submodule containing `WindFrozenData`.

class lihzahrd.terraria.world.journey.wind_frozen_data.WindFrozenData(frozen: bool)

  Data about the Freeze Wind power.

  frozen: bool

    Whether wind is currently frozen and cannot change.

## `journey_difficulty_data`

Submodule containing `JourneyDifficultyData`.

class lihzahrd.terraria.world.journey.journey_difficulty_data.JourneyDifficultyData(multiplier: float)

  Data about the Journey mode difficulty setting.

  multiplier: float

    The difficulty multiplier.

## `spread_frozen_data`

Submodule containing `SpreadFrozenData`.

class lihzahrd.terraria.world.journey.spread_frozen_data.SpreadFrozenData(frozen: bool)

  Data about the Freeze Infection Spread power.

  frozen: bool

    Whether infection is currently frozen and cannot happen.