Список методов в категории Input:

StopTextInput

Описание

Эта команда останавливает и скрывает любое приглашение ввода текста, ранее запущенное с помощью команды StartTextInput.

Определение

void agk::StopTextInput( )

Параметры

Пример кода

StartTextInput

Описание

Эта команда выводит текстовое приглашение ввода над вашим приложением, в то время как ваше приложение продолжает работать в фоновом режиме. Допустимыми символами являются значения ASCII в диапазоне от 32 до 126 включительно, если только вы не активировали новые шрифты по умолчанию с помощью UseNewDefaultFonts, и в этом случае можно использовать любые символы Unicode. Если для ввода текста на этом устройстве требуется виртуальная клавиатура, то она будет отображаться поверх вашего приложения. Вы не можете предполагать, что какая-либо часть вашего приложения будет видна во время ввода текста, хотя ваш код будет продолжать работать. Когда пользователь закончит ввод текста, GetTextInputCompleted вернет 1, а GetTextInputCancelled сообщит вам, завершил ли он ввод текста или отменил его. На клавиатурных устройствах отмена производится с помощью клавиши escape, а завершение-с помощью клавиши enter. В случае успеха вы можете получить введенный текст с помощью GetTextInput.

Определение

void agk::StartTextInput( const char* initial )
void agk::StartTextInput( )

Параметры

initial - Начальная строка для отображения пользователю, которую он может редактировать.

Пример кода

SetVirtualJoystickVisible

Описание

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

Определение

void agk::SetVirtualJoystickVisible( UINT index, int visible )

Параметры

index - Идентификатор виртуального джойстика для установки.
visible - 1 для отображения джойстика, 0 для его скрытия.

Пример кода

SetVirtualJoystickSize

Описание

Задает диаметр виртуального джойстика в экранных координатах. Изменение размера виртуального джойстика во время его использования изменит текущие возвращаемые значения X и Y.

Определение

void agk::SetVirtualJoystickSize( UINT index, float size )

Параметры

index - Идентификатор виртуального джойстика для установки.
size - Новый диаметр джойстика в экранных координатах.

Пример кода

SetVirtualJoystickPosition

Описание

Задает положение виртуального джойстика в экранных координатах. Вы можете использовать GetVirtualWidth и GetVirtualHeight, чтобы найти текущие границы экрана. Джойстик будет центрирован в заданном положении x и y. Перемещение виртуального джойстика во время его использования изменит текущие возвращаемые значения X и Y.

Определение

void agk::SetVirtualJoystickPosition( UINT index, float x, float y )

Параметры

index - Идентификатор виртуального джойстика для установки.
x - Координата x новой позиции.
y - Координата y новой позиции.

Пример кода

SetVirtualJoystickImageInner

Описание

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

Определение

void agk::SetVirtualJoystickImageInner( UINT index, UINT imageID )

Параметры

index - Идентификатор виртуального джойстика для установки.
imageID - Идентификатор изображения, используемый для этого джойстика.

Пример кода

SetVirtualJoystickDeadZone

Описание

Устанавливает мертвую зону для всех виртуальных джойстиков так, чтобы любое значение X или Y ниже заданного порога возвращало 0. Это значение должно быть между 0 и 1, по умолчанию оно равно 0,15.

Определение

void agk::SetVirtualJoystickDeadZone( float threshold )

Параметры

threshold - Значение, ниже которого будет возвращено 0.

Пример кода

SetVirtualJoystickImageOuter

Описание

Устанавливает изображение, используемое внешней (фиксированной) частью джойстика. Вы можете использовать идентификатор изображения 0, чтобы вернуть его к изображению по умолчанию.

Определение

void agk::SetVirtualJoystickImageOuter( UINT index, UINT imageID )

Параметры

index - Идентификатор виртуального джойстика для установки.
imageID - Идентификатор изображения, используемый для этого джойстика.

Пример кода

SetVirtualJoystickAlpha

Описание

Устанавливает прозрачность виртуального джойстика на экране. Виртуальный джойстик состоит из двух частей: внутренней подвижной части и внешней статической части. Alpha1 устанавливает прозрачность внешней части в диапазоне 0-255, при этом 255 полностью непрозрачны. Alpha2 устанавливает прозрачность внутренней части в диапазоне 0-255.

Определение

void agk::SetVirtualJoystickAlpha( UINT index, UINT alpha1, UINT alpha2 )

Параметры

index - Идентификатор виртуального джойстика для установки.
alpha1 - Альфа-значение внешней части джойстика.
alpha2 - Альфа-значение внутренней части джойстика.

Пример кода

SetVirtualJoystickActive

Описание

Устанавливает, будет ли джойстик захватывать события мыши и касания. Если установлено значение 0, то он не будет захватывать входные данные и не будет обновлять свои значения X и Y, они вернутся к 0. Это не повлияет на видимость виртуального джойстика, используйте SetVirtualJoystickVisible, чтобы изменить его видимость.

Определение

void agk::SetVirtualJoystickActive( UINT index, int active )

Параметры

index - Идентификатор виртуального джойстика для установки.
active - 1, чтобы разрешить ввод, 0, чтобы отключить его.

Пример кода

SetVirtualButtonText

Описание

Устанавливает текст, отображаемый в центре кнопки.

Определение

void agk::SetVirtualButtonText( UINT index, const char *str )

Параметры

index - Идентификатор виртуальной кнопки для установки.
str - Текст для отображения.

Пример кода

SetVirtualButtonVisible

Описание

Устанавливает, виден ли виртуальный объект на экране, это не влияет на его способность принимать ввод, используйте SetVirtualButtonActive, чтобы повлиять на то, будет ли виртуальная кнопка принимать ввод. Невидимая кнопка все еще может быть активна.

