OpenTTD Source  20241125-master-g5b02f51e17
signs_func.h File Reference

Functions related to signs. More...

#include "signs_type.h"
#include "tile_type.h"

Go to the source code of this file.

Functions

void UpdateAllSignVirtCoords ()
 Update the coordinates of all signs.
 
void PlaceProc_Sign (TileIndex tile)
 PlaceProc function, called when someone pressed the button if the sign-tool is selected. More...
 
bool CompanyCanRenameSign (const Sign *si)
 Check if the current company can rename a given sign. More...
 
void ShowRenameSignWindow (const Sign *si)
 Show the window to change the text of a sign. More...
 
void HandleClickOnSign (const Sign *si)
 Handle clicking on a sign. More...
 
void DeleteRenameSignWindow (SignID sign)
 Close the sign window associated with the given sign. More...
 
WindowShowSignList ()
 Open the sign list window. More...
 

Detailed Description

Functions related to signs.

Definition in file signs_func.h.

Function Documentation

◆ CompanyCanRenameSign()

bool CompanyCanRenameSign ( const Sign si)

Check if the current company can rename a given sign.

Parameters
*siThe sign in question.
Returns
true if the sign can be renamed, else false.

Definition at line 71 of file signs.cpp.

References _current_company, and OWNER_DEITY.

Referenced by CmdRenameSign(), and HandleClickOnSign().

◆ DeleteRenameSignWindow()

void DeleteRenameSignWindow ( SignID  sign)

Close the sign window associated with the given sign.

Parameters
signThe sign to close the window for.

Definition at line 585 of file signs_gui.cpp.

References Window::Close(), FindWindowById(), WC_QUERY_STRING, and WN_QUERY_STRING_SIGN.

Referenced by Sign::~Sign().

◆ HandleClickOnSign()

void HandleClickOnSign ( const Sign si)

Handle clicking on a sign.

Parameters
siThe sign that was clicked on.

Definition at line 556 of file signs_gui.cpp.

References _ctrl_pressed, _local_company, CompanyCanRenameSign(), and OWNER_DEITY.

◆ PlaceProc_Sign()

void PlaceProc_Sign ( TileIndex  tile)

PlaceProc function, called when someone pressed the button if the sign-tool is selected.

Parameters
tileon which to place the sign

Definition at line 122 of file signs_cmd.cpp.

References CcPlaceSign().

◆ ShowRenameSignWindow()

void ShowRenameSignWindow ( const Sign si)

Show the window to change the text of a sign.

Parameters
siThe sign to show the window for.

Definition at line 573 of file signs_gui.cpp.

References CloseWindowByClass(), and WC_QUERY_STRING.

◆ ShowSignList()

Window* ShowSignList ( )

Open the sign list window.

Returns
newly opened sign list window, or nullptr if the window could not be opened.

Definition at line 392 of file signs_gui.cpp.