GTA Connected - User contributions [en]

OnPlayerJoined

2021-08-13T11:28:09Z

MexTest1:

{{ScriptItem
|endpoint = server
|type = event
|name = OnPlayerJoined
|usage = a player has connected to the server
|callbackParameters = Event event, Client client
|cancellable = false
|parameter1 = Client client The client that has connected to the server.
|notes =
The chronological order of player connection events are: 
[[OnPlayerConnect|OnPlayerConnect]] 
[[OnPlayerJoin|OnPlayerJoin]] 
[[OnPlayerJoined|OnPlayerJoined]]
|exampleJS =
addEventHandler('OnPlayerJoined', (event, client) => {
messageClient(`Hello ${client.name}, welcome to my server! 👋`, client, COLOUR_YELLOW);
});
|exampleLua =
addEventHandler('OnPlayerJoined', function(event, client)
messageClient('Hello ' .. client.name .. ', welcome to my server! 👋', client, COLOUR_YELLOW)
end)
}}

OnPlayerJoined

2021-08-13T11:27:58Z

MexTest1:

{{ScriptItem
|endpoint = server
|type = event
|name = OnPlayerJoined
|usage = a player has connected to the server
|callbackParameters = Event event, Client client
|cancellable = false
|parameter1 = Client client The client that has connected to the server.
|notes =
The chronological order of player connection events are: 
[[OnPlayerConnect|OnPlayerConnect]] 
[[OnPlayerJoin|OnPlayerJoin]] 
[[OnPlayerJoined|OnPlayerJoined]]
|exampleJSSS =
addEventHandler('OnPlayerJoined', (event, client) => {
messageClient(`Hello ${client.name}, welcome to my server! 👋`, client, COLOUR_YELLOW);
});
|exampleLuaSS =
addEventHandler('OnPlayerJoined', function(event, client)
messageClient('Hello ' .. client.name .. ', welcome to my server! 👋', client, COLOUR_YELLOW)
end)
}}

OnPlayerCommand

2021-08-12T16:10:46Z

MexTest1:

{{ScriptItem
|endpoint = server
|type = event
|name = OnPlayerCommand
|usage = a player submits a chat command. A command starts with a forward slash (the command character), and the command is not displayed in the chat box
|callbackParameters = Event event, Client client, string command, string parameters
|cancellable = true
|parameter1 = Client client The client that submitted a command.
|parameter2 = string command The command name.
|parameter3 = string parameters The command parameters as a string.
|exampleJS = addEventHandler('OnPlayerCommand', (event, client, command, parameters) => {
console.log(`(Command) ${client.name} has used the command '/${command} ${parameters}'.`);
});
|exampleLua = addEventHandler('OnPlayerCommand', function(event, client, command, parameters)
console.log(`(Command) ${client.name} has used the command '/${command} ${parameters}'.`);
end);
}}

OnElementStreamIn

2021-08-12T15:56:37Z

MexTest1:

{{ScriptItem
|endpoint = shared
|type = event
|name = onElementStreamIn
|parameter1 = Element element The element that has streamed in for a client.
|parameter2 = Client client The client that the element has streamed in for. Server-side only.
|usage = an element streams in for a client
|callbackParametersSS = Event event, Element element, Client client
|callbackParametersCS = Event event, Element element
|cancellable = true
|exampleJSSS = addEventHandler('OnElementStreamIn', (event, element, client) => {
message('Element with id ' + element.id + ' has streamed in for ' + client.name, COLOUR_BLUE);
});
|exampleJSCS = addEventHandler('OnElementStreamIn', (event, element) => {
message('Element with id ' + element.id + ' has streamed in.', COLOUR_BLUE);
});
|exampleLuaSS = addEventHandler('OnElementStreamIn', function(event, element, client)
message('Element with id ' .. element.id .. ' has streamed in for a client.', COLOUR_RED)
end)
|exampleLuaCS = addEventHandler('OnElementStreamIn', function(event, element)
message('Element with id ' .. element.id .. ' has streamed in.', COLOUR_BLUE)
end)
}}

OnElementStreamIn

2021-08-12T15:55:53Z

MexTest1:

