DgsCreateMenu

From Multi Theft Auto: Wiki
Revision as of 07:54, 12 August 2023 by Thisdp (talk | contribs)
Jump to navigation Jump to search

Example DGS Menu.

This function is for creating a DGS menu.

DGS menu is invisible by default. To show menu, use dgsMenuShow.


Syntax

element dgsCreateMenu( 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 DGS menu on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the DGS menu on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the DGS menu. This is affected by the relative argument.
  • height: A float of the height of the DGS menu. 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 DGS menu 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 a dgs-dxmenu element of the created menu if it was successfully created, false otherwise.

Example

DGS = exports.dgs

	local menu = DGS:dgsCreateMenu(200,200,200,600,false)
	local timeItem = DGS:dgsMenuAddItem(menu,"Time","time")
		DGS:dgsMenuAddItem(menu,"Day","t.Day",timeItem)
		DGS:dgsMenuAddItem(menu,"Night","t.Night",timeItem)
	DGS:dgsMenuAddSeparator(menu)
	local weatherItem = DGS:dgsMenuAddItem(menu,"Weather","weather")
		DGS:dgsMenuAddItem(menu,"Clear Day","w.ClearDay",weatherItem)
		DGS:dgsMenuAddItem(menu,"Storming","w.Storming",weatherItem)

	local button = DGS:dgsCreateButton(400,400,100,50,"Right Click Here",false)
	addEventHandler("onDgsMouseClickUp",button,function(button)
		if button == "right" then
			DGS:dgsMenuShow(menu)
		end
	end)
	addEventHandler("onDgsMenuSelect",menu,function(subMenu,uniqueID)
		local command = DGS:dgsMenuGetItemCommand(source,uniqueID)
		if command == "t.Day" then
			setTime(12,0)
		elseif command == "t.Night" then
			setTime(0,0)
		elseif command == "w.ClearDay" then
			setWeather(0)
		elseif command == "w.Storming" then
			setWeather(8)
		else
			return
		end
		DGS:dgsMenuHide(source)
	end,false)
end

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