diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 67de1ec..b94ca2d 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -29,3 +29,4 @@ - [Component Logic](tips/logic) - [Changing Button Color](tips/buttons) - [Advanced usage of Events](tips/events.md) + - [Example Designs](tips/design.md) diff --git a/docs/tips/design.md b/docs/tips/design.md new file mode 100644 index 0000000..b214f19 --- /dev/null +++ b/docs/tips/design.md @@ -0,0 +1,54 @@ +Hello! This page contains some tips on how to create cool designs with Basalt + +To understand this page, it is recommended to familiarize yourself with [Animations](../objects/Animation.md) as animations are important for creating complex designs + +Let us begin with simple things: + +## Recolor objects + +Let's create a Button: + +```lua +local basalt = dofile("basalt.lua") +local mainFrame = basalt.createFrame("myFirstFrame"):setBackground(colors.black):show() +local aButton = mainFrame:addButton("myFirstButton"):setSize(10, 3):setText("Beautiful"):setBackground(colors.gray):show() +``` + +Here lets make use of the event system:
+```lua +local function changeButtonColor(self,event,typ,x,y) + if(event=="mouse_click")then + self:setBackground(colors.lightGray) + end + if(event=="mouse_up")then + self:setBackground(colors.gray) + end +end + +local function buttonLogic() + -- here you can do some logic when button gets the mouse_up event +end + +aButton:onClick(changeButtonColor) -- button color change on click +aButton:onClickUp(changeButtonColor) -- button color change on click up +aButton:onClickUp(buttonLogic) -- button logic on click up +aButton:onLoseFocus(function(self) self:setBackground(colors.gray) end) -- if user is clicking on the button and dragging out of button size this event will change the bg color back to gray +``` + +## Fade In/Out Objects +instead of recoloring we are also able to slowly reposition the button, something like fade in:
+```lua +local buttonAnimation = mainFrame:addAnimation("buttonFadeAnim") +local function fadeButtonIn(btn) + if(btn.x < 5)then + btn:setPosition(1,0,"r") + else + buttonAnimation:cancel() -- here you cancel the loop + end +end + +buttonAnimation:wait(0.1):add(function() fadeButtonIn(aButton) end):play(true) -- with play(true) you will create a infinite loop +``` +This is also possible with entire frames and its children objects. So keep that in mind if you want to create something like a bigger panel to the right or a menu bar + +WIP \ No newline at end of file