summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2015-07-28 08:16:52 +0000
committeralberth <alberth@openttd.org>2015-07-28 08:16:52 +0000
commit3cd390b2ce2c399492832dc598d9ac1314a20ca8 (patch)
tree668af8533f9a2b601ae604914f04bcc9765b12b9
parent74e61a180630aeccd3da64da218f59bebfc4cc6d (diff)
downloadopenttd-3cd390b2ce2c399492832dc598d9ac1314a20ca8.tar.xz
(svn r27344) -Doc: Documenting the (Re)setObjectToPlace functions.
-rw-r--r--src/viewport.cpp16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/viewport.cpp b/src/viewport.cpp
index 0dfc894f9..a1bb2c81d 100644
--- a/src/viewport.cpp
+++ b/src/viewport.cpp
@@ -3141,6 +3141,13 @@ EventState VpHandlePlaceSizingDrag()
return ES_HANDLED;
}
+/**
+ * Change the cursor and mouse click/drag handling to a mode for performing special operations like tile area selection, object placement, etc.
+ * @param icon New shape of the mouse cursor.
+ * @param pal Palette to use.
+ * @param mode Mode to perform.
+ * @param w %Window requesting the mode change.
+ */
void SetObjectToPlaceWnd(CursorID icon, PaletteID pal, HighLightStyle mode, Window *w)
{
SetObjectToPlace(icon, pal, mode, w->window_class, w->window_number);
@@ -3148,6 +3155,14 @@ void SetObjectToPlaceWnd(CursorID icon, PaletteID pal, HighLightStyle mode, Wind
#include "table/animcursors.h"
+/**
+ * Change the cursor and mouse click/drag handling to a mode for performing special operations like tile area selection, object placement, etc.
+ * @param icon New shape of the mouse cursor.
+ * @param pal Palette to use.
+ * @param mode Mode to perform.
+ * @param window_class %Window class of the window requesting the mode change.
+ * @param window_num Number of the window in its class requesting the mode change.
+ */
void SetObjectToPlace(CursorID icon, PaletteID pal, HighLightStyle mode, WindowClass window_class, WindowNumber window_num)
{
if (_thd.window_class != WC_INVALID) {
@@ -3192,6 +3207,7 @@ void SetObjectToPlace(CursorID icon, PaletteID pal, HighLightStyle mode, WindowC
}
+/** Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows). */
void ResetObjectToPlace()
{
SetObjectToPlace(SPR_CURSOR_MOUSE, PAL_NONE, HT_NONE, WC_MAIN_WINDOW, 0);