| login |
| Назначение: |
| Хранит логин аккаунта. Значение участвует при авторизации аккаунта. |
| password |
| Назначение: |
| Хранит пароль аккаунта. Участвует при авторизации. |
| Назначение: |
| Хранит адрес электронной почты аккаунта. На этот адрес будут отправлятся письма из ядра. |
| void SetCodepage("идентификатор") |
| Назначение: |
| Задает кодировку, в которой работает аккаунт (клиент на другой стороне соединения). |
| Параметры: |
| идентификатор - из числа идентификаторов кодировок, загруженных сервером |
| void NextStep("идентификатор шага") |
| Назначение: |
| Устанавливает на какой шаг в обработчике аккаунт перейдет после заверешения текущего шага |
| Параметры: |
| идентификатор шага - имя шага, указанное в тегах step в обработчике |
| void NextTreat("идентификатор обработчика") |
| Назначение: |
| Устанавливает в какой следующий обработчик аккаунт перейдет после заверешения текущего шага. Имеет приоритет перед методом NextStep. |
| Параметры: |
| идентификатор обработчика - имя обработчика из числа всех загруженных обработчиков или миров |
| void Send("текст") |
| Назначение: |
| Отправляет аккаунту заданную строку текста. |
| Параметры: |
| "текст" - отправляемый текст. Может содержать скрипты динамического описания. |
| bool LinkAccounts("идентификатор базы аккаунтов") |
| Назначение: |
| Осуществляет привязку аккаунта к конкретной базе аккаунтов. Это необходимо для возможности авторизации аккаунта по логину и паролю. |
| Параметры: |
| "идентификатор базы пользователей" - идентификатор одной из списка баз аккаунтов, загруженных в главном конфигурационном файле. |
| Возвращаемые значения: |
| true - аккаунт успешно был привязан к базе |
| false - при привязке произошла ошибка (нет такой базы или она не загружена) |
| bool LinkWorld("идентификатор мира") |
| Назначение: |
| Осуществляет привязку аккаунта к миру. При этом в аккаунт загружается список персонажей этого мира. |
| Параметры: |
| "идентификатор мира" - один из списка идентфикаторов миров, загруженных в ядро. |
| Возвращаемые значения: |
| true - аккаунт успешно был привязан к миру |
| false - при привязке произошла ошибка (нет такого мира или он не загружен) |
| bool CheckLogin() |
| Назначение: |
| Проверяет существует ли уже такой же логин(имя пользователя) в мире. Используется значение login аккаунта. Требует наличие привязки к базе аккаунтов. |
| Параметры: |
| Нет параметров |
| Возвращаемые значения: |
| true - логин аккаунта свободен и может быть использован |
| false - логин аккаунта уже используется другим аккаунтом и не может быть использован |
| bool CheckAccess() |
| Назначение: |
| Проверяет совпадение логина и пароля аккаунта, с тем, что хранится в базе аккаунтов. Используются значения login и password. Требует наличие привязки к базе аккаунтов. |
| Параметры: |
| Нет параметров |
| Возвращаемые значения: |
| true - аккаунт содержит правильные значения login и password. В ядре есть такая учетная запись. |
| false - такой комбинации логина и пароля нет. Неверный логин и(или) пароль. |
| bool Activate() |
| Назначение: |
| Производит активацию аккаунта. Устанавливает флаг, что аккаунт успешно прошел авторизацию. Требуется перед входом аккаунта в мир, т.к. еще дозагружает в аккаунт необходимые данные. |
| Параметры: |
| Нет параметров |
| Возвращаемые значения: |
| true - активация прошла успешно. |
| false - в случае ошибки активации (ошибка в файлах аккаунта). |
| bool CreateNewActor() |
| Назначение: |
| Создает нового персонажа, заполняет его стейты начальными значениями и устанавливает его в качестве текущего. |
| Параметры: |
| Нет параметров |
| Возвращаемые значения: |
| true - в случае успешного создания нового персонажа |
| false - в случае ошибки |
| bool AddNewActor() |
| Назначение: |
| Добавляет нового персонажа в общий список аккаунта, добавляя тем самым его в мир. Новый персонаж становится текущим персонажем аккаунта. |
| Параметры: |
| Нет параметров |
| Возвращаемые значения: |
| true - в случае успешного добавления персонажа в список аккаунта |
| false - в случае ошибки |
| int GetActorsCount() |
| Назначение: |
| Возвращает количество персонажей у аккаунта. |
| Параметры: |
| Нет параметров. |
| Возвращаемые значения: |
| число - количество персонажей у аккаунта. |
| int GetCurrentActor() |
| Назначение: |
| Возвращает индекс текущего персонажа аккаунта. Индекс считается от 1. Если у аккаунта нет текущего персонажа возращается 0. |
| Параметры: |
| Нет параметров. |
| Возвращаемые значения: |
| число - индекс текущего персонажа |
| void SelectActor(индекс персонажа) |
| Назначение: |
| Устанавливает у аккаунта другой персонаж в качестве текущего. Если индекс некорректный, то смена персонажа не происходит. |
| Параметры: |
| число - индекс персонажа, которого необходимо установить в качестве текущего |
| void DeleteActor(индекс персонажа) |
| Назначение: |
| Удаляет персонаж аккаунта. |
| Параметры: |
| число - индекс персонажа, которого необходимо удалить. Может при этом измениться индекс текущего персонажа. Если индекс некорректный, то удаление персонажа не происходит. |
| bool SetTextColor("имя цвета", цвет) |
| Назначение: |
| Устанавливает цвет текста для палитры цветов аккаунта. Палитра цветов используется с помощью тегов динамического описания '#U + имя цвета'. |
| Параметры: |
| "имя цвета" - имя (одна буква или цифра) цвета, для которого нужно задать цвет текста. |
| цвет - число, определяющее сам цвет. Может принимать значение от 0 до 15. |
| Возвращаемые значения: |
| true - в случае успешного изменения цвета |
| false - в случае ошибки (неправильное имя цвета или значение цвета) |
| bool SetPaperColor("имя цвета", цвет) |
| Назначение: |
| Устанавливает цвет фона для палитры цветов аккаунта. Палитра цветов используется с помощью тегов динамического описания '#U + имя цвета'. |
| Параметры: |
| "имя цвета" - имя (одна буква или цифра) цвета, для которого нужно задать цвет фона. |
| цвет - число, определяющее сам цвет. Может принимать значение от 0 до 7. |
| Возвращаемые значения: |
| true - в случае успешного изменения цвета |
| false - в случае ошибки (неправильное имя цвета или значение цвета) |