Skip to content

Game.UI.Widgets.Bounds3InputField

Assembly:
Assembly-CSharp (typical game assembly for Cities: Skylines 2; confirm against your build)

Namespace: Game.UI.Widgets

Type:
class

Base:
Field

Summary:
A UI field type for editing/representing a Colossal.Mathematics.Bounds3 value. Extends the generic Colossal UI Field for Bounds3 and exposes a single option property allowMinGreaterMax which controls whether the field accepts a minimum value that is greater than the maximum. When serializing its properties to JSON it writes that option via the provided IJsonWriter.

Fields

  • private bool <allowMinGreaterMax>k__BackingField
    Compiler-generated backing field for the public auto-property allowMinGreaterMax.

Properties

  • public bool allowMinGreaterMax { get; set; }
    When true, the input field allows the minimum bounds component(s) to be greater than the maximum bounds component(s). Defaults to false unless set. This value is emitted to JSON during WriteProperties so the UI system or saved layout can preserve the setting.

Constructors

  • public Bounds3InputField()
    Implicit default constructor. No custom construction logic provided in the class source.

Methods

  • protected override void WriteProperties(IJsonWriter writer) : System.Void
    Overrides Field.WriteProperties to serialize additional property data. Calls base.WriteProperties(writer) first, then writes a JSON property named "allowMinGreaterMax" with the current value of the allowMinGreaterMax property.

Example behavior: - Ensures the allowMinGreaterMax flag is included when the field's configuration is saved or streamed as JSON.

Usage Example

// Create the field and allow min > max
var boundsField = new Game.UI.Widgets.Bounds3InputField();
boundsField.allowMinGreaterMax = true;

// Typical placement or registration in your UI code depends on the UI framework in use.
// The WriteProperties method will include the setting when the UI system serializes the field.