{{ScriptItem
|endpoint = shared
|type = event
|name = onElementStreamIn
|parameter1 = Element element The element that has streamed in for a client.
|parameter2 = Client client The client that the element has streamed in for. Server-side only.
|usage = an element streams in for a client
|callbackParametersSS = Event event, Element element, Client client
|callbackParametersCS = Event event, Element element
|cancellable = true
|exampleJSSS = addEventHandler('OnElementStreamIn', (event, element, client) => {
messageClient('Element with id ' + element.id + ' has streamed in for ' + client.name, client, COLOUR_BLUE);
});
|exampleJSCS = addEventHandler('OnElementStreamIn', (event, element) => {
message('Element with id ' + element.id + ' has streamed in.', COLOUR_BLUE);
});
|exampleLuaSS = addEventHandler('OnElementStreamIn', function(event, element, client)
messageClient('Element with id ' .. element.id .. ' has streamed in for a client.', client, COLOUR_RED)
end)
|exampleLuaCS = addEventHandler('OnElementStreamIn', function(event, element)
message('Element with id ' .. element.id .. ' has streamed in.', COLOUR_BLUE)
end)
}}

OnElementDestroy

2021-08-12T15:47:41Z

MexTest1: Added JavaScript example

{{ScriptItem
|endpoint = shared
|type = event
|name = onElementDestroy
|usage = an element is destroyed
|callbackParameters = Event event, Element element
|parameter1 = Element element The element that is about to be destroyed.
|cancellable = true
|exampleJS = addEventHandler('OnElementDestroy', (event, element) => {
message(`Element with id ${element.id} has been destroyed.`, COLOUR_RED)
});
|exampleLua = addEventHandler('OnElementDestroy', function(event, element)
message('Element with id ' .. element.id .. ' has been destroyed.', COLOUR_RED)
end)
}}

OnPlayerJoined

2021-08-12T15:22:58Z

MexTest1:

{{ScriptItem
|endpoint = server
|type = event
|name = onPlayerJoined
|usage = a player has connected to the server
|callbackParameters = Event event, Client client
|cancellable = false
|parameter1 = Client client The client that has connected to the server.
|notes =
The chronological order of player connection events are: 
[[OnPlayerConnect|OnPlayerConnect]] 
[[OnPlayerJoin|OnPlayerJoin]] 
[[OnPlayerJoined|OnPlayerJoined]]
|exampleJSSS =
addEventHandler('OnPlayerJoined', (event, client) => {
messageClient(`Hello ${client.name}, welcome to my server! 👋`, client, COLOUR_YELLOW);
});
|exampleLuaSS =
addEventHandler('OnPlayerJoined', function(event, client)
messageClient('Hello ' .. client.name .. ', welcome to my server! 👋', client, COLOUR_YELLOW)
end)
}}

OnPlayerJoined

2021-08-12T15:06:50Z

MexTest1: Since the event doesn't exist client-side, I made it server-side only. I also added an example

Client/Natives/IV/taskCarMissionPedTarget

2021-07-06T10:28:43Z

MexTest1: page created; including Javascript example

{{DISPLAYTITLE:natives.taskCarMissionPedTarget}}
{{ScriptItem
|endpoint = client
|games = iv
|type = function
|name = natives.taskCarMissionPedTarget
|usage = make the vehicle follow the target using internal game path data.
|parameters = Ped ped, Vehicle vehicle, Ped target, int driveFlag, float driveSpeed, int driveStyle, int stopDist, int chaseDist
|parameter1 = Ped ped The Ped to drive the Vehicle.
|parameter2 = Vehicle vehicle The Vehicle to drive with.
|parameter3 = Ped target The targetPed to chase after.
|parameter4 = int driveFlag The AI driving/chasing behavior to use. (0-13, ''see details below'')
|parameter5 = float driveSpeed The speed of driving in meters per second. '''(default = 20)'''
|parameter6 = int driveStyle The AI driving style (behavior) to use. (0-7, ''see details below'')
|parameter7 = int stopDist Special distance flag #1, depending on selected driveFlag; vehicle may stop within
|parameter8 = int chaseDist Special distance flag #2, depending on selected driveFlag; direct chase mode within
|notes = direct chase mode = cut corners; no braking before intersections; ignore obstacles; follow target directly;
|return1 = void
|returnFail1 = void
|exampleJSCS = // find a random char inside a vehicle
function getPedInVehicle() {
// array of all peds (includes localPlayer)
let allPeds = getPeds();

// loop thru peds array
for (let i=0; i < allPeds.length; i++)
{
// filter by peds in vehicles
if (allPeds[i] != localPlayer && allPeds[i].isInVehicle) {
return allPeds[i];
}
}

return null;
}

/* example code provided by DrFauli */
addCommandHandler("chasetarget", function(cmdName, params) {
// find a random char inside a vehicle
let thisPed = getPedInVehicle();
if (thisPed == null) return false;

let driveSpeed = 25;
let driveFlag = 6; // 6 = chase after target (player) and stay on throttle
let driveStyle = 2 // ignore traffic lights; drive around peds and cars
let stopDist = 10; // dist behavior flag 1 (stop within)
let chaseDist = 25; // dist behavior flag 2 (chase within)

// prevent ped from leaving the car screaming by marking it as mission_char first
natives.setCharAsMissionChar(thisPed, true);
natives.setCharStayInCarWhenJacked(thisPed, true);
natives.setCharInvincible(thisPed, true);
natives.clearCharTasks(thisPed);

// let ped follow player and crash into him (driveFlag: 6)
// [syntax]: PedHandle, CarHandle, TargetCharHandle, flag, speed, style, stopDist, chaseDist
natives.taskCarMissionPedTarget(thisPed, thisPed.vehicle, localPlayer, driveFlag, driveSpeed, driveStyle, stopDist, chaseDist);

// add a blip to make the ped more visible to the player
natives.addBlipForChar(thisPed);

return true;
});
}}

