Difference between revisions of "GUIChatSurface"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the GUIChatSurface class)
(Documentation for the GUIChatSurface class)
Line 1: Line 1:
A GUI surface that can receive chat messages on particular channels
 
 
 
*'''Inherits class: [[GUIScrollBox]]'''
 
*'''Inherits class: [[GUIScrollBox]]'''
 
* This is a JavaScript visible object
 
* This is a JavaScript visible object
Line 8: Line 6:
 
===Properties===
 
===Properties===
 
:{{CSharp|bool AllowRichText {get; set;} }}
 
:{{CSharp|bool AllowRichText {get; set;} }}
::
 
::Should we strip or allow rich-text markup in chat messages?
 
  
 
:{{CSharp|bool DropShadow {get; set;} }}
 
:{{CSharp|bool DropShadow {get; set;} }}
::
 
::Enables a drop shadow on the chat message text.
 
  
 
:{{CSharp|Color32 DropShadowColor {get; set;} }}
 
:{{CSharp|Color32 DropShadowColor {get; set;} }}
::
 
::If we're using a dropshadow on the text, what color should it be.
 
  
 
:{{CSharp|int FontSize {get; set;} }}
 
:{{CSharp|int FontSize {get; set;} }}
::
 
::How large should the chat messages appear
 
  
 
:{{CSharp|Color32 LinkColor {get; set;} }}
 
:{{CSharp|Color32 LinkColor {get; set;} }}
::
 
::What color should links be displayed in
 
  
 
:{{CSharp|bool LinksEnabled {get; set;} }}
 
:{{CSharp|bool LinksEnabled {get; set;} }}
::
 
::Should the chat surface try and identify URLs in the message text and make them into clickable links.
 
  
 
:{{CSharp|int MaximumMessages {get; set;} }}
 
:{{CSharp|int MaximumMessages {get; set;} }}
::
 
::How much of a message backlog should this surface keep?
 
  
 
:{{CSharp|string TimeStampFormat {get; set;} }}
 
:{{CSharp|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===
 
===Methods===
 
:{{CSharp|bool AddChatChannel(Guid? channel {{=}} NULL)}}
 
:{{CSharp|bool AddChatChannel(Guid? channel {{=}} NULL)}}
::
 
::Adds a listening channel to this ChatSurface. Messages from that channel will start appearing on it.
 
  
 
:{{CSharp|bool RemoveChatChannel(Guid? channel {{=}} NULL)}}
 
:{{CSharp|bool RemoveChatChannel(Guid? channel {{=}} NULL)}}
::
 
::Removes a listening channel to this ChatSurface. No further messages from that channel will appear on it.
 
  
 
:{{CSharp|void SetLevelModifier(ColorLevelPreSets level, string start, string end)}}
 
:{{CSharp|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)
 
  
 
__NOTOC____NOEDITSECTION__
 
__NOTOC____NOEDITSECTION__

Revision as of 14:16, 15 January 2018

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

Remarks [edit]

Properties

bool AllowRichText {get; set;}
bool DropShadow {get; set;}
Color32 DropShadowColor {get; set;}
int FontSize {get; set;}
Color32 LinkColor {get; set;}
bool LinksEnabled {get; set;}
int MaximumMessages {get; set;}
string TimeStampFormat {get; set;}

Methods

bool AddChatChannel(Guid? channel = NULL)
bool RemoveChatChannel(Guid? channel = NULL)
void SetLevelModifier(ColorLevelPreSets level, string start, string end)