CGameClock Class Reference

PutClassNameHere. More...

#include <GameClock.h>

List of all members.

Public Member Functions
	CGameClock (uint32 baseline=1)
	CGameClock.
	~CGameClock ()
	~CGameClock
void	SetBaseline (uint32 baseline)
	SetBaseline.
uint64	GetBaseline () const
	SetBaseline.
void	SetPlayerTimeAllotment (uint32 PlayerTime)
	SetPlayerTimeAllotment.
uint32	GetPlayerTimeAllotment () const
	GetPlayerTimeAllotment.
real32	GetHandicapPercent (uint32 PlayerBenchmark) const
	GetHandicapPercent.
CCountdownTimer *	GetPlayerClock (uint32 PlayerBenchmark)
	GetPlayerClock.

---

Detailed Description

PutClassNameHere.

Description:

Limitations:

---

Constructor & Destructor Documentation

CGameClock::CGameClock (  uint32  baseline = 1  )

CGameClock. Description: This function initializes the class's internal attributes Parameters: baseline,:  The tournament performance baseline. Returns: None Limitations: None

CGameClock::~CGameClock (   )

~CGameClock Description: This destructor was included for maintenance purposes only Returns: None Limitations: None

---

Member Function Documentation

uint64 CGameClock::GetBaseline (   )  const

SetBaseline. Description: Sets the baseline performance measure. Player time allotments are scaled to that their performance equals this measure. Returns: None Limitations: None

real32 CGameClock::GetHandicapPercent (  uint32  BenchmarkValue  )  const

GetHandicapPercent. Description: This function returns the amount of scaling that will be applied to a player whose benchmark value equals the value supplied. Parameters: BenchmarkValue,:  The performance measure of a participating machine. Returns: real32: The percentage of handicap. Positive values indicate an advantage over the baseline. Limitations: The benchmark used to measure system performance for the baseline and the player must be the same.

CCountdownTimer * CGameClock::GetPlayerClock (  uint32  PlayerBenchmark  )

GetPlayerClock. Description: A new countdown timer is generated and initialized to the player's game time. The time value assigned is scaled according to the player's benchmark value. Parameters: PlayerBenchmark,:  The performance measure of the player's computer. Returns: CCountdownTimer*: A pointer to a newly allocated timer initalized with the player's game time. Limitations: The benchmark used to measure system performance for the baseline and the player must be the same.

uint32 CGameClock::GetPlayerTimeAllotment (   )  const

GetPlayerTimeAllotment. Description: Returns the amount of time that is assigned to each player at the begining of the game or round. Returns: uint32: The player allotment in milliseconds. Limitations: None

void CGameClock::SetBaseline (  uint32  baseline  )

SetBaseline. Description: Sets the baseline performance measure. Player time allotments are scaled to that their performance equals this measure. Returns: None Limitations: None

void CGameClock::SetPlayerTimeAllotment (  uint32  allotment  )

SetPlayerTimeAllotment. Description: Sets the amount of time alloted to each player at the beginining of the game or round. This is the time value that is scaled based on the player's benchmark value and its ratio to the baseline. Parameters: allotment,:  The time assigned to each player in milliseconds Returns: void Limitations: None

---

The documentation for this class was generated from the following files:

• Games/GameClock.h
• Games/GameClock.cpp

---

Copyright (c) 2005 Matt Bruns, Pat Hammond, Kevin Markussen, Travis Service, Brain Shaver