index

из группы item/pickup
вызывает игрок
Подбор сущностей-вещей с земли в инвентарь. Событие ставится подбирающему; источников три — клик игрока по вещи, шаг живого игрока в другую клетку (самоподбор: его ставит код смены положения — поле игры «Position code», а какие вещи он берёт, сказано в описаниях компонентов autopickup и pickup_radius) и движение, дошедшее до вещи, которая была дальше дальности. Вещь соседней карты, видная у границы карт, берётся лишь на её карте: подбор, начатый игроком, ведёт персонажа через границу в клетку вещи, и подбор повторяется уже там; самоподбор такую вещь пропускает. Целей бывает несколько — берутся за один раз: у сущности стоит лишь одно событие группы, и отдельные события подбора сменяли бы друг друга — бралась бы лишь последняя вещь. Цель дальше дальности либо на соседней карте, а подбор начат игроком — подбор ставит подход к ней: движение, дойдя, ставит подбор заново (параметр walk). Любая новая команда движения отменяет подход; движение, снятое раньше (маршрута к вещи нет), подбора не ставит; игрок к ходу подбора уже идёт своей командой — подход не ставится. Самоподбор подхода не ставит: вещь, от которой игрок, пока событие ждало хода, отошёл дальше своей дальности самоподбора, остаётся лежать — подход тянул бы ушедшего назад против его воли. Удалённость вещи считается клетками, а не расстоянием между точками: лежащая вещь смещена внутри своей клетки, чтобы спрайты не сливались, и по точкам у самого края дальности подбора она выглядела бы дальше, чем лежит, — игроку пришлось бы топтаться рядом без понятной причины. Зачисление в инвентарь ищет место под вещь в момент применения (стак той же вещи приоритетен, иначе первая пустая ячейка); места нет — вещь падает подбирающему под ноги. Исключение — вещь, которая и так лежит на клетке подбирающего: без места она остаётся лежать нетронутой, иначе снятие с возвратом на ту же клетку сбросило бы ей срок снятия с карты; место под неё считается с учётом вещей, взятых тем же заходом. Взятая вещь снимается с карты, а в ячейку инвентаря переезжают её количество и только те значения компонентов, что отличаются от значений префаба вещи (у компонента, не заданного префабу, — от умолчания компонента); прочие значения вещь из ячейки получает от префаба.
Цена в кадре
Одно срабатывание: 0.3 мс процессорного времени
Срабатываний в минуту у одной сущности: 4
Формулами, потому что обе величины зависят от обстановки на карте — сколько вокруг сущностей и сколько из них живых.
Параметры 3
Параметр По умолчанию Что задаёт
radius 1
Дальность подбора в клетках: 0 — только клетка подбирающего, 1 — и соседние вокруг неё, дальше по тому же счёту. Перепроверяет на миг срабатывания цели, которые выбрал тот, кто поставил подбор (клик игрока, самоподбор, движение до вещи): пока событие ждало своего хода, обе стороны могли сдвинуться. От игрока значение не принимается: подбор, присланный игроком, всегда идёт по клетке подбирающего и соседним, иначе игрок, приславший большую дальность, брал бы вещи через всю карту. Берутся вещи лишь этажа подбирающего.
target обязателен
Ключ сущности-вещи на запущенной карте либо СПИСОК таких ключей, когда за раз берётся несколько вещей. Берётся то, чей вид сущности — item либо носимый, — и что лежит на карте подбирающего не дальше допустимой дальности; прочее в списке молча пропускается. Недостижимая цель на этаже подбирающего и вещь соседней карты становятся точкой подхода, когда подход разрешён.
walk пусто
Ставит ли команда подход к недостижимой цели. 1 — ставит: цель дальше дальности становится точкой, к которой игра сама ведёт персонажа, а движение, дойдя, ставит подбор заново со значением 2. 2 — это и есть тот повтор: подход уже был, и цель, всё ещё недостижимая, пропускается — подбор кончается без неё: второй подход дал бы тот же исход. Заполняется только кодом: подбор, присланный игроком, ставится заново со значением 1, присланное отбрасывается. Пусто — недостижимая цель просто пропускается.
Кому доступна
player
Что делает команда — код, который выполняется при её срабатывании
Что платформа подаёт в код
Код исполняется телом функции, и платформа подаёт в него эти переменные:
  • $object — сущность, выполняющая команду
  • $data — параметры команды: ключ — slug параметра; непереданные приходят со своим значением по умолчанию
  • $from_client — команду прислал игрок пакетом, а не поставил код механик
  • $client_origin — цепочку начал игрок: признак наследуют и события, которые код поставит по ходу неё

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

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

