Command

From BergerHealer Wiki
Jump to navigation Jump to search
(Try improving style)
No edit summary
Line 1: Line 1:
<noinclude>Template to display a Description, command and permission.
<noinclude>This template is used to show the command alongside some additional information in a Table.


== Usage ==
== Usage ==
<pre>{{Command|command|description|permission}}</pre>
<pre>{{Command|command|description|permission|Example|Aliases}}</pre>
 
== Parameters ==
{| class="wikitable"
! Parameter:
! Description:
! Default:
|-
! scope="row" style="text-align: left;" | ''Command''
| The Command itself. You don't have to provide a / before the text. It will be added automatically.
| ''command''
|-
! scope="row" style="text-align: left;" | ''Description''
| The description to display. Can be left blank/ommited for no description.
|
|-
! scope="row" style="text-align: left;" | ''Permission''
| The permission(s) this command has.
|
|-
! scope="row" style="text-align: left;" | ''Exmaple''
| The Command-example(s) to display.
|
|-
! scope="row" style="text-align: left;" | ''Aliases''
| The alternative command options available.
|
|}
 


== Examples ==
== Examples ==
Line 8: Line 36:
=== Full Example ===
=== Full Example ===
'''Code'''
'''Code'''
<pre>{{Command|train|Main command of TrainCarts|train.command.train}}</pre>
<pre>{{Command|train setname [name]|Set the name of the selected train|train.command.name|/train setname SomeName|/train name [name]<br>/train rename [name]}}</pre>


'''Result:'''
'''Result:'''
{{Command|train|Main command of TrainCarts|train.command.train}}
{{Command|train setname [name]|Set the name of the selected train|train.command.name|/train setname SomeName|/train name [name]<br>/train rename [name]}}


=== No permissions ===
=== No permissions ===
Line 39: Line 67:
   {{!}}-
   {{!}}-
   }}
   }}
! Command
! style="text-align: left; padding-right: 10px;" {{!}} Command
| /{{{1|command}}}
| style="font-family: monospace" {{!}} /{{{1|command}}}
|-
  {{#if: {{{5|}}}|
  ! style="text-align: left;" {{!}} Aliases
  {{!}} style="font-family: monospace" {{!}} {{{5}}}
  }}
|-
|-
   {{#if: {{{3|}}}|
   {{#if: {{{3|}}}|
   ! Permission
   ! style="text-align: left;" {{!}} Permission
   {{!}} {{{3}}}
   {{!}} {{{3}}}
   }}
   }}
Line 50: Line 83:
   ! colspan="2" {{!}} Examples
   ! colspan="2" {{!}} Examples
   {{!}}-
   {{!}}-
   {{!}} colspan="2" style="font-family: monospace" {{!}} {{{4}}}
   {{!}} colspan="2" style="font-family: monospace;" {{!}} {{{4}}}
   }}
   }}
|-
|-
|}</onlyinclude></includeonly>
|}</onlyinclude></includeonly>

Revision as of 15:00, 14 February 2021

This template is used to show the command alongside some additional information in a Table.

Usage

{{Command|command|description|permission|Example|Aliases}}

Parameters

Parameter: Description: Default:
Command The Command itself. You don't have to provide a / before the text. It will be added automatically. command
Description The description to display. Can be left blank/ommited for no description.
Permission The permission(s) this command has.
Exmaple The Command-example(s) to display.
Aliases The alternative command options available.


Examples

Full Example

Code

{{Command|train setname [name]|Set the name of the selected train|train.command.name|/train setname SomeName|/train name [name]<br>/train rename [name]}}

Result:

Set the name of the selected train
Command /train setname [name]
Aliases /train name [name]
/train rename [name]
Permission train.command.name
Examples
/train setname SomeName

No permissions

Code

{{Command|train|Main command of TrainCarts}}

Result

Main command of TrainCarts
Command /train

No Description

Code

{{Command|train||train.command.train}}

Result

Command /train
Permission train.command.train

With Examples

Code

{{Command|train setname [name]|Set the name of the selected train|train.command.name|/train setname SomeName}}

Result

Set the name of the selected train
Command /train setname [name]
Permission train.command.name
Examples
/train setname SomeName