Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
DozerAIInterface Class Referenceabstract

#include <DozerAIUpdate.h>

Inherited by DozerAIUpdate, and WorkerAIUpdate.

Public Member Functions

virtual void onDelete (void)=0
 
virtual Real getRepairHealthPerSecond (void) const =0
 get health to repair per second
 
virtual Real getBoredTime (void) const =0
 how long till we're bored
 
virtual Real getBoredRange (void) const =0
 when we're bored, we look this far away to do things
 
virtual Object * construct (const ThingTemplate *what, const Coord3D *pos, Real angle, Player *owningPlayer, Bool isRebuild)=0
 
virtual DozerTask getMostRecentCommand (void)=0
 return task that was most recently issued
 
virtual Bool isTaskPending (DozerTask task)=0
 is there a desire to do the requested task
 
virtual ObjectID getTaskTarget (DozerTask task)=0
 get target of task
 
virtual Bool isAnyTaskPending (void)=0
 is there any dozer task pending
 
virtual DozerTask getCurrentTask (void) const =0
 return the current task we're doing
 
virtual void setCurrentTask (DozerTask task)=0
 set the current task of the dozer
 
virtual Bool getIsRebuild (void)=0
 get whether or not this is a rebuild.
 
virtual void newTask (DozerTask task, Object *target)=0
 set a desire to do the requrested task
 
virtual void cancelTask (DozerTask task)=0
 cancel this task from the queue, if it's the current task the dozer will stop working on it
 
virtual void internalTaskComplete (DozerTask task)=0
 set a dozer task as successfully completed
 
virtual void internalCancelTask (DozerTask task)=0
 cancel this task from the dozer
 
virtual void internalTaskCompleteOrCancelled (DozerTask task)=0
 this is called when tasks are cancelled or completed
 
virtual const Coord3D * getDockPoint (DozerTask task, DozerDockPoint point)=0
 
virtual void setBuildSubTask (DozerBuildSubTask subTask)=0
 
virtual DozerBuildSubTask getBuildSubTask (void)=0
 
virtual Bool canAcceptNewRepair (Object *obj)=0
 
virtual void createBridgeScaffolding (Object *bridgeTower)=0
 
virtual void removeBridgeScaffolding (Object *bridgeTower)=0
 
virtual void startBuildingSound (const AudioEventRTS *sound, ObjectID constructionSiteID)=0
 
virtual void finishBuildingSound ()=0
 

Detailed Description

This is no longer a leaf behavior. Someone else needs to combine this with another major AIUpdate. So provide an interface to satisfy the people who look this up by name.

Definition at line 106 of file DozerAIUpdate.h.

Member Function Documentation

◆ canAcceptNewRepair()

virtual Bool DozerAIInterface::canAcceptNewRepair ( Object * obj)
pure virtual

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ cancelTask()

virtual void DozerAIInterface::cancelTask ( DozerTask task)
pure virtual

cancel this task from the queue, if it's the current task the dozer will stop working on it

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ construct()

virtual Object * DozerAIInterface::construct ( const ThingTemplate * what,
const Coord3D * pos,
Real angle,
Player * owningPlayer,
Bool isRebuild )
pure virtual

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ createBridgeScaffolding()

virtual void DozerAIInterface::createBridgeScaffolding ( Object * bridgeTower)
pure virtual

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ finishBuildingSound()

virtual void DozerAIInterface::finishBuildingSound ( )
pure virtual

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ getBoredRange()

virtual Real DozerAIInterface::getBoredRange ( void ) const
pure virtual

when we're bored, we look this far away to do things

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ getBoredTime()

virtual Real DozerAIInterface::getBoredTime ( void ) const
pure virtual

how long till we're bored

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ getBuildSubTask()

virtual DozerBuildSubTask DozerAIInterface::getBuildSubTask ( void )
pure virtual

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ getCurrentTask()

virtual DozerTask DozerAIInterface::getCurrentTask ( void ) const
pure virtual

return the current task we're doing

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ getDockPoint()

virtual const Coord3D * DozerAIInterface::getDockPoint ( DozerTask task,
DozerDockPoint point )
pure virtual

return a dock point for the action and task (if valid) ... note it can return NULL if no point has been set for the combination of task and point

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ getIsRebuild()

virtual Bool DozerAIInterface::getIsRebuild ( void )
pure virtual

get whether or not this is a rebuild.

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ getMostRecentCommand()

virtual DozerTask DozerAIInterface::getMostRecentCommand ( void )
pure virtual

return task that was most recently issued

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ getRepairHealthPerSecond()

virtual Real DozerAIInterface::getRepairHealthPerSecond ( void ) const
pure virtual

get health to repair per second

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ getTaskTarget()

virtual ObjectID DozerAIInterface::getTaskTarget ( DozerTask task)
pure virtual

get target of task

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ internalCancelTask()

virtual void DozerAIInterface::internalCancelTask ( DozerTask task)
pure virtual

cancel this task from the dozer

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ internalTaskComplete()

virtual void DozerAIInterface::internalTaskComplete ( DozerTask task)
pure virtual

set a dozer task as successfully completed

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ internalTaskCompleteOrCancelled()

virtual void DozerAIInterface::internalTaskCompleteOrCancelled ( DozerTask task)
pure virtual

this is called when tasks are cancelled or completed

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ isAnyTaskPending()

virtual Bool DozerAIInterface::isAnyTaskPending ( void )
pure virtual

is there any dozer task pending

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ isTaskPending()

virtual Bool DozerAIInterface::isTaskPending ( DozerTask task)
pure virtual

is there a desire to do the requested task

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ newTask()

virtual void DozerAIInterface::newTask ( DozerTask task,
Object * target )
pure virtual

set a desire to do the requrested task

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ onDelete()

virtual void DozerAIInterface::onDelete ( void )
pure virtual

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ removeBridgeScaffolding()

virtual void DozerAIInterface::removeBridgeScaffolding ( Object * bridgeTower)
pure virtual

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ setBuildSubTask()

virtual void DozerAIInterface::setBuildSubTask ( DozerBuildSubTask subTask)
pure virtual

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ setCurrentTask()

virtual void DozerAIInterface::setCurrentTask ( DozerTask task)
pure virtual

set the current task of the dozer

Implemented in DozerAIUpdate, and WorkerAIUpdate.

◆ startBuildingSound()

virtual void DozerAIInterface::startBuildingSound ( const AudioEventRTS * sound,
ObjectID constructionSiteID )
pure virtual

Implemented in DozerAIUpdate, and WorkerAIUpdate.

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