Class BeamNgVehicleVariantDescriptor

Namespace

LibreRally.Vehicle.Content

Assembly

LibreRally.dll

Describes one selectable BeamNG Vehicle variant backed by an optional .pc configuration.

public sealed record BeamNgVehicleVariantDescriptor : IEquatable<BeamNgVehicleVariantDescriptor>

Inheritance

object

BeamNgVehicleVariantDescriptor

Implements

IEquatable<BeamNgVehicleVariantDescriptor>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BeamNgVehicleVariantDescriptor(BeamNgVehicleDescriptor, string?, string, string, string, string, string?, string?, bool)

Describes one selectable BeamNG Vehicle variant backed by an optional .pc configuration.

public BeamNgVehicleVariantDescriptor(BeamNgVehicleDescriptor Vehicle, string? ConfigFileName, string VariantId, string VehicleDisplayName, string VariantDisplayName, string Description, string? ThumbnailPath, string? ConfigType, bool IsDefaultVariant)

Parameters

Vehicle BeamNgVehicleDescriptor

The parent discovered BeamNG vehicle package.

ConfigFileName string

The configuration file name to load, or null for JBeam defaults.

VariantId string

Stable identifier for the variant within the package.

VehicleDisplayName string

The user-facing parent package name shown in menus.

VariantDisplayName string

User-facing variant/configuration name shown in menus.

Description string

Optional descriptive copy for the variant.

ThumbnailPath string

Absolute path to the preview thumbnail image when available.

ConfigType string

Optional classification such as Factory or Rally.

IsDefaultVariant bool

Indicates whether the variant matches the package default configuration.

Properties

ConfigFileName

The configuration file name to load, or null for JBeam defaults.

public string? ConfigFileName { get; init; }

Property Value

string

ConfigType

Optional classification such as Factory or Rally.

public string? ConfigType { get; init; }

Property Value

string

Description

Optional descriptive copy for the variant.

public string Description { get; init; }

Property Value

string

DisplayName

Gets a combined user-facing label for the vehicle and variant.

public string DisplayName { get; }

Property Value

string

IsDefaultVariant

Indicates whether the variant matches the package default configuration.

public bool IsDefaultVariant { get; init; }

Property Value

bool

SourceKind

Gets the origin of the parent package.

public BeamNgVehicleSourceKind SourceKind { get; }

Property Value

BeamNgVehicleSourceKind

SourceLabel

Gets the source label for the parent package.

public string SourceLabel { get; }

Property Value

string

SourcePath

Gets the directory or archive path that contains the parent package.

public string SourcePath { get; }

Property Value

string

ThumbnailPath

Absolute path to the preview thumbnail image when available.

public string? ThumbnailPath { get; init; }

Property Value

string

VariantDisplayName

User-facing variant/configuration name shown in menus.

public string VariantDisplayName { get; init; }

Property Value

string

VariantId

Stable identifier for the variant within the package.

public string VariantId { get; init; }

Property Value

string

Vehicle

The parent discovered BeamNG vehicle package.

public BeamNgVehicleDescriptor Vehicle { get; init; }

Property Value

BeamNgVehicleDescriptor

VehicleDisplayName

The user-facing parent package name shown in menus.

public string VehicleDisplayName { get; init; }

Property Value

string

VehicleId

Gets the BeamNG identifier for the parent package.

public string VehicleId { get; }

Property Value

string