Files
@ r27308:abc0eb023c25
Branch filter:
Location: cpp/openttd-patchpack/source/src/script/api/script_window.hpp.in - annotation
r27308:abc0eb023c25
4.9 KiB
text/plain
Codechange: use std::string as std::map key, instead of stredup string
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r26478:6f8abc6225df r24325:ed063eed3f1c r24325:ed063eed3f1c r26993:0c537987d9dd r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r26993:0c537987d9dd r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r26993:0c537987d9dd r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r26993:0c537987d9dd r24325:ed063eed3f1c r24325:ed063eed3f1c r26993:0c537987d9dd r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r26993:0c537987d9dd r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r26993:0c537987d9dd r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r26993:0c537987d9dd r24325:ed063eed3f1c r26993:0c537987d9dd r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r26993:0c537987d9dd r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c r24325:ed063eed3f1c | /*
* This file is part of OpenTTD.
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file script_window.hpp Everything to handle window interaction. */
#ifndef SCRIPT_WINDOW_HPP
#define SCRIPT_WINDOW_HPP
#include "script_object.hpp"
${INCLUDES}
/**
* Class that handles window interaction. A Window in OpenTTD has two important
* values. The WindowClass, and a Window number. The first indicates roughly
* which window it is. WC_TOWN_VIEW for example, is the view of a town.
* The Window number is a bit more complex, as it depends mostly on the
* WindowClass. For example for WC_TOWN_VIEW it is the TownID. In general a
* good rule of thumb is: either the number is always 0, or the ID of the
* object in question.
* In the comment at the widget enum, it is mentioned how the number is used.
*
* Note, that the detailed window layout is very version specific.
* Enum values might be added, changed or removed in future versions without notice
* in the changelog, and there won't be any means of compatibility.
*
* @api game
*/
class ScriptWindow : public ScriptObject {
public:
// @enum WindowNumberEnum ../../window_type.h@ENUM_WINDOWNUMBERENUM@
// @endenum
// @enum WindowClass ../../window_type.h@ENUM_WINDOWCLASS@
// @endenum
/**
* The colours in the game which you can use for text and highlights.
*/
enum TextColour {
/* Note: these values represent part of the in-game TextColour enum */
TC_BLUE = ::TC_BLUE, ///< Blue colour.
TC_SILVER = ::TC_SILVER, ///< Silver colour.
TC_GOLD = ::TC_GOLD, ///< Gold colour.
TC_RED = ::TC_RED, ///< Red colour.
TC_PURPLE = ::TC_PURPLE, ///< Purple colour.
TC_LIGHT_BROWN = ::TC_LIGHT_BROWN, ///< Light brown colour.
TC_ORANGE = ::TC_ORANGE, ///< Orange colour.
TC_GREEN = ::TC_GREEN, ///< Green colour.
TC_YELLOW = ::TC_YELLOW, ///< Yellow colour.
TC_DARK_GREEN = ::TC_DARK_GREEN, ///< Dark green colour.
TC_CREAM = ::TC_CREAM, ///< Cream colour.
TC_BROWN = ::TC_BROWN, ///< Brown colour.
TC_WHITE = ::TC_WHITE, ///< White colour.
TC_LIGHT_BLUE = ::TC_LIGHT_BLUE, ///< Light blue colour.
TC_GREY = ::TC_GREY, ///< Grey colour.
TC_DARK_BLUE = ::TC_DARK_BLUE, ///< Dark blue colour.
TC_BLACK = ::TC_BLACK, ///< Black colour.
TC_INVALID = ::TC_INVALID, ///< Invalid colour.
};
/**
* Special number values.
*/
enum NumberType {
NUMBER_ALL = -1, ///< Value to select all windows of a class.
};
/**
* Special widget values.
*/
enum WidgetType {
WIDGET_ALL = -1, ///< Value to select all widgets of a window.
};
/**
* Close a window.
* @param window The class of the window to close.
* @param number The number of the window to close, or NUMBER_ALL to close all of this class.
* The value will be clamped to 0 .. MAX(int32) when value is not NUMBER_ALL.
* @pre !ScriptGame::IsMultiplayer().
*/
static void Close(WindowClass window, SQInteger number);
/**
* Check if a window is open.
* @param window The class of the window to check for.
* @param number The number of the window to check for, or NUMBER_ALL to check for any in the class.
* The value will be clamped to 0 .. MAX(int32) when value is not NUMBER_ALL.
* @pre !ScriptGame::IsMultiplayer().
* @return True if the window is open.
*/
static bool IsOpen(WindowClass window, SQInteger number);
/**
* Highlight a widget in a window.
* @param window The class of the window to highlight a widget in.
* @param number The number of the window to highlight a widget in.
* The value will be clamped to 0 .. MAX(int32) when value is not NUMBER_ALL.
* @param widget The widget in the window to highlight, or WIDGET_ALL (in combination with TC_INVALID) to disable all widget highlighting on this window.
* The value will be clamped to 0 .. MAX(uint8) when value is not WIDGET_ALL.
* @param colour The colour of the highlight, or TC_INVALID for disabling.
* @pre !ScriptGame::IsMultiplayer().
* @pre number != NUMBER_ALL.
* @pre colour < TC_END || (widget == WIDGET_ALL && colour == TC_INVALID).
* @pre IsOpen(window, number).
*/
static void Highlight(WindowClass window, SQInteger number, SQInteger widget, TextColour colour);
// @enum .*Widgets ../../widgets/*_widget.h@ENUM_WIDGETS@
// @endenum
};
#endif /* SCRIPT_WINDOW_HPP */
|