AddVehicleUpgrade - Revision history

Pirulax: Add documentation for "all" upgrade

2021-03-19T21:24:46Z

Add documentation for "all" upgrade

← Older revision		Revision as of 21:24, 19 March 2021
Line 4:		Line 4:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool addVehicleUpgrade ( vehicle theVehicle, int upgrade )</syntaxhighlight>		<syntaxhighlight lang="lua">bool addVehicleUpgrade ( vehicle theVehicle, string/int upgrade )</syntaxhighlight>
	{{OOP\|\|[[vehicle]]:addUpgrade}}		{{OOP\|\|[[vehicle]]:addUpgrade}}
	===Required Arguments===		===Required Arguments===
	*'''theVehicle''': The [[element]] representing the [[vehicle]] you wish to add the upgrade to.		*'''theVehicle''': The [[element]] representing the [[vehicle]] you wish to add the upgrade to.
	*'''upgrade''': The id of the upgrade you wish to add~~. (~~1000 to 1193), ''see [[Vehicle Upgrades]]''		*'''upgrade''': The id of the upgrade you wish to add: 1000 to 1193 (''see [[Vehicle Upgrades]]'') or "'''all"''' to add all upgrades.
	'''Note:''' setCameraTarget will behave strangely if you use hydraulics (upgrade id: 1087) server sided and when your camera target is the player inside the vehicle with hydraulics and if the player is not you.		'''Note:''' setCameraTarget will behave strangely if you use hydraulics (upgrade id: 1087) server sided and when your camera target is the player inside the vehicle with hydraulics and if the player is not you.

Myonlake at 17:33, 8 July 2018

2018-07-08T17:33:31Z

← Older revision		Revision as of 17:33, 8 July 2018
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function adds an upgrade to ~~an existing~~ vehicle, ~~eg: nos~~, ~~hyrdraulics~~.		This function adds an upgrade to a [[vehicle]], e.g. nitrous, hydraulics.

	==Syntax==		==Syntax==

Strix: OOP

2014-10-13T15:44:43Z

OOP

← Older revision		Revision as of 15:44, 13 October 2014
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool addVehicleUpgrade ( vehicle theVehicle, int upgrade )</syntaxhighlight>		<syntaxhighlight lang="lua">bool addVehicleUpgrade ( vehicle theVehicle, int upgrade )</syntaxhighlight>
			{{OOP\|\|[[vehicle]]:addUpgrade}}
	===Required Arguments===		===Required Arguments===
	*'''theVehicle''': The [[element]] representing the [[vehicle]] you wish to add the upgrade to.		*'''theVehicle''': The [[element]] representing the [[vehicle]] you wish to add the upgrade to.

Arezu: /* Required Arguments */

2013-07-15T12:22:26Z

Required Arguments

← Older revision		Revision as of 12:22, 15 July 2013
Line 9:		Line 9:
	*'''theVehicle''': The [[element]] representing the [[vehicle]] you wish to add the upgrade to.		*'''theVehicle''': The [[element]] representing the [[vehicle]] you wish to add the upgrade to.
	*'''upgrade''': The id of the upgrade you wish to add. (1000 to 1193), ''see [[Vehicle Upgrades]]''		*'''upgrade''': The id of the upgrade you wish to add. (1000 to 1193), ''see [[Vehicle Upgrades]]''
	'''Note:''' setCameraTarget will behave strangely if you use hydraulics (upgrade id: 1087) server sided and when your camera target is the player inside the vehicle with hydraulics and the player is not you.		'''Note:''' setCameraTarget will behave strangely if you use hydraulics (upgrade id: 1087) server sided and when your camera target is the player inside the vehicle with hydraulics and if the player is not you.

	==Returns==		==Returns==

Arezu: /* Required Arguments */

2013-07-15T12:21:49Z

Required Arguments

← Older revision		Revision as of 12:21, 15 July 2013
Line 9:		Line 9:
	*'''theVehicle''': The [[element]] representing the [[vehicle]] you wish to add the upgrade to.		*'''theVehicle''': The [[element]] representing the [[vehicle]] you wish to add the upgrade to.
	*'''upgrade''': The id of the upgrade you wish to add. (1000 to 1193), ''see [[Vehicle Upgrades]]''		*'''upgrade''': The id of the upgrade you wish to add. (1000 to 1193), ''see [[Vehicle Upgrades]]''
			'''Note:''' setCameraTarget will behave strangely if you use hydraulics (upgrade id: 1087) server sided and when your camera target is the player inside the vehicle with hydraulics and the player is not you.

	==Returns==		==Returns==

Sebassje: /* Example */

2010-06-24T11:07:31Z

Example

← Older revision		Revision as of 11:07, 24 June 2010
Line 20:		Line 20:
	function consoleAddUpgrade ( thePlayer, commandName, id )		function consoleAddUpgrade ( thePlayer, commandName, id )
	-- make sure the player is in a vehicle		-- make sure the player is in a vehicle
	if ( ~~isPlayerInVehicle~~ ( thePlayer ) ) then		if ( isPedInVehicle ( thePlayer ) ) then
	-- convert the given ID from a string to a number		-- convert the given ID from a string to a number
	local id = tonumber ( id )		local id = tonumber ( id )
	-- get the player's vehicle		-- get the player's vehicle
	local theVehicle = ~~getPlayerOccupiedVehicle~~ ( thePlayer )		local theVehicle = getPedOccupiedVehicle ( thePlayer )
	-- add the requested upgrade to the vehicle		-- add the requested upgrade to the vehicle
	local success = addVehicleUpgrade ( theVehicle, id )		local success = addVehicleUpgrade ( theVehicle, id )

EAi at 15:22, 23 February 2008

2008-02-23T15:22:29Z

← Older revision		Revision as of 15:22, 23 February 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function adds an upgrade to an existing vehicle, eg: nos, hyrdraulics~~. These upgrades are listed in San Andreas\data\maps\veh_mods\veh_mods.ide~~.		This function adds an upgrade to an existing vehicle, eg: nos, hyrdraulics.

	==Syntax==		==Syntax==

50pence: /* Required Arguments */

2008-02-22T22:54:37Z

Required Arguments

← Older revision		Revision as of 22:54, 22 February 2008
Line 8:		Line 8:
	===Required Arguments===		===Required Arguments===
	*'''theVehicle''': The [[element]] representing the [[vehicle]] you wish to add the upgrade to.		*'''theVehicle''': The [[element]] representing the [[vehicle]] you wish to add the upgrade to.
	*'''upgrade''': The id of the upgrade you wish to add. (1000 to 1193)		*'''upgrade''': The id of the upgrade you wish to add. (1000 to 1193), ''see [[Vehicle Upgrades]]''

	==Returns==		==Returns==

Arc at 14:49, 21 August 2007

2007-08-21T14:49:40Z

← Older revision		Revision as of 14:49, 21 August 2007
Line 4:		Line 4:

	==Syntax==		==Syntax==
	~~<section name="Server and Client" class="both" show="true">~~
	<syntaxhighlight lang="lua">bool addVehicleUpgrade ( vehicle theVehicle, int upgrade )</syntaxhighlight>		<syntaxhighlight lang="lua">bool addVehicleUpgrade ( vehicle theVehicle, int upgrade )</syntaxhighlight>

Line 13:		Line 12:
	==Returns==		==Returns==
	Returns ''true'' if the upgrade was successfully added to the vehicle, otherwise ''false''.		Returns ''true'' if the upgrade was successfully added to the vehicle, otherwise ''false''.
	~~</section>~~

	==Example==		==Example==
	<section name="Example 1" class="server">		<section name="Example 1" class="server" show="true">
	This serverside function allows the user to get an upgrade by typing a command:		This serverside function allows the user to get an upgrade by typing a command:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 24:		Line 22:
	if ( isPlayerInVehicle ( thePlayer ) ) then		if ( isPlayerInVehicle ( thePlayer ) ) then
	-- convert the given ID from a string to a number		-- convert the given ID from a string to a number
	id = tonumber ( id )		local id = tonumber ( id )
	-- get the player's vehicle		-- get the player's vehicle
	local theVehicle = getPlayerOccupiedVehicle ( thePlayer )		local theVehicle = getPlayerOccupiedVehicle ( thePlayer )
Line 44:		Line 42:
	</section>		</section>

	<section name="Example 2" class="client">		<section name="Example 2" class="client" show="true">
	This client-side script gives vehicles a nitro upgrade whenever they pass through a certain collision shape:		This client-side script gives vehicles a nitro upgrade whenever they pass through a certain collision shape:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Jbeta: Added template, sections, minor changes

2007-08-12T22:00:54Z

Added template, sections, minor changes

← Older revision		Revision as of 22:00, 12 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	This function adds an upgrade to an existing vehicle, eg: nos, hyrdraulics. ~~Defined~~ in San Andreas\data\maps\veh_mods\veh_mods.ide.		{{Server client function}}
			This function adds an upgrade to an existing vehicle, eg: nos, hyrdraulics. These upgrades are listed in San Andreas\data\maps\veh_mods\veh_mods.ide.

	==Syntax==		==Syntax==
			<section name="Server and Client" class="both" show="true">
	<syntaxhighlight lang="lua">bool addVehicleUpgrade ( vehicle theVehicle, int upgrade )</syntaxhighlight>		<syntaxhighlight lang="lua">bool addVehicleUpgrade ( vehicle theVehicle, int upgrade )</syntaxhighlight>

Line 11:		Line 13:
	==Returns==		==Returns==
	Returns ''true'' if the upgrade was successfully added to the vehicle, otherwise ''false''.		Returns ''true'' if the upgrade was successfully added to the vehicle, otherwise ''false''.
			</section>

	==Example==		==Example==
	~~'''~~Example 1~~:'''~~ This ~~example~~ allows the user to get an upgrade by typing a command:		<section name="Example 1" class="server">
			This serverside function allows the user to get an upgrade by typing a command:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- ~~add a console~~ command		-- define the handler function for our command
	function consoleAddUpgrade ( thePlayer, commandName, id )		function consoleAddUpgrade ( thePlayer, commandName, id )
	-- make sure the player is in a vehicle		-- make sure the player is in a vehicle
Line 35:		Line 39:
	end		end
	end		end
			-- add the function as a handler for the "addupgrade" command
	addCommandHandler ( "addupgrade", consoleAddUpgrade )		addCommandHandler ( "addupgrade", consoleAddUpgrade )
	</syntaxhighlight>		</syntaxhighlight>
	~~'''~~Example 2~~:'''~~ This client-side script gives vehicles a nitro upgrade whenever they pass through a certain collision shape:		</section>

			<section name="Example 2" class="client">
			This client-side script gives vehicles a nitro upgrade whenever they pass through a certain collision shape:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- create a collision shape		-- create a collision shape
Line 51:		Line 59:
	addEventHandler ( "onClientColShapeHit", nitroColShape, onNitroColShapeHit )		addEventHandler ( "onClientColShapeHit", nitroColShape, onNitroColShapeHit )
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Vehicle functions}}		{{Vehicle functions}}