Version Class Reference

#include <version.h>

Public Member Functions
	Version ()
UnsignedInt	getVersionNumber (void)
	Return a 4-byte integer suitable for WOLAPI.
AsciiString	getAsciiVersion (void)
	Return a human-readable version number.
UnicodeString	getUnicodeVersion (void)
	Return a human-readable version number.
UnicodeString	getFullUnicodeVersion (void)
	Return a human-readable version number.
AsciiString	getAsciiBuildTime (void)
	Return a formated date/time string for build time.
UnicodeString	getUnicodeBuildTime (void)
	Return a formated date/time string for build time.
AsciiString	getAsciiBuildLocation (void)
	Return a string with the build location.
UnicodeString	getUnicodeBuildLocation (void)
	Return a string with the build location.
AsciiString	getAsciiBuildUser (void)
	Return a string with the build user.
UnicodeString	getUnicodeBuildUser (void)
	Return a string with the build user.
Bool	showFullVersion (void)
void	setShowFullVersion (Bool val)
void	setVersion (Int major, Int minor, Int buildNum, Int localBuildNum, AsciiString user, AsciiString location, AsciiString buildTime, AsciiString buildDate)
	Set version info.

Detailed Description

The Version class formats the version number into integer and string values for different parts of the game.

Todo

: increment build number on compile, and stamp exe with username

Definition at line 39 of file version.h.

Constructor & Destructor Documentation

Version()

Version::Version

(

)

Definition at line 36 of file version.cpp.

Member Function Documentation

getAsciiBuildLocation()

AsciiString Version::getAsciiBuildLocation

(

void

)

Return a string with the build location.

Definition at line 153 of file version.cpp.

getAsciiBuildTime()

AsciiString Version::getAsciiBuildTime

(

void

)

Return a formated date/time string for build time.

Definition at line 132 of file version.cpp.

getAsciiBuildUser()

AsciiString Version::getAsciiBuildUser

(

void

)

Return a string with the build user.

Definition at line 169 of file version.cpp.

getAsciiVersion()

AsciiString Version::getAsciiVersion

(

void

)

Return a human-readable version number.

Definition at line 70 of file version.cpp.

getFullUnicodeVersion()

UnicodeString Version::getFullUnicodeVersion

(

void

)

Return a human-readable version number.

Definition at line 111 of file version.cpp.

getUnicodeBuildLocation()

UnicodeString Version::getUnicodeBuildLocation

(

void

)

Return a string with the build location.

Definition at line 158 of file version.cpp.

getUnicodeBuildTime()

UnicodeString Version::getUnicodeBuildTime

(

void

)

Return a formated date/time string for build time.

Definition at line 140 of file version.cpp.

getUnicodeBuildUser()

UnicodeString Version::getUnicodeBuildUser

(

void

)

Return a string with the build user.

Definition at line 174 of file version.cpp.

getUnicodeVersion()

UnicodeString Version::getUnicodeVersion

(

void

)

Return a human-readable version number.

Definition at line 86 of file version.cpp.

getVersionNumber()

UnsignedInt Version::getVersionNumber

(

void

)

Return a 4-byte integer suitable for WOLAPI.

Definition at line 65 of file version.cpp.

setShowFullVersion()

void Version::setShowFullVersion ( Bool val )

inline

Definition at line 55 of file version.h.

setVersion()

void Version::setVersion	(	Int	major,
		Int	minor,
		Int	buildNum,
		Int	localBuildNum,
		AsciiString	user,
		AsciiString	location,
		AsciiString	buildTime,
		AsciiString	buildDate )

Set version info.

Definition at line 51 of file version.cpp.

showFullVersion()

Bool Version::showFullVersion ( void )

inline

Definition at line 54 of file version.h.

---

The documentation for this class was generated from the following files:

• Code/GameEngine/Include/Common/version.h
• Code/GameEngine/Source/Common/version.cpp