DgsCreateDetectArea - Revision history

Thisdp at 09:25, 17 January 2021

2021-01-17T09:25:23Z

← Older revision		Revision as of 09:25, 17 January 2021
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsCreateDetectArea ( float x, float y, float width, float height, bool relative, [element parent = nil ] )		element dgsCreateDetectArea ( float x, float y, float width, float height, bool relative [, element parent = nil ] )
	</syntaxhighlight>		</syntaxhighlight>

Thisdp: /* Returns */

2020-03-23T04:33:12Z

Returns

← Older revision		Revision as of 04:33, 23 March 2020
Line 21:		Line 21:

	===Returns===		===Returns===
	Returns [[element]] if detect area was created successfully, ''false'' otherwise.		Returns dgs-dxdetectarea element if detect area was created successfully, ''false'' otherwise.

	==Example==		==Example==

Thisdp: /* Example */

2020-03-23T04:32:51Z

Example

← Older revision		Revision as of 04:32, 23 March 2020
Line 24:		Line 24:

	==Example==		==Example==
	This example will create detect area and set to debug mode to display a ellipse on the player's screen.		This example will create a ellipse detect area using detect area and set to debug mode to display a ellipse on the player's screen.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	DGS = exports.dgs		DGS = exports.dgs
	da = DGS:dgsCreateDetectArea (400,300,400,200,false) -- Create Detect Area		da = DGS:dgsCreateDetectArea (400,300,400,200,false) -- Create Detect Area
	DGS:dgsDetectAreaSetFunction(da,[[		DGS:dgsDetectAreaSetFunction(da,[[
	if mxRlt^2+myRlt^2 < 0.5 then		if (mxRlt-0.5)^2+(myRlt-0.5)^2 < 0.5 then
	return true		return true
	end		end

Thisdp: /* Required Arguments */

2020-03-21T18:36:03Z

Required Arguments

← Older revision		Revision as of 18:36, 21 March 2020
Line 12:		Line 12:
	*'''x:''' A float of the 2D x position of the detect area on a player's screen. This is affected by the ''relative'' argument.		*'''x:''' A float of the 2D x position of the detect area on a player's screen. This is affected by the ''relative'' argument.
	*'''y:''' A float of the 2D y position of the detect area on a player's screen. This is affected by the ''relative'' argument.		*'''y:''' A float of the 2D y position of the detect area on a player's screen. This is affected by the ''relative'' argument.
	*'''width:''' A float of the width of the detect area. This is affected by the ''relative'' argument ~~( Can be regarded as major axis length of ellipse )~~.		*'''width:''' A float of the width of the detect area. This is affected by the ''relative'' argument.
	*'''height:''' A float of the height of the detect area. This is affected by the ''relative'' argument ~~( Can be regarded as minor axis length of ellipse )~~.		*'''height:''' A float of the height of the detect area. This is affected by the ''relative'' argument.
	*'''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 measures relative to the parent.		*'''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 measures relative to the parent.

Thisdp at 18:35, 21 March 2020

2020-03-21T18:35:29Z

← Older revision		Revision as of 18:35, 21 March 2020
Line 3:		Line 3:
	This function creates a custom detect area for any kind of shapes.		This function creates a custom detect area for any kind of shapes.

			'''DGS Detect Area Tutorial:''' https://www.youtube.com/watch?v=9kxKI1epzWI
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Thisdp: /* Example */

2020-03-21T18:23:29Z

Example

← Older revision		Revision as of 18:23, 21 March 2020
Line 26:		Line 26:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	DGS = exports.dgs		DGS = exports.dgs
	da = DGS:dgsCreateDetectArea (400,300,400,200,false) -- Create ~~Ellipse~~ Detect Area		da = DGS:dgsCreateDetectArea (400,300,400,200,false) -- Create Detect Area
	DGS:dgsDetectAreaSetFunction(da,[[		DGS:dgsDetectAreaSetFunction(da,[[
	if mxRlt^2+myRlt^2 < 0.5 then		if mxRlt^2+myRlt^2 < 0.5 then

Thisdp: /* Example */

2020-03-21T18:22:51Z

Example

← Older revision		Revision as of 18:22, 21 March 2020
Line 23:		Line 23:

	==Example==		==Example==
	This example will create ~~ellipse~~ detect area and set to debug mode to display a ellipse on the player's screen.		This example will create detect area and set to debug mode to display a ellipse on the player's screen.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	DGS = exports.dgs		DGS = exports.dgs

Thisdp: Created page with "NOTOC {{Client function}} This function creates a custom detect area for any kind of shapes. ==Syntax== element dgsCreateDetectArea ( float..."

2020-03-21T18:22:42Z

Created page with "__NOTOC__ {{Client function}} This function creates a custom detect area for any kind of shapes. ==Syntax== <syntaxhighlight lang="lua"> element dgsCreateDetectArea ( float..."

New page

__NOTOC__
{{Client function}}
This function creates a custom detect area for any kind of shapes.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateDetectArea ( float x, float y, float width, float height, bool relative, [element parent = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float of the 2D x position of the detect area on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the detect area on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the detect area. This is affected by the ''relative'' argument ( Can be regarded as major axis length of ellipse ).
*'''height:''' A float of the height of the detect area. This is affected by the ''relative'' argument ( Can be regarded as minor axis length of ellipse ).
*'''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 measures relative to the parent.

===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the detect area is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Returns===
Returns [[element]] if detect area was created successfully, ''false'' otherwise.

==Example==
This example will create ellipse detect area and set to debug mode to display a ellipse on the player's screen.
<syntaxhighlight lang="lua">
DGS = exports.dgs
da = DGS:dgsCreateDetectArea (400,300,400,200,false) -- Create Ellipse Detect Area
DGS:dgsDetectAreaSetFunction(da,[[
if mxRlt^2+myRlt^2 < 0.5 then
return true
end
]]) --Custom Detect Area function
DGS:dgsDetectAreaSetDebugModeEnabled(da,true) --Set debug mode so that we can see where it is and how it looks like.
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsCreateDetectArea - Revision history

Thisdp at 09:25, 17 January 2021

Thisdp: /* Returns */

Thisdp: /* Example */

Thisdp: /* Required Arguments */

Thisdp at 18:35, 21 March 2020

Thisdp: /* Example */

Thisdp: /* Example */

Thisdp: Created page with "__NOTOC__ {{Client function}} This function creates a custom detect area for any kind of shapes. ==Syntax== element dgsCreateDetectArea ( float..."

Thisdp: Created page with "NOTOC {{Client function}} This function creates a custom detect area for any kind of shapes. ==Syntax== element dgsCreateDetectArea ( float..."