Class VehicleSetupEntry

Namespace

LibreRally.Vehicle

Assembly

LibreRally.dll

Describes a single editable setup field exposed to the garage UI.

public sealed record VehicleSetupEntry : IEquatable<VehicleSetupEntry>

Inheritance

object

VehicleSetupEntry

Implements

IEquatable<VehicleSetupEntry>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

VehicleSetupEntry(string, string, string, string, string, string?, float, float, float, float, float, string, float?, float?, VehicleSetupApplyMode, VehicleSetupEntryKind, VehicleSetupAxle)

Describes a single editable setup field exposed to the garage UI.

public VehicleSetupEntry(string Id, string ResolvedKey, string Label, string Description, string Category, string? SubCategory, float Value, float DefaultValue, float MinimumValue, float MaximumValue, float Step, string Unit, float? MinDisplayValue, float? MaxDisplayValue, VehicleSetupApplyMode ApplyMode, VehicleSetupEntryKind Kind, VehicleSetupAxle Axle)

Parameters

Id string

Stable identifier for the entry.

ResolvedKey string

Resolved variable or override key used at apply time.

Label string

Display label shown in the UI.

Description string

Long-form field description.

Category string

Top-level setup category name.

SubCategory string

Optional subcategory used for sorting or grouping.

Value float

Current setting presented to the player.

DefaultValue float

Original default setting from the vehicle definition.

MinimumValue float

Lowest allowed numeric setting.

MaximumValue float

Highest allowed numeric setting.

Step float

Recommended edit step size.

Unit string

Display unit text.

MinDisplayValue float?

Optional alternate minimum shown in the UI.

MaxDisplayValue float?

Optional alternate maximum shown in the UI.

ApplyMode VehicleSetupApplyMode

How the entry is applied to the vehicle.

Kind VehicleSetupEntryKind

Underlying entry type.

Axle VehicleSetupAxle

Associated axle when the entry is axle-specific.

Properties

ApplyMode

How the entry is applied to the vehicle.

public VehicleSetupApplyMode ApplyMode { get; init; }

Property Value

VehicleSetupApplyMode

Axle

Associated axle when the entry is axle-specific.

public VehicleSetupAxle Axle { get; init; }

Property Value

VehicleSetupAxle

Category

Top-level setup category name.

public string Category { get; init; }

Property Value

string

DefaultValue

Original default setting from the vehicle definition.

public float DefaultValue { get; init; }

Property Value

float

Description

Long-form field description.

public string Description { get; init; }

Property Value

string

Id

Stable identifier for the entry.

public string Id { get; init; }

Property Value

string

Kind

Underlying entry type.

public VehicleSetupEntryKind Kind { get; init; }

Property Value

VehicleSetupEntryKind

Label

Display label shown in the UI.

public string Label { get; init; }

Property Value

string

MaxDisplayValue

Optional alternate maximum shown in the UI.

public float? MaxDisplayValue { get; init; }

Property Value

float?

MaximumValue

Highest allowed numeric setting.

public float MaximumValue { get; init; }

Property Value

float

MinDisplayValue

Optional alternate minimum shown in the UI.

public float? MinDisplayValue { get; init; }

Property Value

float?

MinimumValue

Lowest allowed numeric setting.

public float MinimumValue { get; init; }

Property Value

float

ResolvedKey

Resolved variable or override key used at apply time.

public string ResolvedKey { get; init; }

Property Value

string

Step

Recommended edit step size.

public float Step { get; init; }

Property Value

float

SubCategory

Optional subcategory used for sorting or grouping.

public string? SubCategory { get; init; }

Property Value

string

Unit

Display unit text.

public string Unit { get; init; }

Property Value

string

Value

Current setting presented to the player.

public float Value { get; init; }

Property Value

float