settings

словарь со своим кодом
Настройки игрока. У игрока значения настроек лежат по их ключам. Умолчание компонента (поле «По умолчанию») задаёт окно настроек клиента: у каждой настройки вид type (checkbox — флажок со значением 0 либо 1, dropdown — выпадающий список, slider — ползунок), подпись в окне title, начальное значение value, у ползунка пределы min и max, у списка допустимые значения values с их подписями. По умолчанию код компонента проверяет присланное: значение вне допустимого отбивается ошибкой, а настройка, которой в умолчании нет, у игрока снимается. Значение ползунка radius становится радиусом жизни игрока, и выше предела, который задаёт установка сервера, его не поднять. Настройка debug («Тестовый режим») включает в клиенте служебные блоки: отладочные слои карты и счётчики частоты, задержки и номера карты.
Стартовое значение
{
    "joystick": {
        "type": "checkbox",
        "title": "Джойстик",
        "value": 1
    },
    "autoattack": {
        "type": "checkbox",
        "title": "Авто ответ на атаку",
        "value": 1
    },
    "minimap": {
        "type": "checkbox",
        "title": "Мини-карта",
        "value": 1
    },
    "debug": {
        "type": "checkbox",
        "title": "Тестовый режим",
        "value": 0
    },
    "actions": {
        "type": "dropdown",
        "title": "Быстрый доступ",
        "value": "mobile",
        "values": {
            "mobile": "Мобильная",
            "pc": "ПК"
        }
    },
    "radius": {
        "type": "slider",
        "title": "Радиус обзора",
        "min": 5,
        "max": 15,
        "value": 14
    },
    "fps": {
        "type": "slider",
        "title": "FPS (частота приема пакетов)",
        "min": 30,
        "max": 100,
        "value": 60
    }
}
Кому выдаётся
player
Каждая сущность этих видов получает компонент при создании.
Код компонента — срабатывает, когда значение меняется, и когда сущность появляется на карте
Что платформа подаёт в код
Код исполняется телом функции, и платформа подаёт в него эти переменные:
  • $object — сущность, которой присваивают значение компонента
  • $value — присваиваемое значение; в самом компоненте на этот момент ещё лежит прежнее

Записано будет то, что лежит в $value после кода: платформа возвращает его сама, свой return тоже годится — так значение правят перед записью либо отказывают в смене. Пустое значение выражается пустой строкой либо пустым набором, null запрещён. Код срабатывает на смену значения и на появление сущности на карте; повторная запись прежнего значения его не запускает. В коде компонента менять компоненты нельзя, ставить события можно.

Кроме них коду доступны классы фреймворка игры и подключённых к ней библиотек — их зовут по имени класса; что именно они умеют, сказано на их страницах.

<?php
# Этот код и при создании существ проверит значение компонента и далее из события что будет меняться

$component = ComponentCollection::list()['settings'];

// Набор настроек уходит клиенту РАЗНИЦЕЙ значений: глубина сравнения 2 разбирает его поключево,
// и переключение одной галочки везёт один ключ, а не весь набор. Отсутствие ключа читается как «значение
// не менялось» и ничего больше: перечень самих настроек клиент знает из умолчания этого компонента
// (оно же схема — типы, заголовки, границы) в каталоге префабов, а не из состава присланного пакета.
// Глубину правят в админке, а сломается от неё клиент — потому сверяем её тут, у кода, который от неё зависит.
if($component->maxCompareLevel !== 2)
	throw new Error('Компоненту settings нужна глубина сравнения значений 2: клиенту настройки уходят разницей значений, а перечень настроек он берёт из умолчания компонента');

// если существо создается на сцене будут присвоено значение по умолчанию
// и если ранее были настройки которых в значениях по умолчанию сейчас нет - они будут удалены (не будут обработаны ниже)
// таким образом мы можем менять настройки частично в том числе
$defaults = $component->default;
$settings = array();
foreach($defaults as $key=>&$setting)
{
	// из события мы отправляем просто значения , а при первом присвоении значения при создании существа на сцене это много мерный массив
	if(array_key_exists($key, $value))
	{
		$current_value = $value[$key]['value']??$value[$key];
		switch($setting['type'])
		{
			case 'checkbox':
				if(!is_numeric($current_value))
					throw new Error('значение настроек чекбокса должно быть числом');

				$current_value = (int)$current_value;

				if(!in_array($current_value, [0, 1]))
					throw new Error('недопустимое значение '.$current_value.' выпадающего списка '.$key);
			break;

			case 'dropdown':
				if(empty($setting['values']))
					throw new Error('У копонента настроек dropdown не указан список допустимых значений');

				if(!isset($setting['values'][$current_value]))
					throw new Error('недопустимое значение '.$current_value.' выпадающего списка '.$key);
			break;

			case 'slider':
				if(!is_numeric($current_value))
					throw new Error('значение настроек слайдера ('.$current_value.') должно быть числом');

				$current_value = (int)$current_value;

				// Обзор пишется в радиус жизни персонажа, а его потолок задаёт УСТАНОВКА сервера:
				// им же считается нагрузка, им сверяется присвоение радиуса и им центр отбивает сохранение
				// игрока. Игра в умолчании компонента вправе сузить предел — по нему клиент строит ползунок, —
				// но поднять его выше потолка установки не может.
				if($key == 'radius')
					$setting['max'] = isset($setting['max']) ? min((int)$setting['max'], LIFE_RADIUS_MAX) : LIFE_RADIUS_MAX;

				if(isset($setting['max']) && $current_value>$setting['max'])
					throw new Error('значение настроек слайдера должно быть не больше '.$setting['max']);

				if(isset($setting['min']) && $current_value<$setting['min'])
					throw new Error('значение настроек слайдера должно быть не меньше '.$setting['min']);

				if($key == 'radius')
					$object->lifeRadius = $current_value;

			break;

			default:
				throw new Error('Неизвестный тип настроек '.$setting['type']);
			break;
		}

		$setting['value'] = $current_value;
	}

	// игроку в компоненты в итоге сохраним ключ->значение. Схему настроек (типы, заголовки, границы) клиент
	// берёт из умолчания этого компонента в каталоге префабов — отдельным пакетом она не шлётся.
	$settings[$key] = $setting['value'];
	unset($setting['value']);
}

// тот самый случай когда нам надо переопределить value (считайте что он по ссылке передан) которая в итоге присвоиться (мы не передаем с киента тип настройк , а только значение, но значение новое должно содержать все)
$value = $settings;
К игре