Class CompassObjectType

Object type that can be displayed on the compass.

Inheritance

System.Object

CompassObjectType

Namespace: Phoenix.Controls.Compass

Assembly: Phoenix.Controls.Compass.dll

Syntax

public class CompassObjectType : BindableBase

Constructors

CompassObjectType(CompassObjectInfo, Nullable<Color>, Boolean, Boolean)

Initializes a new instance of the CompassObjectType class.

Declaration

public CompassObjectType(CompassObjectInfo objectInfo, Color? objectTypeColor, bool enabled = false, bool isInternalObject = false)

Parameters

Type	Name	Description
CompassObjectInfo	objectInfo	The data object that holds information on the type, compass source and id.
System.Nullable<System.Windows.Media.Color>	objectTypeColor	The color to use for objects of this type.
System.Boolean	enabled	Indicating whether objects of this type are currently displayed on the compass.
System.Boolean	isInternalObject	Indicating whether this type is from the compass's internal game state source or from an external source (Ex. Recommendation).

Properties

Enabled

Gets or sets a value indicating whether objects of this type are currently displayed on the compass.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

IsGameStateObject

Gets a value indicating whether this type is from the game state or from another source (Ex. Recommendation).

Declaration

public bool IsGameStateObject { get; }

Property Value

Type	Description
System.Boolean

ObjectColor

Gets or sets the color to use for objects of this type.

Declaration

public Color ObjectColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Color

ObjectInfo

Gets the data object that contains information about this object's type, its compass source and its unique Id.

Declaration

public CompassObjectInfo ObjectInfo { get; }

Property Value

Type	Description
CompassObjectInfo

RefreshRate

Gets the object types actual refresh rate based on the refresh string and the time span type. Used in xaml.

Declaration

public object RefreshRate { get; }

Property Value

Type	Description
System.Object

RefreshRateString

Gets or sets the current the string representing the refresh rate. Used in xaml.

Declaration

public string RefreshRateString { get; set; }

Property Value

Type	Description
System.String

RefreshRateType

Gets or sets the current time span type the player's refresh rate is using. Used in xaml.

Declaration

public TimeSpanType RefreshRateType { get; set; }

Property Value

Type	Description
TimeSpanType

Methods

ToString()

Returns a System.String that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents this instance.