6,834
edits
PageTemplateSyntax: Difference between revisions
no edit summary
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
!Field Name | !Field Name | ||
!Page Type | !Page Type | ||
!Status | |||
!Values | !Values | ||
!Notes | !Notes | ||
| Line 10: | Line 11: | ||
|name | |name | ||
|all | |all | ||
|required | |||
|name of the function/event | |name of the function/event | ||
|Including namespaces if applicable, excluding class name if object oriented | |Including namespaces if applicable, excluding class name if object oriented | ||
| Line 16: | Line 18: | ||
|side | |side | ||
|all | |all | ||
|required | |||
|server, client, or shared | |server, client, or shared | ||
| | | | ||
| Line 22: | Line 25: | ||
|type | |type | ||
|all | |all | ||
|required | |||
|function, method, variable, property, event | |function, method, variable, property, event | ||
|Use event for events, use method/property when object oriented, use function/variable otherwise | |Use event for events, use method/property when object oriented, use function/variable otherwise | ||
| Line 28: | Line 32: | ||
|games | |games | ||
|all | |all | ||
|required | |||
|iii vc sa iv | |iii vc sa iv | ||
|Game support. One or multiple are supported. Delimit games by a space. | |Game support. One or multiple are supported. Delimit games by a space. | ||
| Line 34: | Line 39: | ||
|desc | |desc | ||
|all | |all | ||
|required | |||
|description of the item | |description of the item | ||
|For events, text is automatically added to the start: "The '''event-name''' event is invoked when"<br>Otherwise, text is automatically added to the start: "The '''item-name''' '''item-type''' is used to"<br>A full stop is added to the end of the description if the description doesn't end in one already. | |For events, text is automatically added to the start: "The '''event-name''' event is invoked when"<br>Otherwise, text is automatically added to the start: "The '''item-name''' '''item-type''' is used to"<br>A full stop is added to the end of the description if the description doesn't end in one already. | ||
| Line 40: | Line 46: | ||
|arg(1-20) | |arg(1-20) | ||
|function, method, event | |function, method, event | ||
|required if over 0 args | |||
|An argument. | |An argument. | ||
|Syntax: '''type name description''' or '''[type name = defaultValue]'''.<br>For an optional argument, use [] around the type and name and use '''= value''' for the default value. | |Syntax: '''type name description''' or '''[type name = defaultValue]'''.<br>For an optional argument, use [] around the type and name and use '''= value''' for the default value. | ||
| Line 46: | Line 53: | ||
|return | |return | ||
|function, method | |function, method | ||
|required | |||
|The return information, for a successful result. | |The return information, for a successful result. | ||
|Syntax: '''type description'''. | |Syntax: '''type description'''. | ||
| Line 52: | Line 60: | ||
|freturn | |freturn | ||
|function, method | |function, method | ||
|required | |||
|The return information, for a failed result. | |The return information, for a failed result. | ||
|Syntax: '''type''' or '''type value'''. | |Syntax: '''type''' or '''type value'''. | ||
| Line 58: | Line 67: | ||
|note or<br>note(2-20) | |note or<br>note(2-20) | ||
|all | |all | ||
|optional | |||
| | | | ||
|A note for the page. | |A note for the page. | ||
| Line 64: | Line 74: | ||
|cancel | |cancel | ||
|event | |event | ||
|required | |||
|true, false | |true, false | ||
|Whether the event can be cancelled. | |Whether the event can be cancelled. | ||
|cancel = true | |cancel = true | ||
|- | |||
|compat or<br>compat(1-20) | |||
|all | |||
|optional | |||
| | |||
|Compatibility information. | |||
|compat1 = Text goes here. | |||
|- | |||
|example or<br>exampleJS or<br>exampleLua or<br>exampleSquirrel or<br>exampleJSSS or<br>exampleJSCS or<br>exampleLuaSS or<br>exampleLuaCS or<br>exampleSquirrelJS or<br>exampleSquirrelCS | |||
|all | |||
|optional | |||
|Code. | |||
| | |||
|exampleJS = code here | |||
|} | |} | ||