Due to a sudden burst in spammer activity, account creation has been temporarily disabled. Sorry for the inconvenience to any new potential contributors.
Template:Scriptcommand
From AGEWiki
Contents |
Usage
This template structures information about event commands syntax, and should be used for all such entries, since it will make it easier to restructure the layout of what looks to be a sizable amount of data.
{{ scriptcommand
| name =
| type =
| cat =
| syntax =
| description =
| example =
| example-description =
| example2 =
| example2-description =
| param1 =
| param1desc =
| param2 =
| param2desc =
| param3 =
| param3desc =
}}
("param"-parameters run up to "param9")
Parameters
| Parameter | Explanation |
|---|---|
| name | The name of the action, condition (or other thing that fits in this template), as it appears in the gamefiles |
| type | The type of component. Valid types are action, condition and actionblock. |
| cat | Event commands will be placed into the Category:Script commands-category and in a type-specific category. cat can be used for additional categories that an event command should belong to. |
| syntax | A definition of the general syntax of the event. |
| description | Text describing how the component is used and the effects it will have |
| example | A single example of the event in use. Not mandatory, but advisable. |
| example-description | Text explaining the effects and use of the example. |
| example2 | A second example of the event in use. Make sure to use "example" before you use this one, to get proper headers |
| example2-description | Text explaining the effects and use of the second example. |
| paramX | This should echo one of the items from the syntax given. X can be any number from 1-9, but you need to have a "param1" for the parameters-section to display. |
| paramXdesc | A description of what parameter X is expected to be, but in format/content and in use. |
Example
{{ scriptcommand
| name = MinDate
| syntax = YYYY/MM/DD
| description = This condition is fulfilled if the actual date is this date or later (greater than or equal to).
| example = 1864/10/01
| example-description = This condition will be fulfilled on October 1st 1864, and on any date thereafter.
| param1 = YYYY
| param1desc = Integer; Year
| param2 = MM
| param2desc = Integer; Month
| param3 = DD
| param3desc = Integer; Day
}}
will display the following:
MinDate | |||
|
Syntax MinDate = YYYY/MM/DD Description This condition is fulfilled if the actual date is this date or later (greater than or equal to). Example MinDate = 1864/10/01 This condition will be fulfilled on October 1st 1864, and on any date thereafter.
|
Parameters
Integer; Year
Integer; Month
Integer; Day | ||
