/*
 * EventCodes.cs
 * Authors:
 * Copyright (c) 2007-2008 Cornell University

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

namespace StellarProspector
{
	/// <summary>
	/// Code listings of all the events that occur in Stellar Prospector
	/// </summary>
	public enum EventCodes
	{
		#region Key Codes

		/// <summary>
		/// Event that occurs whenever the key corresponding to a response to a peripheral stimulus is pressed
		/// </summary>
		PeripheralStimulusResponsePressed = 1,

		/// <summary>
		/// Event that occurs whenever the key corresponding to a response to a central stimulus is pressed
		/// </summary>
		CentralStimulusResponsePressed = 2,

		/// <summary>
		/// Event that occurs whenever the key for pausing is pressed when unpaused
		/// </summary>
		Pause = 3,

		/// <summary>
		/// Event that occurs whenever the key for unpausing is pressed when paused
		/// </summary>
		Resume = 4,

		/// <summary>
		/// Event that occurs whenever the key for moving the selection cursor up is pressed when in a menu
		/// </summary>
		Menu_Up = 5,

		/// <summary>
		/// Event that occurs whenever the key for moving the selection cursor down is pressed when in a menu
		/// </summary>
		Menu_Down = 6,

		/// <summary>
		/// Event that occurs whenever the key for selecting is pressed when in a menu
		/// </summary>
		Menu_Select = 7,

		/// <summary>
		/// Event that occurs whenever the key for exiting the menu is pressed when in a menu
		/// </summary>
		Menu_Cancel = 8,

		#endregion

		#region Progress codes

		/// <summary>
		/// Event that occurs whenever phase one of stellar prospector begins
		/// </summary>
        Phase1Begin = 9,

		/// <summary>
		/// Event that occurs whenever phase two of stellar prospector begins
		/// </summary>
        Phase2Begin = 10,

		/// <summary>
		/// Event that occurs whenever phase three of stellar prospector begins
		/// </summary>
        Phase3Begin = 11,

		/// <summary>
		/// Event that occurs whenever stellar prospector ends
		/// </summary>
        GameEnd = 12,

		#endregion

		#region Gameplay codes

		/// <summary>
		/// Event that occurs whenever a peripheral stimulus spawns
		/// </summary>
        PeripheralStimulusSpawn = 13,

		/// <summary>
		/// Event that occurs whenever a central stimulus spawns
		/// </summary>
		CentralStimulusSpawn = 14,

		/// <summary>
		/// Event that occurs whenever a distractor spawns
		/// </summary>
		DistractorSpawn = 15,

		/// <summary>
		/// Event that occurs whenever the early detection cue changes
		/// </summary>
		CueChange = 16,

		/// <summary>
		/// Event that occurs whenever a peripheral stimulus dissappears from a lack of response
		/// </summary>
		MissedPeripheralStimulus = 17,

		/// <summary>
		/// Event that occurs whenever a central stimulus dissappears from a lack of response
		/// </summary>
		MissedCentralStimulus = 18,

		/// <summary>
		/// Event that occurs whenever a distractor dissappears
		/// </summary>
		DistractorDisappear = 19,

		#endregion

		#region Tutorial codes

		/// <summary>
		/// Event that occurs whenever the tutorial mode starts
		/// </summary>
		TutorialStart = 20,

		/// <summary>
		/// Event that occurs whenever section one of the tutorial mode starts
		/// </summary>
		Section1 = 21,

		/// <summary>
		/// Event that occurs whenever section two of the tutorial mode starts
		/// </summary>
		Section2 = 22,

		/// <summary>
		/// Event that occurs whenever section three of the tutorial mode starts
		/// </summary>
		Section3 = 23,

		/// <summary>
		/// Event that occurs whenever section four of the tutorial mode starts
		/// </summary>
		Section4 = 24,

		/// <summary>
		/// Event that occurs whenever section five of the tutorial mode starts
		/// </summary>
		Section5 = 25,

		/// <summary>
		/// Event that occurs whenever section six of the tutorial mode starts
		/// </summary>
		Section6 = 26,

		/// <summary>
		/// Event that occurs whenever section seven of the tutorial mode starts
		/// </summary>
		Section7 = 27,

		/// <summary>
		/// Event that occurs whenever section eight of the tutorial mode starts
		/// </summary>
		Section8 = 28,

		/// <summary>
		/// Event that occurs whenever section nine of the tutorial mode starts
		/// </summary>
		Section9 = 29,

		/// <summary>
		/// Event that occurs whenever section ten of the tutorial mode starts
		/// </summary>
		Section10 = 30,

		/// <summary>
		/// Event that occurs whenever section eleven of the tutorial mode starts
		/// </summary>
		Section11 = 31,

		/// <summary>
		/// Event that occurs whenever section tweleve of the tutorial mode starts
		/// </summary>
		Section12 = 32,

		/// <summary>
		/// Event that occurs whenever section thirteen of the tutorial mode starts
		/// </summary>
		Section13 = 33,

		/// <summary>
		/// Event that occurs whenever section fourteen of the tutorial mode starts
		/// </summary>
		Section14 = 34,

		/// <summary>
		/// Event that occurs whenever section fifteen of the tutorial mode starts
		/// </summary>
		Section15 = 35,

		/// <summary>
		/// Event that occurs whenever section sixteen of the tutorial mode starts
		/// </summary>
		Section16 = 36,

		/// <summary>
		/// Event that occurs whenever the tutorial mode ends
		/// </summary>
		TutorialEnd = 37,

		#endregion
	}
}