GTA Connected - User contributions [en]

exportFunction

2026-04-10T02:31:16Z

PerikiyoXD:

{{ScriptItem
|endpoint = shared
|type = function
|name = exportFunction
|parameters = string name, function Function
|parameter1 = string name The name of the exported function.
|parameter2 = function Function The function to export.
|return1 = void
|returnFail1 = void
|returnInfo = a boolean, indicating whether the function has been exported or not
|note1 = To use this function in another resource, use [[findResourceByName|findResourceByName]] in the other resource, which returns a resource object. You can then use [[resource.exports|resource.exports]] or [[resource.getExport|resource.getExport]] to access exported functions.
|note2 = Only simple types (string, number, boolean, null) are guaranteed to work across resource boundaries. Passing compound types (objects, arrays, tables) is discouraged — depending on the language combination involved, this may cause crashes or undefined behaviour. If structured data must be passed, serialize it to a JSON string before the call and deserialize on the receiving side.
|usage = export a function so it can be used in other resources
|exampleJS = bindEventHandler("OnResourceStart", thisResource, function(event, resource) {
exportFunction("testFunc", testFunc);
});
function testFunc(foo, bar) {
return true;
}
}}

OnRequestSession

2026-04-07T23:01:06Z

PerikiyoXD: Created page with "{{ScriptItem2 |name = OnRequestSession |side = server |type = event |games = iv |desc = when a client requests a session in GTA IV |arg1 = Client client The client that sent the request |arg2 = Episode integer The episode number requested by the client |cancel = true |ExampleSSJS = addEventHandler("OnRequestSession", (event, client, episode) => { console.log(`${client.name} requested session for episode ${episode}`); }); }}"

{{ScriptItem2

|name = OnRequestSession

|side = server

|type = event

|games = iv

|desc = when a client requests a session in GTA IV

|arg1 = Client client The client that sent the request

|arg2 = Episode integer The episode number requested by the client

|cancel = true

|ExampleSSJS = addEventHandler("OnRequestSession", (event, client, episode) => {
console.log(`${client.name} requested session for episode ${episode}`);
});

}}

FAQ

2026-04-06T02:30:03Z

PerikiyoXD:

