Changeset - r22171:03c0cf536b1b
[Not reviewed]
master
0 1 0
alberth - 9 years ago 2015-07-28 08:16:52
alberth@openttd.org
(svn r27344) -Doc: Documenting the (Re)setObjectToPlace functions.
1 file changed with 16 insertions and 0 deletions:
0 comments (0 inline, 0 general)
src/viewport.cpp
Show inline comments
 
@@ -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, 
 

	
 
#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, Pal
 

	
 
}
 

	
 
/** 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);
0 comments (0 inline, 0 general)