== driving flag behavior ==
{|class="wikitable"
!|
!|behavior
!|ramming
!|overtaking
!|stopDist
!|chaseDist
|-
|0
|follow target
|from behind (+braking)
|stay behind
|not used
|direct chase within
|-
|1
|drive wander
|ignore target
|ignore target
|not used
|not used
|-
|2
|follow target
|from behind (+braking)
|stay behind
|not used
|direct chase within
|-
|3
|follow target
|from sides
|overtake then stop
|not used
|direct chase within
|-
|4
|follow target
|none
|overtake then stop
|stop within (forever)
|direct chase within
|-
|5
|do nothing
|/
|/
|/
|/
|-
|-
|6
|follow target
|from behind (+full throttle)
|stay behind (+full throttle)
|not used
|direct chase within
|-
|7
|follow target
|none
|stay behind
|stop within
|direct chase within
|-
|8
|drive wander
|ignore target
|ignore target
|not used
|not used
|-
|9
|follow target
|none
|circle around then stop
|distance left side
|distance right side
|-
|10
|follow target
|none
|drive parallel (left)
|not used
|parallel within
|-
|11
|follow target
|none
|drive parallel (right)
|not used
|parallel within
|-
|12
|follow target
|none
|drive parallel (rear)
|not used
|parallel within
|-
|13
|follow target
|none
|drive parallel (front)
|not used
|parallel within
|-
|}

== driving flag notes ==
*all flags will follow the selected driveStyle (parameter 6)
*driveStyle will be ignored within radius of chaseDist(direct chase mode)
*flag '''0 and 2''' seem to be identical.
*flag '''1 and 8''' seem to be identical.

==driving style behavior==
{|class="wikitable"
!|
!|traffic lights
!|other cars
!|pedestrians
!|blinkers
!|when stuck
|-
|0
|ignore
|drive around
|drive around
|not used
|reverse
|-
|1
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|-
|2
|ignore
|drive around
|drive around
|not used
|reverse
|-
|3
|ignore
|ignore
|ignore
|not used
|reverse
|-
|4
|ignore
|stay behind
|stop and honk
|not used
|wait
|-
|5
|stop on red
|drive around
|drive around
|not used
|reverse
|-
|6
|stop+reversing
|drive around
|drive around
|not used
|reverse
|-
|7
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|}

== driving style notes ==
*driving styles '''0 and 2''' seem to be identical.
*driving styles '''1 and 7''' seem to be identical.

Client/Natives/IV/taskCarDriveToCoord

2021-07-04T13:44:53Z

MexTest1: page created; including Javascript example

