Core Module - Gui - This file is used to require all the different elements of the gui module - each module has an outline here but for more details see their separate files in ./gui - please read the files for more documentation that cant be shown here - please note there is a rework planned but not started
expcore.gui.core | |
expcore.gui.prototype | |
expcore.gui.concepts.toolbar | |
utils.game | |
CenterFrames.get_flow(player) | Gets the center flow for a player |
CenterFrames.clear_flow(player) | Clears the center flow for a player |
CenterFrames.draw_frame(player, name) | Draws the center frame for a player, if already open then will do nothing |
CenterFrames.redraw_frame(player, name) | Draws the center frame for a player, if already open then will destroy it and redraw |
CenterFrames.toggle_frame(player, name[, state]) | Toggles if the frame is currently open or not, will open if closed and close if open |
CenterFrames.new_frame(permission_name) | Creates a new center frame define |
CenterFrames._prototype:set_auto_focus([state=true]) | Sets the frame to be the current active gui when opened and closes all other frames |
CenterFrames._prototype:draw_frame(player) | Draws this frame to the player, if already open does nothing (will call on_draw to draw to the frame) |
CenterFrames._prototype:redraw_frame(player) | Draws this frame to the player, if already open it will remove it and redraw it (will call on_draw to draw to the frame) |
CenterFrames._prototype:toggle_frame(player) | Toggles if the frame is open, if open it will close it and if closed it will open it |
CenterFrames._prototype:event_handler([action=update]) | Creates an event handler that will trigger one of its functions, use with Event.add |
expcore.gui.core | |
expcore.gui.prototype | |
expcore.gui.concepts.toolbar | |
expcore.gui.elements.buttons | |
mod-gui | |
utils.game | |
utils.event | |
LeftFrames.get_flow(player) | Gets the left frame flow for a player |
LeftFrames.get_frame(name, player) | Gets one frame from the left flow by its name |
LeftFrames.get_open(player) | Gets all open frames for a player, if non are open it will remove the close all button |
LeftFrames.toggle_frame(name, player[, state]) | Toggles the visibility of a left frame, or sets its visibility state |
LeftFrames.new_frame(permission_name) | Creates a new left frame define |
LeftFrames._prototype:set_open_by_default([state=true]) | Sets if the frame is visible when a player joins, can also be a function to return a boolean |
LeftFrames._prototype:set_direction(direction) | Sets the direction of the frame, either vertical or horizontal |
LeftFrames._prototype:_internal_draw(player) | Creates the gui for the first time, used internally |
LeftFrames._prototype:get_frame(player) | Gets the frame for this define from the left frame flow |
LeftFrames._prototype:is_open(player) | Returns if the player currently has this define visible |
LeftFrames._prototype:toggle(player) | Toggles the visibility of the left frame |
LeftFrames._prototype:update(player) | Updates the contents of the left frame, first tries update callback, other wise will clear and redraw |
LeftFrames._prototype:update_all([update_offline=false]) | Updates the frame for all players, see update |
LeftFrames._prototype:redraw(player) | Redraws the frame by calling on_draw, will always clear the frame |
LeftFrames._prototype:redraw_all([update_offline=false]) | Redraws the frame for all players, see redraw |
LeftFrames._prototype:event_handler([action=update]) | Creates an event handler that will trigger one of its functions, use with Event.add |
expcore.gui.core | |
expcore.gui.prototype | |
utils.game | |
utils.event | |
expcore.gui.elements.progress-bar | |
expcore.gui.elements.buttons | |
mod-gui | |
resources.color_presets | |
utils.global | |
PopupFrames.get_flow(player) | Gets the left flow that contains the popup frames |
PopupFrames.open(define_name, player[, open_time], ...) | Opens a popup for the player, can give the amount of time it is open as well as params for the draw function |
PopupFrames.close_progress | Progress bar which when depleted will close the popup frame |
PopupFrames.close_button | A button which can be used to close the gui before the timer runs out |
PopupFrames.new_popup([name]) | Creates a new popup frame define |
PopupFrames._prototype:set_default_open_time(amount) | Sets the default open time for the popup, will be used if non is provided with open |
PopupFrames._prototype:open(player[, open_time], ...) | Opens this define for a player, can be given open time and any other params for the draw function |
expcore.gui.core | |
expcore.gui.elements.buttons | |
expcore.roles | |
utils.event | |
utils.game | |
mod-gui | |
Toolbar.new_button([name]) | Adds a new button to the toolbar |
Toolbar.add_button(button) | Adds an existing buttton to the toolbar |
Toolbar.update(player) | Updates the player's toolbar with an new buttons or expected change in auth return |
utils.gui | |
utils.game | |
new_define(prototype[, debug_name]) | Used to create new element defines from a class prototype, please use the own given by the class |
get_define(name[, internal]) | Gets an element define give the uid, debug name or a copy of the element define |
categorize_by_player(element) | A categorize function to be used with add_store, each player has their own value |
categorize_by_force(element) | A categorize function to be used with add_store, each force has its own value |
categorize_by_surface(element) | A categorize function to be used with add_store, each surface has its own value |
draw(name, element) | Draws a copy of the element define to the parent element, see draw_to |
toggle_enabled(element) | Will toggle the enabled state of an element |
toggle_visible(element) | Will toggle the visiblity of an element |
set_padding(element[, up=0][, down=0][, left=0][, right=0]) | Sets the padding for a gui element |
set_padding_style(style[, up=0][, down=0][, left=0][, right=0]) | Sets the padding for a gui style |
create_alignment(element[, name][, horizontal_align='right'][, vertical_align='center']) | Allows the creation of an alignment flow to place elements into |
destroy_if_valid(element) | Destroies an element but tests for it being present and valid first |
create_scroll_table(element, table_size, maximal_height[, name='scroll']) | Creates a scroll area with a table inside, table can be any size |
create_header(element, caption[, tooltip][, right_align][, name='header']) | Creates a header section with a label and button area |
mod-gui | |
expcore.gui.core | |
expcore.gui.prototype | |
Button.new_button([name]) | Creates a new button element define |
Button._prototype:set_sprites(sprite[, hovered_sprite][, clicked_sprite]) | Adds sprites to a button making it a sprite button |
Button._prototype:set_click_filter(filter[, ...]) | Adds a click / mouse button filter to the button |
Button._prototype:set_key_filter(filter[, ...]) | Adds a control key filter to the button |
expcore.gui.core | |
expcore.gui.prototype | |
expcore.store | |
utils.game | |
Checkbox.new_checkbox([name]) | Creates a new checkbox element define |
Checkbox.new_radiobutton([name]) | Creates a new radiobutton element define, has all functions checkbox has |
Checkbox._prototype_radiobutton:add_as_option(option_set, option_name) | Adds this radiobutton to be an option in the given option set (only one can be true at a time) |
Checkbox._prototype_radiobutton:get_store(category, internal) | Gets the stored value of the radiobutton or the option set if present |
Checkbox._prototype_radiobutton:set_store(category, value, internal) | Sets the stored value of the radiobutton or the option set if present |
Checkbox.new_option_set(name, callback, categorize) | Registers a new option set that can be linked to radiobuttons (only one can be true at a time) |
Checkbox.draw_option_set(name, element) | Draws all radiobuttons that are part of an option set at once (Gui.draw will not work) |
Checkbox.reset_radiobuttons(element[, exclude][, recursive=false]) | Sets all radiobutton in a element to false (unless excluded) and can act recursively |
expcore.gui.core | |
expcore.gui.prototype | |
utils.game | |
Dropdown.new_dropdown([name]) | Creates a new dropdown element define |
Dropdown.new_list_box([name]) | Creates a new list box element define |
Dropdown._prototype:new_static_options(options[, ...], the) | Adds new static options to the dropdown which will trigger the general callback |
Dropdown._prototype:new_dynamic_options(callback) | Adds a callback which should return a table of values to be added as options for the dropdown (appended after static options) |
Dropdown._prototype:add_option_callback(option, callback) | Adds a case specific callback which will only run when that option is selected (general case still triggered) |
Dropdown.select_value(element, value) | Selects the option from a dropdown or list box given the value rather than key |
Dropdown.get_selected_value(element) | Returns the currently selected value rather than index |
expcore.gui.core | |
expcore.gui.prototype | |
utils.game | |
ElemButton.new_elem_button([name]) | Creates a new elem button element define |
ElemButton._prototype.set_type | Sets the type of the elem button, the type is required so this must be called at least once |
ElemButton._prototype:set_default(value) | Sets the default value for the elem button, this may be a function or a string |
expcore.gui.core | |
expcore.gui.prototype | |
utils.global | |
utils.game | |
ProgressBar.set_maximum(element, amount) | Sets the maximum value that represents the end value of the progress bar |
ProgressBar.increment(element[, amount=1]) | Increases the value of the progressbar, if a define is given all of its instances have incremented |
ProgressBar.decrement(element[, amount=1]) | Decreases the value of the progressbar, if a define is given all of its instances have decremented |
ProgressBar.new_progressbar([name]) | Creates a new progressbar element define |
ProgressBar._prototype:set_default_maximum(amount) | Sets the maximum value that represents the end value of the progress bar |
ProgressBar._prototype:use_count_down([state=true]) | Will set the progress bar to start at 1 and trigger when it hits 0 |
ProgressBar._prototype:increment([amount=1][, category]) | Increases the value of the progressbar |
ProgressBar._prototype:increment_filtered([amount=1], filter) | Increases the value of the progressbar, if the filter condition is met, does not work with store |
ProgressBar._prototype:decrement([amount=1][, category]) | Decreases the value of the progressbar |
ProgressBar._prototype:decrement_filtered([amount=1], filter) | Decreases the value of the progressbar, if the filter condition is met, does not work with store |
ProgressBar._prototype:add_element(element[, maximum]) | Adds an element into the list of instances that will are waiting to complete, does not work with store note use store if you want persistent data, this only stores the elements not the values which they have |
ProgressBar._prototype:reset_element(element) | Resets an element, or its store, to be back at the start, either 1 or 0 |
ProgressBar._prototype:event_counter([filter]) | Event handler factory that counts up by 1 every time the event triggers, can filter which elements have incremented |
ProgressBar._prototype:event_countdown([filter]) | Event handler factory that counts down by 1 every time the event triggers, can filter which elements have decremented |
expcore.gui.core | |
expcore.gui.prototype | |
expcore.gui.instances | |
utils.game | |
Slider.new_slider([name]) | Creates a new slider element define |
Slider._prototype:set_range([min][, max]) | Sets the range of a slider, if not used will use default values for a slider |
Slider._prototype:draw_label(element) | Draws a new label and links its value to the value of this slider, if no store then it will only show one value per player |
Slider._prototype:enable_auto_draw_label([state=true]) | Enables auto draw of the label, the label will share the same parent element as the slider |
expcore.gui.core | |
expcore.gui.prototype | |
utils.game | |
Text.new_text_field([name]) | Creates a new text field element define |
Text.new_text_box([name]) | Creates a new text box element define |
Text._prototype_box:set_selectable([state=true]) | Sets the text box to be selectable |
Text._prototype_box:set_word_wrap([state=true]) | Sets the text box to have word wrap |
Text._prototype_box:set_read_only([state=true]) | Sets the text box to be read only |
utils.global | |
Instances.has_categories(name) | Returns if a instance group has a categorise function; must be registered |
Instances.is_registered(name) | Returns if the given name is a registered instance group |
Instances.register(name[, categorise]) | Registers the name of an instance group to allow for storing element instances |
Instances.add_element(name, element) | Adds an element to the instance group under the correct category; must be registered |
Instances.get_elements_raw(name[, category]) | Gets all element instances without first removing any invalid ones; used internally and must be registered |
Instances.get_valid_elements(name[, category][, callback]) | Gets all valid element instances and has the option of running a callback on those that are valid |
Instances.unregistered_add_element(name, category, element) | A version of add_element that does not require the group to be registered |
Instances.unregistered_get_elements(name, category[, callback]) | A version of get_elements that does not require the group to be registered |
utils.game | |
expcore.store | |
expcore.gui.instances | |
Constructor.event(event_name) | Creates a new function to add functions to an event handler |
Constructor.extend(new_prototype) | Extents a prototype with the base functions of all gui prototypes, no metatables |
Constructor.store(sync, callback) | Creates a new function which adds a store to a gui define |
Constructor.setter(value_type, key[, second_key]) | Creates a setter function that checks the type when a value is set |
Prototype:uid() | Gets the uid for the element define |
Prototype.debug_name | Sets a debug alias for the define |
Prototype.set_caption | Sets the caption for the element define |
Prototype.set_tooltip | Sets the tooltip for the element define |
Prototype.set_pre_authenticator | Sets an authenticator that blocks the draw function if check fails |
Prototype.set_post_authenticator | Sets an authenticator that disables the element if check fails |
Prototype.on_draw | Registers a callback to the on_draw event |
Prototype.on_style_update | Registers a callback to the on_style_update event |
Prototype:set_style(style[, callback]) | Sets the style for the element define |
Prototype:set_embedded_flow(state) | Sets the element to be drawn inside a nameless flow, can be given a name using a function |
Prototype:raise_event(event_name, ...) | Raises a custom event for this define, any number of params can be given |
Prototype:draw_to(element) | The main function for defines, when called will draw an instance of this define to the given element what is drawn is based on the data in draw_data which is set using other functions |
Prototype:get_store(category) | Gets the value in this elements store, category needed if categorize function used |
Prototype:set_store(category, value) | Sets the value in this elements store, category needed if categorize function used |
Prototype:clear_store([category]) | Sets the value in this elements store to nil, category needed if categorize function used |
expcore.gui |
expcore.common |
resources.color_presets |
utils.event |
expcore.store |
Gets the center flow for a player
Parameters:Clears the center flow for a player
Parameters:Draws the center frame for a player, if already open then will do nothing
Parameters:Draws the center frame for a player, if already open then will destroy it and redraw
Parameters:Toggles if the frame is currently open or not, will open if closed and close if open
Parameters:Creates a new center frame define
Parameters:Sets the frame to be the current active gui when opened and closes all other frames
Parameters:Draws this frame to the player, if already open does nothing (will call on_draw to draw to the frame)
Parameters:Draws this frame to the player, if already open it will remove it and redraw it (will call on_draw to draw to the frame)
Parameters:Toggles if the frame is open, if open it will close it and if closed it will open it
Parameters:Creates an event handler that will trigger one of its functions, use with Event.add
Parameters:Gets the left frame flow for a player
Parameters:Gets one frame from the left flow by its name
Parameters:Gets all open frames for a player, if non are open it will remove the close all button
Parameters:Toggles the visibility of a left frame, or sets its visibility state
Parameters:Creates a new left frame define
Parameters:Sets if the frame is visible when a player joins, can also be a function to return a boolean
Parameters:Sets the direction of the frame, either vertical or horizontal
Parameters:Creates the gui for the first time, used internally
Parameters:Gets the frame for this define from the left frame flow
Parameters:Returns if the player currently has this define visible
Parameters:Toggles the visibility of the left frame
Parameters:Updates the contents of the left frame, first tries update callback, other wise will clear and redraw
Parameters:Updates the frame for all players, see update
Parameters:Redraws the frame by calling on_draw, will always clear the frame
Parameters:Redraws the frame for all players, see redraw
Parameters:Creates an event handler that will trigger one of its functions, use with Event.add
Parameters:Gets the left flow that contains the popup frames
Parameters:Opens a popup for the player, can give the amount of time it is open as well as params for the draw function
Parameters:Progress bar which when depleted will close the popup frame
A button which can be used to close the gui before the timer runs out
Creates a new popup frame define
Parameters:Sets the default open time for the popup, will be used if non is provided with open
Parameters:Opens this define for a player, can be given open time and any other params for the draw function
Parameters:Adds a new button to the toolbar
Parameters:Adds an existing buttton to the toolbar
Parameters:Updates the player's toolbar with an new buttons or expected change in auth return
Parameters:Used to create new element defines from a class prototype, please use the own given by the class
Parameters:Gets an element define give the uid, debug name or a copy of the element define
Parameters:A categorize function to be used with add_store, each player has their own value
Parameters:A categorize function to be used with add_store, each force has its own value
Parameters:A categorize function to be used with add_store, each surface has its own value
Parameters:Draws a copy of the element define to the parent element, see draw_to
Parameters:Will toggle the enabled state of an element
Parameters:Will toggle the visiblity of an element
Parameters:Sets the padding for a gui element
Parameters:Sets the padding for a gui style
Parameters:Allows the creation of an alignment flow to place elements into
Parameters:Destroies an element but tests for it being present and valid first
Parameters:Creates a scroll area with a table inside, table can be any size
Parameters:Creates a header section with a label and button area
Parameters:Creates a new button element define
Parameters:Adds sprites to a button making it a sprite button
Parameters:Adds a click / mouse button filter to the button
Parameters:Adds a control key filter to the button
Parameters:Creates a new checkbox element define
Parameters:Creates a new radiobutton element define, has all functions checkbox has
Parameters:Adds this radiobutton to be an option in the given option set (only one can be true at a time)
Parameters:Gets the stored value of the radiobutton or the option set if present
Parameters:Sets the stored value of the radiobutton or the option set if present
Parameters:Registers a new option set that can be linked to radiobuttons (only one can be true at a time)
Parameters:Draws all radiobuttons that are part of an option set at once (Gui.draw will not work)
Parameters:Sets all radiobutton in a element to false (unless excluded) and can act recursively
Parameters:Creates a new dropdown element define
Parameters:Creates a new list box element define
Parameters:Adds new static options to the dropdown which will trigger the general callback
Parameters:Adds a callback which should return a table of values to be added as options for the dropdown (appended after static options)
Parameters:Adds a case specific callback which will only run when that option is selected (general case still triggered)
Parameters:Selects the option from a dropdown or list box given the value rather than key
Parameters: