Содержание   <<< Назад   Далее >>>

Lua скрипты игрового режима


mob
object

Методы мобов и объектов будут описываться одновременно, т.к. и моб и объект имеют одинаковый набор методов. У моба и объекта есть стейты. Доступ к ним осуществляется через точку. Про список доступных стейтов можно прочитать тут. Как таковых, глобальных mob и оbject, не существует. Это типы сущностей. Сущности данных типов - это результат работы некоторых других методов.

Список методов :
void Destroy()
Назначение:
Удаляет (уничтожает) моба или объект из мира.
Параметры:
Нет параметров

any RunMethod("идентификатор метода", ...)
Назначение:
Запускает скрипт метода для моба или объекта.
Параметры:
"идентификатор метода" - метод, который нужно запустить.
... - запуск метода может сопровождаться любым количеством параметров, которые пишутся через запятую. Доступ к параметрам из скрипта метода осуществляется с помощью методов params() и param(index).
Возвращаемые значения:
actor|room|object|mob|string|nil - значение любого типа, которое может вернуть метод. По умолчанию или в случае ошибки возвращается nil.

bool SetRoom(room|nil)
Назначение:
Помещает моба или объект в заданную комнату, при этом, если объект уже находился в какой-то комнате, то он из этой комнаты убирается. Если указывается nil, в качестве параметра, то моб или объект просто убирается из комнаты, в которой он находится. Следует заметить, что при использовании nil, объект или моб становится в "подвешенном" состоянии, т.е. он существует в мире, но никому не принадлежит. Следует обязательно после выполнять методы привязки моба или объекта, к "другому хозяину". Возвращает true - если метод выполнился удачно, false - если метод выполнился с ошибкой.
Параметры:
room - комната, в которую нужно поместить моба или объект.

void SendRoom("текст")
Назначение:
Отправляет от имени моба(объекта), всем персам в одной комнате с мобом(объектом) заданную строку текста. В тексте можно использовать теги динамического описания.
Параметры:
"текст" - текст, который нужно отправить всем персонажам в комнате.

group|nil AddGroup("идентификатор группы")
Назначение:
Добавляет мобу или объекту группу с заданным идентификатором. О группах можно почитать тут.
Параметры:
"идентификатор группа" - группа, которую нужно добавить мобу или объекту.
Возвращаемые значения:
group - добавленная, группа в случае успешного добавления группы.
nil - в случае ошибки (такой группы не существует).

group|nil GetGroup("идентификатор группы")
Назначение:
Возвращает группу моба или объекта по идентификатору. О группах можно почитать тут.
Параметры:
"идентификатор группа" - группа моба или объекта, которую нужно вернуть.
Возвращаемые значения:
group - в случае, если группа у моба или объекта есть.
nil - в случае ошибки (такой группы у моба или объекта нет).

group|nil FindGroupActor("строка поиска" [,"список групп"])
Назначение:
Осуществляет поиск персонажа по строке поиска в группах моба или объекта.
Параметры:
"строка поиска" - строка по которой ищется персонаж.
"список групп" - необязательный параметр. Это строка-список групп в которых ищется персонаж. Список состоит из имен групп, разделенных запятой - ','. Допускается делать сокращения - начальные буквы имени группы, тем самым объединяя группы для наглядности кода.
Возвращаемые значения:
group - группа, в которую входит персонаж, в случае, если такой персонаж есть в группах моба или объекта.
nil - в случае ошибки (такого персонажа в группах у моба или объекта нет).

group|nil FindGroupMob("строка поиска" [,"список групп"])
Назначение:
Осуществляет поиск моба по строке поиска в группах моба или объекта.
Параметры:
"строка поиска" - строка по которой ищется моб.
"список групп" - необязательный параметр. Это строка-список групп в которых ищется моб. Список состоит из имен групп, разделенных запятой - ','. Допускается делать сокращения - начальные буквы имени группы, тем самым объединяя группы для наглядности кода.
Возвращаемые значения:
group - группа, в которую входит моб, в случае, если такой моб есть в группах моба или объекта.
nil - в случае ошибки (такого моба в группах у моба или объекта нет).