<?php
/** @var EntityAbstract $object @var array $data @var bool $from_client */

if(!$object->components->isset('inventory') || ($object->components->isset('hp') && $object->components->get('hp') <= 0))
	return;

// Команда от игрока приходит на группу, чьё накопленное время давно вышло, и без сдвига исполнилась бы тем же
// кадром: её постановка и снятие легли бы в ОДИН пакет, и наружу ушла бы пустая команда — показать подбор
// нечем, ради того у группы и заведена пауза. Тем же приёмом сдвигает исполнение самоподбор (код смены положения игры).
// Прежний маршрут снимается: клик по вещи есть новое решение игрока, а висящая своя ходьба на первом же
// повторе была бы прочтена как отмена подхода и сняла бы подбор.
if($from_client)
{
	$object->events->remove('move/walk');
	$object->events->add('item/pickup', 'index', ['target' => $data['target'], 'radius' => 1, 'walk' => 1]);
	$object->events->get('item/pickup')->resetTimeout();

	return;
}

// Дальность задаёт тот, кто вешал команду; присланная игроком сюда не доходит вовсе — его команда выше
// переставлена со своей дальностью, иначе клиент дотянулся бы через всю карту.
$radius = (int)$data['radius'];
$current = $object->components->get('inventory');
$mine = explode(Position::DELIMETR, $object->position->tile());
$adds = [];
$taken = [];
$far = null;

