SpecialPowerModuleInterface Class Reference

#include <SpecialPowerModule.h>

Inherited by SpecialPowerModule.

Public Member Functions
virtual Bool	isModuleForPower (const SpecialPowerTemplate *specialPowerTemplate) const =0
virtual Bool	isReady (void) const =0
virtual Real	getPercentReady (void) const =0
virtual UnsignedInt	getReadyFrame (void) const =0
virtual AsciiString	getPowerName (void) const =0
virtual const SpecialPowerTemplate *	getSpecialPowerTemplate (void) const =0
virtual ScienceType	getRequiredScience (void) const =0
virtual void	onSpecialPowerCreation (void)=0
virtual void	setReadyFrame (UnsignedInt frame)=0
virtual void	pauseCountdown (Bool pause)=0
virtual void	doSpecialPower (UnsignedInt commandOptions)=0
virtual void	doSpecialPowerAtObject (Object *obj, UnsignedInt commandOptions)=0
virtual void	doSpecialPowerAtLocation (const Coord3D *loc, Real angle, UnsignedInt commandOptions)=0
virtual void	doSpecialPowerUsingWaypoints (const Waypoint *way, UnsignedInt commandOptions)=0
virtual void	markSpecialPowerTriggered (const Coord3D *location)=0
virtual void	startPowerRecharge ()=0
virtual const AudioEventRTS &	getInitiateSound () const =0
virtual Bool	isScriptOnly () const =0
virtual const ThingTemplate *	getReferenceThingTemplate () const =0

Detailed Description

Definition at line 49 of file SpecialPowerModule.h.

Member Function Documentation

doSpecialPower()

virtual void SpecialPowerModuleInterface::doSpecialPower ( UnsignedInt commandOptions )

pure virtual

Implemented in BaikonurLaunchPower, CashBountyPower, FireWeaponPower, OCLSpecialPower, SpecialAbility, SpecialPowerModule, and SpyVisionSpecialPower.

doSpecialPowerAtLocation()

virtual void SpecialPowerModuleInterface::doSpecialPowerAtLocation ( const Coord3D * loc, Real angle, UnsignedInt commandOptions )

pure virtual

Implemented in BaikonurLaunchPower, CashHackSpecialPower, CleanupAreaPower, DefectorSpecialPower, FireWeaponPower, OCLSpecialPower, SpecialAbility, and SpecialPowerModule.

doSpecialPowerAtObject()

virtual void SpecialPowerModuleInterface::doSpecialPowerAtObject ( Object * obj, UnsignedInt commandOptions )

pure virtual

Implemented in CashHackSpecialPower, DefectorSpecialPower, FireWeaponPower, OCLSpecialPower, SpecialAbility, and SpecialPowerModule.

doSpecialPowerUsingWaypoints()

virtual void SpecialPowerModuleInterface::doSpecialPowerUsingWaypoints ( const Waypoint * way, UnsignedInt commandOptions )

pure virtual

Implemented in SpecialPowerModule.

getInitiateSound()

virtual const AudioEventRTS & SpecialPowerModuleInterface::getInitiateSound ( ) const

pure virtual

Implemented in SpecialPowerModule.

getPercentReady()

virtual Real SpecialPowerModuleInterface::getPercentReady ( void ) const

pure virtual

Implemented in SpecialPowerModule.

getPowerName()

virtual AsciiString SpecialPowerModuleInterface::getPowerName ( void ) const

pure virtual

Implemented in SpecialPowerModule.

getReadyFrame()

virtual UnsignedInt SpecialPowerModuleInterface::getReadyFrame ( void ) const

pure virtual

Implemented in SpecialPowerModule.

getReferenceThingTemplate()

virtual const ThingTemplate * SpecialPowerModuleInterface::getReferenceThingTemplate ( ) const

pure virtual

Implemented in OCLSpecialPower, and SpecialPowerModule.

getRequiredScience()

virtual ScienceType SpecialPowerModuleInterface::getRequiredScience ( void ) const

pure virtual

Implemented in SpecialPowerModule.

getSpecialPowerTemplate()

virtual const SpecialPowerTemplate * SpecialPowerModuleInterface::getSpecialPowerTemplate ( void ) const

pure virtual

Implemented in SpecialPowerModule.

isModuleForPower()

virtual Bool SpecialPowerModuleInterface::isModuleForPower ( const SpecialPowerTemplate * specialPowerTemplate ) const

pure virtual

Implemented in SpecialPowerModule.

isReady()

virtual Bool SpecialPowerModuleInterface::isReady ( void ) const

pure virtual

Implemented in SpecialPowerModule.

isScriptOnly()

virtual Bool SpecialPowerModuleInterface::isScriptOnly ( ) const

pure virtual

Implemented in SpecialPowerModule.

markSpecialPowerTriggered()

virtual void SpecialPowerModuleInterface::markSpecialPowerTriggered ( const Coord3D * location )

pure virtual

Implemented in SpecialPowerModule.

onSpecialPowerCreation()

virtual void SpecialPowerModuleInterface::onSpecialPowerCreation ( void )

pure virtual

Implemented in CashBountyPower, and SpecialPowerModule.

pauseCountdown()

virtual void SpecialPowerModuleInterface::pauseCountdown ( Bool pause )

pure virtual

Implemented in SpecialPowerModule.

setReadyFrame()

virtual void SpecialPowerModuleInterface::setReadyFrame ( UnsignedInt frame )

pure virtual

Implemented in SpecialPowerModule.

startPowerRecharge()

virtual void SpecialPowerModuleInterface::startPowerRecharge ( )

pure virtual

Implemented in SpecialPowerModule.

---

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

• Code/GameEngine/Include/GameLogic/Module/SpecialPowerModule.h