Template:Useful Functions

2012-07-13T10:34:19Z

Bartek Drągowski:

*[[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

*[[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.

*[[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.

*[[getElementSpeed]] » This function allows you to get element speed in kph or mph units.

*[[getPlayerFromNamePart]] » This function allows you to get player From his Name part.

*[[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 [http://en.wikipedia.org/wiki/Unix_time UNIX timestamp].

*[[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.

*[[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.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. --[[User:Ransom|Ransom]] 21:45, 2 May 2012 (UTC) 

*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations. 

*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites.

*[[getPlayersInPhotograph]] » This function gets all the players in a photograph.

*[[dxDrawRectangle3D]] » This function draws a 3D rectangle.

*[[dxDrawImage3D]] » This function draws a 3D image.

*[[string.count]] » This function counts a text from a text.

*[[getOnlineAdmins]] » This function will give the online admins.

*[[dxGetFontSizeFromHeight]] » This function calculate a font size from height.
[[Category:Useful Functions]]

DxGetFontSizeFromHeight

2012-07-13T10:32:32Z

Bartek Drągowski: Created page with "<pageclass class="#228B22" subcaption="Useful Function"></pageclass> <lowercasetitle/> __NOTOC__ This function calculate a font size from given height for dxDraw. =..."

<pageclass class="#228B22" subcaption="Useful Function"></pageclass>
<lowercasetitle/>
__NOTOC__
This function calculate a font size from given height for dxDraw.
 

==Syntax==
<syntaxhighlight lang="lua">float dxGetFontSizeFromHeight( int height, [mixed font="default"] )</syntaxhighlight>

===Required Arguments===
* '''height''': The font height in pixels.

===Optional Arguments===
{{OptionalArg}}
* '''font''': Either a custom [[DX font]] element or the name of a built-in dx font:
{{DxFonts}}

===Returns===
Returns an float of the font size.

==Code==
<section name="Clientside Script" class="client" show="true">
<syntaxhighlight lang="lua">
function dxGetFontSizeFromHeight( height, font )
if type( height ) ~= "number" then return false end
if not font then font = "default" end
local ch = dxGetFontHeight( 1, font )
return height/ch
end
</syntaxhighlight>
</section>

==Example==
<section name="Clientside Script" class="client" show="true">
<syntaxhighlight lang="lua">
function render()
local size = dxGetFontSizeFromHeight( 250, "pricedown" )
dxDrawText( "Hello World", 500, 500, 1000, 1000, tocolor(255,128,0,255), size, "pricedown" )
end

addEventHandler( "onClientRender", getRootElement(), render )
</syntaxhighlight>
</section>

Author: bartekPL

==See Also==
{{Useful_Functions}}

[[Category:Useful Functions]]

Multi Theft Auto: Wiki - User contributions [en]

Template:Useful Functions

DxGetFontSizeFromHeight