SetHelicopterRotorSpeed: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added OOP syntax)
m (Deprecate)
 
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
{{Client function}}
{{Client function}}
Sets the rotor speed of a helicopter.
Sets the rotor speed of a helicopter.
{{deprecated|setVehicleRotorSpeed}}
{{Note|Setting higher values will cause problems to the client}}


==Syntax==
==Syntax==
Line 15: Line 18:
===Returns===
===Returns===
Returns ''true'' if successful, ''false'' otherwise.
Returns ''true'' if successful, ''false'' otherwise.
==Example==
This example change the helicopter rotor speed.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function rotorSpeed()
  local theVehicle = getPedOccupiedVehicle (localPlayer)
    if theVehicle then
local controller = getVehicleController (theVehicle)
if controller == localPlayer then
  local vehecileType = getVehicleType(theVehicle)
  if vehecileType == "Helicopter" then
setHelicopterRotorSpeed (theVehicle,10)
  end
      end
  end
end
addCommandHandler("rs",rotorSpeed)
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Client vehicle functions}}
{{Client vehicle functions}}

Latest revision as of 13:34, 2 September 2024

Sets the rotor speed of a helicopter.

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 setVehicleRotorSpeed instead.


[[{{{image}}}|link=|]] Note: Setting higher values will cause problems to the client

Syntax

bool setHelicopterRotorSpeed ( vehicle heli, float speed )

OOP Syntax Help! I don't understand this!

Method: vehicle:setHelicopterRotorSpeed(...)
Variable: .helicopterRotorSpeed
Counterpart: getHelicopterRotorSpeed


Required Arguments

  • heli: the helicopter to adjust the rotor of.
  • speed: the new rotor speed. Usual values are 0 if the helicopter stands still, or 0.2 if the rotor is fully spun up. Higher values than normal will not affect the helicopter's handling. Negative values are allowed and will make the rotor spin in the opposite direction (pushing the helicopter down).

Returns

Returns true if successful, false otherwise.

Example

This example change the helicopter rotor speed.

Click to collapse [-]
Client
function rotorSpeed() 
   local theVehicle = getPedOccupiedVehicle (localPlayer)
     if theVehicle then 
	local controller = getVehicleController (theVehicle)
	if controller == localPlayer then 
	   local vehecileType = getVehicleType(theVehicle)
	   if vehecileType == "Helicopter" then 
		setHelicopterRotorSpeed (theVehicle,10)
	   end 
       end 
   end 
end 
addCommandHandler("rs",rotorSpeed)

See Also