signs_cmd.cpp

Go to the documentation of this file.

/*
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */
 
#include "stdafx.h"
#include "landscape.h"
#include "company_func.h"
#include "signs_base.h"
#include "signs_func.h"
#include "command_func.h"
#include "tilehighlight_func.h"
#include "viewport_kdtree.h"
#include "window_func.h"
#include "string_func.h"
#include "signs_cmd.h"
 
#include "table/strings.h"
 
#include "safeguards.h"
 
std::tuple<CommandCost, SignID> CmdPlaceSign(DoCommandFlags flags, TileIndex tile, const std::string &text)
{
  /* Try to locate a new sign */
  if (!Sign::CanAllocateItem()) return { CommandCost(STR_ERROR_TOO_MANY_SIGNS), SignID::Invalid() };
 
  /* Check sign text length if any */
  if (Utf8StringLength(text) >= MAX_LENGTH_SIGN_NAME_CHARS) return { CMD_ERROR, SignID::Invalid() };
 
  /* When we execute, really make the sign */
  if (flags.Test(DoCommandFlag::Execute)) {
    int x = TileX(tile) * TILE_SIZE;
    int y = TileY(tile) * TILE_SIZE;
 
    Sign *si = Sign::Create(_game_mode == GM_EDITOR ? OWNER_DEITY : _current_company, x, y, GetSlopePixelZ(x, y), text);
 
    si->UpdateVirtCoord();
    InvalidateWindowData(WC_SIGN_LIST, 0, 0);
    return { CommandCost(), si->index };
  }
 
  return { CommandCost(), SignID::Invalid() };
}
 
CommandCost CmdRenameSign(DoCommandFlags flags, SignID sign_id, const std::string &text, Colours text_colour)
{
  Sign *si = Sign::GetIfValid(sign_id);
  if (si == nullptr) return CMD_ERROR;
  if (!CompanyCanEditSign(si)) return CMD_ERROR;
 
  /* Rename the signs when empty, otherwise remove it */
  if (!text.empty()) {
    if (Utf8StringLength(text) >= MAX_LENGTH_SIGN_NAME_CHARS) return CMD_ERROR;
 
    if (flags.Test(DoCommandFlag::Execute)) {
      /* Assign the new one */
      si->name = text;
      if (text_colour != INVALID_COLOUR) si->text_colour = text_colour;
      if (_game_mode != GM_EDITOR) si->owner = _current_company;
 
      si->UpdateVirtCoord();
      InvalidateWindowData(WC_SIGN_LIST, 0, 1);
    }
  } else { // Delete sign
    if (flags.Test(DoCommandFlag::Execute)) {
      si->sign.MarkDirty();
      if (si->sign.kdtree_valid) _viewport_sign_kdtree.Remove(ViewportSignKdtreeItem::MakeSign(si->index));
      delete si;
 
      InvalidateWindowData(WC_SIGN_LIST, 0, 0);
    }
  }
 
  return CommandCost();
}
 
CommandCost CmdMoveSign(DoCommandFlags flags, SignID sign_id, TileIndex tile)
{
  Sign *si = Sign::GetIfValid(sign_id);
  if (si == nullptr) return CMD_ERROR;
  if (!CompanyCanEditSign(si)) return CMD_ERROR;
 
  /* Move the sign */
  if (flags.Test(DoCommandFlag::Execute)) {
    int x = TileX(tile) * TILE_SIZE;
    int y = TileY(tile) * TILE_SIZE;
 
    si->x = x;
    si->y = y;
    si->z = GetSlopePixelZ(x, y);
    if (_game_mode != GM_EDITOR) si->owner = _current_company;
 
    si->UpdateVirtCoord();
  }
 
  return CommandCost();
}
 
void CcPlaceSign(Commands, const CommandCost &result, SignID new_sign)
{
  if (result.Failed()) return;
 
  ShowRenameSignWindow(Sign::Get(new_sign));
  ResetObjectToPlace();
}
 
void PlaceProc_Sign(TileIndex tile)
{
  Command<CMD_PLACE_SIGN>::Post(STR_ERROR_CAN_T_PLACE_SIGN_HERE, CcPlaceSign, tile, {});
}