DgsCreateDetectArea

From Multi Theft Auto: Wiki

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

Multi Language Supports

Animation

3D Interface

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Grid List

Image

Memo

Label

Progress Bar

Radio Button

Scroll Bar

Scroll Pane

Selector

Switch Button

Tab Panel

Window

Plugin

Blur Box

Color Picker

Canvas

Effect 3D

Media Browser

Mask

Nine Slice

Object Preview Supports

QRCode

Remote Image

Rounded Rectangle