14 октября

Scheduler удобный распорядок вызова функций, моя система кондиций

.NETVisual StudioUnity
Из песочницы
ИСХОДНИКИ


Изначально инструмент был написан для помощи в разработке простых казуальных игр на Unity, по крайней мере, там он был весьма полезен.
Но я, думаю, прибегну к нему и в других проектах, и не только на юнити.
И, возможно, он пригодится и вам!




И так, для чего он?


Представим ситуацию: вы написали несложную казуалку, в которой нужно тапнуть по экрану десять раз, чтобы пройти один уровень, и отправили ее на превью начальнику (или избалованному заказчику).
Следом одна за одной приходят задачи:
  1. А давай добавим рекламы на финише каждые 1,5 минуты?
  2. А давай после нее где-нибудь на старте будет окно: «Купите премиум чтобы не было рекламы»?
  3. Че-то это окно резко давит, а давай оно будет после рекламы, но только когда игрок нажал старт и прошел два уровня?
  4. А давай на 10, 20, 30 уровне будет окно «поделитесь с друзьями»?
  5. А давай с 10 уровня каждые 2 левела будет окно «Оцените нас!»?
  6. И кучу еще всего!


Даже пройдя через жестокий расстрел и бесконечный перекрой своего чада, проведя сотую проверку расположения окон, вы, рано или поздно, столкнетесь с такой проблемой: окна, привязанные к таймеру могут накладываться поверх окон, привязанных к самим уровням! Переделать это становится все более затруднительно — ведь проверок условий и так по горло, плюс ваш коллега мог добавить свои окна с совершенно нечитабельным кодом! Что же делать?




Задача:


Вызывать окно в определенный момент (например, нажатие на кнопку), и только в том случае, если выполнены все заданные условия (время прошло, достигли необходимого пойнта и т.д.)


Решение:


Для этого я сделал класс Condition, вот основные его поля:
  1. таймер int setedSeconds
  2. скипы int setedSkips
  3. список чекПойнтов List &ltint&gt checkPoints

Пока что, для общего понимания, начнем с мануальной настройки Кондиций. Потом и вовсе будет возможно задействовать сложный алгоритм вызова в одной строке.

Таймер и скипы работают вместе, почти одинаково, оба имеют обратный отсчет. Разве что, для скипов необходимо придумать, на каком событии они будут убавляться, метод NextSkip(). Если значение таймера = 0, то он не активен, тоже самое и
с скипами. Но даже если вы установили какое-нибудь значение, все равно нужно обязательно вызвать START() — он запустит их отсчет. Вы можете сделать
это индивидуально, в конкретных для себя случаях методы StartTimer() и ResetSkips(). Также, общий метод IsReady()
возвращает true только когда те поля, что были активны (value > 0), после вызова метода START() достигли своего пика.



В общем все просто: нужен таймер — ставите время (в секундах) таймеру setedSeconds, скипы оставляете на нуле, или наоборот,
или все вместе! IsReady() во всем разберется, главное всегда вызывать общий метод START() в том месте, где
вы хотите, чтобы начался отсчет скипов.



    public Condition myCondition;

    void Start(){
        myCondition = new Condition("Имя");
        myCondition.setedSeconds = 120; // 2 минуты
        myCondition.setedSkips = 5;
        myCondition.START(); // Отсчет пошел с самого старта игры
    }

    // Финиш какого нибудь уровня
    public void FinishRound(){
        myCondition.NextSkip(); // Левел пройден, скип убавился

        if (myCondition.IsReady())
        {
            // Мы достигли нужной кондиции, теперь можно выполнять какую нибудь функцию...

            myCondition.START(); //На этот раз START() как сброс на исходное. Обязательно, иначе каждый финиш будет IsReady == true
        }
    }



