PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience

Lua Chat System — Client API — ChatWindow

Lua Chat System — Client API — ChatWindow

Oct 31 2018, 12:07 AM PST 5 min

< Return to Lua Chat System

The ChatWindow is the main class of the Lua Chat System’s client side.

Properties

ChatBar

ChannelsBar

MessageLogDisplay

Methods

AddChannel

RemoveChannel

  • Parameters: string channelName
  • Description: Removes a ChatChannelUI with the given channelName from the window
  • Returns: void

GetChannel

GetCurrentChannel

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