Объект Game

Объект Game предоставляет доступ ко всем свойствам игры, а также самого движка. Всегда существует только один объект Game, который хранится в предопределённой переменной.


Методы

Функции диагностики
LOG Записывает строку текста в файл системного журнала.
Msg Выводит окно сообщения на экран.
DumpTextureStats Записывает информацию о состоянии использования текстур в текстовый файл в формате CSV.
Манипулирование объектами
ValidObject Выясняет, является ли верной текущая ссылка на объект.
UnloadObject Удаляет объект из памяти.
LoadActor Загружает персонаж из файла.
LoadActor3D Загружает 3D-персонаж из файла.
LoadEntity Загружает объект сцены (entity) из файла.
LoadWindow Загружает окно из файла.
ExpandString Форматирует переданную в качестве аргумента строку, основываясь на текстовой таблице.
Функции для работы с музыкой
MusicCrossfade Осуществляет плавное затухание звука в одном канале и нарастание в другом
PlayMusic Начинает воспроизведение музыки.
StopMusic Останавливает воспроизведение музыки.
PauseMusic Ставит на паузу воспроизведение музыки.
ResumeMusic Продолжает воспроизведение после паузы.
SetMusicPosition Задаёт текущую позицию для воспроизведения в музыкальном файле.
GetMusicPosition Возвращает текущую позицию для воспроизведения в музыкальном файле
IsMusicPlaying Выясняет, идёт ли в настоящий момент воспроизведение музыки
GetMusic Возвращает имя файла, проигрываемого в настоящий момент
SetMusicVolume Устанавливает громкость музыки.
GetMusicVolume Возвращает значение текущего уровня громкости.
PlayMusicChannel Воспроизводит музыку на заданном канале.
StopMusicChannel Останавливает воспроизведение музыки на заданном канале.
PauseMusicChannel Ставит на паузу воспроизведение музыки на заданном канале.
ResumeMusicChannel Продолжает воспроизведение после паузы на заданном канале.
SetMusicChannelPosition Задаёт текущую позицию для воспроизведения в музыкальном файле на заданном канале.
GetMusicChannelPosition Возвращает текущую позицию для воспроизведения в музыкальном файле на заданном канале.
IsMusicChannelPlaying Выясняет, идёт ли в настоящий момент воспроизведение музыки на заданном канале
GetMusicChannel Возвращает имя файла, проигрываемого в настоящий момент на заданном канале
SetMusicChannelVolume Устанавливает громкость музыки на заданном канале.
GetMusicChannelVolume Возвращает значение текущего уровня громкости на заданном канале.
Функции для работы со сценариями
AttachScript Выполняет файл сценария и прикрепляет его к объекту.
DetachScript Выгружает из памяти файл сценария и удаляет его связку с объектом.
IsScriptRunning Выясняет, прикреплён ли указанный файл сценария к объекту.
CanHandleMethod Выясняет, поддерживает ли объект метод с указанным именем.
Функции для работы со звуком
GetSoundLength Вычисляет длину звукового файла
PlaySound Воспроизводит звук. Если имя файла не указано, воспроизводится прикреплённый на настоящий момент звук (если есть).
PlaySoundEvent Воспроизводит звук и генерирует событие, когда воспроизведение закончится. Если имя файла не указано, воспроизводится прикреплённый на настоящий момент звук (если есть).
StopSound Останавливает воспроизведение звука (если есть).
PauseSound Ставит на паузу воспроизведение звука.
ResumeSound Продолжает воспроизведение после паузы.
IsSoundPlaying Выясняет, воспроизводится ли в настоящий момент звуковой файл.
SetSoundPosition Задаёт текущую позицию для воспроизведения в звуковом файле.
GetSoundPosition Возвращает текущую позицию для воспроизведения в звуковом файле
SetSoundVolume Устанавливает громкость звука.
GetSoundVolume Возвращает значение уровня громкости звука.
LoadSound Инициализирует звук из файла, подготавливая его к воспроизведению.
Звуковые эффекты
SoundFXNone Удаляет любой звуковой эффект, прикреплённый к объекту.
SoundFXEcho Задаёт эффект эха для любого звука, привязанного к объекту.
SoundFXReverb Задаёт эффект реверберации для любого звука, привязанного к объекту.
Обработка событий
ApplyEvent Вызывает указанное событие для объекта.
CanHandleEvent Выясняет, имеет ли объект обработчик для указанного события.
Разные функции
SkipTo Перемещает объект в указанную точку.
SetMousePos Перемещает курсор мыши в указанную точку.
LockMouseRect Ограничивает передвижение курсора мыши заданным прямоугольником.
QuitGame Завершает текущую игровую сессию (выход из игры).
FileExists Выясняет, существует ли указанный файл.
Screenshot Делает снимок экрана текущей игры и сохраняет его в BMP-файл.
ScreenshotEx Делает снимок экрана (с изменёнными размерами, опционально) текущей игры и сохраняет его в BMP-файл.
LoadStringTable Загружает текстовую таблицу из файла.
AddSpeechDir Добавляет папку, которая будет использоваться при автоматическом поиске речевых файлов.
RemoveSpeechDir Удаляет папку из списка существующих директорий, по которым осуществляется поиск речевых файлов.
Reset Сбрасывает постоянные данные игры.
OpenDocument Открывает указанный документ или URL в сети Интернет в связанной с данным типом файла программе.
SetLoadingScreen Задаёт изображение, которое будет отображаться во время загрузки игры.
SetSavingScreen Задаёт изображение, которое будет отображаться во время сохранения игры.
ClearScriptCache Очищает кэш сценариев движка.
DisplayLoadingIcon Мгновенно выводит пиктограмму "загружается".
HideLoadingIcon Убирает пиктограмму загрузки, отображаемую с помощью метода DisplayLoadingIcon()
StoreSaveThumbnail Сохраняет текущее изображение на экране, чтобы использовать в дальнейшем в качестве превью сохранённой игры.
DeleteSaveThumbnail Удаляет превью сохранённой игры.
Функции для работы с видео
PlayVideo Воспроизводит видео в формате AVI.
PlayTheora Воспроизводит видео в формате Theora.
Функции для работы с реестром
RegWriteNumber Записывает число в реестр Windows.
RegWriteString Записывает строку в реестр Windows.
RegReadNumber Читает число из реестра Windows.
RegReadString Читает строку из реестра Windows.
Сохранение/загрузка
SaveGame Сохраняет игру в указанный слот.
LoadGame Загружает игру из указанного слота.
IsSaveSlotUsed Выясняет, занят ли указанный слот.
GetSaveSlotDescription Возвращает описание слота.
EmptySaveSlot Очищает слот.
Функции управления громкостью
SetGlobalSFXVolume Устанавливает громкость звуковых эффектов.
SetGlobalSpeechVolume Устанавливает громкость речи.
SetGlobalMusicVolume Устанавливает громкость музыки.
SetGlobalMasterVolume Устанавливает общую громкость.
GetGlobalSFXVolume Возвращает текущий уровень громкости звуковых эффектов.
GetGlobalSpeechVolume Возвращает текущий уровень громкости речи.
GetGlobalMusicVolume Возвращает текущий уровень громкости музыки.
GetGlobalMasterVolume Возвращает текущий общий уровень громкости.
Функции управления курсором
SetCursor Устанавливает стандартный курсор.
GetCursor Возвращает имя файла спрайта курсора или null, если курсор не задан
GetCursorObject Возвращает ссылку на спрайт курсора (объект) или null, если курсор не задан
RemoveCursor Удаляет стандартный курсор.
HasCursor Выясняет, задан ли стандартный курсор для объекта.
SetActiveCursor Устанавливает активный курсор.
GetActiveCursor Возвращает имя файла спрайта активного курсора или null, если курсор не задан
GetActiveCursorObject Возвращает ссылку на спрайт активного курсора (объект) или null, если курсор не задан
RemoveActiveCursor Удаляет активный курсор.
HasActiveCursor Выясняет, задан ли активный курсор для объекта.
SetWaitCursor Устанавливает неинтерактивный курсор.
GetWaitCursor Возвращает имя файла спрайта неинтерактивного курсора или null, если курсор не задан
GetWaitCursorObject Возвращает ссылку на спрайт неинтерактивного курсора (объект) или null, если курсор не задан
RemoveWaitCursor Удаляет неинтерактивный курсор.
Эффект затуманивания
FadeOut Затуманивает экран указанным цветом.
FadeIn Прояснивает экран из заданного цвета.
GetFadeColor Возвращает текущий цвет тумана.
Функции для работы со сценами
ChangeScene Загружает файл сцены.
SetSceneViewport Задаёт область отображения сцены.
Диалоги/инвентарь
AddResponse Добавляет фразу в диалоговое окно.
AddResponseOnce Добавляет фразу в диалоговое окно. Реплика будет добавлена единожды в диалоговую ветку.
AddResponseOnceGame Добавляет фразу в диалоговое окно. Реплика будет добавлена единожды на всю игру.
ResetResponse Восстанавливает недоступную фразу (ранее выбранную).
GetResponse Отображает диалоговое окно и ожидает выбора реплики пользователем.
GetNumResponses Возвращает количество оставшихся фраз в диалоговом окне.
ClearResponses Удаляет все фразы, добавленные ранее в диалоговое окно.
GetInventoryWindow Возвращает ссылку на объект window, используемый для отображения окна инвентаря.
GetResponsesWindow Возвращает ссылку на объект window, используемый для отображения диалогового окна.
StartDlgBranch Обозначает начало диалоговой ветки.
EndDlgBranch Обозначает конец диалоговой ветки.
GetCurrentDlgBranch Возвращает имя текущей диалоговой ветки.
LoadResponseBox Загружает диалоговое окно из файла.
LoadInventoryBox Загружает окно инвентаря из файла.
LoadItems Загружает предметы инвентаря из файла.
Предметы инвентаря
TakeItem Добавляет предмет в инвентарь.
DropItem Удаляет предмет из инвентаря.
GetItem Возвращает ссылку на предмет инвентаря.
HasItem Выясняет, есть ли в инвентаре объекта (персонажа) указанный предмет.
IsItemTaken Выясняет, есть ли указанный предмет в любом из существующих в игре инвентарей.
QueryItem Запрашивает предмет (из всех, что существуют в игре).
Динамическое создание объектов
CreateEntity Создаёт новый объект сцены (entity).
DeleteEntity Удаляет объект сцены (entity).
CreateWindow Создаёт новое окно (объект window).
DeleteWindow Удаляет окно.
CreateItem Создаёт новый предмет инвентаря (объект item).
DeleteItem Удаляет предмет инвентаря.
3D-персонажи
SetShadowImage Задаёт изображение, используемое в качестве простой тени (simple) для 3D-персонажей.
GetShadowImage Возвращает изображение, используемое в настоящий момент в качестве простой тени (simple) для 3D-персонажей.
IsShadowTypeSupported Проверяет, поддерживается ли на оборудовании пользователя данный тип теней.
Специальные возможности
AccOutputText Отправляет текст на синтезатор речи.