Определение

void agk::SetVirtualButtonVisible( UINT index, int visible )

Параметры

index - Идентификатор виртуальной кнопки для установки.
visible - 1, чтобы показать кнопку, 0, чтобы скрыть ее.

Пример кода

SetVirtualButtonSize

Описание

Задает размер виртуальной кнопки в координатах экрана.

Определение

void agk::SetVirtualButtonSize( UINT index, float sizeX, float sizeY )
void agk::SetVirtualButtonSize( UINT index, float size )

Параметры

index - Идентификатор виртуальной кнопки для установки.
sizeX - Новый размер X кнопки в координатах экрана.
sizeY - Новый размер кнопки Y в координатах экрана.
size - Новый диаметр кнопки в экранных координатах.

Пример кода

SetVirtualButtonImageUp

Описание

Устанавливает изображение, используемое кнопкой, когда она не нажата. Вы можете использовать идентификатор изображения 0, чтобы вернуть его к изображению по умолчанию.

Определение

void agk::SetVirtualButtonImageUp( UINT index, UINT imageID )

Параметры

index - Идентификатор виртуальной кнопки для установки.
imageID - Идентификатор изображения, используемый для этой кнопки.

Пример кода

SetVirtualButtonImageDown

Описание

Устанавливает изображение, используемое кнопкой при ее нажатии. Вы можете использовать идентификатор изображения 0, чтобы вернуть его к изображению по умолчанию.

Определение

void agk::SetVirtualButtonImageDown( UINT index, UINT imageID )

Параметры

index - Идентификатор виртуальной кнопки для установки.
imageID - Идентификатор изображения, используемый для этой кнопки.

Пример кода

SetVirtualButtonColor

Описание

Устанавливает цвет виртуальной кнопки по заданному индексу. По умолчанию кнопки имеют оттенки серого, так что они могут принимать различные цвета. Цвета должны быть указаны в диапазоне 0-255.

Определение

void agk::SetVirtualButtonColor( UINT index, UINT red, UINT green, UINT blue )

Параметры

index - Идентификатор виртуальной кнопки для установки.
red - Красная составляющая нового цвета.
green - Зеленая составляющая нового цвета.
blue - Синий компонент нового цвета.

Пример кода

SetVirtualButtonPosition

Описание

Задает положение виртуальной кнопки в координатах экрана. Вы можете использовать GetVirtualWidth и GetVirtualHeight, чтобы найти текущие границы экрана. Кнопка будет центрирована по заданным координатам x и y.

Определение

void agk::SetVirtualButtonPosition( UINT index, float x, float y )

Параметры

index - Идентификатор виртуальной кнопки для установки.
x - Координата x новой позиции в координатах экрана.
y - Координата y новой позиции в координатах экрана.

Пример кода

SetVirtualButtonAlpha

Описание

Устанавливает прозрачность виртуальной кнопки по заданному индексу. Альфа-значение должно находиться в диапазоне 0-255, где 255 полностью непрозрачно.

Определение

void agk::SetVirtualButtonAlpha( UINT index, UINT alpha )

Параметры

index - Идентификатор виртуальной кнопки для установки.
alpha - Новое альфа-значение для этой кнопки.

Пример кода

SetVirtualButtonActive

Описание

Устанавливает, будет ли виртуальный захватывать события мыши и касания. Если установлено значение 0, он не будет захватывать входные данные и не будет обновлять свое нажатое состояние, он вернется к 0 (вверх). Это не повлияет на видимость виртуальной кнопки, используйте SetVirtualButtonVisible, чтобы изменить ее видимость.

Определение

void agk::SetVirtualButtonActive( UINT index, int active )

Параметры

index - Идентификатор виртуальной кнопки для установки.
active - 1 для принятия ввода, 0 для его деактивации.

Пример кода

SetTextInputMaxChars

Описание

Задает максимальное количество символов, которое может быть введено в полноэкранное поле редактирования. Используйте 0 для неограниченного количества.

Определение

void agk::SetTextInputMaxChars( int max )

Параметры

max - Максимальное количество символов.

Пример кода

SetJoystickScreenPosition

Описание

Джойстик AGK-это эмулируемый метод ввода, который использует любые доступные входы устройства для создания ввода в стиле джойстика в диапазоне от -1 до 1. Эта команда позиционирует виртуальный джойстик на экране только в том случае, если необходимо эмулировать этот ввод. Например, если имеется реальный джойстик или клавиатура, то эта команда не имеет заметного эффекта. Рекомендуется всегда вызывать эту команду в любом случае, если вы собираетесь использовать GetJoystickX или GetJoystickY, просто если вам нужен виртуальный джойстик. Любой виртуальный джойстик будет центрирован в заданном положении X и Y.

Определение

void agk::SetJoystickScreenPosition( float x, float y, float size )

Параметры

x - Координата X новой позиции в координатах экрана.
y - Координата Y новой позиции в координатах экрана.
size - Диаметр джойстика в экранных координатах.

Пример кода

SetJoystickDeadZone

Описание

Устанавливает мертвую зону для универсальных джойстиков так, чтобы любое значение X или Y ниже заданного порога возвращало 0. Это значение должно быть между 0 и 1, по умолчанию оно равно 0,15.

Определение

void agk::SetJoystickDeadZone( float threshold )

Параметры

threshold - Значение, ниже которого будет возвращено 0.

Пример кода

SetEditBoxWrapMode

Описание

Если SetEditBoxMultiLine имеет значение 0, эта команда устанавливает, будет ли одна строка текста прокручиваться вправо или переноситься на новую строку, когда она перетекает по ширине поля редактирования. Использование по-прежнему не будет разрешено вводить новые символы строки самостоятельно.

