Public Member Functions

ai::interface Class Reference

#include <interface.hpp>

Inheritance diagram for ai::interface:
Inheritance graph
[legend]
Collaboration diagram for ai::interface:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 interface ()
 The constructor.
virtual ~interface ()
virtual void play_turn ()=0
 Function that is called when the AI must play its turn.
virtual void new_turn ()=0
 Function called when a a new turn is played.
virtual void on_create ()
 Function called after the new ai is created.
virtual void switch_side (ai::side_number side)=0
virtual std::string evaluate (const std::string &)
 Evaluate.
virtual std::string describe_self () const
 Describe self.
virtual config to_config () const =0
 serialize to config

Detailed Description

Definition at line 29 of file interface.hpp.


Constructor & Destructor Documentation

ai::interface::interface (  )  [inline]

The constructor.

Definition at line 34 of file interface.hpp.

virtual ai::interface::~interface (  )  [inline, virtual]

Definition at line 40 of file interface.hpp.


Member Function Documentation

std::string ai::interface::describe_self (  )  const [virtual]

Describe self.

Reimplemented in ai::idle_ai.

Definition at line 28 of file interface.cpp.

virtual std::string ai::interface::evaluate ( const std::string &   )  [inline, virtual]

Evaluate.

Definition at line 64 of file interface.hpp.

virtual void ai::interface::new_turn (  )  [pure virtual]

Function called when a a new turn is played.

Implemented in ai::idle_ai.

virtual void ai::interface::on_create (  )  [inline, virtual]

Function called after the new ai is created.

Definition at line 58 of file interface.hpp.

virtual void ai::interface::play_turn (  )  [pure virtual]

Function that is called when the AI must play its turn.

Derived classes should implement their AI algorithm in this function.

Implemented in ai::idle_ai.

virtual void ai::interface::switch_side ( ai::side_number  side  )  [pure virtual]

Implemented in ai::idle_ai.

virtual config ai::interface::to_config (  )  const [pure virtual]

serialize to config

Implements savegame::savegame_config.

Implemented in ai::idle_ai.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated by doxygen 1.7.1 on Thu May 24 2012 01:19:00 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs