GTA Connected - User contributions [en]

triggerNetworkEvent

2025-04-25T09:41:16Z

Stepbro:

{{ScriptItem
|offline = false
|endpoint = shared
|type = function
|name = triggerNetworkEvent
|usage = trigger a custom network event
|parametersSS = string networkEventName, null or Client client, [ ... ]
|parametersCS = string networkEventName, [ ... ]
|parameter1 = string networkEventName The name of the network event, case-insensitive.
|parameter2 = Client client Can be null. The client to trigger the network event for.
|parameter3 = vararg ... optional n/a Arguments to send to the scripting functions that are bound to the network event.
|callbackParametersSS = Client client, ...
|callbackParametersCS = ...
|return1 = void
|returnFail1 = void
|notes = When used in a server script, use null to send the event to all clients or specify a client object. See [[Shared/Functions/Network/addNetworkHandler|addNetworkHandler]] for information regarding custom event handler functions. Passing <code>vararg</code> arguments that are not default types of GTA:C, the function will fail.
|exampleJSSS = function makeCivilianWalkToPos(civilian, x, y, z) {
triggerNetworkEvent("walkToPos", null, civilian, x, y);
}
}}

triggerNetworkEvent

2025-04-25T02:56:06Z

Stepbro:

{{ScriptItem
|offline = false
|endpoint = shared
|type = function
|name = triggerNetworkEvent
|usage = trigger a custom network event
|parametersSS = string networkEventName, null or Client client, [ ... ]
|parametersCS = string networkEventName, [ ... ]
|parameter1 = string networkEventName The name of the network event, case-insensitive.
|parameter2 = Client client Can be null. The client to trigger the network event for.
|parameter3 = vararg ... optional n/a Arguments to send to the scripting functions that are bound to the network event.
|callbackParametersSS = Client client, ...
|callbackParametersCS = ...
|return1 = void
|returnFail1 = void
|notes = When used in a server script, use null to send the event to all clients or specify a client object. See [[Shared/Functions/Network/addNetworkHandler|addNetworkHandler]] for information regarding custom event handler functions. Passing <code>vararg</code> arguments that are not default types of GTA:C, the function will fail.
|exampleJSSS = function makeCivilianWalkToPos(civilian, x, y, z) {
triggerNetworkEvent("walkToPos", null, civilian, x, y);
}
}}

triggerNetworkEvent

2025-04-25T02:55:54Z

Stepbro:

{{ScriptItem
|offline = false
|endpoint = shared
|type = function
|name = triggerNetworkEvent
|usage = trigger a custom network event
|parametersSS = string networkEventName, null or Client client, [ ... ]
|parametersCS = string networkEventName, [ ... ]
|parameter1 = string networkEventName The name of the network event, case-insensitive.
|parameter2 = Client client Can be null. The client to trigger the network event for.
|parameter3 = vararg ... optional n/a Arguments to send to the scripting functions that are bound to the network event.
|callbackParametersSS = Client client, ...
|callbackParametersCS = ...
|return1 = void
|returnFail1 = void
|notes = When used in a server script, use null to send the event to all clients or specify a client object. See [[Shared/Functions/Network/addNetworkHandler|addNetworkHandler]] for information regarding custom event handler functions.
* Passing <code>vararg</code> arguments that are not default types of GTA:C, the function will fail.
|exampleJSSS = function makeCivilianWalkToPos(civilian, x, y, z) {
triggerNetworkEvent("walkToPos", null, civilian, x, y);
}
}}

triggerNetworkEvent

2025-04-25T02:55:41Z

Stepbro: Trying bullet points as stated by MediaWiki