Атрибуты

Type (только для чтения) Всегда возвращает "game"
Accelerated (только для чтения) Вернёт true, если в настоящий момент игра использует 3D-ускорение для отображения графики.
CurrentTime (только для чтения) Возвращает время, истёкшее с момента старта игры.
WindowsTime (только для чтения) Возвращает время, истёкшее с момента старта Windows.
TextEncoding Задаёт кодировку для отображения текстов в игре, 0..ANSI, 1..UTF8
TextRTL Задаёт направление отображения текстов справа-налево (для еврейского и арабского языков). Имеет эффект только при использовании шрифтов TrueType!
MouseX Координата X текущей позиции курсора мыши
MouseY Координата Y текущей позиции курсора мыши
MainObject Объект, который используется для автоскроллинга сцен. Может быть (установлен в) null
ActiveObject (только для чтения) Возвращает объект, над которым наведён курсор мыши (или null, если такового нет)
InventoryObject Объект (персонаж), чей инвентарь отображается в настоящий момент.
ScreenWidth (только для чтения) Возвращает ширину экрана в пикселях.
ScreenHeight (только для чтения) Возвращает высоту экрана в пикселях.
DebugMode (только для чтения) Выясняет, запущена ли игра в режиме отладки.
SoundAvailable (только для чтения) Выясняет, доступен ли звук в игре и включён ли.
Keyboard (только для чтения) Возвращает ссылку на объект Keyboard (состояние нажатия клавиш).
Subtitles Указывает, включены ли субтитры речи.
VideoSubtitles Указывает, включены ли субтитры для AVI/Theora видео.
SubtitlesSpeed Указывает скорость отображения субтитров речи (в мс/символ)
Scene (только для чтения) Возвращает ссылку на сцену (объект Scene), загруженную на текущий момент.
SelectedItem Выбранный на текущий момент предмет инвентаря (или null, если такового нет).
NumItems (только для чтения) Возвращает число предметов в инвентаре пользователя (по всем персонажам в совокупности).
TotalNumItems (только для чтения) Возвращает число всех предметов, определённых в игре.
SmartItemCursor Указывает, должен ли курсор мыши с выбранным предметом подсвечиваться только в том случае, если объект, над которым курсор наведён, может взаимодействовать с данным предметом.
TalkSkipButton Указывает, какая кнопка мыши будет использоваться для пропуска текста диалогов (0-левая, 1-правая, 2-обе, 3-пропуск текста отключён)
InventoryVisible Указывает, должен ли инвентарь быть видимым в настоящий момент.
InventoryScrollOffset Указывает количество прокрученных предметов в инвентаре.
ResponsesVisible (только для чтения) Выясняет, является ли видимым окно выбора реплик (например, когда ожидается выбор пользователя).
WindowedMode (только для чтения) Возвращает true, если игра запущена в оконном режиме.
Hwnd (только для чтения) Возвращает дескриптор окна игры (HWND) (полезно только для разработки плагинов).
StartupScene Имя файла сцены, которая будет загружена в начале игры.
PrevScene (только для чтения) Возвращает имя предыдущей сцены, которую посетил персонаж.
PrevSceneFilename (только для чтения) Возвращает имя файла предыдущей сцены.
LastResponse (только для чтения) Возвращает текст самой последней из выбранных реплик.
LastResponseOrig (только для чтения) Возвращает текст самой последней из выбранных реплик в оригинальной (нелокализованной) форме.
FPS (только для чтения) Возвращает текущую частоту кадров (кадр/сек)
MaxShadowType Указывает максимальную детализацию теней, которая будет использоваться в игре (0..нет, 1..простые (simple), 2..плоские (flat), 3..шаблонные (stencil))
Shadows Указывает, включены ли тени для 3D-персонажей (устарел, используйте MaxShadowType)
SimpleShadows Указывает, использовать ли для 3D-персонажей простые тени. Не имеет эффекта, если не поддерживаются тени в реальном времени (устарел, используйте MaxShadowType)
SupportsRealTimeShadows (только для чтения) Возвращает true, если видеокарта поддерживает тени в реальном времени (устарел, используйте IsShadowTypeSupported())
MaxActiveLights (только для чтения) Возвращает максимальное число активных источников света, поддерживаемое видеокартой.
HardwareTL (только для чтения) Возвращает true, если игра использует преимущество аппаратной поддержки трансформации и освещения.
Direct3DDevice (только для чтения) Возвращает указатель на объект IDirect3DDevice8/IDirect3DDevice9 (только для плагинов)
DirectDrawInterface (только для чтения) Возвращает указатель на объект IDirectDraw7 (только для плагинов)
Frozen (только для чтения) Возвращает true, если игра нахожится в «замороженном» состоянии (пауза)
SoundBufferSize Задаёт размер звукового буфера в секундах
SuspendedRendering Указывает, следует ли игре обновлять экран. Используйте данный параметр с осторожностью.
Name Внутреннее имя объекта.
Caption Заголовок объекта.
AccCaption Специальный заголовок объекта, используемый специальными фукциями движка для людей с ослабленным зрением.
X Координата X объекта.
Y Координата Y объекта.
Height (только для чтения) Возвращает текущую высоту объекта (учитывает масштаб персонажей).
Filename (только для чтения) Возвращает имя файла объекта.
Ready (только для чтения) Возвращает true, если объект в настоящий момент не совершает никакого действия.
Interactive Указывает, должен ли объект реагировать на действия пользователя (быть интерактивным).
SoundPanning Указывает, должен ли звук, воспроизводимый данным объектом, панорамироваться в зависимости от его позиции на экране.
NonIntMouseEvents Указывает, должен ли объект реагировать на события MouseEntry и MouseLeave, даже в том случае, если игра работает в неинтерактивном режиме.
AccTTSEnabled (только для чтения) Специальные возможности: голосовой вывод текста включён
AccTTSCaptions (только для чтения) Специальные возможности: голосовой вывод текста для заголовков предметов включён
AccTTSTalk (только для чтения) Специальные возможности: голосовой вывод текста для диалоговых реплик включён
AccTTSKeypress (только для чтения) Специальные возможности: голосовой вывод текста для нажимаемых клавиш включён
AccKeyboardEnabled (только для чтения) Специальные возможности: подсвечивание активных объектов включено
AccKeyboardCursorSkip (только для чтения) Специальные возможности: подсвечивание активных объектов автоматически помещает над ними указатель мыши
AccKeyboardPause (только для чтения) Специальные возможности: остановка игры (пауза) по сочетанию клавиш Ctrl+Space включена
SuppressScriptErrors Указывает, следует ли WME отображать предупреждение на экране в случае возникновения ошибки в выполняемом сценарии.
ChangingScene (только для чтения) Выясняет, происходит ли в настоящий момент смена сцен.

