PageTemplateSyntax: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{| class="wikitable" !Template Field !Page Type !Values !Notes !Example |- |name |all |name of the function/event |Including namespaces if applicable, excluding class name if...") |
No edit summary |
||
| Line 1: | Line 1: | ||
Template Name: ScriptItem2 | |||
{| class="wikitable" | {| class="wikitable" | ||
! | !Field Name | ||
!Page Type | !Page Type | ||
!Values | !Values | ||
!Notes | !Notes | ||
! | !Examples | ||
|- | |- | ||
|name | |name | ||
| Line 35: | Line 37: | ||
|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. | ||
|desc = an element is destroyed | |desc = an element is destroyed | ||
|- | |||
|arg(1-20) | |||
|function, method, event | |||
|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. | |||
|arg1 = Element element The element that is about to be destroyed.<br>arg1 = [Element element = localClient.player] Example description. | |||
|} | |} | ||
Revision as of 17:44, 29 November 2022
Template Name: ScriptItem2
| Field Name | Page Type | Values | Notes | Examples |
|---|---|---|---|---|
| name | all | name of the function/event | Including namespaces if applicable, excluding class name if object oriented | name = gta.createBlip |
| side | all | server, client, or shared | side = shared | |
| type | all | function, method, variable, property, event | Use event for events, use method/property when object oriented, use function/variable otherwise | type = function |
| games | all | iii vc sa iv | Game support. One or multiple are supported. Delimit games by a space. | games = iii vc sa iv |
| desc | all | description of the item | For events, text is automatically added to the start: "The event-name event is invoked when" Otherwise, text is automatically added to the start: "The item-name item-type is used to" A full stop is added to the end of the description if the description doesn't end in one already. |
desc = an element is destroyed |
| arg(1-20) | function, method, event | An argument. Syntax: type name description or [type name = defaultValue]. For an optional argument, use [] around the type and name and use = value for the default value. |
arg1 = Element element The element that is about to be destroyed. arg1 = [Element element = localClient.player] Example description. |