supertux
endsequence.hpp
1 // SuperTux - End Sequence
2 // Copyright (C) 2007 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
3 //
4 // This program is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program. If not, see <http://www.gnu.org/licenses/>.
16 
17 #ifndef HEADER_SUPERTUX_OBJECT_ENDSEQUENCE_HPP
18 #define HEADER_SUPERTUX_OBJECT_ENDSEQUENCE_HPP
19 
20 #include "control/codecontroller.hpp"
21 #include "supertux/game_object.hpp"
22 
23 #include <unordered_map>
24 
25 class EndSequence : public GameObject
26 {
27 public:
28  EndSequence();
29  ~EndSequence() override;
30  virtual GameObjectClasses get_class_types() const override { return GameObject::get_class_types().add(typeid(EndSequence)); }
31 
32  virtual void update(float dt_sec) override;
33  virtual void draw(DrawingContext& context) override;
34 
35  void start();
36  void stop_tux(int player);
37  void stop();
38  bool is_running() const;
39  bool is_tux_stopped(int player);
40  bool is_done() const;
41  virtual bool is_saveable() const override {
42  return false;
43  }
44 
45  const Controller* get_controller(int player);
46 
47 protected:
48  CodeController* get_code_controller(int player);
49  virtual void starting();
50  virtual void running(float dt_sec);
51  virtual void stopping();
53 protected:
54  bool m_is_running;
55  bool m_is_done;
56  std::unordered_map<int, bool> m_tux_is_stopped;
57  std::unordered_map<int, std::unique_ptr<CodeController>> m_end_sequence_controllers;
58 
59 private:
60  EndSequence(const EndSequence&) = delete;
61  EndSequence& operator=(const EndSequence&) = delete;
62 };
63 
64 #endif
65 
66 /* EOF */
Definition: controller.hpp:57
bool is_running() const
returns true if the ending cinematic started
Definition: endsequence.cpp:72
virtual void starting()
called when EndSequence starts
Definition: endsequence.cpp:90
void stop_tux(int player)
called when Tux has reached his final position
Definition: endsequence.cpp:57
virtual bool is_saveable() const override
Indicates if the object will be saved.
Definition: endsequence.hpp:41
virtual void update(float dt_sec) override
This function is called once per frame and allows the object to update it&#39;s state.
Definition: endsequence.cpp:35
virtual GameObjectClasses get_class_types() const override
List notable classes in inheritance hierarchy of class.
Definition: endsequence.hpp:30
bool m_is_running
true while EndSequence plays
Definition: endsequence.hpp:54
virtual void draw(DrawingContext &context) override
The GameObject should draw itself onto the provided DrawingContext if this function is called...
Definition: endsequence.cpp:42
std::unordered_map< int, bool > m_tux_is_stopped
true while tux is allowed to walk
Definition: endsequence.hpp:56
bool m_is_done
true if EndSequence has finished playing
Definition: endsequence.hpp:55
bool is_done() const
returns true if EndSequence has finished playing
Definition: endsequence.cpp:84
Definition: endsequence.hpp:25
This class is responsible for: Updating and drawing the object.
Definition: game_object.hpp:83
This is a dummy controller that doesn&#39;t react to any user input but should be controlled by code...
Definition: codecontroller.hpp:24
bool is_tux_stopped(int player)
returns true if Tux has reached his final position
Definition: endsequence.cpp:78
virtual GameObjectClasses get_class_types() const
List notable classes in inheritance hierarchy of class.
Definition: game_object.cpp:113
A helper structure to list all the type_indexes of the classes in the type hierarchy of a given class...
Definition: game_object.hpp:57
virtual void running(float dt_sec)
called while the EndSequence is running
Definition: endsequence.cpp:95
void stop()
stop playing EndSequence, mark it as done playing
Definition: endsequence.cpp:63
virtual void stopping()
called when EndSequence stops
Definition: endsequence.cpp:104
This class provides functions for drawing things on screen.
Definition: drawing_context.hpp:42
void start()
play EndSequence
Definition: endsequence.cpp:47