Низкоуровневые события

LeftClick Была нажата левая кнопка мыши.
RightClick Была нажата правая кнопка мыши.
MiddleClick Была нажата средняя кнопка мыши.
LeftDoubleClick Был сделан двойной щелчок левой кнопкой мыши.
RightDoubleClick Был сделан двойной щелчок правой кнопкой мыши.
LeftRelease Была отпущена левая кнопка мыши.
RightRelease Была отпущена правая кнопка мыши.
MiddleRelease Была отпущена средняя кнопка мыши.
MouseWheelUp Колёсико мыши было прокручено вверх.
MouseWheelDown Колёсико мыши было прокручено вниз.
Keypress Была нажата клавиша. Для выяснения деталей (какая клавиша была нажата и др.), используйте переменную Keyboard.
BeforeSave Игра находится в состоянии перед сохранением.
AfterLoad Только что была загружена сохранённая игра.

LOG(Text)

Записывает строку текста в файл системного журнала.

Параметры

Text
Текстовая строка для записи в файл системного журнала.

Примечания

Когда игра запущена в режиме отладки, она генерирует файл wme.log в той же папке, где находится файл описания проекта. С помощью этого метода Вы можете записывать собственные диагностические сообщения.


Msg(Text)

Выводит окно сообщения на экран.

Параметры

Text
Текстовая строка для вывода на экран.

Примечания

Выводимое текстовое сообщение исчезает через несколько секунд.


DumpTextureStats(Filename)

Записывает информацию о состоянии использования текстур в текстовый файл в формате CSV.

Параметры

Filename
Имя файла для экспорта.

Примечания

Этот метод доступен только в том случае, когда игра работает в режиме 3D-ускорения.


ValidObject(Object)

Выясняет, является ли верной текущая ссылка на объект.

Параметры

Object
Проверяемая ссылка на объект.

Возвращаемое значение

Если ссылка верна, метод вернёт значение true.

Примечания

Если в качестве значения Вы присваиваете переменной ссылку на объект, то Вы должны быть уверены, что этот объект существует, т. к. объекты могут быть выгружены из памяти (непосредственно или, к примеру, при переходе персонажа в другую сцену).


UnloadObject(Object)

Удаляет объект из памяти.

Параметры

Object
Объект для удаления.

Примечания

Если Вы загружаете объекты с помощью методов Game.LoadActor, Game.LoadEntity или других подобных, то Вам следует выгружать их из памяти после того, как они будут больше не нужны. Иначе эти объекты будут ликвидированы только при выходе из игры.


LoadActor(Filename)

Загружает персонаж из файла.

Параметры

Filename
Имя файла описания персонажа для загрузки.

Возвращаемое значение

Ссылка на объект Actor. Если метод не сможет создать объект, он вернёт значение null.


LoadActor3D(Filename)

Загружает 3D-персонаж из файла.

Параметры

Filename
Имя файла описания 3D-персонажа для загрузки.

Возвращаемое значение

Ссылка на объект 3D actor. Если метод не сможет создать объект, он вернёт значение null.


LoadEntity(Filename)

Загружает объект сцены (entity) из файла.

Параметры

Filename
Имя файла описания объекта сцены для загрузки.

Возвращаемое значение

Ссылка на объект Entity. Если метод не сможет создать объект, он вернёт значение null.


LoadWindow(Filename)

Загружает окно из файла.

Параметры

Filename
Имя файла описания окна для загрузки.

Возвращаемое значение

Ссылка на объект Window. Если метод не сможет создать объект, он вернёт значение null.


ExpandString(String)

Форматирует переданную в качестве аргумента строку, основываясь на текстовой таблице.

Параметры

String
Строка, которую следует отформатировать.