Определение

void agk::SetEditBoxWrapMode( UINT index, int mode )

Параметры

index - Идентификатор поля редактирования для изменения.
mode - 0 для прокрутки вправо (по умолчанию), 1 для переноса на новую строку.

Пример кода

SetEditBoxVisible

Описание

Переключает видимое состояние этого поля редактирования, когда видимое установлено в 1, поле редактирования можно щелкнуть, получить фокус и изменить, когда установлено в 0, поле редактирования не отображается, не может быть изменено или получить фокус.

Определение

void agk::SetEditBoxVisible( UINT index, int visible )

Параметры

index - Идентификатор поля редактирования для изменения.
visible - Новое состояние поля редактирования, 1 для видимого, 0 для невидимого.

Пример кода

SetEditBoxUseAlternateInput

Описание

Задает, будет ли поле редактирования использовать альтернативный метод ввода текста, если поле редактирования будет скрыто виртуальной клавиатурой. Это относится только к мобильным платформам, таким как iOS и Android, и альтернативный метод ввода обычно представляет собой меньшее поле редактирования, расположенное чуть выше клавиатуры. Поле редактирования по-прежнему будет обновляться в режиме реального времени, как если бы оно вводилось непосредственно, но поскольку оно закрыто клавиатурой, пользователь его не увидит. По умолчанию он включен. Если вы хотите, вы можете отключить его и переместить поле редактирования в поле зрения, когда GetEditBoxHasFocus возвращает 1, обязательно переместите его обратно, когда GetEditBoxHasFocus возвращает 0.

Определение

void agk::SetEditBoxUseAlternateInput( UINT index, int mode )

Параметры

index - Идентификатор поля редактирования для изменения.
mode - 1 для использования альтернативного ввода (по умолчанию), 0 для использования обычного ввода.

Пример кода

SetEditBoxTextSize

Описание

Задает высоту в мировых координатах текста в этом поле редактирования. По умолчанию он установлен на высоту поля редактирования минус 2.

Определение

void agk::SetEditBoxTextSize( UINT index, float size )

Параметры

index - Идентификатор поля редактирования для изменения.
size - Новый размер шрифта для использования.

Пример кода

SetEditBoxTextColor

Описание

Задает цвет вводимого текста.

Определение

void agk::SetEditBoxTextColor( UINT index, UINT red, UINT green, UINT blue )

Параметры

index - Идентификатор поля редактирования для изменения.
red - Красная составляющая цвета (от 0 до 255).
green - Зеленая составляющая цвета (от 0 до 255).
blue - Синяя составляющая цвета (от 0 до 255).

Пример кода

SetEditBoxText

Описание

Задает текст, который в данный момент отображается в поле редактирования.

Определение

void agk::SetEditBoxText( UINT index, const char *str )

Параметры

index - Идентификатор поля редактирования для изменения.
str - Новый текст для отображения.

Пример кода

SetEditBoxSize

Описание

Задает размер поля редактирования в мировых координатах. При этом устанавливается размер фактического поля ввода текста, его граница будет выходить за пределы этих значений.

Определение

void agk::SetEditBoxSize( UINT index, float width, float height )

Параметры

index - Идентификатор поля редактирования для изменения.
width - Ширина нового размера.
height - Высота нового размера.

Пример кода

SetEditBoxScissor

Описание

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

Определение

void agk::SetEditBoxScissor( UINT index, float x, float y, float x2, float y2 )

Параметры

index - Идентификатор поля редактирования для изменения.
x - Координата x верхнего левого угла прямоугольника для использования в качестве границы клипа.
y - Координата y верхнего левого угла прямоугольника для использования в качестве границы клипа.
x2 - Координата x в правом нижнем углу окна для использования в качестве границы клипа.
y2 - Координата y в правом нижнем углу окна для использования в качестве границы клипа.

Пример кода

SetEditBoxPosition

Описание

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

Определение

void agk::SetEditBoxPosition( UINT index, float x, float y )

Параметры

index - Идентификатор поля редактирования для изменения.
x - Значение X позиции.
y - Значение Y позиции.

Пример кода

SetEditBoxPasswordMode

Описание

Задает, будут ли в поле редактирования отображаться звезды вместо ввода текста. Использование GetEditBoxText по-прежнему будет возвращать фактические символы, введенные пользователем.

Определение

void agk::SetEditBoxPasswordMode( UINT index, int mode )

Параметры

index - Идентификатор поля редактирования для изменения.
mode - 1 для отображения звезд, 0 для отображения нормального ввода.

Пример кода

SetEditBoxMultiLine

Описание

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

Определение

void agk::SetEditBoxMultiLine( UINT index, int multiline )

Параметры

index - Идентификатор поля редактирования для изменения.
multiline - 1 для включения многострочного режима, 0 для отключения.

Пример кода

SetEditBoxMaxLines

Описание

Задает максимальное количество строк, которые могут быть введены в это многострочное поле редактирования. Используйте 0 для неограниченного количества.

Определение

void agk::SetEditBoxMaxLines( UINT index, UINT max )

Параметры

index - Идентификатор поля редактирования для изменения.
max - Максимальное количество строк.

Пример кода

SetEditBoxMaxChars

Описание

Задает максимальное количество символов, которое может быть введено в это поле редактирования. Используйте 0 для неограниченного количества.

Определение

void agk::SetEditBoxMaxChars( UINT index, UINT max )

Параметры

index - Идентификатор поля редактирования для изменения.
max - Максимальное количество символов.

Пример кода

SetEditBoxInputType

Описание

Задает тип клавиатуры, которая будет отображаться на мобильных устройствах при редактировании этого поля редактирования. Там, где это возможно, будет отображаться клавиатура такого типа, например клавиатура только с цифрами.