{{DISPLAYTITLE:natives.taskCarDriveToCoord}}
{{ScriptItem
|endpoint = client
|games = iv
|type = function
|name = natives.taskCarDriveToCoord
|usage = make the vehicle randomly drive around using internal game path data.
|parameters = Ped ped, Vehicle vehicle, float x, float y, float z, float driveSpeed, int driveFlag, 0 (or model hash), int driveStyle, float stopDist, -1)
|parameter1 = Ped ped The Ped to drive the Vehicle.
|parameter2 = Vehicle vehicle The Vehicle to drive with.
|parameter3 = float x The x position to drive to.
|parameter4 = float y The y position to drive to.
|parameter5 = float z The z position to drive to.
|parameter6 = float driveSpeed The speed of driving in meters per second. '''(default = 20)'''
|parameter7 = int driveFlag The AI driving behavior/flag to use. (0-4, ''see details below'')
|parameter8 = int hash (unknown) 0 or model hash of the vehicle used in parameter 2
|parameter9 = int driveStyle The AI driving style (behavior) to use. (0-7, ''see details below'')
|parameter10 = float stopDist Radius around the given coords. Vehicle will stop when inside radius.
|parameter11 = int unknown (unknown) always -1
|return1 = void
|returnFail1 = void
|exampleJSCS = /* example code provided by DrFauli */
addCommandHandler("drivecoords", function(cmdName, params) {
// current vehicle/ped handle
let thisVeh = null;
let thisPed = null;

// check if player is in a car
if (!localPlayer.vehicle) {
natives.requestModel(-956048545) // Taxi
natives.requestModel(8772846); // Taxi Driver
natives.loadAllObjectsNow();

// spawn the car
thisVeh = createVehicle2(-956048545, localPlayer.position, true);
thisVeh.heading = localPlayer.heading;

// spawn the driver
thisPed = natives.createCharInsideCar(thisVeh, 1, 8772846);

// prevent ped from leaving the car screaming by marking it as mission_char first
natives.setCharAsMissionChar(thisPed, true);
natives.setCharStayInCarWhenJacked(thisPed, true);

// warp player into passenger seat
natives.warpCharIntoCarAsPassenger(localPlayer, thisVeh, 0);
} else {
thisVeh = localPlayer.vehicle;
thisPed = thisVeh.getOccupant(0);
}

// get speed and driveStyle/driveFlag from params
let splitParams = params.split(" ");
let stopDist = 50;
let driveSpeed = Number(splitParams[0]); // default is 20
let driveStyle = Number(splitParams[1]);
let driveFlag = Number(splitParams[2]); // default is 0

// let this car drive to coords (0,0,0)
// [syntax]: pedHandle, carHandle, x, y, z, driveSpeed, driveFlag, (0 or model hash?), driveStyle, stop distance, unknown(-1)
natives.taskCarDriveToCoord(thisPed, thisVeh, 0, 0, 0, driveSpeed, driveFlag, 0, driveStyle, stopDist, -1);

return true;
});
}}

== driving flag behavior ==
{|class="wikitable"
!|
!|behavior
!|parameter9 (driving style)
|-
|0
|normal driving
|used
|-
|1
|get to coord as fast as possible
|ignored
|-
|2
|driving in reverse
|used (while reversing)
|-
|3
|drive wander (ignore coords)
|used
|}

==driving style behavior==
{|class="wikitable"
!|
!|traffic lights
!|other cars
!|pedestrians
!|blinkers
!|when stuck
|-
|0
|ignore
|drive around
|drive around
|not used
|reverse
|-
|1
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|-
|2
|ignore
|drive around
|drive around
|not used
|reverse
|-
|3
|ignore
|ignore
|ignore
|not used
|reverse
|-
|4
|ignore
|stay behind
|stop and honk
|not used
|wait
|-
|5
|stop on red
|drive around
|drive around
|not used
|reverse
|-
|6
|stop+reversing
|drive around
|drive around
|not used
|reverse
|-
|7
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|}

==notes==
*driving styles '''0 and 2''' seem to be identical.
*driving styles '''1 and 7''' seem to be identical.
*using values '''< 0''' or '''> 7''' will behave like '''3'''
*the AI will slow down for corners and intersections, but won't break for "drive around" obstacles.
There '''could be''' small distance and/or speed differences when "drive around" is used.‎ 
It is also unclear if the AI drivers are able to see objects like light poles or traffic lights while evading.

Client/Natives/IV/taskCarDriveWander

2021-07-04T05:10:15Z

MexTest1: switched script example driver to civilian AI instead of localPlayer

