UiBuilderLibrary

A Library that allows for easily creating complex UIs in Rust.
By itself this plugin doesn't really do anything.

Configuration

Default configuration:

{
  "DefaultScreenAspectRatio": 1.7777777777777777, // 16 : 9
  "DefaultRenderScale": 1.0
}

Example

var MyUi = new UI("Overlay", (rootPanel, player) =>
{
  rootPanel.CursorEnabled = true;
  rootPanel.Image.Color = "1 1 1 0.5";
  rootPanel.Bounds.MinX = 0.2;
  rootPanel.Bounds.MaxX = 0.8;
  rootPanel.Bounds.MinY = 0.2;
  rootPanel.Bounds.MaxY = 0.8;

  rootPanel.AddPanel((panel) => {
    // ...
  });
  rootPanel.AddLabel((label) => {
    // ...
  });
  rootPanel.AddButton((button) => {
    // ...
  });
  rootPanel.AddGameImage((gameImage) => {
    // ...
  });
  rootPanel.AddRawImage((rawImage) => {
    // ...
  });
  rootPanel.AddTabs((tabs) => {
    tabs.Vertical = true;
    tabs.AddTab((tab) => {
      // ...
    });
  });
  rootPanel.AddGrid((grid) => {
    grid.Rows = 3;
    grid.Columns = 4;
    for (var i = 0; i < grid.Rows * grid.Columns; i++) {
      grid.AddCell((cell) => {
        // ...
      });
    }
  });
}

MyUi.Open(player);
MyUi.Close(player);

The Render Function

When defining an element, you need to provided a render function for it.This function should perform all of the changes that you want to apply to the element.This includes setting the element's bounds, color and children.

The render function must return a boolean.This boolean indicates whether or not the element's content has changed since the last rendering of the element (it has no effect for the first render).

Dos and Don'ts

Each rendering of an element must add all the same children in the same order. You cannot dynamically add or remove them.

❌ Don't

if (comeCondition) {
  rootPanel.AddPanel((panel) => {});
}

✅ Do

rootPanel.AddPanel((panel) => {
  panel.Visible = comeCondition
});

Development

Bug Report or Feature Request

Open an issue on GitHub.

Want to contribute

Fork and clone the GitHub repository. Send me a PR :)