25 replies to this topic

[BlankWolf]

Hello everyone,

I made an API for creating some buttons on a computer or monitor.
I know there are already button apis posted, but I wanted to show you own.

Download:
http://pastebin.com/6A8JuwqB

API-code:

Spoiler

local objects = {}

function newButton(array)
        if(not term.isColor()) then error('you have to use an advanced computer/monitor',2) end
        if(type(array) ~= 'table' and type(array) ~= 'nil') then error('Expectet \'table\' got \''..type(array)..'\'',2) end
        local self = {}

        if(type(array) == 'nil') then array = {} end

        local title = array.title or ''
        local posX = array.posX or 0
        local posY = array.posY or 0
        local width = array.width or 0
        local height = array.height or 0
        local tcolor = array.textcolor or colors.black
        local bcolor = array.backgroundcolor or colors.red
        local active = array.active or false
        local funct = array.funct or function() return false end
        local termX, termY = term.getSize()

        if(width <= 0 or height <= 0 or posX+width > termX or posY+height > termY) then
                active = false
        end

        table.insert(objects, self)

        function self.getTitle()
                return title
        end
        function self.getPosX()
                return posX
        end
        function self.getPosY()
                return posY
        end
        function self.getWidth()
                return width
        end
        function self.getHeight()
                return height
        end
        function self.getTextColor()
                return tcolor
        end
        function self.getBackgroundColor()
                return bcolor
        end
        function self.getActive()
                return active
        end
        function self.getDraw()
                return draw
        end

        function self.setTitle(str)
                if(type(str) ~= 'string' and type(str) ~= 'number') then error('Expectet \'string\' or \'number\' got \''..type(str)..'\'',2) end
                title = ''..str
                return true
        end
        function self.setPosX(int)
                if(type(int) ~= 'number') then error('Expectet \'number\' got \''..type(int)..'\'',2) end
                termX, termY = term.getSize()
                if(width <= 0 or height <= 0 or posX+width > termX or posY+height > termY) then
                        active = false
                end
                posX = int
                return true
        end
        function self.setPosY(int)
                if(type(int) ~= 'number') then error('Expectet \'number\' got \''..type(int)..'\'',2) end
                termX, termY = term.getSize()
                if(width <= 0 or height <= 0 or posX+width > termX or posY+height > termY) then
                        active = false
                end
                posY = int
                return true
        end
        function self.setWidth(int)
                if(type(int) ~= 'number') then error('Expectet \'number\' got \''..type(int)..'\'',2) end
                termX, termY = term.getSize()
                if(width <= 0 or height <= 0 or posX+width > termX or posY+height > termY) then
                        active = false
                end
                width = int
                return true
        end
        function self.setHeight(int)
                if(type(int) ~= 'number') then error('Expectet \'number\' got \''..type(int)..'\'',2) end
                termX, termY = term.getSize()
                if(width <= 0 or height <= 0 or posX+width > termX or posY+height > termY) then
                        active = false
                end
                height = int
                return true
        end
        function self.setTextColor(int)
                if(type(int) ~= 'number') then error('Expectet \'number\' got \''..type(int)..'\'',2) end
                tcolor = int
                return true
        end
        function self.setBackgroundColor(int)
                if(type(int) ~= 'number') then error('Expectet \'number\' got \''..type(int)..'\'',2) end
                bcolor = int
                return true
        end
        function self.setActive(bool)
                if(type(bool) ~= 'boolean') then error('Expectet \'boolean\' got \''..type(bool)..'\'',2) end
                termX, termY = term.getSize()
                if(width <= 0 or height <= 0 or posX+width > termX or posY+height > termY) then
                        active = false
                        return false
                end
                active = bool
                return true
        end
        function self.setFunction(funct)
                if(type(funct) ~= 'function') then error('Expectet \'function\' got \''..type(funct)..'\'',2) end
        end

        function self.changeTitle(str)
                if(type(str) ~= 'string' and type(str) ~= 'number') then error('Expectet \'string\' or \'number\' got \''..type(str)..'\'',2) end
                if(self.setTitle(str)) then
                        self.draw()
                        return true
                end
                return false
        end
        function self.changePosX(int)
                if(type(int) ~= 'number') then error('Expectet \'number\' got \''..type(int)..'\'',2) end
                if(self.setPosX(int)) then
                        self.draw()
                        return true
                end
                return false
        end
        function self.changePosY(int)
                if(type(int) ~= 'number') then error('Expectet \'number\' got \''..type(int)..'\'',2) end
                if(self.setPosY(int)) then
                        self.draw()
                        return true
                end
                return false
        end
        function self.changeWidth(int)
                if(type(int) ~= 'number') then error('Expectet \'number\' got \''..type(int)..'\'',2) end
                if(self.setWidth(int)) then
                        self.draw()
                        return true
                end
                return false
        end
        function self.changeHeight(int)
                if(type(int) ~= 'number') then error('Expectet \'number\' got \''..type(int)..'\'',2) end
                if(self.setHeight(int)) then
                        self.draw()
                        return true
                end
                return false
        end
        function self.changeTextColor(int)
                if(type(int) ~= 'number') then error('Expectet \'number\' got \''..type(int)..'\'',2) end
                if(self.setTextColor(int)) then
                        self.draw()
                        return true
                end
                return false
        end
        function self.changeBackgroundColor(int)
                if(type(int) ~= 'number') then error('Expectet \'number\' got \''..type(int)..'\'',2) end
                if(self.setBackgroundColor(int)) then
                        self.draw()
                        return true
                end
                return false
        end

        function self.draw()
                if(not active) then return false end
                oldX, oldY = term.getCursorPos()
                term.setBackgroundColor(bcolor)
                term.setTextColor(tcolor)
                for y=0, height-1 do
                        term.setCursorPos(posX, posY+y)
                        for x=1, width do
                                write(' ')
                        end
                end
                term.setCursorPos(math.floor((width - #string.sub(title,1,width)) / 2) + posX, math.floor(height / 2) + posY)
                write(string.sub(title,1,width))

                term.setCursorPos(oldX, oldY)
                term.setBackgroundColor(colors.black)
                term.setTextColor(colors.white)
                draw = true
                return true
        end
        function self.runFunction(...)
                funct(...)
        end

        return self
end

function getButton(posX, posY)
        if(type(posX) ~= 'number') then error('posX: expectet \'number\' got \''..type(posX)..'\'',2) end
        if(type(posY) ~= 'number') then error('posY: expectet \'number\' got \''..type(posY)..'\'',2) end
        for number, obj in pairs(objects) do
                if(obj.getActive() and obj.getDraw()) then
                        if(posX >= obj.getPosX() and posX < obj.getPosX() + obj.getWidth() and posY >= obj.getPosY() and posY < obj.getPosY() + obj.getHeight()) then
                                return obj
                        end
                end
        end
        return dummy
end

available functions:

Spoiler

get/set/changeTitle()  -- set and change needs a string
get/set/changeWidth()  -- set and change needs a number
get/set/changeHeight()  -- set and change needs a number
get/set/changePosX()  -- set and change needs a number
get/set/changePosY()  -- set and change needs a number
get/set/changeTextColor()  -- set and change needs a number
get/set/changeBackgroundColor()  -- set and change needs a number
get/setActive()  -- set needs a boolean
getDraw()
draw()
runFunction()  -- you can use arguments
getButton()

usage:

Spoiler

First load the API.

os.loadAPI("button")

Than you can create a new button like so,

b1 = button.newButton()
-- notice: you can't draw this button

or you give the button some arguments (you don't have to use all).

b2 = button.newButton({title='test'; width=11; height=3; posX=5; posY=5; backgroundcolor=colors.red; textcolor=colors.black; active=true; func=function(int) print(int+1) end})
-- notice: when the width/height == 0 or width+posX/height+posY > then the screen or active == false you can't draw the button either!
-- notice: when the title is lager then the button, the title will be cutoff
-- notice: the arguments need to be in a table or you get an error

If the button is created you can get or set the arguments. For example:

b2.getWidth()	-- this will return 11
b2.setWidth(9)   -- set the width off b2 to 9 and return true by success
b2.getWidth()	-- this time it returns 9

When you'r happy with your arguments you can draw the button to the screen.

b2.draw()

You also can run a function wich is bound to a button

b2.runFunction(5)  -- in this example it prints 6 to the screen

Finally you can get a button by his position and change the arguments.

event, button, x, y = os.pullEvent('mouse_click')
button.getButton(x,y).changeTitle('newTitle')
-- notice: you can only use change, when the button is allready drawed to the screen, otherwise it will return false

For an ingame help start my api like a normal program with "help" has an argument.

button  help

example program:

Spoiler

-- load the api
os.unloadAPI("button")
os.loadAPI("button")

termX,termY = term.getSize()
shell.run("clear")
term.setCursorPos(1,termY)

funct = function()
end

-- create some buttons
b1 = button.newButton({title='b1';posX=5;posY=2;width=9;height=3;active=true;funct=function(x,y) term.clearLine() term.setCursorPos(x,y) end})
b2 = button.newButton({title='b2';posX=5;posY=6;width=9;height=3})
b3 = button.newButton({title='b3';posX=5;posY=10;width=9;height=3;active=true;funct=function() write(5) end})

-- draw the buttons
b1.draw()
b2.draw()
b3.draw()


while true do
        e = {os.pullEvent('mouse_click')}
        obj = button.getButton(e[3],e[4])
        if(obj.getBackgroundColor() == colors.red) then
                obj.changeBackgroundColor(colors.lime)
        else
                obj.changeBackgroundColor(colors.red)
        end
        obj.runFunction(1,termY)
end

http://pastebin.com/up7K08ZQ

changelog:

Spoiler

v1.1 - add a new function (runFunction) and a button argument (func)

please report any bugs or ideas what I can add or change

thanks
BlankWolf

[svdragster]

Nice job! But you should definetly include an explanation here instead only in the program!

[BlankWolf]

svdragster, on 02 July 2013 - 12:19 PM, said:

Nice job! But you should definetly include an explanation here instead only in the program!

Thanks. Your right I have add an explanation under usage.
Do you have an idea what feature can be added?

[svdragster]

I can't think of more features... not yet

[BlankWolf]

Update the API to v1.1
Have a look to the changelogs.

[computercraftprogrammer]

Well I made a GUI api (Not public yet) that does the same thing pretty much, it checks each button if its in the area of the click. Though this is nice!

[BlankWolf]

UMayBleed, on 04 July 2013 - 02:56 PM, said:

Well I made a GUI api (Not public yet) that does the same thing pretty much, it checks each button if its in the area of the click. Though this is nice!

Thanks.
I will make a GUI api too. (someday)

[wolfhowl42]

kinda confusing

[BlankWolf]

wolfhowl42, on 07 July 2013 - 10:40 PM, said:

kinda confusing

What exactly are you confused about?

[Cutecurtain]

Very useful. Easy to read through the code as well Nice job

[BlankWolf]

Gulligagardinen, on 10 July 2013 - 03:56 AM, said:

Very useful. Easy to read through the code as well Nice job

Thanks.
If you have any suggestion what can be added or change feel free to post it

[oedze]

looks nice, but i dont need it right now. i will follow your topic incase i need one

[BlankWolf]

oedze, on 22 July 2013 - 12:10 PM, said:

looks nice, but i dont need it right now. i will follow your topic incase i need one

Thanks.
Go ahead. Use my API when ever you want.
But I'am still rewriting the code... Well I will rewrite it, when I have time for it

[jesusthekiller]

BlankWolf, on 24 July 2013 - 01:04 AM, said:

Thanks.
Go ahead. Use my API when ever you want.
But I'am still rewriting the code... Well I will rewrite it, when I have time for it

Maintaining part sucks

[BlankWolf]

jesusthekiller, on 24 July 2013 - 04:55 AM, said:

Maintaining part sucks

Well... I don't think so.
I like it when I can make my program better than before

[jesusthekiller]

I hate it tho

[figgycity50]

am i doing something wrong or is this broken? my error:

Attached Thumbnails

• 

[BlankWolf]

figgycity50, on 29 July 2013 - 10:41 AM, said:

am i doing something wrong or is this broken? my error:

Well no. It's my fault.
I think I fixed it, but I can't test it atm.

[LeB0ucEtMistere]

nice work pretty useful, i will get some inspiration of your design to code my own API i tough ^^' indeed, that's a nice job ! keep it up

[BlankWolf]

LeB0ucEtMistere, on 16 August 2013 - 03:22 PM, said:

nice work pretty useful, i will get some inspiration of your design to code my own API i tough ^^' indeed, that's a nice job ! keep it up

Thanks, I'm glad that my code is useful for you. And don't worry. I will keep it up. I just haven't enough time. D=