OpenTTD Source: src/signs_cmd.cpp Source File

OpenTTD Source 1.11.0-RC1

signs_cmd.cpp
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10 #include "stdafx.h"
11 #include "landscape.h"
12 #include "company_func.h"
13 #include "signs_base.h"
14 #include "signs_func.h"
15 #include "command_func.h"
16 #include "tilehighlight_func.h"
17 #include "viewport_kdtree.h"
18 #include "window_func.h"
19 #include "string_func.h"
20
21 #include "table/strings.h"
22
23 #include "safeguards.h"
24
26 SignID _new_sign_id;
27
39 CommandCost CmdPlaceSign(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
40 {
41 /* Try to locate a new sign */
42 if (!Sign::CanAllocateItem()) return_cmd_error(STR_ERROR_TOO_MANY_SIGNS);
43
44 /* Check sign text length if any */
45 if (!StrEmpty(text) && Utf8StringLength(text) >= MAX_LENGTH_SIGN_NAME_CHARS) return CMD_ERROR;
46
47 /* When we execute, really make the sign */
48 if (flags & DC_EXEC) {
49 Sign *si = new Sign(_game_mode == GM_EDITOR ? OWNER_DEITY : _current_company);
50 int x = TileX(tile) * TILE_SIZE;
51 int y = TileY(tile) * TILE_SIZE;
52
53 si->x = x;
54 si->y = y;
55 si->z = GetSlopePixelZ(x, y);
56 if (!StrEmpty(text)) {
57 si->name = stredup(text);
58 }
59 si->UpdateVirtCoord();
60 InvalidateWindowData(WC_SIGN_LIST, 0, 0);
61 _new_sign_id = si->index;
62 }
63
64 return CommandCost();
65 }
66
78 CommandCost CmdRenameSign(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
79 {
80 Sign *si = Sign::GetIfValid(p1);
81 if (si == nullptr) return CMD_ERROR;
82 if (si->owner == OWNER_DEITY && _current_company != OWNER_DEITY && _game_mode != GM_EDITOR) return CMD_ERROR;
83
84 /* Rename the signs when empty, otherwise remove it */
85 if (!StrEmpty(text)) {
86 if (Utf8StringLength(text) >= MAX_LENGTH_SIGN_NAME_CHARS) return CMD_ERROR;
87
88 if (flags & DC_EXEC) {
89 /* Assign the new one */
90 si->name = text;
91 if (_game_mode != GM_EDITOR) si->owner = _current_company;
92
93 si->UpdateVirtCoord();
94 InvalidateWindowData(WC_SIGN_LIST, 0, 1);
95 }
96 } else { // Delete sign
97 if (flags & DC_EXEC) {
98 si->sign.MarkDirty();
99 if (si->sign.kdtree_valid) _viewport_sign_kdtree.Remove(ViewportSignKdtreeItem::MakeSign(si->index));
100 delete si;
101
102 InvalidateWindowData(WC_SIGN_LIST, 0, 0);
103 }
104 }
105
106 return CommandCost();
107 }
108
117 void CcPlaceSign(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
118 {
119 if (result.Failed()) return;
120
121 ShowRenameSignWindow(Sign::Get(_new_sign_id));
122 ResetObjectToPlace();
123 }
124
131 void PlaceProc_Sign(TileIndex tile)
132 {
133 DoCommandP(tile, 0, 0, CMD_PLACE_SIGN | CMD_MSG(STR_ERROR_CAN_T_PLACE_SIGN_HERE), CcPlaceSign);
134 }
CMD_MSG
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:372
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
InvalidateWindowData
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition: window.cpp:3321
CmdRenameSign
CommandCost CmdRenameSign(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Rename a sign.
Definition: signs_cmd.cpp:78
Pool::PoolItem<&_sign_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:329
command_func.h
Pool::PoolItem<&_sign_pool >::GetIfValid
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:340
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:23
signs_func.h
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:227
MAX_LENGTH_SIGN_NAME_CHARS
static const uint MAX_LENGTH_SIGN_NAME_CHARS
The maximum length of a sign name in characters including '\0'.
Definition: signs_type.h:19
WC_SIGN_LIST
@ WC_SIGN_LIST
Sign list; Window numbers:
Definition: window_type.h:271
TILE_SIZE
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:13
TileY
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:215
DC_EXEC
@ DC_EXEC
execute the given command
Definition: command_type.h:348
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:346
TileX
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:205
Kdtree::Remove
void Remove(const T &element)
Remove a single element from the tree, if it exists.
Definition: kdtree.hpp:419
Utf8StringLength
size_t Utf8StringLength(const char *s)
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes th...
Definition: string.cpp:334
return_cmd_error
#define return_cmd_error(errcode)
Returns from a function with a specific StringID as error.
Definition: command_func.h:33
CommandCost
Common return value for all commands.
Definition: command_type.h:23
tilehighlight_func.h
DoCommandP
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:541
CcPlaceSign
void CcPlaceSign(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
Callback function that is called after a sign is placed.
Definition: signs_cmd.cpp:117
Sign::UpdateVirtCoord
void UpdateVirtCoord()
Update the coordinate of one sign.
Definition: signs.cpp:45
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition: command_type.h:159
ViewportSign::MarkDirty
void MarkDirty(ZoomLevel maxzoom=ZOOM_LVL_MAX) const
Mark the sign dirty in all viewports.
Definition: viewport.cpp:1466
safeguards.h
_new_sign_id
SignID _new_sign_id
The last built sign.
Definition: signs_cmd.cpp:26
StrEmpty
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:60
stdafx.h
landscape.h
string_func.h
_current_company
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
TrackedViewportSign::kdtree_valid
bool kdtree_valid
Are the sign data valid for use with the _viewport_sign_kdtree?
Definition: viewport_type.h:58
Pool::PoolItem<&_sign_pool >::CanAllocateItem
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
Definition: pool_type.hpp:299
Sign
Definition: signs_base.h:22
PlaceProc_Sign
void PlaceProc_Sign(TileIndex tile)
PlaceProc function, called when someone pressed the button if the sign-tool is selected.
Definition: signs_cmd.cpp:131
OWNER_DEITY
@ OWNER_DEITY
The object is owned by a superuser / goal script.
Definition: company_type.h:27
company_func.h
CmdPlaceSign
CommandCost CmdPlaceSign(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Place a sign at the given coordinates.
Definition: signs_cmd.cpp:39
stredup
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Definition: string.cpp:137
window_func.h
ShowRenameSignWindow
void ShowRenameSignWindow(const Sign *si)
Show the window to change the text of a sign.
Definition: signs_gui.cpp:577
ResetObjectToPlace
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Definition: viewport.cpp:3421
CMD_PLACE_SIGN
@ CMD_PLACE_SIGN
place a sign
Definition: command_type.h:251
signs_base.h
SignID
uint16 SignID
The type of the IDs of signs.
Definition: signs_type.h:14