Repository navigation
User Interface
Mod screens are written as in tModLoader: a UIState with elements, shown by
a UserInterface, updated in ModSystem.UpdateUI and drawn in a layer added
by ModSystem.ModifyInterfaceLayers.
[Autoload(Side = ModSide.Client)]
public class MyUISystem : ModSystem
{
UserInterface ui;
MyState state;
public override void PostSetupContent()
{
ui = new UserInterface();
state = new MyState();
state.Activate();
ui.SetState(state);
}
public override void UpdateUI(GameTime gameTime)
{
if (ui?.CurrentState != null) ui.Update(gameTime);
}
public override void ModifyInterfaceLayers(List<GameInterfaceLayer> layers)
{
int index = layers.FindIndex(layer => layer.Name.Equals("Vanilla: Mouse Text"));
if (index != -1)
layers.Insert(index, new LegacyGameInterfaceLayer("MyMod: My UI", delegate
{
if (ui?.CurrentState != null) ui.Draw(Main.spriteBatch, new GameTime());
return true;
}, InterfaceScaleType.UI));
}
}Build the screen in PostSetupContent or later: in Load the game has no
screen yet and textures only load on the game thread.
UIElement, UIState, UserInterface, StyleDimension, CalculatedStyle,
the events (OnLeftClick, OnMouseOver...), OverflowHidden, and
UIPanel, UIText, UITextPanel<T>, UIImage, UIImageButton,
UIImageFramed, UIList, UIScrollbar, plus UICommon.TooltipMouseText.
The game's layers keep their PC names (Vanilla: Mouse Text,
Vanilla: Inventory, Vanilla: Resource Bars...); a layer can be turned off
with Active = false.
-
Units. The interface is drawn in UI units: the phone's screen divided by
the interface scale (about 1019×573 on a 1600×900 screen).
UserInterface.GetDimensions()andMain.mouseX/mouseYinsideUpdateuse them. -
Touch. There is no hover: an element is under the finger only while it
is touching. A touch lasts one or two frames, so
UserInterface.Updatereplays every change of the finger since the last update, and the click arrives even when the update skipped that frame. -
Touch regions. The game only gives a touch to the interface inside a
registered region; each
UserInterfacedrawn in a frame registers the area of its top-level elements for the next one. Elements outside those areas get no touch, and the touch keeps going to the world. -
Lists.
UIListscrolls by dragging the finger; a drag is not a click on an item. -
Images. Some PC images do not exist on the phone (
Images/UI/ButtonPlay,ButtonDelete,Scrollbar,ScrollbarInner).UIScrollbardraws plain rectangles without them; a mod that needs the others ships its own copy.
Example: samples/ExampleModCSharp/Common/UI/ExampleCoinsUI (the coins per
minute panel, opened with /coins).
A ModResourceOverlay sees every heart and star the bar draws and can draw
over it, as in tModLoader:
| Hook | When |
|---|---|
PreDrawResource(context) |
before each piece of a heart or star (GUIHearts.HeartDraw, GUIMana.StarDraw); false skips the game's draw |
PostDrawResource(context) |
after it; context.Draw() draws context.texture with the context's position, source, color, rotation, origin, scale and effects |
PreDrawResourceDisplay(snapshot, displaySet, drawingLife, ref textColor, out drawText) |
before the whole life or mana display (GUIHearts.Draw, GUIMana.Draw); false skips it, drawText = false hides the life text |
PostDrawResourceDisplay(...) |
after it |
context.texture is the game's Asset<Texture2D>, so the comparisons of
tModLoader's examples work: asset == TextureAssets.Heart, or
asset == Main.Assets.Request<Texture2D>("Images/UI/PlayerResourceSets/FancyClassic/Heart_Fill")
(the phone's bar uses the same images as the PC's). context.resourceNumber
is the heart or star (0 is the first), context.snapshot has the player's
Life, LifeMax, Mana, ManaMax and AmountOfLifeHearts/AmountOfManaStars.
The phone has no hover text on the bar, so DisplayHoverText is not called,
and drawText only hides the life text.
Bunny Loader wiki ·
Discord ·
Repository ·
BL Editor
Written for Bunny Loader 0.5.5-beta and Terraria Mobile 1.4.5.8.6.
Bunny Loader is not affiliated with Re-Logic or 505 Games.
