Class CompassSettings

Compass settings.

Inheritance

System.Object

CompassSettings

Namespace: Phoenix.Controls.Compass

Assembly: Phoenix.Controls.Compass.dll

Syntax

[Serializable]
public class CompassSettings : SettingsCategoryBase

Constructors

CompassSettings()

Initializes a new instance of the CompassSettings class.

Declaration

public CompassSettings()

Properties

CanvasWidth

Gets the width of the canvas.

Declaration

public int CanvasWidth { get; }

Property Value

Type	Description
System.Int32

DueEastMarginValue

Gets or sets the due east margin value.

Declaration

public int DueEastMarginValue { get; set; }

Property Value

Type	Description
System.Int32

DueEastValue

Gets or sets the degrees for due east.

Declaration

public int DueEastValue { get; set; }

Property Value

Type	Description
System.Int32

GameStateDataUpdateRate

Gets or sets the update rate (ms) for checking for new game state data.

Declaration

public double GameStateDataUpdateRate { get; set; }

Property Value

Type	Description
System.Double

GameStateReconnectDelay

Gets or sets the delay (ms) between attempting to reconnect to a title.

Declaration

public double GameStateReconnectDelay { get; set; }

Property Value

Type	Description
System.Double

HeightBuffer

Gets or sets the buffer of Z units above or below a player that determines if the object is on the same plane as the player vs. above or below the player.

Declaration

public int HeightBuffer { get; set; }

Property Value

Type	Description
System.Int32

IndicatorMaxDistance

Gets or sets the maximum distance an object has to be before their indicator is the minimum size. The further the object, the smaller it appears until this distance is reached.

Declaration

public int IndicatorMaxDistance { get; set; }

Property Value

Type	Description
System.Int32

IndicatorMinDistance

Gets or sets the minimum distance an object has to be before their indicator is the maximum size. The closer the object, the larger it appears until this distance is reached.

Declaration

public int IndicatorMinDistance { get; set; }

Property Value

Type	Description
System.Int32

LengthScaleFactor

Gets or sets the scale factor for resizing the length of the compass canvas.

Declaration

public float LengthScaleFactor { get; set; }

Property Value

Type	Description
System.Single