⚪
Tank & Healer Studio Assets
Return to Website
Ultimate Chat Box
Ultimate Chat Box
  • 🟠Introduction
    • 👋Welcome!
    • ⚡Getting Started
  • 📖Documentation
    • UltimateChatBox
      • Public Methods
        • RegisterChat (+4 overloads)
        • Enable
        • Disable
        • ClearChat
        • EnableInputField
        • ToggleInputField
        • DisableInputField
        • SendCustomInput
        • FindChatsFromUser
        • FindChatsOfStyle
        • UpdatePositioning
      • Events
        • OnChatRegistered
        • OnUsernameHover
        • OnUsernameInteract
        • OnInputFieldUpdated
        • OnInputFieldSubmitted
        • OnInputFieldCommandUpdated
        • OnInputFieldCommandSubmitted
        • OnExtraImageInteract
      • Public Classes
        • ChatInformation
        • ChatStyle
      • Properties
    • UltimateChatBoxStyles
      • Creating a custom Chat Style
  • 💡Tips & Tricks
    • Catching Commands
  • Helpful Links
    • Support Discord
    • Leave us a review!
Powered by GitBook
On this page
  • Public Methods
  • Properties

Was this helpful?

  1. Documentation
  2. UltimateChatBox
  3. Public Classes

ChatInformation

The ChatInformation class stores all the information about the chat that was registered to the chat box.

Public Methods

Method

RemoveChat

Removes the chat from the chat box.

UpdateText

[INTERNAL] Updates the text component of this chat so that it can be display.

UpdateVisibility

[INTERNAL] Updates the stored visibility calculations of the chat.

Properties

Name
Type
Description

IsVisible

bool

Returns the current state of this chat being visible.

Username

string

The exact username that was provided when registering a chat. If the provided username contained a number, this string includes that number for reference.

DisplayUsername

string

The display username. If the username provided when registering a chat contained a number, then this string will be just the name portion, excluding the associated number.

Message

string

The exact string value provided to the chat box for the message.

DisplayMessage

string

The modified string value with all the users options applied to it so that it looks correct.

PreviousPublic ClassesNextChatStyle

Last updated 6 months ago

Was this helpful?

📖