Определение

void agk::SetEditBoxInputType( UINT index, int inputType )

Параметры

index - Идентификатор поля редактирования для изменения.
inputType - 0 для обычного текста, 1 только для чисел.

Пример кода

SetEditBoxFontImage

Описание

Устанавливает изображение шрифта, которое будет использоваться для этого поля редактирования, должно быть ранее загружено с помощью LoadImage(). Используйте 0, чтобы вернуть поле редактирования к шрифту по умолчанию.

Определение

void agk::SetEditBoxFontImage( UINT index, UINT image )

Параметры

index - Идентификатор поля редактирования для изменения.
image - Идентификатор используемого изображения-0 для шрифта по умолчанию.

Пример кода

SetEditBoxFocus

Описание

Переключает состояние фокуса этого поля редактирования, когда фокус установлен на 1, курсор начинает мигать, и любое нажатие клавиши добавит текст в поле редактирования. При установке значения 0 курсор исчезает, и текст не добавляется.

Определение

void agk::SetEditBoxFocus( UINT index, int focus )

Параметры

index - Идентификатор поля редактирования для изменения.
focus - Новое состояние поля редактирования, 1 для активного, 0 для неактивного.

Пример кода

SetEditBoxFont

Описание

Устанавливает шрифт, используемый для этого поля редактирования, который должен быть ранее загружен с помощью LoadFont. Используйте 0, чтобы вернуть поле редактирования к шрифту по умолчанию.

Определение

void agk::SetEditBoxFont( UINT index, UINT fontID )

Параметры

index - Идентификатор поля редактирования для изменения.
fontID - Идентификатор используемого шрифта-0 для шрифта по умолчанию.

Пример кода

SetEditBoxExtendedFontImage

Описание

Устанавливает расширенное изображение шрифта, используемое для этого поля редактирования, должно быть ранее загружено с помощью LoadImage(). Используйте 0, чтобы удалить расширенное изображение шрифта. Если вы не установите это изображение, поле редактирования не будет принимать расширенные символы, такие как £ é á и т. Д.

Определение

void agk::SetEditBoxExtendedFontImage( UINT index, UINT image )

Параметры

index - Идентификатор поля редактирования для изменения.
image - Идентификатор изображения для использования, 0 для использования без изображения.

Пример кода

SetEditBoxDepth

Описание

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

Определение

void agk::SetEditBoxDepth( UINT index, int depth )

Параметры

index - Идентификатор поля редактирования для изменения.
depth - Глубина в диапазоне от 0 (спереди) до 10000 (сзади).

Пример кода

SetEditBoxCursorWidth

Описание

Устанавливает ширину в мировых координатах курсора ввода текста, по умолчанию это значение равно 1,5 Обратите внимание, что функции, изменяющие размер текста или размер поля редактирования, могут перезаписать это значение.

Определение

void agk::SetEditBoxCursorWidth( UINT index, float width )

Параметры

index - Идентификатор поля редактирования для изменения.
width - Новая ширина курсора.

Пример кода

SetEditBoxCursorBlinkTime

Описание

Задает время в секундах между видимым и невидимым курсором в поле ввода текста.

Определение

void agk::SetEditBoxCursorBlinkTime( UINT index, float time )

Параметры

index - Идентификатор поля редактирования для изменения.
time - Время в секундах.

Пример кода

SetEditBoxCursorColor

Описание

Задает цвет мигающего курсора в этом поле редактирования.

Определение

void agk::SetEditBoxCursorColor( UINT index, UINT red, UINT green, UINT blue )

Параметры

index - Идентификатор поля редактирования для изменения.
red - Красная составляющая цвета (от 0 до 255).
green - Зеленая составляющая цвета (от 0 до 255).
blue - Синяя составляющая цвета (от 0 до 255).

Пример кода

SetEditBoxCursorPosition

Описание

Устанавливает курсор в заданную позицию в тексте, т. е. позиция 0 находится слева от первого символа, позиция 1-слева от второго символа и т. Д. Если значение позиции находится вне диапазона, оно будет зажато до ближайшего символа. Текущая позиция курсора гарантированно находится в поле зрения пользователя, поэтому ее можно использовать для выравнивания текста влево или вправо, установив курсор в крайнем левом или правом углу текста.

Определение

void agk::SetEditBoxCursorPosition( UINT index, int pos )

Параметры

index - Идентификатор поля редактирования для изменения.
pos - Новое положение курсора

Пример кода

SetEditBoxBorderSize

Описание

Задает размер границы в мировых координатах, которая будет окружать поле ввода текста. Например, значение 2 добавит границу в 2 пикселя вокруг поля ввода.

Определение

void agk::SetEditBoxBorderSize( UINT index, float size )

Параметры

index - Идентификатор поля редактирования для изменения.
size - Размер границы.

Пример кода

SetEditBoxBorderImage

Описание

Устанавливает изображение для использования в качестве границы, это может быть использовано вместе с цветом границы. Используйте 0, чтобы удалить изображение границы.

Определение

void agk::SetEditBoxBorderImage( UINT index, UINT image )

Параметры

index - Идентификатор поля редактирования для изменения.
image - Идентификатор используемого изображения.

Пример кода

SetEditBoxBorderColor

Описание

Задает цвет любой присутствующей границы. Вы также можете использовать изображение с помощью SetEditBoxBorderImage().

Определение

void agk::SetEditBoxBorderColor( UINT index, UINT red, UINT green, UINT blue, UINT alpha )

Параметры

index - Идентификатор поля редактирования для изменения.
red - Красная составляющая цвета (от 0 до 255).
green - Зеленая составляющая цвета (от 0 до 255).
blue - Синяя составляющая цвета (от 0 до 255).
alpha - Альфа-компонент цвета (от 0 до 255). 255 полностью непрозрачен.

