DgsGetCursorPosition - Revision history

Thisdp: /* Required Arguments */

2023-01-08T04:56:15Z

Required Arguments

← Older revision		Revision as of 04:56, 8 January 2023
Line 10:		Line 10:
	===Required Arguments===		===Required Arguments===
	*'''dgsElement:''' The dgs element that you want to relative to.		*'''dgsElement:''' The dgs element that you want to relative to.
	*'''relative:''' This ~~determines if~~ positioning are relative. If this is true, then all width,height floats must be between 0 and 1, representing positions as a fraction of the '''dgsElement''' size. If false, then the co-ordinates will be absolute pixels on screen.		*'''relative:''' This is whether positioning are relative. If this is true, then all width,height floats must be between 0 and 1, representing positions as a fraction of the '''dgsElement''' size. If false, then the co-ordinates will be absolute pixels on screen.

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

Thisdp: /* Required Arguments */

2023-01-08T04:56:00Z

Required Arguments

← Older revision		Revision as of 04:56, 8 January 2023
Line 10:		Line 10:
	===Required Arguments===		===Required Arguments===
	*'''dgsElement:''' The dgs element that you want to relative to.		*'''dgsElement:''' The dgs element that you want to relative to.
	*'''relative:''' This ~~is whether~~ positioning are relative. If this is true, then all width,height floats must be between 0 and 1, representing positions as a fraction of the '''dgsElement''' size. If false, then the co-ordinates will be absolute pixels on screen.		*'''relative:''' This determines if positioning are relative. If this is true, then all width,height floats must be between 0 and 1, representing positions as a fraction of the '''dgsElement''' size. If false, then the co-ordinates will be absolute pixels on screen.

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

Thisdp: /* Returns */

2023-01-08T04:55:12Z

Returns

← Older revision		Revision as of 04:55, 8 January 2023
Line 13:		Line 13:

	===Returns===		===Returns===
	Returns two ''number''s indicates x and y coordinate if successful, ''false'' otherwise. If '''dgsElement''' is a DGS 3D Interface, you will get 3 extra ''number'' as world position ( x, y, z ) and 1 extra ''bool'' indicates if the mouse is inside the 3d interface.		Returns two ''number''s indicates x and y coordinate if successful, ''false'' otherwise. If the '''dgsElement''' is specified as a DGS 3D Interface, you will get 3 extra ''number'' as world position ( x, y, z ) and 1 extra ''bool'' indicates if the mouse is inside the 3d interface.

	==Example==		==Example==

Thisdp: /* Returns */

2023-01-08T04:53:47Z

Returns

← Older revision		Revision as of 04:53, 8 January 2023
Line 13:		Line 13:

	===Returns===		===Returns===
	Returns two ''number''s indicates x and y coordinate if successful, ''false'' otherwise. If '''dgsElement''' is a DGS 3D Interface, you will get 3 extra ''number'' as world position ( x, y, z ) and 1 extra bool indicates if the mouse is inside the 3d interface.		Returns two ''number''s indicates x and y coordinate if successful, ''false'' otherwise. If '''dgsElement''' is a DGS 3D Interface, you will get 3 extra ''number'' as world position ( x, y, z ) and 1 extra ''bool'' indicates if the mouse is inside the 3d interface.

	==Example==		==Example==

Thisdp: /* Returns */

2023-01-08T04:53:30Z

Returns

← Older revision		Revision as of 04:53, 8 January 2023
Line 13:		Line 13:

	===Returns===		===Returns===
	Returns two ''~~numbers~~'' indicates x and y coordinate if successful, ''false'' otherwise. If dgsElement is a ~~dgs 3d interface, after the 2 numbers~~, you will get 3 ~~float~~ number as world position and 1 bool as if the mouse is inside the 3d interface.		Returns two ''number''s indicates x and y coordinate if successful, ''false'' otherwise. If '''dgsElement''' is a DGS 3D Interface, you will get 3 extra ''number'' as world position ( x, y, z ) and 1 extra bool indicates if the mouse is inside the 3d interface.

	==Example==		==Example==

