script_sign.hpp

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #ifndef SCRIPT_SIGN_HPP
00013 #define SCRIPT_SIGN_HPP
00014 
00015 #include "script_error.hpp"
00016 
00021 class ScriptSign : public ScriptObject {
00022 public:
00026   enum ErrorMessages {
00027 
00029     ERR_SIGN_BASE = ScriptError::ERR_CAT_SIGN << ScriptError::ERR_CAT_BIT_SIZE,
00030 
00032     ERR_SIGN_TOO_MANY_SIGNS,             // [STR_ERROR_TOO_MANY_SIGNS]
00033   };
00034 
00040   static bool IsValidSign(SignID sign_id);
00041 
00052   static bool SetName(SignID sign_id, const char *name);
00053 
00060   static char *GetName(SignID sign_id);
00061 
00068   static TileIndex GetLocation(SignID sign_id);
00069 
00082   static SignID BuildSign(TileIndex location, const char *text);
00083 
00090   static bool RemoveSign(SignID sign_id);
00091 };
00092 
00093 #endif /* SCRIPT_SIGN_HPP */