C#Code
C#Code
Public Member Functions | Public Attributes | Static Public Attributes | Properties | Static Private Attributes
TheForum.GameCode.Mapping.KeyboardMapping Class Reference

List of all members.

Public Member Functions

 KeyboardMapping ()
KeyboardMapping GetMemberwiseClone ()
Object Clone ()
void Copy (KeyboardMapping mappingToCopy)
void SetWithDefaults ()
void SaveToFile ()

Public Attributes

Keys m_postMessage
 What keys trigger the game keyboard messages.
Keys m_swapPieces
Keys m_refreshPageMessage
Keys m_moveLeft
Keys m_moveRight
Keys m_moveUp
Keys m_moveDown
Keys m_speedUpMovement

Static Public Attributes

static Keys s_postMessage = Settings.DefaultInputSettings.s_defaultPostMessageKey
static Keys s_swapPieces = Settings.DefaultInputSettings.s_defaultSwapPiecesKey
static Keys s_refreshPageMessage = Settings.DefaultInputSettings.s_defaultRefreshPageKey
static Keys s_moveLeft = Settings.DefaultInputSettings.s_keyboardMoveLeftKey
static Keys s_moveRight = Settings.DefaultInputSettings.s_keyboardMoveRightKey
static Keys s_moveUp = Settings.DefaultInputSettings.s_keyboardMoveUpKey
static Keys s_moveDown = Settings.DefaultInputSettings.s_keyboardMoveDownKey

Properties

static KeyboardMapping Instance [get]

Static Private Attributes

static readonly
Libraries.StringType 
s_saveFolder = new Libraries.StringType("Controls")
 Folder to save keyboard mapping to.
static readonly
Libraries.StringType 
s_saveName = new Libraries.StringType("KeyboardControls.xml")
 Keyboard mapping file name.
static KeyboardMapping s_instance
 Singleton instance for the class. This should contain the current configuration.

Detailed Description

Used to store the mapping for keyboard keys and game actions. This will be serialized for save data, and stored in a xml file. Do not add anything to it that should not be serialized.

Used to store the mapping for keyboard keys and game actions.


Constructor & Destructor Documentation

TheForum.GameCode.Mapping.KeyboardMapping.KeyboardMapping ( )

Default constructor.


Member Function Documentation

Object TheForum.GameCode.Mapping.KeyboardMapping.Clone ( )

Create a memberwise clone of the keyboard mapping.

void TheForum.GameCode.Mapping.KeyboardMapping.Copy ( KeyboardMapping  mappingToCopy)

Copy the values from the given mapping.

mappingToCopy - Values to copy.
KeyboardMapping TheForum.GameCode.Mapping.KeyboardMapping.GetMemberwiseClone ( )

Create a memberwise clone of the keyboard mapping.

void TheForum.GameCode.Mapping.KeyboardMapping.SaveToFile ( )

Saves the keyboard configuration values used to file.

void TheForum.GameCode.Mapping.KeyboardMapping.SetWithDefaults ( )

Load the default key values to use.


Member Data Documentation

What keys trigger the game keyboard messages.

Singleton instance for the class. This should contain the current configuration.

Folder to save keyboard mapping to.

Keyboard mapping file name.


Property Documentation

KeyboardMapping TheForum.GameCode.Mapping.KeyboardMapping.Instance [static, get]

Gets the singleton instance of mapping. Loads from file if possible. If not possible, the default values are loaded, the file is created, and a exception is thrown.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Properties