Docs 1.6

Accidentally uploaded outdated 1.6 docs

docs/docs1_6/objects/Frame/addLayout.md

@@ -0,0 +1,17 @@
+## addLayout
+Adds a new XML Layout into your frame.
+
+#### Parameters: 
+1. `string` Path to your layout
+
+#### Returns:
+1. `frame` The frame being used
+
+#### Usage:
+* Creates a new base frame and adds the mainframe.xml layout
+```lua
+local myFrame = basalt.createFrame():addLayout("mainframe.xml")
+```
+```xml
+<frame layout="mainframe.xml"></frame>
+```

docs/docs1_6/objects/Frame/addLayoutFromString.md

@@ -0,0 +1,14 @@
+## addLayoutFromString
+Adds a new XML Layout as string into your frame.
+
+#### Parameters: 
+1. `string` xml
+
+#### Returns:
+1. `frame` The frame being used
+
+#### Usage:
+* Creates a new base frame and adds the mainframe.xml layout
+```lua
+local myFrame = basalt.createFrame():addLayoutFromString("<button x='12' y='5' bg='black' />")
+```

docs/docs1_6/objects/Frame/addObject.md

@@ -0,0 +1,18 @@
+## add<Object>
+Adds a new object. Don't use add<Object> please use addTheObjectYouNeed For example if you want a new Frame, use
+addFrame, if you want to add a button, use addButton
+
+#### Parameters:
+1. `string` optional - the id if you don't add a id it will autimatically generate one for you
+
+#### Returns:
+1. `object` The new object you've created
+
+#### Usage:
+* Creates some example objects
+```lua
+local main = basalt.createFrame()
+local button = main:addButton()
+local label = main:addLabel()
+local frame = main:addFrame()
+```

docs/docs1_6/objects/Frame/getFocusedObject.md

@@ -0,0 +1,11 @@
+## getFocusedObject
+Gets the currently focused object
+
+#### Returns: 
+1. `object` The currently focused object
+
+#### Usage:
+* Gets the currently focused object from the frame, storing it in a variable
+```lua
+local focusedObject = myFrame:getFocusedObject()
+```

docs/docs1_6/objects/Frame/getLastLayout.md

