⚡Getting Started

Let's take a look at the Ultimate Chat Box and see how to get it working in your project as quick as possible!

The Ultimate Chat Box is designed to be as simple and easy to use as possible. You will only need a few lines of code in order to get the Ultimate Chat Box working in your project.

To begin we'll look at how to simply create an Ultimate Chat Box in your scene. After that we will go over how to reference the Ultimate Chat Box in your custom scripts. Let's begin!

How to Create

To create an Ultimate Chat Box in your scene, simply find the Ultimate Chat Box prefab that you would like to add and drag the prefab into your scene. It should automatically set itself as a child of a UI Canvas or create one if necessary.

Prefabs can be found at: Assets/Tank & Healer Studio/Ultimate Chat Box/Prefabs

How to Reference

The Ultimate Chat Box was created from ground up to be as simple to implement as possible. While there is a lot that can be done with the chat box, implementing it into your code is incredibly simple.

---

It's worth noting that Unity recently made changes to their Asset Store guidelines that requires all code to be within a namespace. This means that you will need to add the using tag at the top of your script for TankAndHealerStudioAssets.

using TankAndHealerStudioAssets;

---

To add chat to the Ultimate Chat Box, all you need to do is use the RegisterChat function along with the information about the chat. Then the Ultimate Chat Box will do the rest.

// SIMPLE EXAMPLE CODE //
chatBox.RegisterChat( "Username", "Message" );

Chat from the Input Field: If you have the Input Field option enabled on the chat box, you can use the OnInputFieldSubmitted callback to be notified when the player has submitted chat through the input field. Then, inside your own code, you can send the chat to the server and then the Ultimate Chat Box if you would like.

Now you are ready to start adding chat into the Ultimate Chat Box!

For a full list of the functions available, please see the Documentation section.