ATLAS Wiki
Advertisement
Template-info.png Documentation

This template is used to describe a console command.

{{ConsoleCommand
|name = 
|syntax =
|argX = 
|typeX = 
|noteX = 
|parameters = 
|cheat = 
|target = 
|added = 
|description = 
|example =
|consoleCompatible =
}}

Parameters

name
name of the command
syntax
Optional. Used to describe a special syntax, other than space separated parameters. Otherwise the argX parameters will be listed.
argX, typeX, noteX
Description of the parameters. Instead of X use numbers or whatever you like. Use as many of these combinations as needed.
arg: name of the parameter
type: something like String or Boolean
note: description of the parameter
parameters
optional, additional text for arguments or if argX/typeX/noteX can't be used
cheat
Every kind of entry results to a "Yes". Leave empty if this command is not a cheat.
target
What or who is the target of the command? Leave empty if not relevant.
added
optional, if release version is known
description
description of the command
example
one or more examples how to use this command
consoleCompatible
Is this command compatible with gaming consoles. If partial compatibility describe limitations.

Examples

{{ConsoleCommand
|name = FirstExampleCommand
|syntax =
|arg1 = a
|type1 = string
|note1 = Description of parameter a.
|arg2 = b
|type2 = boolean
|note2 = Description of parameter b.
|cheat = yes
|target = self
|added = [[250.0]]
|description = Description of the command.
|consoleCompatible = No

With extra paragraph.
|example = FirstExampleCommand test true
}}

FirstExampleCommand

FirstExampleCommand <a> <b> 

Cheat: Yes
Target: self
Added: 250.0
Arguments:

Name Type Description
a string Description of parameter a.
b boolean Description of parameter b.

Description: Description of the command.
Compatible with gaming consoles: No

With extra paragraph.
Example:

FirstExampleCommand test true

{{ConsoleCommand
|name = SecondExampleCommand
|syntax = '''true{{!}}false'''
|parameters = Only text as description of parameters
|cheat = 
|target = 
}}

SecondExampleCommand

SecondExampleCommand true|false

Cheat: -
Target: -
Arguments: Only text as description of parameters
Description:


{{ConsoleCommand
|name = ThirdExampleCommand
|syntax = '''true{{!}}false'''
|arg1 = a
|type1 = string
|note1 = Description of parameter a.
|arg2 = b
|type2 = boolean
|note2 = Description of parameter b.
|parameters = Extra description of parameters
|cheat = 
|target = 
|description = ...
}}

ThirdExampleCommand

ThirdExampleCommand true|false

Cheat: -
Target: -
Arguments:

Name Type Description
a string Description of parameter a.
b boolean Description of parameter b.
Extra description of parameters

Description: ...


{{ConsoleCommand
|name = FourthExampleCommand
}}

FourthExampleCommand

FourthExampleCommand

Cheat: -
Target: -
Description:


Advertisement