DgsCreateEDA

From Multi Theft Auto: Wiki

This function creates an ellipse detect area.

Syntax

element dgsCreateEDA ( 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 image on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the image on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the image. This is affected by the relative argument ( Can be regarded as major axis length of ellipse ).
  • height: A float of the height of the image. 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

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 image 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 ellipse 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.

DGS = exports.dgs
eda = DGS:dgsCreateEDA(400,300,400,200,false) -- Create Ellipse Detect Area
DGS:dgsEDASetDebugModeEnabled(eda,true)  --Set debug mode so that we can see where it is and how it looks like.

This example will create circle detect area and set to debug mode to display a ellipse on the player's screen.

DGS = exports.dgs
eda = DGS:dgsCreateEDA(400,300,200,200,false) -- minor axis equals to major axis
DGS:dgsEDASetDebugModeEnabled(eda,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

Arrow List

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Ellipse Detect Area

Detect Area

Grid List

Image

Memo

Label

Progress Bar

Radio Button

Scroll Bar

Scroll Pane

Switch Button

Tab Panel

Window

Plugin

Media Browser

Rounded Rectangle

Color Picker

Blur Box

Effect 3D

Nine Slice

Object Preview

QRCode

mask