Multi Theft Auto: Wiki - User contributions [en]

Template:Useful Functions

2012-10-30T04:50:13Z

Drline: fixup

*[[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.
*[[coroutine.resume]] » Fix for hidden coroutine error messages
*[[dxDrawColorText]] » This function draws a dx text with #RRGGBB color codes support.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites.
*[[dxDrawImage3D]] » This function draws a 3D image.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle.
*[[dxGetFontSizeFromHeight]] » This function calculate a font size from given height for dxDraw.
*[[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.
*[[GenerateString]] » With this function you can generate a random string with any characters.
*[[getAge]] » This function calculates the age of a birthday.
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns all the alive players by a client side, so you can store them into a Gridlist or something like that, faster.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getCursorMoveOn]] » This function checks in which way the cursor is currently moving.
*[[getDistanceBetweenPointAndSegment2D]] » Takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
*[[getElementSpeed]] » This function allows you to get element speed in kph or mph units.
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.
*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
*[[getOnlineAdmins]] » This function will give the online admins.
*[[getOnlineStaff]] » Returns all online staff, names separated by two spaces.
*[[getPlayerFromNamePart]] » This function allows you to get player From his Name part.
*[[getPlayersInPhotograph]] » This function gets all the players in a photograph.
*[[getPointFromDistanceRotation]] » Finds a point based on a starting point, direction and distance.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getTimestamp]] » With this function you can get the UNIX timestamp.
*[[getXMLNodes]] » Returns all children of a node
*[[IfElse]] » Returns one of two values based on a boolean expression.
*[[isElementInPhotograph]] » This function checks if an element was in the player's camera picture.
*[[isElementInRange]] » This function allows you to check is the element's range to the main point is smaller than (or as big as) the maximum range.
*[[isLeapYear]] » Checks if the given year is a leap year.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[iterElements]] » Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).
*[[math.neg]] » This function returns the negative value of a number.
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[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.
*[[setTableProtected]] » Protects a table and makes it read-only.
*[[setVehicleGravityPoint]] » This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[string.count]] » This function counts a text from a text.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[switch]] » This function allow the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.condition]] » This function check if both tables is equal. 
*[[table.empty]] » This function check is empty table or not.
*[[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.random]] » This function retrieves a random variable from a table.
*[[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()
*[[convertNumber]] » This function converts large numbers and adds commas to it. (Example: 100000 -> 100,000)
[[Category:Useful Functions]]

Template:Useful Functions

2012-10-30T04:48:33Z

Drline: Undo revision 33856 by Drline (talk)

*[[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.
*[[coroutine.resume]] » Fix for hidden coroutine error messages
*[[dxDrawColorText]] » This function draws a dx text with #RRGGBB color codes support.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites.
*[[dxDrawImage3D]] » This function draws a 3D image.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle.
*[[dxGetFontSizeFromHeight]] » This function calculate a font size from given height for dxDraw.
*[[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.
*[[GenerateString]] » With this function you can generate a random string with any characters.
*[[getAge]] » This function calculates the age of a birthday.
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns all the alive players by a client side, so you can store them into a Gridlist or something like that, faster.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getCursorMoveOn]] » This function checks in which way the cursor is currently moving.
*[[getDistanceBetweenPointAndSegment2D]] » Takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
*[[getElementSpeed]] » This function allows you to get element speed in kph or mph units.
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.
*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
*[[getOnlineAdmins]] » This function will give the online admins.
*[[getOnlineStaff]] » Returns all online staff, names separated by two spaces.
*[[getPlayerFromNamePart]] » This function allows you to get player From his Name part.
*[[getPlayersInPhotograph]] » This function gets all the players in a photograph.
*[[getPointFromDistanceRotation]] » Finds a point based on a starting point, direction and distance.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getTimestamp]] » With this function you can get the UNIX timestamp.
*[[getXMLNodes]] » Returns all children of a node
*[[IfElse]] » Returns one of two values based on a boolean expression.
*[[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)
*[[isElementInRange]] » This function allows you to check is the element's range to the main point is smaller than (or as big as) the maximum range.
*[[isLeapYear]] » Checks if the given year is a leap year.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[iterElements]] » Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).
*[[math.neg]] » This function returns the negative value of a number.
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[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.
*[[setTableProtected]] » Protects a table and makes it read-only.
*[[setVehicleGravityPoint]] » This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[string.count]] » This function counts a text from a text.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[switch]] » This function allow the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.condition]] » This function check if both tables is equal. 
*[[table.empty]] » This function check is empty table or not.
*[[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.random]] » This function retrieves a random variable from a table.
*[[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()
*[[convertNumber]] » This function converts large numbers and adds commas to it. (Example: 100000 -> 100,000)
[[Category:Useful Functions]]

Template:Useful Functions

2012-10-30T04:47:56Z

Drline:

Useful Functions

2012-10-30T04:45:27Z

Drline: wrote it ~~~~

<pageclass class="#228B22"></pageclass>
{{Adding_Pages_to_Categories_and_Templates}}

This page lists functions that are not included in the server or the client, but are still useful.
 
{{Useful_Functions}}
 
[[ES:Funciones Útiles]]
[[ru:Useful Functions]]

Talk:Useful Functions

2012-10-30T04:44:48Z

Drline:

there i wrote isElementInPhotograph()
enjoy
[[User:Drline|Drline]] 04:44, 30 October 2012 (UTC)

IsElementInPhotograph

2012-10-30T04:42:43Z

Drline: /* Required Arguments */

{{Useful Function}}
__NOTOC__
This function can be used with any weapon, but is more accurate when executed when the player shoots the weapon and the weapon is a camera. 
* '''NOTE:''' This is made to be used clientside!.

==Syntax==
<syntaxhighlight lang="lua">bool isElementInPhotograph( element theElement )</syntaxhighlight>

===Required Arguments===
* '''theElement''': The element to be checked.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">function isElementInPhotograph(ele)
local nx, ny, nz = getPedWeaponMuzzlePosition(localPlayer)
if (ele ~= localPlayer) and (isElementOnScreen(ele)) then -- Determine whether the element is even on the screen and not the client
local px, py, pz = getElementPosition(ele)
local _, _, _, _, hit = processLineOfSight(nx, ny, nz, px, py, pz) -- Check if there is a collision between the "camera viewpoint" and the element
if (hit == ele) then -- If it collides with the element return true
return true
end
end
end</syntaxhighlight>
</section>

==Example==
<syntaxhighlight lang="lua">
-- todo
</syntaxhighlight>

Credits: qaisjp's getPlayersInPhotograph() function stripped down by DRLINE

==See Also==
{{Useful_Functions}}

IsElementInPhotograph

2012-10-30T04:41:38Z

Drline: page creation

{{Useful Function}}
__NOTOC__
This function can be used with any weapon, but is more accurate when executed when the player shoots the weapon and the weapon is a camera. 
* '''NOTE:''' This is made to be used clientside!.

==Syntax==
<syntaxhighlight lang="lua">bool isElementInPhotograph( element theElement )</syntaxhighlight>

===Required Arguments===
* none

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">function isElementInPhotograph(ele)
local nx, ny, nz = getPedWeaponMuzzlePosition(localPlayer)
if (ele ~= localPlayer) and (isElementOnScreen(ele)) then -- Determine whether the element is even on the screen and not the client
local px, py, pz = getElementPosition(ele)
local _, _, _, _, hit = processLineOfSight(nx, ny, nz, px, py, pz) -- Check if there is a collision between the "camera viewpoint" and the element
if (hit == ele) then -- If it collides with the element return true
return true
end
end
end</syntaxhighlight>
</section>

==Example==
<syntaxhighlight lang="lua">
-- todo
</syntaxhighlight>

Credits: qaisjp's getPlayersInPhotograph() function stripped down by DRLINE

==See Also==
{{Useful_Functions}}