{{DISPLAYTITLE:Player FAQ}}
{{AlertInformationBox|This FAQ is for the client (players) only. For the server FAQ, click [[ServerFAQ|here]]}}
<br><br>
==IV crashes when i change window, minimize, or alt tab==
Either use windowed mode in the GTAC Launcher settings, or use borderless via zolikapatch.
<br><br>
==My game is on Steam, Rockstar Launcher, or CD/DVD, can I still play GTAC?==
Yes, check our [[Downgrading|downgrading]] page to get a downgraded exe.
<br><br>
==My game is pirated (torrent), can I still play GTAC?==
Yes. You may need to downgrade your game though, check our [[Downgrading|downgrading]] page to get a downgraded exe.
<br><br>
==What are the in-game key binds for typing chat messages?==
For GTA III, Vice City, and San Andreas, use the '''T''' key to start typing.<br>
For GTA IV, use the built-in chat key to start typing, which by default is the '''Y''' key.
<br><br>
==What do I do if my game crashes?==
Report the crash on our [https://bugs.gtaconnected.com bug tracker]. Attach a [[CrashDumps|crash dump]] to the bug report. If possible, explain what just happened right before the crash.
<br><br>
==How do I customize my character's appearance?==
For any of the supported games, this depends on each server's resources. A server may have a command to change your character appearance, such as <code>/skin 35</code><br>
For IV, [https://zolika1351.pages.dev/mods/ivmenu Zmenu] can also be used with GTAC, if the server allows players to use it.
<br><br>
==Why is the GTAC Launcher stuck on Connecting or Disconnected status?==
Firstly, check if the [https://serverlisting.gtaconnected.com/ server list] is working via a web browser.<br>
If the server list is working, secondly check that your internet DNS settings are configured correctly, more specifically ensure that your preferred DNS server IP address is valid.
Sometimes VPN's can interfere with the launcher connection. Try turning off your VPN to see if that helps.
<br><br>
==Why am I getting an error about a side-by-side configuration?==
It looks like you might be missing a required Visual C++ runtime service pack. Download and install the '''x86 version''' from here: https://www.microsoft.com/en-gb/download/details.aspx?id=26347
<br><br>
==Why can't I increase my graphics settings in GTA IV?==
Make a new file called commandline.txt in your IV folder and add this to it:
{{InlineCode|1=-nomemrestrict -norestrictions -noswapdelay -percentvidmem 100}}
<br><br>

==How do I fix the IMG10 error?==
[[File:Crash-Window-IMG10.png|thumb|left]]
This seems to be caused by a FusionFix update that modifies the settings file. This affects all players who have installed the new FusionFix update for Complete Edition and launched the game at least once. Until FusionFix is updated to fix this, we will just have to swap between settings folders.<br />
Here's the fix:
* Rename `C:\Users\user\AppData\Local\Rockstar Games\GTA IV\SETTINGS.CFG` to something else
* Launch the game
* Swap between the 2 config files when wanting to play Complete Edition and GTAC
* A handy one-liner: `powershell -Command "Rename-Item -Force $ENV:USERPROFILE'\AppData\Local\Rockstar Games\GTA IV' $ENV:USERPROFILE'\AppData\Local\Rockstar Games\GTA IV.bak'"`

File:Crash-Window-IMG10.png

2026-04-06T02:29:06Z

PerikiyoXD:

A messagebox that shows IMG10 error

NativeMultiplayer

2026-03-22T10:10:52Z

PerikiyoXD: typo on xml

{{DISPLAYTITLE:Native Multiplayer}}
{{AlertBox|This page only applies to Grand Theft Auto IV}}

== tl;dr ==
* Native MP = GFWL modes
* Custom sync = Empty and scriptable like SA-MP, FiveM, etc<br />
Making a roleplay server? Turn off native MP mode in [[ServerConfiguration|server.xml]]: {{InlineCode|<iv_nativemultiplayer>false<iv_nativemultiplayer>}}

== What is native multiplayer? ==
Native multiplayer (sometimes referred to as native mp for short) is an alternative server/sync mode for GTA IV.

While GTAC (and most other GTA multiplayer mods) provide a sandbox environment and custom-made sync, GTAC also allows the use of "native multiplayer" which is Rockstar's sync, just passed through the server instead of directly peer to peer.

== How do I use it? ==
Players can't turn native multiplayer mode on or off, only a server can. If you are hosting a server, you can set the <iv_nativemultiplayer> tag in the server configuration to true or false.

== When should I use it? ==
* If you're hosting a server that uses [[Resources/GTAIV/GameModes|built-in IV gamemodes]], you should use native multiplayer mode.
* If you're making a script that's similar to other MP mods like RAGEMP, MTA:SA, SA-MP, FiveM, etc, you should '''NOT''' use native multiplayer mode.
* If your scripts need to keep track of elements or attach data to them, like a vehicle's owner for example, you should '''NOT''' use native multiplayer mode.
* If your scripts need to control which [[element.dimension|world players are in]], you should '''NOT''' use native multiplayer mode.

== Some notes and technical info ==
* Using native multiplayer mode presents a challenge when trying to script a gamemode that needs to track elements. For example, a roleplay server might provide vehicle ownership but if the server doesn't know the vehicle exists, tying that data to the vehicle would be an issue. You could tell a client to spawn it, then report back with the newly spawned vehicle's ID, but as soon as the session is destroyed and/or another one is created, those ID's are useless. The ID's also change if the element is streamed out for everybody and no client has it in memory anymore. If you need to attach persistent data to an element, you should disable native multiplayer on your server

* When using native multiplayer mode, you can't force players to create or join specific sessions (also called lobbies) with scripting. Each session has a player hosting it. Even if you have the phone disabled, the game might still place some players in different sessions with different hosts, and they won't be able to see players from another session. If you're trying to script a gamemode that needs everybody in the same "world" or needs to control which world they're in then you should disable native multiplayer on your server.

* If you want to use elements in the same way as other GTA multiplayer mods, or the older games here on GTA Connected, you'll need to turn off native MP mode in server config. This will force GTAC to use it's own custom sync. When using GTAC's custom sync, servers will be aware of elements and all can be handled using either GTAC functions or natives, although natives will only exist client-side.

* When native multiplayer mode is ''disabled'', some internal "events" that IV uses are not currently handled or synced. This means things like when a player shoots another player, the damage itself won't be synced. A small snippet of code added to a resource is needed to sync these events.

* The [[element.id|element.id]] function is part of GTAC's own element handling and does not work on native multiplayer mode. If you're using native multiplayer mode, you will need to use natives to get the ID of an element.

* When using native multiplayer mode, the server doesn't know how to read the sync packets, and only passes them along '''as-is'''. Any references to elements in this mode is handled by the games themselves.

meta.xml

2026-03-12T13:12:11Z

PerikiyoXD: New `meta.xml`

== Resource `meta.xml` ==

Defines metadata and file declarations for a resource.
Every resource '''must contain a `meta.xml` file''' or the resource will not load.

----

== Basic Structure ==

<pre>
<meta>
<info author="" type="" version="" description="" />
<script src="" type="" language="" />
<dependency src="" />
<map src="" type="" />
<file src="" type="" />
</meta>
</pre>

----

== Complete Example ==

<pre>
<meta>
<info
author="JohnDoe"
type="gameplay"
version="1.0.0"
description="Example resource"
/>

<script src="server/main.js" type="server" language="javascript" />
<script src="client/ui.js" type="client" language="javascript" />

<file src="config/settings.json" type="server" />
<file src="ui/index.html" type="client" />

<map src="maps/city.map" type="map" />

<dependency src="core" />
</meta>
</pre>

----

== Elements ==

=== <meta> ===

Root element that contains all metadata and file declarations for the resource.

Only one `<meta>` element should exist in a `meta.xml`.

----

=== <info> ===

Provides general metadata about the resource.

==== Attributes ====

{| class="wikitable"
! Attribute
! Description
|-
| author
| Name of the resource author.
|-
| type
| Resource category or custom description.
|-
| version
| Resource version number.
|-
| description
| Short description explaining the resource.
|}

==== Example ====

<pre>
<info
author="JohnDoe"
type="gameplay"
version="1.0.0"
description="Adds custom gameplay mechanics"
/>
</pre>

----

=== <script> ===

Declares a script file that should be loaded by the resource.

Each script file must have its own `<script>` entry.

==== Attributes ====

{| class="wikitable"
! Attribute
! Description
|-
| src
| Relative path to the script file.
|-
| type
| Execution side (<code>server</code> or <code>client</code>).
|-
| language
| Script language used by the file.
|}

==== Example ====

<pre>
<script src="server/main.js" type="server" language="javascript" />
<script src="client/ui.js" type="client" language="javascript" />
</pre>

----

=== <file> ===

Declares a custom file included in the resource.

==== Attributes ====

{| class="wikitable"
! Attribute
! Description
|-
| src
| Relative path to the file.
|-
| type
| Target side (<code>client</code> or <code>server</code>).
|}

==== Example ====

<pre>
<file src="config/settings.json" type="server" />
<file src="ui/index.html" type="client" />
</pre>

----

=== <dependency> ===

Declares a required resource dependency.

If specified, the dependency resource must load before this one.

==== Attributes ====

{| class="wikitable"
! Attribute
! Description
|-
| src
| Name of the required resource.
|}

==== Example ====

<pre>
<dependency src="core" />
<dependency src="database" />
</pre>

----

=== <map> ===

Registers a map file used by the resource.

==== Attributes ====

{| class="wikitable"
! Attribute
! Description
|-
| src
| Relative path to the map file.
|-
| type
| Map type definition.
|}

==== Example ====

<pre>
<map src="maps/city.map" type="map" />
</pre>

----

== Path Rules ==

All <code>src</code> attributes use '''paths relative to the resource root folder'''.

=== Valid Examples ===

<pre>
example.js
client/ui.js
server/modules/auth.js
assets/images/logo.png
</pre>

=== Invalid Example ===

<pre>
/absolute/path/file.js
</pre>

Absolute paths are not supported.

----

== Key Rules ==

* Every resource must include a <code>meta.xml</code>.
* Each script requires its own <code><script></code> entry.
* All <code>src</code> paths are relative to the resource root folder.
* Dependencies ensure correct resource load order.
* Custom files must be declared using <code><file></code> to be available at runtime.

Main Page

2026-02-23T13:53:28Z

PerikiyoXD:

__NOTOC__
<div style="width:100%;padding:0;margin:0;">


<div style="background:#222222;text-align:center;color:white;font-size:2em;padding:1em;margin:0;">GTA Connected Wiki</div>


<div style="display:flex;flex-wrap:wrap;gap:1em;padding:1em;background:#f9f9f9;">


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #008b8b;display:flex;flex-direction:column;">
<div style="background:#008b8b;text-align:center;color:white;font-size:1.5em;padding:0.8em;">For Players</div>
<div style="padding:1em;">
==Getting Started==
*[[Downgrading|Downgrading]]
*[[GameModifications|Game Modifications]]
*[[GamesAndVersions|Games & Versions]]

==More Information==
*[[ClientManual|Client Manual]]
*[[SteamDeck|Steam Deck]]
*[[FAQ|FAQ]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #008b8b;display:flex;flex-direction:column;">
<div style="background:#008b8b;text-align:center;color:white;font-size:1.5em;padding:0.8em;">For Servers</div>
<div style="padding:1em;">
==Hosting a server==
*[[Servers/GettingStarted|Getting Started]]
*[[PortForward|Port Forwarding]]
*[[ServerManual|Server Manual]]
*[[ServerConfiguration|Server Configuration]]
*[[CVars|CVars]]
*[[ServerRules|Server Rules]]

==Extending the server==
*[[Resources|Resources]]
*[[Modules|Modules]]

==Advanced==
*[[Dumpdoc|Dumpdoc]]
*[[ServerCommandLine|Server Command Line]]
*[[ServerQuery|Server Query]]
*[[Anticheat|Anticheat]]
*[[Limits|Limits]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #8b0000;display:flex;flex-direction:column;">
<div style="background:#8b0000;text-align:center;color:white;font-size:1.5em;padding:0.8em;">Scripting</div>
<div style="padding:1em;">
==Shared==
*[[Types|Types]]
*[[Defines|Defines]]

==Server==
*[[Server/Events|Events]]
*[[Server/Functions|Functions]]

==Client==
*[[Client/Events|Events]]
*[[Client/Functions|Functions]]
*[[Client/Natives|Native Scripting Functions]]

==Extra==
*[[ScriptingLanguages|Scripting Languages]]
*[[NetworkEvents|Network Events]]
*[[ScriptingExamples|Examples]]
*[[ScriptingTutorials|Tutorials]]
*[[NativeMultiplayer|Native MP Mode (GTA IV)]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #8b8b00;display:flex;flex-direction:column;">
<div style="background:#8b8b00;text-align:center;color:white;font-size:1.5em;padding:0.8em;">Reference</div>
<div style="display:flex;flex-wrap:wrap;gap:1em;padding:1em;flex:1;">

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAIII_Logo.png|32px|middle]] GTA III ===
*[[Resources/GTA3/Animations|Animations]]
*[[Resources/GTA3/PedSkins|Ped Skins]]
*[[Resources/GTA3/Pickups|Pickups]]
*[[Resources/GTA3/RadarBlips|Radar Blips]]
*[[Resources/GTA3/VehicleColours|Vehicle Colours]]
*[[Resources/GTA3/VehicleModels|Vehicle Models]]
*[[Resources/GTA3/Weapons|Weapons]]
*[[Resources/GTA3|More ...]]
</div>

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAVC_Logo.png|32px|middle]] GTA Vice City ===
*[[Resources/GTAVC/Animations|Animations]]
*[[Resources/GTAVC/PedSkins|Ped Skins]]
*[[Resources/GTAVC/Pickups|Pickups]]
*[[Resources/GTAVC/RadarBlips|Radar Blips]]
*[[Resources/GTAVC/VehicleColours|Vehicle Colours]]
*[[Resources/GTAVC/VehicleModels|Vehicle Models]]
*[[Resources/GTAVC/Weapons|Weapons]]
*[[Resources/GTAVC|More ...]]
</div>

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTASA_Logo.png|32px|middle]] GTA San Andreas ===
*[[Resources/GTASA/Animations|Animations]]
*[[Resources/GTASA/PedSkins|Ped Skins]]
*[[Resources/GTASA/Pickups|Pickups]]
*[[Resources/GTASA/RadarBlips|Radar Blips]]
*[[Resources/GTASA/VehicleColours|Vehicle Colours]]
*[[Resources/GTASA/VehicleModels|Vehicle Models]]
*[[Resources/GTASA/Weapons|Weapons]]
*[[Resources/GTASA|More ...]]
</div>

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAIV_Logo.png|32px|middle]] GTA IV ===
*[[Resources/GTAIV/Animations|Animations]]
*[[Resources/GTAIV/PedSkins|Ped Skins]]
*[[Resources/GTAIV/Pickups|Pickups]]
*[[Resources/GTAIV/RadarBlips|Radar Blips]]
*[[Resources/GTAIV/VehicleColours|Vehicle Colours]]
*[[Resources/GTAIV/VehicleModels|Vehicle Models]]
*[[Resources/GTAIV/Weapons|Weapons]]
*[[Resources/GTAIV|More ...]]
</div>

</div>
</div>

</div>
</div>

Main Page

2026-02-23T13:51:46Z

PerikiyoXD:

__NOTOC__
<div style="width:100%;padding:0;margin:0;">


<div style="background:#222222;text-align:center;color:white;font-size:2em;padding:1em;margin:0;">GTA Connected Wiki</div>


<div style="display:flex;flex-wrap:wrap;gap:1em;padding:1em;background:#f9f9f9;">


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #008b8b;display:flex;flex-direction:column;">
<div style="background:#008b8b;text-align:center;color:white;font-size:1.5em;padding:0.8em;">For Players</div>
<div style="padding:1em;">
==Getting Started==
*[[Downgrading|Downgrading]]
*[[GameModifications|Game Modifications]]
*[[GamesAndVersions|Games & Versions]]

==More Information==
*[[ClientManual|Client Manual]]
*[[SteamDeck|Steam Deck]]
*[[FAQ|FAQ]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #008b8b;display:flex;flex-direction:column;">
<div style="background:#008b8b;text-align:center;color:white;font-size:1.5em;padding:0.8em;">For Servers</div>
<div style="padding:1em;">
==Hosting a server==
*[[Server/GettingStarted|Getting Started]]
*[[PortForward|Port Forwarding]]
*[[ServerManual|Server Manual]]
*[[ServerConfiguration|Server Configuration]]
*[[CVars|CVars]]
*[[ServerRules|Server Rules]]

==Extending the server==
*[[Resources|Resources]]
*[[Modules|Modules]]

==Advanced==
*[[Dumpdoc|Dumpdoc]]
*[[ServerCommandLine|Server Command Line]]
*[[ServerQuery|Server Query]]
*[[Anticheat|Anticheat]]
*[[Limits|Limits]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #8b0000;display:flex;flex-direction:column;">
<div style="background:#8b0000;text-align:center;color:white;font-size:1.5em;padding:0.8em;">Scripting</div>
<div style="padding:1em;">
==Shared==
*[[Types|Types]]
*[[Defines|Defines]]

==Server==
*[[Server/Events|Events]]
*[[Server/Functions|Functions]]

==Client==
*[[Client/Events|Events]]
*[[Client/Functions|Functions]]
*[[Client/Natives|Native Scripting Functions]]

==Extra==
*[[ScriptingLanguages|Scripting Languages]]
*[[NetworkEvents|Network Events]]
*[[ScriptingExamples|Examples]]
*[[ScriptingTutorials|Tutorials]]
*[[NativeMultiplayer|Native MP Mode (GTA IV)]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #8b8b00;display:flex;flex-direction:column;">
<div style="background:#8b8b00;text-align:center;color:white;font-size:1.5em;padding:0.8em;">Reference</div>
<div style="display:flex;flex-wrap:wrap;gap:1em;padding:1em;flex:1;">

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAIII_Logo.png|32px|middle]] GTA III ===
*[[Resources/GTA3/Animations|Animations]]
*[[Resources/GTA3/PedSkins|Ped Skins]]
*[[Resources/GTA3/Pickups|Pickups]]
*[[Resources/GTA3/RadarBlips|Radar Blips]]
*[[Resources/GTA3/VehicleColours|Vehicle Colours]]
*[[Resources/GTA3/VehicleModels|Vehicle Models]]
*[[Resources/GTA3/Weapons|Weapons]]
*[[Resources/GTA3|More ...]]
</div>

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAVC_Logo.png|32px|middle]] GTA Vice City ===
*[[Resources/GTAVC/Animations|Animations]]
*[[Resources/GTAVC/PedSkins|Ped Skins]]
*[[Resources/GTAVC/Pickups|Pickups]]
*[[Resources/GTAVC/RadarBlips|Radar Blips]]
*[[Resources/GTAVC/VehicleColours|Vehicle Colours]]
*[[Resources/GTAVC/VehicleModels|Vehicle Models]]
*[[Resources/GTAVC/Weapons|Weapons]]
*[[Resources/GTAVC|More ...]]
</div>

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTASA_Logo.png|32px|middle]] GTA San Andreas ===
*[[Resources/GTASA/Animations|Animations]]
*[[Resources/GTASA/PedSkins|Ped Skins]]
*[[Resources/GTASA/Pickups|Pickups]]
*[[Resources/GTASA/RadarBlips|Radar Blips]]
*[[Resources/GTASA/VehicleColours|Vehicle Colours]]
*[[Resources/GTASA/VehicleModels|Vehicle Models]]
*[[Resources/GTASA/Weapons|Weapons]]
*[[Resources/GTASA|More ...]]
</div>

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAIV_Logo.png|32px|middle]] GTA IV ===
*[[Resources/GTAIV/Animations|Animations]]
*[[Resources/GTAIV/PedSkins|Ped Skins]]
*[[Resources/GTAIV/Pickups|Pickups]]
*[[Resources/GTAIV/RadarBlips|Radar Blips]]
*[[Resources/GTAIV/VehicleColours|Vehicle Colours]]
*[[Resources/GTAIV/VehicleModels|Vehicle Models]]
*[[Resources/GTAIV/Weapons|Weapons]]
*[[Resources/GTAIV|More ...]]
</div>

</div>
</div>

</div>
</div>

GettingStarted

2026-02-23T13:51:27Z

PerikiyoXD: PerikiyoXD moved page GettingStarted to Servers/GettingStarted: Namespacing

#REDIRECT [[Servers/GettingStarted]]

Servers/GettingStarted

2026-02-23T13:51:27Z

PerikiyoXD: PerikiyoXD moved page GettingStarted to Servers/GettingStarted: Namespacing

{{DISPLAYTITLE:Getting Started}}
{{BlueInformationBox|1=This guide explains how to '''create and run a server'''. If you only want to join and play on an existing server, this page is not required.}}

= Getting Started =

== Overview ==

Setting up a server involves four main steps:

# Download the server package from the [https://gtaconnected.com/downloads Downloads] page.
# Extract the files to a new, empty folder.
# Configure your server settings in <code>server.xml</code> (see [[ServerConfiguration|Server Configuration]]).
# Start the server executable.

Executable names:
* '''Windows:''' <code>Server.exe</code>
* '''Linux:''' See [[LinuxServer|Linux Server]] for available launch methods and instructions.

Once started successfully, the server will begin listening for incoming connections.

== Server Configuration ==

All core settings are stored in <code>server.xml</code>. This includes:

* Server name
* Port settings
* Resource loading
* Player limits
* Networking options

Refer to [[ServerConfiguration|Server Configuration]] for a full list of available settings and explanations.

After modifying the configuration, restart the server for changes to take effect.

== Game Mode Setup ==

=== GTA IV (Rockstar Modes) ===

To use Rockstar’s built-in game modes (Party Mode sessions):

# Navigate to the <code>resources</code> folder.
# Delete the <code>freeroam</code> folder.
# Open <code>server.xml</code>.
# Remove the line:
<pre><resource src="freeroam" /></pre>

Start the server normally.

Players who connect will enter a generic rendezvous lobby using Party Mode. From there:

* Players can use the in-game phone.
* Sessions can be created or joined directly.

=== GTA III, Vice City, San Andreas, and IV (Custom / Scripted Modes) ===

For scripted servers:

* Example scripts are available here:
[https://github.com/VortrexFTW/v-essentials v-essentials examples]

If creating your own scripts, you must at minimum:

* Spawn the player.
* Fade in the camera using [[gta.fadeCamera|gta.fadeCamera]].
* Trigger this logic in an appropriate event, such as [[OnPlayerJoined|onPlayerJoined]].

The default <code>freeroam</code> resource:

* Handles spawning and camera fade.
* Is designed for GTA III.
* May require modification for other games.

We also provide a [[MinimalResourceSkeleton|Minimal Resource Skeleton]] that you can use to start on your own.

== Resources ==

Resources control gameplay logic, scripts, and custom functionality.

See [[Resources|Resources]] for:

* Resource structure
* Loading and unloading
* Script organization
* Best practices

== Modules ==

Modules extend server functionality with native integrations such as:

* MySQL
* SQLite
* INI file handling
* Additional system-level features

See [[Modules|Modules]] for usage instructions.

Additional modules are available on the forum:
[https://forum.gtaconnected.com/index.php?board=24.0 Modules Board]

Developers with C or C++ experience can create custom modules using the:
[https://gtaconnected.com/downloads/ModuleSDK.7z Module SDK]

== Server Manual ==

For in-depth documentation covering commands, configuration, scripting, and advanced topics, see the [[ServerManual|Server Manual]].

== Next Steps ==

After your server is running:

* Verify connectivity (see port forwarding documentation if hosting from home).
* Test resource loading.
* Confirm players can join successfully.
* Begin developing or installing additional resources and modules.

Resources/GTAIV/Weapons

2026-02-23T13:48:22Z

PerikiyoXD:

== Weapon Flags ==

{| class="wikitable sortable"
! ID !! Name
|-
| 0 || CAN_AIM
|-
| 1 || CAN_AIM_WITH_ARM
|-
| 2 || CAN_FREE_AIM
|-
| 3 || FIRST_PERSON
|-
| 4 || KEEP_CAMERA_BEHIND
|-
| 5 || GUN
|-
| 6 || THROWN
|-
| 7 || HEAVY
|-
| 8 || SILENCED
|-
| 9 || MELEE_CLUB
|-
| 10 || MELEE_BLADE
|-
| 11 || ARMOUR_PENETRATING
|-
| 12 || 2HANDED
|-
| 13 || TREAT_AS_2HANDED_IN_COVER
|-
| 14 || ANIM_RELOAD
|-
| 15 || ANIM_CROUCH_FIRE
|-
| 16 || CREATE_VISIBLE_ORDNANCE
|-
| 17 || EXPLOSION_BASED_ON_IMPACT
|-
| 18 || ADD_SMOKE_ON_EXPLOSION
|-
| 19 || INSTANT_KILL_IN_MP
|-
| 20 || HIGHER_BREAK_FORCE
|-
| 21 || CAN_BE_USED_AS_DRIVEBY
|-
| 22 || HEAVY_WEAPON_USES_RIFLE_ANIMS
|-
| 23 || MISSION_CAN_FORCE_DRIVEBY_USE
|-
| 24 || DONT_RUMBLE_WHEN_DOING_DRIVE_BY
|}

== Weapon Slots ==

{| class="wikitable sortable"
! ID !! Name
|-
| 0 || UNARMED
|-
| 1 || MELEE
|-
| 2 || HANDGUN
|-
| 3 || SHOTGUN
|-
| 4 || SMG
|-
| 5 || RIFLE
|-
| 6 || SNIPER
|-
| 7 || HEAVY
|-
| 8 || THROWN
|-
| 9 || SPECIAL
|-
| 10 || GIFT
|-
| 11 || PARACHUTE
|-
| 12 || DETONATORUNKNOWN
|}

== Weapons ==

{| class="wikitable sortable"
! ID !! Name !! Associated Weapon Model
|-
| 0 || UNARMED || Fist
|-
| 1 || BASEBALLBAT || w_bat
|-
| 2 || POOLCUE || w_cue
|-
| 3 || KNIFE || w_knife
|-
| 4 || GRENADE || w_grenade
|-
| 5 || MOLOTOV || w_molotov
|-
| 6 || ROCKET || cj_rpg_rocket
|-
| 7 || PISTOL || w_glock
|-
| 8 || UNUSED0 ||
|-
| 9 || DEAGLE || w_eagle, w_e2_eagle (TBOGT only)
|-
| 10 || SHOTGUN || w_pumpshot
|-
| 11 || BARETTA || w_shotgun
|-
| 12 || MICRO_UZI || w_uzi
|-
| 13 || MP5 || w_mp5
|-
| 14 || AK47 || w_ak47
|-
| 15 || M4 || w_m4
|-
| 16 || SNIPERRIFLE || w_psg1
|-
| 17 || M40A1 || w_rifle
|-
| 18 || RLAUNCHER || rpg
|-
| 19 || FTHROWER || flame (Removed)
|-
| 20 || MINIGUN || minigun (Removed), Annihilator MiniGuns
|-
| 21 || EPISODIC_1 || w_e1_glauncher (TLAD), w_e2_glauncher (TBoGT)
|-
| 22 || EPISODIC_2 || w_e1_sweeper (TLAD)
|-
| 23 || EPISODIC_3 ||
|-
| 24 || EPISODIC_4 || w_e1_cuehalf (TLAD)
|-
| 25 || EPISODIC_5 || w_e1_grenade (TLAD), w_e2_grenade (TBoGT)
|-
| 26 || EPISODIC_6 || w_sawnoff (TLAD)
|-
| 27 || EPISODIC_7 || w_cz75 (TLAD)
|-
| 28 || EPISODIC_8 || w_pipebomb (TLAD)
|-
| 29 || EPISODIC_9 || w_44amag (TBoGT)
|-
| 30 || EPISODIC_10 || w_e2_aa12_exp (TBoGT)
|-
| 31 || EPISODIC_11 || w_e2_aa12 (TBoGT)
|-
| 32 || EPISODIC_12 || w_e2_p90 (TBoGT)
|-
| 33 || EPISODIC_13 || w_e2_uzi (TBoGT)
|-
| 34 || EPISODIC_14 || w_e2_m249 (TBoGT)
|-
| 35 || EPISODIC_15 || w_e2_dsr1 (TBoGT)
|-
| 36 || EPISODIC_16 || w_e2_stickybomb (TBoGT)
|-
| 37 || EPISODIC_17 || Buzzard Rocket Launcher (TBoGT)
|-
| 38 || EPISODIC_18 || Buzzard Rockets (TBoGT)
|-
| 39 || EPISODIC_19 || Buzzard Miniguns (TBoGT)
|-
| 40 || EPISODIC_20 || APC Cannons (TBoGT)
|-
| 41 || EPISODIC_21 || Parachute (TBoGT)
|-
| 42 || EPISODIC_22 ||
|-
| 43 || EPISODIC_23 ||
|-
| 44 || EPISODIC_24 ||
|-
| 45 || CAMERA ||
|-
| 46 || OBJECT || Pickup able Objects to be thrown
|-
| 47 || WEAPONTYPE_LAST_WEAPONTYPE ||
|-
| 48 || ARMOUR ||
|-
| 49 || RAMMEDBYCAR ||
|-
| 50 || RUNOVERBYCAR ||
|-
| 51 || EXPLOSION ||
|-
| 52 || UZI_DRIVEBY ||
|-
| 53 || DROWNING ||
|-
| 54 || FALL ||
|-
| 55 || UNIDENTIFIED ||
|-
| 56 || ANYMELEE ||
|-
| 57 || ANYWEAPON ||
|}

== Weapon Fire Types ==

{| class="wikitable sortable"
! ID !! Name
|-
| 0 || MELEE
|-
| 1 || INSTANT_HIT
|-
| 2 || DELAYED_HIT
|-
| 3 || PROJECTILE
|-
| 4 || AREA_EFFECT
|-
| 5 || CAMERA
|-
| 6 || USE
|-
| 7 || UNKNOWN
|}

== Weapon Damage Types ==

{| class="wikitable sortable"
! ID !! Name
|-
| 0 || NONE
|-
| 1 || MELEE
|-
| 2 || BULLET
|-
| 3 || EXPLOSIVE
|-
| 4 || FIRE
|-
| 5 || COLLISION
|-
| 6 || FALL
|-
| 7 || DROWN
|-
| 8 || UNKNOWN
|}

== Projectile Types ==

{| class="wikitable sortable"
! ID !! Name
|-
| 0 || NONE
|-
| 1 || FUSE
|-
| 2 || IMPACT
|-
| 3 || ROCKET
|-
| 4 || UNKNOWN
|-
| ? || STICKY
|}

== Weapon Groups ==

{| class="wikitable sortable"
! ID !! Name
|-
| 0 || PUNCH_KICK
|-
| 1 || MELEE_WOOD
|-
| 2 || MELEE_METAL
|-
| 3 || MELEE_SHARP
|-
| 4 || MELEE_GENERIC
|-
| 5 || PISTOL_SMALL
|-
| 6 || PISTOL_LARGE
|-
| 7 || PISTOL_SILENCED
|-
| 8 || SMG
|-
| 9 || SHOTGUN
|-
| 10 || RIFLE_ASSAULT
|-
| 11 || RIFLE_SNIPER
|-
| 12 || ROCKET
|-
| 13 || GRENADE
|-
| 14 || MOLOTOV
|-
| 15 || FIRE
|-
| 16 || EXPLOSION
|-
| 17 || UNKNOWN
|}

== Explosion Types ==

{| class="wikitable sortable"
! ID !! Name
|-
| 0 || GRENADE
|-
| 1 || MOLOTOV
|-
| 2 || ROCKET
|-
| 3 || HI_OCTANE
|-
| 4 || CAR
|-
| 5 || PLANE
|-
| 6 || PETROL_PUMP
|-
| 7 || BIKE
|-
| 8 || DIR_STEAM
|-
| 9 || DIR_FLAME
|-
| 10 || DIR_WATER_HYDRANT
|-
| 11 || DIR_GAS_CANISTER
|-
| 12 || BOAT
|-
| 13 || SHIP_DESTROY
|-
| 14 || TRUCK
|-
| 15 || EPISODIC_1
|-
| 16 || EPISODIC_2
|-
| 17 || EPISODIC_3
|-
| 18 || EPISODIC_4
|-
| 19 || EPISODIC_5
|-
| 20 || EPISODIC_6
|-
| 21 || EPISODIC_7
|-
| 22 || EPISODIC_8
|-
| 23 || EPISODIC_9
|-
| 24 || EPISODIC_10
|-
| 25 || UNKNOWN
|}

GameModifications

2026-02-23T11:54:05Z

PerikiyoXD: Readjust for better reading

{{DISPLAYTITLE:Game Modifications}}
== Overview ==
Modifications are generally not compatible with GTA Connected unless listed in the known compatible list below. GTA Connected's anticheat will prevent most mods from loading, and those that do load may cause bugs or crashes.

== Mod Support ==
There are currently no plans to add mod support. The GTA Connected developers are focused on improving game support, fixing bugs, and adding new features.

== Troubleshooting Mods ==
If a mod isn't loading, it is most likely blocked by GTA Connected's anticheat. The GTA Connected team cannot provide support for issues caused by modified game files, but you may be able to get help from other players on the [https://discord.com/invite/YSyasDa Discord] or [https://forum.gtaconnected.com/ forum].

If you find a mod that is or isn't compatible with GTA Connected, add it to the appropriate list below. If a forum topic exists with help or info for a listed mod, link it with the mod name.

== Known Compatible Mods ==
''This list only includes verified compatible mods and is not exhaustive.''<br>
{{game-iii-vc-sa}} [https://gtaforums.com/topic/669045-silentpatch/ SilentPatch]<br>
{{game-iv}} [https://gtaforums.com/topic/896795-1000-1080-zolika1351s-trainermod-menu-rewritten/ ZolikaMenu/ZMenu]<br>
{{game-iv}} [https://gtaforums.com/topic/955449-iv-zolikapatch/ ZolikaPatch]<br>
{{game-iv}} SteamAchievements<br>

== Known Incompatible Mods ==
''This list only includes verified incompatible mods and is not exhaustive.''<br>
{{game-iii-vc-sa}} [https://cleo.li/ CLEO]

Downgrading

2026-02-23T11:52:06Z

PerikiyoXD:

{{DISPLAYTITLE:Downgrading}}
= Patching the Games =
To play online, your game executable must be patched to a compatible version.
This process is called Downgrading.
Click the appropriate game logo below to download the required patch.
After downloading, verify the file's SHA256 hash to ensure integrity before replacing your existing executable.

== Downloads ==
{| class="wikitable"
! Game
! Download
! SHA256 Hash
|-
| '''Grand Theft Auto IV'''
| [[File:GTAIV_Logo.png|32px|middle|link=DowngradingIV]]
| <code>N/A</code> — GTA IV requires a multi-step downgrade process. See [[DowngradingIV]] for instructions.
|-
| '''Grand Theft Auto III'''
| [[File:GTAIII_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta3.exe]]
| <code>17e036ff18cdd805951fec9107746492f582ae1eb46ca028544e37e517e8fc1f</code>
|-
| '''Grand Theft Auto: Vice City'''
| [[File:GTAVC_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta-vc.exe]]
| <code>04e4db72629eaa786fdd182ac224f4fd6d68806f5f4fe5c1fb5f756dc4da11d7</code>
|-
| '''Grand Theft Auto: San Andreas'''
| [[File:GTASA_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta_sa.exe]]
| <code>590b4be1bb005f4e07edf6b32df4a95b7ba403fb85472d68aa4275875b345b6f</code>
|}

== Installation Instructions ==
# Download the correct executable for your game.
# Navigate to your game installation directory.
# Backup your original executable.
# Replace it with the downloaded patched version.
# Launch the game through the multiplayer client.

'''Note:''' GTA IV does not use a direct executable replacement. See [[DowngradingIV]] for its specific process.

== Verifying File Integrity ==
To verify the SHA256 hash:
* On Windows (PowerShell):
<pre>Get-FileHash gta_sa.exe -Algorithm SHA256</pre>
* On Linux:
<pre>sha256sum gta_sa.exe</pre>
Ensure the output matches the hash listed above exactly. If it does not match, do not use the file.

DowngradingIV

2026-02-23T11:49:46Z

PerikiyoXD:

{{DISPLAYTITLE:Patching GTA IV for GTA Connected}}

= Patching GTA IV for GTA Connected =

These instructions apply to a default installation of
[https://store.steampowered.com/app/12210/Grand_Theft_Auto_IV_The_Complete_Edition/ Grand Theft Auto IV: The Complete Edition].

The Complete Edition includes all Episodes in a single directory. After patching, you will be able to switch between Episodes and join any server without modifying your original game files.

Video tutorial:
https://youtu.be/hLUrUefMo8Y?t=8

== Requirements ==

* A clean GTA IV: Complete Edition installation
* GTA Connected installed
* Access to your GTA IV installation directory

== Installation Instructions ==

# Download the patch:
#* [https://wiki.gtaconnected.com/downloads/Retail-1080.zip Version 1.0.8.0] (recommended)
#* [https://wiki.gtaconnected.com/downloads/Retail-1070.zip Version 1.0.7.0]
# Extract the archive. It will create a folder named <code>Retail</code>.
# Drag the entire <code>Retail</code> folder into your GTA IV directory.
#* Do '''not''' move files out of the folder.
#* Do '''not''' overwrite your existing installation.
# Open the GTA Connected launcher.
# Go to ''Tools'' → ''Game Settings''.
# Select ''Grand Theft Auto IV'' from the game dropdown list.
# Next to ''Game EXE Path'', click ''Browse'' and select:
#* <code>GTAIV.exe</code> inside the new <code>Retail</code> folder.

Default Steam path:

<pre>
C:\Program Files (x86)\Steam\steamapps\common\Grand Theft Auto IV\GTAIV\Retail\GTAIV.exe
</pre>

# Go to ''Tools'' → ''Launcher Settings'' and set your player name.
# Double-click a server in the server browser to connect.

== How to Play in Lobbies ==

After joining a server:

* Press '''UP''' to open the in-game phone.
* Navigate to ''Multiplayer'' → ''Games''.
* Select ''Custom Match'' to view active lobbies.
* Join a lobby by double-clicking it.
** If double-click does not work, press '''DOWN''' and then '''ENTER'''.

If you know which lobby is active (for example, by holding '''TAB''' if the server uses [https://github.com/VortrexFTW/v-essentials/tree/master/v-scoreboard v-scoreboard]):

* Use ''Quick Match'' in the phone menu to connect directly.

Press '''Y''' to chat in-game.

== File Integrity Note ==

If installed correctly:

* Your original GTA IV files remain untouched.
* Steam or the Rockstar Launcher will not overwrite the patch.
* You can still launch and play the standard GTA IV: Complete Edition campaigns normally.
* GTA Connected uses the separate <code>Retail</code> folder only.

== FAQ ==

=== How do I customize my character? ===

# Open the phone.
# Create a ''Deathmatch'' lobby.
# Press '''M''' to open the character customization menu.

Downgrading

2026-02-23T11:48:17Z

PerikiyoXD:

{{DISPLAYTITLE:Downgrading}}

= Patching the Games =

To play online, your game executable must be patched to a compatible version.

This process is called Downgrading.

Click the appropriate game logo below to download the required patch.

After downloading, verify the file’s SHA256 hash to ensure integrity before replacing your existing executable.

== Downloads ==

{| class="wikitable"
! Game
! Download
! SHA256 Hash
|-
| '''Grand Theft Auto III'''
| [[File:GTAIII_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta3.exe]]
| <code>17e036ff18cdd805951fec9107746492f582ae1eb46ca028544e37e517e8fc1f</code>
|-
| '''Grand Theft Auto: Vice City'''
| [[File:GTAVC_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta-vc.exe]]
| <code>04e4db72629eaa786fdd182ac224f4fd6d68806f5f4fe5c1fb5f756dc4da11d7</code>
|-
| '''Grand Theft Auto: San Andreas'''
| [[File:GTASA_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta_sa.exe]]
| <code>590b4be1bb005f4e07edf6b32df4a95b7ba403fb85472d68aa4275875b345b6f</code>
|-
| '''Grand Theft Auto IV'''
| [[File:GTAIV_Logo.png|32px|middle|link=DowngradingIV]]
| <code>N/A</code>
|}

== Installation Instructions ==

# Download the correct executable for your game.
# Navigate to your game installation directory.
# Backup your original executable.
# Replace it with the downloaded patched version.
# Launch the game through the multiplayer client.

== Verifying File Integrity ==

To verify the SHA256 hash:

* On Windows (PowerShell):
<pre>Get-FileHash gta_sa.exe -Algorithm SHA256</pre>

* On Linux:
<pre>sha256sum gta_sa.exe</pre>

Ensure the output matches the hash listed above exactly. If it does not match, do not use the file.

== GTA IV ==

GTA IV requires a specific downgrade process rather than a direct executable replacement.

See [[DowngradingIV]] for detailed instructions.

Downgrading

2026-02-23T11:47:13Z

PerikiyoXD:

{{DISPLAYTITLE:Patching The Games}}

= Patching the Games =

To play online, your game executable must be patched to a compatible version.

Click the appropriate game logo below to download the required patch.

After downloading, verify the file’s SHA256 hash to ensure integrity before replacing your existing executable.

== Downloads ==

{| class="wikitable"
! Game
! Download
! SHA256 Hash
|-
| '''Grand Theft Auto III'''
| [[File:GTAIII_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta3.exe]]
| <code>17e036ff18cdd805951fec9107746492f582ae1eb46ca028544e37e517e8fc1f</code>
|-
| '''Grand Theft Auto: Vice City'''
| [[File:GTAVC_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta-vc.exe]]
| <code>04e4db72629eaa786fdd182ac224f4fd6d68806f5f4fe5c1fb5f756dc4da11d7</code>
|-
| '''Grand Theft Auto: San Andreas'''
| [[File:GTASA_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta_sa.exe]]
| <code>590b4be1bb005f4e07edf6b32df4a95b7ba403fb85472d68aa4275875b345b6f</code>
|-
| '''Grand Theft Auto IV'''
| [[File:GTAIV_Logo.png|32px|middle|link=DowngradingIV]]
| <code>N/A</code>
|}

== Installation Instructions ==

# Download the correct executable for your game.
# Navigate to your game installation directory.
# Backup your original executable.
# Replace it with the downloaded patched version.
# Launch the game through the multiplayer client.

== Verifying File Integrity ==

To verify the SHA256 hash:

* On Windows (PowerShell):
<pre>Get-FileHash gta_sa.exe -Algorithm SHA256</pre>

* On Linux:
<pre>sha256sum gta_sa.exe</pre>

Ensure the output matches the hash listed above exactly. If it does not match, do not use the file.

== GTA IV ==

GTA IV requires a specific downgrade process rather than a direct executable replacement.

See [[DowngradingIV]] for detailed instructions.

Servers/GettingStarted

2026-02-23T11:45:49Z

PerikiyoXD:

MinimalResourceSkeleton

2026-02-23T11:43:02Z

PerikiyoXD: Created page with "{{DISPLAYTITLE:MinimalResourceSkeleton}} = Minimal Resource Skeleton = This page provides the smallest functional scripted resource required to: * Handle a player joining the server * Spawn the player at a fixed position * Fade in the camera * Log basic server-side activity This is intended as a starting point for custom game modes. == Purpose == When building a custom server mode, you must: * Create a player element * Spawn the player * Fade in the camera * Handl..."

{{DISPLAYTITLE:MinimalResourceSkeleton}}

= Minimal Resource Skeleton =

This page provides the smallest functional scripted resource required to:

* Handle a player joining the server
* Spawn the player at a fixed position
* Fade in the camera
* Log basic server-side activity

This is intended as a starting point for custom game modes.

== Purpose ==

When building a custom server mode, you must:

* Create a player element
* Spawn the player
* Fade in the camera
* Handle join logic

Without this logic, players may connect but remain in a black screen or uninitialized state.

This example demonstrates the minimal structure needed to make a playable resource.

== Example Script ==

Place the following code inside your resource’s main JavaScript file (for example: <code>main.js</code>).

<syntaxhighlight lang="javascript">
let spawn_pos = [39.59, 128.88, 15.63]; // Example spawn position

function respawnPlayer(client) {
console.log(`Respawning player ${client.name}`);
spawnPlayer(client, spawn_pos);
console.log(`Player ${client.name} respawned.`);
}

addEventHandler("OnPlayerJoined", (event, client) => {
console.log(`Player ${client.name} joined the server.`);

if (client.player) {
destroyElement(client.player);
console.log(`Destroyed player element for ${client.name}`);
}

respawnPlayer(client);
fadeCamera(client, true);
});
</syntaxhighlight>

== How It Works ==

=== Spawn Position ===

<code>spawn_pos</code> defines the coordinates where players will appear:

<pre>
[x, y, z]
</pre>

Replace the values with valid coordinates for your game map.

=== OnPlayerJoined Event ===

<code>OnPlayerJoined</code> is triggered when a client successfully connects.

The handler:

# Logs the join event.
# Destroys any existing player element (safety cleanup).
# Calls <code>respawnPlayer()</code>.
# Fades the camera in.

=== destroyElement ===

If a player element already exists for the client, it is destroyed before respawning. This prevents duplicate player entities.

=== spawnPlayer ===

<code>spawnPlayer(client, positionArray)</code> creates and places the player at the given coordinates.

=== fadeCamera ===

<code>fadeCamera(client, true)</code> fades the camera in from black.
If omitted, the player may remain on a black screen.

== Required Resource Structure ==

Minimal folder layout:

<pre>
resources/
└── minimal/
├── resource.xml
└── main.js
</pre>

Example <code>resource.xml</code>:

<pre>
<resource>
<script src="main.js" />
</resource>
</pre>

Ensure the resource is added to <code>server.xml</code>:

<pre>
<resource src="minimal" />
</pre>

== What This Does Not Include ==

This minimal skeleton does NOT include:

* Weapons
* Teams
* Vehicles
* Custom game logic
* Respawn timers
* Death handling
* UI elements

It only guarantees that:

* A player joins
* A player spawns
* The camera fades in
* The server logs activity

== Next Steps ==

From this baseline, you can extend the resource with:

* Spawn selection
* Death events
* Custom game rules
* Vehicle spawning
* Database-backed accounts (via modules)
* Teams and scoring systems

For additional scripting references, see:

* [[Resources]]
* [[ServerManual]]
* [[gta.fadeCamera]]
* [[OnPlayerJoined]]

Servers/GettingStarted

2026-02-23T11:41:45Z

PerikiyoXD:

{{DISPLAYTITLE:Getting Started}}
{{BlueInformationBox|1=This guide explains how to '''create and run a server'''. If you only want to join and play on an existing server, this page is not required.}}

= Getting Started =

== Overview ==

Setting up a server involves four main steps:

# Download the server package from the [https://gtaconnected.com/downloads Downloads] page.
# Extract the files to a new, empty folder.
# Configure your server settings in <code>server.xml</code> (see [[ServerConfiguration|Server Configuration]]).
# Start the server executable.

Executable names:
* '''Windows:''' <code>Server.exe</code>
* '''Linux:''' See [[LinuxServer|Linux Server]] for available launch methods and instructions.

Once started successfully, the server will begin listening for incoming connections.

== Server Configuration ==

All core settings are stored in <code>server.xml</code>. This includes:

* Server name
* Port settings
* Resource loading
* Player limits
* Networking options

Refer to [[ServerConfiguration|Server Configuration]] for a full list of available settings and explanations.

After modifying the configuration, restart the server for changes to take effect.

== Game Mode Setup ==

=== GTA IV (Rockstar Modes) ===

To use Rockstar’s built-in game modes (Party Mode sessions):

# Navigate to the <code>resources</code> folder.
# Delete the <code>freeroam</code> folder.
# Open <code>server.xml</code>.
# Remove the line:
<pre><resource src="freeroam" /></pre>

Start the server normally.

Players who connect will enter a generic rendezvous lobby using Party Mode. From there:

* Players can use the in-game phone.
* Sessions can be created or joined directly.

=== GTA III, Vice City, San Andreas, and IV (Custom / Scripted Modes) ===

For scripted servers:

* Example scripts are available here:
[https://github.com/VortrexFTW/v-essentials v-essentials examples]

If creating your own scripts, you must at minimum:

* Spawn the player.
* Fade in the camera using [[gta.fadeCamera|gta.fadeCamera]].
* Trigger this logic in an appropriate event, such as [[OnPlayerJoined|onPlayerJoined]].

The default <code>freeroam</code> resource:

* Handles spawning and camera fade.
* Is designed for GTA III.
* May require modification for other games.

== Resources ==

Resources control gameplay logic, scripts, and custom functionality.

See [[Resources|Resources]] for:

* Resource structure
* Loading and unloading
* Script organization
* Best practices

== Modules ==

Modules extend server functionality with native integrations such as:

* MySQL
* SQLite
* INI file handling
* Additional system-level features

See [[Modules|Modules]] for usage instructions.

Additional modules are available on the forum:
[https://forum.gtaconnected.com/index.php?board=24.0 Modules Board]

Developers with C or C++ experience can create custom modules using the:
[https://gtaconnected.com/downloads/ModuleSDK.7z Module SDK]

== Server Manual ==

For in-depth documentation covering commands, configuration, scripting, and advanced topics, see the [[ServerManual|Server Manual]].

== Next Steps ==

After your server is running:

* Verify connectivity (see port forwarding documentation if hosting from home).
* Test resource loading.
* Confirm players can join successfully.
* Begin developing or installing additional resources and modules.

Main Page

2026-02-23T11:38:24Z

PerikiyoXD: Add portforward to main

__NOTOC__
<div style="width:100%;padding:0;margin:0;">


<div style="background:#222222;text-align:center;color:white;font-size:2em;padding:1em;margin:0;">GTA Connected Wiki</div>


<div style="display:flex;flex-wrap:wrap;gap:1em;padding:1em;background:#f9f9f9;">


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #008b8b;display:flex;flex-direction:column;">
<div style="background:#008b8b;text-align:center;color:white;font-size:1.5em;padding:0.8em;">For Players</div>
<div style="padding:1em;">
==Getting Started==
*[[Downgrading|Downgrading]]
*[[GameModifications|Game Modifications]]
*[[GamesAndVersions|Games & Versions]]

==More Information==
*[[ClientManual|Client Manual]]
*[[SteamDeck|Steam Deck]]
*[[FAQ|FAQ]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #008b8b;display:flex;flex-direction:column;">
<div style="background:#008b8b;text-align:center;color:white;font-size:1.5em;padding:0.8em;">For Servers</div>
<div style="padding:1em;">
==Hosting a server==
*[[GettingStarted|Getting Started]]
*[[PortForward|Port Forwarding]]
*[[ServerManual|Server Manual]]
*[[ServerConfiguration|Server Configuration]]
*[[CVars|CVars]]
*[[ServerRules|Server Rules]]

==Extending the server==
*[[Resources|Resources]]
*[[Modules|Modules]]

==Advanced==
*[[Dumpdoc|Dumpdoc]]
*[[ServerCommandLine|Server Command Line]]
*[[ServerQuery|Server Query]]
*[[Anticheat|Anticheat]]
*[[Limits|Limits]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #8b0000;display:flex;flex-direction:column;">
<div style="background:#8b0000;text-align:center;color:white;font-size:1.5em;padding:0.8em;">Scripting</div>
<div style="padding:1em;">
==Shared==
*[[Types|Types]]
*[[Defines|Defines]]

==Server==
*[[Server/Events|Events]]
*[[Server/Functions|Functions]]

==Client==
*[[Client/Events|Events]]
*[[Client/Functions|Functions]]
*[[Client/Natives|Native Scripting Functions]]

==Extra==
*[[ScriptingLanguages|Scripting Languages]]
*[[NetworkEvents|Network Events]]
*[[ScriptingExamples|Examples]]
*[[ScriptingTutorials|Tutorials]]
*[[NativeMultiplayer|Native MP Mode (GTA IV)]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #8b8b00;display:flex;flex-direction:column;">
<div style="background:#8b8b00;text-align:center;color:white;font-size:1.5em;padding:0.8em;">Reference</div>
<div style="display:flex;flex-wrap:wrap;gap:1em;padding:1em;flex:1;">

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAIII_Logo.png|32px|middle]] GTA III ===
*[[Resources/GTA3/Animations|Animations]]
*[[Resources/GTA3/PedSkins|Ped Skins]]
*[[Resources/GTA3/Pickups|Pickups]]
*[[Resources/GTA3/RadarBlips|Radar Blips]]
*[[Resources/GTA3/VehicleColours|Vehicle Colours]]
*[[Resources/GTA3/VehicleModels|Vehicle Models]]
*[[Resources/GTA3/Weapons|Weapons]]
*[[Resources/GTA3|More ...]]
</div>

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAVC_Logo.png|32px|middle]] GTA Vice City ===
*[[Resources/GTAVC/Animations|Animations]]
*[[Resources/GTAVC/PedSkins|Ped Skins]]
*[[Resources/GTAVC/Pickups|Pickups]]
*[[Resources/GTAVC/RadarBlips|Radar Blips]]
*[[Resources/GTAVC/VehicleColours|Vehicle Colours]]
*[[Resources/GTAVC/VehicleModels|Vehicle Models]]
*[[Resources/GTAVC/Weapons|Weapons]]
*[[Resources/GTAVC|More ...]]
</div>

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTASA_Logo.png|32px|middle]] GTA San Andreas ===
*[[Resources/GTASA/Animations|Animations]]
*[[Resources/GTASA/PedSkins|Ped Skins]]
*[[Resources/GTASA/Pickups|Pickups]]
*[[Resources/GTASA/RadarBlips|Radar Blips]]
*[[Resources/GTASA/VehicleColours|Vehicle Colours]]
*[[Resources/GTASA/VehicleModels|Vehicle Models]]
*[[Resources/GTASA/Weapons|Weapons]]
*[[Resources/GTASA|More ...]]
</div>

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAIV_Logo.png|32px|middle]] GTA IV ===
*[[Resources/GTAIV/Animations|Animations]]
*[[Resources/GTAIV/PedSkins|Ped Skins]]
*[[Resources/GTAIV/Pickups|Pickups]]
*[[Resources/GTAIV/RadarBlips|Radar Blips]]
*[[Resources/GTAIV/VehicleColours|Vehicle Colours]]
*[[Resources/GTAIV/VehicleModels|Vehicle Models]]
*[[Resources/GTAIV/Weapons|Weapons]]
*[[Resources/GTAIV|More ...]]
</div>

</div>
</div>

</div>
</div>

PortForward

2026-02-23T11:37:09Z

PerikiyoXD:

{{DISPLAYTITLE:Port Forwarding}}

= Port Forwarding =

== What Is Port Forwarding? ==

Port forwarding is a router configuration that allows external devices on the internet to connect to a specific device inside your local network.

By default, home routers block unsolicited incoming traffic for security reasons. Port forwarding creates a rule that:

* Listens on a specific external port
* Accepts incoming traffic on that port
* Forwards the traffic to a designated internal IP address and port

This is required when hosting a server from a home network.

== Why Is It Required? ==

If you are running a server from a PC on your home network:

* Your router blocks incoming connections by default.
* External players cannot reach your server.
* Server listing services cannot communicate with your server.

Without port forwarding, your server will only be accessible from inside your local network.

== Before You Begin ==

Ensure the following:

* You have access to your router’s admin panel.
* Your server PC has a static local IP address (or a DHCP reservation).
* You know the ports your server uses.

Default server ports:

* '''22000 UDP'''
* '''22000 TCP'''
* '''HTTP port (if applicable)'''

Ports can be changed in your [[ServerConfiguration|server configuration]].

== How to Open Ports ==

Port forwarding is configured in your router settings.

General steps:

# Log into your router’s admin interface (usually 192.168.0.1 or 192.168.1.1).
# Locate the section labeled:
#* Port Forwarding
#* Virtual Server
#* NAT Rules
#* Applications & Gaming
# Create a new rule:
#* External Port: 22000
#* Internal IP: (your server PC’s local IP)
#* Internal Port: 22000
#* Protocol: TCP + UDP
# Save changes.
# Restart the router if required.

Because every router interface is different, consult:
[https://portforward.com/router.htm portforward.com router guide]

Select your router model for step-by-step instructions.

== Verifying Port Forwarding ==

After configuring:

* Ensure the server is running.
* Use an external port checking tool.
* Ask someone outside your network to attempt connection.

You can check whether your port is open using:
[https://www.yougetsignal.com/tools/open-ports/ YouGetSignal Open Port Checker]

Enter your public IP address and the port number (e.g., 22000) to test accessibility.

Important: Port checks will fail if the server is not running.

== Troubleshooting ==

=== No Router Access ===

If you do not control the router (e.g., apartment, campus, shared housing), you cannot configure port forwarding yourself.

=== Router Restart Required ===

Some routers require:

* A reboot
* A full power cycle

Changes may take seconds to several minutes to apply.

=== ISP Port Blocking ===

Some Internet Service Providers block:

* Specific ports
* All inbound ports

Possible solutions:

* Contact your ISP
* Use a VPN with port forwarding support
* Use a VPS or dedicated hosting provider

=== Carrier-Grade NAT (CGNAT) ===

If your ISP uses [https://en.wikipedia.org/wiki/Carrier-grade_NAT carrier-grade NAT (CGNAT)]:

* You do not have a public IPv4 address.
* Port forwarding will not work.

Solutions:

* Request a public IP from your ISP
* Use IPv6 (if supported)
* Use a VPS or external hosting
* Use a VPN that provides port forwarding

=== Firewall Conflicts ===

Ensure:

* Your operating system firewall allows the server.
* Security software is not blocking the ports.
* The internal IP in the router rule matches your server machine.

== Alternatives to Port Forwarding ==

If port forwarding is not possible:

* Rent a VPS
* Use dedicated game server hosting
* Use a VPN with port forwarding
* Use a reverse proxy or tunneling solution

These options typically involve cost but avoid router configuration.

== Summary ==

Port forwarding allows external players to connect to a server hosted on your home network. It requires:

* Router access
* Correct port configuration
* A public IP address
* Proper firewall rules

Without it, your server will not be reachable from the internet.

PortForward

2026-02-23T11:33:25Z

PerikiyoXD:

{{DISPLAYTITLE:Port Forwarding}}

= Port Forwarding =

== What Is Port Forwarding? ==

Port forwarding is a router configuration that allows external devices on the internet to connect to a specific device inside your local network.

By default, home routers block unsolicited incoming traffic for security reasons. Port forwarding creates a rule that:

* Listens on a specific external port
* Accepts incoming traffic on that port
* Forwards the traffic to a designated internal IP address and port

This is required when hosting a server from a home network.

== Why Is It Required? ==

If you are running a server from a PC on your home network:

* Your router blocks incoming connections by default.
* External players cannot reach your server.
* Server listing services cannot communicate with your server.

Without port forwarding, your server will only be accessible from inside your local network.

== Before You Begin ==

Ensure the following:

* You have access to your router’s admin panel.
* Your server PC has a static local IP address (or a DHCP reservation).
* You know the ports your server uses.

Default server ports:

* **22000 UDP**
* **22000 TCP**
* **HTTP port (if applicable)**

Ports can be changed in the [[ServerConfiguration|server configuration]].

== How to Open Ports ==

Port forwarding is configured in your router settings.

General steps:

1. Log into your router’s admin interface (usually 192.168.0.1 or 192.168.1.1).
2. Locate the section labeled:

* Port Forwarding
* Virtual Server
* NAT Rules
* Applications & Gaming
3. Create a new rule:

* External Port: 22000
* Internal IP: (your server PC’s local IP)
* Internal Port: 22000
* Protocol: TCP + UDP
4. Save changes.
5. Restart the router if required.

Because every router interface is different, consult:
[https://portforward.com/router.htm](https://portforward.com/router.htm)

Select your router model for step-by-step instructions.

== Verifying Port Forwarding ==

After configuring:

* Ensure the server is running.
* Use an external port checking tool.
* Ask someone outside your network to attempt connection.

Important: Port checks will fail if the server is not running.

== Troubleshooting ==

=== No Router Access ===
If you do not control the router (e.g., apartment, campus, shared housing), you cannot configure port forwarding yourself.

=== Router Restart Required ===
Some routers require:

* A reboot
* A full power cycle

Changes may take seconds to several minutes to apply.

=== ISP Port Blocking ===
Some Internet Service Providers block:

* Specific ports
* All inbound ports

Possible solutions:

* Contact your ISP
* Use a VPN with port forwarding support
* Use a VPS or dedicated hosting provider

=== Carrier-Grade NAT (CGNAT) ===
If your ISP uses CGNAT:

* You do not have a public IPv4 address.
* Port forwarding will not work.

Solutions:

* Request a public IP from your ISP
* Use IPv6 (if supported)
* Use a VPS or external hosting
* Use a VPN that provides port forwarding

=== Firewall Conflicts ===
Ensure:

* Your operating system firewall allows the server.
* Security software is not blocking the ports.
* The internal IP in the router rule matches your server machine.

== Alternatives to Port Forwarding ==

If port forwarding is not possible:

* Rent a VPS
* Use dedicated game server hosting
* Use a VPN with port forwarding
* Use a reverse proxy or tunneling solution

These options typically involve cost but avoid router configuration.

== Summary ==

Port forwarding allows external players to connect to a server hosted on your home network. It requires:

* Router access
* Correct port configuration
* A public IP address
* Proper firewall rules

Without it, your server will not be reachable from the internet.

Main Page

2026-02-23T10:59:50Z

PerikiyoXD:

__NOTOC__
<div style="width:100%;padding:0;margin:0;">


<div style="background:#222222;text-align:center;color:white;font-size:2em;padding:1em;margin:0;">GTA Connected Wiki</div>


<div style="display:flex;flex-wrap:wrap;gap:1em;padding:1em;background:#f9f9f9;">


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #008b8b;display:flex;flex-direction:column;">
<div style="background:#008b8b;text-align:center;color:white;font-size:1.5em;padding:0.8em;">For Players</div>
<div style="padding:1em;">
==Getting Started==
*[[Downgrading|Downgrading]]
*[[GameModifications|Game Modifications]]
*[[GamesAndVersions|Games & Versions]]

==More Information==
*[[ClientManual|Client Manual]]
*[[SteamDeck|Steam Deck]]
*[[FAQ|FAQ]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #008b8b;display:flex;flex-direction:column;">
<div style="background:#008b8b;text-align:center;color:white;font-size:1.5em;padding:0.8em;">For Servers</div>
<div style="padding:1em;">
==Hosting a server==
*[[GettingStarted|Getting Started]]
*[[ServerManual|Server Manual]]
*[[ServerConfiguration|Server Configuration]]
*[[CVars|CVars]]
*[[ServerRules|Server Rules]]

==Extending the server==
*[[Resources|Resources]]
*[[Modules|Modules]]

==Advanced==
*[[Dumpdoc|Dumpdoc]]
*[[ServerCommandLine|Server Command Line]]
*[[ServerQuery|Server Query]]
*[[Anticheat|Anticheat]]
*[[Limits|Limits]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #8b0000;display:flex;flex-direction:column;">
<div style="background:#8b0000;text-align:center;color:white;font-size:1.5em;padding:0.8em;">Scripting</div>
<div style="padding:1em;">
==Shared==
*[[Types|Types]]
*[[Defines|Defines]]

==Server==
*[[Server/Events|Events]]
*[[Server/Functions|Functions]]

==Client==
*[[Client/Events|Events]]
*[[Client/Functions|Functions]]
*[[Client/Natives|Native Scripting Functions]]

==Extra==
*[[ScriptingLanguages|Scripting Languages]]
*[[NetworkEvents|Network Events]]
*[[ScriptingExamples|Examples]]
*[[ScriptingTutorials|Tutorials]]
*[[NativeMultiplayer|Native MP Mode (GTA IV)]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #8b8b00;display:flex;flex-direction:column;">
<div style="background:#8b8b00;text-align:center;color:white;font-size:1.5em;padding:0.8em;">Reference</div>
<div style="display:flex;flex-wrap:wrap;gap:1em;padding:1em;flex:1;">

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAIII_Logo.png|32px|middle]] GTA III ===
*[[Resources/GTA3/Animations|Animations]]
*[[Resources/GTA3/PedSkins|Ped Skins]]
*[[Resources/GTA3/Pickups|Pickups]]
*[[Resources/GTA3/RadarBlips|Radar Blips]]
*[[Resources/GTA3/VehicleColours|Vehicle Colours]]
*[[Resources/GTA3/VehicleModels|Vehicle Models]]
*[[Resources/GTA3/Weapons|Weapons]]
*[[Resources/GTA3|More ...]]
</div>

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAVC_Logo.png|32px|middle]] GTA Vice City ===
*[[Resources/GTAVC/Animations|Animations]]
*[[Resources/GTAVC/PedSkins|Ped Skins]]
*[[Resources/GTAVC/Pickups|Pickups]]
*[[Resources/GTAVC/RadarBlips|Radar Blips]]
*[[Resources/GTAVC/VehicleColours|Vehicle Colours]]
*[[Resources/GTAVC/VehicleModels|Vehicle Models]]
*[[Resources/GTAVC/Weapons|Weapons]]
*[[Resources/GTAVC|More ...]]
</div>

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTASA_Logo.png|32px|middle]] GTA San Andreas ===
*[[Resources/GTASA/Animations|Animations]]
*[[Resources/GTASA/PedSkins|Ped Skins]]
*[[Resources/GTASA/Pickups|Pickups]]
*[[Resources/GTASA/RadarBlips|Radar Blips]]
*[[Resources/GTASA/VehicleColours|Vehicle Colours]]
*[[Resources/GTASA/VehicleModels|Vehicle Models]]
*[[Resources/GTASA/Weapons|Weapons]]
*[[Resources/GTASA|More ...]]
</div>

<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAIV_Logo.png|32px|middle]] GTA IV ===
*[[Resources/GTAIV/Animations|Animations]]
*[[Resources/GTAIV/PedSkins|Ped Skins]]
*[[Resources/GTAIV/Pickups|Pickups]]
*[[Resources/GTAIV/RadarBlips|Radar Blips]]
*[[Resources/GTAIV/VehicleColours|Vehicle Colours]]
*[[Resources/GTAIV/VehicleModels|Vehicle Models]]
*[[Resources/GTAIV/Weapons|Weapons]]
*[[Resources/GTAIV|More ...]]
</div>

</div>
</div>

</div>
</div>

Main Page

2026-02-23T10:56:19Z

PerikiyoXD:

__NOTOC__
<div style="width:100%;padding:0;margin:0;">


<div style="background:#222222;text-align:center;color:white;font-size:2em;padding:1em;margin:0;">GTA Connected Wiki</div>


<div style="display:flex;flex-wrap:wrap;gap:1em;padding:1em;background:#f9f9f9;">


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #008b8b;display:flex;flex-direction:column;">
<div style="background:#008b8b;text-align:center;color:white;font-size:1.5em;padding:0.8em;">For Players</div>
<div style="padding:1em;">
==Getting Started==
*[[Downgrading|Downgrading]]
*[[GameModifications|Game Modifications]]
*[[GamesAndVersions|Games & Versions]]

==More Information==
*[[ClientManual|Client Manual]]
*[[SteamDeck|Steam Deck]]
*[[FAQ|FAQ]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #008b8b;display:flex;flex-direction:column;">
<div style="background:#008b8b;text-align:center;color:white;font-size:1.5em;padding:0.8em;">For Servers</div>
<div style="padding:1em;">
==Hosting a server==
*[[GettingStarted|Getting Started]]
*[[ServerManual|Server Manual]]
*[[ServerConfiguration|Server Configuration]]
*[[CVars|CVars]]
*[[ServerRules|Server Rules]]

==Extending the server==
*[[Resources|Resources]]
*[[Modules|Modules]]

==Advanced==
*[[Dumpdoc|Dumpdoc]]
*[[ServerCommandLine|Server Command Line]]
*[[ServerQuery|Server Query]]
*[[Anticheat|Anticheat]]
*[[Limits|Limits]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #8b0000;display:flex;flex-direction:column;">
<div style="background:#8b0000;text-align:center;color:white;font-size:1.5em;padding:0.8em;">Scripting</div>
<div style="padding:1em;">
==Shared==
*[[Types|Types]]
*[[Defines|Defines]]

==Server==
*[[Server/Events|Events]]
*[[Server/Functions|Functions]]

==Client==
*[[Client/Events|Events]]
*[[Client/Functions|Functions]]
*[[Client/Natives|Native Scripting Functions]]

==Extra==
*[[ScriptingLanguages|Scripting Languages]]
*[[NetworkEvents|Network Events]]
*[[ScriptingExamples|Examples]]
*[[ScriptingTutorials|Tutorials]]
*[[NativeMultiplayer|Native MP Mode (GTA IV)]]
</div>
</div>


<div class="mainPageLinksBox" style="flex:1 1 300px;border:4px solid #8b8b00;display:flex;flex-direction:column;">
<div style="background:#8b8b00;text-align:center;color:white;font-size:1.5em;padding:0.8em;">Reference</div>
<div style="display:flex;flex-wrap:wrap;gap:1em;padding:1em;flex:1;">
<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAIII_Logo.png|32px|middle]] GTA III ===
{{Resources/ShortGTA3}}
</div>
<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAVC_Logo.png|32px|middle]] GTA Vice City ===
{{Resources/ShortGTAVC}}
</div>
<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTASA_Logo.png|32px|middle]] GTA San Andreas ===
{{Resources/ShortGTASA}}
</div>
<div style="flex:1 1 120px;padding:0.8em;border:1px solid #ddd;background:white;">
=== [[Image:GTAIV_Logo.png|32px|middle]] GTA IV ===
{{Resources/ShortGTAIV}}
</div>
</div>
</div>

</div>
</div>

Template:MainPageResources

2026-02-23T10:53:53Z

PerikiyoXD: Undo revision 11392 by PerikiyoXD (talk)

__NOTOC__
<div class="mainPageLinksBox" style="border:4px solid #8b8b00;width:22%" >
<div style="background:#8b8b00;text-align:center;color:white;font-size:2em">Reference</div>
<div style="margin:1em;">
<div>
==[[Image:GTAIII_Logo.png|32px|middle]] GTA III==

{{Resources/ShortGTA3}}

==[[Image:GTAVC_Logo.png|32px|middle]] GTA Vice City==
{{Resources/ShortGTAVC}}
</div>
<div>
==[[Image:GTASA_Logo.png|32px|middle]] GTA San Andreas==
{{Resources/ShortGTASA}}
</div>
<div>
==[[Image:GTAIV_Logo.png|32px|middle]] GTA IV==
{{Resources/ShortGTAIV}}
</div>
</div>
</div>

Template:MainPageResources

2026-02-23T10:47:02Z

PerikiyoXD:

__NOTOC__
<div style="background:#8b8b00;text-align:center;color:white;font-size:2em;width:100%">Reference</div>
<div class="mainPageLinksBox" style="border:4px solid #8b8b00;width:100%;border-top:none;height:auto;display:flex;flex-direction:column;align-items:center;justify-content:center;">
<div style="margin:1em;">
<div style="display: flex; flex-wrap: wrap; gap: 1em;">
<div style="flex: 1 1 300px;">
== [[Image:GTAIII_Logo.png|32px|middle]] GTA III ==

{{Resources/ShortGTA3}}
</div>
<div style="flex: 1 1 300px;">
== [[Image:GTAVC_Logo.png|32px|middle]] GTA Vice City ==
{{Resources/ShortGTAVC}}
</div>
<div style="flex: 1 1 300px;">
== [[Image:GTASA_Logo.png|32px|middle]] GTA San Andreas ==
{{Resources/ShortGTASA}}
</div>
<div style="flex: 1 1 300px;">
== [[Image:GTAIV_Logo.png|32px|middle]] GTA IV ==
{{Resources/ShortGTAIV}}
</div>
</div>
</div>

meta.xml

2026-02-20T03:40:35Z

PerikiyoXD: Easy redirect by keyword "meta.xml"

#REDIRECT [[Resources#Meta.xml_File]]

Downgrading

2026-02-11T16:32:55Z

PerikiyoXD:

{{DISPLAYTITLE:Patching The Games}}

Click on the game logo below to download the patch.

{| class="wikitable" style="text-align:left;"
! Game !! Hash (SHA256)
|-
| [[File:GTAIII_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta3.exe]] '''Grand Theft Auto III'''
| <code>17e036ff18cdd805951fec9107746492f582ae1eb46ca028544e37e517e8fc1f</code>
|-
| [[File:GTAVC_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta-vc.exe]] '''Grand Theft Auto: Vice City'''
| <code>04e4db72629eaa786fdd182ac224f4fd6d68806f5f4fe5c1fb5f756dc4da11d7</code>
|-
| [[File:GTASA_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta_sa.exe]] '''Grand Theft Auto: San Andreas'''
| <code>590b4be1bb005f4e07edf6b32df4a95b7ba403fb85472d68aa4275875b345b6f</code>
|-
| [[File:GTAIV_Logo.png|32px|middle|link=DowngradingIV]] '''Grand Theft Auto IV'''
| <code>N/A</code>
|}

Downgrading

2026-02-11T15:30:44Z

PerikiyoXD:

{{DISPLAYTITLE:Patching The Games}}

Click on the game logo below to download the patch.

{| class="wikitable" style="text-align:left;"
! Game !! Hash (SHA256)
|-
| [[File:GTAIII_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta3.exe]] '''Grand Theft Auto III'''
| <code>17e036ff18cdd805951fec9107746492f582ae1eb46ca028544e37e517e8fc1f</code>
|-
| [[File:GTAVC_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta-vc.exe]] '''Grand Theft Auto: Vice City'''
| <code>04e4db72629eaa786fdd182ac224f4fd6d68806f5f4fe5c1fb5f756dc4da11d7</code>
|-
| [[File:GTASA_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta_sa.exe]] '''Grand Theft Auto: San Andreas'''
| <code>???</code>
|-
| [[File:GTAIV_Logo.png|32px|middle|link=DowngradingIV]] '''Grand Theft Auto IV'''
| <code>N/A</code>
|}

Downgrading

2026-02-11T15:20:14Z

PerikiyoXD: Use correct link for VC

{{DISPLAYTITLE:Patching The Games}}
Click on a game icon below to download the patch.
{|
|-
|style="padding: 10px"|[[Image:GTAIII_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta3.exe]]
|style="padding: 10px"|[[Image:GTAVC_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta-vc.exe]]
|style="padding: 10px"|[[Image:GTASA_Logo.png|32px|middle|link=https://wiki.gtaconnected.com/downloads/gta_sa.exe]]
|style="padding: 10px"|[[Image:GTAIV_Logo.png|32px|middle|link=DowngradingIV]]
|}

Module:ScriptItem

2022-07-03T17:00:27Z

PerikiyoXD: Inlined local varialbes into function calls

local p = {}

-- settings
p.categoryItems = {
-- Category Name = table. (Fully resolved item name(s), case-sensitive.) (Event names must start with a capital letter "O", to match the dumpdoc XML.)
['Audio'] = {'gta.addOneOffSound', 'gta.playFrontEndSound', 'gta.playSuspectLastSeen'},
['Camera'] = {'gta.fading'},
['Chatbox'] = {'message', 'messageClient', 'messageAllExcept', 'setChatWindowEnabled', 'OnChatOutput'},
['Cursor'] = {'gta.getMouseSpeed'},
['CustomText'] = {'gta.setCustomText', 'gta.setCustomText', 'gta.clearCustomText', 'gta.printBig'},
['Drawing'] = {'gta.drawRectangle'},
['Effect'] = {'gta.addParticleEffect', 'addParticleEffect', 'gta.addMovingParticleEffect', 'addMovingParticleEffect', 'gta.createSingleParticle', 'createSingleParticle'},
['Font'] = {'font.render'},
['GarbageCollection'] = {'collectAllGarbage'},
['Game'] = {'gta.game', 'gta.standardControls', 'gta.gameSpeed', 'gta.loadDFF', 'gta.loadTXD', 'gta.loadCOL'},
['GameStat'] = {'gta.setGameStat', 'gta.getGameStat'},
['GUI'] = {'OnGUIClick'},
['Key'] = {'isScancodePressed', 'OnCharacter'},
['KillFrenzy'] = {'gta.startKillFrenzy'},
['Message'] = {'gta.clearMessages', 'gta.smallMessage', 'gta.bigMessage', 'gta.pagerMessage'},
['Miscellaneous'] = {'platform', 'toColour', 'gta.tickCount', 'getRandomSkin', 'gta.getRandomSkin', 'gta.processLineOfSight', 'processLineOfSight', 'gta.setIsland', 'gta.setDefaultInteriors'},
['Network'] = {'isConnected', 'isConnecting', 'connect', 'disconnect', 'triggerNetworkEvent', 'OnDisconnect'},
['Path'] = {'gta.trafficDensity', 'gta.setTrafficEnabled', 'setTrafficEnabled', 'gta.setCiviliansEnabled', 'setCiviliansEnabled'},
['Ped'] = {'gta.tommyFatness'},
['Radio'] = {'gta.setRadioChannel', 'gta.forceRadioChannel'},
['Reflection'] = {'exportFunction', 'setErrorMode'},
['Renderware'] = {'gta.rwRenderStateSet'},
['SaveGame'] = {'gta.saveGame'},
['Screen'] = {'gta.aspectRatio', 'gta.width', 'gta.height'},
['Script'] = {'gta.terminateScript', 'gta.getActiveScripts', 'gta.scriptCommand'},
['Timer'] = {'setImmediate', 'clearImmediate', 'setInterval', 'clearInterval', 'setTimeout', 'clearTimeout'},
['Weather'] = {'snowing', 'forceSnowing'},
['Window'] = {'OnFocus', 'OnLostFocus'},
['World'] = {'gta.ssvBridgeEnabled', 'gta.planesEnabled', 'gta.trainsEnabled', 'setPlanesEnabled', 'setTrainsEnabled', 'world', 'gta.findGroundZForCoord', 'findGroundZForCoord', 'gta.setTrainsEnabled', 'gta.setPlanesEnabled'}
}

p.categoryWords = {
-- Category Names. (String(s) to look for in an item name, case-INsensitive.)
'Blip', 'Building', 'Camera', 'Chatbox', 'Cheat', 'Client', 'Command', 'Cursor', 'Debug', 'Dodo',
'Element', 'Entity', 'Event', 'File', 'Font', 'Garage', 'HTTP', 'HUD', 'Key', 'Mission', 'Mouse', 'Network', 'Object',
'Pause', 'Ped', 'Pickup', 'Player', 'Process', 'Render', 'Resource', 'Screen', 'Socket', 'Sphere', 'Time', 'Vehicle', 'Weather', 'World'
}

-- entry point
function p.main(frame)
local args = p.getArgs(frame)

if args.type == 'variable' then
return p.showVariablePage(frame)
elseif args.type == 'function' then
return p.showFunctionPage(frame)
elseif args.type == 'property' then
return p.showPropertyPage(frame)
elseif args.type == 'method' then
return p.showMethodPage(frame)
elseif args.type == 'event' then
return p.showEventPage(frame)
else
return "This page has been documented incorrectly, '''type''' is missing."
end
end

-- item page types
function p.showVariablePage(frame)
return p.showPage(frame, { "Value" })
end

function p.showFunctionPage(frame)
return p.showPage(frame, { "Parameters", "Return", "Callbacks" })
end

function p.showPropertyPage(frame)
return p.showPage(frame, { "Value" })
end

function p.showMethodPage(frame)
return p.showPage(frame, { "Parameters", "Return", "Callbacks" })
end

function p.showEventPage(frame)
return p.showPage(frame, { "Parameters", "Attributes" })
end

-- item page
function p.showPage(frame, parts)
local args = p.getArgs(frame)
if args.type ~= 'event' then
table.insert(parts, "Types")
end
--table.insert(parts, "Symbols")
local lines = p.getPageTopLines(frame)
for i,part in ipairs({"Notes", "Examples", "Compatibility", "Related"}) do
table.insert(parts, part)
end
for i,part in ipairs(parts) do
local data = p[part:lower() == 'return' and 'returns' or part:lower()](frame)
if data and #data > 0 then
if part == 'Settable' then
part = args.readonly == 'true' and 'Read-Only' or 'Read and Set'
end
table.insert(lines, '== '..part..' ==')
table.insert(lines, data)
end
end
return table.concat(lines, "\n")
end

function p.getPageTopLines(frame)
local lines = {}
table.insert(lines, frame:preprocess("{{DISPLAYTITLE:"..p.getDisplayedName(frame).."}}"))
table.insert(lines, "__NOTOC__"..p.getPageTopBoxes(frame).."\n")
table.insert(lines, "<div style='margin-top: 20px;'>Available since "..p.since(frame).."</div>\n")
table.insert(lines, "<div style='margin-top: 6px;'>\n"..p.syntax(frame).."</div>\n")
table.insert(lines, "<div style='margin-top: 20px;'>\n"..p.description(frame).."</div>\n")
return lines
end

function p.getPageTopBoxes(frame)
local args = p.getArgs(frame)

local topBoxes = { "type", "endpoint", "games", "online" }
if args.type == 'variable' or args.type == 'property' then
table.insert(topBoxes, "settable")
elseif args.type == 'event' then
table.insert(topBoxes, "cancellable")
end

local outBoxes = {}
for i,topBox in ipairs(topBoxes) do
table.insert(outBoxes, p[topBox.."Box"](frame))
end
return table.concat(outBoxes, ' ').."<br>"
end

-- template arguments
function p.getArgs(frame)
if p.argsCache then
return p.argsCache
else
local args = frame:getParent().args
p.copyOldToNewForTemplateArguments(frame, args)
p.copyNonIndexedToIndexedTemplateArguments(frame, args)
p.populateTypeSpecificTemplateArguments(frame, args)
p.populateDefaultTemplateArguments(frame, args)
p.argsCache = args
return args
end
end

function p.copyOldToNewForTemplateArguments(frame, args)
if args.parameters then
args.syntax = args.parameters
end
if args.parametersSS then
args.syntaxSS = args.parametersSS
end
if args.parametersCS then
args.syntaxCS = args.parametersCS
end

if args.callbackParameters then
args.callbackSyntax = args.callbackParameters
end
if args.callbackParametersSS then
args.callbackSyntaxSS = args.callbackParametersSS
end
if args.callbackParametersCS then
args.callbackSyntaxCS = args.callbackParametersCS
end

if args.type == 'event' then
if args.callbackParameters then
args.syntax = args.callbackParameters
end
if args.callbackParametersSS then
args.syntaxSS = args.callbackParametersSS
end
if args.callbackParametersCS then
args.syntaxCS = args.callbackParametersCS
end
end

if args.returnType or args.returnTypes then
local returnType = args.returnType and args.returnType or args.returnTypes
if args.returnInfo then
args.return1 = returnType.." "..args.returnInfo
args.value = returnType.." "..args.returnInfo
else
args.return1 = returnType
args.value = returnType
end
end

if args.usage then
args.description = args.usage
end

if args.notes then
local notes = p.splitLines(args.notes)
for i,note in ipairs(notes) do
args['note'..i] = note
end
end

local exampleKeys = {
'example', 'exampleSS', 'exampleCS', 'exampleJS', 'exampleLua', 'exampleSquirrel',
'exampleJSSS', 'exampleJSCS', 'exampleLuaSS', 'exampleLuaCS', 'exampleSquirrelSS', 'exampleSquirrelCS'
}
for i,exampleKey in ipairs(exampleKeys) do
if args[exampleKey] then
local examples = p.split(args[exampleKey], '<br>')
for i,example in ipairs(examples) do
args[exampleKey..i] = example
end
end
end

if args.bcName and args.bcMaxVersion then
args.previous1 = args.bcName.." "..args.bcMaxVersion
end
end

function p.copyNonIndexedToIndexedTemplateArguments(frame, args)
if args.description then
args.description1 = args.description
end
end

function p.populateTypeSpecificTemplateArguments(frame, args)
if args.type == 'variable' or args.type == 'property' then
if args.value then
local tokens = p.split(args.value, ' ')
local type = tokens[1]

local name
if args.type == 'property' then
name = args.class.."."..args.name
else
name = args.name
end

args.syntax = type.." "..name
end
end
end

function p.populateDefaultTemplateArguments(frame, args)
if not args.since then
args.since = "1.0.0 1.0.0"
end

if args.syntax and args.syntax:lower() == "void" then
args.parameter1 = "void"
end
end

-- item top boxes
function p.typeBox(frame)
local args = p.getArgs(frame)
local typeText = p.getType(args.type)
return p.loadTemplate(frame, 'GreenInformationBox', {typeText,id='type'});
end

function p.endpointBox(frame)
local args = p.getArgs(frame)
local endpointText, isShared = p.getEndpoint(args.endpoint)
if isShared then
return p.loadTemplate(frame, 'GreenInformationBox', {endpointText,id='endpoint'});
else
return p.loadTemplate(frame, 'RedInformationBox', {endpointText,id='endpoint'});
end
end

function p.gamesBox(frame)
local args = p.getArgs(frame)
local gamesText = p.getGames(args.games)
if gamesText == "All Games" then
return p.loadTemplate(frame, 'GreenInformationBox', {table.concat({
p.loadTemplate(frame, 'icon-iii'),
p.loadTemplate(frame, 'icon-vc'),
p.loadTemplate(frame, 'icon-sa'),
p.loadTemplate(frame, 'icon-iv')
}, ' '), id='games'})
else
local games = { 'iii', 'vc', 'sa', 'iv' }
local out = {}
for i,game in ipairs(games) do
if gamesText:lower():find(game) then
table.insert(out, p.loadTemplate(frame, 'icon-'..game, {}))
end
end
return p.loadTemplate(frame, 'RedInformationBox', {table.concat(out, ' '), id='games'})
end
end

function p.onlineBox(frame)
local args = p.getArgs(frame)
if args.sp == 'true' or args.online == 'false' then
return p.loadTemplate(frame, 'RedInformationBox', {'Offline Only',id='online'});
elseif args.sp == 'false' or args.offline == 'false' then
return p.loadTemplate(frame, 'RedInformationBox', {'Online Only',id='online'});
else
return p.loadTemplate(frame, 'GreenInformationBox', {'Online and Offline',id='online'});
end
end

function p.settableBox(frame)
local args = p.getArgs(frame)
if args.readonly == 'true' then
return p.loadTemplate(frame, 'RedInformationBox', {'Read-Only',id='settable'});
else
return p.loadTemplate(frame, 'GreenInformationBox', {'Read and Set',id='settable'});
end
end

function p.cancellableBox(frame)
local args = p.getArgs(frame)
if p.isCancellable(frame)then
return p.loadTemplate(frame, 'GreenInformationBox', {'Cancellable',id='cancellable'});
else
return p.loadTemplate(frame, 'RedInformationBox', {'Not Cancellable',id='cancellable'});
end
end

-- item parts
function p.since(frame)
local args = p.getArgs(frame)
if not args.since then
return p.documentationMissing(frame, "Available since")
else
local endpointVersions = p.getEndpointVersions(args.since, args.endpoint)
if #endpointVersions == 2 then
return "'''Server "..endpointVersions[1].."''', '''Client "..endpointVersions[2].."'''"
else
if args.endpoint == 'server' then
return "'''Server "..endpointVersions[1].."'''"
elseif args.endpoint == 'client' then
return "'''Client "..endpointVersions[1].."'''"
else
return p.documentationMissing(frame, "Available since (Both server and client version is needed for shared items)")
end
end
end
end

function p.syntax(frame)
local args = p.getArgs(frame)

if args.syntax then
return p.loadTemplate(frame, 'CodeSyntax', {p.buildSyntax(frame, args.syntax),id='syntax'})
end

if args.syntaxSS and args.syntaxCS then
local rows = {}
rows[1] = { "'''Server:'''", p.loadTemplate(frame, 'CodeSyntax', {p.buildSyntax(frame, args.syntaxSS),id='syntaxss'}) }
rows[2] = { "'''Client:'''", p.loadTemplate(frame, 'CodeSyntax', {p.buildSyntax(frame, args.syntaxCS),id='syntaxcs'}) }
return p.table(false, rows, { 100 }, false)
end

return p.documentationMissing(frame, "Syntax")
end

function p.description(frame)
local args = p.getArgs(frame)
local entries = p.getIndexedArgs(frame, 'description')

local startTextFirstLine = "The <span style=\"font-family: 'Source Code Pro', monospace;\">"..p.getDisplayedNameColoured(frame).."</span> [[HowTo/Functions|"..args.type.."]] is "..(args.type == "event" and "invoked when" or "used to").." "

for i,entry in ipairs(entries) do
if i == 1 then
entry = startTextFirstLine..entry
end

entries[i] = p.formatDescription(entry)
end
return table.concat(entries, '<br>')
end

function p.parameters(frame)
local args = p.getArgs(frame)
local entries = p.getIndexedArgs(frame, 'parameter')
local rows = {}
local isEvent = args.type == 'event'

if isEvent and args.syntax and args.syntax:lower() == 'event event' then
elseif #entries == 0 then
return p.documentationMissing(frame, "Parameters")
elseif entries[1] == "void" then
local headers = nil
local rows = { { p.formatType("void", frame), "This "..args.type.." doesn't take any parameters." } }
local widths = { 120, 400 }
return p.table(headers, rows, widths, 'wikitable-returns wikitable')
else
for i,arg in ipairs(entries) do
local tokens = p.split(arg, ' ')

local isOptional = tokens[3] == 'optional'
local defaultValue = isOptional and "<span style='font-family: \"Source Code Pro\", monospace;'>"..tokens[4].."</span>" or "n/a"
local description = p.formatDescription(table.concat(tokens, ' ', isOptional and 5 or 3))

if isEvent then
rows[i] = { (i + 1)..") ", p.formatType(tokens[1], frame), p.formatName(tokens[2], frame), description }
else
rows[i] = { i..") ", p.formatType(tokens[1], frame), p.formatName(tokens[2], frame), (isOptional and ("Optional, defaults to "..defaultValue..". ") or "")..description }
end
end
end

if isEvent then
table.insert(rows, 1, { "1) ", p.formatType("Event", frame), p.formatName("event", frame), "The event object for this event." })
end

local headers, widths
if isEvent then
headers = nil--{ "Type", "Name", "Description" }
widths = { 30, 80, 110, 400 }
else
headers = nil--{ "Type", "Name", "Presence", "Default Value", "Description" }
widths = { 30, 80, 110, 400 }
end
return p.table(headers, rows, widths, 'wikitable-parameters wikitable')
end

function p.returns(frame)
local args = p.getArgs(frame)
local text = ""
local entries
local rows
local headers
local widths
local isVoidReturn = false

rows = {}
entries = p.getIndexedArgs(frame, 'return')
if #entries == 0 then
text = text..p.documentationMissing(frame, "Returns").."<br><br>"
else
for i,arg in ipairs(entries) do
local tokens = p.split(arg, ' ')

local type = tokens[1]
type = p.standardizeNullType(type)

local description
if type:lower() == "void" then
isVoidReturn = true
description = "This "..args.type.." doesn't return a value."
elseif tokens[2] then
description = p.formatDescription(table.concat(tokens, ' ', 2))
else
description = p.documentationMissing(frame, "Description for return value")
end

rows[i] = { p.formatType(tokens[1], frame), description }
end
headers = nil-- { "Type", "Description" }
widths = { 120, 400 }
text = text..p.table(headers, rows, widths, 'wikitable-returns wikitable')
end

--[[
-- commented out as failure returns are not currently implemented in GTAC.
if not isVoidReturn then
rows = {}
entries = p.getIndexedArgs(frame, 'returnFail')
text = text.."'''Failure Return:'''\n\n"
if #entries == 0 then
text = text..p.documentationMissing(frame, "Failure returns")
else
for i,arg in ipairs(entries) do
local tokens = p.split(arg, ' ')

local type = tokens[1]
type = p.standardizeNullType(type)

local value
if type:lower() == 'void' then
value = "n/a"
elseif tokens[2] then
value = p.formatSource(table.concat(tokens, ' ', 2), frame)
else
value = p.formatSource(p.documentationMissing(frame, "Description for failure return value"), frame)
end

rows[i] = { p.formatType(tokens[1], frame), value }
end
headers = nil--{ "Type", "Value" }
widths = { 120, 400 }
text = text..p.table(headers, rows, widths, 'wikitable-returns wikitable')
end
end
]]

return text
end

function p.callbacks(frame)
local args = p.getArgs(frame)

local suffixes = {
{ '', '' },
{ 'SS', 'Server-Side Callbacks' },
{ 'CS', 'Client-Side Callbacks' }
}

local html = {}

for i3,suffixData in ipairs(suffixes) do
local suffix = suffixData[1]

local parameters = p.getIndexedArgs(frame, 'parameter')
for i=1, #parameters do
local callbackSyntax = args['callback'..i..'Syntax'..suffix]
local callbackText = args['callback'..i..'Text'..suffix]
local callbackNParameters = p.getIndexedArgs(frame, 'callback'..i..'Parameter'..suffix)

if #callbackNParameters > 0 then
if suffixData[1] ~= '' then
table.insert(html, "'''"..suffixData[2].."'''")
end

local parameterTokens = p.split(parameters[i], ' ')
local rows = {}

if #parameterTokens > 0 then
local syntaxLine = parameterTokens[1]..' '..parameterTokens[2]..'('..callbackSyntax..')'
syntaxLine = p.loadTemplate(frame, 'CodeSyntax', {syntaxLine})
table.insert(html, syntaxLine)
end

if callbackText and #callbackText > 0 then
table.insert(html, callbackText)
end

for i2,callbackNParameter in ipairs(callbackNParameters) do
local callbackTokens = p.split(callbackNParameter, ' ')

local parameterType = callbackTokens[1]
local parameterName = callbackTokens[2]
local description = p.formatDescription(table.concat(callbackTokens, ' ', 3))

rows[i2] = { i2..') ', p.formatType(parameterType, frame), p.formatName(parameterName, frame), description }
end

local headers, widths
headers = nil--{ "Type", "Name", "Description" }
widths = { 30, 80, 110, 400 }
local table2 = "\n"..p.table(headers, rows, widths, 'wikitable-callback wikitable')
table.insert(html, table2)

if i ~= #parameters then
table.insert(html, "<br>")
end
end
end
end

if args.callbackSyntax then
table.concat(html, p.loadTemplate(frame, 'CodeSyntax', {p.buildSyntax(frame, args.callbackSyntax, true),id='callbacks'}))
end

if args.callbackSyntaxSS and args.callbackSyntaxCS then
local rows = {}
rows[1] = { "'''Server:'''", p.loadTemplate(frame, 'CodeSyntax', {p.buildSyntax(frame, args.callbackSyntaxSS, true),id='callbacks'}) }
rows[2] = { "'''Client:'''", p.loadTemplate(frame, 'CodeSyntax', {p.buildSyntax(frame, args.callbackSyntaxCS, true),id='callbacks'}) }
table.concat(html, p.table(false, rows, { 100 }, false, 'wikitable-callback wikitable'))
end

return #html > 0 and table.concat(html, '') or false
end

function p.attributes(frame)
local args = p.getArgs(frame)
local headers = nil--{ "Type", "Description" }
local rows = {}
if p.isCancellable(frame) then
rows[1] = { 'cancellable', 'This '..args.type..' can be cancelled, by using [[event.preventDefault|event.preventDefault]].' }
else
rows[1] = { p.formatType('const', frame), 'This '..args.type..' cannot be cancelled.' }
end
local widths = { 120, 400 }
return p.table(headers, rows, widths, 'wikitable-returns wikitable')
end

function p.value(frame)
local args = p.getArgs(frame)

if not args.value then
return p.documentationMissing(frame, "Value type and description")
end

local arg = args.value
local tokens = p.split(arg, ' ')
local description = p.formatDescription(table.concat(tokens, ' ', 2))

local headers = nil--{ "Type", "Description" }
local rows = {}
rows[1] = { p.formatType(tokens[1], frame), description }
if args.readonly == 'true' then
rows[2] = { p.formatType('readonly', frame), 'This '..args.type..' cannot be changed.' }
else
rows[2] = { 'read/set', 'This '..args.type..' can be changed, as well as read.' }
end
local widths = { 120, 400 }
return p.table(headers, rows, widths, 'wikitable-returns wikitable')
end

function p.settable(frame)
local args = p.getArgs(frame)

if args.readonly == 'true' then
return "This "..args.type.." is read-only."
else
return "This "..args.type.." can be read and set."
end
end

function p.types(frame)
local args = p.getArgs(frame)
return p.getTypesText(frame, args.class)
end

function p.symbols(frame)
local args = p.getArgs(frame)
return p.getSymbolsText(frame, args.class)
end

function p.notes(frame)
local args = p.getArgs(frame)
local entries = p.getIndexedArgs(frame, 'note')
if #entries == 0 then
return "There aren't any notes for this "..args.type.."."
end
for i,entry in ipairs(entries) do
entries[i] = p.dot(entry)
end
return "* "..table.concat(entries, "\n* ")
end

function p.examples(frame)
local args = p.getArgs(frame)

local data = {
{ "example", "" },

{ "exampleSS", "Server-Side" },
{ "exampleCS", "Client-Side" },

{ "exampleJS", "JavaScript" },
{ "exampleLua", "Lua" },
{ "exampleSquirrel", "Squirrel" },

{ "exampleJSSS", "JavaScript - Server-Side" },
{ "exampleJSCS", "JavaScript - Client-Side" },

{ "exampleLuaSS", "Lua - Server-Side" },
{ "exampleLuaCS", "Lua - Client-Side" },

{ "exampleSquirrelSS", "Squirrel - Server-Side" },
{ "exampleSquirrelCS", "Squirrel - Client-Side" }
}

local examples = {}
local exampleIndex = 1
for i,data2 in ipairs(data) do
local entries = p.getIndexedArgs(frame, data2[1])
for i2, entry in ipairs(entries) do
local entry = "'''Example "..exampleIndex.." - "..data2[2]..":'''<br>"..p.loadTemplate(frame, 'CodeSyntax', {entry,id='example_'..exampleIndex})
table.insert(examples, entry)
exampleIndex = exampleIndex + 1
end
end

if #examples == 0 then
return "There aren't any examples for this "..args.type.."."
end
return table.concat(examples, "<br>")
end

function p.compatibility(frame)
local args = p.getArgs(frame)
local entries1 = p.getIndexedArgs(frame, 'previous')
local entries2 = p.getIndexedArgs(frame, 'compat')
if #entries1 == 0 and #entries2 == 0 then
return "There isn't any compatibility information for this "..args.type.."."
else
local entriesOut = {}
for i,arg in ipairs(entries1) do
local versionsText, tokens = p.getVersionsText(arg, args.endpoint, 2)
entriesOut[i] = "This "..args.type.." was previously named <code>"..tokens[1].."</code> in "..versionsText.."."
end
local offset = #entriesOut
for i,arg in ipairs(entries2) do
entriesOut[i + offset] = p.dot(arg)
end
return "* "..table.concat(entriesOut, "\n* ")
end
end

function p.related(frame)
local args = p.getArgs(frame)
local categoryTitle = p.getItemCategory(frame)
if categoryTitle and categoryTitle:len() > 0 then
local shared = args.endpoint:lower() == 'shared'
local server = args.endpoint:lower() == 'shared' or args.endpoint:lower() == 'server'
local client = args.endpoint:lower() == 'shared' or args.endpoint:lower() == 'client'
local pageName = args.type:lower() == 'event' and 'Event' or 'Function'

local parts = {}

local name
if args.type == 'property' then
name = args.class.."."..args.name
else
name = args.name
end

if server then
local title = 'Server/'..pageName..'s/'..categoryTitle
local t = p.loadTemplate(frame, title, args)

--t = p.remove(t, "[["..name.."|"..name.."]]<br>\n")

--[[
t = p.replace(t, " ", " ");
t = p.remove(t, "\t");
t = p.remove(t, "\r");
t = p.remove(t, "\n");
t = p.remove(t, "<a class=\"mw-selflink selflink\">"..name.."</a><br />")
]]

table.insert(parts, "'''Server Related'''<br><br>"..t)
end

if client then
local title = 'Client/'..pageName..'s/'..categoryTitle
local t = p.loadTemplate(frame, title, args)

--t = p.remove(t, "[["..name.."|"..name.."]]<br>\n")

--[[
t = p.replace(t, " ", " ");
t = p.remove(t, "\t");
t = p.remove(t, "\r");
t = p.remove(t, "\n");
t = p.remove(t, "<a class=\"mw-selflink selflink\">"..name.."</a><br />")
]]

table.insert(parts, "'''Client Related'''<br><br>"..t)
end

return table.concat(parts, '<br><br>')
else
return ''
end
end

-- item category
function p.getItemCategory(frame)
local args = p.getArgs(frame)
local resolvedNameLower = p.getDisplayedName(frame):lower()

for categoryTitle,categoryData in pairs(p.categoryItems) do
for i2,resolvedItemName in ipairs(categoryData) do
if resolvedNameLower == resolvedItemName:lower() then
return categoryTitle
end
end
end

for i,categoryTitle in ipairs(p.categoryWords) do
if resolvedNameLower:find(categoryTitle:lower(), 1, true) then
return categoryTitle
end
end

return false
end

-- item part utility
function p.getType(text)
local finds = { "variable", "function", "property", "method", "event", "define" }
local replaces = { "Variable", "Function", "Property", "Method", "Event", "Define" }
local defaults = {}
return p.findText(text, finds, replaces, defaults, "'''undocumented type'''")
end

function p.getGames(text)
local finds = { "iii", "vc", "sa", "iv", "ug" }
local replaces = { "GTA III", "GTA VC", "GTA SA", "GTA IV", "GTA UG" }
local defaults = { "all", "all games" }
return p.findText(text, finds, replaces, defaults, "All Games")
end

function p.getEndpoint(text)
local finds = { "shared", "server", "client" }
local replaces = { "Server and Client", "Server Only", "Client Only" }
local defaults = {}
local result = p.findText(text, finds, replaces, defaults, "'''undocumented endpoint'''")
local isShared = result == replaces[1]
return result, isShared
end

function p.getDisplayedName(frame)
local args = p.getArgs(frame)
if p.isOOP(frame) then
return args.class:lower().."."..args.name
else
return args.name
end
end

function p.getTypeRgb()
return '#009106'
end

function p.getNameRgb()
return '#0645ad'
end

function p.getDisplayedNameColoured(frame)
local typeRgb = p.getTypeRgb()
local nameRgb = p.getNameRgb()
local args = p.getArgs(frame)
if p.isOOP(frame) then
return "<span style='color:"..typeRgb..";'>"..args.class:lower().."</span>.<span style='color:"..nameRgb.."';>"..args.name.."</span>"
else
return "<span style='color:"..nameRgb.."';>"..args.name.."</span>"
end
end

function p.getSuccessReturnTypes(frame)
local entries = p.getIndexedArgs(frame, 'return')
if #entries == 0 then
return "unknown"
end
for i,entry in ipairs(entries) do
local tokens = p.split(entry, ' ')
entries[i] = tokens[1]
end
return table.concat(entries, ", ")
end

function p.isOOP(frame)
local args = p.getArgs(frame)
return args.type == "property" or args.type == "method"
end

function p.warning(frame, text)
return p.loadTemplate(frame, 'BlueInformationBox', {text})..'\n'
end

function p.documentationMissing(frame, text)
return p.warning(frame, "Documentation Missing: "..text)
end

function p.buildSyntax(frame, parameters, isCallback)
if isCallback == nil then
isCallback = false;
end
local args = p.getArgs(frame)
if not isCallback and (args.type == 'variable' or args.type == 'property') then
return p.getSuccessReturnTypes(frame).." "..p.getDisplayedName(frame)
elseif isCallback or args.type == 'event' then
return "function("..parameters..")"
else
return p.getSuccessReturnTypes(frame).." "..p.getDisplayedName(frame).."("..parameters..")"
end
end

function p.getTypesText(frame, baseType)
local args = p.getArgs(frame)

local derivedTypes = {
ped = {'Player'},
physical = {'Object', 'Ped', 'Vehicle', 'Player'},
entity = {'Building', 'Physical', 'Object', 'Ped', 'Vehicle', 'Player'},
element = {'Blip', 'Entity', 'Marker', 'Building', 'Physical', 'Object', 'Ped', 'Vehicle', 'Player'},
vehicle = {'Train'},
event = {'CancellableEvent', 'KeyEvent'},
surface = {'RenderTarget', 'Texture'}
}

local serverTypes = {}
local sharedTypes = {
'Building', 'Client', 'Effect', 'Event', 'Timer', 'ReflectedFunction', 'Resource', 'Stream', 'Vec2', 'Vec3', 'Matrix4x4',
'Element', 'Blip', 'Pickup', 'Entity', 'Physical','Vehicle', 'Train', 'XmlDocument', 'XmlElement',
'CancellableEvent', 'KeyEvent', 'Marker', 'Object', 'Ped', 'Player'
}

local out = {}

local getTypeSide = function(type)
for i2,type2 in ipairs(serverTypes) do
if type:lower() == type2:lower() then
return 'server'
end
end

for i2,type2 in ipairs(sharedTypes) do
if type:lower() == type2:lower() then
return 'shared'
end
end

return 'client'
end

if baseType then
local baseTypeLower = baseType:lower()
local allTypes
if derivedTypes[baseTypeLower] then
allTypes = p.copyTable(derivedTypes[baseTypeLower])
table.insert(allTypes, 1, baseType)
else
allTypes = { baseType }
end
local types = {}
for i,type in ipairs(allTypes) do
types[i] = type
end
p.sortTable(types)
for i,type in ipairs(types) do
types[i] = p.loadTemplate(frame, 'Side', {[getTypeSide(type)]='1'}).." ".."<span style=\"font-family: 'Source Code Pro', monospace;\">"..type.."</span>"
end
--table.insert(out, "<div style='margin-top: 20px;'></div>")
table.insert(out, "\n"..table.concat(types, "<br>"))
end

return table.concat(out, "")
end

function p.getSymbolsText(frame, baseType)
local args = p.getArgs(frame)

local out = {}

local rows = {}

if args.type == 'function' or args.type == 'variable' then
local parts = p.split(p.getDisplayedName(frame), ".")
for i=1,(#parts)-1,1 do
rows[i] = {}
rows[i][1] = "<span style=\"font-family: 'Source Code Pro', monospace; color: "..p.getNameRgb()..";\">"..parts[i].."</span>"
rows[i][2] = 'Namespace'
rows[i][3] = i == 1 and 'Global' or 'Namespace: '..parts[i-1]
rows[i][4] = i == 1 and parts[i]..' is a namespace, which exists in the global namespace.' or parts[i]..' is a namespace, which exists in the '..parts[i-1]..' namespace.'
end
rows[#parts] = {}
rows[#parts][1] = "<span style=\"font-family: 'Source Code Pro', monospace; color: "..p.getNameRgb()..";\">"..parts[#parts].."</span>"
rows[#parts][2] = p.properCase(args.type)
rows[#parts][3] = #parts == 1 and 'Global' or 'Namespace: '..parts[#parts-1]
rows[#parts][4] = #parts == 1 and parts[1]..' is a '..p.properCase(args.type)..', which exists in the global namespace.' or parts[#parts]..' is a '..p.properCase(args.type)..', which exists in the '..parts[#parts-1]..' namespace.'
elseif args.type == 'method' or args.type == 'property' then
local parts = p.split(p.getDisplayedName(frame), ".")
rows[1] = {}
rows[1][1] = "<span style=\"font-family: 'Source Code Pro', monospace; color: "..p.getNameRgb()..";\">"..parts[1].."</span>"
rows[1][2] = 'Object'
rows[1][3] = 'n/a'
rows[1][4] = "<span style=\"font-family: 'Source Code Pro', monospace; color: "..p.getNameRgb()..";\">"..parts[1].."</span>"..' is an object.'

rows[2] = {}
rows[2][1] = "<span style=\"font-family: 'Source Code Pro', monospace; color: "..p.getNameRgb()..";\">"..parts[2].."</span>"
rows[2][2] = p.properCase(args.type)
rows[2][3] = #parts == 1 and 'Global' or 'Namespace: '..parts[#parts-1]
rows[2][4] = "<span style=\"font-family: 'Source Code Pro', monospace; color: "..p.getNameRgb()..";\">"..parts[2].."</span>"..' is a '..p.properCase(args.type)..', which is used on objects of type '..parts[1]
elseif args.type == 'event' then
rows[1] = {}
rows[1][1] = "<span style=\"font-family: 'Source Code Pro', monospace; color: "..p.getNameRgb()..";\">"..p.getDisplayedName(frame).."</span>"
rows[1][2] = 'String'
rows[1][3] = 'n/a'
rows[1][4] = 'Events are referenced by name. Event names use data type String.'
end

--table.insert(out, "<div style='margin-top: 20px;'></div>")
local headers = { 'Symbol Name', 'Symbol Type', 'Container', 'Description' }
table.insert(out, "\n"..p.table(headers, rows, { 120, 120, 400 }, false))

if args.type ~= 'event' then
local languages = { 'JS', 'Lua', 'Squirrel' }
local languageSymbols = {
['JS'] = { ['function'] = 'dot', ['variable'] = 'dot', ['method'] = 'dot', ['property'] = 'dot' },
['Lua'] = { ['function'] = 'dot', ['variable'] = 'dot', ['method'] = 'colon', ['property'] = 'dot' },
['Squirrel'] = { ['function'] = 'dot', ['variable'] = 'dot', ['method'] = 'dot', ['property'] = 'dot' }
}
for i,language in ipairs(languages) do
local line
if args.type == 'function' then
line = language..' uses the '..languageSymbols[language][args.type]..' symbol to call a function.'
elseif args.type == 'variable' then
line = language..' uses the '..languageSymbols[language][args.type]..' symbol to get or set a variable.'
elseif args.type == 'method' then
line = language..' uses the '..languageSymbols[language][args.type]..' symbol to call a method.'
elseif args.type == 'property' then
line = language..' uses the '..languageSymbols[language][args.type]..' symbol to get or set a property.'
end
table.insert(out, "<br>"..line)
end
end

return table.concat(out, "")
end

function p.isCancellable(frame)
local args = p.getArgs(frame)
return (args.cancellable and args.cancellable == 'true') or (args.cancelable and args.cancelable == 'true')
end

function p.formatType(type, frame)
return "<span style='font-family: \"Source Code Pro\", monospace; color: "..p.getTypeRgb()..";\"'>"..type.."</span>"
end

function p.formatName(name, frame)
return "<span style='font-family: \"Source Code Pro\", monospace; color: "..p.getNameRgb()..";\"'>"..name.."</span>"
end

function p.formatSource(type, frame)
return frame:preprocess('<source>'..type..'</source>')
end

function p.formatCode(code)
return "<code>"..code.."</code>"
end

function p.formatDescription(description)
description = p.capital(description)
description = p.dot(description)
return description
end

function p.standardizeNullType(type)
type = type:lower()
if type == 'void' or type == 'null' or type == 'undefined' or type == 'n/a' then
return 'void'
else
return type
end
end

-- general utility
function p.split(str, sep, limit)
if not sep or sep == "" then
return false
end
if not str then
return false
end
limit = limit or math.huge
if limit == 0 or limit == 1 then
return {str}, 1
end

local r = {}
local n, init = 0, 1

while true do
local s,e = str:find(sep, init, true)
if not s then
break
end
r[#r+1] = str:sub(init, s - 1)
init = e + 1
n = n + 1
if n == limit - 1 then
break
end
end

if init <= str:len() then
r[#r+1] = str:sub(init)
else
r[#r+1] = ""
end
n = n + 1

if limit < 0 then
for i=n, n + limit + 1, -1 do r[i] = nil end
n = n + limit
end

return r, n
end

function p.splitLines(text)
text = p.remove(text, "\n")
text = p.remove(text, "\r")
return p.split(text, "<br>")
end

function p.remove(text, remove)
return p.replace(text, remove, "")
end

function p.replace(text, find, replace)
return text:gsub(find, replace)
end

function p.getIndexedArgs(frame, name)
local args = p.getArgs(frame)
local i = 1
local out = {}
while args[name..i] do
out[i] = args[name..i]
i = i + 1
end
return out
end

function p.loadTemplate(frame, title, args)
return frame:expandTemplate{ title = title, args = args }
end

function p.getEndpointVersions(arg, endpoint, start)
if not start then start = 1 end
local tokens = p.split(arg, ' ')
local endpointVersions = {}
if endpoint == 'shared' then
if tokens[start+1] then
endpointVersions[1] = tokens[start]
endpointVersions[2] = tokens[start+1]
else
endpointVersions[1] = tokens[start]
end
elseif endpoint == 'server' then
endpointVersions[1] = tokens[start]
elseif endpoint == 'client' then
endpointVersions[1] = tokens[start]
end
return endpointVersions, tokens
end

function p.getVersionsText(arg, endpoint, start)
if not start then start = 1 end
local tokens = p.split(arg, ' ')
local text
if endpoint == 'shared' then
if tokens[start+1] then
text = "server version "..tokens[start].." and client version "..tokens[start+1]
else
text = "version "..tokens[start]
end
elseif endpoint == 'server' then
text = "server version "..tokens[start]
elseif endpoint == 'client' then
text = "client version "..tokens[start]
end
return text, tokens
end

function p.properCase(text)
return text:sub(1,1):upper()..text:sub(2):lower()
end

function p.findText(text, finds, replaces, defaults, default)
if not text then return default end
local textLower = text:lower()

for i,default2 in ipairs(defaults) do
if textLower == default2 then
return default
end
end

local items = {}
for i,find in ipairs(finds) do
if textLower:find(find, 1, true) then
table.insert(items, replaces[i])
end
end
return p.getListText(items)
end

function p.getListText(items)
local count = #items

if count == 1 then
return items[1]
elseif count == 2 then
return items[1].." and "..items[2]
else
return table.concat(items, ", ", 1, count - 1).." and "..items[count]
end
end

function p.dot(text)
local i = #text
while i > 0 and text:sub(i, i) == "." do
i = i - 1
end
return text:sub(1,i).."."
end

function p.capital(text)
return text:sub(1,1):upper()..text:sub(2)
end

function p.copyTable(t)
local out = {}
for k,v in pairs(t) do
out[k] = v
end
return out
end

function p.sortTable(t)
table.sort(t, function(a,b)
return a:lower() < b:lower()
end)
end

function p.table(headers, rows, widths, tableCssClass)
if tableCssClass == nil then tableCssClass = 'wikitable' end
rows = p.copyTable(rows)
if not widths then widths = {} end

if headers then
headers = p.copyTable(headers)

for i,header in ipairs(headers) do
local width = widths[i]
if width and width > 0 then
headers[i] = "id='th_"..i.."' style='text-align:left;"..(i==#headers and 'min-width' or 'width')..":"..width.."px;'| "..header
end
end
else
for i,cell in ipairs(rows[1]) do
local width = widths[i]
if width and width > 0 then
rows[1][i] = "id='td_"..i.."' style='text-align:left;"..(i==#rows[1] and 'min-width' or 'width')..":"..width.."px;'| "..cell
end
end
end

for i,row in ipairs(rows) do
rows[i] = '|'..table.concat(row, '\n|')
end

return '{|'..(tableCssClass and ' class="'..tableCssClass..'"' or '')..(headers and " id='headers' " and '\n!'..table.concat(headers, '\n!')..'\n|-' or '')..'\n'..table.concat(rows, '\n|-\n')..'\n|}'
end

-- return the module
return p

Template:ScriptingEntry

2022-07-03T16:45:29Z

PerikiyoXD:

<code style="border:1px solid black;background-color:rgb(200,200,200);padding:5px;">Type: {{{entryType}}}</code>
<code style="border:1px solid black;background-color:rgb(200,200,200);padding:5px;">Side: {{{entrySide}}}</code>
<code style="border:1px solid black;background-color:rgb(200,200,200);padding:5px;">Game: {{{entryGame}}}</code>
<hr>
== Signature ==
<code style="border:1px solid black;background-color:rgb(255,255,255);padding:5px;">{{{returnType}}} {{{name}}}({{{parameters}}})</code>

== Details ==
{{{name}}} is a {{{entryType}}}

== Value ==

Template:ScriptingEntry

2022-07-03T16:13:35Z

PerikiyoXD: Created page with "<code>Type: {{{type}}}</code> <code>Side: {{{side}}}</code> <code>Game: {{{game}}}</code>"

TestEntry

2022-07-03T16:10:07Z

PerikiyoXD: Created page with "Test! {{ScriptingEntry |side = client |type = property |class = Physical |name = turnVelocity |readonly = false |returnTypes = Vec3 |usage = fetch or set the turn velocity fo..."

Test!

{{ScriptingEntry
|side = client
|type = property
|class = Physical
|name = turnVelocity
|readonly = false
|returnTypes = Vec3
|usage = fetch or set the turn velocity for an item
|returnInfo = the item's turn velocity
}}

sound.position

2022-06-21T04:47:46Z

PerikiyoXD: Upcoming updates

{{ScriptItem
|endpoint = client
|type = property
|class = Sound
|name = position
|readonly = false
|returnTypes = float
|usage = fetch or set the current position (in seconds) for the sound
|returnInfo = a float representing the current position of the sound in seconds
|since=1.0.72
}}

= Upcoming Updates =
== 1.4.3 ==
* position now can be set

DowngradingIV

2022-06-20T20:35:53Z

PerikiyoXD:

{{DISPLAYTITLE:Downgrading GTA IV to work on GTA Connected}}
==Instructions==
* Use the tool on [https://support.steampowered.com/kb_article.php?ref=2037-QEUH-3335 Steam] or [https://support.rockstargames.com/articles/360036000713/How-to-verify-game-files-in-the-Rockstar-Games-Launcher Rockstar Games Launcher] to verify integrity of game files so they get converted back to their original state.
* Then, download the patch for either [https://www.dropbox.com/s/7mvbvayak0g67sw/Retail-1080.zip?dl=1 1.0.8.0] or [https://www.dropbox.com/s/50b5k6lcu3lj296/Retail-1070.zip?dl=1 1.0.7.0], depending on which version you want to use.
* Unzip it. it should make a folder called <code>Retail</code>.
* Drag the Retail folder into your GTA IV game directory. ''Don't move the files out of the folder!'' Just move the whole folder itself.
* Open GTA Connected launcher and select ''Tools'' > ''Game Settings'' and choose GTA IV from the game select dropdown.
* Use the Browse button to set the path for the exe to ''GTAIV.exe'' inside the new Retail folder in your IV install directory.
* Launch the game and enjoy!

==Note==
* If you've followed those instructions correctly, the original files should be intact and unmodified. This means Steam/Rockstar launcher won't force the files to be reverted, and you can now launch the patched version using GTA Connected or also use the original through Steam without any further changes
* If you don't have GTA IV on Steam or Rockstar Launcher, skip the first step.

ScriptingFAQ

2022-06-16T20:58:47Z

PerikiyoXD:

{{DISPLAYTITLE:Scripting FAQ}}
== An element disappears if I go too far! (blips, cars...) ==
Sometimes you want to sync an element all the time.
Check [[netFlags.distanceStreaming]] to toggle streaming by distance.

ScriptingFAQ

2022-06-16T20:53:42Z

PerikiyoXD: /* An element dissapears if I go too far! (Blips, Cars...) */

== An element dissapears if I go too far! (Blips, Cars...) ==
Sometimes you want to sync an element all the time.
Check [[netFlags.distanceStreaming]] to toggle streaming by distance.

ScriptingFAQ

2022-06-16T20:53:28Z

PerikiyoXD: Created page with "== An element dissapears if I go too far! (Blips, Cars...) == Sometimes you want to sync an element all the time. Check netFlags.distanceStreaming to toggle straming by di..."

== An element dissapears if I go too far! (Blips, Cars...) ==
Sometimes you want to sync an element all the time.
Check [[netFlags.distanceStreaming]] to toggle straming by distance.

gta.createBlip

2022-06-16T20:44:53Z

PerikiyoXD:

{{ScriptItem
|endpoint = shared
|type = function
|name = gta.createBlip
|usage = add a blip to the game
|parameters = int icon, Vec3 position, [ int size = 2, int colour = 0 ]
|parameter1 = int icon The icon ID for the blip.
|parameter2 = Vec3 position The 3D position for the blip.
|parameter3 = int size optional 2 The size for the blip.
|parameter4 = int colour optional 0 The colour for the blip.
|return1 = Blip The new blip object.
|returnFail1 = bool false
|bcMaxVersion = 1.0.71
|bcName = game.createBlip
|notes = [[Resources/GTA3/RadarBlips|III Radar Blips]]<br>
[[Resources/GTAVC/RadarBlips|VC Radar Blips]]<br>
[[Resources/GTASA/RadarBlips|SA Radar Blips]]
}}

User:PerikiyoXD

2022-02-18T18:43:53Z

PerikiyoXD: Created blank page

Main Page

2021-11-09T15:16:37Z

PerikiyoXD:

__NOTOC__
{{MainPageHeader}}
----
{{MainPageLinks}}

Main Page

2021-11-09T15:13:41Z

PerikiyoXD:

{{DISPLAYTITLE:<span style="visibility: hidden;"></span>}}
__NOTOC__
{{MainPageHeader}}
----
{{MainPageLinks}}

Template:MainPageResources

2021-11-09T15:11:53Z

PerikiyoXD:

__NOTOC__
<div class="mainPageLinksBox" style="border:4px solid #8b8b00;" >
<div style="background:#8b8b00;text-align:center;color:white;font-size:2em">Reference</div>
<div style="margin:1em;">
<div>
==[[Image:GTAIII_Logo.png]] GTA III==
{{Resources/ShortGTA3}}
</div>
<div>
==[[Image:GTAVC_Logo.png|32px]] GTA Vice City==
{{Resources/ShortGTAVC}}
</div>
<div>
==[[Image:GTASA_Logo.png|32px]] GTA San Andreas==
{{Resources/ShortGTASA}}
</div>
<div>
==[[Image:GTAIV_Logo.png|32px]] GTA IV==
{{Resources/ShortGTAIV}}
</div>
</div>
</div>

Template:MainPageResources

2021-11-09T15:11:35Z

PerikiyoXD:

{{DISPLAYTITLE:<span style="display:none"></span>}}
__NOTOC__
<div class="mainPageLinksBox" style="border:4px solid #8b8b00;" >
<div style="background:#8b8b00;text-align:center;color:white;font-size:2em">Reference</div>
<div style="margin:1em;">
<div>
==[[Image:GTAIII_Logo.png]] GTA III==
{{Resources/ShortGTA3}}
</div>
<div>
==[[Image:GTAVC_Logo.png|32px]] GTA Vice City==
{{Resources/ShortGTAVC}}
</div>
<div>
==[[Image:GTASA_Logo.png|32px]] GTA San Andreas==
{{Resources/ShortGTASA}}
</div>
<div>
==[[Image:GTAIV_Logo.png|32px]] GTA IV==
{{Resources/ShortGTAIV}}
</div>
</div>
</div>

Template:MainPageScripting

2021-11-09T15:08:25Z

PerikiyoXD:

__NOTOC__
<div class="mainPageLinksBox" style="border:4px solid #8b0000;">
<div style="background:#8b0000;text-align:center;color:white;font-size:2em">Scripting</div>
<div style="margin:1em;">
==Shared==
*[[Types|Types]]
*[[Defines|Defines]]
==Server==
*[[Server/Events|Events]]
*[[Server/Functions|Functions]]
==Client==
*[[Client/Events|Events]]
*[[Client/Functions|Functions]]
*[[Client/Natives|Native Scripting Functions]]
==Extra==
*[[GettingStarted|Getting Started]]
*[[ScriptingInterface|Scripting Interface]]
*[[ScriptingExamples|Examples]]
*[[ScriptingTutorials|Tutorials]]
==Compatibility==
*[[ThirdPartyVersions|Third-Party Versions]]
*[[SignificantChanges|Significant Changes]]
</div>
</div>

Template:MainPageOverview

2021-11-09T15:07:41Z

PerikiyoXD:

__NOTOC__
<div class="mainPageLinksBox" style="border:4px solid #008b8b;">
<div style="background:#008b8b;text-align:center;color:white;font-size:2em">Overview</div>
<div style="margin:1em;">
==Client==
'''Playing a game'''
*[[ClientManual|Client Manual]]
*[[ClientCommands|Client Commands]]
*[[ClientSettings|Client Settings]]
*[[ClientVariables|Client Variables]]

'''Game Support'''
*[[GamesAndVersions|Games & Versions]]
*[[GameModifications|Game Modifications]]
*[[Downgrading|Downgrading]]

==Server==
'''Hosting a server'''
<div>
*[[GettingStarted|Getting Started]]
*[[HostingAndJoining|Hosting and Joining]]
*[[Resources|Resources (Scripting)]]
*[[Modules|Modules (Programming)]]
</div>
<div>
*[[ServerManual|Server Manual]]
*[[ServerConfiguration|Server Configuration]]
*[[Limits|Limits]]
*[[ServerRules|Server Rules (Shown in Launcher)]]
*[[Dumpdoc|dumpdoc (Alternative Documentation)]]
*[[ServerQuery|Server Query]]
</div>
</div>
</div>

Template:MainPageResources

2021-11-09T15:07:33Z

PerikiyoXD:

__NOTOC__
<div class="mainPageLinksBox" style="border:4px solid #8b8b00;" >
<div style="background:#8b8b00;text-align:center;color:white;font-size:2em">Reference</div>
<div style="margin:1em;">
<div>
<span style="font-size:1.5em;"><center>[[Image:GTAIII_Logo.png|32px]] III</center></span>
{{Resources/ShortGTA3}}
</div>
<div>
<span style="font-size:1.5em;"><center>[[Image:GTAVC_Logo.png|32px]] Vice City</center></span>
{{Resources/ShortGTAVC}}
</div>
<div>
<span style="font-size:1.5em;"><center>[[Image:GTASA_Logo.png|32px]] San Andreas</center></span>
{{Resources/ShortGTASA}}
</div>
<div>
<span style="font-size:1.5em;"><center>[[Image:GTAIV_Logo.png|32px]] IV</center></span>
{{Resources/ShortGTAIV}}
</div>
</div>
</div>

Template:MainPageHeader

2021-11-09T15:07:19Z

PerikiyoXD:

<div style="height:3em;background: #072C38;background: radial-gradient(circle, #072C38, #000000);text-align:center;font-size:2em;color:white;line-height:3em;">
GTA Connected
</div>

Main Page

2021-11-09T15:07:06Z

PerikiyoXD:

__NOTOC__
{{MainPageHeader}}
----
{{MainPageLinks}}