guiCreateLabel | Multi Theft Auto: Wiki Skip to content

guiCreateLabel

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.


This function is for creating a new GUI label. A label is simply a piece of text that cannot be edited by the user. If you would like to have a bigger text you'd have to change its font because font size is not supported.

OOP Syntax Help! I don't understand this!

Syntax

element guiCreateLabel ( float x, float y, float width, float height, string text, [ bool relative = false, gui-element parent = nil ] )
Required Arguments
  • x: A float of the 2D x position of the GUI label on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the GUI label on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the GUI label. This is affected by the relative argument.
  • height: A float of the height of the GUI label. This is affected by the relative argument.
  • text: A string of the text that will be displayed by the label.
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • relative (default: false): 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 sizes relative to the parent.
  • parent (default: nil): This is the parent that the gui label 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

  • element: value

Returns an element of the created label if it was successfully created, false otherwise.

Code Examples

shared

Example 1:This example creates a information window and adds two tabs to a "tabPanel" tabpanel, and adds some gui labels to each tab.

local myWindow = guiCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )--create a window which has "Information" in the title bar.
local tabPanel = guiCreateTabPanel ( 0, 0.1, 1, 1, true, myWindow ) --create a tab panel which fills the whole window
local tabMap = guiCreateTab( "Map Information", tabPanel ) -- create a tab named "Map Information" on 'tabPanel'
local tabHelp = guiCreateTab( "Help", tabPanel ) -- create another tab named "Help" on 'tabPanel'
-- adds a label (text) to each tab
guiCreateLabel(0.02,0.04,0.94,0.2,"This is information about the current map",true,tabMap)
guiCreateLabel(0.02,0.04,0.94,0.92,"This is help text.",true,tabHelp)

See Also

GUI Functions