Возвращаемое значение

Отформатированная строка.

Примечания

Внимание: такие методы, как Actor.Talk() форматируют строки автоматически, Вам не нужно делать это самостоятельно.


MusicCrossfade(Channel1, Channel2, Time, SwapChannels)

Осуществляет плавное затухание звука в одном канале и нарастание в другом

Параметры

Channel1
Канал, в котором звук будет затухать
Channel2
Канал, в котором звук будет нарастать
Time
Период времени, в течение которого произойдёт плавный переход одной мелодии в другую
SwapChannels
Указывает, должны ли каналы поменяться номерами после перехода (необязательный параметр, по умолчанию = true)

Примечания

Допустимо использование в текущий момент времени только одного перетекания мелодии из одной в другую.


PlayMusic(Filename, Looping, LoopStart)

Начинает воспроизведение музыки.

Параметры

Filename
Музыкальный файл для воспроизведения.
Looping
Указывает, должно ли воспроизведение повторяться при достижении конца файла (необязательный параметр, по умолчанию = true).
LoopStart
Позиция, с которой следует начинает повторное воспроизведение при Looping = true, в мс (необязательный параметр, по умолчанию = 0).

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


StopMusic()

Останавливает воспроизведение музыки.

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


PauseMusic()

Ставит на паузу воспроизведение музыки.

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


ResumeMusic()

Продолжает воспроизведение после паузы.

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


SetMusicPosition(Time)

Задаёт текущую позицию для воспроизведения в музыкальном файле.

Параметры

Time
Новая позиция (в мс)

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


GetMusicPosition()

Возвращает текущую позицию для воспроизведения в музыкальном файле

Возвращаемое значение

Позиция в мс.


IsMusicPlaying()

Выясняет, идёт ли в настоящий момент воспроизведение музыки

Возвращаемое значение

Возвращает true, если музыка играет.


GetMusic()

Возвращает имя файла, проигрываемого в настоящий момент

Возвращаемое значение

Имя музыкального файла или null, если музыка не играет.


SetMusicVolume(Volume)

Устанавливает громкость музыки.

Параметры

Volume
Уровень громкости в процентах.

GetMusicVolume()

Возвращает значение текущего уровня громкости.

Возвращаемое значение

Уровень громкости в процентах.


PlayMusicChannel(Channel, Filename, Looping, LoopStart)

Воспроизводит музыку на заданном канале.

Параметры

Channel
Номер канала
Filename
Музыкальный файл для воспроизведения.
Looping
Указывает, должно ли воспроизведение повторяться при достижении конца файла (необязательный параметр, по умолчанию = true).
LoopStart
Позиция, с которой следует начинает повторное воспроизведение при Looping = true, в мс (необязательный параметр, по умолчанию = 0).

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


StopMusicChannel(Channel)

Останавливает воспроизведение музыки на заданном канале.

Параметры

Channel
Номер канала

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


PauseMusicChannel(Channel)

Ставит на паузу воспроизведение музыки на заданном канале.

Параметры

Channel
Номер канала

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


ResumeMusicChannel(Channel)

Продолжает воспроизведение после паузы на заданном канале.

Параметры

Channel
Номер канала

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


SetMusicChannelPosition(Channel, Time)

Задаёт текущую позицию для воспроизведения в музыкальном файле на заданном канале.

Параметры

Channel
Номер канала
Time
Новая позиция (в мс)

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


GetMusicChannelPosition(Channel)

Возвращает текущую позицию для воспроизведения в музыкальном файле на заданном канале.

Параметры

Channel
Номер канала

Возвращаемое значение

Позиция в мс.


IsMusicChannelPlaying(Channel)

Выясняет, идёт ли в настоящий момент воспроизведение музыки на заданном канале

Параметры

Channel
Номер канала

Возвращаемое значение

Возвращает true, если музыка играет.


GetMusicChannel(Channel)

Возвращает имя файла, проигрываемого в настоящий момент на заданном канале

Параметры

Channel
Номер канала

Возвращаемое значение

Имя музыкального файла или null, если музыка не играет.


SetMusicChannelVolume(Channel, Volume)

Устанавливает громкость музыки на заданном канале.

Параметры

Channel
Номер канала
Volume
Уровень громкости в процентах

GetMusicChannelVolume(Channel)

Возвращает значение текущего уровня громкости на заданном канале.

Параметры

Channel
Номер канала

Возвращаемое значение

Уровень громкости в процентах.


AttachScript(Filename)

Выполняет файл сценария и прикрепляет его к объекту.

Параметры

Filename
Имя файла сценария.

Возвращаемое значение

Возвращает true, если сценарий был успешно выполнен.

Примечания

К каждому объекту WME можно прикреплять несколько сценариев.


DetachScript(Filename, KillThreads)

Выгружает из памяти файл сценария и удаляет его связку с объектом.

Параметры

Filename
Имя файла сценария.
KillThreads
Указывает, нужно ли выгружать из памяти всё запущенные экземляры (threads) этого сценария (необязательный параметр, по умолчанию = false)

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.

Примечания

Экземпляры сценария (threads) - это исполняемые в настоящий момент обработчики событий и методы, которые тем или иным образом включают в себя выполнение данного сценария.


IsScriptRunning(Filename)

Выясняет, прикреплён ли указанный файл сценария к объекту.

Параметры

Filename
Имя файла сценария.

Возвращаемое значение

Возвращает true, если указанный сценарий прикреплён к объекту.


CanHandleMethod(MethodName)

Выясняет, поддерживает ли объект метод с указанным именем.

Параметры

MethodName
Название метода.

Возвращаемое значение

Возвращает true, если объект поддерживает метод с указанным именем.


GetSoundLength(SoundFilename)

Вычисляет длину звукового файла

Параметры

SoundFilename
Имя звукового файла

Возвращаемое значение

Длина файла в мс.


PlaySound(Filename, Looping, LoopStart)
PlaySound(Looping, LoopStart)

Воспроизводит звук. Если имя файла не указано, воспроизводится прикреплённый на настоящий момент звук (если есть).

Параметры

Filename
Имя звукового файла
Looping
Указывает, нужно ли зациклить воспроизведение звука (необязательный параметр, по умолчанию = false).
LoopStart
Позиция в мс, с которой будет начинаться воспроизведение при включённом зацикливании (необязательный параметр, по умолчанию = 0).

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


PlaySoundEvent(Filename, EventName)
PlaySoundEvent(EventName)

Воспроизводит звук и генерирует событие, когда воспроизведение закончится. Если имя файла не указано, воспроизводится прикреплённый на настоящий момент звук (если есть).

Параметры

Filename
Имя звукового файла
EventName
Имя события, которое будет сгенерировано после окончания воспроизведения звука.

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


StopSound()

Останавливает воспроизведение звука (если есть).

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


PauseSound()

Ставит на паузу воспроизведение звука.

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


ResumeSound()

Продолжает воспроизведение после паузы.

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


IsSoundPlaying()

Выясняет, воспроизводится ли в настоящий момент звуковой файл.

Возвращаемое значение

Если звук воспроизводится, метод вернёт true.


SetSoundPosition(Time)

Задаёт текущую позицию для воспроизведения в звуковом файле.

Параметры

