Skip to content

Game.UI.PropertyNames

Assembly: Assembly-CSharp
Namespace: Game.UI

Type: public static class

Base: System.Object

Summary:
A centralized collection of constant string keys used by the UI system for property names and data bindings. These constants standardize the property keys used throughout UI components, JSON/data payloads, and binding layers to avoid hard-coded string literals and typos.

Fields

  • public const string kPets = "pets"
    Constant key for the "pets" property (e.g., number or list of pets).

  • public const string kResidents = "residents"
    Constant key for the "residents" property.

  • public const string kCount = "count"
    Constant key for numeric counts.

  • public const string kSelected = "selected"
    Key indicating selected state or selected item.

  • public const string kFamilyName = "familyName"
    Key for a family's name.

  • public const string kOccupants = "occupants"
    Key for occupants (people inside a building/household).

  • public const string kHouseholds = "households"
    Key for households collection.

  • public const string kResidence = "residence"
    Key referring to a residence entity.

  • public const string kHousehold = "household"
    Key for a single household.

  • public const string kId = "id"
    Generic identifier key.

  • public const string kEntity = "entity"
    Key for an entity reference.

  • public const string kName = "name"
    Key for a display or internal name.

  • public const string kType = "type"
    Key indicating a type or category.

  • public const string kIcon = "icon"
    Key for an icon identifier or path.

  • public const string kImage = "image"
    Key for an image resource.

  • public const string kOverrideImagePS = "overrideImagePS"
    Key to specify a PlayStation-specific override image.

  • public const string kOverrideImageXbox = "overrideImageXbox"
    Key to specify an Xbox-specific override image.

  • public const string kParent = "parent"
    Key for parent relationship.

  • public const string kChildren = "children"
    Key for child elements/collection.

  • public const string kLocked = "locked"
    Key indicating locked state.

  • public const string kPriority = "priority"
    Key for priority value.

  • public const string kActive = "active"
    Key indicating active state.

  • public const string kDisabled = "disabled"
    Key indicating disabled state.

  • public const string kEnabled = "enabled"
    Key indicating enabled state.

  • public const string kUITag = "uiTag"
    Key for UI tagging.

  • public const string kDirection = "direction"
    Key for direction (e.g., layout or orientation).

  • public const string kJustify = "justify"
    Key for justification settings.

  • public const string kAlignment = "alignment"
    Key for alignment settings.

  • public const string kRequirements = "requirements"
    Key for requirement lists or conditions.

  • public const string kData = "data"
    Generic key for data payloads.

  • public const string kValue = "value"
    Generic key for a value.

  • public const string kDefault = "default"
    Key for default values.

  • public const string kRange = "range"
    Key for range definitions.

  • public const string kStep = "step"
    Key for step increments.

  • public const string kUnit = "unit"
    Key for unit labels or units of measurement.

  • public const string kPages = "pages"
    Key for paged content count or list.

  • public const string kItems = "items"
    Key for collections of items.

  • public const string kTitle = "title"
    Key for a title string.

  • public const string kSubTitle = "subtitle"
    Key for a subtitle string.

  • public const string kParagraphs = "paragraphs"
    Key for paragraph collections (e.g., long text).

  • public const string kImages = "images"
    Key for collection of images.

  • public const string kDlc = "dlc"
    Key indicating DLC-related data.

  • public const string kWidth = "width"
    Key for width value.

  • public const string kHeight = "height"
    Key for height value.

  • public const string kAspectRatio = "aspectRatio"
    Key for aspect ratio value.

  • public const string kFocused = "focused"
    Key indicating focus state.

  • public const string kTutorials = "tutorials"
    Key for tutorials collection.

  • public const string kPhases = "phases"
    Key for phases (e.g., multi-step flows).

  • public const string kTrigger = "trigger"
    Key for a single trigger.

  • public const string kTriggers = "triggers"
    Key for multiple triggers.

  • public const string kShown = "shown"
    Key indicating whether something is shown.

  • public const string kHints = "hints"
    Key for hint entries.

  • public const string kIntro = "intro"
    Key for introduction content.

  • public const string kCompleted = "completed"
    Key indicating completed state.

  • public const string kPreCompleted = "preCompleted"
    Key indicating pre-completion state.

  • public const string kForcesCompletion = "forcesCompletion"
    Key that forces completion behavior.

  • public const string kMandatory = "mandatory"
    Key indicating mandatory requirement.

  • public const string kFilters = "filters"
    Key for filter collections.

  • public const string kAlternatives = "alternatives"
    Key for alternative options.

  • public const string kAdvisorActivation = "advisorActivation"
    Key for advisor activation settings.

  • public const string kDisplayUI = "displayUI"
    Key for toggling or targeting UI display.

  • public const string kIsBranch = "isBranch"
    Key indicating branch state in flows.

  • public const string kBlinkTags = "blinkTags"
    Key for blink/tagging behavior.

  • public const string kPhaseBranching = "phaseBranching"
    Key for phase branching configuration.

  • public const string kTitleVisible = "titleVisible"
    Key controlling title visibility.

  • public const string kDescriptionVisible = "descriptionVisible"
    Key controlling description visibility.

  • public const string kBalloonTargets = "balloonTargets"
    Key for balloon/tooltip target references.

  • public const string kForceAdvisor = "force"
    Key used to force advisor behavior (named "force" in payloads).

  • public const string KPolicies = "policies"
    Key for policies collection (note the constant name uses an uppercase K).

Properties

  • This static class exposes only constant fields and does not define any properties.

Constructors

  • Static classes cannot be instantiated; there are no constructors exposed.

Methods

  • This class provides no methods. It only defines constant string fields for use as UI property keys.

Usage Example

// Example usages of PropertyNames in UI code:

// Accessing a property key to read from a property bag/dictionary:
if (props.TryGetValue(PropertyNames.kResidents, out var residentsObj))
{
    int residents = Convert.ToInt32(residentsObj);
    // ...
}

// Setting a name property on a UI model:
uiModel.Set(PropertyNames.kName, "Main Street");

// Using keys when building JSON or payloads consumed by UI components:
var item = new Dictionary<string, object> {
    { PropertyNames.kId, 123 },
    { PropertyNames.kTitle, "Neighborhood Info" },
    { PropertyNames.KPolicies, new[] { "FreeParking", "Recycling" } }
};