{{ScriptItem
|offline = false
|endpoint = shared
|type = function
|name = triggerNetworkEvent
|usage = trigger a custom network event
|parametersSS = string networkEventName, null or Client client, [ ... ]
|parametersCS = string networkEventName, [ ... ]
|parameter1 = string networkEventName The name of the network event, case-insensitive.
|parameter2 = Client client Can be null. The client to trigger the network event for.
|parameter3 = vararg ... optional n/a Arguments to send to the scripting functions that are bound to the network event.
|callbackParametersSS = Client client, ...
|callbackParametersCS = ...
|return1 = void
|returnFail1 = void
|notes = When used in a server script, use null to send the event to all clients or specify a client object. See [[Shared/Functions/Network/addNetworkHandler|addNetworkHandler]] for information regarding custom event handler functions. * Passing <code>vararg</code> arguments that are not default types of GTA:C, the function will fail.
|exampleJSSS = function makeCivilianWalkToPos(civilian, x, y, z) {
triggerNetworkEvent("walkToPos", null, civilian, x, y);
}
}}

triggerNetworkEvent

2025-04-25T02:52:33Z

Stepbro:

{{ScriptItem
|offline = false
|endpoint = shared
|type = function
|name = triggerNetworkEvent
|usage = trigger a custom network event
|parametersSS = string networkEventName, null or Client client, [ ... ]
|parametersCS = string networkEventName, [ ... ]
|parameter1 = string networkEventName The name of the network event, case-insensitive.
|parameter2 = Client client Can be null. The client to trigger the network event for.
|parameter3 = vararg ... optional n/a Arguments to send to the scripting functions that are bound to the network event.
|callbackParametersSS = Client client, ...
|callbackParametersCS = ...
|return1 = void
|returnFail1 = void
|notes = When used in a server script, use null to send the event to all clients or specify a client object. See [[Shared/Functions/Network/addNetworkHandler|addNetworkHandler]] for information regarding custom event handler functions. Passing <code>vararg</code> arguments that are not default types of GTA:C, the function will fail.
|exampleJSSS = function makeCivilianWalkToPos(civilian, x, y, z) {
triggerNetworkEvent("walkToPos", null, civilian, x, y);
}
}}

triggerNetworkEvent

2025-04-25T02:52:09Z

Stepbro:

{{ScriptItem
|offline = false
|endpoint = shared
|type = function
|name = triggerNetworkEvent
|usage = trigger a custom network event
|parametersSS = string networkEventName, null or Client client, [ ... ]
|parametersCS = string networkEventName, [ ... ]
|parameter1 = string networkEventName The name of the network event, case-insensitive.
|parameter2 = Client client Can be null. The client to trigger the network event for.
|parameter3 = vararg ... optional n/a Arguments to send to the scripting functions that are bound to the network event.
|callbackParametersSS = Client client, ...
|callbackParametersCS = ...
|return1 = void
|returnFail1 = void
|notes = When used in a server script, use null to send the event to all clients or specify a client object. See [[Shared/Functions/Network/addNetworkHandler|addNetworkHandler]] for information regarding custom event handler functions.\nPassing <code>vararg</code> arguments that are not default types of GTA:C, the function will fail.
|exampleJSSS = function makeCivilianWalkToPos(civilian, x, y, z) {
triggerNetworkEvent("walkToPos", null, civilian, x, y);
}
}}

triggerNetworkEvent

2025-04-25T02:51:47Z

Stepbro:

{{ScriptItem
|offline = false
|endpoint = shared
|type = function
|name = triggerNetworkEvent
|usage = trigger a custom network event
|parametersSS = string networkEventName, null or Client client, [ ... ]
|parametersCS = string networkEventName, [ ... ]
|parameter1 = string networkEventName The name of the network event, case-insensitive.
|parameter2 = Client client Can be null. The client to trigger the network event for.
|parameter3 = vararg ... optional n/a Arguments to send to the scripting functions that are bound to the network event.
|callbackParametersSS = Client client, ...
|callbackParametersCS = ...
|return1 = void
|returnFail1 = void
|notes = When used in a server script, use null to send the event to all clients or specify a client object. See [[Shared/Functions/Network/addNetworkHandler|addNetworkHandler]] for information regarding custom event handler functions.
|notes = Passing <code>vararg</code> arguments that are not default types of GTA:C, the function will fail.
|exampleJSSS = function makeCivilianWalkToPos(civilian, x, y, z) {
triggerNetworkEvent("walkToPos", null, civilian, x, y);
}
}}

