tron@2186: /* $Id$ */
tron@2186: 
richk@10724: /** @file signs.cpp Handling of signs. */
richk@6719: 
truelight@988: #include "stdafx.h"
Darkvater@1891: #include "openttd.h"
richk@6719: #include "landscape.h"
rubidium@6872: #include "player_func.h"
richk@10184: #include "signs_base.h"
richk@10184: #include "signs_func.h"
truelight@988: #include "saveload.h"
rubidium@6872: #include "command_func.h"
tron@2153: #include "variables.h"
rubidium@6872: #include "strings_func.h"
rubidium@6872: #include "viewport_func.h"
richk@10724: #include "tilehighlight_func.h"
rubidium@6872: #include "zoom_func.h"
rubidium@6872: #include "functions.h"
rubidium@6872: #include "window_func.h"
rubidium@6872: #include "map_func.h"
rubidium@6872: #include "string_func.h"
richk@10184: #include "oldpool_func.h"
rubidium@6872: 
rubidium@6872: #include "table/strings.h"
truelight@988: 
richk@6732: SignID _new_sign_id;
rubidium@6872: bool _sign_sort_dirty;
tron@2789: 
richk@6743: /* Initialize the sign-pool */
richk@6743: DEFINE_OLD_POOL_GENERIC(Sign, Sign)
richk@6743: 
rubidium@6872: Sign::Sign(PlayerID owner)
truelight@1283: {
rubidium@6872: 	this->owner = owner;
truelight@1283: }
truelight@1283: 
richk@6743: Sign::~Sign()
richk@6743: {
rubidium@6872: 	free(this->name);
rubidium@6872: 	this->owner = INVALID_PLAYER;
richk@6743: }
richk@6743: 
truelight@988: /**
truelight@988:  *
truelight@988:  * Update the coordinate of one sign
richk@6719:  * @param si Pointer to the Sign
truelight@988:  *
truelight@988:  */
truelight@4349: static void UpdateSignVirtCoords(Sign *si)
truelight@988: {
truelight@4349: 	Point pt = RemapCoords(si->x, si->y, si->z);
richk@6720: 	SetDParam(0, si->index);
truelight@4349: 	UpdateViewportSignPos(&si->sign, pt.x, pt.y - 6, STR_2806);
truelight@988: }
truelight@988: 
truelight@988: /**
truelight@988:  *
truelight@990:  * Update the coordinates of all signs
truelight@988:  *
truelight@988:  */
rubidium@6573: void UpdateAllSignVirtCoords()
truelight@988: {
truelight@4349: 	Sign *si;
truelight@988: 
truelight@4349: 	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);
truelight@988: 
truelight@988: }
truelight@988: 
truelight@988: /**
rubidium@6870:  * Marks the region of a sign as dirty.
truelight@988:  *
rubidium@6870:  * This function marks the sign in all viewports as dirty for repaint.
truelight@988:  *
truelight@4349:  * @param si Pointer to the Sign
rubidium@6870:  * @ingroup dirty
truelight@988:  */
truelight@4349: static void MarkSignDirty(Sign *si)
truelight@988: {
richk@6719: 	/* We use ZOOM_LVL_MAX here, as every viewport can have an other zoom,
richk@6719: 		*  and there is no way for us to know which is the biggest. So make the
richk@6719: 		*  biggest area dirty, and we are safe for sure. */
truelight@988: 	MarkAllViewportsDirty(
truelight@4349: 		si->sign.left - 6,
truelight@4349: 		si->sign.top  - 3,
richk@6719: 		si->sign.left + ScaleByZoom(si->sign.width_1 + 12, ZOOM_LVL_MAX),
richk@6719: 		si->sign.top  + ScaleByZoom(12, ZOOM_LVL_MAX));
truelight@988: }
truelight@988: 
truelight@988: /**
truelight@4400:  * Place a sign at the given coordinates. Ownership of sign has
Darkvater@1793:  * no effect whatsoever except for the colour the sign gets for easy recognition,
Darkvater@1793:  * but everybody is able to rename/remove it.
tron@3491:  * @param tile tile to place sign at
richk@6719:  * @param flags type of operation
Darkvater@1793:  * @param p1 unused
Darkvater@1793:  * @param p2 unused
truelight@988:  */
richk@6720: CommandCost CmdPlaceSign(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@988: {
truelight@988: 	/* Try to locate a new sign */
richk@10724: 	if (!Sign::CanAllocateItem()) return_cmd_error(STR_2808_TOO_MANY_SIGNS);
truelight@988: 
truelight@988: 	/* When we execute, really make the sign */
truelight@988: 	if (flags & DC_EXEC) {
richk@10724: 		Sign *si = new Sign(_current_player);
tron@3491: 		int x = TileX(tile) * TILE_SIZE;
tron@3491: 		int y = TileY(tile) * TILE_SIZE;
tron@3491: 
truelight@4349: 		si->x = x;
truelight@4349: 		si->y = y;
richk@6719: 		si->z = GetSlopeZ(x, y);
truelight@4349: 		UpdateSignVirtCoords(si);
truelight@4349: 		MarkSignDirty(si);
truelight@1575: 		InvalidateWindow(WC_SIGN_LIST, 0);
truelight@1575: 		_sign_sort_dirty = true;
richk@6732: 		_new_sign_id = si->index;
truelight@988: 	}
truelight@988: 
richk@6720: 	return CommandCost();
truelight@988: }
truelight@988: 
Darkvater@1793: /** Rename a sign. If the new name of the sign is empty, we assume
Darkvater@1793:  * the user wanted to delete it. So delete it. Ownership of signs
Darkvater@1793:  * has no meaning/effect whatsoever except for eyecandy
tron@3491:  * @param tile unused
richk@6719:  * @param flags type of operation
Darkvater@1793:  * @param p1 index of the sign to be renamed/removed
Darkvater@1793:  * @param p2 unused
richk@6719:  * @return 0 if succesfull, otherwise CMD_ERROR
truelight@988:  */
richk@6720: CommandCost CmdRenameSign(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@988: {
truelight@4352: 	if (!IsValidSignID(p1)) return CMD_ERROR;
Darkvater@1837: 
Darkvater@1837: 	/* If _cmd_text 0 means the new text for the sign is non-empty.
Darkvater@1793: 	 * So rename the sign. If it is empty, it has no name, so delete it */
rubidium@6868: 	if (!StrEmpty(_cmd_text)) {
truelight@988: 		if (flags & DC_EXEC) {
truelight@4349: 			Sign *si = GetSign(p1);
truelight@988: 
truelight@988: 			/* Delete the old name */
rubidium@6872: 			free(si->name);
truelight@988: 			/* Assign the new one */
rubidium@6872: 			si->name = strdup(_cmd_text);
truelight@4349: 			si->owner = _current_player;
truelight@988: 
Darkvater@1793: 			/* Update; mark sign dirty twice, because it can either becom longer, or shorter */
truelight@4349: 			MarkSignDirty(si);
truelight@4349: 			UpdateSignVirtCoords(si);
truelight@4349: 			MarkSignDirty(si);
truelight@1575: 			InvalidateWindow(WC_SIGN_LIST, 0);
truelight@1575: 			_sign_sort_dirty = true;
truelight@988: 		}
richk@6719: 	} else { // Delete sign
truelight@988: 		if (flags & DC_EXEC) {
truelight@4349: 			Sign *si = GetSign(p1);
truelight@988: 
truelight@4384: 			MarkSignDirty(si);
richk@6743: 			delete si;
truelight@988: 
truelight@1575: 			InvalidateWindow(WC_SIGN_LIST, 0);
truelight@1575: 			_sign_sort_dirty = true;
truelight@988: 		}
truelight@988: 	}
truelight@988: 
richk@6720: 	return CommandCost();
truelight@988: }
truelight@988: 
truelight@988: /**
truelight@988:  * Callback function that is called after a sign is placed
richk@6719:  * @param success of the operation
richk@6719:  * @param tile unused
richk@6719:  * @param p1 unused
richk@6719:  * @param p2 unused
truelight@988:  */
tron@1977: void CcPlaceSign(bool success, TileIndex tile, uint32 p1, uint32 p2)
truelight@988: {
truelight@988: 	if (success) {
richk@6732: 		ShowRenameSignWindow(GetSign(_new_sign_id));
truelight@988: 		ResetObjectToPlace();
truelight@988: 	}
truelight@988: }
truelight@988: 
truelight@988: /**
truelight@988:  *
truelight@988:  * PlaceProc function, called when someone pressed the button if the
truelight@988:  *  sign-tool is selected
richk@6719:  * @param tile on which to place the sign
truelight@988:  */
tron@1977: void PlaceProc_Sign(TileIndex tile)
truelight@988: {
tron@2783: 	DoCommandP(tile, 0, 0, CcPlaceSign, CMD_PLACE_SIGN | CMD_MSG(STR_2809_CAN_T_PLACE_SIGN_HERE));
truelight@988: }
truelight@988: 
truelight@988: /**
truelight@988:  *
truelight@988:  * Initialize the signs
truelight@988:  *
truelight@988:  */
rubidium@6573: void InitializeSigns()
truelight@988: {
richk@6743: 	_Sign_pool.CleanPool();
richk@6743: 	_Sign_pool.AddBlockToPool();
truelight@988: }
truelight@988: 
Darkvater@1881: static const SaveLoad _sign_desc[] = {
rubidium@6872:   SLE_CONDVAR(Sign, name,  SLE_NAME,                   0, 83),
rubidium@6872:   SLE_CONDSTR(Sign, name,  SLE_STR, 0,                84, SL_MAX_VERSION),
truelight@4349:   SLE_CONDVAR(Sign, x,     SLE_FILE_I16 | SLE_VAR_I32, 0, 4),
truelight@4349:   SLE_CONDVAR(Sign, y,     SLE_FILE_I16 | SLE_VAR_I32, 0, 4),
truelight@4349:   SLE_CONDVAR(Sign, x,     SLE_INT32,                  5, SL_MAX_VERSION),
truelight@4349:   SLE_CONDVAR(Sign, y,     SLE_INT32,                  5, SL_MAX_VERSION),
truelight@4349:   SLE_CONDVAR(Sign, owner, SLE_UINT8,                  6, SL_MAX_VERSION),
truelight@4349:       SLE_VAR(Sign, z,     SLE_UINT8),
truelight@988: 	SLE_END()
truelight@988: };
truelight@988: 
truelight@988: /**
truelight@988:  *
truelight@988:  * Save all signs
truelight@988:  *
truelight@988:  */
rubidium@6573: static void Save_SIGN()
truelight@988: {
truelight@4349: 	Sign *si;
truelight@988: 
truelight@4349: 	FOR_ALL_SIGNS(si) {
truelight@4349: 		SlSetArrayIndex(si->index);
truelight@4349: 		SlObject(si, _sign_desc);
truelight@988: 	}
truelight@988: }
truelight@988: 
truelight@988: /**
truelight@988:  *
truelight@988:  * Load all signs
truelight@988:  *
truelight@988:  */
rubidium@6573: static void Load_SIGN()
truelight@988: {
truelight@988: 	int index;
truelight@988: 	while ((index = SlIterateArray()) != -1) {
richk@6743: 		Sign *si = new (index) Sign();
truelight@4349: 		SlObject(si, _sign_desc);
truelight@988: 	}
truelight@1575: 
truelight@1575: 	_sign_sort_dirty = true;
truelight@988: }
truelight@988: 
rubidium@5838: extern const ChunkHandler _sign_chunk_handlers[] = {
truelight@988: 	{ 'SIGN', Save_SIGN, Load_SIGN, CH_ARRAY | CH_LAST},
truelight@988: };