Time
Новая позиция в мс

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


GetSoundPosition()

Возвращает текущую позицию для воспроизведения в звуковом файле

Возвращаемое значение

Позиция в мс.


SetSoundVolume(Volume)

Устанавливает громкость звука.

Параметры

Volume
Уровень громкости в процентах.

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


GetSoundVolume()

Возвращает значение уровня громкости звука.

Возвращаемое значение

Текущий уровень громкости в процентах.


LoadSound(Filename)

Инициализирует звук из файла, подготавливая его к воспроизведению.

Параметры

Filename
Имя звукового файла.

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.

Примечания

Этот метод используется для кэширования звуковых файлов. Инициализация звука занимает некоторое время, поэтому желательно разместить её в стартовом сценарии сцены, чтобы метод PlaySound не замедлял игру. Для этой цели и служит метод LoadSound. Чтобы воспроизвести кэшированный звук, нужно просто вызвать метод PlaySound без указания имени файла, например, SomeObject.PlaySound(false);


SoundFXNone()

Удаляет любой звуковой эффект, прикреплённый к объекту.


SoundFXEcho(WetDryMix, Feedback, LeftDelay, RightDelay)

Задаёт эффект эха для любого звука, привязанного к объекту.

Параметры

WetDryMix
Микс влажность/сухость, в процентах (0 - 100)
Feedback
Обратная отдача, в процентах (0 - 100)
LeftDelay
Задержка слева, в мс (1 - 2000)
RightDelay
Задержка справа, в мс (1 - 2000)

Примечания

Пример: actor.SoundFXEcho(50, 50);


SoundFXReverb(InGain, ReverbMix, ReverbTime, HighFreqRTRatio)

Задаёт эффект реверберации для любого звука, привязанного к объекту.

Параметры

InGain
Прирост, в дБ (-96 - 0)
ReverbMix
Реверберация, в дБ (-96 - 0)
ReverbTime
Время реверберации, в мс (0.001 - 3000)
HighFreqRTRatio
Коэффициент высоких частот (0.001 - 0.999)

Примечания

Пример: actor.SoundFXReverb(0, 0, 2000);


ApplyEvent(EventName)

Вызывает указанное событие для объекта.

Параметры

EventName
Имя события.

Возвращаемое значение

Возвращает true, если событие было вызвано успешно.


CanHandleEvent(EventName)

Выясняет, имеет ли объект обработчик для указанного события.

Параметры

EventName
Имя события.

Возвращаемое значение

Возвращает true, если объект может обрабатывать запрашиваемое событие.


SkipTo(X, Y)

Перемещает объект в указанную точку.

Параметры

X
Координата X.
Y
Координата Y.

SetMousePos(X, Y)

Перемещает курсор мыши в указанную точку.

Параметры

X
Координата X.
Y
Координата Y.

LockMouseRect(Left, Top, Right, Bottom)

Ограничивает передвижение курсора мыши заданным прямоугольником.

Параметры

Left
Левый край прямоугольника.
Top
Верхний край прямоугольника.
Right
Правый край прямоугольника.
Bottom
Нижний край прямоугольника.

Примечания

Вызвав этот метод без параметров (или передав ему одни нули), можно блокировать курсор мыши.


QuitGame()

Завершает текущую игровую сессию (выход из игры).


FileExists(Filename)

Выясняет, существует ли указанный файл.

Параметры

Filename
Имя файла.

Возвращаемое значение

Если файл существует, метод вернёт true.


Screenshot(Name)

Делает снимок экрана текущей игры и сохраняет его в BMP-файл.

Параметры

Name
Базовое имя, используемое для генерации BMP-файла (необязательный параметр, по умолчанию = Game.Name)

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


ScreenshotEx(Filename, Width, Height)

Делает снимок экрана (с изменёнными размерами, опционально) текущей игры и сохраняет его в BMP-файл.

Параметры

Filename
Имя BMP-файла.
Width
Результирующая ширина снимка.
Height
Результирующая высота снимка.

Возвращаемое значение

В случае удачного выполнения, метод вернёт значение true.


LoadStringTable(Filename, ClearOld)

Загружает текстовую таблицу из файла.

Параметры

Filename
Имя файла текстовой таблицы.
ClearOld
Удалять старые строки из текстовой таблицы (необязательный параметр, по умолчанию = true)

Примечания

Текстовая таблица НЕ является частью сохранённой игры. Вам нужно либо предоставлять пользователю выбор языка каждый раз при старте игры, либо сохранять настройки в реестре.


AddSpeechDir(Directory)

Добавляет папку, которая будет использоваться при автоматическом поиске речевых файлов.

Параметры

Directory
Имя папки, в которой будет осуществляться поиск.

Примечания

По умолчанию, WME ищет речевые файлы только в папке speech.


RemoveSpeechDir(Directory)

Удаляет папку из списка существующих директорий, по которым осуществляется поиск речевых файлов.

Параметры

Directory
Имя папки.

Reset()

Сбрасывает постоянные данные игры.

Примечания

Этот метод очищает состояния сцен, выбранные действия, сбрасывает таймер, а также очищает все глобальные переменные, за исключением тех, которые содержат объекты игры (такие, как окна или объекты сцены (entities)). Используйте данный метод, если желаете начать новую игру.


OpenDocument(Filename)

Открывает указанный документ или URL в сети Интернет в связанной с данным типом файла программе.

Параметры

Filename
Имя файла

Примечания

Этот метод использует расширение ассоциаций Windows для запуска соответствующей типу файла программы. Важно то, что файл документа НЕ ДОЛЖЕН находиться внутри какого-либо из пакетов игры. Следует указывать полный путь до файла либо относительно директории игры.


SetLoadingScreen(ImageFilename, PosX, PosY)

Задаёт изображение, которое будет отображаться во время загрузки игры.

Параметры

ImageFilename
Имя файла изображения или null
PosX
Координата X изображения
PosY
Координата Y изображения

SetSavingScreen(ImageFilename, PosX, PosY)

Задаёт изображение, которое будет отображаться во время сохранения игры.

Параметры

ImageFilename
Имя файла изображения или null
PosX
Координата X изображения
PosY
Координата Y изображения

ClearScriptCache()

Очищает кэш сценариев движка.

Примечания

Обычно движок кэширует скомпилированные сценарии, благодарю чему их не требуется компилировать много раз. Очистка кэша может понадобиться, например, если Вы генерируете сценарии динамически и их требуется каждый раз компилировать заново.


DisplayLoadingIcon(Sprite, X, Y, Persistent)

Мгновенно выводит пиктограмму "загружается".

Параметры

Sprite
Имя файла спрайта пиктограммы.
X
Координата X пиктограммы.
Y
Координата Y пиктограммы.
Persistent
Указывает, должна ли пиктограмма оставаться на экране до тех пор, пока не будет вызван метод HideLoadingIcon() (необязательный параметр, по умолчанию = false)

Примечания

Вы можете использовать эту функцию для отображения символа "в процессе"; например, перед вызовом команды, которая займёт много времени (загрузка окна, продолжительная анимация и т. д.). Пиктограмма отображается до тех пор, пока сценарий не вернёт управление движку, если только праметр Persistent не установлен в true. В этом случае Вам следует вручную скрыть пиктограмму, вызвав метод Game.HideLoadingIcon().


