Arcade
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
GameAPI.Highscore Class Reference

Represents a score attained by a player in an arcade game. More...

Inheritance diagram for GameAPI.Highscore:

Public Member Functions

 Highscore (string initials, int score)
 Constructs a new highscore using the specified 3 character initials and score. More...
 
 Highscore (string initials, int score, long data)
 Constructs a new highscore using the specified 3 character initials, score and auxiliary data. More...
 
 Highscore (string initials, int score, DateTime date, long data)
 Constructs a new highscore using the specified 3 character initials, score, time and auxiliary data. More...
 
int CompareTo (Highscore other)
 Compares this highscore to another. Returns 1 if the other score is larger, 0 if they are equal, and -1 otherwise. More...
 
override bool Equals (object obj)
 
bool Equals (Highscore other)
 Returns true if the given highscore has the same submission date, initials and score. More...
 
override int GetHashCode ()
 

Properties

string Initials [get]
 Three characters entered by the player to identify themselves. More...
 
int Score [get]
 Number of points recorded in this highscore. More...
 
DateTime Date [get]
 The date and time the Highscore was attained. More...
 
long Data [get]
 May optionally contain some additional data related to the Highscore. More...
 

Detailed Description

Represents a score attained by a player in an arcade game.

Constructor & Destructor Documentation

GameAPI.Highscore.Highscore ( string  initials,
int  score 
)
inline

Constructs a new highscore using the specified 3 character initials and score.

GameAPI.Highscore.Highscore ( string  initials,
int  score,
long  data 
)
inline

Constructs a new highscore using the specified 3 character initials, score and auxiliary data.

GameAPI.Highscore.Highscore ( string  initials,
int  score,
DateTime  date,
long  data 
)
inline

Constructs a new highscore using the specified 3 character initials, score, time and auxiliary data.

Member Function Documentation

int GameAPI.Highscore.CompareTo ( Highscore  other)
inline

Compares this highscore to another. Returns 1 if the other score is larger, 0 if they are equal, and -1 otherwise.

override bool GameAPI.Highscore.Equals ( object  obj)
inline
bool GameAPI.Highscore.Equals ( Highscore  other)
inline

Returns true if the given highscore has the same submission date, initials and score.

override int GameAPI.Highscore.GetHashCode ( )
inline

Property Documentation

long GameAPI.Highscore.Data
get

May optionally contain some additional data related to the Highscore.

DateTime GameAPI.Highscore.Date
get

The date and time the Highscore was attained.

string GameAPI.Highscore.Initials
get

Three characters entered by the player to identify themselves.

int GameAPI.Highscore.Score
get

Number of points recorded in this highscore.