Multi Theft Auto: Wiki - User contributions [en]

GuiCreateCheckBox

2010-07-10T05:55:59Z

Lordazamath: Removed from category "Needs example"

__NOTOC__
{{Client function}}
This function creates a [[Element/GUI/Checkbox|checkbox]].

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, bool relative, [element parent = nil] )
</syntaxhighlight>

===Required Arguments===
[[Image:Checkbox.png|thumb|Test Checkbox]]
*'''x:''' A float of the 2D x position of the checkbox on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the checkbox 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 checkbox. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the text field next to the checkbox. This is affected by the ''relative'' argument.
*'''text:''' The text to be displayed next to the checkbox.
*'''selected:''' A boolean representing whether the checkbox created should be selected by default.
*'''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 checkbox 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]] of the checkbox if it was created succesfully, ''false'' otherwise.

==Example==

This example creates a GUI window with a checked and an unchecked checkbox and adds a command to toggle their visibility

<syntaxhighlight lang="lua">
function drawGUI()
local guiWindow = guiCreateWindow(100,100,200,100,"Checkbox test area",false,false) -- create the container window
local checkedBox = guiCreateCheckBox(20,30,150,20,"Checked checkbox",true,false,guiWindow) -- note the parameter after header, it will make the checkbox be checked
local uncheckedBox = guiCreateCheckBox(20,60,150,20,"Unchecked checkbox",false,false,guiWindow) -- not here though
guiSetVisible(guiWindow,false) -- set it invisible just in case
return guiWindow -- we return the guiWindow
end
function cmdGUI(cmd)
if not checkBoxWindow then -- if it hasn't been declared yet
checkBoxWindow = drawGUI() -- we draw the gui window
guiSetVisible(checkBoxWindow,true) -- we set it visible again. Strictly speaking it's not necessary, could have omitted both this and the upper guiSetVisible, but this is needed if you want to cache a window without actually showing it
else -- if we actually have run this function before and declared checkBoxWindow
guiSetVisible(checkBoxWindow, not guiGetVisible(checkBoxWindow)) -- we just toggle the visibility. If it was visible, not visible returns false and thus sets it's visibility false, effectivly hiding it
end
showCursor(not isCursorShowing()) -- similar to above visibility
end
addCommandHandler("guiwindow",cmdGUI) -- trigger cmdGUI function with this command
</syntaxhighlight>

==See Also==
{{GUI_functions}}

FileExists

2010-07-10T05:54:13Z

Lordazamath: Removed from category "Needs example"

__NOTOC__
{{Server function}}
This functions checks whether a specified file exists inside a resource.

==Syntax==
<syntaxhighlight lang="lua">
bool fileExists ( string filePath )
</syntaxhighlight>

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file, whose existence is going to be checked, in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is checked to be in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to check whether a file named 'myfile.txt' exists in the resource 'mapcreator', it can be done from another resource this way: ''fileExists(":mapcreator/myfile.txt")''.
:If the file, whose existence is going to be checked, is in the current resource, only the file path is necessary, e.g. ''fileExists("myfile.txt")''.

===Returns===
Returns ''true'' if the file exists, ''false'' otherwise.

==Example==
This example checks if a file exists in a resource directory
<syntaxhighlight lang="lua">
function checkExistingFile(player,cmd,filename,resourcename)
if not filename then -- if the player didn't include a filename
outputChatBox("ERROR: Syntax '/checkfile filename resourcename(optional)'.",player) -- display error
return false -- stop function
end
if not resourcename then -- if the player didn't specify the resource he wants to check, use current resource
resourcename = getResourceName(resource) --every resource has a predefined global variable called resource that contains the resource pointer for that resource, in other words, the value that getThisResource() function returns.
else
if not getResourceFromName(resourcename) then -- if a resource with that name doesn't exist, output error and stop function
outputChatBox("ERROR: Resource "..resourcename.." doesn't exist.",player) -- output error message
return false -- stop the function here
end
end
-- as it hasn't stopped anywhere, we have both correct resourcename and filename
local exists = fileExists((":%s/%s"):format(resourcename,filename)) -- using shorter format of string.format, see StringLibraryTutorial in lua wiki for that
if exists then
outputChatBox(("The file %q in resource %q exists"):format(filename,resourcename))
else
outputChatBox(("The file %q in resource %q doesn't exist"):format(filename,resourcename))
end
end
addCommandHandler("exists",checkExistingFile)
</syntaxhighlight>

==See Also==
{{File functions}}

FileExists

2010-07-10T05:52:30Z

Lordazamath: /* Example */ added example

GuiCreateCheckBox

2010-07-10T05:37:22Z

Lordazamath: /* Example */ Instead of asking for an example, why not do it yourself?