DxGetTextWidth: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 21: Line 21:


==Example==  
==Example==  
<section name="Example" class="client" show="true">
This will show you the width of a message in a normal chatbox sent by a player
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function dxwidth(msg)
    chatbox = getChatboxLayout()
    local length = dxGetTextWidth(msg,chatbox["chat_scale"][1])
    outputChatBox(tostring(length))
end
addEventHandler("onPlayerChat",getRootElement(),dxwidth)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Drawing_functions}}
{{Drawing_functions}}
[[Category:Needs_Example]]
[[Category:Needs_Example]]

Revision as of 15:07, 14 January 2011

This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using dxDrawText.

Syntax

float dxGetTextWidth ( string text, [float scale=1, string font="default"] )

Required Arguments

  • text: A string representing the text for which you wish to retrieve with width for.

Optional Arguments

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

  • scale: The size of the text.
  • font: The dx font for the text.
    • "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
    • "unifont": Unifont

Returns

Returns the float of the width of the text.

Example

Click to collapse [-]
Example

This will show you the width of a message in a normal chatbox sent by a player 

function dxwidth(msg)
    chatbox = getChatboxLayout()
    local length = dxGetTextWidth(msg,chatbox["chat_scale"][1])
    outputChatBox(tostring(length))
end
addEventHandler("onPlayerChat",getRootElement(),dxwidth)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/DxGetTextWidth?oldid=25091"