Class Chat
A Compound composed of MiniConsoles and tabs that can be echoed to.
One MiniConsole is displayed at a time. The tabs are used to switch the active MiniConsole.
Functions
| self:Echo (channel, text) | Echos any kind of text into a specific channel. |
| self:Append (channel) | Appends text to a channel from the buffer. |
| self:Paste (channel) | Pastes copy()'d text into a channel. |
| self:Clear ([channel="All"]) | Removes all text from a channel. |
Methods
| Chat:_ChatSwitch (channel) | A dirty global function used as a callback for tabs. |
| Chat:_InitializeChat () | A global function, registered as an event handler for the VyzorDrawnEvent. |
| Chat:Chat (_name, initialBackground, initialChannels[, initialTabLocation=TabLocation.Top[, initialSize=0.05[, initialWordWrap="dynamic"[, initialFont=10[, initialComponents]]]]]) | Chat constructor. |
Properties
| self.Name.get () | Returns the name of the Chat Compound. |
| self.Background.get () | Returns the background Frame of the Chat Compound. |
| self.Container.get () | Returns the parent Frame of the Chat Compound. |
| self.Container.set (value) | Sets the parent Frame of the Chat Compound. |
| self.Channels.get () | Returns the channels this Chat Compound manages. |
| self.TabSize.get () | Returns the size of the Chat Compound's tabs. |
| self.TabSize.set (value) | Sets the size of the Chat Compound's tabs. |
| self.FontSize.get () | Returns the font size of the Chat Compound's MiniConsoles. |
| self.FontSize.set (value) | Sets the font size of the Chat Compound's MiniConsoles. |
| self.WordWrap.get () | Returns the word wrap of the Chat Compound's MiniConsoles. |
| self.WordWrap.set (value) | Sets the word wrap of the Chat Compoound's MiniConsoles. |
| self.TabLocation.get () | Returns the Chat Compound's TabLocation. |
| self.TabLocation.set (value) | Sets the Chat Compound's TabLocation. |
| self.Components.get () | Returns the Components used to decorate the Chat Compound's tabs. |
| self.ActiveBackground.get () | Returns the Background used to style the active tab. |
| self.ActiveBackground.set (value) | Sets the Background used to style the active tab. |
| self.InactiveBackgrounds.get () | Returns the Background used to style inactive tabs. |
| self.InactiveBackground.set (value) | Sets the Background used to style style inactive tabs. |
| self.PendingBackground.get () | Returns the Background used to style a tab with new text. |
| self.PendingBackground.set (value) | Sets the Background used to style a tab with new text. |
| self.CurrentChannel.get () | Returns the channel of the active MiniConsole. |
| self.MiniConsoles.get () | Returns the MiniConsoles the Chat Compound manages. |
| self.Tabs.get () | Returns the tabs the Chat Compound manages. |
Functions
- self:Echo (channel, text)
-
Echos any kind of text into a specific channel.
Parameters:
- self:Append (channel)
-
Appends text to a channel from the buffer.
Parameters:
- channel string The channel into which the text should be appended.
- self:Paste (channel)
-
Pastes copy()'d text into a channel.
Parameters:
- channel string The channel into which the text should be pasted.
- self:Clear ([channel="All"])
-
Removes all text from a channel.
Parameters:
- channel string The channel to be cleared. (default "All")
Methods
- Chat:_ChatSwitch (channel)
-
A dirty global function used as a callback for tabs.
Vyzor creates one of these functions for each Chat Compound.
Replace the underscore with the Chat Compound's name.
Parameters:
- channel string The channel to be switched to.
- Chat:_InitializeChat ()
-
A global function, registered as an event handler for the VyzorDrawnEvent.
Makes sure the proper consoles are visible.
Replace the underscore with the Chat Compound's name.
- Chat:Chat (_name, initialBackground, initialChannels[, initialTabLocation=TabLocation.Top[, initialSize=0.05[, initialWordWrap="dynamic"[, initialFont=10[, initialComponents]]]]])
-
Chat constructor.
Parameters:
- _name string Name of the Chat Compound. Used to create unique event handler functions.
- initialBackground Frame The Background Frame for this Chat Compound.
- initialChannels table The names of the channels managed by this Compound. Passed as a table.
- initialTabLocation TabLocation A TabLocation Enum that determines on which side of the consoles the tabs sit. (default TabLocation.Top)
- initialSize number This is the size of the unmanaged portion of the tabs. Must be between 0.0 and 1.0. (default 0.05)
- initialWordWrap number or string This is the word wrap of the MiniConsole text. (default "dynamic")
- initialFont number or string This is the font size of the MiniConsole text. (default 10)
- initialComponents table A table of Components. These are used to decorate the tabs. (optional)
Returns:
Properties
- self.Name.get ()
-
Returns the name of the Chat Compound.
Returns:
- self.Background.get ()
-
Returns the background Frame of the Chat Compound.
Returns:
- self.Container.get ()
-
Returns the parent Frame of the Chat Compound.
Returns:
- self.Container.set (value)
-
Sets the parent Frame of the Chat Compound.
Parameters:
- value Frame
- self.Channels.get ()
-
Returns the channels this Chat Compound manages.
Returns:
- self.TabSize.get ()
-
Returns the size of the Chat Compound's tabs.
Returns:
-
number
- self.TabSize.set (value)
-
Sets the size of the Chat Compound's tabs.
Parameters:
- value number
- self.FontSize.get ()
-
Returns the font size of the Chat Compound's MiniConsoles.
Returns:
-
number
- self.FontSize.set (value)
-
Sets the font size of the Chat Compound's MiniConsoles.
Parameters:
- value number
- self.WordWrap.get ()
-
Returns the word wrap of the Chat Compound's MiniConsoles.
Returns:
-
number
- self.WordWrap.set (value)
-
Sets the word wrap of the Chat Compoound's MiniConsoles.
Parameters:
- value number
- self.TabLocation.get ()
-
Returns the Chat Compound's TabLocation.
Returns:
- self.TabLocation.set (value)
-
Sets the Chat Compound's TabLocation.
Parameters:
- value TabLocation
- self.Components.get ()
-
Returns the Components used to decorate the Chat Compound's tabs.
Returns:
- self.ActiveBackground.get ()
-
Returns the Background used to style the active tab.
Returns:
- self.ActiveBackground.set (value)
-
Sets the Background used to style the active tab.
Parameters:
- value Background
- self.InactiveBackgrounds.get ()
-
Returns the Background used to style inactive tabs.
Returns:
- self.InactiveBackground.set (value)
-
Sets the Background used to style style inactive tabs.
Parameters:
- value Background
- self.PendingBackground.get ()
-
Returns the Background used to style a tab with new text.
Returns:
- self.PendingBackground.set (value)
-
Sets the Background used to style a tab with new text.
Parameters:
- value Background
- self.CurrentChannel.get ()
-
Returns the channel of the active MiniConsole.
Returns:
- self.MiniConsoles.get ()
-
Returns the MiniConsoles the Chat Compound manages.
Returns:
- self.Tabs.get ()
-
Returns the tabs the Chat Compound manages.
Returns: