Wiki Page Templates

[Vortrex]

The GTA Connected wiki provides several templates to make adding and editing pages easier. Below are a list of commonly used templates with descriptions of accepted values and information. Any field that is indicated as required must be provided or the wiki page will show that documentation for it wasn't added. Please don't leave any pages you add or edit with blank or missing required template values.


[/hr]



[/td][td]no[/td][/tr]
[tr][td]name[/td][td]

the property name ... this is only the name, don't use quotes or include the parent object

[/td][td]no[/td][/tr]
[tr][td]returnTypes[/td][td]

what the property returns as a type (int, string, etc)

[/td][td]no[/td][/tr]
[tr][td]readonly[/td][td]

Boolean indicating whether or not this property's value can be set

[/td][td]no[/td][/tr]
[tr][td]usage[/td][td]

Explain what the property does if it's value is set, and what is returned if the value is only read

[/td][td]no[/td][/tr]
[tr][td]returnInfo[/td][td]

Explain what the property returns if used as a getter

[/td][td]no[/td][/tr]
[tr][td]notes[/td][td]

Any extra information that scripters should be aware of goes here.

[/td][td]yes[/td][/tr]
[/table][/spoiler]

[/hr]



[/td][td]no[/td][/tr]
[tr][td]name[/td][td]

The method name ... this is only the name, don't use quotes or parentheses

[/td][td]no[/td][/tr]
[tr][td]returnTypes[/td][td]

What the method returns as a type (int, string, etc)

[/td][td]no[/td][/tr]
[tr][td]usage[/td][td]

explain what the method does when used

[/td][td]no[/td][/tr]
[tr][td]returnInfo[/td][td]

explain what the method returns. Use void if it doesn't return anything

[/td][td]no[/td][/tr]
[tr][td]notes[/td][td]

Any extra information that scripters should be aware of goes here.

[/td][td]yes[/td][/tr]
[tr][td]parameter1[/td][td]

first argument as [type name description]. Example: "string dataName The string name of the data."

[/td][td]yes[/td][/tr]
[tr][td]parameter2[/td][td]

Same as parameter1 but with the second parameter's information

[/td][td]yes[/td][/tr]
[tr][td]parameter3[/td][td]

Same as parameter1 but with the third parameter's information

[/td][td]yes[/td][/tr]
[/table][/spoiler]