46.229.168.137: Importing a new version from external source

2019-05-09T17:52:54Z

Importing a new version from external source

New page

{{DISPLAYTITLE:{{#ifeq: {{{type|}}} | method | {{{class|UndocumentedClassName}}}::{{{name|}}} |
{{#ifeq: {{{type|}}} | property | {{#if: {{{class|}}} | {{{class|}}}::{{{name|}}} | {{{name|}}} }} |
{{{name|Script Item}}}
}} }} }}
__NOTOC__<nowiki>
</nowiki>{{#ifeq: {{{type|}}} | event | {{Event}} |
{{#ifeq: {{{type|}}} | function | {{Function}} |
{{#ifeq: {{{type|}}} | method | {{Method}} |
{{#ifeq: {{{type|}}} | variable | {{Variable}} |
{{#ifeq: {{{type|}}} | property | {{Property}} |
{{#ifeq: {{{type|}}} | eventObject | {{EventObject}} | }}}}}}}}}}}}<nowiki>
</nowiki>{{#ifeq: {{{endpoint|}}} | server | {{ServerItem|type={{{type|}}}}} |<nowiki>
</nowiki>{{#ifeq: {{{endpoint|}}} | client | {{ClientItem|type={{{type|}}}}} |<nowiki>
</nowiki>{{#ifeq: {{{endpoint|}}} | shared | {{SharedItem|type={{{type|}}}}} | The endpoint for this scripting item has not been documented. }}
}}
}}<nowiki>
</nowiki>{{GameSupport|games={{{games|All Games}}}}}<nowiki>
</nowiki>{{#if: {{{readonly|}}} | {{ReadOnlyStatus|{{{readonly|}}}}}}}

== Usage ==
{{#if: {{{name|}}} |
{{#if: {{{usage|}}} |
{{#ifeq: {{{type|}}} | function | The '''{{{name|}}}''' function is used to {{{usage|}}}. |
{{#ifeq: {{{type|}}} | method | The '''{{{class|UndocumentedClassName}}}::{{{name|}}}''' method is used to {{{usage|}}}. |
{{#ifeq: {{{type|}}} | variable | The '''{{{name|}}}''' variable is used to {{{usage|}}}. |
{{#ifeq: {{{type|}}} | property | The '''{{#if: {{{class|}}} | {{{class|}}}::{{{name|}}} | {{{name|}}} }}''' property is used to {{{usage|}}}. |
{{#ifeq: {{{type|}}} | event | The '''{{{name|}}}''' event is invoked when {{{usage|}}}. |
{{#ifeq: {{{type|}}} | eventObject | The '''{{{name|}}}''' event object is sent to {{{usage|}}}. |
The functionality-type for this scripting item has not been documented.
}}
}}
}}
}}
}}
}} |
The usage for this scripting item has not been documented.
}} |
The name for this scripting item has not been documented.
}}<nowiki>

</nowiki>{{#if: {{{parameters|}}} {{{parametersSS|}}} {{{parametersCS|}}} {{#ifeq: {{{type|}}} | property | a | }} {{#ifeq: {{{type|}}} | variable | a | }} | <nowiki></nowiki>
== Syntax ==
{{#if: {{{parameters|}}} |
{{#ifeq: {{{type|}}} | method |
{{{!}}
{{!}}-
{{!}}JavaScript:
{{!}}{{CodeSyntax|{{{returnTypes|void}}} {{lc:{{{class|UndocumentedClassType}}}}}.{{{name|}}}({{{parameters|}}})}}
{{!}}-
{{!}}Lua:
{{!}}{{CodeSyntax|{{{returnTypes|void}}} {{lc:{{{class|UndocumentedClassType}}}}}:{{{name|}}}({{{parameters|}}})}}
{{!}}-
{{!}}Squirrel:
{{!}}{{CodeSyntax|{{{returnTypes|void}}} {{lc:{{{class|UndocumentedClassType}}}}}.{{{name|}}}({{{parameters|}}})}}
{{!}}} |
{{CodeSyntax|{{{returnTypes|void}}} {{{name|}}}({{{parameters|}}})}}
}}
}}<nowiki>
</nowiki>{{#if: {{{parametersSS|}}} {{{parametersCS|}}} |
{{{!}}
{{!}}-
{{#ifeq: {{{type|}}} | method |
{{!}}JavaScript, Server-Side:
{{!}}{{CodeSyntax|{{{returnTypes|void}}} {{lc:{{{class|UndocumentedClassType}}}}}.{{{name|}}}({{{parametersSS|}}})}}
{{!}}-
{{!}}Lua, Server-Side:
{{!}}{{CodeSyntax|{{{returnTypes|void}}} {{lc:{{{class|UndocumentedClassType}}}}}:{{{name|}}}({{{parametersSS|}}})}}
{{!}}-
{{!}}Squirrel, Server-Side:
{{!}}{{CodeSyntax|{{{returnTypes|void}}} {{lc:{{{class|UndocumentedClassType}}}}}.{{{name|}}}({{{parametersSS|}}})}}
|
{{!}}Server-Side:
{{!}}{{CodeSyntax|{{{returnTypes|void}}} {{{name|}}}({{{parametersSS|}}})}}
}}
{{!}}-
{{#ifeq: {{{type|}}} | method |
{{!}}JavaScript, Client-Side:
{{!}}{{CodeSyntax|{{{returnTypes|void}}} {{lc:{{{class|UndocumentedClassType}}}}}.{{{name|}}}({{{parametersCS|}}})}}
{{!}}-
{{!}}Lua, Client-Side:
{{!}}{{CodeSyntax|{{{returnTypes|void}}} {{lc:{{{class|UndocumentedClassType}}}}}:{{{name|}}}({{{parametersCS|}}})}}
{{!}}-
{{!}}Squirrel, Client-Side:
{{!}}{{CodeSyntax|{{{returnTypes|void}}} {{lc:{{{class|UndocumentedClassType}}}}}.{{{name|}}}({{{parametersCS|}}})}}
{{!}}
|
{{!}}Client-Side:
{{!}}{{CodeSyntax|{{{returnTypes|void}}} {{{name|}}}({{{parametersCS|}}})}}
}}
{{!}}}
}}<nowiki>
</nowiki>{{#ifeq: {{{type|}}} | property |
{{CodeSyntax|{{{returnTypes|void}}} {{#if: {{{class|}}} |{{lc:{{{class|}}}}}.{{{name|}}}|{{{name|}}}}}}} |
}}<nowiki>
</nowiki>{{#ifeq: {{{type|}}} | variable |
{{CodeSyntax|{{{returnTypes|void}}} {{{name|}}}}} |
}}
}}<nowiki>

</nowiki>{{#if: {{{callbackParameters|}}} {{{callbackParametersSS|}}} {{{callbackParametersCS|}}} | <nowiki></nowiki>
== Callback Syntax ==
{{#if: {{{callbackParameters|}}} | {{CodeSyntax|function({{{callbackParameters|}}})}} | }}
{{#if: {{{callbackParametersSS|}}} {{{callbackParametersCS|}}} |
{{{!}}
{{!}}-
{{!}}Server-Side:
{{!}}{{CodeSyntax|function({{{callbackParametersSS}}})}}
{{#if: {{{callbackParametersCS|}}} |
{{!}}-
{{!}}Client-Side:
{{!}}{{CodeSyntax|function({{{callbackParametersCS}}})}}
}}
{{!}}}
}}
}}<nowiki>

</nowiki>{{#if: {{{class|}}} | <nowiki></nowiki>
== Class ==
{{#if: {{{class|}}} |
This {{{type|undocumented-item-type}}} works on objects of class <code>{{{class|}}}</code>
{{#if:
{{#ifeq: {{{class|}}} | Element | a |}}
{{#ifeq: {{{class|}}} | Transformable | a |}}
{{#ifeq: {{{class|}}} | Entity | a |}}
{{#ifeq: {{{class|}}} | Physical | a |}}
{{#ifeq: {{{class|}}} | Object | a |}}
{{#ifeq: {{{class|}}} | Ped | a |}}
|, which includes objects of derived classes: <code><nowiki>
</nowiki>{{#ifeq: {{{class|}}} | Element | Transformable, Entity, Physical, Object, Building, Ped, Civilian, Player, Vehicle, Train|}}<nowiki>
</nowiki>{{#ifeq: {{{class|}}} | Transformable | Entity, Physical, Object, Building, Ped, Civilian, Player, Vehicle, Train|}}<nowiki>
</nowiki>{{#ifeq: {{{class|}}} | Entity | Physical, Object, Building, Ped, Civilian, Player, Vehicle, Train|}}<nowiki>
</nowiki>{{#ifeq: {{{class|}}} | Physical | Object, Ped, Civilian, Player, Vehicle, Train|}}<nowiki>
</nowiki>{{#ifeq: {{{class|}}} | Object |}}<nowiki>
</nowiki>{{#ifeq: {{{class|}}} | Ped | Civilian, Player|}}<nowiki>
</nowiki>{{#ifeq: {{{class|}}} | Vehicle | Train|}}<nowiki>
</nowiki></code>
|}}. |
The class name for this {{{type|undocumented-item-type}}} has not been documented.
}}
| }}<nowiki>

</nowiki>{{#if: {{{readonly|}}} | <nowiki></nowiki>
== Read-Only Status ==
{{#ifeq: {{{readonly|}}} | true | This {{{type|undocumented-item-type}}} is read-only. |
{{#ifeq: {{{readonly|}}} | false | This {{{type|undocumented-item-type}}} can be read and set. |
{{#ifeq: {{{readonly|}}} | ss | This {{{type|undocumented-item-type}}} is read-only server-side, but can be read and set client-side. |
{{#ifeq: {{{readonly|}}} | cs | This {{{type|undocumented-item-type}}} can be read and set server-side, but is read-only client-side. |
The read-only status for this {{{type|undocumented-item-type}}} has been documented incorrectly.
}}
}}
}}
}} |
}}<nowiki>

</nowiki>{{#if: {{{cancellable|}}} | <nowiki></nowiki>
== Cancellable Status ==
{{#ifeq: {{{cancellable|}}} | true | This {{{type|undocumented-item-type}}} can be cancelled by calling [[event.preventDefault|event.preventDefault]]. | This {{{type|undocumented-item-type}}} cannot be cancelled.}} |
}}<nowiki>

</nowiki>{{#if: {{{canFail|}}} {{#if: {{{returnInfo|}}} {{#ifeq: {{{type|}}} | function | a | }} {{#ifeq: {{{type|}}} | method | a | }} | <nowiki></nowiki>
== Returns ==
{{#if: {{{returnInfo|}}} |
{{{!}}
{{!}}-
{{!}}Success:
{{!}}This {{{type|undocumented-item-type}}} returns {{{returnInfo|undocumented-item-returns}}}.
{{!}}-
{{!}}Failure:
{{!}}This {{{type|undocumented-item-type}}} returns <code>{{#ifeq: {{{returnTypes|}}} | void | void |
{{#ifeq: {{{returnTypes|}}} | boolean | bool false |
{{#ifeq: {{{returnTypes|}}} | int | integer -1 |
{{#ifeq: {{{returnTypes|}}} | integer | integer -1 |
{{#ifeq: {{{returnTypes|}}} | float | float 0.0 |
{{#ifeq: {{{returnTypes|}}} | number | number 0.0 |
{{#ifeq: {{{returnTypes|}}} | string | string "" (a blank string) |
{{#ifeq: {{{returnTypes|}}} | array | array [] (an empty array) |
null/nil
}}}}}}}}}}}}}}}}</code>. See [[Shared/ScriptingSystem#Failure_Return_Types|failure-return-types]] for more information.
{{!}}} |
{{{!}}
{{!}}-
{{!}}Success:
{{!}}This {{{type|undocumented-item-type}}} returns <code>void</code>.
{{!}}-
{{!}}Failure:
{{!}}This {{{type|undocumented-item-type}}} returns <code>void</code>.
{{!}}}
}}
}}
}}<nowiki>

</nowiki>{{#if: {{{since|}}} | <nowiki></nowiki>
== Compatibility ==
This {{{type|undocumented-item-type}}} is available in GTAC versions '''{{{since|undocumented-item-version}}}''' and newer.|}}<nowiki>

</nowiki>{{#if: {{{bcMaxVersion|}}} | <nowiki></nowiki>
== Backward Compatibility ==
{{#if: {{{bcMaxVersion|}}} | In GTAC versions {{{bcMaxVersion|undocumented-version}}} and below| }}<nowiki>
</nowiki>, this {{{type|undocumented-item-type}}}
{{#if: {{{bcName|}}} | was previously named {{{bcName|undocumented-old-item-name}}} | }}<nowiki>
</nowiki>{{#if: {{{bcText|}}} | {{{bcText|}}} | }}<nowiki>
</nowiki>.
|}}

== Notes ==
{{{notes|There are no notes available for this {{#ifeq: {{{type|a}}} | eventObject | event object | {{{type|undocumented-item-type}}}}}.}}}

== Examples ==
{{#if: {{{example|}}} | {{CodeBox|{{{example|}}}}}}}<nowiki>
</nowiki>{{#if: {{{exampleLua|}}} | '''Lua:''' {{LuaCode|{{{exampleLua}}}}}}}<nowiki>
</nowiki>{{#if: {{{exampleJS|}}} | '''JavaScript:''' {{JSCode|{{{exampleJS}}}}}}}<nowiki>
</nowiki>{{#if: {{{exampleSquirrel|}}} | '''Squirrel:''' {{SquirrelCode|{{{exampleSquirrel}}}}}}}<nowiki>
</nowiki>{{#if: {{{exampleLuaSS|}}} | '''Lua, Server-Side:''' {{LuaCode|{{{exampleLuaSS}}}}}}}<nowiki>
</nowiki>{{#if: {{{exampleLuaCS|}}} | '''Lua, Client-Side:''' {{LuaCode|{{{exampleLuaCS}}}}}}}<nowiki>
</nowiki>{{#if: {{{exampleJSSS|}}} | '''JavaScript, Server-Side:''' {{JSCode|{{{exampleJSSS}}}}}}}<nowiki>
</nowiki>{{#if: {{{exampleJSCS|}}} | '''JavaScript, Client-Side:''' {{JSCode|{{{exampleJSCS}}}}}}}<nowiki>
</nowiki>{{#if: {{{exampleSquirrelSS|}}} | '''Squirrel, Server-Side''': {{SquirrelCode|{{{exampleSquirrelSS}}}}}}}<nowiki>
</nowiki>{{#if: {{{exampleSquirrelCS|}}} | '''Squirrel, Client-Side''': {{SquirrelCode|{{{exampleSquirrelCS}}}}}}}
{{#if: {{{example|}}} {{{exampleLua|}}} {{{exampleJS|}}} {{{exampleSquirrel|}}} {{{exampleLuaSS|}}} {{{exampleLuaCS|}}} {{{exampleJSSS|}}} {{{exampleJSCS|}}} {{{exampleSquirrelSS|}}} {{{exampleSquirrelCS|}}} | | There are no examples available for this {{{type|undocumented-item-type}}}.}}

Template:ScriptItem/en - Revision history

46.229.168.137: Importing a new version from external source