PageTemplateSyntax - Revision history

Vortrex at 03:18, 5 September 2025

2025-09-05T03:18:44Z

← Older revision		Revision as of 03:18, 5 September 2025
Line 27:		Line 27:
	\|all		\|all
	\|required		\|required
	\|server, client, or shared		\|server, client, shared
	\|		\|
	\|side = shared		\|side = shared
Line 42:		Line 42:
	\|required		\|required
	\|iii vc sa iv		\|iii vc sa iv
	\|Game support. ~~One or multiple are supported. Delimit games~~ by ~~a space~~.		\|[[GamesAndVersions\|Game support]]. Separated by spaces.
	\|games = iii vc sa iv		\|games = iii vc sa iv
			\|-
			\|offline
			\|all
			\|optional
			\|true/false
			\|Whether the function works when '''not''' connected to a server
			\|offline = true
			\|-
			\|online
			\|all
			\|optional
			\|true/false
			\|Whether the function works when connected to a server
			\|online= true
	\|-		\|-
	\|desc		\|desc
Line 76:		Line 90:
	\|event		\|event
	\|required		\|required
	\|true, false		\|true/false
	\|Whether the event can be cancelled.		\|Whether the event can be cancelled.
	\|cancel = true		\|cancel = true
Line 83:		Line 97:
	\|variable, property		\|variable, property
	\|required		\|required
	\|true, false		\|true/false
	\|Whether the variable/property is readonly.		\|Whether the variable/property is readonly.
	\|readonly = true		\|readonly = true
Line 110:		Line 124:
	\|cb(1-20)text		\|cb(1-20)text
	\|method, function, event		\|method, function, event
	\|optional~~, even if matching arg(1-20) is a callback.~~		\|optional
	\|Text		\|Text
	\|Extra description for the callback argument.		\|Extra description for the callback argument.
Line 117:		Line 131:
	\|cb(1-20)arg(1-20)		\|cb(1-20)arg(1-20)
	\|method, function, event		\|method, function, event
	\|~~required if matching arg(1-20) callback receives any arguments.~~		\|optional
	\|A callback argument.		\|A callback argument.
	\|Syntax: '''type name description'''.		\|Syntax: '''type name description'''.
	\|arg1 = ~~Element element~~ The element ~~that is about to be destroyed.~~		\|arg1 = Client client The element's syncer
	\|-		\|-
	\|}		\|}

Mex at 21:37, 29 November 2022

2022-11-29T21:37:10Z

← Older revision		Revision as of 21:37, 29 November 2022
Line 1:		Line 1:
	Template Name: ScriptItem2		{{DISPLAYTITLE:Page Template Syntax}}
			== Template Name: ScriptItem2 ==

	{\| class="wikitable"		{\| class="wikitable"

Mex at 21:34, 29 November 2022

2022-11-29T21:34:16Z

@@ Line 15: / Line 15: @@
 |Including namespaces if applicable, excluding class name if object oriented
 |name = gta.createBlip
 |-
 |side
@@ Line 64: / Line 71: @@
 |Syntax: '''type''' or '''type value'''.
 |void<br>int -1
 |-
 |cancel
@@ Line 79: / Line 79: @@
 |cancel = true
 |-
-|compat or<br>compat(1-20)
+|readonly
 |all
 |optional
@@ Line 86: / Line 100: @@
 |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
+|example<br>exampleJS<br>exampleLua<br>exampleSquirrel<br>exampleJSSS<br>exampleJSCS<br>exampleLuaSS<br>exampleLuaCS<br>exampleSquirrelJS<br>exampleSquirrelCS
 |all
 |optional
@@ Line 92: / Line 106: @@
+|
 |exampleJS = code here
 |}

Mex at 18:39, 29 November 2022

2022-11-29T18:39:55Z

← Older revision		Revision as of 18:39, 29 November 2022
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
	\|}		\|}

Mex at 18:31, 29 November 2022

2022-11-29T18:31:47Z

@@ Line 43: / Line 43: @@
 |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.
 |}

Mex at 17:44, 29 November 2022

2022-11-29T17:44:45Z

← Older revision		Revision as of 17:44, 29 November 2022
Line 40:		Line 40:
	\|arg(1-20)		\|arg(1-20)
	\|function, method, event		\|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.		\|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.		\|arg1 = Element element The element that is about to be destroyed.<br>arg1 = [Element element = localClient.player] Example description.
	\|}		\|}

Mex at 17:44, 29 November 2022

2022-11-29T17:44:28Z

← Older revision		Revision as of 17:44, 29 November 2022
Line 1:		Line 1:
			Template Name: ScriptItem2

	{\| class="wikitable"		{\| class="wikitable"
	!~~Template~~ Field		!Field Name
	!Page Type		!Page Type
	!Values		!Values
	!Notes		!Notes
	!~~Example~~		!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.
	\|}		\|}

Mex: 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..."

2022-11-29T17:08:02Z

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..."

New page

{| class="wikitable"
!Template Field
!Page Type
!Values
!Notes
!Example
|-
|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"<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
|}