group|nil FindGroupObject("строка поиска" [,"список групп"])
Назначение:
Осуществляет поиск объекта по строке поиска в группах моба или объекта.
Параметры:
"строка поиска" - строка по которой ищется объект.
"список групп" - необязательный параметр. Это строка-список групп в которых ищется объект. Список состоит из имен групп, разделенных запятой - ','. Допускается делать сокращения - начальные буквы имени группы, тем самым объединяя группы для наглядности кода.
Возвращаемые значения:
group - группа, в которую входит объект, в случае, если такой объект есть в группах моба или объекта.
nil - в случае ошибки (такого объекта в группах у моба или объекта нет).

actor|nil FindActor("строка поиска" [,"список групп"])
Назначение:
Осуществляет поиск персонажа по строке поиска в группах моба или объекта.
Параметры:
"строка поиска" - строка по которой ищется персонаж.
"список групп" - необязательный параметр. Это строка-список групп в которых ищется персонаж. Список состоит из имен групп, разделенных запятой - ','. Допускается делать сокращения - начальные буквы имени группы, тем самым объединяя группы для наглядности кода.
Возвращаемые значения:
actor - персонаж, если такой персонаж есть в группах моба или объекта.
nil - в случае ошибки (такого персонажа в группах моба или объекта нет).

mob|nil FindMob("строка поиска" [,"список групп"])
Назначение:
Осуществляет поиск моба по строке поиска в группах моба или объекта.
Параметры:
"строка поиска" - строка по которой ищется моб.
"список групп" - необязательный параметр. Это строка-список групп в которых ищется моб. Список состоит из имен групп, разделенных запятой - ','. Допускается делать сокращения - начальные буквы имени группы, тем самым объединяя группы для наглядности кода.
Возвращаемые значения:
mob - моб, в случае, если такой моб есть в группах моба или объекта.
nil - в случае ошибки (такого моба в группах моба или объекта нет).

group|nil FindObject("строка поиска" [,"список групп"])
Назначение:
Осуществляет поиск объекта по строке поиска в группах моба или объекта.
Параметры:
"строка поиска" - строка по которой ищется объект.
"список групп" - необязательный параметр. Это строка-список групп в которых ищется объект. Список состоит из имен групп, разделенных запятой - ','. Допускается делать сокращения - начальные буквы имени группы, тем самым объединяя группы для наглядности кода.
Возвращаемые значения:
group - группа, в которую входит объект, в случае, если такой объект есть в группах моба или объекта.
nil - в случае ошибки (такого объекта в группах моба или объекта нет).

[mob] GetMobs(["список групп"])
Назначение:
Возвращает массив мобов в группах моба или объекта.
Параметры:
"список групп" - необязательный параметр. Это строка-список групп в которых ищутся мобы. Список состоит из имен групп, разделенных запятой - ','. Допускается делать сокращения - начальные буквы имени группы, тем самым объединяя группы для наглядности кода. Если параметр не задан, то мобы ищутся во всех группах моба или объекта.
Возвращаемые значения:
[mob] - массив мобов в группах моба или объекта.
nil - в случае ошибки.

[object] GetObjects(["список групп"])
Назначение:
Возвращает массив объектов в группах моба или объекта.
Параметры:
"список групп" - необязательный параметр. Это строка-список групп в которых ищутся объекты. Список состоит из имен групп, разделенных запятой - ','. Допускается делать сокращения - начальные буквы имени группы, тем самым объединяя группы для наглядности кода. Если параметр не задан, то объекты ищутся во всех группах моба или объекта.
Возвращаемые значения:
[object] - массив объектов в группах моба или объекта.
nil - в случае ошибки.

string|nil RandomMove(["возможные направления"])
Назначение:
Определяет случайное возможное направление перемещения для моба или объекта.
Параметры:
"возможные направления" - необязательный параметр. Представляет собой список идентификторов возможных направлений, разделенных запятой - ','.
Возвращаемые значения:
string - идентификатор случайного возможного направления перемещения для моба или объекта.
nil - если нет возможного случайного направления перещения.

room|nil Move("направление"[,limit])
Назначение:
Перемещает моба или объект в другую комнату в заданном направлении.
Параметры:
"направление" - один из идентфикаторов возможного направления в мире.
limit - необязательный параметр. Определяет степень ограничения для перемещения. Может принимать только значения '1' и '2'. Значение '1' - ограничивает перемещение в рамках зоны, значение '2' - в рамках подзоны.
Возвращаемые значения:
room - комната, которая находится в данном направлении.
nil - если в данном направлении нет комнаты или перемещение попадает под ограничение.

Содержание   <<< Назад   Далее >>>