HideLoadingIcon()

Убирает пиктограмму загрузки, отображаемую с помощью метода DisplayLoadingIcon()


StoreSaveThumbnail()

Сохраняет текущее изображение на экране, чтобы использовать в дальнейшем в качестве превью сохранённой игры.

Возвращаемое значение

Возвращает true в случае успеха.

Примечания

Как правило, снимок экрана делается движком непосредственно перед сохранением игры. Но иногда это бывает нежелательно. С помощью данного метода Вы можете точно поймать момент, в который следует сгенерировать превью. Он используется непосредственно перед вызовом метода Game.SaveGame().


DeleteSaveThumbnail()

Удаляет превью сохранённой игры.

Возвращаемое значение

Возвращает true в случае успеха.

Примечания

Удаляет превью, сгенерированное ранее методом Game.StoreSaveThumbnail().


PlayVideo(Filename, Type, X, Y, FreezeMusic)

Воспроизводит видео в формате AVI.

Параметры

Filename
Имя видеофайла.
Type
Тип дисплея, 0 = в заданной позиции, 1 = растянутый, 2 = центрированный (необязательный параметр, по умолчанию = 1)
X
Координата X позиции на экране. Используется только если Type = 0 (необязательный параметр, по умолчанию = 0)
Y
Координата Y позиции на экране. Используется только если Type = 0 (необязательный параметр, по умолчанию = 0)
FreezeMusic
Указывает, должна ли фоновая музыка быть остановлена на время воспроизведения видео (необязательный параметр, по умолчанию = true)

Возвращаемое значение

Возвращает true в случае успеха.


PlayTheora(Filename, Type, X, Y, FreezeMusic, DropFrames)

Воспроизводит видео в формате Theora.

Параметры

Filename
Имя видеофайла.
Type
Тип дисплея, 0 = в заданной позиции, 1 = растянутый, 2 = центрированный (необязательный параметр, по умолчанию = 1)
X
Координата X позиции на экране. Используется только если Type = 0 (необязательный параметр, по умолчанию = 0)
Y
Координата Y позиции на экране. Используется только если Type = 0 (необязательный параметр, по умолчанию = 0)
FreezeMusic
Указывает, должна ли фоновая музыка быть остановлена на время воспроизведения видео (необязательный параметр, по умолчанию = true)
DropFrames
Указывает, следует ли пропускать кадры при воспроизведении, если оно идёт слишком медленно (необязательный параметр, по умолчанию = true)

Возвращаемое значение

Возвращает true в случае успеха.


RegWriteNumber(Key, Value)

Записывает число в реестр Windows.

Параметры

Key
Имя параметра (ключ), который следует записать.
Value
Число (значение ключа), которое следует записать.

RegWriteString(Key, Value)

Записывает строку в реестр Windows.

Параметры

Key
Имя параметра (ключ), который следует записать.
Value
Строка для записи.

RegReadNumber(Key, InitValue)

Читает число из реестра Windows.

Параметры

Key
Имя параметра (ключ), который следует прочитать.
InitValue
Начальное значение, которое следует вернуть, если указанный ключ не существует (необязательный параметр, по умолчанию = null)

Возвращаемое значение

Число, прочитанное из реестра Windows.


RegReadString(Key, InitValue)

Читает строку из реестра Windows.

Параметры

Key
Имя параметра (ключ), который следует прочитать.
InitValue
Начальное значение, которое следует вернуть, если указанный ключ не существует (необязательный параметр, по умолчанию = null).

Возвращаемое значение

Строка, прочитанная из реестра Windows.


SaveGame(Slot, Description)

Сохраняет игру в указанный слот.

Параметры

Slot
Номер слота.
Description
Описание сохранённой игры.

Возвращаемое значение

Возвращает true в случае успеха.


LoadGame(Slot)

Загружает игру из указанного слота.

Параметры

Slot
Номер слота.

Возвращаемое значение

Если загрузка не будет успешной, метод вернёт false.


IsSaveSlotUsed(Slot)

Выясняет, занят ли указанный слот.

Параметры

Slot
Номер слота.

Возвращаемое значение

Если указанный слот уже используется, метод вернёт true.


GetSaveSlotDescription(Slot)

Возвращает описание слота.

Параметры

Slot
Номер слота.

Возвращаемое значение

Описание слота.


EmptySaveSlot(Slot)

Очищает слот.

Параметры

Slot
Номер слота.

SetGlobalSFXVolume(Percent)

Устанавливает громкость звуковых эффектов.

Параметры

Percent
Уровень громкости в процентах.

Возвращаемое значение

Возвращает true в случае успеха.


SetGlobalSpeechVolume(Percent)

Устанавливает громкость речи.

Параметры

Percent
Уровень громкости в процентах.

Возвращаемое значение

Возвращает true в случае успеха.


SetGlobalMusicVolume(Percent)

Устанавливает громкость музыки.

Параметры

Percent
Уровень громкости в процентах.

Возвращаемое значение

Возвращает true в случае успеха.


SetGlobalMasterVolume(Percent)

Устанавливает общую громкость.

Параметры

Percent
Уровень громкости в процентах.

Возвращаемое значение

Возвращает true в случае успеха.


GetGlobalSFXVolume()

Возвращает текущий уровень громкости звуковых эффектов.

Возвращаемое значение

Уровень громкости в процентах.


GetGlobalSpeechVolume()

Возвращает текущий уровень громкости речи.

Возвращаемое значение

Уровень громкости в процентах.


GetGlobalMusicVolume()

Возвращает текущий уровень громкости музыки.

Возвращаемое значение

Уровень громкости в процентах.


GetGlobalMasterVolume()

Возвращает текущий общий уровень громкости.

Возвращаемое значение

Уровень громкости в процентах.


SetCursor(Filename)

Устанавливает стандартный курсор.

Параметры

Filename
Имя файла спрайта, который будет использоваться в качестве указателя.

Возвращаемое значение

Возвращает true в случае успеха.


GetCursor()

Возвращает имя файла спрайта курсора или null, если курсор не задан


GetCursorObject()

Возвращает ссылку на спрайт курсора (объект) или null, если курсор не задан


RemoveCursor()

Удаляет стандартный курсор.


HasCursor()

Выясняет, задан ли стандартный курсор для объекта.

Возвращаемое значение

Возвращает true, если для объекта задан свой собственный стандартный курсор.


SetActiveCursor(Filename)

Устанавливает активный курсор.

Параметры

Filename
Имя файла спрайта, который будет использоваться в качестве указателя.

Возвращаемое значение

Возвращает true в случае успеха.

Примечания

"Активный" курсор используется в том случае, когда курсор мыши наведён на интерактивный объект.


GetActiveCursor()

Возвращает имя файла спрайта активного курсора или null, если курсор не задан


GetActiveCursorObject()

Возвращает ссылку на спрайт активного курсора (объект) или null, если курсор не задан


RemoveActiveCursor()

Удаляет активный курсор.


HasActiveCursor()

Выясняет, задан ли активный курсор для объекта.

Возвращаемое значение

Возвращает true, если для объекта задан свой собственный активный курсор.


