Шаблон:КонсольнаяКоманда

Документация

[стили] [редактировать документацию] [очистить кэш]

Этот шаблон используется для описания консольной команды.

{{КонсольнаяКоманда
|name = 
|syntax =
|argX = 
|typeX = 
|noteX = 
|parameters = 
|cheat = 
|target = 
|added = 
|description = 
|example =
|consoleCompatible =
}}

Параметры

name

название команды

syntax

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

argX, typeX, noteX

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

arg: имя параметра

type: что-то вроде String или Boolean

note: описание параметра

parameters

необязательный, дополнительный текст для аргументов или если argX/typeX/noteX не могут быть использованы

cheat

Каждый вид ввода приводит к ответу "Да". Оставить пустым, если данная команда не является мошеннической.

target

Что или кто является объектом командования? Оставить пустым, если не относится к делу.

added

необязательно, если известна версия релиза

description

описание команды

example

один или несколько примеров использования этой команды

consoleCompatible

Совместима ли данная команда с игровыми консолями. Если совместимость частичная, опишите ограничения.

Примеры

{{КонсольнаяКоманда
|name = FirstExampleCommand
|syntax =
|arg1 = a
|type1 = string
|note1 = Описание параметра a.
|arg2 = b
|type2 = boolean
|note2 = Описание параметра b.
|cheat = yes
|target = self
|added = [[250.0]]
|description = Описание команды.
|consoleCompatible = No

С дополнительным абзацем.
|example = FirstExampleCommand test true
}}

cheat

FirstExampleCommand

<a><b>

Общая Информация

Цель:	self
Добавлено в:	250.0
Совместимость с консолями:
В  ARK: Survival Ascended:
В  ARK: Survival Evolved:

Информация об Аргументе

Название	Тип	Описание
<a>	string	Описание параметра a.
<b>	boolean	Описание параметра b.

Описание команды.

Пример:

FirstExampleCommand test true

{{КонсольнаяКоманда
|name = SecondExampleCommand
|syntax = '''true{{!}}false'''
|parameters = Только текст в качестве описания параметров
|cheat = 
|target = 
}}

SecondExampleCommand

Общая Информация

В  ARK: Survival Ascended:
В  ARK: Survival Evolved:

{{КонсольнаяКоманда
|name = ThirdExampleCommand
|syntax = '''true{{!}}false'''
|arg1 = a
|type1 = string
|note1 = Описание параметра a.
|arg2 = b
|type2 = boolean
|note2 = Описание параметра b.
|parameters = Дополнительное описание параметров
|cheat = 
|target = 
|description = ...
}}

ThirdExampleCommand

<a><b>

Общая Информация

В  ARK: Survival Ascended:
В  ARK: Survival Evolved:

Информация об Аргументе

Название	Тип	Описание
<a>	string	Описание параметра a.
<b>	boolean	Описание параметра b.

...

{{КонсольнаяКоманда
|name = FourthExampleCommand
}}

FourthExampleCommand

Общая Информация

В  ARK: Survival Ascended:
В  ARK: Survival Evolved:

Расположенная выше документация включена из Шаблон:КонсольнаяКоманда/док. (править | история)