Lua Chat System — Client API — ChatWindow
Lua Chat System — Client API — ChatWindow
The ChatWindow is the main class of the Lua Chat System’s client side.
Properties
ChatBar
ChannelsBar
- Type: ChatChannelsBar
- Description: A reference to the ChatChannelsBar of the window
MessageLogDisplay
- Type: ChatMessageLogDisplay
- Description: A reference to the ChatMessageLogDisplay of the window
Methods
AddChannel
- Parameters: string
channelName
- Description: Adds a ChatChannelUI with the given
channelName
to the window - Returns: ChatChannelUI
RemoveChannel
- Parameters: string
channelName
- Description: Removes a ChatChannelUI with the given
channelName
from the window - Returns: void
GetChannel
- Parameters: string
channelName
- Description: Get the ChatChannelUI with the given
channelName
if it exists. - Returns: ChatChannelUI or
nil
GetCurrentChannel
- Parameters: string
channelName
- Description: Returns the current ChatChannelUI
- Returns: ChatChannelUI
SwitchCurrentChannel
- Parameters: string
channelName
- Description: Switches the current channel to the ChatChannelUI with the given
channelName
if it exists. - Returns: void
GetVisible
- Parameters: None
- Description: Returns whether the window is visible or not. Note: this refers to the chat UI in general; when the chat window fades to transparent due to inactivity, the window is still considered visible.
- Returns: bool
SetVisible
- Parameters: bool
visible
- Description: Sets the visibility of the chat window.
- Returns: void
FadeOutBackground
- Parameters: float
duration
- Description: Fades out the background over the given
duration
in seconds. Note: later calls to control fading in/out will override earlier calls. - Returns: void
FadeInBackground
- Parameters: float
duration
- Description: Fades in the background over the given
duration
in seconds. Note: later calls to control fading in/out will override earlier calls. - Returns: void
FadeOutText
- Parameters: float
duration
- Description: Fades out the text over the given
duration
in seconds. Note: later calls to control fading in/out will override earlier calls. - Returns: void
FadeInText
- Parameters: float
duration
- Description: Fades in the text over the given
duration
in seconds. Note: later calls to control fading in/out will override earlier calls. - Returns: void