SetWaitCursor(Filename)

Устанавливает неинтерактивный курсор.

Параметры

Filename
Имя файла спрайта, который будет использоваться в качестве указателя.

Возвращаемое значение

Возвращает true в случае успеха.


GetWaitCursor()

Возвращает имя файла спрайта неинтерактивного курсора или null, если курсор не задан


GetWaitCursorObject()

Возвращает ссылку на спрайт неинтерактивного курсора (объект) или null, если курсор не задан


RemoveWaitCursor()

Удаляет неинтерактивный курсор.


FadeOut(Duration, TargetRed, TargetGreen, TargetBlue, TargetAlpha)
FadeOutAsync(Duration, TargetRed, TargetGreen, TargetBlue, TargetAlpha)
SystemFadeOut(Duration, TargetRed, TargetGreen, TargetBlue, TargetAlpha)
SystemFadeOutAsync(Duration, TargetRed, TargetGreen, TargetBlue, TargetAlpha)

Затуманивает экран указанным цветом.

Параметры

Duration
Указывает, как долго будет длиться процесс затуманивания, в мс (необязательный параметр, по умолчанию = 500)
TargetRed
Красная составляющая цвета тумана (необязательный параметр, по умолчанию = 0)
TargetGreen
Зелёная составляющая цвета тумана (необязательный параметр, по умолчанию = 0)
TargetBlue
Синяя составляющая цвета тумана (необязательный параметр, по умолчанию = 0)
TargetAlpha
Альфа-составляющая (прозрачность) цвета тумана (необязательный параметр, по умолчанию = 255)

Примечания

Метод FadeOut блокирует выполнение сценария до тех пор, пока процесс затуманивания не будет завершён, метод FadeOutAsync работает параллельно со сценарием. Методы SystemFadeOut и SystemFadeOutAsync продолжают свою работу даже после того, как игра входит в эксклюзивный системный режим.


FadeIn(Duration, SourceRed, SourceGreen, SourceBlue, SourceAlpha)
FadeInAsync(Duration, SourceRed, SourceGreen, SourceBlue, SourceAlpha)
SystemFadeIn(Duration, SourceRed, SourceGreen, SourceBlue, SourceAlpha)
SystemFadeInAsync(Duration, SourceRed, SourceGreen, SourceBlue, SourceAlpha)

Прояснивает экран из заданного цвета.

Параметры

Duration
Указывает, как долго будет длиться данный процесс, в мс (необязательный параметр, по умолчанию = 500)
TargetRed
Красная составляющая цвета тумана (необязательный параметр, по умолчанию = 0)
TargetGreen
Зелёная составляющая цвета тумана (необязательный параметр, по умолчанию = 0)
TargetBlue
Синяя составляющая цвета тумана (необязательный параметр, по умолчанию = 0)
TargetAlpha
Альфа-составляющая (прозрачность) цвета тумана (необязательный параметр, по умолчанию = 255)

Примечания

Метод FadeIn блокирует выполнение сценария до тех пор, пока процесс прояснивания не будет завершён, метод FadeInAsync работает параллельно со сценарием. Методы SystemFadeIn и SystemFadeInAsync продолжают свою работу даже после того, как игра входит в эксклюзивный системный режим.


GetFadeColor()

Возвращает текущий цвет тумана.

Возвращаемое значение

Цвет тумана в цветовом числовом формате (RGB).

Примечания

Вы можете использовать методы GetRValue(), GetGValue(), GetBValue() и GetAValue() для получения конкретных составляющих цвета.


ChangeScene(Filename, FadeOut, FadeIn)

Загружает файл сцены.

Параметры

Filename
Имя файла сцены.
FadeOut
Указывает, должна ли предыдущая сцена плавно раствориться (необязательный параметр, по умолчанию = true)
FadeIn
Указывает, должна ли новая сцена плавно проясниться (необязательный параметр, по умолчанию = true)

SetSceneViewport(X, Y, Width, Height)

Задаёт область отображения сцены.

Параметры

X
Координата X области отображения.
Y
Координата Y области отображения.
Width
Ширина области отображения.
Height
Высота области отображения.

Примечания

Этот метод влияет на все сцены (в отличие от Scene.SetViewport). Вызвав этот метод без параметров, Вы можете задать область отображения на полный экран.


AddResponse(ID, Response, IconFilename, HoverIconFilename, PressedIconFilename, FontFilename)

Добавляет фразу в диалоговое окно.

Параметры

ID
Уникальный идентификатор фразы.
Response
Текст фразы.
IconFilename
Файл спрайта для этой фразы (необязательный параметр).
HoverIconFilename
Файл спрайта для этой фразы при наведённом курсоре мыши (необязательный параметр).
PressedIconFilename
Файл спрайта для этой фразы в нажатом состоянии (необязательный параметр).
FontFilename
Файл шрифта (необязательный параметр).

AddResponseOnce(ID, Response, IconFilename, HoverIconFilename, PressedIconFilename, FontFilename)

Добавляет фразу в диалоговое окно. Реплика будет добавлена единожды в диалоговую ветку.

Параметры

ID
Уникальный идентификатор фразы.
Response
Текст фразы.
IconFilename
Файл спрайта для этой фразы (необязательный параметр).
HoverIconFilename
Файл спрайта для этой фразы при наведённом курсоре мыши (необязательный параметр).
PressedIconFilename
Файл спрайта для этой фразы в нажатом состоянии (необязательный параметр).
FontFilename
Файл шрифта (необязательный параметр).

Примечания

Реплика будет добавлена в диалоговое окно только в том случае, если она не была выбрана до этого пользователем в текущей ветке диалога. Нужно обязательно обозначить ветку диалога с помощью методов Game.StartDlgBranch() и Game.EntDlgBranch(), чтобы данный метод работал.


AddResponseOnceGame(ID, Response, IconFilename, HoverIconFilename, PressedIconFilename, FontFilename)

Добавляет фразу в диалоговое окно. Реплика будет добавлена единожды на всю игру.

Параметры

ID
Уникальный идентификатор фразы.
Response
Текст фразы.
IconFilename
Файл спрайта для этой фразы (необязательный параметр).
HoverIconFilename
Файл спрайта для этой фразы при наведённом курсоре мыши (необязательный параметр).
PressedIconFilename
Файл спрайта для этой фразы в нажатом состоянии (необязательный параметр).
FontFilename
Файл шрифта (необязательный параметр).

Примечания

Реплика будет добавлена в диалоговое окно только в том случае, если она не была выбрана до этого пользователем. Нужно обязательно обозначить ветку диалога с помощью методов Game.StartDlgBranch() и Game.EntDlgBranch(), чтобы данный метод работал.


ResetResponse(ID)

Восстанавливает недоступную фразу (ранее выбранную).

Параметры

ID
Уникальный идентификатор фразы.

Примечания

Если реплика была добавлена с помощью метода Game.AddResponseOnce() или Game.AddResponseOnceGame(), она будет более недоступна после того, как пользователь однажды выберет её. Метод ResetResponse используется для того, чтобы она снова появилась.


GetResponse(AutoSelectLastResp)

Отображает диалоговое окно и ожидает выбора реплики пользователем.

Параметры

