DgsIsMouseWithinGUI: Difference between revisions

Latest revision as of 10:18, 20 December 2022

This function returns whether the mouse is in a specific dgs element.

Syntax

bool/table dgsIsMouseWithinGUI( element/table withinElement )

Required Arguments

withinElement: A dgs element or a table of dgs elements that you want to check whether the mouse is within the dgs element(s).

Returns

Returns true if mouse is within the specific dgs element, false otherwise. Or a table of dgs elements that the mouse is within if passing a table of dgs elements into withinElement.

Example 1

DGS = exports.dgs
-- create our button
button = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )

addEventHandler("onClientRender",root,function()
	local str = "within the button :"
	local result = DGS:dgsIsMouseWithinGUI ( button )
	dxDrawText(str..(result and "true" or "false"),400,400)
end)

Example 2

DGS = exports.dgs
-- create our button
button1 = DGS:dgsCreateButton( 0.6, 0.1, 0.2, 0.1, "Output!", true )
button2 = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
buttonTable = {button1,button2}

addEventHandler("onClientRender",root,function()
	local str = "within the buttons :"
	local result = DGS:dgsIsMouseWithinGUI ( buttonTable  )
	for index, button in ipairs(buttonTable) do
		str = str.."\n"..tostring(result[button] and true or false)
	end
	dxDrawText(str,400,400)
end)

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

dgsCreateBrowser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

dgsCreateCanvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

@@ Line 1: / Line 1: @@
+{{Client function}}
 __NOTOC__
-{{Client function}}
 This function returns whether the mouse is in a specific dgs element.
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool dgsIsMouseWithinGUI( element withinElement )
+bool/table dgsIsMouseWithinGUI( element/table withinElement )
 </syntaxhighlight>
-==Required Arguments==
+===Required Arguments===
-*'''withinElement:''' A dgs element that you want to check whether the mouse is inside it.
+*'''withinElement:''' A dgs element or a table of dgs elements that you want to check whether the mouse is within the dgs element(s).
 ===Returns===
-Returns ''true'' if mouse is inside the specific dgs element, ''false'' otherwise.
+Returns ''true'' if mouse is within the specific dgs element, ''false'' otherwise. Or a table of dgs elements that the mouse is within if passing a table of dgs elements into  '''withinElement'''.
-==Example==
+==Example 1==
 <syntaxhighlight lang="lua">
 DGS = exports.dgs
@@ Line 21: / Line 21: @@
 addEventHandler("onClientRender",root,function()
-	local str = "Is within the button :"
+	local str = "within the button :"
 	local result = DGS:dgsIsMouseWithinGUI ( button )
 	dxDrawText(str..(result and "true" or "false"),400,400)
+end)
+</syntaxhighlight>
+==Example 2==
+<syntaxhighlight lang="lua">
+DGS = exports.dgs
+-- create our button
+button1 = DGS:dgsCreateButton( 0.6, 0.1, 0.2, 0.1, "Output!", true )
+button2 = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
+buttonTable = {button1,button2}
+addEventHandler("onClientRender",root,function()
+	local str = "within the buttons :"
+	local result = DGS:dgsIsMouseWithinGUI ( buttonTable  )
+	for index, button in ipairs(buttonTable) do
+		str = str.."\n"..tostring(result[button] and true or false)
+	end
+	dxDrawText(str,400,400)
 end)