Game.UI.InGame.CitizenResidenceKey

Assembly:
Assembly-CSharp (game code)

Namespace:
Game.UI.InGame

Type:
public enum

Base:
System.Enum

Summary:
Enumeration that represents the type of residence assigned to a citizen in the game's UI. Used to identify/display whether a citizen's residence is a regular home, a hotel, or a shelter. The values are suitable for UI decisions (icons, labels) and gameplay logic that depends on residence type.

---

Fields

• Home
  Represents a standard private residence/home. Underlying integer value: 0.

• Hotel
  Represents a commercial lodging (hotel). Underlying integer value: 1.

• Shelter
  Represents an emergency shelter or temporary lodging. Underlying integer value: 2.

Properties

• None
  This enum exposes no properties.

Constructors

• Default enum constructor (implicit)
  Enums use the default value construction provided by .NET. The underlying type is int and the defined members correspond to integer values 0..2 unless explicitly specified otherwise.

Methods

• None
  The enum does not declare methods. It inherits the standard System.Enum methods (ToString, HasFlag, etc.).

Usage Example

using Game.UI.InGame;

public void UpdateResidenceDisplay(CitizenResidenceKey residence)
{
    switch (residence)
    {
        case CitizenResidenceKey.Home:
            ShowIcon("icon_home");
            SetLabel("Home");
            break;
        case CitizenResidenceKey.Hotel:
            ShowIcon("icon_hotel");
            SetLabel("Hotel");
            break;
        case CitizenResidenceKey.Shelter:
            ShowIcon("icon_shelter");
            SetLabel("Shelter");
            break;
    }
}