Class ChatChannel
Information regarding Chat Channels such as Channel Name, Channel Identifier, and Overlap radius for local chat channels.
Inheritance
System.Object
ChatChannel
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Assembly: LlamaSoftware.Chat.Model.dll
Syntax
[Serializable]
public class ChatChannel
Fields
Channel
Must be globally unique. This is the differentiator between different chat channels. Having multiple chat channels with the same Channel will lead to messages being sent to unintended recipients.
Declaration
Field Value
| Type |
Description |
| System.UInt32 |
|
ChannelColor
Color the Chat Message should be displayed on the UI.
Declaration
public Color ChannelColor
Field Value
| Type |
Description |
| UnityEngine.Color |
|
IsRegionalChat
Indicates if this chat channel is dynamic. Things like should typically be Regional Chat Channels.
Channels like "Trade" or "General" should not be marked as IsRegionalChat.
When this is true, the channel will not be persisted. Meaning the next time a player logs in they will not be automatically resubscribed to that channel.
Any channels marked as !IsRegionalChat will be persisted and players will be resubscribed the next time they log in.
Declaration
public bool IsRegionalChat
Field Value
| Type |
Description |
| System.Boolean |
|
LocalOverlapRadius
Radius from the sending player that constitutes "local chat" - players outside of this radius will not receive messages.
Only used if Type is LOCAL.
Declaration
public uint LocalOverlapRadius
Field Value
| Type |
Description |
| System.UInt32 |
|
Name
Display name of the Channel
Declaration
Field Value
| Type |
Description |
| System.String |
|
Type
Declaration
public ChatChannel.ChatType Type
Field Value
Methods
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
| Type |
Name |
Description |
| System.Object |
obj |
|
Returns
| Type |
Description |
| System.Boolean |
|
Overrides
System.Object.Equals(System.Object)
GetHashCode()
Declaration
public override int GetHashCode()
Returns
| Type |
Description |
| System.Int32 |
|
Overrides
System.Object.GetHashCode()
ToString()
Declaration
public override string ToString()
Returns
| Type |
Description |
| System.String |
|
Overrides
System.Object.ToString()