Thisdp: /* Syntax */

2023-01-08T04:51:52Z

Syntax

← Older revision		Revision as of 04:51, 8 January 2023
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float/int, float/int dgsGetCursorPosition ( [ element dgsElement, bool relative ] )		float/int, float/int [, float, float, float, bool ] dgsGetCursorPosition ( [ element dgsElement, bool relative ] )
	</syntaxhighlight>		</syntaxhighlight>

Line 13:		Line 13:

	===Returns===		===Returns===
	Returns two ''numbers'' indicates x and y coordinate if successful, ''false'' otherwise.		Returns two ''numbers'' indicates x and y coordinate if successful, ''false'' otherwise. If dgsElement is a dgs 3d interface, after the 2 numbers, you will get 3 float number as world position and 1 bool as if the mouse is inside the 3d interface.

	==Example==		==Example==

Thisdp: /* Returns */

2019-07-13T14:44:03Z

Returns

← Older revision		Revision as of 14:44, 13 July 2019
Line 13:		Line 13:

	===Returns===		===Returns===
	Returns two ''numbers'' indicates x and y coordinate, ''false'' otherwise.		Returns two ''numbers'' indicates x and y coordinate if successful, ''false'' otherwise.

	==Example==		==Example==

Thisdp: /* Returns */

2019-07-13T14:43:53Z

Returns

← Older revision		Revision as of 14:43, 13 July 2019
Line 13:		Line 13:

	===Returns===		===Returns===
	Returns ''~~true~~'' ~~if the function was successful~~, ''false'' otherwise.		Returns two ''numbers'' indicates x and y coordinate, ''false'' otherwise.

	==Example==		==Example==

Thisdp: Created page with "{{Client function}} NOTOC This function gets the position of the cursor and can be relative to a dgs element. ==Syntax== float/int, float/in..."

2019-07-13T14:43:09Z

Created page with "{{Client function}} __NOTOC__ This function gets the position of the cursor and can be relative to a dgs element. ==Syntax== <syntaxhighlight lang="lua"> float/int, float/in..."

New page

{{Client function}}
__NOTOC__
This function gets the position of the cursor and can be relative to a dgs element.

==Syntax==
<syntaxhighlight lang="lua">
float/int, float/int dgsGetCursorPosition ( [ element dgsElement, bool relative ] )
</syntaxhighlight>

===Required Arguments===
*'''dgsElement:''' The dgs element that you want to relative to.
*'''relative:''' This is whether positioning are relative. If this is true, then all width,height floats must be between 0 and 1, representing positions as a fraction of the '''dgsElement''' size. If false, then the co-ordinates will be absolute pixels on screen.

===Returns===
Returns ''true'' if the function was successful, ''false'' otherwise.

==Example==
This example creates a dgs window and brings it on top.
<syntaxhighlight lang="lua">
DGS = exports.dgs

local window = DGS:dgsCreateWindow ( 0.4, 0.4, 0.3, 0.3, "Window", true )
addEventHandler("onClientRender",root,function()
local x,y = DGS:dgsGetCursorPosition(window)
dgsSetText(window,"X:"..x..";"Y:"..y)
end)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGetCursorPosition - Revision history

Thisdp: /* Required Arguments */

Thisdp: /* Required Arguments */

Thisdp: /* Returns */

Thisdp: /* Returns */

Thisdp: /* Returns */

Thisdp: /* Syntax */

Thisdp: /* Returns */

Thisdp: /* Returns */

Thisdp: Created page with "{{Client function}} __NOTOC__ This function gets the position of the cursor and can be relative to a dgs element. ==Syntax== float/int, float/in..."

Thisdp: Created page with "{{Client function}} NOTOC This function gets the position of the cursor and can be relative to a dgs element. ==Syntax== float/int, float/in..."