Difference between revisions of "AeroGUI"
Line 2: Line 2:
 
{{#set:LOVE Version=0.8.0}}
 
{{#set:LOVE Version=0.8.0}}
 
{{#set:Description=Easy-to-use system to create basic interfaces.}}
 
{{#set:Description=Easy-to-use system to create basic interfaces.}}
 +
 +
= Still under development. Coming soon. =
  
 
AeroGUI is a Love2D GUI library developed by [[User:Aeromcfly]].
 
AeroGUI is a Love2D GUI library developed by [[User:Aeromcfly]].
Line 7: Line 9:
 
<!--__TOC__-->
 
<!--__TOC__-->
  
−
= Objects =
+
== Enumerators ==
 +
Under table GuiEnum
 +
 
 +
<ul><b>GuiEnum</b>
 +
 
 +
<ul>
 +
 
 +
<li>AlignX</li>
 +
<ul>
 +
<li>Left</li>
 +
<li>Right</li>
 +
<li>Center</li>
 +
</ul>
  
−
=== List of all GUI objects ===
+
<li>AlignY</li>
 
<ul>
 
<ul>
−
<li>Screen</li>
+
<li>Top</li>
−
<li>Frame</li>
+
<li>Bottom</li>
−
<li>Label</li>
+
<li>Center</li>
−
<li>Button</li>
 
 
</ul>
 
</ul>
  
 +
</ul></ul>
 +
 +
=== Example ===
 
<source lang="lua">
 
<source lang="lua">
−
local a = 10
+
Object.AlignX = GuiEnum.AlignX.Left
 +
Object.AlignY = GuiEnum.AlignY.Center
 +
 
 +
-- Can also be written by the values of the enums directly:
 +
 
 +
Object.AlignX = "left"
 +
Object.AlignY = "center"
 
</source>
 
</source>
 +
 +
== Objects ==
 +
<i>Locked properties are read-only. Trying to set a new value to them will raise an error.</i>
 +
 +
=== Screen ===
 +
Screen objects act as rendering places for GUI objects. Screens
 +
{|class="wikitable"
 +
!Property
 +
!Locked
 +
!Type
 +
!Description
 +
!Default
 +
|-
 +
|Class
 +
|TRUE
 +
|string
 +
|Class name
 +
|Class name
 +
|-
 +
|Name
 +
|FALSE
 +
|string
 +
|Object name
 +
|(class)_(index)
 +
|-
 +
|Visible
 +
|FALSE
 +
|boolean
 +
|Whether or not the object is drawn on screen
 +
|true
 +
|-
 +
|Position
 +
|FALSE
 +
|UDim2
 +
|Position of the object drawn
 +
|UDim2.new()
 +
|-
 +
|Size
 +
|FALSE
 +
|UDim2
 +
|Size of the object drawn
 +
|UDim2.new(1,0,1,0)
 +
|-
 +
|AbsolutePosition
 +
|TRUE
 +
|Vector2
 +
|Actual position of object drawn
 +
|Vector2.new()
 +
|-
 +
|AbsoluteSize
 +
|TRUE
 +
|Vector2
 +
|Actual size of object drawn
 +
|Vector2.new()
 +
|-
 +
|AlignX
 +
|FALSE
 +
|GuiEnum AlignX
 +
|Horizontal alignment of object
 +
|GuiEnum.AlignX.Left
 +
|-
 +
|AlignY
 +
|FALSE
 +
|GuiEnum AlignY
 +
|Vertical alignment of object
 +
|GuiEnum.AlignY.Top
 +
|-
 +
|Screen
 +
|FALSE
 +
|GuiObject Screen
 +
|The Screen this object renders to (Optional for Screen objects)
 +
|screen (argument)
 +
|-
 +
|ZIndex
 +
|FALSE
 +
|float
 +
|Draw layer of object (draw operations simply sorted by this number)
 +
|0
 +
|-
 +
|ZIndexLast
 +
|TRUE
 +
|float
 +
|Used to check for changes in ZIndex
 +
|0
 +
|}

Revision as of 00:54, 23 March 2012



Still under development. Coming soon.

AeroGUI is a Love2D GUI library developed by User:Aeromcfly.


Enumerators

Under table GuiEnum

    GuiEnum
    • AlignX
      • Left
      • Right
      • Center
    • AlignY
      • Top
      • Bottom
      • Center

Example

Object.AlignX = GuiEnum.AlignX.Left
Object.AlignY = GuiEnum.AlignY.Center

-- Can also be written by the values of the enums directly:

Object.AlignX = "left"
Object.AlignY = "center"

Objects

Locked properties are read-only. Trying to set a new value to them will raise an error.

Screen

Screen objects act as rendering places for GUI objects. Screens

Property Locked Type Description Default
Class TRUE string Class name Class name
Name FALSE string Object name (class)_(index)
Visible FALSE boolean Whether or not the object is drawn on screen true
Position FALSE UDim2 Position of the object drawn UDim2.new()
Size FALSE UDim2 Size of the object drawn UDim2.new(1,0,1,0)
AbsolutePosition TRUE Vector2 Actual position of object drawn Vector2.new()
AbsoluteSize TRUE Vector2 Actual size of object drawn Vector2.new()
AlignX FALSE GuiEnum AlignX Horizontal alignment of object GuiEnum.AlignX.Left
AlignY FALSE GuiEnum AlignY Vertical alignment of object GuiEnum.AlignY.Top
Screen FALSE GuiObject Screen The Screen this object renders to (Optional for Screen objects) screen (argument)
ZIndex FALSE float Draw layer of object (draw operations simply sorted by this number) 0
ZIndexLast TRUE float Used to check for changes in ZIndex 0
Retrieved from "http://www.love2d.org/w/index.php?title=AeroGUI&oldid=8155"