GetCursorMoveOn

From Multi Theft Auto: Wiki
Jump to: navigation, search

This function checks in which way the cursor is currently moving.

Syntax

string getCursorMoveOn( )

Returns

Returns left,right,up or down.

Code

Click to collapse [-]
Function source
function getCursorMoveOn()
    if ( isCursorShowing() ) then
	left = "left"
	right = "right"
	up = "up"
	down = "down"
    zero = "nil"
	if getElementData(localPlayer,"movew") == right then
	return right
	elseif getElementData(localPlayer,"movew") == left then
	return left
	elseif getElementData(localPlayer,"movew") == up then
	return up
	elseif getElementData(localPlayer,"movew") == down then
	return down
	elseif getElementData(localPlayer,"movew") == zero then
	return false
	end
	end
end

function executeMoveOn(cursorX,cursorY)
    if ( isCursorShowing() ) then
	setElementData(localPlayer,"moveX",cursorX)
	setElementData(localPlayer,"moveY",cursorY)
	     if cursorX > cX then
         setElementData(localPlayer,"movew",right)
	     elseif cursorX < cX then
	     setElementData(localPlayer,"movew",left)
	     elseif cursorY > cY then
	     setElementData(localPlayer,"movew",down)
	     elseif cursorY < cY then
	     setElementData(localPlayer,"movew",up)
	     end
    end
end
addEventHandler("onClientCursorMove",root,executeMoveOn)

setTimer(
function()
    if ( isCursorShowing() ) then
	local curX = getElementData(localPlayer,"moveX")
	local curY = getElementData(localPlayer,"moveY")
		 if cursorX == cX then
		 setElementData(localPlayer,"movew",zero)
		 elseif cursorY == cY then
		 setElementData(localPlayer,"movew",zero)
		 end
	end
end
,50,0)

function previousM()
   if ( isCursorShowing() ) then
    cX = getElementData(localPlayer,"moveX")
	cY = getElementData(localPlayer,"moveY")
   end
end
setTimer(previousM,50,0)

Example

Click to collapse [-]
Client-side example

This clientside example checks in which way cursor is currently moving.

bindKey ("m", "down",
function()
showCursor( not isCursorShowing() )
end
)

addEventHandler("onClientCursorMove",root,
function()
    if ( isCursorShowing() ) then
	moveOn = getCursorMoveOn()
	outputChatBox("cursor is moving on : " .. moveOn, localPlayer)
	end
end
)


By ronwolf1705.

See Also

ACL functions

  • getPlayerAcls » This function returns a table of all ACL groups on a player.
  • isPlayerInACL » This function checks if a player element is in an ACL group.
  • renameAclGroup » This function gives an existing ACL group a new name.

Account functions

  • setAccountName » This function is used to change an existing account's name.

Camera functions

  • smoothMoveCamera » This function allows you to create a cinematic camera flight.

Cursor functions

  • getCursorMoveOn » This function checks in which way the cursor is currently moving.

Drawing functions

Effects functions

  • attachEffect » This function allows you attach an effect to an element.

Elements functions

  • getElementSpeed » This function returns the specified element's speed in m/s, km/h or mph.
  • getElementsInDimension » This function returns a table of elements that are in the specified dimension.
  • getElementsWithinMarker » This function returns a table of elements that are within a marker's collision shape.
  • isElementInPhotograph » This function checks if an element is in the player's camera picture area.
  • isElementInRange » This function allows you to check if an element's range to a main point is within the maximum range.
  • isElementMoving» This function checks if an element is moving.
  • isElementWithinAColShape» This function checks if an element is within a collision shape element.
  • multi_check » This function checks one element to many, handy and clean.
  • setElementSpeed » This function allows you to set the speed of an element in kph or mph units.

Events

  • onVehicleWeaponFire » This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.

Input functions

  • bindControlKeys » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
  • getBoundControls » This function returns a table of control names that are bound to the specified key.
  • unbindControlKeys » This function allows you to unbind each key bound to a control individually. Use this function with bindControlKeys.

