GUIChatSurface

From Virtual World Web Wiki
Jump to: navigation, search

A GUI surface that can receive chat messages on particular channels

  • Inherits class: GUIScrollBox
  • This is a JavaScript visible object

Remarks [edit]

Properties

bool AllowRichText {get; set;}
Should we strip or allow rich-text markup in chat messages?
bool DropShadow {get; set;}
Enables a drop shadow on the chat message text.
Color32 DropShadowColor {get; set;}
If we're using a dropshadow on the text, what color should it be.
int FontSize {get; set;}
How large should the chat messages appear
Color32 LinkColor {get; set;}
What color should links be displayed in
bool LinksEnabled {get; set;}
Should the chat surface try and identify URLs in the message text and make them into clickable links.
int MaximumMessages {get; set;}
How much of a message backlog should this surface keep?
string TimeStampFormat {get; set;}
A text string that represents the way the timestamp should be formatted.
https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx

Methods

bool AddChatChannel(Guid? channel = NULL)
Adds a listening channel to this ChatSurface. Messages from that channel will start appearing on it.
string[] GetLevelModifiers()
bool RemoveChatChannel(Guid? channel = NULL)
Removes a listening channel to this ChatSurface. No further messages from that channel will appear on it.
void SetLevelModifier(ColorLevelPreSets level, string start, string end)
Used to place markup or text on either end of messages coming in with a particular Level modifier (Friend, Staff, Self, etc)