Hydrogen.Peripherals.Input Class Reference

Inheritance diagram for Hydrogen.Peripherals.Input:

Public Member Functions
bool	AddAction (String name, InputAction action)
bool	RemoveAction (String name, bool alsoRemoveControls)
bool	AddControl (String controlName, String actionName)
void	RemoveControl (String controlName)
void	ClearControls ()
	Clears all controls. More...
List< KeyValuePair< string, string > >	GetControls ()
	Gets the controls. More...
bool	SetControls (List< KeyValuePair< string, string >> controlScheme)
	Set the controls from a List<KeyValuePair<string, string>> More...

Protected Member Functions
virtual void	Awake ()
virtual void	Update ()

Detailed Description

Definition at line 47 of file Input.cs.

Member Function Documentation

bool Hydrogen.Peripherals.Input.AddAction	(	String	name,
		InputAction	action
	)

Definition at line 67 of file Input.cs.

                {
                        if (!_actions.ContainsKey (name)) {
                                _actions.Add (name, action);
                                return true;
                        }
                        return false;
                }

bool Hydrogen.Peripherals.Input.AddControl	(	String	controlName,
		String	actionName
	)

Definition at line 99 of file Input.cs.

                {
                        InputAction action;

                        if (!_actions.TryGetValue (actionName, out action)) {
                                return false;
                        }


                        InputControlBase control = InputControlBase.CreateControl (controlName, action);
                        control.ActionName = actionName;

                        if (control != null) {
                                _controls.Add (control);
                                return true;
                        }
                        return false;
                }

virtual void Hydrogen.Peripherals.Input.Awake ( )

protectedvirtual

Reimplemented in hInput.

Definition at line 52 of file Input.cs.

                {
                        if (_controls == null)
                                _controls = new List<InputControlBase> ();
                        if (_actions == null)
                                _actions = new Dictionary<String, InputAction> ();
                }

void Hydrogen.Peripherals.Input.ClearControls

(

)

Clears all controls.

Definition at line 136 of file Input.cs.

                {
                        _controls.Clear ();
                }

List<KeyValuePair<string, string> > Hydrogen.Peripherals.Input.GetControls

(

)

Gets the controls.

Returns

The controls as a ist<KeyValuePair<string, string>>

Definition at line 145 of file Input.cs.

                {
                        var controlList = new List<KeyValuePair<string, string>> ();

                        for (int x = 0; x < _controls.Count; x++) {
                                controlList.Add (new KeyValuePair<string, string> (_controls [x].ActionName, _controls [x].Name));
                        }

                        return controlList;
                }

bool Hydrogen.Peripherals.Input.RemoveAction	(	String	name,
		bool	alsoRemoveControls
	)

Definition at line 76 of file Input.cs.

                {
                        InputAction action;
                        if (_actions.TryGetValue (name, out action)) {
                                if (alsoRemoveControls) {
                                        bool hasMore = true;
                                        while (hasMore) {
                                                hasMore = false;
                                                foreach (InputControlBase control in _controls) {
                                                        if (control.Action == action) {
                                                                _controls.Remove (control);
                                                                hasMore = true;
                                                                break;
                                                        }
                                                }
                                        }
                                }
                                _actions.Remove (name);
                                return true;
                        }
                        return false;
                }

void Hydrogen.Peripherals.Input.RemoveControl

(

String

controlName

)

Definition at line 118 of file Input.cs.

                {
                        bool hasMore = true;
                        while (hasMore) {
                                hasMore = false;
                                foreach (InputControlBase control in _controls) {
                                        if (control.Name == controlName) {
                                                _controls.Remove (control);
                                                hasMore = true;
                                                break;
                                        }
                                }
                        }
                }

bool Hydrogen.Peripherals.Input.SetControls

(

List< KeyValuePair< string, string >>

controlScheme

)

Set the controls from a List<KeyValuePair<string, string>>

This is useful for loading saved settings, specifically using Hydrogen.Serialization.INI

Returns

true, if controls were set, false otherwise.

Parameters

controlScheme

Control Scheme.

Definition at line 164 of file Input.cs.

                {
                        bool check = true;

                        for (int x = 0; x < controlScheme.Count; x++) {
                                // Reverse because we're assuming this came from a serialized version of the config
                                check &= AddControl (controlScheme [x].Value, controlScheme [x].Key);
                        }

                        return check;
                }

virtual void Hydrogen.Peripherals.Input.Update ( )

protectedvirtual

Definition at line 60 of file Input.cs.

                {
                        foreach (InputControlBase control in _controls) {
                                control.Capture ();
                        }
                }