RemoveVehicleUpgrade: Difference between revisions

Revision as of 17:55, 16 August 2007

Description

This function removes an already existing upgrade from the specified vehicle, eg: nos, hydraulics. Defined in San Andreas\data\maps\veh_mods\veh_mods.ide.

Syntax

bool removeVehicleUpgrade ( vehicle theVehicle, int upgrade )

Required Arguments

theVehicle: The element representing the vehicle you wish to remove the upgrade from
upgrade: The upgrade you wish to remove, currently limited to NOS-5X (1008), NOS-2X (1009), NOS-10X (1010), HYDRAULICS (1087)

Returns

Returns true if the upgrade was successfully removed from the vehicle, otherwise false.

Example

This script defines a 'nos' console command that adds and immediately removes a NOS upgrade to the vehicle that the player who executes the command is sitting in.

function addNOS ( sourcePlayer, command )
    theVehicle = getPlayerOccupiedVehicle ( sourcePlayer )
    if ( theVehicle ) then
        addVehicleUpgrade ( theVehicle, 1010 )     -- NOS 10x
        removeVehicleUpgrade ( theVehicle, 1010 )
    end
end
addCommandHandler ( "nos", addNOS )

@@ Line 1: / Line 1: @@
+{{Server client function}}
 __NOTOC__
 ==Description==
-This function removes an already existing upgrade from the specified vehicle, eg: nos, hyrdraulics. Defined in San Andreas\data\maps\veh_mods\veh_mods.ide.
+This function removes an already existing upgrade from the specified vehicle, eg: nos, hydraulics. Defined in San Andreas\data\maps\veh_mods\veh_mods.ide.
 ==Syntax==
-<syntaxhighlight lang="lua">bool removeVehicleUpgrade ( vehicle, upgrade )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool removeVehicleUpgrade ( vehicle theVehicle, int upgrade )</syntaxhighlight>
 ===Required Arguments===
-*'''vehicle''': The [[element]] representing the [[vehicle]] you wish to remove the upgrade from
+*'''theVehicle''': The [[element]] representing the [[vehicle]] you wish to remove the upgrade from
-*'''upgrade''': The upgrade you wish to remove, currently limited to NOS-5X(1008), NOS-2X(1009), NOS-10X(1010), HYDRAULICS(1087)
+*'''upgrade''': The upgrade you wish to remove, currently limited to NOS-5X (1008), NOS-2X (1009), NOS-10X (1010), HYDRAULICS (1087)
 ==Returns==
-Returns 'true' if the upgrade was successfully removed from the vehicle, otherwise 'false'.
+Returns ''true'' if the upgrade was successfully removed from the vehicle, otherwise ''false''.
 ==Example==
+This script defines a 'nos' console command that adds and immediately removes a NOS upgrade to the vehicle that the player who executes the command is sitting in.
 <syntaxhighlight lang="lua">
-addEventHandler ( "onPlayerConsole", root, "onPlayerConsole" )
+function addNOS ( sourcePlayer, command )
-function onPlayerConsole ( text )
+     theVehicle = getPlayerOccupiedVehicle ( sourcePlayer )
-  command = split ( text, 1, 32 )
+     if ( theVehicle ) then
-  if ( command == "nos" ) then
+        addVehicleUpgrade ( theVehicle, 1010 )     -- NOS 10x
-     vehicle = getPlayerOccupiedVehicle ( source )
+        removeVehicleUpgrade ( theVehicle, 1010 )
-     if ( vehicle ) then
-      addVehicleUpgrade ( vehicle, 1010 ) -- nos-10x
-      removeVehicleUpgrade ( vehicle, 1010 )
      end
-  end
 end
+addCommandHandler ( "nos", addNOS )
 </syntaxhighlight>
 ==See Also==
 {{Vehicle functions}}