InControl API Reference
VersionInfo Struct Reference

Encapsulates a comparable version number. This version number generally conforms to the semantic version system. More...

Inheritance diagram for VersionInfo:

Public Member Functions

 VersionInfo (int major, int minor, int patch, int build)
 Initializes a new instance of the InControl.VersionInfo with given version components. More...
 
int CompareTo (VersionInfo other)
 Returns the sort order of the current instance compared to the specified object. More...
 
override bool Equals (object other)
 Determines whether the specified System.Object is equal to the current InControl.VersionInfo. More...
 
override int GetHashCode ()
 Serves as a hash function for a InControl.VersionInfo object. More...
 
override string ToString ()
 Returns a System.String that represents the current InControl.VersionInfo. More...
 
string ToShortString ()
 Returns a shorter System.String that represents the current InControl.VersionInfo. More...
 

Static Public Member Functions

static VersionInfo InControlVersion ()
 Initialize an instance of InControl.VersionInfo with the current version of InControl. More...
 
static VersionInfo UnityVersion ()
 Initialize an instance of InControl.VersionInfo with the current version of Unity. More...
 
static bool operator== (VersionInfo a, VersionInfo b)
 Compares two instances of InControl.VersionInfo for equality. More...
 
static bool operator!= (VersionInfo a, VersionInfo b)
 Compares two instances of InControl.VersionInfo for inequality. More...
 
static bool operator<= (VersionInfo a, VersionInfo b)
 Compares two instances of InControl.VersionInfo to see if the first is equal to or smaller than the second. More...
 
static bool operator>= (VersionInfo a, VersionInfo b)
 Compares two instances of InControl.VersionInfo to see if the first is equal to or larger than the second. More...
 
static bool operator< (VersionInfo a, VersionInfo b)
 Compares two instances of InControl.VersionInfo to see if the first is smaller than the second. More...
 
static bool operator> (VersionInfo a, VersionInfo b)
 Compares two instances of InControl.VersionInfo to see if the first is larger than the second. More...
 

Public Attributes

int major
 The major version component. This number changes when significant API changes are made. More...
 
int minor
 The minor version component. This number changes when significant functionality is added in a mostly backwards-compatible manner. More...
 
int patch
 The patch version component. This number is changed when small updates and fixes are added in a backwards-compatible manner. More...
 
int build
 The build version component. This number is incremented during development. More...
 

Properties

static VersionInfo Min ^(\d+)\.(\d+)\.(\d+)[a-zA-Z](\d+)" [get]
 Generates the minimum possible version number. More...
 
static VersionInfo Max [get]
 Generates the maximum possible version number. More...
 
VersionInfo Next [get]
 Generates the next build version. More...
 
int Build [get]
 The build version component. This number is incremented during development. More...
 

Detailed Description

Encapsulates a comparable version number. This version number generally conforms to the semantic version system.

Constructor & Destructor Documentation

◆ VersionInfo()

VersionInfo ( int  major,
int  minor,
int  patch,
int  build 
)

Initializes a new instance of the InControl.VersionInfo with given version components.

Parameters
majorThe major version component.
minorThe minor version component.
patchThe patch version component.
buildThe build version component.

Member Function Documentation

◆ CompareTo()

int CompareTo ( VersionInfo  other)

Returns the sort order of the current instance compared to the specified object.

◆ Equals()

override bool Equals ( object  other)

Determines whether the specified System.Object is equal to the current InControl.VersionInfo.

Parameters
otherThe System.Object to compare with the current InControl.VersionInfo.
Returns
true if the specified System.Object is equal to the current InControl.VersionInfo; otherwise, false.

◆ GetHashCode()

override int GetHashCode ( )

Serves as a hash function for a InControl.VersionInfo object.

Returns
A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.

◆ InControlVersion()

static VersionInfo InControlVersion ( )
static

Initialize an instance of InControl.VersionInfo with the current version of InControl.

Returns
The current version of InControl.

◆ operator!=()

static bool operator!= ( VersionInfo  a,
VersionInfo  b 
)
static

Compares two instances of InControl.VersionInfo for inequality.

◆ operator<()

static bool operator< ( VersionInfo  a,
VersionInfo  b 
)
static

Compares two instances of InControl.VersionInfo to see if the first is smaller than the second.

◆ operator<=()

static bool operator<= ( VersionInfo  a,
VersionInfo  b 
)
static

Compares two instances of InControl.VersionInfo to see if the first is equal to or smaller than the second.

◆ operator==()

static bool operator== ( VersionInfo  a,
VersionInfo  b 
)
static

Compares two instances of InControl.VersionInfo for equality.

◆ operator>()

static bool operator> ( VersionInfo  a,
VersionInfo  b 
)
static

Compares two instances of InControl.VersionInfo to see if the first is larger than the second.

◆ operator>=()

static bool operator>= ( VersionInfo  a,
VersionInfo  b 
)
static

Compares two instances of InControl.VersionInfo to see if the first is equal to or larger than the second.

◆ ToShortString()

string ToShortString ( )

Returns a shorter System.String that represents the current InControl.VersionInfo.

Returns
A shorter System.String that represents the current InControl.VersionInfo.

◆ ToString()

override string ToString ( )

Returns a System.String that represents the current InControl.VersionInfo.

Returns
A System.String that represents the current InControl.VersionInfo.

◆ UnityVersion()

static VersionInfo UnityVersion ( )
static

Initialize an instance of InControl.VersionInfo with the current version of Unity.

Returns
The current version of Unity.

Member Data Documentation

◆ build

int build

The build version component. This number is incremented during development.

◆ major

int major

The major version component. This number changes when significant API changes are made.

◆ minor

int minor

The minor version component. This number changes when significant functionality is added in a mostly backwards-compatible manner.

◆ patch

int patch

The patch version component. This number is changed when small updates and fixes are added in a backwards-compatible manner.

Property Documentation

◆ Build

int Build
get

The build version component. This number is incremented during development.

◆ Max

VersionInfo Max
staticget

Generates the maximum possible version number.

◆ Min

VersionInfo Min ^(\d+)\.(\d+)\.(\d+)[a-zA-Z](\d+)"
staticget

Generates the minimum possible version number.

◆ Next

VersionInfo Next
get

Generates the next build version.


The documentation for this struct was generated from the following file: