Clan Chat Director
Support us as a GitHub Sponsor and get instant access to all our assets, exclusive tools and assets, escalated support and issue tracking and our gratitude.
These articles are made possible by our GitHub Sponsors ... become a sponsor today!
This tool simply exposes features present in the API to the inspector.
This is not required to use these features it is simply a helper tool allowing user's who are more comfortable working with editor inspectors and game object rather than classic C# objects and scripting to make use of the related feature.
The Clan Chat Director is intended to be attached to your Clan/Group chat UI. You will then need to call the Join method to connect the director to a specific clan's chat. Assuming the user is permitted to be in that chat you will now start receiving messages from that chat and send messages to that chat.
For smaller groups/clans you can also iterate over the members of the chat however be advised that most Steam groups / clans get very large and cannot be iterated over by the user.
using HeathenEngineering.SteamworksIntegration;
public class ClanChatDirector : MonoBehaviour;
UserData[] | Members | Returns the members in this chat room if the user is able to iterate over them. |
bool | IsOpenInSteam | True if the clan chat is open in Steam client or oen of its dialogs |
bool | InRoom | True if the system has been connected to a room succesfuly. Note it is possible to be removed a room and this not be updated. You should handle errors when attempting to send and adjust accordingly. |
ChatRoom | ChatRoom | Returns the ChatRoom object that is being operated on if any. If none then this will return a default ChatRoom with an invalid ID |
Occurs when a member joins the room
Occurs when a message is received to this room
Occurs when a member leaves the room
public void Join(Clan clan);
Joins the chat for the indicated clan
public void Leave();
Leaves the chat if present
public bool Send(string message);
Sends a chat message if present
public void OpenInSteam();
Opens the clan chat in Steam's overlay or chat dialog
Last modified 3mo ago