DetachTrailerFromVehicle: Difference between revisions

Revision as of 23:08, 15 July 2007

This function detaches an already attached trailer from a vehicle.

Syntax

bool detachTrailerFromVehicle ( vehicle theVehicle, [vehicle theTrailer] )

Required Arguments

theVehicle: The vehicle you wish to detach a trailer from.

Optional Arguments

theTrailer: The trailer you wish to be detached.

Note: If 'theTrailer' is specified, it will only detach if this matches. If it is not specified, any trailer attached to 'theVehicle' will be detached.

Returns

Returns 'true' if the vehicle's were successfully detached, 'false' otherwise.

Example

Example 1: This example will create a trailer and a trailer-tower, attach them, then detach them.

theVehicle = createVehicle ( 515, 500, 500, 40 ) -- create a trailer-tower (roadtrain)
trailer = createVehicle ( 435, 500, 505, 40 ) -- create a trailer
detachTrailerFromVehicle ( theVehicle ) -- detach any old trailers from this vehicle
attachTrailerToVehicle ( theVehicle, trailer ) -- attach them

Example 2:

This example will detach any trailers from a vehicle if it was damaged significantly.
function removeTrailerOnDamage ( loss )
	if loss > 20 then --if the loss was more than 20
		detachTrailerFromVehicle ( source ) --detach any vehicles
	end
end
addEventHandler ( "onVehicleDamage", getRootElement(), removeTrailerOnDamage  ) --add the event handler for onVehicleDamage

@@ Line 15: / Line 15: @@
 ==Example==
-This example will create a trailer and a trailer-tower, attach them, then detach them.
+'''Example 1:''' This example will create a trailer and a trailer-tower, attach them, then detach them.
 <syntaxhighlight lang="lua">
-vehicle = createVehicle ( 515, 500, 500, 40 ) -- create a trailer-tower (roadtrain)
+theVehicle = createVehicle ( 515, 500, 500, 40 ) -- create a trailer-tower (roadtrain)
 trailer = createVehicle ( 435, 500, 505, 40 ) -- create a trailer
-attachTrailerToVehicle ( vehicle, trailer ) -- attach them
+detachTrailerFromVehicle ( theVehicle ) -- detach any old trailers from this vehicle
-detachTrailerFromVehicle ( vehicle ) -- detach any trailer from this vehicle
+attachTrailerToVehicle ( theVehicle, trailer ) -- attach them
 </syntaxhighlight>
+'''Example 2:''' <syntaxhighlight lang="lua">This example will detach any trailers from a vehicle if it was damaged significantly.
+function removeTrailerOnDamage ( loss )
+	if loss > 20 then --if the loss was more than 20
+		detachTrailerFromVehicle ( source ) --detach any vehicles
+	end
+end
+addEventHandler ( "onVehicleDamage", getRootElement(), removeTrailerOnDamage  ) --add the event handler for onVehicleDamage</syntaxhighlight>
 ==See Also==
 {{Vehicle functions}}