{{DISPLAYTITLE:natives.taskCarDriveWander}}
{{ScriptItem
|endpoint = client
|games = iv
|type = function
|name = natives.taskCarDriveWander
|usage = make the vehicle randomly drive around using internal game path data.
|parameters = Ped ped, Vehicle vehicle, float driveSpeed, int driveStyle
|parameter1 = Ped ped The Ped to drive the Vehicle.
|parameter2 = Vehicle vehicle The Vehicle to drive with.
|parameter3 = float driveSpeed The speed of driving in meters per second. '''(default = 20)'''
|parameter4 = int driveStyle The AI driving style (behavior) to use. (0-7, ''see details below'')
|return1 = void
|returnFail1 = void
|exampleJSCS = /* example code provided by DrFauli */
addCommandHandler("drivewander", function(cmdName, params) {
// current vehicle/ped handle
let thisVeh = null;
let thisPed = null;

// check if player is in a car
if (!localPlayer.vehicle) {
natives.requestModel(-956048545) // Taxi
natives.requestModel(8772846); // Taxi Driver
natives.loadAllObjectsNow();

// spawn the car
thisVeh = createVehicle2(-956048545, localPlayer.position, true);
thisVeh.heading = localPlayer.heading;

// spawn the driver
thisPed = natives.createCharInsideCar(thisVeh, 1, 8772846);

// prevent ped from leaving the car screaming by marking it as mission_char first
natives.setCharAsMissionChar(thisPed, true);
natives.setCharStayInCarWhenJacked(thisPed, true);

// warp player into passenger seat id 0 (next to driver)
natives.warpCharIntoCarAsPassenger(localPlayer, thisVeh, 0);
}
else {
thisVeh = localPlayer.vehicle;
thisPed = thisVeh.getOccupant(0);
}

// get speed and driveStyle from params
let splitParams = params.split(" ");
let driveSpeed = Number(splitParams[0]); // default is 20
let driveStyle = Number(splitParams[1]);

// let this car randomly drive around
// [syntax]: pedHandle, carHandle, driveSpeed, driveStyle
natives.taskCarDriveWander(thisPed, thisVeh, driveSpeed, driveStyle);

return true;
});
}}

==driving style behavior==
{|class="wikitable"
!|
!|traffic lights
!|other cars
!|pedestrians
!|blinkers
!|when stuck
|-
|0
|ignore
|drive around
|drive around
|not used
|reverse
|-
|1
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|-
|2
|ignore
|drive around
|drive around
|not used
|reverse
|-
|3
|ignore
|ignore
|ignore
|not used
|reverse
|-
|4
|ignore
|stay behind
|stop and honk
|not used
|wait
|-
|5
|stop on red
|drive around
|drive around
|not used
|reverse
|-
|6
|stop+reversing
|drive around
|drive around
|not used
|reverse
|-
|7
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|}

==notes==
*driving styles '''0 and 2''' seem to be identical.
*driving styles '''1 and 7''' seem to be identical.
*using values '''< 0''' or '''> 7''' will behave like '''3'''
*the AI will slow down for corners and intersections, but won't break for "drive around" obstacles.
There '''could be''' small distance and/or speed differences when "drive around" is used.‎ 
It is also unclear if the AI drivers are able to see objects like light poles or traffic lights while evading.

Client/Natives/IV/taskCarDriveWander

2021-07-03T15:45:45Z

MexTest1: added endpoint (client only)

{{DISPLAYTITLE:natives.taskCarDriveWander}}
{{ScriptItem
|endpoint = client
|games = iv
|type = function
|name = natives.taskCarDriveWander
|usage = make the vehicle randomly drive around using internal game path data.
|parameters = Ped ped, Vehicle vehicle, float driveSpeed, int driveStyle
|parameter1 = Ped ped The Ped to drive the Vehicle.
|parameter2 = Vehicle vehicle The Vehicle to drive with.
|parameter3 = float driveSpeed The speed of driving in meters per second. '''(default = 20)'''
|parameter4 = int driveStyle The AI driving style (behavior) to use. (0-7, ''see details below'')
|return1 = void
|returnFail1 = void
|exampleJSCS = /* example code provided by DrFauli */
addCommandHandler("drivestyle", function(cmdName, params)
{
// current vehicle handle
let thisVeh = null;

// check if player is in a car
if (!localPlayer.vehicle)
{
natives.requestModel(-1685021548) // sabre GT
natives.loadAllObjectsNow();

// spawn the car
thisVeh = createVehicle2(-1685021548, localPlayer.position, true);
thisVeh.heading = localPlayer.heading;

// warp player into driver seat
natives.taskWarpCharIntoCarAsDriver(localPlayer, thisVeh);
}
else
{
thisVeh = localPlayer.vehicle;
}

// get speed and driveStyle from params
let splitParams = params.split(" ");
let driveSpeed = Number(splitParams[0]); // default is 20
let driveStyle = Number(splitParams[1]); // default is 1 (normal driving)

// let the localPlayer drive around with this car
natives.taskCarDriveWander(localPlayer, thisVeh, driveSpeed, driveStyle);

return true;
});
}}

