Модуль:Random/doc

Материал из Народные Сказки

Это страница документации Модуль:Random.

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

Number[править код]

Функция number возвращает случайное число.

{{#invoke:Random|number|m|n|same=yes}}

Аргументы m и n могут быть опущены, однако в случае, если они заданы, они должны быть приводимы к целым числам.

  • При вызове без параметров возвращает вещественное число в полуинтервале <math>[0,1)</math>.
  • При вызове с одним параметром возвращает целое число из интервала <math>[1,m]</math>. m должно быть положительным.
  • При вызове с двумя параметрами возвращает целое число из интервала <math>[m,n]</math>. m и n могут быть как положительными, так и отрицательными. Если m больше n, возвращает целое число из интервала <math>[n,m]</math>.
  • Если параметру |same = присвоено одно из значений «yes», «y», «true» или «1», одно и то же случайное число возвращается для каждого вызова модуля на данной странице.

Примеры (обновить)

  • {{#invoke:Random|number}} → 0.88002528989689
  • {{#invoke:Random|number|100}} → 62
  • {{#invoke:Random|number|-100|-50}} → -76
  • {{#invoke:Random|number|100|same=yes}} → 20
  • {{#invoke:Random|number|100|same=yes}} → 20

Документация этой функции частично скопирована из справки по Scribunto Lua, в свою очередь основанной на справке по Lua 5.1, доступной под лицензией MIT.

Date[править код]

Функция date возвращает случайную дату.

{{#invoke:Random|date|метка1|метка2|format=формат даты|same=yes}}
  • Если ни одна из временных меток не задана, модуль возвращает случайную дату текущего года.
  • Если заданы параметры метка1 и метка2, модуль возвращает случайную дату между данными двумя временными метками. метка1 должна быть раньше метка2.
  • Если задан только параметр метка1, модуль возвращает случайную дату между «эрой Unix» (1 января 1970) и временной меткой. Метка метка1 не должна быть раньше 1 января 1970.
  • Форматирование может быть задано параметром |format =. Форматирование по умолчанию — «hh:mm, DD Month YYYY (UTC)» (аналогично форматированию по умолчанию временных меток РуСказок).
  • Временные метки и параметр |format = поддерживают значения, совместимые с функцией парсера #time. Обратитесь к документации #time для получения полного списка возможных входных значений и опций форматирования.
  • Если параметру |same = присвоено одно из значений «yes», «y», «true» или «1», одна и та же дата возвращается для каждого вызова модуля на данной странице.

Примеры (обновить)

  • {{#invoke:Random|date}} → 15:11, 02 март 2024 (UTC)
  • {{#invoke:Random|date|format=F j}} → июнь 4
  • {{#invoke:Random|date|1 Jan 1980|31 Dec 1999}} → 09:18, 04 февраль 1989 (UTC)
  • {{#invoke:Random|date|1st January 1500|1st January 3000|format=g:i a, l d M Y}} → 1:18 pm, пятница 01 июл 2067
  • {{#invoke:Random|date|1970/06/01}} → 11:29, 26 май 1970 (UTC)
  • {{#invoke:Random|date|same=yes}} → 08:32, 12 март 2024 (UTC)
  • {{#invoke:Random|date|same=yes}} → 08:32, 12 март 2024 (UTC)

Item[править код]

Функция item возвращает случайный элемент списка.

{{#invoke:Random|item|элемент списка 1|элемент списка 2|элемент списка 3|...|same=yes}}

Если параметру |same = присвоено одно из значений «yes», «y», «true» или «1», один и тот же элемент возвращается для каждого вызова модуля на данной странице.

Пример (обновить)

  • {{#invoke:Random|item|egg|beans|sausage|bacon|spam}} → egg
  • {{#invoke:Random|item|egg|beans|sausage|bacon|spam|same=yes}} → sausage
  • {{#invoke:Random|item|egg|beans|sausage|bacon|spam|same=yes}} → sausage

List[править код]

Функция list возвращает список в случайном порядке.

{{#invoke:Random|list|элемент списка 1|элемент списка 2|элемент списка 3|...|sep=разделитель|limit=сколько элементов отображать|same=yes}}

Именованные параметры

  • |sep = или |separator = — опциональный разделитель списка элементов. Некоторые значения зарезервированы, см. таблицу ниже.
  • |limit = — максимальное число отображаемых элементов списка. Наименьшее возможное значение — 0, наибольшее — число элементов в списке.
  • Если параметру |same = присвоено одно из значений «yes», «y», «true» или «1», один и тот же список возвращается для каждого вызова модуля на данной странице.
Возможные значения разделителя
Код Вывод
dot ⧼dot-separator⧽
pipe |
comma ,
tpt-languages ⧼tpt-languages-separator⧽
space пробел
newline символ перевода строки
любое другое значение остальные значения используются без изменения

Передать пробелы в параметр |sep = невозможно из-за ограничений, накладываемых синтаксисом шаблонов в MediaWiki. Однако их можно обойти, используя мнемоники HTML. Используйте &#32; для представления обычного пробела и &nbsp; для представления неразрывного пробела.

Примеры (обновить)

  • {{#invoke:Random|list|egg|beans|sausage|bacon|spam}} → spameggbeansbaconsausage
  • {{#invoke:Random|list|egg|beans|sausage|bacon|spam|sep=dot}} → beans⧼dot-separator⧽sausage⧼dot-separator⧽egg⧼dot-separator⧽bacon⧼dot-separator⧽spam
  • {{#invoke:Random|list|egg|beans|sausage|bacon|spam|sep=space}} → sausage beans bacon egg spam
  • {{#invoke:Random|list|egg|beans|sausage|bacon|spam|sep=;&#32;}} → sausage; spam; bacon; egg; beans
  • {{#invoke:Random|list|egg|beans|sausage|bacon|spam|sep=foo}} → spamfoosausagefooeggfoobeansfoobacon
  • {{#invoke:Random|list|egg|beans|sausage|bacon|spam|limit=3}} → spameggsausage
  • {{#invoke:Random|list|egg|beans|sausage|bacon|spam|same=yes}} → beansspambaconeggsausage
  • {{#invoke:Random|list|egg|beans|sausage|bacon|spam|same=yes}} → beansspambaconeggsausage

Text list[править код]

Функция text_list возвращает список в случайном порядке в виде связанного текста. Другими словами, эта функция работает так же, как функция list, но использует другой разделитель перед последним элементом.

{{#invoke:Random|text_list|элемент списка 1|элемент списка 2|элемент списка 3|...|sep=разделитель|conj=союз|limit=сколько элементов отображать|same=yes}}

Разделитель может быть задан параметрами |sep = или |separator =; значение по умолчанию — «, ». Союз может быть задан параметрами |conj = или |conjunction =; значение по умолчанию — « и ». В параметры разделителя и союза могут быть переданы те же значения, что и в параметр разделителя в функции list.

Максимальное число отображаемых элементов списка может быть задано параметром |limit =. Наименьшее возможное значение — 0, наибольшее — число элементов в списке.

Если параметру |same = присвоено одно из значений «yes», «y», «true» или «1», один и тот же список возвращается для каждого вызова модуля на данной странице.

Примеры (обновить)

  • {{#invoke:Random|text_list|egg|beans|sausage|bacon|spam}} → sausage, bacon, beans, egg и spam
  • {{#invoke:Random|text_list|egg|beans|sausage|bacon|spam|sep=;&#32;}} → sausage; egg; bacon; spam и beans
  • {{#invoke:Random|text_list|egg|beans|sausage|bacon|spam|sep=;&#32;|conj=&#32;или&#32;}} → bacon; sausage; egg; spam или beans
  • {{#invoke:Random|text_list|egg|beans|sausage|bacon|spam|limit=3}} → beans, sausage и bacon
  • {{#invoke:Random|text_list|egg|beans|sausage|bacon|spam|same=yes}} → beans, spam, bacon, egg и sausage
  • {{#invoke:Random|text_list|egg|beans|sausage|bacon|spam|same=yes}} → beans, spam, bacon, egg и sausage

HTML-списки[править код]

Если вы хотите вывести HTML-список в случайном порядке, вы можете выбрать одну из пяти функций: bulleted_list, unbulleted_list, horizontal_list, ordered_list, и horizontal_ordered_list. Все эти функции используют Модуль:List.

Название функции Создаёт Код примера Вывод примера (обновить)
bulleted_list Маркированный список {{#invoke:Random|bulleted_list|egg|sausage|spam}}
  • sausage
  • spam
  • egg
unbulleted_list Немаркированный список {{#invoke:Random|unbulleted_list|egg|sausage|spam}}
  • spam
  • sausage
  • egg
horizontal_list Горизонтальный маркированный список {{#invoke:Random|horizontal_list|egg|sausage|spam}}
  • egg
  • sausage
  • spam
ordered_list Упорядоченный список (нумерованные и алфавитные списки) {{#invoke:Random|ordered_list|egg|sausage|spam}}
  1. egg
  2. spam
  3. sausage
horizontal_ordered_list Горизонтальный упорядоченный список {{#invoke:Random|horizontal_ordered_list|egg|sausage|spam}}
  1. egg
  2. spam
  3. sausage
Базовое использование
{{#invoke:Random|функция|элемент списка 1|элемент списка 2|элемент списка 3|...|limit=сколько элементов отображать|same=yes}}
Все параметры
{{#invoke:Random|функция
|первый элемент|второй элемент|третий элемент|...
|start           = начальное число для упорядоченного списка
|type            = тип маркера для упорядоченного списка
|list_style_type = тип маркера для упорядоченного списка (использует CSS)
|class           = класс
|style           = стиль
|list_style      = стиль списка
|item_style      = стиль всех элементов списка
|item_style1     = стиль первого элемента списка |item_style2 = стиль второго элемента списка |...
|indent          = отступ для горизонтальных списков
}}

Максимальное число отображаемых элементов списка может быть задано параметром |limit =. Наименьшее возможное значение — 0, наибольшее — число элементов в списке.

Если параметру |same = присвоено одно из значений «yes», «y», «true» или «1», один и тот же список возвращается для каждого вызова модуля на данной странице.

Посетите документацию Модуля:List для получения полной информации по остальным параметрам.

См. также[править код]

  • {{Случайное число}}
  • {{Случайный элемент}}
  • {{Очищать кэш}} — для периодической пересборки страницы