Manages a number of MiniConsoles and tabs for a clean interface for text.
| Chat | Manages a number of MiniConsoles and tabs for a clean interface for text. |
| Functions | |
| new | |
| New Chat | A Compound composed of MiniConsoles and tabs that can be echoed to, displaying one MiniConsole at a time, with tabs to switch between the active MiniConsole. |
| Variables | |
| background | The background Frame that houses the Chat Compound. |
| channel_list | A string list of channel names. |
| mini_consoles | The MiniConsoles managed by this Chat Compound. |
| tab_location | Determines on which side of the MiniConsoles the tabs will sit. |
| tabs | The tab Frames managed by this Chat Compound. |
| tab_container | A Frame that holds the tabs’ Box Compound. |
| components | A table of Components that all tabs will share. |
| active_background | The default background color of the active tab. |
| inactive_background | The default background color of tabs when they’re not the active tab. |
| pending_background | The default background color of a tab when there’s a message waiting to be viewed. |
| current_channel | The channel currently active. |
| pending_channels | Channels with text to be viewed, waiting to be clicked on. |
| switch_func | The name of the global function that will be used to switch MiniConsoles when the tab is clicked. |
| Properties | |
| Chat Properties | |
| Functions | |
| Echo | Echos any kind of text into a specific channel. |
| Append | Appends text to a channel from the buffer. |
| Paste | Pastes copy()’d text into a channel. |
| Clear | Removes all text from a channel. |
| <name>ChatSwitch | A dirty global function used as a callback for tabs. |
| <name>InitializeChat | A global function, registered as an event handler for the VyzorDrawnEvent. |
| Variables | |
| init_func | The name of the global initialization function for this Chat Compound. |
local function new ( _, name, init_back, init_channels, init_tabloc, init_size, init_wrap, init_font, init_components )
| name | Name of the Chat Compound. Used to create unique event handler functions. |
| init_back | The Background Frame for this Chat Compound. |
| init_channels | The names of the channels managed by this Compound. Passed as a table. |
| init_tabloc | Optional. A TabLocation Enum that determines on which side of the consoles the tabs sit. Default is top. |
| init_size | Optional. This is the size of the unmanaged portion of the tabs. Must be between 0.0 and 1.0. Default is 0.05. |
| init_wrap | Optional. This is the word wrap of the MiniConsole text. Default is “dynamic”. |
| init_font | Optional. This is the font size of the MiniConsole text. Default is 10. Can be “dynamic” |
| init_components | Optional. A table of Components. These are used to decorate the tabs. |
A Compound composed of MiniConsoles and tabs that can be echoed to, displaying one MiniConsole at a time, with tabs to switch between the active MiniConsole.
| Variables | |
| background | The background Frame that houses the Chat Compound. |
| channel_list | A string list of channel names. |
| mini_consoles | The MiniConsoles managed by this Chat Compound. |
| tab_location | Determines on which side of the MiniConsoles the tabs will sit. |
| tabs | The tab Frames managed by this Chat Compound. |
| tab_container | A Frame that holds the tabs’ Box Compound. |
| components | A table of Components that all tabs will share. |
| active_background | The default background color of the active tab. |
| inactive_background | The default background color of tabs when they’re not the active tab. |
| pending_background | The default background color of a tab when there’s a message waiting to be viewed. |
| current_channel | The channel currently active. |
| pending_channels | Channels with text to be viewed, waiting to be clicked on. |
| switch_func | The name of the global function that will be used to switch MiniConsoles when the tab is clicked. |
| Properties | |
| Chat Properties | |
| Functions | |
| Echo | Echos any kind of text into a specific channel. |
| Append | Appends text to a channel from the buffer. |
| Paste | Pastes copy()’d text into a channel. |
| Clear | Removes all text from a channel. |
| <name>ChatSwitch | A dirty global function used as a callback for tabs. |
| <name>InitializeChat | A global function, registered as an event handler for the VyzorDrawnEvent. |
| Variables | |
| init_func | The name of the global initialization function for this Chat Compound. |
local function new ( _, name, init_back, init_channels, init_tabloc, init_size, init_wrap, init_font, init_components )
The background Frame that houses the Chat Compound.
local background
Determines on which side of the MiniConsoles the tabs will sit.
local tab_location
A Frame that holds the tabs’ Box Compound.
local tab_container
The default background color of the active tab.
local active_background
The default background color of tabs when they’re not the active tab.
local inactive_background
The default background color of a tab when there’s a message waiting to be viewed.
local pending_background
The channel currently active.
local current_channel
The name of the global function that will be used to switch MiniConsoles when the tab is clicked.
local switch_func
Echos any kind of text into a specific channel.
function new_chat:Echo ( channel, text )
Appends text to a channel from the buffer.
function new_chat:Append ( channel )
Pastes copy()’d text into a channel.
function new_chat:Paste ( channel )
Removes all text from a channel.
function new_chat:Clear ( channel )
The name of the global initialization function for this Chat Compound.
local init_func