==driving style behavior==
{|class="wikitable"
!|
!|traffic lights
!|other cars
!|pedestrians
!|blinkers
!|when stuck
|-
|0
|ignore
|drive around
|drive around
|not used
|reverse
|-
|1
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|-
|2
|ignore
|drive around
|drive around
|not used
|reverse
|-
|3
|ignore
|ignore
|ignore
|not used
|reverse
|-
|4
|ignore
|stay behind
|stop and honk
|not used
|wait
|-
|5
|stop on red
|drive around
|drive around
|not used
|reverse
|-
|6
|stop+reversing
|drive around
|drive around
|not used
|reverse
|-
|7
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|}

==notes==
*driving styles '''0 and 2''' seem to be identical.
*driving styles '''1 and 7''' seem to be identical.
*using values '''< 0''' or '''> 7''' will behave like '''3'''
There '''could be''' small distance and/or speed differences when "drive around" is used.‎ 
It is also unclear if the AI drivers are able to see objects like light poles or traffic lights while evading.

Client/Natives/IV/taskCarDriveWander

2021-07-03T07:53:29Z

MexTest1: fixed a typo

{{DISPLAYTITLE:natives.taskCarDriveWander}}
{{ScriptItem
|games = iv
|type = function
|name = natives.taskCarDriveWander
|usage = make the vehicle randomly drive around using internal game path data.
|parameters = Ped ped, Vehicle vehicle, float driveSpeed, int driveStyle
|parameter1 = Ped ped The Ped to drive the Vehicle.
|parameter2 = Vehicle vehicle The Vehicle to drive with.
|parameter3 = float driveSpeed The speed of driving in meters per second. '''(default = 20)'''
|parameter4 = int driveStyle The AI driving style (behavior) to use. (0-7, ''see details below'')
|return1 = void
|returnFail1 = void
|exampleJSCS = /* example code provided by DrFauli */
addCommandHandler("drivestyle", function(cmdName, params)
{
// current vehicle handle
let thisVeh = null;

// check if player is in a car
if (!localPlayer.vehicle)
{
natives.requestModel(-1685021548) // sabre GT
natives.loadAllObjectsNow();

// spawn the car
thisVeh = createVehicle2(-1685021548, localPlayer.position, true);
thisVeh.heading = localPlayer.heading;

// warp player into driver seat
natives.taskWarpCharIntoCarAsDriver(localPlayer, thisVeh);
}
else
{
thisVeh = localPlayer.vehicle;
}

// get speed and driveStyle from params
let splitParams = params.split(" ");
let driveSpeed = Number(splitParams[0]); // default is 20
let driveStyle = Number(splitParams[1]); // default is 1 (normal driving)

// let the localPlayer drive around with this car
natives.taskCarDriveWander(localPlayer, thisVeh, driveSpeed, driveStyle);

return true;
});
}}

==driving style behavior==
{|class="wikitable"
!|
!|traffic lights
!|other cars
!|pedestrians
!|blinkers
!|when stuck
|-
|0
|ignore
|drive around
|drive around
|not used
|reverse
|-
|1
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|-
|2
|ignore
|drive around
|drive around
|not used
|reverse
|-
|3
|ignore
|ignore
|ignore
|not used
|reverse
|-
|4
|ignore
|stay behind
|stop and honk
|not used
|wait
|-
|5
|stop on red
|drive around
|drive around
|not used
|reverse
|-
|6
|stop+reversing
|drive around
|drive around
|not used
|reverse
|-
|7
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|}

==notes==
*driving styles '''0 and 2''' seem to be identical.
*driving styles '''1 and 7''' seem to be identical.
*using values '''< 0''' or '''> 7''' will behave like '''3'''
There '''could be''' small distance and/or speed differences when "drive around" is used.‎ 
It is also unclear if the AI drivers are able to see objects like light poles or traffic lights while evading.

Client/Natives/IV/taskCarDriveWander

2021-07-03T07:49:31Z

MexTest1: used template for formatting

