GetVehicleTowingVehicle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(OOP)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
This function is used to get the vehicle that is towing another.
This function is used to get the vehicle that is towing another.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">vehicle getVehicleTowingVehicle ( vehicle theVehicle )</syntaxhighlight>
<syntaxhighlight lang="lua">vehicle getVehicleTowingVehicle ( vehicle theVehicle )</syntaxhighlight>
 
{{OOP||[[vehicle]]:getTowingVehicle|towingVehicle}}
===Required Arguments===
===Required Arguments===
*'''theVehicle''': The [[vehicle]] being towed.
*'''theVehicle''': the [[vehicle]] being towed.


==Returns==
==Returns==
Returns the vehicle that 'theVehicle' is being towed by, 'nil' if it isn't being towed.
* The vehicle that ''theVehicle'' is being towed by.
* ''false'' if it isn't being towed.


==Example==
==Example==
This example will create a trailer and a trailer-tower, attach them, then check if they attached.
This example will create a trailer and a trailer-tower, attach them, then check if they attached.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
vehicle = createVehicle ( 515, 500, 500, 40 ) -- create a trailer-tower (roadtrain)
local towingVehicle = createVehicle ( 515, 500, 500, 40 ) -- create a trailer-tower (roadtrain)
trailer = createVehicle ( 435, 500, 505, 40 ) -- create a trailer
local trailer = createVehicle ( 435, 500, 490, 40 ) -- create a trailer
attachTrailerToVehicle ( vehicle, trailer ) -- attach them
attachTrailerToVehicle ( towingVehicle, trailer ) -- attach them
if ( getVehicleTowingVehicle ( trailer ) == vehicle ) then -- if it attached
if ( getVehicleTowingVehicle ( trailer ) == towingVehicle ) then -- if it attached
   outputChatBox ( "the vehicles were attached!" )
   outputChatBox ( "The vehicles were attached!" )
end
end
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 23:12, 17 December 2014

This function is used to get the vehicle that is towing another.

Syntax

vehicle getVehicleTowingVehicle ( vehicle theVehicle )

OOP Syntax Help! I don't understand this!

Method: vehicle:getTowingVehicle(...)
Variable: .towingVehicle


Required Arguments

  • theVehicle: the vehicle being towed.

Returns

  • The vehicle that theVehicle is being towed by.
  • false if it isn't being towed.

Example

This example will create a trailer and a trailer-tower, attach them, then check if they attached. 

local towingVehicle = createVehicle ( 515, 500, 500, 40 ) -- create a trailer-tower (roadtrain)
local trailer = createVehicle ( 435, 500, 490, 40 ) -- create a trailer
attachTrailerToVehicle ( towingVehicle, trailer ) -- attach them
if ( getVehicleTowingVehicle ( trailer ) == towingVehicle ) then -- if it attached
  outputChatBox ( "The vehicles were attached!" )
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleTowingVehicle?oldid=43341"