C#Code
C#Code
Public Member Functions | Properties | Private Member Functions | Private Attributes
TheForum.GameCode.BaseHighlighter Class Reference

List of all members.

Public Member Functions

 BaseHighlighter ()
void Update (int timePassed, BaseGameBoard board)
void Create (int col, int row, BaseGameBoard board, Libraries.AssetManager assetM)
void Render (GraphicsDevice device)
bool SetHighlighterBoardLoc (int col, int row, BaseGameBoard board)
bool ChangeRow (BaseGameBoard board, bool nextRow)
bool ChangeColumn (BaseGameBoard board, bool nextCol)
int GetRow ()
int GetCol ()
 BaseHighlighter ()
void Update (int framesPassed, BaseGameBoard board)
void Create (int col, int row, BaseGameBoard board, Libraries.AssetManager assetM)
void Render (GraphicsDevice device)
bool SetHighlighterBoardLoc (int col, int row, BaseGameBoard board)
bool ChangeRow (BaseGameBoard board, bool nextRow)
bool ChangeColumn (BaseGameBoard board, bool nextCol)
int GetRow ()
int GetCol ()

Properties

BaseObj3D Sprite [get, set]

Private Member Functions

 ~BaseHighlighter ()
 ~BaseHighlighter ()

Private Attributes

int m_col
 Which column and row the highlighter is at on the board.
int m_row
BaseObj3D m_sprite
 Store the sprite that will display the highlighter.

Detailed Description

Base piece highlighter. The highlighter is what shows where on the board is currently selected.


Constructor & Destructor Documentation

TheForum.GameCode.BaseHighlighter.BaseHighlighter ( )

Default constructor.

TheForum.GameCode.BaseHighlighter.~BaseHighlighter ( ) [private]

Destructor.

TheForum.GameCode.BaseHighlighter.BaseHighlighter ( )

Default constructor.

TheForum.GameCode.BaseHighlighter.~BaseHighlighter ( ) [private]

Destructor.


Member Function Documentation

bool TheForum.GameCode.BaseHighlighter.ChangeColumn ( BaseGameBoard  board,
bool  nextCol 
)

Tells the highlighter to move to the next or previous column.

board - Board the highlighter is on.
nextCol - True if the highlighter should move to the next column (increasing), false for the previous (decreasing).
bool TheForum.GameCode.BaseHighlighter.ChangeColumn ( BaseGameBoard  board,
bool  nextCol 
)

Tells the highlighter to move to the next or previous column.

board - Board the highlighter is on.
nextRow - True if the highlighter should move to the next column (increasing), false for the previous (decreasing).
bool TheForum.GameCode.BaseHighlighter.ChangeRow ( BaseGameBoard  board,
bool  nextRow 
)

Tells the highlighter to move to the next or previous row.

board - Board the highlighter is on.
nextRow - True if the highlighter should move to the next row (increasing), false for the previous (decreasing).
bool TheForum.GameCode.BaseHighlighter.ChangeRow ( BaseGameBoard  board,
bool  nextRow 
)

Tells the highlighter to move to the next or previous row.

board - Board the highlighter is on.
nextRow - True if the highlighter should move to the next row (increasing), false for the previous (decreasing).
void TheForum.GameCode.BaseHighlighter.Create ( int  col,
int  row,
BaseGameBoard  board,
Libraries.AssetManager  assetM 
)

Create the highlighter.

col, row - Where on the board to put the highlighter.
board - Board the highlighter is on.
assetM - Asset manager to use.
void TheForum.GameCode.BaseHighlighter.Create ( int  col,
int  row,
BaseGameBoard  board,
Libraries.AssetManager  assetM 
)

Create the highlighter.

col, row - Where on the board to put the highlighter.
board - Board the highlighter is on.
assetM - Asset manager to use.
device - Device to render the selector with.
int TheForum.GameCode.BaseHighlighter.GetCol ( )

Get the current column the selector is set to be at.
Value is the column the selector is at.

int TheForum.GameCode.BaseHighlighter.GetCol ( )

Get the current column the selector is set to be at.
Value is the column the selector is at.

int TheForum.GameCode.BaseHighlighter.GetRow ( )

Get the current row the selector is set to be at.
Value is the row the selector is at.

int TheForum.GameCode.BaseHighlighter.GetRow ( )

Get the current row the selector is set to be at.
Value is the row the selector is at.

void TheForum.GameCode.BaseHighlighter.Render ( GraphicsDevice  device)

Render the highlighter.

device - Device to render the selector with.
void TheForum.GameCode.BaseHighlighter.Render ( GraphicsDevice  device)

Render the highlighter.

device - Device to render the selector with.
bool TheForum.GameCode.BaseHighlighter.SetHighlighterBoardLoc ( int  col,
int  row,
BaseGameBoard  board 
)

Set the highlighter to be at the given location on the board.

col, row - Column and row that the highlighter should be located at on the board.
board - Board the highlighter is on.

Return:
Value is true if the highlighter was able to move to the given location, false if not.
bool TheForum.GameCode.BaseHighlighter.SetHighlighterBoardLoc ( int  col,
int  row,
BaseGameBoard  board 
)

Set the highlighter to be at the given location on the board.

col, row - Column and row that the highlighter should be located at on the board.
board - Board the highlighter is on.

Return:
Value is true if the highlighter was able to move to the given location, false if not.
void TheForum.GameCode.BaseHighlighter.Update ( int  timePassed,
BaseGameBoard  board 
)

Update the highlighter.

timePassed - How long has passed since the previous update.
board - Board the selector is on.
void TheForum.GameCode.BaseHighlighter.Update ( int  framesPassed,
BaseGameBoard  board 
)

Update the highlighter.

framesPassed - How long has passed since the previous update, in milliseconds.
board - Board the selector is on.

Member Data Documentation

Which column and row the highlighter is at on the board.

Store the sprite that will display the highlighter.


Property Documentation

BaseObj3D TheForum::GameCode.BaseHighlighter::Sprite [get, set]

Getter/Setter for the sprite used to display the highlighter.


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