4 // Copyright (C) 2006 Matthias Braun <matze@braunis.de>
6 // This program is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU General Public License
8 // as published by the Free Software Foundation; either version 2
9 // of the License, or (at your option) any later version.
11 // This program is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // You should have received a copy of the GNU General Public License
17 // along with this program; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 #ifndef SUPERTUX_GAMEOBJECT_H
20 #define SUPERTUX_GAMEOBJECT_H
23 #include "refcounter.hpp"
26 class ObjectRemoveListener;
29 * This is a base class for all game objects. Each sector of a level will hold a
30 * list of active GameObject while the game is played.
32 * This class is responsible for:
33 * - Updating and Drawing the object. This should happen in the update() and
34 * draw() functions. Both are called once per frame.
35 * - Providing a safe way to remove the object by calling the remove_me
38 class GameObject : public RefCounter
42 virtual ~GameObject();
44 /** This function is called once per frame and allows the object to update
45 * it's state. The elapsed_time is the time since the last frame in
46 * seconds and should be the base for all timed calculations (don't use
47 * SDL_GetTicks directly as this will fail in pause mode)
49 virtual void update(float elapsed_time) = 0;
51 /** The GameObject should draw itself onto the provided DrawingContext if this
54 virtual void draw(DrawingContext& context) = 0;
56 /** returns true if the object is not scheduled to be removed yet */
62 /** schedules this object to be removed at the end of the frame */
68 /** registers a remove listener which will be called if the object
69 * gets removed/destroyed
71 void add_remove_listener(ObjectRemoveListener* listener);
74 * unregisters a remove listener, so it will no longer be called if the object
75 * gets removed/destroyed
77 void del_remove_listener(ObjectRemoveListener* listener);
79 const std::string& get_name() const
85 /** this flag indicates if the object should be removed at the end of the
90 struct RemoveListenerListEntry
92 RemoveListenerListEntry* next;
93 ObjectRemoveListener* listener;
95 RemoveListenerListEntry* remove_listeners;
99 * a name for the gameobject, this is mostly a hint for scripts and for
100 * debugging, don't rely on names being set or being unique
105 #endif /*SUPERTUX_GAMEOBJECT_H*/