Module object.frame
Properties of the frame object most of these properties are optional !
a frame is a special type of gui object/window that can be dragged around with your mouse you can also use it for creating thing such as draggers but that might be bit overkill to use a window for that
Tables
| properties | frame OBJECT CREATION PROPERTIES |
| read_properties | frame OBJECT READ PROPERTIES |
| dragger | dragger table properties |
Tables
- properties
-
frame OBJECT CREATION PROPERTIES
Fields:
- x [number] the starting x position of the frame
- y [number] the starting y position of the frame
- width [number] the starting width of the object
- height [number] the starting height of the object
- dragger [table] definition of the box that the window can be dragged by
- dragable [boolean] sets whether the window can be dragged by the user or not
- on_move [function] gets called when the window gets moved. gets passed the object and the event as an argument. if returns true the window wont get moved. allowing for custom move handling
- on_select [function] gets called when the window gets selected. gets passed the object and the event as an argument.
- on_any [function] gets called every time the frame updates in any non-graphic way
- on_graphic [function] gets ran every time the graphic.lua file of the frame gets ran. allowing for custom well timed updates of graphics inside the frame
- on_deselect [function] gets called when the window gets dropped. gets passed the object and the event as an argument.
- read_properties
-
frame OBJECT READ PROPERTIES
Fields:
- dragged [boolean] gets set to true when the window is currently dragged
- last_click [table] table of 2 coordinates storing the last move position of the frame. used internaly
- window [table] the standard window object for this frame
- child [guih.main_ui] the child gui for this frame
- dragger
-
dragger table properties
Fields:
- x [number] the x position of the dragger
- y [number] the y position of the dragger
- width [number] the width of the dragger
- height [number] the height of the dragger