DgsCreateRadioButton: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Client function}}
This function creates a radio button.
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsDxCreateRadioButton ( float x, float y, float width, float height, string text, bool relative )
element dgsCreateRadioButton ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textcolor, float scaleX = 1.0, float scaleY = 1.0, element normalUncheckedImage = nil, element hoveringUncheckedImage = nil, element clickedUnCheckedImage = nil, int normalUnCheckedColor = 0xFFFFFFFF, int hoveringUnCheckedColor = 0xFFFFFFFF, int clickedUnCheckedColor = 0xFFB4B4B4, element normalCheckedImage = nil, element  hoveringCheckedImage = nil, element clickedCheckedImage = nil, int normalCheckedColor = 0xFFFFFFFF, int hoveringCheckedColor = 0xFFFFFFFF,int clickedCheckedColor = 0xFFB4B4B4 ] )
</syntaxhighlight>  
</syntaxhighlight>  


Line 12: Line 16:
*'''text:''' The text to be displayed next to the radio button.
*'''text:''' The text to be displayed next to the radio button.
*'''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.
===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the DGS radio button 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.
*'''textcolor:''' An int of the color of the radio button.
*'''scaleX :''' A float of the width of the text scale.
*'''scaleY:''' A float of the height of the text scale.
*'''normalUncheckedImage:''' A material element of the default state of the radio button. (unselected)
*'''hoveringUncheckedImage:''' A material element of the hovered state of the radio button. (unselected)
*'''clickedUnCheckedImage:''' A material element of the clicked state of the radio button. (unselected)
*'''normalUnCheckedColor:''' An integer of the color of the default state of the radio button. (unselected)
*'''hoveringUnCheckedColor:''' An integer of the color of the hovered state of the radio button. (unselected)
*'''clickedUnCheckedColor:''' An integer of the color of the clicked state of the radio button. (unselected)
*'''normalCheckedImage:''' A material element of the default state of the radio button. (selected)
*'''hoveringCheckedImage:''' A material element of the hovered state of the radio button. (selected)
*'''clickedCheckedImage:''' A material element of the clicked state of the radio button. (selected)
*'''normalCheckedColor:''' An integer of the color of the default state of the radio button. (selected)
*'''hoveringCheckedColor:''' An integer of the color of the hovered state of the radio button. (selected)
*'''clickedCheckedColor:''' An integer of the color of the clicked state of the radio button. (selected)


<section name="Client" class="client" show="false">
==Example==
<section name="Client" class="client" show="true">
'''Example 1:'''  
'''Example 1:'''  


Line 19: Line 42:
DGS = exports.dgs
DGS = exports.dgs
showCursor(true)
showCursor(true)
local rb1= DGS:dgsDxCreateRadioButton(500,500,200,30,"aaaa",false)
local rb1 = DGS:dgsCreateRadioButton(500,500,200,30,"aaaa",false)
local rb2 = DGS:dgsDxCreateRadioButton(500,520,200,30,"bbbb",false)
local rb2 = DGS:dgsCreateRadioButton(500,520,200,30,"bbbb",false)
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>

Latest revision as of 14:57, 10 April 2022

This function creates a radio button.

Syntax

element dgsCreateRadioButton ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textcolor, float scaleX = 1.0, float scaleY = 1.0, element normalUncheckedImage = nil, element hoveringUncheckedImage = nil, element clickedUnCheckedImage = nil, int normalUnCheckedColor = 0xFFFFFFFF, int hoveringUnCheckedColor = 0xFFFFFFFF, int clickedUnCheckedColor = 0xFFB4B4B4, element normalCheckedImage = nil, element  hoveringCheckedImage = nil, element clickedCheckedImage = nil, int normalCheckedColor = 0xFFFFFFFF, int hoveringCheckedColor = 0xFFFFFFFF,int clickedCheckedColor = 0xFFB4B4B4 ] )

Required Arguments

Example Dx radio buttons.
  • x: A float of the 2D x position of the radio button on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the radio button on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the text field next to the radio button. This is affected by the relative argument.
  • height: A float of the height of the text field next to the radio button. This is affected by the relative argument.
  • text: The text to be displayed next to the radio button.
  • 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 radio button 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.
  • textcolor: An int of the color of the radio button.
  • scaleX : A float of the width of the text scale.
  • scaleY: A float of the height of the text scale.
  • normalUncheckedImage: A material element of the default state of the radio button. (unselected)
  • hoveringUncheckedImage: A material element of the hovered state of the radio button. (unselected)
  • clickedUnCheckedImage: A material element of the clicked state of the radio button. (unselected)
  • normalUnCheckedColor: An integer of the color of the default state of the radio button. (unselected)
  • hoveringUnCheckedColor: An integer of the color of the hovered state of the radio button. (unselected)
  • clickedUnCheckedColor: An integer of the color of the clicked state of the radio button. (unselected)
  • normalCheckedImage: A material element of the default state of the radio button. (selected)
  • hoveringCheckedImage: A material element of the hovered state of the radio button. (selected)
  • clickedCheckedImage: A material element of the clicked state of the radio button. (selected)
  • normalCheckedColor: An integer of the color of the default state of the radio button. (selected)
  • hoveringCheckedColor: An integer of the color of the hovered state of the radio button. (selected)
  • clickedCheckedColor: An integer of the color of the clicked state of the radio button. (selected)

Example

Click to collapse [-]
Client

Example 1:

DGS = exports.dgs
showCursor(true)
local rb1 = DGS:dgsCreateRadioButton(500,500,200,30,"aaaa",false)
local rb2 = DGS:dgsCreateRadioButton(500,520,200,30,"bbbb",false)

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