Flashlight Class Reference

Manages the player's flashlight within the game. The flashlight is a small torch the player uses to illuminate dark areas in the game. The flashlight can be carried and used in unison with the player's gun. The flashlight is an inventory item. More...

Inheritance diagram for Flashlight:

List of all members.

Public Member Functions
void	addPower (float _power)
	Adds power to the touch.
void	drainPower (float _power)
	Drains power from the touch.
float	getPowerLevel ()
	Get's the current power level of the flashlight.
bool	getIsSwitchedOn ()
	Get's if the flashlight is switched on or not.
float	getPowerDrainRate ()
	Get's the flashlight's power drain rate.
float	getMaxPower ()
	Get's the flashlight's maximum power.
void	positionFlashlight ()
	Positions (and rotates) the flashlight into the correct orientation when the flashlight is first picked up. The flashlight is positioned in the player's left hand.

---

Detailed Description

Manages the player's flashlight within the game. The flashlight is a small torch the player uses to illuminate dark areas in the game. The flashlight can be carried and used in unison with the player's gun. The flashlight is an inventory item.

Author:

Alexander Poolton

Version:

3.0

Date:

17/6/2011

---

Member Function Documentation

void Flashlight::addPower

(

float

_power

)

[inline]

Adds power to the touch.

Parameters:

[in]

_power

The amount of power to add to the torch.

void Flashlight::drainPower

(

float

_power

)

[inline]

Drains power from the touch.

Parameters:

[in]

_power

The amount of power to drain from the torch.

bool Flashlight::getIsSwitchedOn

(

)

[inline]

Get's if the flashlight is switched on or not.

Returns:

m_isSwitchedOn Returns if the flashlight is switched on or not.

float Flashlight::getMaxPower

(

)

[inline]

Get's the flashlight's maximum power.

Returns:

m_maxPower Returns the flashlight's maximum power.

float Flashlight::getPowerDrainRate

(

)

[inline]

Get's the flashlight's power drain rate.

Returns:

m_powerDrainRate Returns the drain rate of the flashlight's power level.

float Flashlight::getPowerLevel

(

)

[inline]

Get's the current power level of the flashlight.

Returns:

Returns the flashlight's current power level.

---

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

• C:/Users/Alex/Desktop/Gamepad Classes/Player/Flashlight.cs