Module ExpGamingCore.Gui.Left
Adds a organiser for left gui ellements which will automaticaly update there information and have open requirements
Info:
- License: https://github.com/explosivegaming/scenario/blob/master/LICENSE
- Author: Cooldude2606
Functions
_comment () | This is a submodule of ExpGamingCore.Gui but for ldoc reasons it is under its own module |
add (obj) | Used to add a left gui frame |
update ([frame[, players]]) | This is used to update all the guis of connected players, good idea to use our thread system as it as nested for loops |
open (left_name) | Used to open the left gui of every player |
close (left_name) | Used to close the left gui of every player |
Functions
- _comment ()
- This is a submodule of ExpGamingCore.Gui but for ldoc reasons it is under its own module
- add (obj)
-
Used to add a left gui frame
Parameters:
- obj this is what will be made, needs a name and a draw function(root_frame), open_on_join can be used to set the deaful state true/false, can_open is a test to block it from opening but is not needed
Returns:
-
the object that is made to... well idk but for the future
Usage:
Gui.left.add{name='foo',caption='Foo',tooltip='just testing',open_on_join=true,can_open=function,draw=function}
- update ([frame[, players]])
-
This is used to update all the guis of connected players, good idea to use our thread system as it as nested for loops
Parameters:
- frame string this is the name of a frame if you only want to update one (optional)
- players the player to update for, if not given all players are updated, can be one player (optional)
Usage:
Gui.left.update()
- open (left_name)
-
Used to open the left gui of every player
Parameters:
- left_name string this is the gui that you want to open
Usage:
Gui.left.open('foo')
- close (left_name)
-
Used to close the left gui of every player
Parameters:
- left_name string this is the gui that you want to close
Usage:
Gui.left.close('foo')