DgsCreateDetectArea: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(4 intermediate revisions by the same user not shown)
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">
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>  


Line 11: 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.


Line 20: 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==
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

Latest revision as of 09:25, 17 January 2021

This function creates a custom detect area for any kind of shapes.

DGS Detect Area Tutorial: https://www.youtube.com/watch?v=9kxKI1epzWI

Syntax

element dgsCreateDetectArea ( float x, float y, float width, float height, bool relative [, element parent = nil ] )

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.
  • 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.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • 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 dgs-dxdetectarea element if detect area was created successfully, false otherwise.

Example

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. 

DGS = exports.dgs
da = DGS:dgsCreateDetectArea (400,300,400,200,false) -- Create Detect Area
DGS:dgsDetectAreaSetFunction(da,[[
	if (mxRlt-0.5)^2+(myRlt-0.5)^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.

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

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

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsCreateDetectArea?oldid=68288"