DxGetTextWidth - Revision history

Citizen: Preventing scripters to think it returns the width in relative because of the Note

2020-04-05T14:27:19Z

Preventing scripters to think it returns the width in relative because of the Note

← Older revision		Revision as of 14:27, 5 April 2020
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using [[dxDrawText]].		This function retrieves the theoretical width (in pixels) of a certain piece of text, if it were to be drawn using [[dxDrawText]].

	'''NOTE:''' This function ~~is relative to~~ the client's screen resolution.		'''NOTE:''' This function already takes the client's screen resolution into account.

	==Syntax==		==Syntax==
Line 21:		Line 21:

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

	==Example==		==Example==

2019-03-07T11:15:48Z

Undo revision 62332 by JeViCo (talk)

← Older revision		Revision as of 11:15, 7 March 2019
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using [[dxDrawText]].		This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using [[dxDrawText]].
	~~{{Note\|The returned width will be in logical units which are 1.75 times the actual pixel width.}}~~

	'''NOTE:''' This function is relative to the client's screen resolution.		'''NOTE:''' This function is relative to the client's screen resolution.

2019-03-07T11:09:17Z

← Older revision		Revision as of 11:09, 7 March 2019
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using [[dxDrawText]].		This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using [[dxDrawText]].
			{{Note\|The returned width will be in logical units which are 1.75 times the actual pixel width.}}

	'''NOTE:''' This function is relative to the client's screen resolution.		'''NOTE:''' This function is relative to the client's screen resolution.

2018-11-28T12:56:44Z

2016-07-25T11:30:14Z

Added a note about this function being relative to client screen size

← Older revision		Revision as of 11:30, 25 July 2016
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using [[dxDrawText]].		This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using [[dxDrawText]].

			'''NOTE:''' This function is relative to the client's screen resolution.

	==Syntax==		==Syntax==

2015-08-18T12:41:14Z

Example

← Older revision		Revision as of 12:41, 18 August 2015
Line 30:		Line 30:
	outputChatBox(tostring(length))		outputChatBox(tostring(length))
	end		end
	addEventHandler("onClientChatMessage",~~getRootElement()~~,dxwidth)		addEventHandler("onClientChatMessage",root,dxwidth)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

2015-02-07T06:44:54Z

← Older revision		Revision as of 06:44, 7 February 2015
Line 15:		Line 15:
	* '''scale:''' The size of the text.		* '''scale:''' The size of the text.
	* '''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}}
	* '''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)
	~~{{DxFonts}}~~

	===Returns===		===Returns===

2014-11-23T05:16:14Z

add "added in"

← Older revision		Revision as of 05:16, 23 November 2014
Line 7:		Line 7:
	float dxGetTextWidth ( string text, [float scale=1, mixed font="default", bool bColorCoded=false] )		float dxGetTextWidth ( string text, [float scale=1, mixed font="default", bool bColorCoded=false] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|This syntax requires you to ignore the font argument above\| [[Element/DX font\|font]]:getTextWidth}}		{{New feature/item\|3.0141\|1.4.1\|6942\|{{OOP\|This syntax requires you to ignore the font argument above\| [[Element/DX font\|font]]:getTextWidth}}}}
	===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.

2014-11-23T05:15:14Z

add oop

← Older revision		Revision as of 05:15, 23 November 2014
Line 7:		Line 7:
	float dxGetTextWidth ( string text, [float scale=1, mixed font="default", bool bColorCoded=false] )		float dxGetTextWidth ( string text, [float scale=1, mixed font="default", bool bColorCoded=false] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|This syntax requires you to ignore the font argument above\| [[Element/DX font\|font]]:getTextWidth}}
	===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.

2014-11-23T04:50:49Z

add bcolorcoded

← Older revision		Revision as of 04:50, 23 November 2014
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float dxGetTextWidth ( string text, [float scale=1, mixed font="default"] )		float dxGetTextWidth ( string text, [float scale=1, mixed font="default", bool bColorCoded=false] )
	</syntaxhighlight>		</syntaxhighlight>

Line 15:		Line 15:
	* '''scale:''' The size of the text.		* '''scale:''' The size of the text.
	* '''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:
			* '''bColorCoded:''' Should we exclude color codes from the width? (false will include the hex in the length)
	{{DxFonts}}		{{DxFonts}}