Пример кода

SetEditBoxBackgroundColor

Описание

Задает цвет основного поля ввода текста.

Определение

void agk::SetEditBoxBackgroundColor( UINT index, UINT red, UINT green, UINT blue, UINT alpha )

Параметры

index - Идентификатор поля редактирования для изменения.
red - Красная составляющая цвета (от 0 до 255).
green - Зеленая составляющая цвета (от 0 до 255).
blue - Синяя составляющая цвета (от 0 до 255).
alpha - Альфа-компонент цвета (от 0 до 255). 255 полностью непрозрачен.

Пример кода

SetEditBoxBackgroundImage

Описание

Устанавливает изображение для использования в качестве фона, это может быть использовано вместе с цветом фона. Используйте 0, чтобы удалить фоновое изображение.

Определение

void agk::SetEditBoxBackgroundImage( UINT index, UINT image )

Параметры

index - Идентификатор поля редактирования для изменения.
image - Идентификатор используемого изображения.

Пример кода

SetEditBoxActive

Описание

Переключает активное состояние этого поля редактирования, когда активное установлено в 1, поле редактирования можно щелкнуть, получить фокус и изменить, когда установлено в 0, поле редактирования нельзя ни изменить, ни получить фокус.

Определение

void agk::SetEditBoxActive( UINT index, int active )

Параметры

index - Идентификатор поля редактирования для изменения.
active - Новое состояние поля редактирования, 1 для активного, 0 для неактивного.

Пример кода

SetCursorBlinkTime

Описание

Устанавливает время в секундах между появлением и исчезновением курсора в полноэкранном окне редактирования

Определение

void agk::SetCursorBlinkTime( float seconds )

Параметры

seconds - Время в секундах.

Пример кода

SetButtonScreenPosition

Описание

Эта функция позиционирует виртуальную кнопку в заданном положении только в том случае, если это необходимо для данного устройства, например, если присутствует реальный джойстик или клавиатура, то эта команда не будет иметь заметного эффекта. Рекомендуется вызвать эту команду в любом случае, просто на случай, если потребуется виртуальная кнопка. Кнопки AGK-это эмулируемый метод ввода, который использует любые доступные входы устройства для создания 5 кнопок. Если будет найден настоящий джойстик, то первые 5 кнопок из него будут использоваться для команд кнопки AGK. В противном случае AGK ищет полноразмерную клавиатуру и, если она будет найдена, будет использовать следующие клавиши в следующем порядке: E, R, Q, Control, чтобы представлять кнопки от 1 до 5 соответственно. Если ни джойстик, ни клавиатура не найдены, то создается виртуальная кнопка, которая появится на экране и может быть нажата либо с помощью сенсорного экрана, либо с помощью мыши. Каждая платформа гарантированно имеет способ активации кнопок AGK. Если виртуальная кнопка создана,она будет центрирована на заданной позиции X, Y.

Определение

void agk::SetButtonScreenPosition( UINT index, float x, float y, float size )

Параметры

index - Идентификатор кнопки, которую нужно расположить, должен находиться в диапазоне от 1 до 5 включительно.
x - Координата X положения кнопки в координатах экрана.
y - Координата Y положения кнопки в координатах экрана.
size - Диаметр положения кнопки в координатах экрана.

Пример кода

GetVirtualJoystickX

Описание

Возвращает значение X виртуального джойстика по заданному индексу. Это будет находиться в диапазоне от -1.0 до 1.0 с центрированием 0. Когда пользователь не взаимодействует с виртуальным джойстиком, он возвращает 0.

Определение

float agk::GetVirtualJoystickX( UINT index )

Параметры

index - Идентификатор виртуального джойстика для проверки.

Пример кода

GetVirtualJoystickY

Описание

Возвращает значение Y виртуального джойстика по заданному индексу. Это будет находиться в диапазоне от -1.0 до 1.0 с центрированием 0. Когда пользователь не взаимодействует с виртуальным джойстиком, он возвращает 0.

Определение

float agk::GetVirtualJoystickY( UINT index )

Параметры

index - Идентификатор виртуального джойстика для проверки.

Пример кода

GetVirtualJoystickExists

Описание

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

Определение

int agk::GetVirtualJoystickExists( UINT index )

Параметры

index - Идентификатор виртуального джойстика для проверки.

Пример кода

GetVirtualButtonState

Описание

Возвращает 1, если виртуальная кнопка в данный момент находится внизу, и 0, если она поднята. Используйте GetVirtualButtonPressed или GetVirtualButtonReleased, чтобы проверить, нажата или отпущена ли кнопка.

Определение

int agk::GetVirtualButtonState( UINT index )

Параметры

index - Идентификатор виртуальной кнопки для проверки.

Пример кода

GetVirtualButtonPressed

Описание

Возвращает 1 если виртуальная кнопка была нажата в этом кадре, то после первоначального нажатия эта функция вернется к 0. Используйте GetVirtualButtonState, чтобы проверить, находится ли виртуальная кнопка вверх или вниз.

Определение

int agk::GetVirtualButtonPressed( UINT index )

Параметры

index - Идентификатор виртуальной кнопки для проверки.

Пример кода

GetVirtualButtonReleased

Описание

Возвращает 1 если виртуальная кнопка была выпущена в этом кадре, то после первоначального выпуска эта функция вернется к 0. Используйте GetVirtualButtonState, чтобы проверить, находится ли виртуальная кнопка вверх или вниз.

Определение

int agk::GetVirtualButtonReleased( UINT index )

Параметры

index - Идентификатор виртуальной кнопки для проверки.