Кондиция, как было написано выше, может хранить в себе отдельное условие — список чек пойнтов List &ltint&gt checkPoints. Этот список работает немного по-другому
по той причине, что он, как правило приоритетный, т.е, нужен, если вы хотите какой-либо явный вызов функции строго по чекПойнтам. За чекПойнты можно принимать все, что угодно: пройденные лвлы, нажатия на кнопку или любые другие события (в основном, это уровни). Список чекПойнтов можно добавить исключительно через конструктор, он прилично инкапсулирован в целях дальнейшего удобного добавления в Scheduler класс, да и вряд ли будут причины по ходу программы менять список, ведь его идея — в ясности момента вызова.


    public Condition myCondition;

    void Start(){
        myCondition = new Condition("имя",new List<int> { 1, 2, 5 }); // добавляем после обязательного имени, наш список лвлов
        myCondition.setedSeconds = 120;
        myCondition.setedSkips = 5;
        myCondition.START();
    }

    public void FinishRound(){
        myCondition.NextSkip();

        if (myCondition.IsReady() || myCondition.HasCheckPoint(currentLevel)) // добавили в условие имеет ли кондиция в списке текущий Левел
        {
            // Мы достигли нужной кондиции, теперь можно выполнять какую нибудь функцию...

            myCondition.START();
        }
    }


Ну, если механика становится ясна, можно переходить на коробку автомат вообще без проблем =) У кондиции есть
AutoInvoke(Action CallBack, int checkPoint = 0) который освобождает от таких вызовов, как NextSkip() или повторного
START() для перезапуска условий, но первый START() все равно требуется.



public Condition myCondition;

void Start(){
myCondition = new Condition(«имя»,new List { 1, 2, 5 });
myCondition.setedSeconds = 120;
myCondition.setedSkips = 5;
myCondition.START();
}

public void FinishRound(){

myCondition.AutoInvoke(() => Debug.Log(«hello World»), currentLevel);
// можно без currentLevel, но тогда список чекПойнтов не будет учитываться
}

}

Один объект кондиции поможет вам быстро предоставить набор необходимых условий для срабатывания какой-либо одной функции!!!
Если у вас в ТЗ задача чуть сложнее, чем простой вызов, например, вызов через раз или через какое-то время, уже будет полезно прибегнуть к кондиции, ибо это абстракция и читабельность — вам лишь остается ее запустить и проверять ее готовность.


Я добавил в поля кондиции полезные юнити аттрибуты для удобной инициализации через
инспектор!


Главное — это гибкость, и если вдруг кто-то придумает добавить свой функционал, который не должен конфликтовать с вашей кондицией, вам просто нужно создать общий планировщик…


next Задача:


Гибко добавлять разные окна (вызов функции) с разных мест программы, сохранять синхронизацию и избегать конфликтов наложения!


Решение:
И вот мы добрались до главного класса Scheduler наш планировщик кондиций!
Объект данного класса лучше инициализировать как можно раньше. Конкретно в юнити лучше, чтобы объект был DontDestroyOnLoad.
Если заглянуть внутрь Scheduler, можно увидеть там такие поля:
  1. Текущий чек пойнт int currentСheckPoint
  2. Коллекция всех добавленных кондиций и их поведения Dictionary &ltCondition,Action&gt ConditionHandlers — чтобы
    планировщик знал, какую роль должна выполнить готовая кондиция
  3. Список чек пойнтов Dictionary &ltint,Condition&gt CheckPoints — когда кондиция добавляется в Scheduler, её список добавляется в этот Dictionary, обязательно проверяя, свободен ли данный ключ. В противном случае он занимает след свободный чек пойнт.
  4. Очередь всех готовых кондиций Queue &ltCondition&gt WaitingConditions Если несколько кондиций становятся готовыми одновременно,
    они откладываются на следующий вызов

Scheduler хранит поведение каждой кондиции и срабатывает согласно этому классу, задается он в момент добавления кондиции
public void Add(Condition newCondition, Action CallBack),
где в аргументах есть обязательный делегат. Сам метод считывает имя кондиции и выбрасывает исключение, если оно пустое или уже добавлено — это нужно на случай, если по какой-то причине вам надо взять кондицию из расписания по имени List&ltCondition&gt GetConditions(params string[] conditionName). Также, метод добавления Add() Сразу запускает Start()
добавленной кондиции. Это полезно, если запустить Start()
добавленной кондиции забудет кто из разработчиков, а также для того, чтобы избежать постоянного выбрасывания этой функции от Scheduler. Если вам нужно другое место для старта кондиции, вы просто работаете с кондицией как раньше, вы всегда можете менять её счетчики. В этом вся прелесть Scheduler — он обрабатывает, где кондиция готова, и где она изменила своей готовности, и делает этот расчет в момент вызова своего главного метода Condition Invoke(params Condition[] badges). В аргументах вы можете указать некие бэйджики, т.е те кондиции, исключительно которые должны сработать, и те, чья очередь подошла, однако они не появились в списке бейджиков, то они не сработают. Но, если ничего не указывать, то, как и положено, каждый имеет право на вызов на пике очереди!

