Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/overlays/InGameConsole.h @ 7996

Last change on this file since 7996 was 7284, checked in by landauf, 14 years ago

merged consolecommands3 branch back to trunk.

note: the console command interface has changed completely, but the documentation is not yet up to date. just copy an existing command and change it to your needs, it's pretty self-explanatory. also the include files related to console commands are now located in core/command/. in the game it should work exactly like before, except for some changes in the auto-completion.

  • Property svn:eol-style set to native
File size: 3.4 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Felix Schulthess
24 *   Co-authors:
25 *      Fabian 'x3n' Landau
26 *
27 */
28
29#ifndef _InGameConsole_H__
30#define _InGameConsole_H__
31
32
33#include "OrxonoxPrereqs.h"
34
35#include <string>
36
37#include "util/OgreForwardRefs.h"
38#include "util/Singleton.h"
39#include "core/WindowEventListener.h"
40#include "core/command/Shell.h"
41
42namespace orxonox
43{
44    class _OrxonoxExport InGameConsole : public Singleton<InGameConsole>, public ShellListener, public WindowEventListener
45    {
46        friend class Singleton<InGameConsole>;
47    public: // functions
48        InGameConsole();
49        ~InGameConsole();
50
51        void initialise();
52        void setConfigValues();
53
54        void preUpdate(const Clock& time);
55
56        static void openConsole();
57        static void closeConsole();
58
59    private: // functions
60        InGameConsole(const InGameConsole& other);
61
62        void activate();
63        void deactivate();
64
65        void linesChanged();
66        void onlyLastLineChanged();
67        void lineAdded();
68        void inputChanged();
69        void cursorChanged();
70        void executed();
71        void exit();
72
73        void shiftLines();
74        void colourLine(Shell::LineType type, int index);
75        void setCursorPosition(unsigned int pos);
76        void print(const std::string& text, Shell::LineType type, int index, bool alwaysShift = false);
77
78        void windowResized(unsigned int newWidth, unsigned int newHeight);
79
80        // config value related
81        void bHidesAllInputChanged();
82
83    private: // variables
84        Shell* shell_;
85        bool bActive_;
86        int windowW_;
87        int windowH_;
88        int desiredTextWidth_;
89        unsigned int maxCharsPerLine_;
90        unsigned int numLinesShifted_;
91        int scroll_;
92        float cursor_;
93        unsigned int inputWindowStart_;
94        bool bShowCursor_;
95        std::string displayedText_;
96        Ogre::Overlay* consoleOverlay_;
97        Ogre::OverlayContainer* consoleOverlayContainer_;
98        Ogre::PanelOverlayElement* consoleOverlayNoise_;
99        Ogre::TextAreaOverlayElement* consoleOverlayCursor_;
100        Ogre::BorderPanelOverlayElement* consoleOverlayBorder_;
101        Ogre::TextAreaOverlayElement** consoleOverlayTextAreas_;
102
103        // input related
104        InputState* inputState_;
105
106        // config values
107        float relativeWidth;
108        float relativeHeight;
109        float blinkTime;
110        float scrollSpeed_;
111        float noiseSize_;
112        char cursorSymbol_;
113        bool bHidesAllInput_;
114
115        static InGameConsole* singletonPtr_s;
116    };
117}
118
119#endif /* _InGameConsole_H__ */
Note: See TracBrowser for help on using the repository browser.