triggerNetworkEvent

2025-04-25T02:51:11Z

Stepbro: Added note stating that as of 1.7.11, you can only pass through types provided by GTA:C for vararg arguments.

{{ScriptItem
|offline = false
|endpoint = shared
|type = function
|name = triggerNetworkEvent
|usage = trigger a custom network event
|parametersSS = string networkEventName, null or Client client, [ ... ]
|parametersCS = string networkEventName, [ ... ]
|parameter1 = string networkEventName The name of the network event, case-insensitive.
|parameter2 = Client client Can be null. The client to trigger the network event for.
|parameter3 = vararg ... optional n/a Arguments to send to the scripting functions that are bound to the network event.
|callbackParametersSS = Client client, ...
|callbackParametersCS = ...
|return1 = void
|returnFail1 = void
|notes = When used in a server script, use null to send the event to all clients or specify a client object. See [[Shared/Functions/Network/addNetworkHandler|addNetworkHandler]] for information regarding custom event handler functions.
Passing <code>vararg</code> arguments that are not default types of GTA:C, the function will fail.
|exampleJSSS = function makeCivilianWalkToPos(civilian, x, y, z) {
triggerNetworkEvent("walkToPos", null, civilian, x, y);
}
}}

gta.createBlip

2025-04-20T14:45:43Z

Stepbro: Re-arranged parameters.

{{ScriptItem
|endpoint = shared
|type = function
|name = gta.createBlip
|usage = add a blip to the game
|parameters = Vec3 position, int icon, [ int size = 2, int colour = 0 ]
|parameter1 = Vec3 position The 3D position for the blip.
|parameter2 = int icon The icon ID 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]] 
[[Resources/GTAVC/RadarBlips|VC Radar Blips]] 
[[Resources/GTASA/RadarBlips|SA Radar Blips]]
}}

Resources/GTA3/VehicleModels

2025-04-19T14:02:55Z

Stepbro: Added 'Police' Car ID.

{{DISPLAYTITLE:GTA III - Vehicle Models}}
<nowiki>90 - LANDSTALKER
91 - IDAHO
92 - STINGER
93 - LINERUNNER
94 - PERENNIAL
95 - SENTINEL
96 - PATRIOT
97 - FIRE TRUCK
98 - TRASHMASTER
99 - STRETCH
100 - MANANA
101 - INFERNUS
102 - BLISTA
103 - PONY
104 - MULE
105 - CHEETAH
106 - AMBULANCE
107 - FBI CAR
108 - MOONBEAM
109 - ESPERANTO
110 - TAXI
111 - KURUMA
112 - BOBCAT
113 - MR. WHOOPEE
114 - BF INJECTION
115 - MANANA (CORPSE)
116 - POLICE
117 - ENFORCER
118 - SECURICAR
119 - BANSHEE
120 - PREDATOR
121 - BUS
122 - RHINO
123 - BARRACKS OL
124 - TRAIN
125 - POLICE HELICOPTER
126 - DODO
127 - COACH
128 - CABBIE
129 - STALLION
130 - RUMPO
131 - RC BANDIT
132 - BELLYUP
133 - MR. WONGS
134 - MAFIA SENTINEL
135 - YARDIE LOBO
136 - YAKUZA STINGER
137 - DIABLO STALLION
138 - CARTEL CRUISER
139 - HOODS RUMPO XL
140 - AIR TRAIN
141 - DEAD DODO
142 - SPEEDER
143 - REEFER
144 - PANLANTIC
145 - FLATBED
146 - YANKEE
147 - ESCAPE
148 - BORGNINE TAXI
149 - TOYZ VAN
150 - GHOST</nowiki>

