Skip to content

Game.UI.InGame.VehicleStateLocaleKey

Assembly: Game
Namespace: Game.UI.InGame

Type: enum

Base: System.Enum

Summary:
Enumeration of vehicle state identifiers used by the in-game UI for localization. Each enum value corresponds to a named vehicle status (for example, "Boarding" or "Extinguishing") that the UI can map to a localized string shown to the player. This enum is intended to be used as the key or part of a key when looking up localized text for vehicle states.

Fields

  • Evacuating
    Vehicle is evacuating (moving people away from danger).

  • Boarding
    Passengers are boarding the vehicle.

  • Parked
    Vehicle is parked / idle.

  • AccidentSite
    Vehicle is at an accident site.

  • CrimeScene
    Vehicle is at a crime scene.

  • Patrolling
    Vehicle is patrolling an area.

  • Working
    Vehicle is performing its work duty (generic working state).

  • Collecting
    Vehicle is collecting goods/resources/trash.

  • Extinguishing
    Vehicle (fire engine) is extinguishing a fire.

  • Rescuing
    Vehicle is rescuing citizens (e.g., ambulance).

  • Dispatched
    Vehicle has been dispatched to a task but not yet arrived.

  • Transporting
    Vehicle is transporting passengers or goods.

  • Buying
    Vehicle is performing a buying action (e.g., purchasing supplies).

  • Exporting
    Vehicle is involved in exporting goods.

  • Importing
    Vehicle is involved in importing goods.

  • Delivering
    Vehicle is delivering goods or passengers.

  • Conveying
    Vehicle is conveying items (similar to transporting).

  • Gathering
    Vehicle is gathering resources.

  • Returning
    Vehicle is returning to base/garage/starting point.

  • Loading
    Vehicle is loading cargo or passengers.

  • EnRoute
    Vehicle is en route to a destination.

  • Disembarking
    Passengers are leaving the vehicle.

  • InvolvedInAccident
    Vehicle has been involved in an accident.

  • Fishing
    Vehicle (boat) is performing fishing activities.

  • Farming
    Vehicle is performing farming duties.

  • Harvesting
    Vehicle is harvesting crops/resources.

  • Drilling
    Vehicle is drilling (e.g., oil/gas rigs or drills).

  • Mining
    Vehicle is performing mining operations.

  • Extracting
    Vehicle is extracting resources (generic extraction).

  • Unknown
    Fallback state when the vehicle state is not recognized.

Properties

  • None.
    This type is a plain enum and does not define properties.

Constructors

  • None (implicit).
    Enums do not define explicit constructors; values are used directly.

Methods

  • None.
    No methods are defined on this enum type.

Usage Example

// Example: map enum to a localization key and fetch localized text.
// The exact localization API in Cities: Skylines 2 may differ; adjust to the project's localization helper.

VehicleStateLocaleKey state = VehicleStateLocaleKey.Extinguishing;

// Common pattern: construct a localization identifier from a prefix and enum name.
string localeId = $"VEHICLE_STATE.{state}";

// Example call to a hypothetical localization API:
string displayText = Locale.Get(localeId); // Replace Locale.Get with the actual localization call

// Result: displayText now holds the localized string for VEHICLE_STATE.Extinguishing

{{ Additional notes for modders: - Use the enum values as stable identifiers when adding or replacing UI text for vehicle states. - Check the game's existing locale key naming conventions (prefixes, separators) before constructing keys — the example uses "VEHICLE_STATE.{Name}" as a common pattern but your project may use a different prefix or format. - When creating new UI elements that show vehicle state, prefer using these enum values (or a mapping) rather than hard-coded strings to keep localization maintainable. }}