Main Page Modules Namespaces C++ Classes Compound List File List Index
TNL: Zap::GameUserInterface Class Reference

# Zap::GameUserInterface Class Reference

`#include <UIGame.h>`

Inheritance diagram for Zap::GameUserInterface:

## Public Member Functions

| GameUserInterface ()
void | displayMessage (Color messageColor, const char *format,...)
void | render ()
void | renderReticle ()
void | renderMessageDisplay ()
void | renderCurrentChat ()
void | setPlayMode ()
void | idle (U32 timeDelta)
void | issueChat ()
void | cancelChat ()
void | onMouseMoved (S32 x, S32 y)
void | onMouseDragged (S32 x, S32 y)
void | onMouseDown (S32 x, S32 y)
void | onMouseUp (S32 x, S32 y)
void | onRightMouseDown (S32 x, S32 y)
void | onRightMouseUp (S32 x, S32 y)
void | onKeyDown (U32 key)
void | onKeyUp (U32 key)
void | onModifierKeyDown (U32 key)
void | onModifierKeyUp (U32 key)
void | onSpecialKeyDown (U32 key)
void | onControllerButtonDown (U32 buttonIndex)
void | onControllerButtonUp (U32 buttonIndex)
void | receivedControlUpdate (bool recvd)
Move * | getCurrentMove ()

## Private Types

enum | { DisplayMessageTimeout = 2500 }
enum | { MessageDisplayCount = 4 }
enum | Mode { PlayMode, ChatMode, VChatMode, LoadoutMode
}
enum | ChatType { GlobalChat, TeamChat }
enum | { ChatBlinkTime = 100, FPSAvgCount = 32 }

## Private Member Functions

void | enterVChat (bool fromController)
void | enterLoadout (bool fromController)

## Private Attributes

Move | mCurrentMove
Move | mTransformedMove
Point | mMousePoint
Color | mDisplayMessageColor [MessageDisplayCount]
char | mDisplayMessage [MessageDisplayCount][2048]
U32 | mDisplayMessageTimer
Mode | mCurrentMode
ChatType | mCurrentChatType
char | mChatBuffer [50]
U32 | mChatCursorPos
bool | mChatBlink
U32 | mChatLastBlinkTime
bool | mInScoreboardMode
bool | mGotControlUpdate
bool | mFPSVisible
U32 | mIdleTimeDelta [FPSAvgCount]
U32 | mFrameIndex
VChatHelper | mVChat
LoadoutHelper | mLoadout
Zap::GameUserInterface::VoiceRecorder | mVoiceRecorder

## Data Structures

struct | VoiceRecorder

## Member Enumeration Documentation

anonymous enum`[private]`

Enumerator:

  DisplayMessageTimeout |

anonymous enum`[private]`

Enumerator:

  MessageDisplayCount |

enum Zap::GameUserInterface::Mode`[private]`

Enumerator:

  PlayMode |
  ChatMode |
  VChatMode |
  LoadoutMode |

enum Zap::GameUserInterface::ChatType`[private]`

Enumerator:

  GlobalChat |
  TeamChat |

anonymous enum`[private]`

Enumerator:

  ChatBlinkTime |
  FPSAvgCount |

## Constructor & Destructor Documentation

Zap::GameUserInterface::GameUserInterface | ( |  | ) |

## Member Function Documentation

void Zap::GameUserInterface::enterVChat | ( | bool | fromController | ) | `[private]`

void Zap::GameUserInterface::enterLoadout | ( | bool | fromController | ) | `[private]`

void Zap::GameUserInterface::displayMessage | ( | Color | messageColor,
|  | const char * | format,
|  |  | ... |
| ) |  |  |

void Zap::GameUserInterface::render | ( |  | ) | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::renderReticle | ( |  | ) |

void Zap::GameUserInterface::renderMessageDisplay | ( |  | ) |

void Zap::GameUserInterface::renderCurrentChat | ( |  | ) |

void Zap::GameUserInterface::setPlayMode | ( |  | ) | `[inline]`

void Zap::GameUserInterface::idle | ( | U32 | timeDelta | ) | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::issueChat | ( |  | ) |

void Zap::GameUserInterface::cancelChat | ( |  | ) |

void Zap::GameUserInterface::onMouseMoved | ( | S32 | x,
|  | S32 | y |
| ) |  |  | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::onMouseDragged | ( | S32 | x,
|  | S32 | y |
| ) |  |  | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::onMouseDown | ( | S32 | x,
|  | S32 | y |
| ) |  |  | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::onMouseUp | ( | S32 | x,
|  | S32 | y |
| ) |  |  | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::onRightMouseDown | ( | S32 | x,
|  | S32 | y |
| ) |  |  | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::onRightMouseUp | ( | S32 | x,
|  | S32 | y |
| ) |  |  | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::onKeyDown | ( | U32 | key | ) | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::onKeyUp | ( | U32 | key | ) | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::onModifierKeyDown | ( | U32 | key | ) | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::onModifierKeyUp | ( | U32 | key | ) | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::onSpecialKeyDown | ( | U32 | key | ) | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::onControllerButtonDown | ( | U32 | buttonIndex | ) | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::onControllerButtonUp | ( | U32 | buttonIndex | ) | `[virtual]`

Reimplemented from Zap::UserInterface.

void Zap::GameUserInterface::receivedControlUpdate | ( | bool | recvd | ) | `[inline]`

Move* Zap::GameUserInterface::getCurrentMove | ( |  | ) |

## Field Documentation

Move Zap::GameUserInterface::mCurrentMove`[private]`

Move Zap::GameUserInterface::mTransformedMove`[private]`

Point Zap::GameUserInterface::mMousePoint`[private]`

Color Zap::GameUserInterface::mDisplayMessageColor[MessageDisplayCount]`[private]`

char Zap::GameUserInterface::mDisplayMessage[MessageDisplayCount][2048]`[private]`

U32 Zap::GameUserInterface::mDisplayMessageTimer`[private]`

Mode Zap::GameUserInterface::mCurrentMode`[private]`

ChatType Zap::GameUserInterface::mCurrentChatType`[private]`

char Zap::GameUserInterface::mChatBuffer[50]`[private]`

U32 Zap::GameUserInterface::mChatCursorPos`[private]`

bool Zap::GameUserInterface::mChatBlink`[private]`

U32 Zap::GameUserInterface::mChatLastBlinkTime`[private]`

bool Zap::GameUserInterface::mInScoreboardMode`[private]`

bool Zap::GameUserInterface::mGotControlUpdate`[private]`

bool Zap::GameUserInterface::mFPSVisible`[private]`

U32 Zap::GameUserInterface::mIdleTimeDelta[FPSAvgCount]`[private]`

U32 Zap::GameUserInterface::mFrameIndex`[private]`

VChatHelper Zap::GameUserInterface::mVChat`[private]`

LoadoutHelper Zap::GameUserInterface::mLoadout`[private]`

struct Zap::GameUserInterface::VoiceRecorder Zap::GameUserInterface::mVoiceRecorder`[private]`