Пример кода

GetVirtualButtonExists

Описание

Возвращает 1, если виртуальная кнопка существует в данном индексе. 0 в противном случае.

Определение

int agk::GetVirtualButtonExists( UINT index )

Параметры

index - Идентификатор виртуальной кнопки для проверки.

Пример кода

GetTextInputCompleted

Описание

Возвращает 1 для кадра, который пользователь завершил ввод текста (успешно или нет). После завершения эта команда вернется к 0. На этом этапе вы можете проверить, отменил ли пользователь ввод, используя GetTextInputCancelled.

Определение

int agk::GetTextInputCompleted()

Параметры

Пример кода

GetTextInputCancelled

Описание

Возвращает 1, если пользователь отменил ввод текста, и 0, если нет. Это значение команды не определяется до тех пор, пока GetTextInputCompleted не вернет 1.

Определение

int agk::GetTextInputCancelled()

Параметры

Пример кода

GetTextInputState

Описание

Возвращает 0, если пользователь в данный момент вводит текст, и 1, если нет.

Определение

int agk::GetTextInputState()

Параметры

Пример кода

GetTextInput

Описание

Возвращает строку, введенную пользователем. Он будет содержать символы, закодированные с помощью UTF-8, некоторые устройства также могут разрешать возврат символов новой строки. Это значение команды не определяется до тех пор, пока GetTextInputCompleted не вернет 1.

Определение

char* agk::GetTextInput()

Параметры

Пример кода

GetPointerX

Описание

Это эмулируемый метод ввода, который использует любые доступные входы устройства для создания указателя экрана. Если устройство имеет мышь, то это возвращает текущее положение X мыши. В противном случае AGK проверит наличие сенсорного экрана и, если он будет найден, вернет положение X самого последнего события касания. Если никаких событий не происходит, то это последняя позиция X, записанная сенсорным событием. На устройствах, не имеющих ни мышей, ни сенсорных экранов, AGK попытается создать некоторую форму экранного указателя, управляемого аналоговыми стиками или подобными. Эта координата будет находиться в координатах вида, если вы смещаете порт вида, вы можете преобразовать его в мировые координаты с помощью ScreenToWorldX.

Определение

float agk::GetPointerX()

Параметры

Пример кода

GetPointerState

Описание

Это эмулируемый метод ввода, который использует любые доступные входы устройства для создания указателя экрана. Если на устройстве есть мышь, то это вернет 1, если левая кнопка мыши в данный момент нажата, и 0, если нет. В противном случае AGK проверит наличие сенсорного экрана и, если он будет найден, вернет 1, если в данный момент нажимается одно или несколько сенсорных событий. На устройствах, не имеющих ни мышей, ни сенсорных экранов, AGK попытается создать некоторую форму экранного указателя, управляемого аналоговыми стиками или подобными. Существует три команды для получения состояния нажатия указателя: GetPointerPressed возвращает 1 в момент нажатия указателя, а затем возвращает 0, GetPointerReleased возвращает 1 в момент отпускания указателя, а затем возвращает 0, GetPointerState возвращает 1 все время нахождения указателя в нажатом состоянии.

Определение

int agk::GetPointerState()

Параметры

Пример кода

GetPointerReleased

Описание

Это эмулируемый метод ввода, который использует любые доступные входы устройства для создания указателя экрана. Если на устройстве есть мышь, то это вернет 1, если левая кнопка мыши отпущена, и 0, если нет. В противном случае AGK проверит наличие сенсорного экрана и, если он будет найден, вернет 1, если будет выпущено одно или несколько сенсорных событий. На устройствах, не имеющих ни мышей, ни сенсорных экранов, AGK попытается создать некоторую форму экранного указателя, управляемого аналоговыми стиками или подобными. Существует три команды для получения состояния нажатия указателя: GetPointerPressed возвращает 1 в момент нажатия указателя, а затем возвращает 0, GetPointerReleased возвращает 1 в момент отпускания указателя, а затем возвращает 0, GetPointerState возвращает 1 все время нахождения указателя в нажатом состоянии.

Определение

int agk::GetPointerReleased()

Параметры

Пример кода

GetPointerY

Описание

Это эмулируемый метод ввода, который использует любые доступные входы устройства для создания указателя экрана. Если устройство имеет мышь, то это возвращает текущее положение мыши Y. В противном случае AGK проверит наличие сенсорного экрана и, если он будет найден, вернет положение Y самого последнего события касания. Если никаких событий не происходит, то это последняя позиция Y, записанная сенсорным событием. На устройствах, не имеющих ни мышей, ни сенсорных экранов, AGK попытается создать некоторую форму экранного указателя, управляемого аналоговыми стиками или подобными. Эта координата будет находиться в координатах вида, если вы смещаете порт вида, вы можете преобразовать его в мировые координаты с помощью ScreenToWorldY.

Определение

float agk::GetPointerY()

Параметры

Пример кода

GetPointerPressed

Описание

Это эмулируемый метод ввода, который использует любые доступные входы устройства для создания указателя экрана. Если устройство имеет мышь, то это вернет 1, если левая кнопка мыши нажата, 0, если нет. В противном случае AGK проверит наличие сенсорного экрана и, если он будет найден, вернет 1, если существует одно или несколько событий касания. На устройствах, не имеющих ни мышей, ни сенсорных экранов, AGK попытается создать некоторую форму экранного указателя, управляемого аналоговыми стиками или подобными. Существует три команды для получения состояния нажатия указателя: GetPointerPressed возвращает 1 в момент нажатия указателя, а затем возвращает 0, GetPointerReleased возвращает 1 в момент отпускания указателя, а затем возвращает 0, GetPointerState возвращает 1 все время нахождения указателя в нажатом состоянии.

