Skip to content
Snippets Groups Projects
Commit bc1b8d7a authored by Trandinh Thien's avatar Trandinh Thien
Browse files

Added doxygen for Model, View, Controller. Also finished most of Unit.cs for doxygen

parent 17d27052
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Doc/MIS/Blaze_Brigade.XML 0 → 100644
+ 285
− 0
View file @ bc1b8d7a
<?xml version="1.0"?>
<doc>
<assembly>
<name>Blaze_Brigade</name>
</assembly>
<members>
<member name="T:Model.Archer">
<summary>
Archer class to be implemented
</summary>
</member>
<member name="T:Model.Unit">
<summary>
Unit Interface
Warrior, mage and archer will extend this interface
</summary>
</member>
<member name="F:Blaze_Brigade.CharInfoScreen.components">
<summary>
Required designer variable.
</summary>
</member>
<member name="M:Blaze_Brigade.CharInfoScreen.Dispose(System.Boolean)">
<summary>
Clean up any resources being used.
</summary>
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
</member>
<member name="M:Blaze_Brigade.CharInfoScreen.InitializeComponent">
<summary>
Required method for Designer support - do not modify
the contents of this method with the code editor.
</summary>
</member>
<member name="T:Blaze_Brigade.Resource1">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1._2archer">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1._2archer_attack">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1._2archer_stats">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1._2mage">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1._2mage_attack">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1._2mage_stats">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1._2warrior">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1._2warrior_attack">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1._2warrior_stats">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.archer">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.archer_attack">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.archer_stats">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.attack">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.attack_confirm">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.attackableNode">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.confirm_attack">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.Game_Map">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.instructions1">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.instructions2">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.instructions3">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.items">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.mage">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.mage_attack">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.mage_stats">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.MenuImage">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.move">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.moveableNode">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.wait">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.warrior">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.warrior_attack">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="P:Blaze_Brigade.Resource1.warrior_stats">
<summary>
Looks up a localized resource of type System.Drawing.Bitmap.
</summary>
</member>
<member name="M:Controller.Program.Main(System.String[])">
<summary>
The main entry point for the application.
</summary>
</member>
<member name="T:Controller.Game">
<summary>
Main Controller for game
</summary>
</member>
<member name="F:View.HowToPlay.components">
<summary>
Required designer variable.
</summary>
</member>
<member name="M:View.HowToPlay.Dispose(System.Boolean)">
<summary>
Clean up any resources being used.
</summary>
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
</member>
<member name="M:View.HowToPlay.InitializeComponent">
<summary>
Required method for Designer support - do not modify
the contents of this method with the code editor.
</summary>
</member>
<member name="F:View.HowToPlay2.components">
<summary>
Required designer variable.
</summary>
</member>
<member name="M:View.HowToPlay2.Dispose(System.Boolean)">
<summary>
Clean up any resources being used.
</summary>
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
</member>
<member name="M:View.HowToPlay2.InitializeComponent">
<summary>
Required method for Designer support - do not modify
the contents of this method with the code editor.
</summary>
</member>
<member name="F:View.HowToPlay3.components">
<summary>
Required designer variable.
</summary>
</member>
<member name="M:View.HowToPlay3.Dispose(System.Boolean)">
<summary>
Clean up any resources being used.
</summary>
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
</member>
<member name="M:View.HowToPlay3.InitializeComponent">
<summary>
Required method for Designer support - do not modify
the contents of this method with the code editor.
</summary>
</member>
<member name="F:View.MainMenu.components">
<summary>
Required designer variable.
</summary>
</member>
<member name="M:View.MainMenu.Dispose(System.Boolean)">
<summary>
Clean up any resources being used.
</summary>
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
</member>
<member name="M:View.MainMenu.InitializeComponent">
<summary>
Required method for Designer support - do not modify
the contents of this method with the code editor.
</summary>
</member>
</members>
</doc>
src/Blaze-Brigade/Blaze_Brigade/Blaze_Brigade.csproj
+ 1
− 0
View file @ bc1b8d7a
......@@ -31,6 +31,7 @@
<UseVSHostingProcess>false</UseVSHostingProcess>
<PlatformTarget>x86</PlatformTarget>
<XnaCompressContent>false</XnaCompressContent>
<DocumentationFile>C:\Users\chaos\Documents\Blaze-Brigade\Doc\MIS\Blaze_Brigade.XML</DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
<DebugType>pdbonly</DebugType>
......
src/Blaze-Brigade/Blaze_Brigade/Blaze_Brigade.csproj.Debug.cachefile
+ 2
− 2
View file @ bc1b8d7a
......@@ -6,10 +6,10 @@ Content\attack.xnb
Content\items.xnb
Content\move.xnb
Content\wait.xnb
Content\PixelFont.xnb
Content\warrior_stats.xnb
Content\PixelFontLarge.xnb
Content\warrior.xnb
Content\PixelFont.xnb
Content\PixelFontLarge.xnb
Content\instructions1.xnb
Content\instructions2.xnb
Content\instructions3.xnb
......
src/Blaze-Brigade/Blaze_Brigade/Game.cs
+ 4
− 0
View file @ bc1b8d7a
......@@ -15,6 +15,10 @@ using View;
using Blaze_Brigade;
using System.Diagnostics;
/// <summary>
/// The controller in MVC. These classes will control how the Model is used, and how the
/// view will be displayed to the user.
/// </summary>
namespace Controller
{
......
src/Blaze-Brigade/Blaze_Brigade/MainMenu.cs
+ 3
− 0
View file @ bc1b8d7a
......@@ -7,6 +7,9 @@ using System.Linq;
using System.Text;
using System.Windows.Forms;
/// <summary>
/// The view in MVC. These classes deal with the view that the user sees in the game.
/// </summary>
namespace View
{
......
src/Blaze-Brigade/Blaze_Brigade/Unit.cs
+ 58
− 12
View file @ bc1b8d7a
......@@ -4,24 +4,70 @@ using System.Linq;
using System.Text;
using Microsoft.Xna.Framework.Graphics;
using Microsoft.Xna.Framework;
using View;
/// <summary>
/// The model in MVC. These classes contain the structure of the game, and will be controlled by Controller,
/// and displayed in View.
/// </summary>
namespace Model
{
/// <summary>
/// Unit Interface for Warrior, Mage, and Archer
/// </summary>
/**
* This is the interface for the 3 playable unit classes, where the only
differences in the units will be their statistics and graphical assets
*/
interface Unit
{
bool Alive { get; set; } // whether unit is dead or alive
int Hp { get; set; } // returns and sets unit's HP
int Str { get; set; } // returns and sets unit's strength
int Int { get; set; } // returns and sets unit's intelligence
int Skill { get; set; } // returns and sets unit's skill
int Speed { get; set; } // returns and sets unit's speed
int Def { get; set; } // returns and sets unit's defense
int Res { get; set; } // returns and sets unit's resistance
int Level { get; set; } // returns and sets unit's level
int getMovability(); // returns the unit's movability (number of spaces the unit can move in one turn)
int getStats(int i); // returns stat located at i (in order from 0-6: lvl, str, mag, skill, spd, def, res)
/**
Sets and returns whether or not unit is alive
*/
bool Alive { get; set; }
/**
Sets and returns a unit's HP
*/
int Hp { get; set; }
/**
Sets and returns a unit's Strength
*/
int Str { get; set; }
/**
Sets and returns a unit's Intelliegence
*/
int Int { get; set; }
/**
Sets and returns a unit's Skill
*/
int Skill { get; set; }
/**
Sets and returns a unit's Speed
*/
int Speed { get; set; }
/**
Sets and returns a unit's Defense
*/
int Def { get; set; }
/**
Sets and returns a unit's Resistance
*/
int Res { get; set; }
/**
Sets and returns a unit's Level
*/
int Level { get; set; }
/**
Returns the unit's movability range on grid (number of spaces the unit can move in one turn)
*/
int getMovability();
/**
returns stat located at i (in order from 0-6: lvl, str, mag, skill, spd, def, res)
\param i The location of the stat to be returned in array
*/
int getStats(int i);
Weapon equippedWeapon { get; set; } // returns weapon the unit is currently equipping
//void setEquipableWeapons(Weapon add); // need to update the weapon array, put new weapon into it
bool isButtonActive(ButtonType buttonType); // indicates whether a button has already been previously selected or not
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment