MovingBlocks

Create an overview of core NUI widgets

Terasology uses its' own NUI framework to display in-game interfaces at overlays - it includes traditional interface elements, or "widgets", such as buttons, textboxes, dropdowns and so on. The NUI tutorial has a Core Widgets wiki page which is empty at the moment. Your task is to add info to it covering the NUI widgets in the org.terasology.rendering.nui.widgets package.

Definition of 'Done'

  • The wiki page contains a complete list of all widgets. (If you don't have wiki access, ask someone or IRC - or use a placeholder wiki in your own repo, we can move the page later.)
  • Each widget has:
    • A short description (what does it do?)
    • An overview of 2-3 API methods (how can a modder interact with it?)
    • [Optional but nice to have] A screenshot of the widget in-game.

Where to start?

  • Inspect the widgets in the org.terasology.rendering.nui.widgets package or search for subtypes of org.terasology.rendering.nui.CoreWidget.
  • The NUI Quick Start guide can be helpful if you want to test a widget yourself.
  • Typing showScreen migTestScreen in the ingame console will display a list of several core widgets - you can use it to take screenshots of the widget.

Task tags

  • wiki
  • documentation
  • java
  • nui
  • writing

Students who completed this task

Quinn Roberts

Task type

  • chrome_reader_mode Documentation / Training
  • web Design
close

2016