Class Detail

Container class comprising mainly of:

A label DisplayName

A value IntValue or FloatValue or StringValue

(Optional) Unit

Inheritance

System.Object

Detail

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: GDA

Assembly: Assembly-CSharp.dll

Syntax

[Serializable]
public class Detail

Constructors

Detail()

Declaration

public Detail()

Detail(Detail)

Declaration

public Detail(Detail detail)

Parameters

Type	Name	Description
Detail	detail

Detail(UnitUtility.UnitType, Boolean, String, Int32)

Declaration

public Detail(UnitUtility.UnitType detailType, bool isShown, string name, int value)

Parameters

Type	Name	Description
UnitUtility.UnitType	detailType
System.Boolean	isShown
System.String	name
System.Int32	value

Detail(UnitUtility.UnitType, Boolean, String, Single)

Declaration

public Detail(UnitUtility.UnitType detailType, bool isShown, string name, float value)

Parameters

Type	Name	Description
UnitUtility.UnitType	detailType
System.Boolean	isShown
System.String	name
System.Single	value

Detail(UnitUtility.UnitType, Boolean, String, String)

Declaration

public Detail(UnitUtility.UnitType detailType, bool isShown, string name, string value)

Parameters

Type	Name	Description
UnitUtility.UnitType	detailType
System.Boolean	isShown
System.String	name
System.String	value

Fields

IS_SHOWN

Declaration

public const bool IS_SHOWN = true

Field Value

Type	Description
System.Boolean

isShown

Defines whether the detail should be displayed or hidden in the game.

Declaration

public bool isShown

Field Value

Type	Description
System.Boolean

Properties

DisplayName

The dislayed label of the Detail

Declaration

[JsonIgnore]
public string DisplayName { get; set; }

Property Value

Type	Description
System.String

FloatValue

Returns the value of a detail as a float if valueType is Interger or Float. Returns -1f otherwise.

Declaration

[JsonIgnore]
public float FloatValue { get; set; }

Property Value

Type	Description
System.Single

IntValue

Returns the value of a detail as a float if valueType is Interger or Float. Returns -1f otherwise.

Declaration

[JsonIgnore]
public int IntValue { get; set; }

Property Value

Type	Description
System.Int32

StringValue

Returns the value of the detail as a string.

Declaration

[JsonIgnore]
public string StringValue { get; set; }

Property Value

Type	Description
System.String

UnitType

enum defining the type of unit the value is in. UnitUtility.UnitType

Declaration

[JsonIgnore]
public UnitUtility.UnitType UnitType { get; set; }

Property Value

Type	Description
UnitUtility.UnitType

valueType

enum defining the type of value the Detail holds. ValueType

Declaration

[JsonIgnore]
public ValueType valueType { get; set; }

Property Value

Type	Description
ValueType

Methods

GetUnitString()

Declaration

public string GetUnitString()

Returns

Type	Description
System.String	Units of the value as a string

IsComparable(Detail)

Unused. For (unused) inspection mechanic.

Declaration

public bool IsComparable(Detail other)

Parameters

Type	Name	Description
Detail	other	Detail to compare with

Returns

Type	Description
System.Boolean	true if comparable, false otherwise

ValueToString()

Declaration

public string ValueToString()

Returns

Type	Description
System.String	Value of the Detail as a string