Package net.risingworld.api.events.player

Klasse PlayerLocationTickerEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerLocationTickerEvent

Alle implementierten Schnittstellen:

Cancellable

public final class PlayerLocationTickerEvent
extends PlayerEvent
implements Cancellable

Called when the location ticker text (lower left corner of the screen) of the player changes.

Feldübersicht

Von Klasse geerbte Felder net.risingworld.api.events.Event

cancelled, pointer

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
float	getDuration()	Gets the duration (seconds) how long the text should be shown to the player.
String	getLocationTickerText()	Gets the text that should be shown on the location ticker (lower left corner of the screen).
boolean	isCancelled()	Determines if the event is cancelled.
boolean	isLocalized()
void	setCancelled(boolean cancel)	Cancels this event.
void	setDuration(float duration)	Sets the duration (seconds) how long the text should be shown to the player.
void	setLocalized(boolean set)
void	setLocationTickerText(String text, boolean localized)

Von Klasse geerbte Methoden net.risingworld.api.events.player.PlayerEvent

getPlayer

Von Klasse geerbte Methoden net.risingworld.api.events.Event

equals, hashCode, isValid

Von Klasse geerbte Methoden java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methodendetails

getLocationTickerText

public String getLocationTickerText()

Gets the text that should be shown on the location ticker (lower left corner of the screen).

Gibt zurück:

the new location ticker text.

setLocationTickerText

public void setLocationTickerText(String text,
 boolean localized)

isLocalized

public boolean isLocalized()

setLocalized

public void setLocalized(boolean set)

getDuration

public float getDuration()

Gets the duration (seconds) how long the text should be shown to the player.

Gibt zurück:

the duration (seconds) how long the text should be shown to the player.

setDuration

public void setDuration(float duration)

Sets the duration (seconds) how long the text should be shown to the player.

Parameter:

duration - the duration (seconds) how long the text should be shown to the player.

isCancelled

public boolean isCancelled()

Beschreibung aus Schnittstelle kopiert: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e the event will still be executed.

Angegeben von:

isCancelled in Schnittstelle Cancellable

Gibt zurück:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Beschreibung aus Schnittstelle kopiert: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Angegeben von:

setCancelled in Schnittstelle Cancellable

Parameter:

cancel - set to true if you want to cancel this event.

Example: Cancel "PlayerEnterAreaEvent", i.e prevent player from entering an area

1	//Listener class
2	public class PlayerListener implements Listener{
3	@EventMethod
4	public void onEnterArea(PlayerEnterAreaEvent evt){
5	//Now the player will not be able to enter the area, i.e.
6	//he will be teleported back to his old position (outside the area)
7	evt.setCancelled(true);
8	}
9	}