physical.affectedByGravity

2025-04-12T02:52:11Z

Stepbro: Adding information and trying to learn the current standard as to how information should be displayed/represented on the wiki.

{{ScriptItem
|endpoint = client
|type = property
|class = physical
|name = affectedByGravity
|readonly = false
|returnTypes = void
|usage = set the current entity to be affected by gravity.
|returnInfo = nothing.
}}

ScriptingExamples/AddObject

2025-04-09T02:22:27Z

Stepbro: Removed 'addToWorld()' function invoke as the webpage for 'addToWorld()' (https://wiki.gtaconnected.com/addToWorld) states that it no longer needs to be invoked.

{{DISPLAYTITLE:Add an Object}}
== Description ==
This code adds an object to the game when a player types '''/object model''' in-game. 
'''model''' must be an integer representing an object model ID. 
Validation included in this code: Check that the player is spawned, and check that the player typed at least some text after the command name. 
Validation not included in this code: Check that the object model ID is valid.

== Code ==
'''JavaScript, Server-Side'''
{{JSCode|1=addCommandHandler('object', function(command, parameters, client)
{
if(!client.player)
{
messageClient('You must be spawned to spawn an object!', client);
}
else if(parameters.trim() == '')
{
messageClient('You must type a model number! Command syntax: /object model', client);
}
else
{
var model = parseInt(parameters);
var object = gta.createObject(model, client.player.position);
}
});}}

ScriptingExamples/AddVehicle

2025-04-09T02:22:06Z

Stepbro: Removed 'addToWorld()' function invoke as the webpage for 'addToWorld()' (https://wiki.gtaconnected.com/addToWorld) states that it no longer needs to be invoked.

{{DISPLAYTITLE:Add a Vehicle}}
== Description ==
This code adds a vehicle to the game when a player types '''/vehicle model''' in-game. 
'''model''' must be an integer representing a vehicle model ID, this command example does not work with vehicle model names. 
Validation included in this code: Check that the player is spawned, and check that the player typed at least some text after the command name. 
Validation not included in this code: Check that the vehicle model ID is valid.

== Code ==
'''JavaScript, Server-Side'''
{{JSCode|1=addCommandHandler('vehicle', function(command, parameters, client)
{
if(!client.player)
{
messageClient('You must be spawned to spawn a vehicle!', client);
}
else if(parameters.trim() == '')
{
messageClient('You must type a model number! Command syntax: /vehicle model', client);
}
else
{
var model = parseInt(parameters);
var vehicle = gta.createVehicle(model, client.player.position);
}
});}}

gta.createVehicle

2025-04-09T02:20:53Z

Stepbro: Removed 'addToWorld()' function invoke as the webpage for 'addToWorld()' (https://wiki.gtaconnected.com/addToWorld) states that it no longer needs to be invoked.

{{ScriptItem
|endpoint = shared
|type = function
|name = gta.createVehicle
|parametersSS = int model, Vec3 position
|parametersCS = int model, [ Vec3 position ]
|parameter1 = int model The vehicle model ID.
|parameter2 = Vec3 position optional Vec3(0.0, 0.0, 0.0) The position for the vehicle.
|return1 = Vehicle The vehicle handle.
|returnFail1 = null n/a
|usage = add a vehicle
|returnInfo = a handle to the vehicle
|bcMaxVersion = 1.0.71
|bcName = game.createVehicle
|notes = Use the [[addToWorld|addToWorld]] function afterwards to add the vehicle to the players games.
|exampleJSSS = addCommandHandler("vehicle", function(command, parameters, client) {
var model = parseInt(parameters);
var vehicle = gta.createVehicle(model, client.player.position);
});
|exampleJSCS = addCommandHandler("vehicle", function(command, parameters) {
var model = parseInt(parameters);
var vehicle = gta.createVehicle(model, localPlayer.position);
});
}}