open

из группы ui/dialog
вызывает игрок
Начало разговора с NPC — в том числе с торговцем (клик по нему). Дерево разговора берётся у самого NPC и уходит лишь заговорившему игроку; видящим NPC оно не рассылается. Говорят на карте NPC — с его клетки либо с любой из восьми соседних на том же этаже. Команда от игрока издалека ставит движение к NPC, и движение, дойдя до соседней клетки, ставит начало разговора заново; любая новая команда движения отменяет подход. К NPC соседней карты, видному у границы карт, движение ведёт персонажа через границу вплотную к нему, и начало разговора повторяется уже на его карте. Повтор, поставленный движением, застал игрока всё ещё не рядом с NPC на его карте — разговор не начинается, без ошибки: второй подход дал бы тот же исход. Разговор, ещё не написанный (пустое значение), законен: вместо него уходит сигнальная реплика «Разговор не написан» — её ставит эта команда, клиент ничего не подставляет, и недоделанное заметно в игре; варианты в ней — лишь достроенные ниже. Достраивается дерево под заговорившего. Квестовый вариант — вариант разговора, которому автор задал quest, либо квест NPC без такого варианта (ему вариант добавляется к первой реплике с надписью из записи квеста — компонент quests), — уходит с полем state: take — игрок может взять квест, progress — взял и ещё не выполнил, complete — может сдать, cooldown — NPC на откате, его остаток клиент берёт у группы quest/cooldown этого NPC. Вариант автора с intent уходит лишь в своём состоянии — сдача только при complete, взятие при прочих — и сохраняет intent и next. Взять либо сдать квест — команда ui/dialog/quest. Каждому торговцу (есть компонент trade), в том числе с незаданным ценником — множителями компонента trade, — к первой реплике добавляется вариант «Торговать» с полем ui = trade — оно называет окно клиента, которое вариант открывает (лавку открывает ui/loot/open — с тем же правилом дистанции и подходом до соседней клетки торговца). У торговца с разговором клиент открывает лавку только этим вариантом. У торговца без ценника лавка открывается, но сделок в ней нет: покупка и продажа у него — нарушение (ui/inventory/take, ui/inventory/put). Слать команду можно только к сущности с компонентом разговора (dialog): цель без него — нарушение, игрок отключается от игры. Торговец вида trader_silent (без компонента разговора) сюда не попадает: клиент открывает его лавкой сразу. NPC с таким ключом нет ни на карте игрока, ни на соседних либо игрок мёртв — тихий отказ. Эти отказы приходят до подхода: к такому NPC персонаж не идёт, и через границу карт тоже.
Параметры 1
Параметр По умолчанию Что задаёт
key пусто Ключ NPC на запущенной карте — того, с кем заговаривает игрок, в том числе торговца. Стоять рядом не обязательно: издалека игра сама подводит к нему игрока.
Кому доступна
player
Что делает команда — код, который выполняется при её срабатывании
Что платформа подаёт в код
Код исполняется телом функции, и платформа подаёт в него эти переменные:
  • $object — сущность, выполняющая команду
  • $data — параметры команды: ключ — slug параметра; непереданные приходят со своим значением по умолчанию
  • $from_client — команду прислал игрок пакетом, а не поставил код механик
  • $client_origin — цепочку начал игрок: признак наследуют и события, которые код поставит по ходу неё

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

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

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

# Начало разговора с NPC. Дерево уходит адресно заговорившему в начале каждого разговора: здесь его
# и достраиваем под игрока и NPC (квестовые варианты, «Торговать»), видящим NPC оно не рассылается.
# Исход механики — ТИХИЙ отказ (return), НЕ throw: throw в клиентском событии фреймворк отключает игрока.

if(!World::isset($data['key']))
	return;

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

$npc = World::get($data['key']);

// Разговор положен только видам, чей состав несёт компонент разговора, и клиент шлёт его только им: начало
// разговора с иной целью — неверная команда, не гонка (состав сущности за игру не меняется).
if(!$npc->components->isset('dialog'))
	throw new Error('у '.$npc->key.' нет компонента разговора — клиент не должен был начинать разговор (ui/dialog/open)');

// Рядом — клетка NPC либо любая из восьми соседних на том же этаже. Издалека — подойти: дойдя, движение
// повторит начало. Повтор пришёл уже от движения, а рядом всё ещё не стоим — второй подход дал бы тот же исход.
// С NPC соседней карты говорят лишь на его карте: подход идёт вплотную, через границу, и начало повторяется уже там.
if($npc->map != MAP_ID || !$object->position->adjacent($npc->position))
{
	if(!$from_client)
		return;

	$object->events->add('move/walk', 'to', ['x' => $npc->position->x, 'y' => $npc->position->y, 'z' => $npc->position->z, 'target' => $npc->key, 'max_distance' => $npc->map == MAP_ID ? 1 : 0, 'then' => ['event' => 'ui/dialog/open', 'data' => ['key' => $npc->key]]]);
	return;
}

$tree = $npc->components->get('dialog');

// Пустое дерево — разговор ещё не написан: законно, игрок видит сигнальную реплику, и недоделанное заметно в игре.
if(!$tree)
	$tree = ['start' => 'start', 'nodes' => ['start' => ['text' => 'Разговор не написан', 'options' => []]]];

// Квестовые варианты — той же функцией, что признаёт выбор варианта (ui/dialog/quest): выбор обязан принять ровно
// показанное. Вариант автора получает состояние квеста для этого игрока, квест без варианта автора — свой
// вариант в первой реплике; квест, которого игроку не предлагают, снимается и из варианта автора.
$quests = Methods::questOptions($object, $npc);
$used = [];
foreach($tree['nodes'] as $name => $node)
{
	if(empty($node['options']))
		continue;

	$options = [];
	foreach($node['options'] as $option)
	{
		if(isset($option['quest']))
		{
			if(!isset($quests[$option['quest']]))
				continue;

			$used[$option['quest']] = true;

			// Вариант сдачи виден лишь тогда, когда квест можно сдать, вариант взятия в это время скрыт: благодарность
			// после сдачи несёт next варианта сдачи, а не повтор надписи взятия.
			$state = $quests[$option['quest']]['state'];
			if(isset($option['intent']) && ($option['intent'] === 'complete') !== ($state === 'complete'))
				continue;

			$option = ['text' => $option['text']] + array_intersect_key($option, ['next' => true, 'intent' => true]) + $quests[$option['quest']];
		}

		$options[] = $option;
	}

	$tree['nodes'][$name]['options'] = $options;
}

foreach($quests as $key => $option)
	if(!isset($used[$key]))
		$tree['nodes'][$tree['start']]['options'][] = $option;

// У торговца лавка открывается из разговора: вариант называет окно клиента, сервер его не открывает. Торговцу
// с незаданным ценником вариант тоже положен — лавка покажет товар без сделок.
if($npc->components->isset('trade'))
	$tree['nodes'][$tree['start']]['options'][] = ['text' => 'Торговать', 'ui' => 'trade'];

$object->send(['components' => ['dialog' => $tree]], from: $npc);
К игре