DxDrawBorderedText

From Multi Theft Auto: Wiki

This function renders a text with an outline. In order for the text to stay visible continuously, you need to call this function with the same parameters on each frame update (see onClientRender).

Syntax

bool dxDrawBorderedText ( int outline, string text, float left, float top [, float right = left, float bottom = top, int color = white,
                          float scaleXY = 1.0 [, float scaleY = 1.0 ], mixed font = "default", string alignX = "left", string alignY = "top",
                          bool clip = false, bool wordBreak = false, bool postGUI = false, bool colorCoded = false, bool subPixelPositioning = false,
                          float fRotation = 0.0, float fRotationCenterX = 0.0, float fRotationCenterY = 0.0 ] )

Required Arguments

  • outline: an integer representing the text outline weight.
  • text: the text to draw.
  • left: the absolute X coordinate of the top left corner of the text.
  • top: the absolute Y coordinate of the top left corner of the text.

Optional Arguments

  • right: the absolute X coordinate of the right side of the text bounding box. Used for text aligning, clipping and word breaking.
  • bottom: the absolute Y coordinate of the bottom side of the text bounding box. Used for text aligning, clipping and word breaking.
  • color: the color of the text, a value produced by tocolor or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
  • scale: the size of the text.scale: can (optionally) be specified as two floats. i.e. scaleX, scaleY
  • font: Either a custom DX font element or the name of a built-in DX font: Note: Some fonts are incompatible with certain languages such as Arabic.
    • "default": Tahoma
    • "default-bold": Tahoma Bold
    • "clear": Verdana
    • "arial": Arial
    • "sans": Microsoft Sans Serif
    • "pricedown": Pricedown (GTA's theme text)
    • "bankgothic": Bank Gothic Medium
    • "diploma": Diploma Regular
    • "beckett": Beckett Regular
  • alignX: horizontal alignment of the text within the bounding box. Can be "left", "center" or "right".
  • alignY: vertical alignment of the text within the bounding box. Can be "top", "center" or "bottom".
  • clip: if set to true, the parts of the text that don't fit within the bounding box will be cut off.
  • wordBreak: if set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.
  • postGUI: A bool representing whether the text should be drawn on top of or behind any ingame GUI (rendered by CEGUI).
  • colorCoded: Set to true to enable embedded #FFFFFF color codes. Note: clip and wordBreak are forced false if this is set.
  • subPixelPositioning: A bool representing whether the text can be positioned sub-pixel-ly. Looks nicer for moving/scaling animations.
  • fRotation: Rotation
  • fRotationCenterX: Rotation Origin X
  • fRotationCenterY: Rotation Origin Y

Returns

This function doesn't return values.

Code

Click to collapse [-]
Version1
function dxDrawBorderedText (outline, text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
    for oX = (outline * -1), outline do
        for oY = (outline * -1), outline do
            dxDrawText (text, left + oX, top + oY, right + oX, bottom + oY, tocolor(0, 0, 0, 255), scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
        end
    end
    dxDrawText (text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
end
Click to collapse [-]
Version2

This second version makes the outline width adapts to the font scale instead of using a fixed outline width. If you increase the font size, the outline width will also increase. 

function dxDrawBorderedText (outline, text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
    local outline = (scale or 1) * (1.333333333333334 * (outline or 1))
    dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left - outline, top - outline, right - outline, bottom - outline, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
    dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left + outline, top - outline, right + outline, bottom - outline, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
    dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left - outline, top + outline, right - outline, bottom + outline, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
    dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left + outline, top + outline, right + outline, bottom + outline, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
    dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left - outline, top, right - outline, bottom, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
    dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left + outline, top, right + outline, bottom, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
    dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left, top - outline, right, bottom - outline, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
    dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left, top + outline, right, bottom + outline, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
    dxDrawText (text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
end

Author: LordHenry

Example

This example draws a text with outline on the screen.

Click to collapse [-]
Client
local screenX, screenY = guiGetScreenSize()

addEventHandler ("onClientRender", root, function()
	dxDrawBorderedText (3, "mission completed!", 0, 0, screenX, screenY - (screenY * 0.1), tocolor (150, 100, 0, 255), 3, "pricedown", "center", "center", true, false)
	dxDrawBorderedText (3, "$1000000", 0, screenY * 0.1, screenX, screenY, tocolor (255, 255, 255, 255), 3, "pricedown", "center", "center", true, false)
end)

See Also

Table functions

  • isValueInTable » This function returns true if the value exists in the table, false if the value does not exist in the table.
  • setTableToSql » This function is used to save the table in the database (sql).
  • getTableFromSql » This functionality is used to obtain saved tables using the function (SetTableToSql ).
  • rangeToTable » This function converts a string range to a table containing number values.
  • setTableProtected » This function protects a table and makes it read-only.
  • Sort_Functions » These functions are able to sort your tables by a key.
  • table.compare » This function checks whether two given tables are equal.
  • table.copy » This function copies a whole table and all the tables in that table.
  • 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.removeValue » This function removes a specified value from a table.
  • table.size » This function returns the absolute size of a table.
  • table.getRandomRows » This function returns random rows from table.

ACL functions

  • aclGroupClone » This function clone a group to another group with/without ACLs and/or objects.
  • getPlayersInACLGroup » This function returns all players in an ACL group.
  • 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.
  • isPlayerStaff » This function checks if a player is server admin or staff.
  • renameAclGroup » This function gives an existing ACL group a new name.

Account functions

Camera functions

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

Cursor functions

  • getCursorMovedOn » 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.
  • getClipboard » This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.

Data functions

  • byte2human » This function converts an integer (number of bytes) into a human-readable unit.
  • 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.
  • findRotation3D » This function takes two sets of XYZ coordinates. It returns the 3D 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.
  • getDistance » Returns the distance between two elements.
  • 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.
  • getRealMonthH » This function convert english months to arabic months
  • getRealMonthM » This function gives you the real months name
  • 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 hexadecimal numbers (colors, for example) from strings.
  • RGBToHex » This function returns a string representing the color in hexadecimal.
  • 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.
  • toHex » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
  • 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.
  • getDistanceBetweenElements » Esta funcion sirve para obtener la distancia entre dos elementos.

GUI functions

  • centerWindow » This function centers a CEGUI window element responsively in any resolution.
  • guiMoveElement » This function moves guiElement by/like using moveObject.
  • isMouseOnGUICloseButton » This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.
Comboboxes
Gridlists
Labels
  • guiLabelAddEffect » This function add an effects to the gui-label like (shadow, outline).

Marker functions

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.
  • reMap » Re-maps a number from one range to another.
  • math.isPointInPolygon » Check if point is inside polygon or not.
  • math.polygonArea » Compute area of any polygon.
  • math.randomDiff » Generates a pseudo-random integer that's always different from the last random number generated.

Map functions

  • assignLod » This function lets you conveniently generate and apply a LOD model to a mapping object

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.
  • getPlayersInVehicles » This function returns a table of the players insides vehicles from a specified dimension.
  • getGuestPlayers » This function gets a players not login or players Guest .
  • getOnlineAdmins » This function returns a table of all logged-in administrators.
  • getPedEyesPosition » This function allows you to get peds eyes position.
  • 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.
  • 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.
  • isPedAimingNearPed » This is similar to isPedAiming but uses a colshape to be more precise.
  • isPedDrivingVehicle » This function checks if a specified pedestrian is driving a vehicle.
  • isPlayerInTeam » This function checks if a player is in a specified team.

Player functions

  • countPlayersInRange » This function returns the number of players that are within a certain range of the specified coordinates.
  • warpToPlayer» This function make player warp to another player.

Resource functions

Sound functions

Browser functions

  • playVideo » This function plays a video on the screen.

Team functions

Vehicle functions

Weapon functions

XML functions

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

Utility

  • animate » This function allows you to use interpolateBetween without render event and easily used.
  • 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.
  • 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.
  • 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.
  • isMouseInCircle » This function checks if a cursor position is in circular area or not.
  • 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.
  • thisCommandHandlersExist » This method checks a string if this exist as command Handlers
  • vector3:compare » This method checks whether two vectors match, with optional precision.
  • preprocessor » This function allow you to use gcc macros.
  • PlotTrajectoryAtTime » Calculate projectile/water trajectory.


Retrieved from "https://wiki.multitheftauto.com/index.php?title=DxDrawBorderedText&oldid=64217"