@@ -0,0 +1,5 @@
+## getLastLayout
+returns a table of all objects this frame has created via xml (useful if you'd like to access all of them for some reason)
+
+#### Returns:
+1. `table` table with objects 

docs/docs1_6/objects/Frame/getObject.md

@@ -0,0 +1,15 @@
+## getObject 
+Returns a child object of the frame
+
+#### Parameters: 
+1. `string` The name of the child object
+
+#### Returns: 
+1. `object | nil` The object with the supplied name, or `nil` if there is no object present with the given name 
+
+#### Usage:
+* Adds a button with id "myFirstButton", then retrieves it again through the frame object
+```lua
+myFrame:addButton("myFirstButton")
+local aButton = myFrame:getObject("myFirstButton")
+```

docs/docs1_6/objects/Frame/removeFocusedObject.md

@@ -0,0 +1,15 @@
+## removeFocusedObject 
+Removes the currently focused object of that frame
+
+#### Returns: 
+1. `frame` The frame being used
+
+#### Usage:
+* Creates a new button then removes the focus from that button when clicking on it
+```lua
+local main = basalt.createFrame()
+local input = main:addInput():setFocus()
+local aButton = main:addButton():onClick(function() 
+    main:removeFocusedObject()
+end)
+```

docs/docs1_6/objects/Frame/removeObject.md

@@ -0,0 +1,18 @@
+## removeObject 
+Removes a child object from the frame
+
+#### Parameters:
+1. `string|object` The name of the child object or the object itself
+
+#### Returns: 
+1. `boolean` Whether the object with the given name was properly removed
+
+#### Usage:
+* Adds a button with the id "myFirstButton", then removes it with the aforementioned id
+```lua
+local main = basalt.createFrame()
+main:addButton("myFirstButton"):setText("Close")
+    :onClick(function(self)
+        main:removeObject("myFirstButton") -- or main:removeObject(self) 
+    end)
+```

docs/docs1_6/objects/Frame/setBar.md

@@ -0,0 +1,30 @@
+## setBar
+Sets the text, background, and foreground of the upper bar of the frame, accordingly.
+
+#### Parameters:
+1. `string` The title text to set the bar to
+2. `number` The background color
+2. `number` The foreground color
+
+#### Returns:
+1. `frame` The frame being used
+
+#### Usage:
+* Set the title to "My first frame!", with a background of black and a foreground of light gray.
+```lua
+frame:setBar("My first Frame!", colors.black, colors.lightGray)
+```
+* Store the frame, use the named frame variable after assigning.
+```lua
+local mainFrame = basalt.createFrame()
+local myFrame = MainFrame:addFrame()
+myFrame:setBar("My first Frame!")
+```
+* This abuses the call-chaining that Basalt uses.
+```lua
+local mainFrame = basalt.createFrame()
+local myFrame = mainFrame:addFrame():setBar("My first Frame!")
+```
+```xml
+<frame barText="My first Frame!" barBG="black" barFG="lightGray"></frame>
+```

docs/docs1_6/objects/Frame/setBarTextAlign.md

@@ -0,0 +1,17 @@
+## setBarTextAlign
+Sets the frame's bar-text alignment
+
+#### Parameters: 
+1. `string` Can be supplied with "left", "center", or "right"
+
+#### Returns: 
+1. `frame` The frame being used
+
+#### Usage:
+* Set the title of myFrame to "My first frame!", and align it to the right.
+```lua
+myFrame:setBar("My first Frame!"):setBarTextAlign("right")
+```
+```xml
+<frame barAlign="right"></frame>
+```

docs/docs1_6/objects/Frame/setFocusedObject.md

@@ -0,0 +1,15 @@
+## setFocusedObject 
+Sets the currently focused object
+
+#### Parameters: 
+1. `object` The child object to focus on
+
+#### Returns: 
+1. `frame` The frame being used
+
+#### Usage:
+* Creates a new button, sets the focused object to the previously mentioned button
+```lua
+local aButton = myFrame:addButton()
+myFrame:setFocusedObject(aButton)
+```

docs/docs1_6/objects/Frame/setMirror.md

@@ -0,0 +1,17 @@
+## setMirror
+mirrors this frame to another peripheral monitor object.
+
+#### Parameters: 
+1. `string` The monitor name ("right", "left",... "monitor_1", "monitor_2",...)
+
+#### Returns:
+1. `frame` The frame being used
+
+#### Usage:
+* Creates mirror of your main frame to a monitor on the left side.
+```lua
+local mainFrame = basalt.createFrame():setMirror("left")
+```
+```xml
+<frame mirror="left"></frame>
+```

docs/docs1_6/objects/Frame/setMonitor.md

@@ -0,0 +1,41 @@
+## setMonitor
+You can set base frames as monitor frames, don't try to use setMonitor on sub frames
+
+#### Parameters: 
+1. `string|table` The monitor name ("right", "left",... "monitor_1", "monitor_2",...) OR a table to create multi-monitors (see example)
+2. `number` optional - a number between 0.5 to 5 which sets the monitor scale
+
+#### Returns:
+1. `frame` The frame being used
+
+#### Usage:
+* Creates a new monitor frame, you can use to show objects on a monitor.
+```lua
+local mainFrame = basalt.createFrame()
+local monitorFrame = basalt.createFrame():setMonitor("right")
+monitorFrame:addLabel():setText("Hellooo!")
+```
+```xml
+<frame monitor="right"></frame>
+```
+
+* Here is a example on how to create mutlimonitors. You always have to start on the top left of your screen and go to the bottom right, which means in this example
+monitor_1 is always your most top left monitor while monitor_6 is your most bottom right monitor.
+
+Table structure:
+local monitors = {
+    [y1] = {x1,x2,x3},
+    [y2] = {x1,x2,x3}
+    ...
+}
+
+```lua
+local monitors = {
+    {"monitor_1", "monitor_2", "monitor_3"},
+    {"monitor_4", "monitor_5", "monitor_6"}
+}
+
+local mainFrame = basalt.createFrame()
+local monitorFrame = basalt.createFrame():setMonitor(monitors)
+monitorFrame:addLabel():setText("Hellooo!")
+```

docs/docs1_6/objects/Frame/setMonitorScale.md

@@ -0,0 +1,15 @@
+## setMonitorScale
+Changes the scale on the the monitor which the frame is attached to
+
+#### Parameters: 
+1. `number` A number from 0.5 to 5
+
+#### Returns:
+1. `frame` The frame being used
+
+#### Usage:
+* Creates a new base frame, sets the frame as a monitor frame and changes the monitor scale
+```lua
+local myFrame = basalt.createFrame()setMonitor("left"):setMonitorScale(2)
+myFrame:addLabel("Monitor scale is bigger")
+```

docs/docs1_6/objects/Frame/setMovable.md

@@ -0,0 +1,17 @@
+## setMovable
+Sets whether the frame can be moved. _In order to move the frame click and drag the upper bar of the frame_
+
+#### Parameters: 
+1. `boolean` Whether the object is movable
+
+#### Returns:
+1. `frame` The frame being used
+
+#### Usage:
+* Creates a frame with id "myFirstFrame" and makes it movable
+```lua
+local myFrame = basalt.createFrame():setMovable(true)
+```
+```xml
+<frame moveable="true"></frame>
+```

docs/docs1_6/objects/Frame/setOffset.md

@@ -0,0 +1,25 @@
+## setOffset
+Sets the frame's coordinate offset. The frame's child objects will receive the frame's coordinate offset. For example, when using a scrollbar, if you use its value to add an offset to a frame, you will get a scrollable frame.
+Objects are also able to ignore the offset by using :ignoreOffset() (For example, you may want to ignore the offset on the scrollbar itself)
+
+The function can also be supplied with negative values
+
+#### Parameters: 
+1. `number` The x direction offset (+/-)
+2. `number` The y direction offset (+/-)
+
+#### Returns:
+1. `frame` The frame being used
+
+#### Usage:
+* Creates a new base frame with x offset of 5 and a y offset of 3
+```lua
+local myFrame = basalt.createFrame():setOffset(5, 3)
+```
+* Creates with x offset of 5 and a y offset of -5 (Meaning if you added a button with y position 5, it would be at y position 0)
+```lua
+local myFrame = basalt.createFrame():setOffset(5, -5)
+```
+```xml
+<frame xOffset="5" yOffset="-5"></frame>
+```

docs/docs1_6/objects/Frame/setScrollAmount.md

@@ -0,0 +1,17 @@
+## setScrollAmount
+Sets the maximum offset it is allowed to scroll
+
+#### Parameters: 
+1. `number` maximum y offset
+
+#### Returns:
+1. `frame` The frame being used
+
+#### Usage:
+* Creates a new base frame and makes it scrollable and sets the maximum amount to 25
+```lua
+local myFrame = basalt.createFrame():setScrollable():setScrollAmount(25)
+```
+```xml
+<frame scrollAmount="25"></frame>
+```

docs/docs1_6/objects/Frame/setScrollable.md

@@ -0,0 +1,17 @@
+## setScrollable
+Makes the frame scrollable with mousewheel.
+
+#### Parameters: 
+1. `bool` scrollable or not
+
+#### Returns:
+1. `frame` The frame being used
+
+#### Usage:
+* Creates a new base frame and makes it scrollable
+```lua
+local myFrame = basalt.createFrame():setScrollable()
+```
+```xml
+<frame scrollable="true"></frame>
+```

docs/docs1_6/objects/Frame/setTheme.md

@@ -0,0 +1,22 @@
+## setTheme
+
+Sets the default theme, of that frame children objects always try to get the theme of its parent frame, if it does not exist it goes to its parent parent frame, and so on until it reaches the basalt manager's theme - which is stored in theme.lua (Please checkout [theme](https://github.com/Pyroxenium/Basalt/blob/master/Basalt/theme.lua) for how it could look like.
+
+#### Parameters:
+
+1. `table` theme layout look into [theme](https://github.com/Pyroxenium/Basalt/blob/master/Basalt/theme.lua) for a example
+
+#### Returns:
+
+1. `frame` The frame being used
+
+#### Usage:
+
+- Creates a new base frame and adds a new theme which only changes the default color of buttons.
+
+```lua
+local myFrame = basalt.createFrame():setTheme({
+    ButtonBG = colors.yellow,
+    ButtonText = colors.red,
+})
+```

docs/docs1_6/objects/Frame/showBar.md

@@ -0,0 +1,17 @@
+## showBar
+Toggles the frame's upper bar
+
+#### Parameters: 
+1. `boolean | nil` Whether the frame's bar is visible or if supplied `nil`, is automatically visible
+
+#### Returns:
+1. `frame` The frame being used
+
+#### Usage:
+* Sets myFrame to have a bar titled "Hello World!" and subsequently displays it.
+```lua
+myFrame:setBar("Hello World!"):showBar()
+```
+```xml
+<frame bar="true"></frame>
+```