tModLoader v2024.10
A mod to make and play Terraria mods
Sign Class Reference

Public Member Functions

override string ToString ()
 

Static Public Member Functions

static void KillSign (int x, int y)
 Kills the Sign at the provided coordinates. Call this in ModLoader.ModTile.KillMultiTile(int, int, int, int) to clean up the Sign instance corresponding to a Main.tileSign tile. More...
 
static int ReadSign (int i, int j, bool CreateIfMissing=true)
 Retrieves the index of the Sign within the Main.sign array that exists at the coordinates provided. Any tile of the 2x2 sign can be passed in. The actual Sign instance is located at the top left corner of the multi-tile. If CreateIfMissing is true the sign will be initialized at the coordinates if it does not exist. Returns -1 if there is no Main.tileSign tile at the provided coordinate, if CreateIfMissing is false and no sign is initialized at the location, or if the sign limit for the world has been reached.
 
static void TextSign (int i, string text)
 Sets the text of the sign corresponding to the given index. Use ReadSign(int, int, bool) to retrieve the index. Behaves similar to Main.sign[i].text = text; except it also handles nulling the sign if it is no longer valid for some reason.
 

Public Attributes

string text
 
int x
 
int y
 

Static Public Attributes

const int maxSigns = 1000
 

Member Function Documentation

◆ KillSign()

static void Sign.KillSign ( int  x,
int  y 
)
static

Kills the Sign at the provided coordinates. Call this in ModLoader.ModTile.KillMultiTile(int, int, int, int) to clean up the Sign instance corresponding to a Main.tileSign tile.

Parameters
x
y