Commented research events

This commit is contained in:
Aaron Moser
2023-07-23 11:42:06 +02:00
parent efa9ffef89
commit 6f2a7d7226
2 changed files with 43 additions and 3 deletions

View File

@@ -1,8 +1,16 @@
/**
* @file
*
* @author Marc de Craigher
* @author Aaron Moser
*
* @package Assets.Scripts.Research.Events
*/
namespace NResearch
{
/// <summary>
/// Enum for any event conected to research.
/// </summary>
/**
* Enum for any event connected to research.
*/
public enum EResearchEvent
{
AddIndustryTechToQueue,

View File

@@ -1,12 +1,44 @@
/**
* @file
*
* @author Aaron Moser
*
* @package Assets.Scripts.Research.Events
*/
namespace NResearch
{
/**
* @section DESCRIPTION
*
* Class is a container for additional arguments for research events.
*/
public class ResearchEventArgs
{
//---------------------------------------------------------------------------------------------------------------------------------------------------------------------
// Public values
/**
* Event type indicated by enum value.
*/
public EResearchEvent eResearchEvent { get; set; }
//---------------------------------------------------------------------------------------------------------------------------------------------------------------------
// Private values
//---------------------------------------------------------------------------------------------------------------------------------------------------------------------
// Public functions
/**
* Constructor sets enum value research event to overhanded value.
*
* @param eResearchEvent, event type occured.
*/
public ResearchEventArgs(EResearchEvent eResearchEvent)
{
this.eResearchEvent = eResearchEvent;
}
//---------------------------------------------------------------------------------------------------------------------------------------------------------------------
// Private functions
}
}