DgsGetSize - Revision history

Lettify: DGS OOP Syntax changing

2021-05-03T19:02:33Z

DGS OOP Syntax changing

← Older revision		Revision as of 19:02, 3 May 2021
Line 6:		Line 6:
	float, float dgsGetSize ( element theElement, bool relative )		float, float dgsGetSize ( element theElement, bool relative )
	</syntaxhighlight>		</syntaxhighlight>
	{{DGS/OOP\|It variables is a conjunction:		{{DGS/OOP\|
			Note = It variables is a conjunction:
	*Relative: '''size.relative''' (whether element size is relative)		*Relative: '''size.relative''' (whether element size is relative)
	*Width: '''size.w''' or '''size.width'''		*Width: '''size.w''' or '''size.width'''
	*Height: '''size.h''' or '''size.height'''		*Height: '''size.h''' or '''size.height'''
	*toVector: '''size.toVector''' [returns a [[Vector/Vector2\|Vector]], use <code>size.toVector.x</code> (for width) and <code>size.toVector.y</code> (for height)]		*toVector: '''size.toVector''' [returns a [[Vector/Vector2\|Vector]], use <code>size.toVector.x</code> (for width) and <code>size.toVector.y</code> (for height)]\|
	\|DGSElement:getSize\|\|size\|dgsSetSize}}		Method = DGSElement:getSize\|
			Variable = size\|
			Counterpart = dgsSetSize
			}}

	===Required Arguments===		===Required Arguments===

Lettify: DGS (OOP Syntax)/(Template Organization) Mission

2021-04-16T20:32:37Z

DGS (OOP Syntax)/(Template Organization) Mission

← Older revision		Revision as of 20:32, 16 April 2021
Line 5:		Line 5:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float, float dgsGetSize ( element theElement, bool relative )		float, float dgsGetSize ( element theElement, bool relative )
	</syntaxhighlight>		</syntaxhighlight>
			{{DGS/OOP\|It variables is a conjunction:
			*Relative: '''size.relative''' (whether element size is relative)
			*Width: '''size.w''' or '''size.width'''
			*Height: '''size.h''' or '''size.height'''
			*toVector: '''size.toVector''' [returns a [[Vector/Vector2\|Vector]], use <code>size.toVector.x</code> (for width) and <code>size.toVector.y</code> (for height)]
			\|DGSElement:getSize\|\|size\|dgsSetSize}}

	===Required Arguments===		===Required Arguments===
Line 25:		Line 31:

	==See Also==		==See Also==
	{{~~DGSFUNCTIONS~~}}
			===<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>===
			{{DGS General Functions}}

			===<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>===
			{{DGS Events/General}}

Thisdp at 03:29, 6 November 2018

2018-11-06T03:29:07Z

← Older revision		Revision as of 03:29, 6 November 2018
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float float dgsGetSize ( element theElement, bool relative )		float, float dgsGetSize ( element theElement, bool relative )
	</syntaxhighlight>		</syntaxhighlight>

Thisdp: /* Example */

2018-01-21T03:54:04Z

Example

← Older revision		Revision as of 03:54, 21 January 2018
Line 18:		Line 18:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	DGS = exports.dgs		DGS = exports.dgs
	local window = DGS:~~dgsDxCreateWindow~~ ( 0, 0, (math.random ( 0, 100 ) / 100), (math.random ( 0, 100 ) / 100), "test", true )		local window = DGS:dgsCreateWindow ( 0, 0, (math.random ( 0, 100 ) / 100), (math.random ( 0, 100 ) / 100), "test", true )
	-- Create the window		-- Create the window
	local x, y = DGS:dgsGetSize ( window, false ) -- Get the dgs window size		local x, y = DGS:dgsGetSize ( window, false ) -- Get the dgs window size

Thisdp at 14:17, 18 January 2018

2018-01-18T14:17:08Z

← Older revision		Revision as of 14:17, 18 January 2018
Line 9:		Line 9:
	===Required Arguments===		===Required Arguments===
	*'''theElement:''' The DGS element to get size of.		*'''theElement:''' The DGS element to get size of.
	*'''relative:''' ~~A boolean representing~~ whether ~~the size should~~ be relative to the ~~element's~~ parent ~~width, or an absolute size in pixels~~.		*'''relative:''' This is whether sizes and positioning are relative. If this is true, then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.

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

Thisdp: Created page with "{{Client function}} NOTOC This function gets the size of a DGS element. ==Syntax== float float dgsGetSize ( element theElement, bool relative..."

2017-08-09T03:13:48Z

Created page with "{{Client function}} __NOTOC__ This function gets the size of a DGS element. ==Syntax== <syntaxhighlight lang="lua"> float float dgsGetSize ( element theElement, bool relative..."

New page

{{Client function}}
__NOTOC__
This function gets the size of a DGS element.
==Syntax==
<syntaxhighlight lang="lua">
float float dgsGetSize ( element theElement, bool relative )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The DGS element to get size of.
*'''relative:''' A boolean representing whether the size should be relative to the element's parent width, or an absolute size in pixels.

===Returns===
Returns the DGS element size ''x'' and ''y'' if the function has been successful, ''false'' otherwise.

==Example==
This example creates a random sized dgs window and outputs its size to the chatbox.
<syntaxhighlight lang="lua">
DGS = exports.dgs
local window = DGS:dgsDxCreateWindow ( 0, 0, (math.random ( 0, 100 ) / 100), (math.random ( 0, 100 ) / 100), "test", true )
-- Create the window
local x, y = DGS:dgsGetSize ( window, false ) -- Get the dgs window size
outputChatBox ( "Window size: " .. x .. " " .. y ) --output the dgs window size
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}