C# Class BF2Statistics.MedalData.Award

Represents an award found in the medal data file as an object
Inheritance: IAward
Mostra file Open project: BF2Statistics/ControlCenter Class Usage Examples

Protected Properties

Property Type Description
StrId string
Type int

Public Methods

Method Description
Award ( string AwardId, string StrId, string Type, Condition Condition ) : System

Class Constructor. Constructs a new award
Exists ( string AwardId ) : bool

Returns whether a specified award ID exists
GetBadgeLevel ( string BadgeId ) : BadgeLevel

Returns the badge level
GetCondition ( ) : Condition

Returns the awards conditions
GetName ( string AwardId ) : string

Returns the full string name of an award
GetType ( string AwardId ) : AwardType

Returns the Award type of an award.
IsSfAward ( string AwardId ) : bool

Indicates whether the award is a special forces award
RestoreDefaultConditions ( ) : void

Restores the condition of this award to the default (vanilla) state
SetCondition ( Condition C ) : void

Sets the Condition, or Condition list to earn the award
ToPython ( ) : string

Converts the medal data, and its conditions to python
ToString ( ) : string

Returns the name of the award
ToTree ( ) : TreeNode

Converts the medal's conditions to a TreeView
UndoConditionChanges ( ) : void

Restores any changes made to the conditions of this award

Method Details

Award() public method

Class Constructor. Constructs a new award
public Award ( string AwardId, string StrId, string Type, Condition Condition ) : System
AwardId string The award id as a string
StrId string The short name of the award
Type string The award earn type. 0 = Purple heart, 1 = Earned only once per player, 2 = Earnable multiple times
Condition Condition The condition to earn this award
return System

Exists() public static method

Returns whether a specified award ID exists
public static Exists ( string AwardId ) : bool
AwardId string The Award ID
return bool

GetBadgeLevel() public static method

Returns the badge level
public static GetBadgeLevel ( string BadgeId ) : BadgeLevel
BadgeId string The award ID
return BadgeLevel

GetCondition() public method

Returns the awards conditions
public GetCondition ( ) : Condition
return Condition

GetName() public static method

Returns the full string name of an award
public static GetName ( string AwardId ) : string
AwardId string The award ID
return string

GetType() public static method

Returns the Award type of an award.
public static GetType ( string AwardId ) : AwardType
AwardId string The award ID
return AwardType

IsSfAward() public static method

Indicates whether the award is a special forces award
public static IsSfAward ( string AwardId ) : bool
AwardId string
return bool

RestoreDefaultConditions() public method

Restores the condition of this award to the default (vanilla) state
public RestoreDefaultConditions ( ) : void
return void

SetCondition() public method

Sets the Condition, or Condition list to earn the award
public SetCondition ( Condition C ) : void
C Condition The condition or condition list
return void

ToPython() public method

Converts the medal data, and its conditions to python
public ToPython ( ) : string
return string

ToString() public method

Returns the name of the award
public ToString ( ) : string
return string

ToTree() public method

Converts the medal's conditions to a TreeView
public ToTree ( ) : TreeNode
return System.Windows.Forms.TreeNode

UndoConditionChanges() public method

Restores any changes made to the conditions of this award
public UndoConditionChanges ( ) : void
return void

Property Details

StrId protected_oe property

The string ID of the award
protected string StrId
return string

Type protected_oe property

The award earn type
protected int Type
return int