Определение

int agk::GetPointerPressed()

Параметры

Пример кода

GetLastChar

Описание

Возвращает значение unicode последнего ввода символа

Определение

UINT agk::GetLastChar()

Параметры

Пример кода

GetJoystickY

Описание

Джойстик AGK-это эмулируемый метод ввода, который использует любые доступные входы устройства для создания ввода в стиле джойстика в диапазоне от -1 до 1. Если к системе подключен физический джойстик, то он будет использоваться,в противном случае,если будет найдена полноразмерная клавиатура,клавиши W, A, S, D будут использоваться в качестве четырех направлений для джойстика. Если ни того, ни другого не существует, то на экране будет создан виртуальный джойстик, которым можно управлять либо с помощью сенсорного экрана, либо с помощью мыши. Используемый виртуальный джойстик будет иметь индекс 1, если он уже существует, его значения будут введены в эту эмулируемую команду джойстика. Вы можете расположить этот виртуальный джойстик в выбранном вами положении на экране с помощью SetJoystickScreenPosition. Каждая платформа гарантированно имеет метод генерации значения AGK - Y.

Определение

float agk::GetJoystickY()

Параметры

Пример кода

GetJoystickX

Описание

Определение

float agk::GetJoystickX()

Параметры

Пример кода

GetEditBoxY

Описание

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

Определение

float agk::GetEditBoxY( UINT index )

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetEditBoxVisible

Описание

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

Определение

int agk::GetEditBoxVisible( UINT index )

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetEditBoxWidth

Описание

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

Определение

float agk::GetEditBoxWidth( UINT index )

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetEditBoxText

Описание

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

Определение

char* agk::GetEditBoxText( UINT index )

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetEditBoxLines

Описание

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

Определение

int agk::GetEditBoxLines( UINT index )

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetEditBoxHeight

Описание

Возвращает текущую высоту поля редактирования. Это высота фактического поля ввода текста, любая граница будет выходить за пределы этого значения.

Определение

float agk::GetEditBoxHeight( UINT index )

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetEditBoxHasFocus

Описание

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

Определение

int agk::GetEditBoxHasFocus( UINT index )

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetEditBoxDepth

Описание

Возвращает текущую глубину поля редактирования, где 0 - передняя часть экрана, а 10000-задняя.

Определение

int agk::GetEditBoxDepth(UINT index)

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetEditBoxCursorPosition

Описание

Возвращает курсор в заданную позицию в тексте, то есть позиция 0 находится слева от первого символа, позиция 1-слева от второго символа и так далее.

Определение

int agk::GetEditBoxCursorPosition( UINT index )

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetEditBoxChanged

Описание

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

Определение

int agk::GetEditBoxChanged( UINT index )

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetEditBoxX

Описание

Возвращает текущую позицию X поля редактирования. Это верхний левый угол фактического поля ввода текста, любая граница будет простираться влево от этой точки.

Определение

float agk::GetEditBoxX( UINT index )

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetEditBoxActive

Описание

Возвращает 1, если поле редактирования включено и может быть нажато, 0, если поле редактирования отключено и не может быть изменено.

Определение

int agk::GetEditBoxActive( UINT index )

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetDirectionY

Описание

Возвращает текущее значение направления в направлении Y. Направление-это эмулируемое значение, которое будет использовать акселерометр, если он доступен, или клавиши со стрелками клавиатуры, если нет.

Определение

float agk::GetDirectionY()

Параметры

Пример кода

GetEditBoxExists

Описание

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

Определение

int agk::GetEditBoxExists( UINT index )

Параметры

index - Идентификатор поля редактирования для проверки.

Пример кода

GetDirectionX

Описание

Возвращает текущее значение направления в направлении X. Направление-это эмулируемое значение, которое будет использовать акселерометр, если он доступен, или клавиши со стрелками клавиатуры, если нет.

Определение

float agk::GetDirectionX()

Параметры

Пример кода

GetDirectionSpeed

Описание

Возвращает текущую скорость направления в виде абсолютного значения от 0 до 1,4, это используется с GetDirectionAngle для определения экстента направления. Направление-это эмулируемое значение, которое будет использовать акселерометр, если он доступен, или клавиши со стрелками клавиатуры, если нет.

Определение

float agk::GetDirectionSpeed()

Параметры

Пример кода

GetDirectionAngle

Описание

Возвращает текущий угол направления относительно x=0, y=-1 (вверх). Угол будет находиться в диапазоне 0-360. Направление-это эмулируемое значение, которое будет использовать акселерометр, если он доступен, или клавиши со стрелками клавиатуры, если нет.

Определение

float agk::GetDirectionAngle()

Параметры

Пример кода

GetCurrentEditBox

Описание

Возвращает ИДЕНТИФИКАТОР текущего активного поля редактирования, только одно поле редактирования может фокусироваться одновременно. Если в данный момент ни одно поле редактирования не имеет фокуса, оно возвращает 0.

Определение

UINT agk::GetCurrentEditBox()

Параметры

Пример кода

GetButtonState

Описание

Эта функция возвращает 1, если указанная кнопка в данный момент удерживается нажатой. Кнопки AGK-это эмулируемый метод ввода, который использует любые доступные входы устройства для создания 5 кнопок. Если будет найден настоящий джойстик, то первые 5 кнопок из него будут использоваться для команд кнопки AGK. В противном случае AGK ищет полноразмерную клавиатуру и, если она будет найдена, будет использовать следующие клавиши в следующем порядке: E, R, Q, Control, чтобы представлять кнопки от 1 до 5 соответственно. Если ни джойстик, ни клавиатура не найдены, то создается виртуальная кнопка, которая появится на экране и может быть нажата либо с помощью сенсорного экрана, либо с помощью мыши. Каждая платформа гарантированно имеет способ активации кнопок AGK.

