| void Send("текст") |
| Назначение: |
| Отправляет персонажу заданную строку текста. Строка может содержать теги динамического описания. |
| Параметры: |
| "текст" - строка текста, которую нужно отправить персонажу. |
| void SendEx(actor|object|mob, "текст") |
| Назначение: |
| Отправляет персонажу заданную строку текста, причем теги динамического описания в строке, должны обрабатываться относительно персонажа, объекта или моба, указанного первым параметром. |
| Параметры: |
| actor|object|mob - персонаж, объект или моб, относительно которого нужно отрабатывать теги динамического описания. |
| "текст" - строка текста, которую нужно отправить персонажу. |
| void SendRoom("текст") |
| Назначение: |
| Отправляет всем остальным персонажам, в одной комнате с текущим персонажем, кроме него самого, заданную строку текста. |
| Параметры: |
| "текст" - строка текста, которую нужно отправить все остальным персонажам в комнате. |
| void SendRoomEx(actor|object|mob, "текст") |
| Назначение: |
| Отправляет всем остальным персонажам, в одной комнате с текущим персонажем, кроме него самого, заданную строку текста. Если в качестве первого параметра указан actor, то посылаемая строка этому персонажу также НЕ посылается. Если указаны моб или объект, то посылаемая строка ТАКЖЕ НЕ посылается владельцу(хозяину группы типа 'owner', в котором находится моб или объект), если этот владелец - персонаж. |
| Параметры: |
| actor|object|mob - персонаж, объект или моб, относительно которого нужно отрабатывать теги динамического описания. |
| "текст" - строка текста, которую нужно отправить всем персонажам в комнате, кроме текущего и персонажа, указанного первым параметром. |
| void SendWorld("текст") |
| Назначение: |
| Отправляет всем персонажам в мире, кроме текущего персонажа, заданную строку текста. |
| Параметры: |
| "текст" - строка текста, которую нужно отправить все персонажам в мире. |
| void SendRoomInfo() |
| Назначение: |
| Отправляет персонажу описание комнаты, в которой он находится. |
| Параметры: |
| Нет параметров |
| void SendError() |
| Назначение: |
| Отправляет персонажу строку ошибки в команде. Строка задается в главном файле мира. |
| Параметры: |
| Нет параметров |
| bool CanMove("направление") |
| Назначение: |
| Определяет возможность перемещения персонажа в заданном направлении. |
| Параметры: |
| "направление" - один из идентфикаторов направления, которые были указаны в конфигурационном файле мира. |
| Возвращаемые значения: |
| true - персонаж может перемещаться в заданном направлении |
| false - персонаж не может перемещаться в заданном направлении |
| room|nil Move("направление") |
| Назначение: |
| Перемещает персонажа в другую комнату в заданном направлении. |
| Параметры: |
| "направление" - один из идентфикаторов возможного направления в мире. |
| Возвращаемые значения: |
| room - комната, которая находится в данном направлении |
| nil - если в данном направлении нет комнаты |
| void ExitWorld() |
| Назначение: |
| Осуществляет вывод персонажа из мира (выход из игры). При выполнении этой команды, запоминается комната, откуда "выходит" персонаж. При следующем входе в игру, персонаж будет помещен именно в эту комнату (по умолчанию). |
| Параметры: |
| Нет параметров |
| group|nil AddGroup("идентификатор группы") |
| Назначение: |
| Добавляет персонажу группу с заданным идентификатором. О группах можно почитать тут. |
| Параметры: |
| "идентификатор группа" - группа, которую нужно добавить персонажу. |
| Возвращаемые значения: |
| group - добавленная группа, в случае успешного добавления. |
| nil - в случае ошибки (такой группы не существует). |
| group|nil GetGroup("идентификатор группы") |
| Назначение: |
| Возвращает группу персонажа по идентификатору. О группах можно почитать тут. |
| Параметры: |
| "идентификатор группа" - группа персонажа, которую нужно вернуть. |
| Возвращаемые значения: |
| group - в случае, если группа у персонажа есть. |
| nil - в случае ошибки (такой группы у персонажа нет). |
| bool SetRoom("идентификатор комнаты") |
| Назначение: |
| Помещает персонажа в заданную комнату, при этом, если персонаж находился в какой-то другой комнате, то он из этой комнаты убирается. Если персонаж еще не вошел в мир, то вызов этого метода устанавливает комнату входа в мир. |
| Параметры: |
| "идентификатор комнаты" - комната, в которую нужно поместить персонажа. |
| Возвращаемые значения: |
| true - в случае успешного перемещения персонажа. |
| false - в случае ошибки (такой комнаты не существует). |
| room|nil GetRoom() |
| Назначение: |
| Возвращает команту, в которой находится персонаж. |
| Параметры: |
| Нет параметров. |
| Возвращаемые значения: |
| room - в случае, когда персонаж находится в игре. |
| nil - в случае, когда персонаж находится вне игры. |
| any RunMethod("идентификатор метода", ...) |
| Назначение: |
| Запускает скрипт метода для персонажа. |
| Параметры: |
| "идентификатор метода" - метод, который нужно запустить. |
| ... - запуск метода может сопровождаться любым количеством параметров, которые пишутся через запятую. Доступ к параметрам из скрипта метода осуществляется с помощью методов params() и param(index). |
| Возвращаемые значения: |
| actor|room|object|mob|string|nil - значение любого типа, которое может вернуть метод. По умолчанию или в случае ошибки возвращается 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 - в случае ошибки (такого моба в группах персонажа нет). |
| object|nil FindObject("строка поиска" [,"список групп"]) |
| Назначение: |
| Осуществляет поиск объекта по строке поиска в группах персонажа. |
| Параметры: |
| "строка поиска" - строка по которой ищется объект. |
| "список групп" - необязательный параметр. Это строка-список групп в которых ищется объект. Список состоит из имен групп, разделенных запятой - ','. Допускается делать сокращения - начальные буквы имени группы, тем самым объединяя группы для наглядности кода. |
| Возвращаемые значения: |
| object - объект, в случае, если такой объект есть в группах персонажа. |
| nil - в случае ошибки (такого объекта в группах персонажа нет). |
| [mob] GetMobs(["список групп"]) |
| Назначение: |
| Возвращает массив мобов в группах персонажа. |
| Параметры: |
| "список групп" - необязательный параметр. Это строка-список групп в которых ищутся мобы. Список состоит из имен групп, разделенных запятой - ','. Допускается делать сокращения - начальные буквы имени группы, тем самым объединяя группы для наглядности кода. Если параметр не задан, то мобы ищутся во всех группах персонажа. |
| Возвращаемые значения: |
| [mob] - массив мобов в группах персонажа. |
| nil - в случае ошибки. |
| [object] GetObjects(["список групп"]) |
| Назначение: |
| Возвращает массив объектов в группах персонажа. |
| Параметры: |
| "список групп" - необязательный параметр. Это строка-список групп в которых ищутся объекты. Список состоит из имен групп, разделенных запятой - ','. Допускается делать сокращения - начальные буквы имени группы, тем самым объединяя группы для наглядности кода. Если параметр не задан, то объекты ищутся во всех группах персонажа. |
| Возвращаемые значения: |
| [object] - массив объектов в группах персонажа. |
| nil - в случае ошибки. |