> For the complete documentation index, see [llms.txt](https://docs.tankandhealerstudio.com/assets/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation.md). # Documentation - [UltimateChatBox](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox.md): The UltimateChatBox class is the main component of this Asset. - [Public Methods](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-methods.md): A list of all the public methods in the UltimateChatBox class. - [RegisterChat (+4 overloads)](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-methods/registerchat-+4-overloads.md): Registers the chat information to the chat box so that it will be displayed to the player. - [Enable](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-methods/enable.md): Enables the chat box so that it can be interacted with. - [Disable](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-methods/disable.md): Disables the chat box so that it will not receive input. - [ClearChat](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-methods/clearchat.md): Clears the chat box of all registered chat entries. - [EnableInputField](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-methods/enableinputfield.md): Enables the input field associated with the Ultimate Chat Box. If a string is provided to the function, the input field will be opened with the string value applied. - [ToggleInputField](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-methods/toggleinputfield.md): Toggles the state of the input field associated with the Ultimate Chat Box. - [DisableInputField](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-methods/disableinputfield.md): Disables the input field associated with the Ultimate Chat Box. - [SendCustomInput](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-methods/sendcustominput.md): Sends custom input to the chat box to process. - [FindChatsFromUser](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-methods/findchatsfromuser.md): Returns all the chats that have been registered with the targeted username. - [FindChatsOfStyle](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-methods/findchatsofstyle.md): Returns all the chats that have been registered with the targeted style. - [UpdatePositioning](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-methods/updatepositioning.md): This function is used internally to update the positioning of the chat box on the screen on Application start, and any time the screen changes size. You will most likely never need to use this. - [Events](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/events.md): List of available events - [OnChatRegistered](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/events/onchatregistered.md): This callback is invoked any time a chat is registered to the Ultimate Chat Box. - [OnUsernameHover](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/events/onusernamehover.md): This callback is invoked when a username has been hovered in the chat box. Only called when Interactable Usernames is enabled. - [OnUsernameInteract](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/events/onusernameinteract.md): This callback is invoked when a username has been interacted with in the chat box. Only called when Interactable Usernames is enabled. - [OnInputFieldUpdated](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/events/oninputfieldupdated.md): This event is called when the input field of the chat box has been updated. - [OnInputFieldSubmitted](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/events/oninputfieldsubmitted.md): This event is called when the input field of the chat box has been submitted. - [OnInputFieldCommandUpdated](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/events/oninputfieldcommandupdated.md): This event is called when the input field is updated and contains a potential command. - [OnInputFieldCommandSubmitted](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/events/oninputfieldcommandsubmitted.md): This event is called when the input field is submitted and contains a potential command. - [OnExtraImageInteract](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/events/onextraimageinteract.md): This event is called when the extra image associated with the input field has been interacted with. - [Public Classes](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-classes.md): Below is a list of all the public classes inside the Ultimate Chat Box script. - [ChatInformation](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-classes/chatinformation.md): The ChatInformation class stores all the information about the chat that was registered to the chat box. - [ChatStyle](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/public-classes/chatstyle.md): The ChatStyle class stores all the settings of a message style for the chat box. - [Properties](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatbox/properties.md): Below is a list of all the properties in the UltimateChatBox class. - [UltimateChatBoxStyles](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatboxstyles.md): A basic list of default styles that you can use. - [Creating a custom Chat Style](https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation/ultimatechatboxstyles/creating-a-custom-chat-style.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.tankandhealerstudio.com/assets/ultimatechatbox/documentation.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.