RU/textCreateTextItem

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Эта функция создает текстовый объект. Он представляет собой единичное поле для текста, примерно так же, как label в программировании GUI. Этот текст будет виден игрокам только в том случае, если он добавлен на текстовый дисплей (textdisplay) с помощью textDisplayAddText. Каждый текстовый объект может быть добавлен на несколько дисплеев одновременно.

Синтаксис

 textitem textCreateTextItem ( [string text, float x, float y, string priority, int red = 255, int green = 0, int blue = 0, int alpha = 255, float scale = 1, string alignX = "left", string alignY = "top", int shadowAlpha = 0] )

Обязательные аргументы

Отсутствуют.

Дополнительные аргументы

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

text: Строка текста, которая будет отображаться
x: Вещественное число от 0.0 до 1.0 , которое указывает, как далеко от левой стороны экрана будет показан текст, в долях от ширины экрана.
y: Вещественное число от 0.0 до 1.0 , которое указывает, как далеко от верха экрана будет показан текст, в долях от высоты экрана.
priority: Приоритет: насколько важно, чтобы этот текст обновлялся на экранах игроков максимально быстро. Доступные значения: "low", "medium", "high" которые означают низкий, средний и высокий приоритет соответственно (или 0, 1 и 2 в числовом эквиваленте).
red: Целое число - количество красного компонента в цвете текста(0 - 255).
green: Целое число - количество зеленого компонента в цвете текста(0 - 255).
blue: Целое число - количество синего компонента в цвете текста(0 - 255).
alpha: Целое число - прозрачность маркера (0 - 255 где 0 - полностью прозрачный, а 255 - полностью непрозрачный).
scale: Вещественное число - масштаб текста. По умолчанию 1.0, что примерно соответствует 12пт.
alignX: Строка - выравнивание по оси X. ("left", "center", "right" - слева, по центру или справа)
alignY: Строка - выравнивание по оси Y. ("top", "center", "bottom" - сверху, по центру или снизу)

Дополнительный параметр начиная с версии 1.0.2:

shadowAlpha: Целое число - определяет, насколько темной должна быть отбрасываемая тень(0 - 255).

Вывод

Возвращает текстовый объект.

Пример

myDisplay = textCreateDisplay ()                              -- создаем дисплей
textDisplayAddObserver ( myDisplay, myPlayer )                -- делаем его видимым игроку
myTextItem = textCreateTextItem ( "Hello world!", 0.5, 0.5 )  -- создаем текстовый объект
textDisplayAddText ( myDisplay, myTextItem )                  -- добавляем текстовый объект на дисплей

Смотрите также