You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
84 lines
3.0 KiB
C++
84 lines
3.0 KiB
C++
/*
|
|
* 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_sign.cpp Implementation of ScriptSign. */
|
|
|
|
#include "../../stdafx.h"
|
|
#include "script_sign.hpp"
|
|
#include "table/strings.h"
|
|
#include "../script_instance.hpp"
|
|
#include "../../signs_base.h"
|
|
#include "../../string_func.h"
|
|
#include "../../strings_func.h"
|
|
#include "../../tile_map.h"
|
|
|
|
#include "../../safeguards.h"
|
|
|
|
/* static */ bool ScriptSign::IsValidSign(SignID sign_id)
|
|
{
|
|
const Sign *si = ::Sign::GetIfValid(sign_id);
|
|
return si != nullptr && (si->owner == ScriptObject::GetCompany() || si->owner == OWNER_DEITY);
|
|
}
|
|
|
|
/* static */ ScriptCompany::CompanyID ScriptSign::GetOwner(SignID sign_id)
|
|
{
|
|
if (!IsValidSign(sign_id)) return ScriptCompany::COMPANY_INVALID;
|
|
|
|
return static_cast<ScriptCompany::CompanyID>((int)::Sign::Get(sign_id)->owner);
|
|
}
|
|
|
|
/* static */ bool ScriptSign::SetName(SignID sign_id, Text *name)
|
|
{
|
|
CCountedPtr<Text> counter(name);
|
|
|
|
EnforcePrecondition(false, IsValidSign(sign_id));
|
|
EnforcePrecondition(false, name != nullptr);
|
|
const char *text = name->GetDecodedText();
|
|
EnforcePreconditionEncodedText(false, text);
|
|
EnforcePreconditionCustomError(false, ::Utf8StringLength(text) < MAX_LENGTH_SIGN_NAME_CHARS, ScriptError::ERR_PRECONDITION_STRING_TOO_LONG);
|
|
|
|
return ScriptObject::DoCommand(0, sign_id, 0, CMD_RENAME_SIGN, text);
|
|
}
|
|
|
|
/* static */ char *ScriptSign::GetName(SignID sign_id)
|
|
{
|
|
if (!IsValidSign(sign_id)) return nullptr;
|
|
|
|
::SetDParam(0, sign_id);
|
|
return GetString(STR_SIGN_NAME);
|
|
}
|
|
|
|
/* static */ TileIndex ScriptSign::GetLocation(SignID sign_id)
|
|
{
|
|
if (!IsValidSign(sign_id)) return INVALID_TILE;
|
|
|
|
const Sign *sign = ::Sign::Get(sign_id);
|
|
return ::TileVirtXY(sign->x, sign->y);
|
|
}
|
|
|
|
/* static */ bool ScriptSign::RemoveSign(SignID sign_id)
|
|
{
|
|
EnforcePrecondition(false, IsValidSign(sign_id));
|
|
return ScriptObject::DoCommand(0, sign_id, 0, CMD_RENAME_SIGN, "");
|
|
}
|
|
|
|
/* static */ SignID ScriptSign::BuildSign(TileIndex location, Text *name)
|
|
{
|
|
CCountedPtr<Text> counter(name);
|
|
|
|
EnforcePrecondition(INVALID_SIGN, ::IsValidTile(location));
|
|
EnforcePrecondition(INVALID_SIGN, name != nullptr);
|
|
const char *text = name->GetDecodedText();
|
|
EnforcePreconditionEncodedText(INVALID_SIGN, text);
|
|
EnforcePreconditionCustomError(INVALID_SIGN, ::Utf8StringLength(text) < MAX_LENGTH_SIGN_NAME_CHARS, ScriptError::ERR_PRECONDITION_STRING_TOO_LONG);
|
|
|
|
if (!ScriptObject::DoCommand(location, 0, 0, CMD_PLACE_SIGN, text, &ScriptInstance::DoCommandReturnSignID)) return INVALID_SIGN;
|
|
|
|
/* In case of test-mode, we return SignID 0 */
|
|
return 0;
|
|
}
|