1 // Copyright (C) 2009 Ben Asselstine
3 // This program is free software; you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation; either version 3 of the License, or
6 // (at your option) any later version.
8 // This program is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 // GNU Library General Public License for more details.
13 // You should have received a copy of the GNU General Public License
14 // along with this program; if not, write to the Free Software
15 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 //! A Commentator is the in-game commentator.
29 * Periodically a message will be conveyed to human players at the start of
30 * their turn. This Commentator object determines appropriate messages to
38 //! Returns the singleton instance.
39 static Commentator* getInstance();
41 //! Explicitly deletes the singleton instance.
42 static void deleteInstance();
44 bool hasComment() const;
46 std::vector<std::string> getComments(Player *player) const;
49 //! Creates a new Commentator from scratch.
53 virtual ~Commentator();
56 static Commentator* d_instance;
59 #endif //COMMENTATOR_H