Uncreated.UI 1.0.0

Releases are available from the NuGet package.

Uncreated.UI

Object oriented abstraction for Unturned's server-side UI API (EffectManager).

This library was built for Uncreated Warfare but can be used for any projects in correspondence with the GPL-3.0 license.

You must be targeting .NET Standard 2.1 to use this library. This means the netstandard.dll library must be included in your Libraries folder from the correct Unity installation. You must also be using UniTask (do NOT download the UniTask from this repository). OpenMod comes with UniTask pre-installed and you can use RocketExtensions by ShimmyMySherbet if you're using RocketMod. Alternatively you can use my Unturned UniTask fork and follow the instructions in the README for that repository. Finally this library references Microsoft.Extensions.Logging.Abstractions 3.1.0 (netstandard2.0) and DanielWillett.ReflectionTools 3.1.0 (netstandard2.1) which can be downloaded from NuGet.

Creating a simple UI

Simple UIs that use only formatting arguments can be defined without creating a new class.

public static UnturnedUI ExampleUI { get; private set; }

// if you want to support reloading you should dispose it on unload.
protected override void Load()
{
    ExampleUI = new UnturnedUI(new Guid("a695abdc9b0947d9ad0cd45d1b7a9931"));
}
protected override void Unload()
{
    ExampleUI.Dispose();
}

Creating a complex UI

In a dependency-injection environment, this object would be registered as a singleton, otherwise a static field or property would work fine.

All properties and fields (public and private) are registered as UI elements unless they're marked with [Ignore] or are compiler-generated.

UnturnedUI implements IDisposable which will clean up any event handlers and should be done on plugin unload or by the service container.

Int16 keys are generated automatically and simply increment for each UI created. keyless can be set to true to use a key of -1, which allows using Lifetime + Lifetime_Spread and prevents any further changes of the UI once it's sent. UIs will not respect their lifetime unless they are keyless.

Most 'fire-and-forget' methods like sending a UI or setting text can be invoked from another thread and will be queued to run on the main thread on the next frame. Check the XML docs to be sure.

public class ExampleUI : UnturnedUI
{

    public UnturnedLabel QuestionLabel { get; } = new UnturnedLabel("Canvas/Question");

    public UnturnedButton AcceptButton { get; } = new UnturnedButton("Canvas/Accept");

    public UnturnedButton CancelButton { get; } = new UnturnedButton("Canvas/Cancel");
    
                                                                         // some extra optional configuration options
    public ExampleUI() : base(new Guid("64615dc226f940da8fc356972f45d5f8"), hasElements: true, keyless: false, reliable: true, debugLogging: false)
    {
        AcceptButton.OnClicked += OnAcceptButtonClicked;
        CancelButton.OnClicked += OnCancelButtonClicked;
    }

    public void SendQuestion(Player player, string question)
    {
        // if QuestionLabel's unity text is '{0}'
        this.SendToPlayer(player, question);

        // if it's not, or you want an example to use in a README, you can do it separately
        this.SendToPlayer(player);
        QuestionLabel.SetText(player, question);
    }

    public void OnAcceptButtonClicked(UnturnedButton button, Player player)
    {
        this.ClearFromPlayer(player);
        // implementation not shown
    }

    public void OnCancelButtonClicked(UnturnedButton button, Player player)
    {
        this.ClearFromPlayer(player);
        // implementation not shown
    }
}

Late Registration

Sometimes you may have to define an element in the constructor. Since the base constructor does all the element discovery, any other elements have to be manually registered.

public class ExampleUI : UnturnedUI
{
    public UnturnedLabel Label { get; }

    public ExampleUI() : base(0)
    {
        Label = new UnturnedLabel("Path/To/Element");

        // this also works with enumerables, presets, and patterns.
        this.LateRegisterElement(Label);
    }
}

UI Paths

You may have noticed that in the first example, UI elements are defined using paths. Most UI methods in Unturned allow you to pass a hierarchy path for performance reasons instead of just the name.

Button and text box names still must be unique across all active UIs in the server. This is an Unturned limitation.

UI's can add a base path to which all paths are appended to.

Paths in a UI with a base path can use ~/ to ignore the base path.

Relative path symbols like ../ and ./ can be used but the destination must fall within the UI for obvious reasons.

[UnturnedUI(BasePath = "Canvas/Image")]
public class ExampleUI : UnturnedUI
{

    // actual path: Canvas/Image/TestLabel
    public UnturnedLabel TestLabel { get; } = new UnturnedLabel("TestLabel");
    
    // actual path: TestElement
    public UnturnedUIElement TestElement { get; } = new UnturnedUIElement("~/TestElement");
    
    // implementation not shown
}

UI Data

Specific data structures can be linked to UI elements and players. This is how the UnturnedEnumButton, UnturnedToggle, and UnturnedTextBox keep track of player data.

The default UI data tracker can be accessed or changed using UnturnedUIDataSource.Instance { get; set; }. Most of its functions are not thread-safe. Check XML comments to be sure.

The Element can also be null so the data is just linked to the UI object itself.

Creating Custom Data

public class CustomUIData : IUnturnedUIData
{
    // Required by the interface
    public CSteamID Player { get; }
    public UnturnedUIElement Element { get; }
    public UnturnedUI Owner => Element.Owner;

