C# Class BF2Statistics.MedalData.AwardCache

The Award cache class is responsible for holding all the found awards and ranks from the Medal data file.
Show file Open project: BF2Statistics/ControlCenter Class Usage Examples

Public Methods

Method Description
AddAward ( Award A ) : void

Used by the parser to add found awards to the list

AddDefaultAwardCondition ( string Id, Condition C ) : void

Used by the Medal data parser to add the original award conditions

AddRank ( Rank A ) : void

Used by the parser to add found ranks to the list

Clear ( ) : void

Clears all awards. Usually only called when the MedalData file changes.

GetAward ( string Id ) : IAward

This method is used to fetch a particular Award or rank by ID

GetBadges ( ) : IEnumerable

Returns all found badges

GetDefaultAwardCondition ( string Id ) : Condition

Returns the original (vanilla) condition list to earn the specified award

GetMedals ( ) : IEnumerable

Returns all found Medals

GetRanks ( ) : IEnumerable

Returns all found ranks

GetRibbons ( ) : IEnumerable

Returns all found ribbons

Method Details

AddAward() public static method

Used by the parser to add found awards to the list
public static AddAward ( Award A ) : void
A Award The Award Object To Add
return void

AddDefaultAwardCondition() public static method

Used by the Medal data parser to add the original award conditions
public static AddDefaultAwardCondition ( string Id, Condition C ) : void
Id string The Award ID found in the Medal Data file
C Condition The parsed condition to earn the award
return void

AddRank() public static method

Used by the parser to add found ranks to the list
public static AddRank ( Rank A ) : void
A Rank The Rank Object To Add
return void

Clear() public static method

Clears all awards. Usually only called when the MedalData file changes.
public static Clear ( ) : void
return void

GetAward() public static method

This method is used to fetch a particular Award or rank by ID
public static GetAward ( string Id ) : IAward
Id string The Award ID
return IAward

GetBadges() public static method

Returns all found badges
public static GetBadges ( ) : IEnumerable
return IEnumerable

GetDefaultAwardCondition() public static method

Returns the original (vanilla) condition list to earn the specified award
public static GetDefaultAwardCondition ( string Id ) : Condition
Id string The award's ID
return Condition

GetMedals() public static method

Returns all found Medals
public static GetMedals ( ) : IEnumerable
return IEnumerable

GetRanks() public static method

Returns all found ranks
public static GetRanks ( ) : IEnumerable
return IEnumerable

GetRibbons() public static method

Returns all found ribbons
public static GetRibbons ( ) : IEnumerable
return IEnumerable