AutoSelectLastResp
Указывает, должна ли последняя из оставшихся фраз выбираться автоматически (необязательный параметр, по умолчанию = false)

Возвращаемое значение

Уникальный идентификатор выбранной фразы.


GetNumResponses()

Возвращает количество оставшихся фраз в диалоговом окне.

Возвращаемое значение

Количество оставшихся фраз в диалоговом окне.

Примечания

Некоторые из реплик, добавленных методом AddResponseOnce или AddResponseOnceGame, могут уже не появиться в диалоговом окне по причине того, что уже были выбраны ранее. Используйте данный метод, чтобы узнать сколько реплик доступно на текущий момент в диалоговом окне.


ClearResponses()

Удаляет все фразы, добавленные ранее в диалоговое окно.


GetInventoryWindow()

Возвращает ссылку на объект window, используемый для отображения окна инвентаря.

Возвращаемое значение

Ссылка на объект window.


GetResponsesWindow()

Возвращает ссылку на объект window, используемый для отображения диалогового окна.

Возвращаемое значение

Ссылка на объект window.


StartDlgBranch(DialogueName)

Обозначает начало диалоговой ветки.

Параметры

DialogueName
Имя ветки. Оно должно быть уникальным внутри одного файла сценария. Этот параметр не является обязательным, тем не менее рекомендуется его указывать.

Примечания

Диалоговую ветку требуется точно обозначать только в том случае, если Вы собираетесь использовать методы Game.AddResponseOnce() или Game.AddResponseOnceGame().


EndDlgBranch(DialogueName)

Обозначает конец диалоговой ветки.

Параметры

DialogueName
Имя ветки. Оно должно быть уникальным внутри одного файла сценария. Этот параметр не является обязательным, тем не менее рекомендуется его указывать.

Примечания

Диалоговую ветку требуется точно обозначать только в том случае, если Вы собираетесь использовать методы Game.AddResponseOnce() или Game.AddResponseOnceGame().


GetCurrentDlgBranch()

Возвращает имя текущей диалоговой ветки.

Возвращаемое значение

Имя текущей диалоговой ветки (обозначенной методом Game.StartDlgBranch) или null, если диалоговая ветка не была начата.


LoadResponseBox(Filename)

Загружает диалоговое окно из файла.

Параметры

Filename
Файл определения диалогового окна.

Возвращаемое значение

Возвращает true в случае успеха.


LoadInventoryBox(Filename)

Загружает окно инвентаря из файла.

Параметры

Filename
Файл определения окна инвентаря.

Возвращаемое значение

Возвращает true в случае успеха.


LoadItems(Filename, Merge)

Загружает предметы инвентаря из файла.

Параметры

Filename
Файл определения предметов инвентаря.
Merge
Указывает, должны ли новые предметы добавляться к уже существующим или же замещать их (необязательный параметр, по умолчанию = false)

Возвращаемое значение

Возвращает true в случае успеха.


TakeItem(ItemName, InsertAfter)

Добавляет предмет в инвентарь.

Параметры

ItemName
Имя предмета.
InsertAfter
Имя предмета, после которого следует вставить данный предмет (необязательный параметр).

DropItem(ItemName)

Удаляет предмет из инвентаря.

Параметры

ItemName
Имя предмета.

GetItem(ItemIndex)
GetItem(ItemName)

Возвращает ссылку на предмет инвентаря.

Параметры

ItemIndex
Индекс взятого предмета.
ItemName
Имя предмета.

Возвращаемое значение

Ссылка на объект item в инвентаре.


HasItem(ItemName)
HasItem(ItemObject)

Выясняет, есть ли в инвентаре объекта (персонажа) указанный предмет.

Параметры

ItemName
Имя предмета.
ItemObject
Ссылка на предмет (объект item).

Возвращаемое значение

Если указанный предмет есть в инвентаре объекта (персонажа), метод вернёт true.

Примечания

Следует обратить внимание, что данный метод ищет предмет в инвентаре только текущего объекта (персонажа), если Вам нужно просмотреть все существующие инвентари, используйте метод Game.IsItemTaken().


IsItemTaken(ItemName)
IsItemTaken(ItemObject)

Выясняет, есть ли указанный предмет в любом из существующих в игре инвентарей.

Параметры

ItemName
Имя предмета.
ItemObject
Ссылка на предмет (объект item).

Возвращаемое значение

Если указанный предмет есть в каком-либо из существующих в игре инвентарей, метод вернёт true.


QueryItem(ItemName)
QueryItem(ItemIndex)

Запрашивает предмет (из всех, что существуют в игре).

Параметры

ItemName
Имя предмета.
ItemIndex
Индекс предмета.

Возвращаемое значение

Ссылка на предмет (объект item) или null, если указанного имени/индекса не существует.

Примечания

Чтобы перебрать все существующие предметы в игре, создайте цикл, просматривающий индексы от 0 до Game.TotalNumItems - 1.


CreateEntity(Name)

Создаёт новый объект сцены (entity).

Параметры

Name
Имя объекта (необязательный параметр)

Возвращаемое значение

Ссылка на вновь созданный объект.


DeleteEntity(Entity)

Удаляет объект сцены (entity).

Параметры

Entity
Имя удаляемого объекта.

CreateWindow(Name)

Создаёт новое окно (объект window).

Параметры

Name
Имя объекта (необязательный параметр)

Возвращаемое значение

Ссылка на вновь созданный объект окна.


DeleteWindow(Window)

Удаляет окно.

Параметры

Window
Имя объекта окна.

CreateItem(Name)

Создаёт новый предмет инвентаря (объект item).

Параметры

Name
Имя объекта (необязательный параметр)

Возвращаемое значение

Ссылка на вновь созданный объект item.


DeleteItem(Item)

Удаляет предмет инвентаря.

Параметры

Item
Имя объекта.

Примечания

Этот метод навсегда удаляет предмет инвентаря из игры. Вы больше не сможете ссылаться на него в таких методах, как TakeItem и др.


SetShadowImage(Filename)

Задаёт изображение, используемое в качестве простой тени (simple) для 3D-персонажей.

Параметры

Filename
Имя файла изображения.

Возвращаемое значение

Возвращает true в случае успеха.


GetShadowImage()

Возвращает изображение, используемое в настоящий момент в качестве простой тени (simple) для 3D-персонажей.

Возвращаемое значение

Имя файла изображения или null, если оно не задано.


IsShadowTypeSupported(ShadowType)

Проверяет, поддерживается ли на оборудовании пользователя данный тип теней.

Параметры

ShadowType
Тип теней (0..нет, 1..простая (simple), 2..плоская (flat), 3..шаблонная (stencil))

Возвращаемое значение

Если указанный тип теней поддерживается видеокартой пользователя, метод вернёт true.

Примечания

Отсутствие теней и простые (simple) тени поддерживаются всегда.


AccOutputText(Text, Type)

Отправляет текст на синтезатор речи.

Параметры

Text
Текст.
Type
Тип текста (0..заголовок, 1..речь, 2..нажатая клавиша)

Примечания

Чтобы этот метод работал, должен быть включён вывод текста на речевой синтезатор во вкладке «Специальные возможности» стартового диалогового окна настроек игры.