Ru:Format Class Functions (SourceMod Scripting)

Введение

Формат классов функций, аргументов переменной - функции в SourceMod которые позволяют Вам форматировать строки. Простой пример этой Format() функции, выглядит следующим образом:

decl String:buffer[512];
Format(buffer, sizeof(buffer), "Ваше имя: %s", userName);

Если userName содержит "Frenzzy", содержимое buffer будет: "Ваше имя: Frenzzy". Прототип этих функций почти всегда содержит следующие параметры:

const char[] fmt, {Handle,float,_}:...

Например, обратите внимание на эти два выражения:

native Format(char[] buffer, int maxlength, const char[] fmt, {Handle,float,_}:...);
native PrintToClient(int client, char[] fmt, {Handle,float,_}:...);

Таким образом, PrintToClient является формат-классовой функцией. Она может быть использована точно так же, как было показано ранее:

PrintToClient(client, "Ваше имя: %s", userName);

Спецификаторы Формата

Спецификаторы Формата имеют код, который позволяет указать, какие типы данных будут отображаться. Наиболее распространенными спецификаторами являются:

• Числовые
  • d или i: Целое число как десятичные
  • b: Бинарные символы в значении
  • f: Числа с плавающей точкой
  • x or X: Шестнадцатеричное представление бинарных значений (применение заглавных букв влияет на шестнадцатеричный регистр букв)
• Символ(ы)
  • s: Строка
  • t или T: Переводы фраз (см. в Inline Translations)
  • c: Вывод одного символа (совместимо с UTF-8)
• Специальные
  • L: Требуется индекс клиента; расширяется до 1<2><3><>, где 1 - имя игрока, 2 - userid игрока, и 3 - Steam ID игрока. Если клиент имеет индекс 0, строка будет: Console<0><Console><Console>
  • N: Требуется индекс клиента; расширяется до строки, содержащей имя игрока. Если клиент имеет индекс 0, строка будет: Console

Использование

Спецификаторы формата обозначаются символом '%s'. Например, чтобы отобразилось число с плавающей точкой, десятичное число и строка, Вы можете использовать этот код:

float fNum = 5.0;
int iNum = 5;
char[] str = "5";
 
PrintToClient(client, "Десятичное число: %d Число с плавающей точкой: %f Строка: %s", iNum, fNum, str);

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

Расширенный формат

Спецификаторы формата имеют расширенный синтаксис для управления различными аспектами того, как будут выводиться данные. Полный синтаксис: %[flags][width][.precision]specifier

Каждый раздел в квадратных скобках является дополнительным расширением. Описание поддерживаемых SourceMod расширений формата:

• %: Очевидно, что это требуется всегда.
• flags:
  • -: Выравнивание по левому краю (выравнивание по правому краю установлено по умолчанию)
  • 0: Заполняет 0 вместо пробелов в случае необходимости (см. width ниже).
• width: Минимальное количество символов, которые будут отображены. Если отображаемая величина будет короче, чем это число, результат будет заполнен пустым пространством. Значение так же не обрежится, даже если результат будет длиннее.
• precision:
  • For integers: определяет минимальное количество цифр для отображения (или заполняет пробелами/нулями, если она меньше минимальной).
  • For strings: определяет максимальное количество символов для отображения.
  • For floats: определяет количество цифр для отображения после запятой.
  • For all other types: нет эффекта.
• specifier: символ указывающий тип данных (требуется всегда).

Для получения более подробной информации см. printf из C Standard Library, хотя не dсе режимы из C поддерживаются.