DxGetTextSize - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T17:19:26Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:19, 7 November 2024
Line 47:		Line 47:

	[[File:DxGetTextSize.png\|frame\|none\|Example]]		[[File:DxGetTextSize.png\|frame\|none\|Example]]

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.5.7-9.20447\|}}~~

	==See Also==		==See Also==
	{{Drawing_functions}}		{{Drawing_functions}}

StrixG at 00:25, 15 May 2021

2021-05-15T00:25:25Z

← Older revision		Revision as of 00:25, 15 May 2021
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float, float dxGetTextSize ( string text [, float width = 0, float ~~scaleX~~ = 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}}

StrixG at 00:25, 15 May 2021

2021-05-15T00:25:13Z

← Older revision		Revision as of 00:25, 15 May 2021
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float, float dxGetTextSize ( string text [, float width = 0, float scaleX = 1.0, float scaleY = 1.0, mixed font = "default", bool wordBreak = false, bool colorCoded = false] )		float, float dxGetTextSize ( string text [, float width = 0, float scaleX = 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}}

Myonlake at 13:07, 7 February 2021

2021-02-07T13:07:53Z

← Older revision		Revision as of 13:07, 7 February 2021
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	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 scaleX = 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}}
Line 16:		Line 16:
	{{OptionalArg}}		{{OptionalArg}}
	* '''width:''' The width of the text. Use with ''wordBreak = true''.		* '''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'''		* '''scaleX:''' The scale of the text. Scale can also be inputted as a [[Vector2]].
			* '''scaleY:''' The scale 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}}		{{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.		* '''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)		* '''colorCoded:''' Should we exclude color codes from the width? False will include the hex in the length.

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

	==Example==		==Example==

Myonlake: Reverted edits by Myonlake (talk) to last revision by StrixG

2021-02-07T13:06:43Z

Reverted edits by Myonlake (talk) to last revision by StrixG

← Older revision		Revision as of 13:06, 7 February 2021
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~Vector2~~ dxGetTextSize ( string text [, float width = 0, float ~~scaleX~~ = 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}}
Line 16:		Line 16:
	{{OptionalArg}}		{{OptionalArg}}
	* '''width:''' The width of the text. Use with ''wordBreak = true''.		* '''width:''' The width of the text. Use with ''wordBreak = true''.
	* '''~~scaleX~~:''' The ~~scale~~ of the text. ~~Scale can~~ be specified as ~~a [[Vector2]]~~.		* '''scale:''' The size of the text. Can (optionally) be specified as two floats. i.e. '''scaleX, scaleY'''
	* '''scaleY:''' ~~The scale of the text. Scale can be specified as a [[Vector2]].~~
	* '''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.		* '''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.
	* '''~~colorCoded~~:''' 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 ~~a [[Vector2]]~~ representing the width and height of the text in pixels.		Returns two floats representing the width and height of the text (in pixels).

	==Example==		==Example==
Line 37:		Line 36:

	function renderMessage()		function renderMessage()
	local ~~textSize~~ = dxGetTextSize(message, messageWidth, 2, "default", true)		local textWidth, textHeight = dxGetTextSize(message, messageWidth, 2, "default", true)
	~~local textWidth, textHeight = textSize.x, textSize.y~~
	local x = screenWidth - textWidth - messageOffset		local x = screenWidth - textWidth - messageOffset
	local y = screenHeight - textHeight - messageOffset		local y = screenHeight - textHeight - messageOffset

Myonlake: Fix bad return type

2021-02-07T12:35:20Z

Fix bad return type

← Older revision		Revision as of 12:35, 7 February 2021
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~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] )		Vector2 dxGetTextSize ( string text [, float width = 0, float scaleX = 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}}
Line 16:		Line 16:
	{{OptionalArg}}		{{OptionalArg}}
	* '''width:''' The width of the text. Use with ''wordBreak = true''.		* '''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'''		* '''scaleX:''' The scale of the text. Scale can be specified as a [[Vector2]].
			* '''scaleY:''' The scale of the text. Scale can be specified as a [[Vector2]].
	* '''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.		* '''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)		* '''colorCoded:''' Should we exclude color codes from the width? False will include the hex in the length.

	===Returns===		===Returns===
	Returns ~~two floats~~ representing the width and height of the text (in pixels).		Returns a [[Vector2]] representing the width and height of the text in pixels.

	==Example==		==Example==
Line 36:		Line 37:

	function renderMessage()		function renderMessage()
	local ~~textWidth, textHeight~~ = dxGetTextSize(message, messageWidth, 2, "default", true)		local textSize = dxGetTextSize(message, messageWidth, 2, "default", true)
			local textWidth, textHeight = textSize.x, textSize.y
	local x = screenWidth - textWidth - messageOffset		local x = screenWidth - textWidth - messageOffset
	local y = screenHeight - textHeight - messageOffset		local y = screenHeight - textHeight - messageOffset

StrixG at 00:37, 26 October 2020

2020-10-26T00:37:53Z

← Older revision		Revision as of 00:37, 26 October 2020
Line 26:		Line 26:

	==Example==		==Example==
	This example draws a ~~message~~ with black background at the bottom right corner of the screen.		This example draws a text with black background at the bottom right corner of the screen.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local screenWidth, screenHeight = guiGetScreenSize()		local screenWidth, screenHeight = guiGetScreenSize()

StrixG: Example

2020-10-26T00:36:25Z

Example

← Older revision		Revision as of 00:36, 26 October 2020
Line 25:		Line 25:
	Returns two floats representing the width and height 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">~~		This example draws a message with black background at the bottom right corner of the screen.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- ~~TODO~~		local screenWidth, screenHeight = guiGetScreenSize()

			local message = "Incredibly huuuuuuuge message"
			local messageOffset = 32
			local messagePadding = 16
			local messageWidth = 256

			function renderMessage()
			local textWidth, textHeight = dxGetTextSize(message, messageWidth, 2, "default", true)
			local x = screenWidth - textWidth - messageOffset
			local y = screenHeight - textHeight - messageOffset
			dxDrawRectangle(x - messagePadding, y - messagePadding, textWidth + messagePadding * 2, textHeight + messagePadding * 2, 0x80000000) -- draw background
			dxDrawText(message, x, y, x + textWidth, y + textHeight, 0xFFFFFFFF, 2, "default", "left", "top", false, true)
			end
			addEventHandler("onClientRender", root, renderMessage)
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~
			[[File:DxGetTextSize.png\|frame\|none\|Example]]

	==Requirements==		==Requirements==

StrixG at 14:11, 25 October 2020

2020-10-25T14:11:53Z

← Older revision		Revision as of 14:11, 25 October 2020
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{New items\|3.~~0160~~\|1.5.7\|This function retrieves the theoretical width and height (in pixels) of a certain piece of text, if it were to be drawn using [[dxDrawText]].\|20447}}		{{New items\|3.0158\|1.5.7\|This function retrieves the theoretical width and height (in pixels) of a certain piece of text, if it were to be drawn using [[dxDrawText]].\|20447}}

	'''NOTE:''' This function already takes the client's screen resolution into account.		'''NOTE:''' This function already takes the client's screen resolution into account.
Line 31:		Line 31:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

			==Requirements==
			{{Requirements\|n/a\|1.5.7-9.20447\|}}

	==See Also==		==See Also==
	{{Drawing_functions}}		{{Drawing_functions}}

StrixG at 18:59, 28 April 2020

2020-04-28T18:59:08Z

← Older revision		Revision as of 18:59, 28 April 2020
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{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 items\|3.0160\|1.5.7\|This function retrieves the theoretical width and height (in pixels) of a certain piece of text, if it were to be drawn using [[dxDrawText]].\|20447}}

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