{{DISPLAYTITLE:natives.taskCarDriveWander}}
{{ScriptItem
|games = iv
|type = function
|name = natives.taskCarDriveWander
|usage = make the vehicle randomly drive around using internal game path data.
|parameters = Ped ped, Vehicle vehicle, float driveSpeed, int driveStyle
|parameter1 = Ped ped The Ped to drive the Vehicle.
|parameter2 = Vehicle vehicle The Vehicle to drive with.
|parameter3 = float driveSpeed The speed of driving in meters per second. '''(default = 20)'''
|parameter4 = int driveStyle The AI driving style (behavior) to use. (0-7, ''see details below'')
|return1 = void
|returnFail1 = void
|exampleJSCS = /* example code provided by DrFauli */
addCommandHandler("drivestyle", function(cmdName, params)
{
// current vehicle handle
let thisVeh = null;

// check if player is in a car
if (!localPlayer.vehicle)
{
natives.requestModel(-1685021548) // sabre GT
natives.loadAllObjectsNow();

// spawn the car
thisVeh = createVehicle2(-1685021548, localPlayer.position, true);
thisVeh.heading = localPlayer.heading;

// warp player into driver seat
natives.taskWarpCharIntoCarAsDriver(localPlayer, thisVeh);
}
else
{
thisVeh = localPlayer.vehicle;
}

// get speed and driveStyle from params
let splitParams = params.split(" ");
let driveSpeed = Number(splitParams[0]); // default is 20
let driveStyle = Number(splitParams[1]); // default is 1 (normal driving)

// let the localPlayer drive around with this car
natives.taskCarDriveWander(localPLayer, thisVeh, driveSpeed, driveStyle);

return true;
});
}}

==driving style behavior==
{|class="wikitable"
!|
!|traffic lights
!|other cars
!|pedestrians
!|blinkers
!|when stuck
|-
|0
|ignore
|drive around
|drive around
|not used
|reverse
|-
|1
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|-
|2
|ignore
|drive around
|drive around
|not used
|reverse
|-
|3
|ignore
|ignore
|ignore
|not used
|reverse
|-
|4
|ignore
|stay behind
|stop and honk
|not used
|wait
|-
|5
|stop on red
|drive around
|drive around
|not used
|reverse
|-
|6
|stop+reversing
|drive around
|drive around
|not used
|reverse
|-
|7
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|}

==notes==
*driving styles '''0 and 2''' seem to be identical.
*driving styles '''1 and 7''' seem to be identical.
*using values '''< 0''' or '''> 7''' will behave like '''3'''
There '''could be''' small distance and/or speed differences when "drive around" is used.‎ 
It is also unclear if the AI drivers are able to see objects like light poles or traffic lights while evading.

Client/Natives/IV/taskCarDriveWander

2021-07-02T21:53:48Z

MexTest1: /* driving style behavior */

{{DISPLAYTITLE:natives.taskCarDriveWander}}
void natives.taskCarDriveWander(Ped ped, Vehicle veh, float driveSpeed, int driveStyle)

==parameters==
*parameter1 = The Ped to drive the Vehicle.
*parameter2 = The Vehicle to drive with.
*parameter3 = The speed of driving in meters per second. '''(default = 20)'''
*parameter4 = The AI driving style (behavior) to use. (0-7)

==used for==
Make the vehicle randomly drive around using internal game path data.

==driving style behavior==
{|class="wikitable"
!|
!|traffic lights
!|other cars
!|pedestrians
!|blinkers
!|when stuck
|-
|0
|ignore
|drive around
|drive around
|not used
|reverse
|-
|1
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|-
|2
|ignore
|drive around
|drive around
|not used
|reverse
|-
|3
|ignore
|ignore
|ignore
|not used
|full throttle
|-
|4
|ignore
|stay behind
|stop and honk
|not used
|wait
|-
|5
|stop on red
|drive around
|drive around
|not used
|reverse
|-
|6
|stop+reversing
|drive around
|drive around
|not used
|reverse
|-
|7
|stop on red
|stay behind
|stop and honk
|used on intersections
|wait
|}

==notes==
*driving styles '''0 and 2''' seem to be identical.
*driving styles '''1 and 7''' seem to be identical.
*using values '''< 0''' or '''> 7''' will behave like '''3'''
There '''could be''' small distance and/or speed differences when "drive around" is used.‎ 
It is also unclear if the AI drivers are able to see light poles (objects) while evading.

