Plugin-Erstellung/Java/UILabel Klasse
UILabel Klasse
stellt ein Text-Label für die Java Plugin-API dar. Ein UILabel kann Text auf dem Bildschirm anzeigen und ermöglicht die Anpassung von Schriftart, Schriftgröße, Schriftfarbe, Textausrichtung und weiteren visuellen Eigenschaften.
Die Klasse UILabel erbt von UIElement und wird mit dem Unity UI Toolkit (UITK) gerendert.
Die visuellen Eigenschaften werden über ein Style-Objekt beschrieben.
Dieser Artikel dokumentiert einige wichtige Methoden der UILabel Klasse und zeigt anhand ausgewählter Java-Beispiele, wie diese zu verwenden sind.
Hier sind nicht alle Methoden aufgeführt.
Die vollständige API-Dokumentation mit allen Methoden, Feldern und Konstruktoren ist im JavaDoc zu finden.
Dokumentation
Die Klasse UILabel ist unter JavaDoc: Class UILabel zu finden. Die vollständige API-Dokumentation mit allen Paketen, Klassen, Methoden, Feldern und Konstruktoren ist im JavaDoc zu finden.
Java Paket
In der Java Plugin-API bezeichnet der Begriff "Package" (Paket) eine Gruppierung von zusammengehörigen Klassen, Interfaces und anderen Paketen. Die UILabel Klasse befindet sich im Package net.risingworld.api.ui.
Beispiel Label erstellen
Erstellt ein Label in der oberen Bildschirmmitte mit Text, Schriftart, Schriftgröße, Schriftfarbe und optionaler Hintergrundfarbe.
//Label mit dem Text "Hello World" erzeugen
UILabel label = new UILabel("Hello World");
//Text zentriert darstellen
label.setTextAlign(TextAnchor.MiddleCenter);
//Eine Schriftart, Schriftgröße und Schriftfarbe festlegen
label.setFont(Font.Medieval);
label.setFontSize(64f);
label.setFontColor(0xFFFFFFFF);
//Optional eine Hintergrundfarbe setzen
label.setBackgroundColor(0x000000FF);
//Das UI-Element zum Spieler hinzufügen
player.addUIElement(label);Dieses Beispiel ist unter JavaDoc: Class UILabel - Example: Create a label in the upper center of the screen zu finden.
Beispiel getText
Ruft den aktuell im Label angezeigten Text ab. Die Methode getText() gibt den Text zurück, der entweder über den Konstruktor oder über setText() gesetzt wurde.
//Ein Label mit einem Starttext erzeugen
UILabel label = new UILabel("Starttext");
player.addUIElement(label);
//Den aktuellen Text abfragen
String aktuellerText = label.getText();Die Methode getText() ist unter javadoc RW: Class UILabel - getText() zu finden.
Beispiel setFont
Legt die Schriftart für das Label fest. Die Methode setFont() akzeptiert einen Wert aus der Font-Enumeration und ändert intern die Style-Eigenschaft für die Schriftart.
//Ein Label erzeugen
UILabel label = new UILabel("Text in Medieval-Schrift");
label.setFontSize(32f);
//Die Schriftart auf "Medieval" setzen
label.setFont(Font.Medieval);
//Label zur Spieler-UI hinzufügen
player.addUIElement(label);Die Methode setFont() ist unter javadoc RW: Class UILabel - setFont(Font) zu finden.
Beispiel setFontColor
Legt die Schriftfarbe für das Label fest. Die Methode setFontColor() kann entweder mit vier Float-Werten (RGBA, jeweils 0-1) oder mit einem einzelnen Integer-Wert (RGBA im Hex-Format) aufgerufen werden.
//Ein Label erzeugen
UILabel label = new UILabel("Farbiger Text");
label.setFontSize(32f);
//Schriftfarbe mit RGBA-Werten setzen (Rot: 1, Grün: 0, Blau: 0, Alpha: 1)
label.setFontColor(1.0f, 0.0f, 0.0f, 1.0f);
//Alternativ: Schriftfarbe als Hex-Wert setzen (vollständig undurchsichtiges Rot: 0xFF0000FF)
label.setFontColor(0xFF0000FF);
//Label zur Spieler-UI hinzufügen
player.addUIElement(label);Die Methode setFontColor() mit Codeschnipsel ist unter javadoc RW: Class UILabel - setFontColor(float, float, float, float) zu finden.
Beispiel setText
Ändert den Text eines Labels nach der Erstellung. Die Methode setText() ersetzt den aktuellen Text durch den neuen Text-String.
//Ein leeres Label erzeugen
UILabel label = new UILabel();
label.setFontSize(24f);
//Den Text nachträglich setzen
label.setText("Dieser Text wurde nachträglich gesetzt");
//Label zur Spieler-UI hinzufügen
player.addUIElement(label);Die Methode setText() mit Codeschnipsel ist unter javadoc RW: Class UILabel - setText(String) zu finden.
Beispiel setTextAlign
Legt die Textausrichtung innerhalb des Labels fest. Die Methode setTextAlign() akzeptiert einen Wert aus der TextAnchor-Enumeration und ändert intern die Style-Eigenschaft für die Textausrichtung.
//Ein Label erzeugen
UILabel label = new UILabel("Hello World");
label.setBackgroundColor(0x000000FF);
label.setFontColor(0xFFFFFFFF);
label.setFontSize(32f);
//Text zentriert ausrichten
label.setTextAlign(TextAnchor.MiddleCenter);
//Label zur Spieler-UI hinzufügen
player.addUIElement(label);Die Methode setTextAlign() mit Codeschnipsel ist unter javadoc RW: Class UILabel - setTextAlign(TextAnchor) zu finden.
Beispiel setTextWrap
Aktiviert oder deaktiviert den automatischen Textumbruch für das Label. Die Methode setTextWrap() steuert, ob langer Text automatisch umbrochen wird oder über den Rand hinausreicht.
//Ein Label erzeugen
UILabel label = new UILabel("Dieser Text ist sehr lang und sollte automatisch umgebrochen werden, wenn der Textumbruch aktiviert ist");
label.setFontSize(16f);
label.setSize(300, 100, false);
//Automatischen Textumbruch aktivieren
label.setTextWrap(true);
//Label zur Spieler-UI hinzufügen
player.addUIElement(label);Die Methode setTextWrap() ist unter javadoc RW: Class UILabel - setTextWrap(boolean) zu finden.
Siehe auch
- UIElement Klasse – Basisklasse für alle UI-Elemente
- Erstellung eines JAVA Plugin-Projekts für Rising World in Eclipse
- Wiki Kategorie: "Java"
- Wiki Kategorie: "Plugin-API"
API Dokumentation
- JavaDoc RW: API Package summary
- JavaDoc RW: Class UILabel
- JavaDoc RW: Package UI
- JavaDoc RW: Class Font (für Schriftarten)
- JavaDoc RW: Class TextAnchor (für Textausrichtung)
Forum
- Rising World Forum: Getting started
- Rising World Forum: Create a Plugin
- Rising World Forum: Code Schnipsel
Kategorien
| Tutorial Kategorien
Tutorial (5 S) |
Plugin-Erstellung
|
