Template:Command

From Bohemia Interactive Community
Revision as of 14:30, 28 July 2006 by Hardrock (talk | contribs)
Jump to navigation Jump to search


This template is not yet complete!

Syntax

You can insert a command using the following syntax:

{{Command|=
____________________________________________________________________________________________

| GAME_VERSION |=
____________________________________________________________________________________________

| DESCRIPTION |=
____________________________________________________________________________________________

| SYNTAX |=

|p1= PARAMETER1 |=

|p2= PARAMETER2 |=

|p3= PARAMETER3 |=

|p4= PARAMETER4 |=

|p5= PARAMETER5 |=

| RETURNVALUE |=

|mp= MPBEHAVIOUR |=
____________________________________________________________________________________________

|x1= EXAMPLE1 |=
____________________________________________________________________________________________

|x2= EXAMPLE2 |=
____________________________________________________________________________________________

|x3= EXAMPLE3 |=
____________________________________________________________________________________________

| SEEALSO |=

}}

Parameters

All of the following parameters should be replaced by reasonable text!

The parameter GAME_VERSION is obvious: It contains the version number when this command was included.

The parameter DESCRIPTION should contain a brief but detailed description of the command.

The parameter SYNTAX should show the syntax for the command. There are several possibilities of format:

'''commandName'''

preargument '''commandName'''

'''commandName''' postargument

preargument '''commandName''' postargument

[prearg1, prearg2] '''commandName''' postargument

preargument '''commandName''' [postarg1, postarg2]

etc. You get the drill.

PARAMETER1 to PARAMETER5 are all optional and should contain descriptions of the parameters. If there are no parameters, delete all lines. If there are two parameters, mention only |p1= PARAM | and |p2= PARAM | and delete |p3=, |p4= and |p5=. The format should be one of the following two:

parameter: [[Type]]

parameter: [[Type]] - Description

The parameter RETURNVALUE should contain a description of the return value. Again, there are two possible formats:

[[Type]]

[[Type]] - Description

The parameter MPBEHAVIOUR should contain a description of the command's behaviour in multiplayer. If you have no description, delete the line.

The parameters EXAMPLE1 to EXAMPLE3 are again all optional. If you don't include one of them, delete the line. They should contain examples for the command (using <pre> or <code> ?) including descriptions of the examples.

The parameter SEEALSO should contain a comma-separated list of links related to this command. Example for doFire would be:

[[commandFire]], [[fire]]