==example code (javascript)==
<nowiki>/* example code provided by DrFauli */
addCommandHandler("drivestyle", function(cmdName, params)
{
// current vehicle/ped handle
let thisVeh = null;
let thisPed = null;

// check if player is in a car
if (!localPlayer.vehicle)
{
natives.requestModel(-1685021548) // sabre GT
natives.requestModel(1424670436); // french tom
natives.loadAllObjectsNow();

// spawn the car
thisVeh = createVehicle2(-1685021548, localPlayer.position, true);
thisVeh.heading = localPlayer.heading;

// spawn the driver
thisPed = natives.createCharInsideCar(thisVeh, 1, 1424670436);

// prevent ped from leaving the car screaming by marking it as mission_char first
natives.setCharAsMissionChar(thisPed, true);
natives.setCharStayInCarWhenJacked(thisPed, true);

// warp player into passenger seat
natives.warpCharIntoCarAsPassenger(localPlayer, thisVeh, 0);
}
else
{
thisVeh = localPlayer.vehicle;
thisPed = thisVeh.getOccupant(0);
}

// get speed and driveStyle from params
let splitParams = params.split(" ");
let driveSpeed = (Number(splitParams[0]) || 20); // default is 20
let driveStyle = (Number(splitParams[1]) || 2);

// let this car drive around
natives.taskCarDriveWander(thisPed, thisVeh, driveSpeed, driveStyle);

return true;
});</nowiki>

Client/Natives/IV/taskCarDriveWander

2021-07-02T21:30:50Z

MexTest1: Created page with "{{DISPLAYTITLE:natives.taskCarDriveWander}} void natives.taskCarDriveWander(Ped ped, Vehicle veh, float driveSpeed, int driveStyle) ==parameters== *parameter1 = The Ped to d..."

{{DISPLAYTITLE:natives.taskCarDriveWander}}
void natives.taskCarDriveWander(Ped ped, Vehicle veh, float driveSpeed, int driveStyle)

==parameters==
*parameter1 = The Ped to drive the Vehicle.
*parameter2 = The Vehicle to drive with.
*parameter3 = The speed of driving in meters per second. '''(default = 20)'''
*parameter4 = The AI driving style (behavior) to use. (0-7)

==used for==
Make the vehicle randomly drive around using internal game path data.

==driving style behavior==
{|class="wikitable"
!|
!|traffic lights
!|other cars
!|pedestrians
!|blinkers
!|when stuck
|-
|0
|ignore
|drive around
|drive around
|not used
|reverse
|-
|1
|stop on red
|stay behind
|stop and honk
|used on crossings
|wait
|-
|2
|ignore
|drive around
|drive around
|not used
|reverse
|-
|3
|ignore
|ignore
|ignore
|not used
|reverse
|-
|4
|ignore
|stay behind
|stop and honk
|not used
|wait
|-
|5
|stop on red
|drive around
|drive around
|not used
|reverse
|-
|6
|stop+reversing
|drive around
|drive around
|not used
|reverse
|-
|7
|stop on red
|stay behind
|stop and honk
|used on crossings
|wait
|}

==notes==
*driving styles '''0 and 2''' seem to be identical.
*driving styles '''1 and 7''' seem to be identical.
*using values '''< 0''' or '''> 7''' will behave like '''3'''
There '''could be''' small distance and/or speed differences when "drive around" is used.‎ 
It is also unclear if the AI drivers are able to see light poles (objects) while evading.

==example code (javascript)==
<nowiki>/* example code provided by DrFauli */
addCommandHandler("drivestyle", function(cmdName, params)
{
// current vehicle/ped handle
let thisVeh = null;
let thisPed = null;

// check if player is in a car
if (!localPlayer.vehicle)
{
natives.requestModel(-1685021548) // sabre GT
natives.requestModel(1424670436); // french tom
natives.loadAllObjectsNow();

// spawn the car
thisVeh = createVehicle2(-1685021548, localPlayer.position, true);
thisVeh.heading = localPlayer.heading;

// spawn the driver
thisPed = natives.createCharInsideCar(thisVeh, 1, 1424670436);

// prevent ped from leaving the car screaming by marking it as mission_char first
natives.setCharAsMissionChar(thisPed, true);
natives.setCharStayInCarWhenJacked(thisPed, true);

// warp player into passenger seat
natives.warpCharIntoCarAsPassenger(localPlayer, thisVeh, 0);
}
else
{
thisVeh = localPlayer.vehicle;
thisPed = thisVeh.getOccupant(0);
}

// get speed and driveStyle from params
let splitParams = params.split(" ");
let driveSpeed = (Number(splitParams[0]) || 20); // default is 20
let driveStyle = (Number(splitParams[1]) || 2);

// let this car drive around
natives.taskCarDriveWander(thisPed, thisVeh, driveSpeed, driveStyle);

return true;
});</nowiki>