Определение

int agk::GetButtonState( UINT index )

Параметры

index - Идентификатор кнопки, которую нужно проверить, должен находиться в диапазоне от 1 до 5 включительно.

Пример кода

GetButtonPressed

Описание

Эта функция возвращает 1, если указанная кнопка только что была нажата, а затем возвращает 0, когда кнопка удерживается нажатой. Кнопки AGK-это эмулируемый метод ввода, который использует любые доступные входы устройства для создания 5 кнопок. Если будет найден настоящий джойстик, то первые 5 кнопок из него будут использоваться для команд кнопки AGK. В противном случае AGK ищет полноразмерную клавиатуру и, если она будет найдена, будет использовать следующие клавиши в следующем порядке: E, R, Q, Control, чтобы представлять кнопки от 1 до 5 соответственно. Если ни джойстик, ни клавиатура не найдены, то создается виртуальная кнопка, которая появится на экране и может быть нажата либо с помощью сенсорного экрана, либо с помощью мыши. Каждая платформа гарантированно имеет способ активации кнопок AGK.

Определение

int agk::GetButtonPressed( UINT index )

Параметры

index - Идентификатор кнопки, которую нужно проверить, должен находиться в диапазоне от 1 до 5 включительно.

Пример кода

GetButtonReleased

Описание

Эта функция возвращает 1, если указанная кнопка только что была отпущена, а затем возвращает 0, когда кнопка поднята. Кнопки AGK-это эмулируемый метод ввода, который использует любые доступные входы устройства для создания 5 кнопок. Если будет найден настоящий джойстик, то первые 5 кнопок из него будут использоваться для команд кнопки AGK. В противном случае AGK ищет полноразмерную клавиатуру и, если она будет найдена, будет использовать следующие клавиши в следующем порядке: E, R, Q, Control, чтобы представлять кнопки от 1 до 5 соответственно. Если ни джойстик, ни клавиатура не найдены, то создается виртуальная кнопка, которая появится на экране и может быть нажата либо с помощью сенсорного экрана, либо с помощью мыши. Каждая платформа гарантированно имеет способ активации кнопок AGK.

Определение

int agk::GetButtonReleased( UINT index )

Параметры

index - Идентификатор кнопки, которую нужно проверить, должен находиться в диапазоне от 1 до 5 включительно.

Пример кода

FixEditBoxToScreen

Описание

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

Определение

void agk::FixEditBoxToScreen( UINT index, int fix )

Параметры

index - Идентификатор поля редактирования для изменения.
fix - 0=двигаться при перемещении видового порта, 1=оставаться неподвижным на экране независимо от того, куда перемещается видовой порт.

Пример кода

DeleteVirtualButton

Описание

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

Определение

void agk::DeleteVirtualButton( UINT index )

Параметры

index - Идентификатор виртуальной кнопки для удаления.

Пример кода

DeleteVirtualJoystick

Описание

Удаляет виртуальный джойстик и удаляет его с экрана. Никакие другие команды виртуального джойстика не могут быть вызваны на этом индексе, если он не воссоздан с помощью AddVirtualJoystick.

Определение

void agk::DeleteVirtualJoystick( UINT index )

Параметры

index - Идентификатор виртуального джойстика для удаления.

Пример кода

DeleteEditBox

Описание

Удаляет любое поле редактирования с заданным идентификатором.

Определение

void agk::DeleteEditBox( UINT index )

Параметры

index - Идентификатор поля редактирования для удаления.

Пример кода

CreateEditBox

Описание

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

Определение

UINT agk::CreateEditBox()
void agk::CreateEditBox( UINT index )

Параметры

index - Идентификатор, используемый для этого поля редактирования.

Пример кода

AddVirtualJoystick

Описание

Создает экранный джойстик, которым можно управлять с помощью сенсорного экрана, мыши или другого указательного устройства. Они отделены от физических джойстиков, так что у вас может быть виртуальный джойстик с идентификатором 1 и реальный джойстик с идентификатором 1. У вас может быть до 4 виртуальных джойстиков на экране одновременно. Если виртуальный джойстик находится на экране и при нажатии или касании джойстик захватит это событие, а GetRawMouseLeftState вернет 0 (вверх), и событие касания не будет сгенерировано для этого действия.

Определение

void agk::AddVirtualJoystick( UINT index, float x, float y, float size )

Параметры

index - Идентификатор создаваемого виртуального джойстика должен находиться в диапазоне от 1 до 4.
x - x-положение центра джойстика в экранных координатах.
y - Положение y центра джойстика в экранных координатах.
size - Диаметр джойстика в экранных координатах.

Пример кода

AddVirtualButton

Описание

Создает экранную кнопку, которой можно управлять с помощью сенсорного экрана, мыши или другого указательного устройства. Они отделены от физических кнопок джойстика или клавиш клавиатуры, так что у вас может быть виртуальная кнопка с идентификатором 1 и реальная кнопка джойстика с идентификатором 1. У вас может быть до 100 виртуальных кнопок на экране одновременно. Если виртуальная кнопка находится на экране и нажата или тронута, то кнопка захватит это событие, а GetRawMouseLeftState вернет 0 (вверх), и событие касания не будет сгенерировано для этого действия.

Определение

void agk::AddVirtualButton( UINT index, float x, float y, float size )

Параметры

index - Идентификатор виртуальной кнопки, которую нужно создать, должен находиться в диапазоне от 1 до 100.
x - x-положение центра кнопки в координатах экрана.
y - Положение y центра кнопки в координатах экрана.
size - Диаметр кнопки в экранных координатах.