// Целей бывает несколько: шаг игрока по куче монет берёт их одной командой — группа держит одно
// событие, и пачка отдельных команд затёрла бы сама себя.
foreach((array)($data['target'] ?: []) as $key)
{
	// Взятое в этом же кадре брать нельзя: снятие с карты лишь СТАВИТ ПОМЕТКУ — из мира сущность
	// уходит в конце кадра, когда собраны её изменения, и проверка наличия до тех пор отвечает утвердительно.
	// Без второй половины та же вещь зачисляется КАЖДОМУ, кто подбирает её тем же кадром: двое
	// на клетке одной монеты получали её оба. Парой «есть и не снимается» живость сущности проверяет и сам фреймворк.
	if(!World::isset($key) || World::isRemove($key))
		continue;

	$item = World::get($key);

	if($item->kind !== 'item' && !World::isKindEquipable($item->kind))
		continue;

	// Вещь соседней карты берут лишь на её карте: подбор, начатый игроком, ведёт его через границу в клетку вещи.
	if($item->map != MAP_ID)
	{
		if(!$far)
			$far = $item;

		continue;
	}

	// Здесь дальность перепроверяется на момент исполнения: пока команда ждала своего хода,
	// обе стороны могли сдвинуться. Счёт в КЛЕТКАХ по каждой оси: вещь лежит со смещением внутри
	// своей клетки, чтобы спрайты не сливались, и расстояние по точкам говорило бы о смещении,
	// а не о том, через сколько клеток она лежит. Разные ярусы не берём вовсе.
	$there = explode(Position::DELIMETR, $item->position->tile());

	if(abs((int)$there[0] - (int)$mine[0]) > $radius || abs((int)$there[1] - (int)$mine[1]) > $radius || (int)$there[2] != (int)$mine[2])
	{
		// Первая недостижимая цель — к ней и поведём, если ведение разрешено ниже.
		if(!$far && (int)$there[2] == (int)$mine[2])
			$far = $item;

		continue;
	}

	// Слот несёт ОТЛИЧИЯ экземпляра от префаба, не копию его состава: значение, совпавшее с префабным,
	// читатель добирает из префаба сам. Копия вмерзала бы в слот — правка префаба до неё не доезжает,
	// а ключ стакуемости (prefab + components) разводил бы одинаковые предметы по разным позициям.
	// count не переносится — он отдельное поле слота.
	$itemComponents = null;
	$prefabComponents = World::prefabGet($item->prefab)['component'] ?? [];

	foreach(ComponentCollection::list() as $name => $comp)
	{
		if($name === 'count') continue;
		if(!isset($comp->entity[$item->kind])) continue;
		if(!$item->components->isset($name)) continue;

		$value = $item->components->get($name);

		// Эталон — то, что сущность получит обратно при создании из этого слота: заданное префабу,
		// иначе умолчание справочника. Нет ни того ни другого — значение живёт только в слоте.
		$base = $prefabComponents[$name] ?? $comp->default;

		if($base !== null && $value == $base)
			continue;

		if(!$itemComponents) $itemComponents = [];
		$itemComponents[$name] = $value;
	}

	// слот-массив в формате инвентаря — identity и поиск слота едины (библиотека inventory-trade)
	$slotData = ['prefab' => $item->prefab, 'count' => $item->components->get('count')];
	if($itemComponents)
		$slotData['components'] = $itemComponents;

	// Место ищет зачисление инвентаря, а без места роняет вещь подбирающему под ноги. Здесь место считается лишь
	// затем, чтобы не трогать вещь, которая и так лежит на его клетке: снятие с возвратом на ту же клетку сбросило бы
	// ей срок лежания. Счёт — С УЧЁТОМ взятого в этот же заход: две вещи подряд претендуют на один пустой слот.
	$slot = Inventory::findSlot($current, $slotData);

	if(!$slot && (int)$there[0] == (int)$mine[0] && (int)$there[1] == (int)$mine[1])
		continue;

	if($slot)
		$current[$slot] = !empty($current[$slot]) ? ['count' => $current[$slot]['count'] + $slotData['count']] + $current[$slot] : $slotData;

	$adds[] = ['item' => $slotData];
	$taken[] = $item;
}

if(!$adds)
{
	// Ничего не взяли. Цель недостижима, а подбор начат игроком — подойти и повторить, как подход
	// к контейнеру. Самоподбор ведения не запускает: вещь, от которой игрок, пока команда ждала хода, отошёл
	// дальше своей дальности самоподбора, остаётся лежать — подход тянул бы ушедшего назад против его воли.
	// Подход уже был (walk = 2): этот повтор поставило само движение, дойдя до вещи, а она всё ещё дальше
	// дальности — второй подход дал бы тот же исход.
	if(!$far || !$data['walk'] || (int)$data['walk'] == 2)
		return;

	// Пока подбор ждал своего хода, игрок пошёл куда-то сам — его команда движения главнее нашего подхода.
	// Клик игрока по вещи сюда не попадает: он перехвачен выше и там же снял прежний маршрут.
	$move = $object->events->get('move/walk');

	if($move->action && $move->from_client)
		return;

	// Дойдя до вещи, движение само поставит подбор заново (walk = 2).
	$object->events->add('move/walk', 'to', ['x' => $far->position->x, 'y' => $far->position->y, 'z' => $far->position->z, 'then' => ['event' => 'item/pickup/index', 'data' => ['target' => $far->key, 'radius' => $radius, 'walk' => 2]]]);
	return;
}

// Одной записью на весь заход: триггер инвентаря и рассылка отрабатывают раз, а не на каждую подобранную вещь.
if($adds)
{
	$object->components->add('inventory', ['__add' => $adds]);

	// Снимаем с карты ПОСЛЕ зачисления: отказ записи иначе оставил бы игрока без вещи и без записи в слоте.
	foreach($taken as $item)
		$item->remove();
}
К игре