sunnamed-unturned / uielementsunturned Goto Github PK

View Code? Open in Web Editor NEW

10.0 1.0 2.0 3.96 MB

Powerful lib for facilitation of communication via UI in Unturned with RocketMod and OpenMod!

Home Page: https://sunnamed.gitbook.io/uielementsunturned/

License: MIT License

C# 100.00%

effect lib ui unturned openmod rocketmod nuget plugins

uielementsunturned's Introduction

UIElementsUnturned

This lib will help you easy communicate with UI in Unturned!

About this library

This library makes easy listening player UI button clicks and text input in inputfields and more.

Getting Started

First of all, download UIElementsLib.

Then, select mod what you are using for.

If you cant see your mod here dont worry you can use RocketMod version, this is not depends on RocketMod, but it 100% is made for it, or you can write about it in issues or you can implement this by yourself!

Contributing!

For more info click here.

uielementsunturned's People

Contributors

Stargazers

Watchers

Forkers

0x59r11 gmh5225

uielementsunturned's Issues

Update documentation

Update comments documentation in Interfaces

Add all throwing exceptions in documentation too

Hard example -> possible Null reference Exception

So, UIElementsLibPluginExample Instance is not assigned anywhere in code

Problem

Possible exception

public sealed class UIElementsLibPluginExample : RocketPlugin<UIElementsLibPluginExampleConfiguration>
{
    private InputFieldUIHolder inputFieldUIHolder;

    private ButtonUIHolder buttonUIHolder;



    public static UIElementsLibPluginExample Instance { get; private set; }



    protected override void Load()
    {
        // Creating Input Fields holder
        inputFieldUIHolder = new InputFieldUIHolder(items: new List<IInputField>
        {
            new SearchInputField(),
        });

        // Creating Buttons holder
        buttonUIHolder = new ButtonUIHolder(items: new List<IButton>
        {
            new CloseUIButton(configurationAsset: Instance.Configuration),
        });

        // Adding new Button, for special tests or fast work you can use ActionButton
        buttonUIHolder.AddNew(new ActionableButton(childObjectName: "MyUIObjectName", callback: (data, uPlayer) =>
        {

        }));

        // Or like that same with input field
        inputFieldUIHolder.AddNew(new ActionableInputField(childObjectName: "MyInputField", callback: onEnterInputInMyInputFieldCallback));

        // Removing input field
        inputFieldUIHolder.Remove(inputFieldUIHolder.FindItem("MyInputField"));

        EffectManager.onEffectTextCommitted += onInputFieldTextCommitted;
        EffectManager.onEffectButtonClicked += onButtonClicked;
    }

IUIElement and IInputField are have incorrect namespace

ActionableButton add classes with generics

add with this #6

public sealed class ActionableButton<TCallbackArgument1, TCallbackArgument2..> : IActionableUIElement<TCallbackArgument1, TCallbackArgument2..>, IButton
{
    public string ChildObjectName { get; }

    public Action<TCallbackArgument1, TCallbackArgument2..> Callback { get; }



    public ActionableButton(string childObjectName, Action<..> callback)
    {
    }



    void IButton.OnClick(UPlayer executor)
    {
        Callback?.Invoke(..);
    }
}

Upload fix of OpenMod version

OpenMod + UIElementsLib won`t work at the moment, at the moment I already have an working example + real usage plugin with it

IUIHolder should be a bit refactored

IUIHolder add method for safely finding UI Elements

Examples:

bool TryFindItem(string childObjectName, out TUIHolder result);

to avoid this usage:

inputFieldUIHolder.FindItem(inputField)?.OnEnterInput(new UPlayer(player), text);

in result:

if (inputFieldUIHolder.TryFindItem(string childObjectName, out IInputField result))
     result.OnEnterInput(childObjectName);

UIElementsLib is not follow "Semantic Versioning"

As you can see in Releases, im just increasing the last index (+1) every release this is not propely. So, next lib + nuget update is will be with version 1.0.0.0 and follow the Semantic Versioning.

UI Elements with Dependency injection (services)

IActionableUIElement does not contain interface with 9 generics

Create new sample with OpenMod

meaningless usage of UnturnedPlayerComponent in hard example

UIElementsUnturned.UIElementsLibPluginExample.Player.Components in class PlayerUIListenerComponent

UIElementsLib: UIHolderBase problems

private IList holders;
Should looks like:

private readonly IList<TUIHolder> holders;

method FindItem and returning holders
Should looks like:

public TUIHolder FindItem(string childObjectName)
{
    if (string.IsNullOrEmpty(childObjectName))
        throw new ArgumentNullException(nameof(childObjectName));

    return Holders.FirstOrDefault(h => h.ChildObjectName.Equals(childObjectName));
}

void AddNew(IEnumerable<TUIHolder> items);
void Remove(IEnumerable<TUIHolder> items);

IActionableUIElement add new generics

Add 16 generics arguments

public interface IActionableUIElement<in TCallbackArgument1, in TCallbackArgument2, in TCallbackArgument3, in TCallbackArgument4, in TCallbackArgument5, in TCallbackArgument6, in TCallbackArgument7, in TCallbackArgument8, in TCallbackArgument9, in TCallbackArgument10> : IUIElement
{
    Action<TCallbackArgument1, TCallbackArgument2, TCallbackArgument3, TCallbackArgument4, TCallbackArgument5, TCallbackArgument6, TCallbackArgument7, TCallbackArgument8, TCallbackArgument9, TCallbackArgument10... - TCallbackArgument16> Callback { get; }
}

Release new version

IUIHolder not right describes documentation

/// <summary>
/// Trying to find item safely by calling <see cref="TryFindItem(IChildObjectNameString, out TUIHolder)"/>.
/// </summary>
/// <param name="childObjectName">Child object name for searching.</param>
/// <param name="holder">Found UI Holder.</param>
/// <returns>Found UI Holder.</returns>
/// <exception cref="System.ArgumentException"></exception>
bool TryFindItem(string childObjectName, out TUIHolder holder);

here is returns not a Found UI Holder -> it returns success result

all methods with this documentation mistake:

TryFindItem(IChildObjectNameString childObjectNameString, out TUIHolder holder);
TryFindItem(string childObjectName, out TUIHolder holder);

Fix CI compiling errors

project is working absolutely properly, but CI is working not correct.

may can be helpful:
Error info

Scatter classes and do it visible in folder, avoid contain it under interface

now interface IEffectArguments.cs looks like that:

/// <summary>
/// Model of Effect Arguments.
/// </summary>
public interface IEffectArguments
{
    /// <summary>
    /// Effect id.
    /// </summary>
    ushort Id { get; }

    /// <summary>
    /// Effect key.
    /// </summary>
    short Key { get; }
}

public class EffectArguments : IEffectArguments
{
    public ushort Id { get; }

    public short Key { get; }



    public EffectArguments(ushort id, short key)
    {
        Id = id;
        Key = key;
    }
}

[Serializable]
public class SerializableEffectArguments : IEffectArguments
{
    public ushort Id { get; set; }

    public short Key { get; set; }



    public SerializableEffectArguments(ushort id, short key)
    {
        Id = id;
        Key = key;
    }

    public SerializableEffectArguments()
    {
    }
}