SetElementSpeed

From Multi Theft Auto: Wiki

Jump to: navigation, search

This function allows you to set moving element speed in kph or mph units.

Syntax

bool setElementSpeed (element theElement, [ int/string unit="kph", int speed=0 ])

Required Arguments

  • theElement: Element you want to set speed of

Optional Arguments

NOTE: When using optional arguments, you must supply all arguments before the one you wish to use. For more information on optional arguments, see Optional Arguments.

  • unit: Units in which speed should be set. This can be 1 or "mph" for mph, any other value for kph.
  • speed: Speed in selected unit

Code

NOTE: This function requires function getElementSpeed in order to work correctly.
Click to collapse [-]
Function source

function setElementSpeed(element, unit, speed) -- only work if element is moving!
	if (unit == nil) then unit = 0 end
	if (speed == nil) then speed = 0 end
	speed = tonumber(speed)
	local acSpeed = getElementSpeed(element, unit)
	if (acSpeed~=false) then -- if true - element is valid, no need to check again
		local diff = speed/acSpeed
		local x,y,z = getElementVelocity(element)
		setElementVelocity(element,x*diff,y*diff,z*diff)
		return true
	end
 
	return false
end

Example

Click to collapse [-]
Server-side example

This example adds command that set player vehicle speed to provided one (in predefined unit kph). Note: It doesn't care if player is driver or passenger.

addCommandHandler("setmyspeed",
function (player, cmd, arg1)
  local veh = getPedOccupiedVehicle(player)
  if (veh) then
    setElementSpeed(veh, "kph", tonumber(arg1))
  else
    outputChatBox("You have to sit in vehicle", player)
  end
end
)

By varez.

See Also

Dialog-information.png This article needs checking.

Reason: The function I added at the bottom should be scripted by someone. --Ransom 21:45, 2 May 2012 (UTC)
  • callClientFunction » This function allows you to call any clientside function from the server's side.
  • callServerFunction » This function allows you to call any server-side function from the client's side.
  • centerWindow » This function center the window in any resolution.
  • Check » This function checks if it's arguments are of the right types and calls the error-function if one isn't.
  • doForAllElements » This function can be used to execute a specified function for all elements of a specified type.
  • dxDrawColorText » This function draws a dx text with #RRGGBB color codes support.
  • findRotation » Takes two points and returns the direction from point A to point B.
  • FormatDate » Formats a date on the basis of a format string and returns it.
  • getAge » This function calculates the age of a birthday.
  • getCursorMoveOn » This function checks in which way the cursor is currently moving.
  • getElementSpeed » This function allows you to get element speed in kph or mph units.
  • IfElse » Returns one of two values based on a boolean expression.
  • isLeapYear » Checks if the given year is a leap year.
  • iterElements » Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).
  • math.round » Rounds a number whereas the number of decimals to keep and the method may be set.
  • onVehicleWeaponFire » This code implements an event that is triggered when a player in a vehicle fires a vehicles weapon.
  • RGBToHex » This function returns a string representing the color in hexadecimal.
  • setElementSpeed » This function allows you to set moving element speed in kph or mph units.
  • setVehicleGravityPoint » This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
  • string.explode » This function splits a string at a given separator pattern and returns a table with the pieces.
  • table.copy » This function copies a whole table and all the tables in that table.
  • table.map » This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.
  • table.size » Finds the absolute size of a table.
  • toHex » This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.
  • var_dump »This function outputs information about one or more variables using outputConsole().
  • multi_check » This function checks one element to many, handy and clean.
  • isElementInPhotograph » This function checks if an element was in the player's camera picture. This needs writing still. --Ransom 21:45, 2 May 2012 (UTC)