HandlingSetABS: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
{{Needs_Example}}
{{Disabled}}
{{Delete|Function has been removed}}
{{Deprecated|setVehicleHandling}}
Turns ABS on or off for a handling element.
Turns ABS on or off for a handling element.


Line 17: Line 21:
==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function turnABS(thePlayer)
local theVehicle = getPedOccupiedVehicle(thePlayer) -- Get thePlayer vehicle
if not theVehicle then return end -- if the player is not in the vehicle then cancel
local ABS = getVehicleHandlingProperty(theVehicle,"ABS") -- We will use the additional function that you will find under this one. That will be more convenient.
if ABS == true then -- Check, if ABS is turn on then turn its off.
setVehicleHandling(theVehicle,"ABS",false)
outputChatBox("You turn off ABS",thePlayer)
else -- ABS is off. Turn on this.
setVehicleHandling(theVehicle,"ABS",true)
outputChatBox("You turn on ABS",thePlayer)
    end
end
addCommandHandler("ABS",turnABS)
function getVehicleHandlingProperty ( element, property )
    if isElement ( element ) and getElementType ( element ) == "vehicle" and type ( property ) == "string" then -- Make sure there's a valid vehicle and a property string
        local handlingTable = getVehicleHandling ( element ) -- Get the handling as table and save as handlingTable
        local value = handlingTable[property] -- Get the value from the table
       
        if value then -- If there's a value (valid property)
return value -- Return it
        end
    end
   
    return false -- Not an element, not a vehicle or no valid property string. Return failure
end
 
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Handling_functions}}
{{Handling_functions}}
[[Category:Archived]]

Latest revision as of 16:01, 3 November 2024

Accessories-text-editor.png Script Example Missing Function HandlingSetABS needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.


Dialog-warning.png Function has been disabled.


Edit-delete.png This page is marked for deletion.

Reason: Function has been removed
Actions: Delete (Administrators) - Discuss - What links here - Category


Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.

Please use setVehicleHandling instead.

Turns ABS on or off for a handling element.

Syntax

bool handlingSetABS ( handling theHandling, bool ABS )

Required Arguments

  • theHandling: the handling of which you want to toggle the ABS.
  • ABS: true to turn ABS on, false to turn it off.

Returns

Returns true on success, false in case of failure.

Example

function turnABS(thePlayer)
	local theVehicle = getPedOccupiedVehicle(thePlayer) -- Get thePlayer vehicle
	if not theVehicle then return end -- if the player is not in the vehicle then cancel
		local ABS = getVehicleHandlingProperty(theVehicle,"ABS") -- We will use the additional function that you will find under this one. That will be more convenient.
		if ABS == true then -- Check, if ABS is turn on then turn its off.
			setVehicleHandling(theVehicle,"ABS",false)
			outputChatBox("You turn off ABS",thePlayer)
		else -- ABS is off. Turn on this.
	setVehicleHandling(theVehicle,"ABS",true)
	outputChatBox("You turn on ABS",thePlayer)
    end
end
	addCommandHandler("ABS",turnABS)
	
	function getVehicleHandlingProperty ( element, property )
    if isElement ( element ) and getElementType ( element ) == "vehicle" and type ( property ) == "string" then -- Make sure there's a valid vehicle and a property string
        local handlingTable = getVehicleHandling ( element ) -- Get the handling as table and save as handlingTable
        local value = handlingTable[property] -- Get the value from the table
        
        if value then -- If there's a value (valid property) 
			return value -- Return it
        end
    end
    
    return false -- Not an element, not a vehicle or no valid property string. Return failure
end

See Also