114 posts
Posted 21 August 2013 - 10:42 PM
SAPI: Simple API
I made this out of the need of an all purpose API, and, lacking a better name for this, called it Simple API or SAPI. This adds buttons, scrollbars, switches, event handling and more. This was written in lua oop, so all functions will be called with a ":" not a "."
Please note that all objects are self contained and self drawn and event handled through use of two functions included with this api
1 Setting Up API:
For the sake of convinience and to use this api as I document it below, DO NOT USE OS.LOADAPI!!!! Please use shell.run(<Whatever you called SAPI here>)! This will make it easier to use, and again, will allow use exactly as below. If you ignore this warning, don't complain about the code in the documentation below not working! Thank you.
2 Documentation
Loading the API
This should be obvious to all who read section one, posting it so that noone gets confused, use shell.run not os.loadapi.
2.2 Labels:
Creates a new label as variable x:
2.3 Buttons:
Creates a new button as variable x:
2.4 ScrollBars:
Creates a new Horizontal ScrollBar as variable x:
2.5 Switches:
Creates a new Horizontal Switch as variable x:
2.6 EventBuffer:
Creates the EventBuffer as variable x:
2.7 InterfaceEntities:
Creates the InterfaceEntity as variable x:
2.8 Drawing:
Draws a string on the screen:
2.9 Term function additions(british spellings too)
Each listed function should be obvious how it works
Changelog: here
Please leave comments and what you guys think should be added next.
To Be Added:
Nothing Planned As Of Yet
Get it here
File is simply Called SAPI.
Thanks!
I made this out of the need of an all purpose API, and, lacking a better name for this, called it Simple API or SAPI. This adds buttons, scrollbars, switches, event handling and more. This was written in lua oop, so all functions will be called with a ":" not a "."
Please note that all objects are self contained and self drawn and event handled through use of two functions included with this api
1 Setting Up API:
For the sake of convinience and to use this api as I document it below, DO NOT USE OS.LOADAPI!!!! Please use shell.run(<Whatever you called SAPI here>)! This will make it easier to use, and again, will allow use exactly as below. If you ignore this warning, don't complain about the code in the documentation below not working! Thank you.
2 Documentation
Spoiler
2.1 First Things First:Loading the API
This should be obvious to all who read section one, posting it so that noone gets confused, use shell.run not os.loadapi.
2.2 Labels:
Creates a new label as variable x:
x = CCLabel:New(<XPosition>, <YPosition>, <Text>[,<TextColor>[,<BackgroundColor>]])CCInterfaceEntities:AddLabel(x)2.3 Buttons:
Creates a new button as variable x:
x = CCButton:New(<XPostion>, <YPosition>, <TextInsideButton>, <OnClickAction>, [<TextColor>[,<BackgroundColor>[,<OnClickColor>]]])CCInterfaceEntities.AddButton(x)2.4 ScrollBars:
Creates a new Horizontal ScrollBar as variable x:
x = CCHorizontalScrollBar:New(<XPostion>, <YPosition>, <Height>, <Min>, <Max>, <Name>[,<BarColor>[,<BackgroundColor>[,<LabelColor>]]])x = CCVerticalScrollBar:New(<XPostion>, <YPosition>, <Width>, <Min>, <Max>, <Name>[,<BarColor>[,<BackgroundColor>[,<LabelColor>]]])CCInterfaceEntities.AddScrollBar(x)2.5 Switches:
Creates a new Horizontal Switch as variable x:
x = CCHorizontalSwitch:New(<XPostition>, <YPosition>, <Name>[,<SwitchColor>[,<BackgroundColor>]]) x = CCVerticalSwitch:New(<XPostition>, <YPosition>, <Name>[,<SwitchColor>[,<BackgroundColor>]])CCInterfaceEntities.AddSwitch(x)2.6 EventBuffer:
Creates the EventBuffer as variable x:
x = CCEventBuffer:New([<IsBuffered>[,<TABLE:BufferedEvents(eventnames as strings)>]])
Gets event formated as mentioned below:
[code]EventData = x:PullEvent()Bool = x:IsBuffer()x:ToggleBuffer()event = x:GetLast()event = x:GetFirst()x:Clear()2.7 InterfaceEntities:
Creates the InterfaceEntity as variable x:
x = CCInterfaceEntities:New()x.AddButton(button) OR
x.AddScrollBar(scrollbar) OR
x.AddSwitch(switch) OR
x.AddLabel(label)x.ToggleAll()2.8 Drawing:
Draws a string on the screen:
CCDrawing:DrawCharacters(<X>, <Y>, <String>[,<TextColor>[,<BackgroundColor>[,<Monitor>]]])CCDrawing:DrawArea(<X>, <Y>, <Width>, <Height>, <CharactertoFillWith>[,<TextColor>[,<BackgroundColor>[,<Monitor>]]])2.9 Term function additions(british spellings too)
Each listed function should be obvious how it works
term.colorPrint(Str, TxtColor, BgColor)
term.colorWrite(Str, TxtColor, BgColor)
term.cPrint(Str)
term.cWrite(Str)
term.cColorPrint(Str, TxtColor, BgColor)
term.cColorWrite(Str, TxtColor, BgColor)Changelog: here
Please leave comments and what you guys think should be added next.
To Be Added:
Nothing Planned As Of Yet
Get it here
File is simply Called SAPI.
Thanks!