Data functions

  • capitalize » This function capitalizes a given string.
  • convertNumber » This function converts and formats large numbers.
  • convertServerTickToTimeStamp » This function converts server ticks to a unix timestamp.
  • convertTextToSpeech » This function converts the provided text to a speech in the provided language which players can hear.
  • findRotation » This function takes two points and returns the direction from point A to point B.
  • FormatDate » This function formats a date on the basis of a format string and returns it.
  • generateString » This function generates a random string with any characters.
  • generateRandomASCIIString » This function returns a random string which uses ASCII characters.
  • getAge » This function calculates the age of a given birthday.
  • getDistanceBetweenPointAndSegment2D » This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
  • getEasterDate » This function returns easter date monthday and month for a given year.
  • getKeyFromValueInTable » This function returns the key of the specified value in a table.
  • getOffsetFromXYZ » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
  • getPointFromDistanceRotation » This function finds a point based on a starting point, direction and distance.
  • getRGColorFromPercentage »This function returns two integers representing red and green colors according to the specified percentage.
  • getScreenRotationFromWorldPosition » This function returns a screen relative rotation to a world position.
  • getTimestamp » This function returns the UNIX timestamp of a specified date and time.
  • isLeapYear » This function returns a boolean representing if a given year is a leap year.
  • isValidMail » This function checks whether a provided e-mail string is valid.
  • removeHex » This function is used to remove hex color codes from strings.
  • RGBToHex » This function returns a string representing the color in hexadecimal.
  • toHex » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
  • secondsToTimeDesc » This function converts a plain seconds-integer into a user-friendly time description.
  • string.count » This function counts the amount of occurences of a string in a string.
  • string.explode » This function splits a string at a given separator pattern and returns a table with the pieces.
  • switch » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
  • var dump » This function outputs information about one or more variables using outputConsole.
  • wavelengthToRGBA » This function converts a physical wavelength of light to a RGBA color.

GUI functions

  • centerWindow » This function centers a CEGUI window element responsively in any resolution.
Comboboxes
Gridlists

Math functions

  • mathNumber » This function is a workaround for the client-side floating-point precision of 24-bits.
  • math.hypot » This function returns the Hypotenuse of the triangle given by sides x and y.
  • math.percent » This function returns a percentage from two number values.
  • math.round » Rounds a number whereas the number of decimals to keep and the method may be set.

Ped functions

  • getAlivePlayers » This function returns a table of the alive players client-side.
  • getAlivePlayersInTeam » This function returns a table of the alive players in a team.
  • getOnlineAdmins » This function returns a table of all logged-in administrators.
  • getPedMaxHealth » This function returns a pedestrians's maximum health by converting it from their maximum health stat.
  • getPedMaxOxygenLevel » This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.
  • getPlayerFromNamePart » This function returns a player from partial name.
  • getPlayerFromSerial » This function returns a player from their serial.
  • getPlayersInGroup » This function returns all Players In Group .
  • getGuestPlayers » This function gets a players not login or players Guest .
  • getPlayersByData » This function returns a table of players that have the specified data name.
  • getPlayersInPhotograph » This function returns a table of all players in photograph.
  • isPedAiming» This function checks if a pedestrian is aiming their weapon.
  • isPedDrivingVehicle » This function checks if a specified pedestrian is driving a vehicle.
  • isPlayerInTeam » This function checks if a player is in a specified team.
  • isPedAimingNearPed » This is similar to isPedAiming but uses a colshape to be more precise.
  • getPedEyesPosition » This function allows you to get peds eyes position.

Resource functions

Sound functions

Table functions

  • rangeToTable » This function converts a string range to a table containing number values.
  • setTableProtected » This function protects a table and makes it read-only.
  • table.copy » This function copies a whole table and all the tables in that table.
  • table.compare » This function checks whether two given tables are equal.
  • table.empty » This function checks whether a table is empty.
  • 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.merge » This function merges two or more tables together.
  • table.random » This function retrieves a random value from a table.
  • table.size » This function returns the absolute size of a table.
  • table.removeValue » This function removes a specified value from a table.

Team functions

Vehicle funcions

Weapon functions

XML functions

  • getXMLNodes » This function returns all children of a XML node.

Utility

  • Check » This function checks if its arguments are of the right type and calls the error-function if one is not.
  • coroutine.resume » This function applies a fix for hidden coroutine error messages.
  • callClientFunction » This function allows you to call any client-side function from the server's side.
  • callServerFunction » This function allows you to call any server-side function from the client's side.
  • getBanFromName » This functions returns the ban of the given playername.
  • getCurrentFPS » This function returns the frames per second at which GTA: SA is running.
  • IfElse » This function returns one of two values based on a boolean expression.
  • isCursorOnElement » This function checks whether the cursor is in a particular area.
  • isMouseInPosition » This function allows you to check whether the mouse cursor/pointer is within a rectangular position.
  • iterElements » This function returns a time-saving iterator for your for-loops.