Sign (Rising World Plugin API)

public interface Sign

Represents a sign.

See Also:

World.getSign(int)

Example: Heal a player when he interacts with specific signs

1	//We're going to listen for the "ObjectInteractionEvent". This is triggered when
2	//a player interacts with an object (i.e. when he presses the interaction key F
3	//while looking at the object).
4
5	`@`EventMethod
6	public void onObjectInteraction(PlayerObjectInteractionEvent event){
7	//Get the object definition
8	Definitions.ObjectDefinition def = event.getObjectDefinition();
9
10	//Check if the object we're using is a sign
11	if(def.isSign()){
12	//The sign id is stored as "object info", so we can use it to get the sign object
13	Sign sign = getWorld().getSign(event.getObjectInfoID());
14	//Always a good idea to check if sign isn't null...
15	if(sign != null){
16	//Now we check if the first line contains the string "HEAL"
17	if(sign.getLineText(0).contains("HEAL")){
18	//Heal the player, i.e. set his health to 100
19	event.getPlayer().setHealth(100);
20
21	//Cancel the event, so the player cannot edit the sign (optional)
22	event.setCancelled(true);
23	}
24	}
25	}
26	}

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearText()` Clears the text on this sign.
`long`	`getCreationDate()`
`int`	`getID()` Gets the global, unique ID of this sign (or more precisely, of the text on this sign).
`int`	`getLineColor(int line)` Gets the color of a certain line, as RGB hex int.
`java.lang.String`	`getLineText(int line)` Gets the content of a certain line.
`int`	`getNumLines()` Gets the total amount of text lines on this sign.
`int`	`getPlayerDbID()` Gets the database id of the player who set the text on the sign.
`java.lang.String`	`getRawText()` Gets the raw text of the sign, i.e. the text with color codes.
`java.lang.String`	`getText()` Gets the text of this sign.
`void`	`setLine(int line, int color, java.lang.String text)` Changes the text of a certain line.
`void`	`setLine(int line, java.lang.String text)` Changes the text of a certain line (using default black color 0x000000).
`void`	`setText(java.lang.String text)` Sets the text of this sign.

void setLine(int line,
             int color,
             java.lang.String text)

Changes the text of a certain line.

Parameters:

line - the line you want to change (0 for the first line, 1 for the 2nd line etc).

color - the RGB color of the line (format: 0xRRGGBB, e.g. 0x000000 for black, 0xFF0000 for red, 0xFFFFFF for white etc).

text - the text you want to set for this line. Provide an empty string to clear the line.

Example: Change text color on sign to red

1	//We will iterate through all lines and just set the same texts with adjusted colors
2	for(int i = 0; i < sign.getNumLines(); i++){
3	String text = sign.getLineText(i);
4	sign.setLine(i, 0xFF0000, text);
5	}

Interface Sign