    // custom data, can be basically any type
    public string? Data { get; set; }

    public CustomUIData(CSteamID playerId, UnturnedUIElement element, string? data)
    {
        Player = playerId;
        Element = element;
        Data = data;
    }
}

Using Custom Data

Data can be accessed, added, or removed using the static helper functions in UnturnedUIDataSource.

// in a UI class
public void OnSomethingHappened(Player player)
{
    CustomUIData? dataObject = UnturnedUIDataSource.GetData<CustomUIData>(player.channel.owner.playerID.steamID, this.SomeElement);
    if (dataObject == null)
    {
        dataObject = new CustomUIData(player.channel.owner.playerID.steamID, this.SomeElement, "new data");
        UnturnedUIDataSource.AddData(dataObject);
    }
    else
    {
        // since the data is a class theres no need to save the changes or anything
        dataObject.Data = "something happened again";
    }

    _logger.LogInformation("Player {0}'s data value is now {1}.", player.channel.owner.playerID.playerName, dataObject.Data);
    this.SomeElement.SetText(dataObject.Data);
}

Patterns

Create your own data types and fill lists of them automatically using patterns.

Currently only primitive types and other patterns are supported, none of the built-in presets can be used.

public class ExampleUI : UnturnedUI
{
    // the {0} in this name will be replaced by the index, in this case 1-10 inclusive. You can also supply a 'length' instead of 'to'.
    public PlayerListElement[] PlayerListElements { get; }
        = ElementPatterns.CreateArray<PlayerListElement>("PlayerList/Player_{0}", 1, to: 10);
        
    public class PlayerListElement
    {
        // marking an element as Root will put all other objects below this one. Only one object can be a root.

        // actual path PlayerList/Player_#
        [Pattern(Root = true)]
        public UnturnedUIElement Root { get; set; }

        // actual path PlayerList/Player_#/Name_#
        [Pattern("Name_{0}")]
        public UnturnedLabel Name { get; set; }

        // actual path PlayerList/Player_#/SteamID_#
        [Pattern("SteamID_{0}")]
        public UnturnedLabel SteamId { get; set; }
    }
}

Format Modes

Different format modes can be used for defining how the names are created.

Most examples will use Replace with a root element, which is why replace is default.

Sometimes, Format may be used instead, which will replace {1} with the pattern name in the base path.

public TestClass[] Elements { get; } = ElementPatterns.CreateArray<TestClass>("Test/{0}/Class_{1}", 1, to: 10);
        
public class TestClass
{
    // marking an element as Root will put all other objects below this one. Only one object can be a root.

    // actual path Test/#/Class
    //   setting the CleanJoin character fixes the extra underscore from formatting in an empty string
    [Pattern("", Mode = FormatMode.Format, CleanJoin = '_')]
    public UnturnedUIElement Root { get; set; }

    // actual path Test/#/Class_Name
    [Pattern("Name", Mode = FormatMode.Format)]
    public UnturnedLabel Name { get; set; }
    
    // actual path Test/#/Class_SteamID
    [Pattern("SteamID", Mode = FormatMode.Format)]
    public UnturnedLabel SteamId { get; set; }
}

The others available are Suffix and Prefix.

Suffix simply adds the value after the base path and prefix adds it before.

Array Patterns

The ArrayPattern attribute can be used to create multiple nested pattern in a pattern class.

[ArrayPattern(1, To = 4)]
[Pattern(Item_{0})]
public ElementType[] Elements { get; }

Logging and Dependency Injection

ILogger or ILoggerFactory instances from Microsoft.Extensions.Logging can also be supplied to the first argument of the constructors of all built-in element and preset types.

If a logger isn't supplied, GlobalLogger.Instance will be used instead, which is a static property that can be set at any time (but won't be updated on already existing UIs). It defaults to NullLogger.Instance;

All UI classes should usually be created as singleton services that will last the lifetime of the plugin.

This is because they use keys that increment each time a UI is created and if they're not singletons will change their key each time.

Also in this way, services can be injected into the parent class (like a configuration that stores the effect ID, a logger for debug logging, etc.) and used in the base constructor.

Built in Types

The library comes with some built-in primitive element types and common preset types.

Primitives

These are concrete classes that represent individual GameObjects.

* UnturnedTextBox has a property, UseData which enables tracking the text players enter so it can be retrieved at any time.

Presets

These are concrete classes that are made up of a few primitives.

Some classes are just combinations of their simpler counterparts and have no description.

If there are multiple elements in the constructor of the preset, all the paths of the remaining ones can be relative of the first one if ./ or ../ is added to the front of the path.

• A new LabeledButton("Canvas/ActionButton", "./Label") will create a Button at Canvas/ActionButton and a label at Canvas/ActionButton/Label.

• A new LabeledButton("Canvas/ActionButton", "../Label") will create a Button at Canvas/ActionButton and a label at Canvas/Label.

* See an example of a right-clickable button from this package (check the README). Basically a second button acts as the right click event.

Interfaces

All elements and most presets also implement interfaces so you can create your own presets and use abstracted extension methods (ex. to allow usage of your own player class).