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
8 /** @file script_sign.cpp Implementation of ScriptSign. */
9
10 #include "../../stdafx.h"
11 #include "script_sign.hpp"
12 #include "table/strings.h"
13 #include "../script_instance.hpp"
14 #include "../../signs_base.h"
15 #include "../../string_func.h"
16 #include "../../strings_func.h"
17 #include "../../tile_map.h"
18
19 #include "../../safeguards.h"
20
IsValidSign(SignID sign_id)21 /* static */ bool ScriptSign::IsValidSign(SignID sign_id)
22 {
23 const Sign *si = ::Sign::GetIfValid(sign_id);
24 return si != nullptr && (si->owner == ScriptObject::GetCompany() || si->owner == OWNER_DEITY);
25 }
26
GetOwner(SignID sign_id)27 /* static */ ScriptCompany::CompanyID ScriptSign::GetOwner(SignID sign_id)
28 {
29 if (!IsValidSign(sign_id)) return ScriptCompany::COMPANY_INVALID;
30
31 return static_cast<ScriptCompany::CompanyID>((int)::Sign::Get(sign_id)->owner);
32 }
33
SetName(SignID sign_id,Text * name)34 /* static */ bool ScriptSign::SetName(SignID sign_id, Text *name)
35 {
36 CCountedPtr<Text> counter(name);
37
38 EnforcePrecondition(false, IsValidSign(sign_id));
39 EnforcePrecondition(false, name != nullptr);
40 const char *text = name->GetDecodedText();
41 EnforcePreconditionEncodedText(false, text);
42 EnforcePreconditionCustomError(false, ::Utf8StringLength(text) < MAX_LENGTH_SIGN_NAME_CHARS, ScriptError::ERR_PRECONDITION_STRING_TOO_LONG);
43
44 return ScriptObject::DoCommand(0, sign_id, 0, CMD_RENAME_SIGN, text);
45 }
46
GetName(SignID sign_id)47 /* static */ char *ScriptSign::GetName(SignID sign_id)
48 {
49 if (!IsValidSign(sign_id)) return nullptr;
50
51 ::SetDParam(0, sign_id);
52 return GetString(STR_SIGN_NAME);
53 }
54
GetLocation(SignID sign_id)55 /* static */ TileIndex ScriptSign::GetLocation(SignID sign_id)
56 {
57 if (!IsValidSign(sign_id)) return INVALID_TILE;
58
59 const Sign *sign = ::Sign::Get(sign_id);
60 return ::TileVirtXY(sign->x, sign->y);
61 }
62
RemoveSign(SignID sign_id)63 /* static */ bool ScriptSign::RemoveSign(SignID sign_id)
64 {
65 EnforcePrecondition(false, IsValidSign(sign_id));
66 return ScriptObject::DoCommand(0, sign_id, 0, CMD_RENAME_SIGN, "");
67 }
68
BuildSign(TileIndex location,Text * name)69 /* static */ SignID ScriptSign::BuildSign(TileIndex location, Text *name)
70 {
71 CCountedPtr<Text> counter(name);
72
73 EnforcePrecondition(INVALID_SIGN, ::IsValidTile(location));
74 EnforcePrecondition(INVALID_SIGN, name != nullptr);
75 const char *text = name->GetDecodedText();
76 EnforcePreconditionEncodedText(INVALID_SIGN, text);
77 EnforcePreconditionCustomError(INVALID_SIGN, ::Utf8StringLength(text) < MAX_LENGTH_SIGN_NAME_CHARS, ScriptError::ERR_PRECONDITION_STRING_TOO_LONG);
78
79 if (!ScriptObject::DoCommand(location, 0, 0, CMD_PLACE_SIGN, text, &ScriptInstance::DoCommandReturnSignID)) return INVALID_SIGN;
80
81 /* In case of test-mode, we return SignID 0 */
82 return 0;
83 }
84