Обязательно придумайте, где будет отсчет чек пойнтов для Scheduler NextCheckPoint(), например, на методе, на финише
или старте раунда


полный пример того, что требуется для работы с Scheduler:

    public Condition OfferBuyVip;
    public Condition OfferToShareWithFriends;
    public Condition OfferToVisitSite;

    public Scheduler OfferScheduler;

    public void Start(){
        OfferScheduler = new Scheduler(currentLevel); // в конструкторе следует указать текущий левел

        /*
         * здесь или в юнити инспекторе заполните поля ваших кондиций
         */

        OfferScheduler.Add(OfferBuyVip, () => Debug.Log("Не желаете ли вы купить VIP"));
        OfferScheduler.Add(OfferToShareWithFriends, () => Debug.Log("Вы можете поделиться с друзьями"));
        OfferScheduler.Add(OfferToVisitSite, () => Debug.Log("Перед игрой лучше посетить наш сайт, там есть подсказки"));
    }

    public void FinishRound(){
        OfferScheduler.NextCheckPoint(currentLevel); // обязательный метод, он также убавляет скипы всем кондициям
        OfferScheduler.Invoke(OfferBuyVip, OfferToShareWithFriends) // будут срабатывать две кондиции при условии, что они на пике
    }

    public void StartRound(){
        OfferScheduler.Invoke(OfferToVisitSite); // на старте раунда будет предлагаться
        //посещение сайта при условии, что кондиция готова, и на этом чек пойнте не было других вызовов от Scheduler
    }




Вот так мы добились того, что три функции наших кондиций вызываются в разных местах, при этом они уважают друг друга и не вылезают все подряд, а соблюдают очередь (как современная цифровая очередь по талончикам), и юзер, быстро перепрыгивая с финиша на старт игры, не будет напрягаться от кол-ва предложений. С Scheduler соблюдает четкую гармонию простоты и гибкости, ведь с Scheduler и делегатом, передаваемым ему через метод Add(Condition newCondition, Action CallBack), возможно реализовать любую связь между окнами. Например, при вызове рекламного баннера, через два уровня появляется предложение о покупке Премиума без рекламы:

    void Start(){
        OfferScheduler = new Scheduler(currentLevel);

        callAddBanner = new Condition("Вызов Рекламы");
        callAddBanner.setedSeconds = 80; // Кондиция настроенна на 80 секунд
        OfferBuyVip = new Condition("Предложение купить VIP без рекламы");

        OfferScheduler.Add(callAddBanner,
            delegate()
            {
                Debug.Log("ЗАПУСК РЕКЛАМЫ");
                OfferBuyVip.setedSkips = 2; // Ставим счетчик скипов
                OfferBuyVip.START();  // Запускаем
            }
           );
        OfferScheduler.Add(OfferBuyVip,
            delegate ()
            {
                Debug.Log("Не желаете ли вы купить VIP");
                OfferBuyVip.setedSkips = 0; // Обязательно сбрасываем, запуск рекламы решает, когда запускать
            }
           );
        }

        void Finish(){
            OfferScheduler.NextCheckPoint(currentLevel); // не забываем про отсчет пойнтов
            OfferScheduler.Invoke(); // Теперь на финише будут вызываться согласно порядку наши кондиции
        }



Вот так вот просто теперь каждые 80 сек будет вызываться не отвлекающая реклама
(Ведь она вызывается не во время важного раунда, а на финише) и ещё вызывать предложение о покупке рекламы тогда,
когда вам это удобно! И самое прекрасное, что теперь любой разработчик в команде может добавлять в Scheduler свои предложения,
и Scheduler все распределит.
Теги:asp.net coreunity
Хабы: .NET Visual Studio Unity
+3
1,4k 21
Комментарии 13
Похожие публикации
Программирование на Visual С++
30 ноября 202024 990 ₽Специалист.ру
Рефакторинг кода .NET
7 декабря 202030 200 ₽Luxoft Training
Python для веб-разработки
27 ноября 202049 500 ₽SkillFactory
Fullstack-разработчик на JavaScript
27 ноября 202083 200 ₽SkillFactory
SMM-менеджер
27 ноября 202069 900 ₽Нетология
▇▅▄▅▅▄ ▇▄▅