User:StrixG/dxGetTextSize - Revision history

StrixG at 18:57, 28 April 2020

2020-04-28T18:57:11Z

← Older revision		Revision as of 18:57, 28 April 2020
Line 9:		Line 9:
	float, float dxGetTextSize ( string text, [float width=0, float scaleXY=1.0, float=scaleY=1.0, mixed font="default", bool wordBreak=false, bool colorCoded=false] )		float, float dxGetTextSize ( string text, [float width=0, float scaleXY=1.0, float=scaleY=1.0, mixed font="default", bool wordBreak=false, bool colorCoded=false] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|This syntax requires you to ignore the font argument above\| [[Element/DX font\|font]]:getSize}}}}		{{OOP\|This syntax requires you to ignore the font argument above\| [[Element/DX font\|font]]:getSize}}
	===Required Arguments===		===Required Arguments===
	* '''text:''' A string representing the text for which you wish to retrieve with width for.		* '''text:''' A string representing the text for which you wish to retrieve with width for.

StrixG at 18:57, 28 April 2020

2020-04-28T18:57:06Z

← Older revision		Revision as of 18:57, 28 April 2020
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float dxGetTextSize ( string text, [float ~~scale~~=1, mixed font="default", bool ~~bColorCoded~~=false] )		float, float dxGetTextSize ( string text, [float width=0, float scaleXY=1.0, float=scaleY=1.0, mixed font="default", bool wordBreak=false, bool colorCoded=false] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|This syntax requires you to ignore the font argument above\| [[Element/DX font\|font]]:~~getTextWidth~~}}}}		{{OOP\|This syntax requires you to ignore the font argument above\| [[Element/DX font\|font]]:getSize}}}}
	===Required Arguments===		===Required Arguments===
	* '''text:''' A string representing the text for which you wish to retrieve with width for.		* '''text:''' A string representing the text for which you wish to retrieve with width for.
Line 15:		Line 15:
	==Optional Arguments==		==Optional Arguments==
	{{OptionalArg}}		{{OptionalArg}}
	* '''scale:''' The size of the text.		* '''width:''' The width of the text. Use with ''wordBreak = true''.
			* '''scale:''' The size of the text. 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:		* '''font:''' Either a custom [[DX font]] element or the name of a built-in dx font:
	{{DxFonts}}		{{DxFonts}}
			* '''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.
	* '''bColorCoded:''' Should we exclude color codes from the width? (false will include the hex in the length)		* '''bColorCoded:''' Should we exclude color codes from the width? (false will include the hex in the length)

	===Returns===		===Returns===
	Returns ~~the float of~~ the width of the text (in pixels).		Returns two floats representing the width and height of the text (in pixels).

	==Example==		==Example==
	<section name="Example" class="client" show="true">		<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">
	~~function dxwidth(msg)~~		-- TODO
	~~chatbox = getChatboxLayout()~~
	~~local length = dxGetTextWidth(msg,chatbox["chat_scale"][1])~~
	~~outputChatBox(tostring(length))~~
	~~end~~
	~~addEventHandler("onClientChatMessage",root,dxwidth)~~
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
Line 38:		Line 34:
	==See Also==		==See Also==
	{{Drawing_functions}}		{{Drawing_functions}}

	~~[[hu:dxGetTextWidth]]~~

StrixG: Created page with "NOTOC {{Client function}} This function retrieves the theoretical width and height (in pixels) of a certain piece of text, if it were to be drawn using dxDrawText...."

2020-04-28T18:41:10Z

Created page with "__NOTOC__ {{Client function}} This function retrieves the theoretical width and height (in pixels) of a certain piece of text, if it were to be drawn using dxDrawText...."

New page

__NOTOC__
{{Client function}}
This function retrieves the theoretical width and height (in pixels) of a certain piece of text, if it were to be drawn using [[dxDrawText]].

'''NOTE:''' This function already takes the client's screen resolution into account.

==Syntax==
<syntaxhighlight lang="lua">
float dxGetTextSize ( string text, [float scale=1, mixed font="default", bool bColorCoded=false] )
</syntaxhighlight>
{{OOP|This syntax requires you to ignore the font argument above| [[Element/DX font|font]]:getTextWidth}}}}
===Required Arguments===
* '''text:''' A string representing the text for which you wish to retrieve with width for.

==Optional Arguments==
{{OptionalArg}}
* '''scale:''' The size of the text.
* '''font:''' Either a custom [[DX font]] element or the name of a built-in dx font:
{{DxFonts}}
* '''bColorCoded:''' Should we exclude color codes from the width? (false will include the hex in the length)

===Returns===
Returns the float of the width of the text (in pixels).

==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">
function dxwidth(msg)
chatbox = getChatboxLayout()
local length = dxGetTextWidth(msg,chatbox["chat_scale"][1])
outputChatBox(tostring(length))
end
addEventHandler("onClientChatMessage",root,dxwidth)
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}

[[hu:dxGetTextWidth]]

User:StrixG/dxGetTextSize - Revision history

StrixG at 18:57, 28 April 2020

StrixG at 18:57, 28 April 2020

StrixG: Created page with "__NOTOC__ {{Client function}} This function retrieves the theoretical width and height (in pixels) of a certain piece of text, if it were to be drawn using dxDrawText...."

StrixG: Created page with "NOTOC {{Client function}} This function retrieves the theoretical width and height (in pixels) of a certain piece of text, if it were to be drawn using dxDrawText...."