Class UIChatMessage

This is the control for messages displayed on the UI. Currently it supports Clicking, Hovering, and Unhovering as defined by IPointerClickHandler, IPointerEnterHandler, IPointerExitHandler If you would like to add more events, you can implement other I[some event]Handlers and do whatever logic you would like to do there, similar to how these 3 have been implemented.

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
UIChatMessage
Implements
UnityEngine.EventSystems.IPointerClickHandler
UnityEngine.EventSystems.IPointerEnterHandler
UnityEngine.EventSystems.IPointerExitHandler
UnityEngine.EventSystems.IEventSystemHandler
Inherited Members
UnityEngine.MonoBehaviour.IsInvoking()
UnityEngine.MonoBehaviour.CancelInvoke()
UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)
UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)
UnityEngine.MonoBehaviour.CancelInvoke(System.String)
UnityEngine.MonoBehaviour.IsInvoking(System.String)
UnityEngine.MonoBehaviour.StartCoroutine(System.String)
UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)
UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)
UnityEngine.MonoBehaviour.StopCoroutine(System.String)
UnityEngine.MonoBehaviour.StopAllCoroutines()
UnityEngine.MonoBehaviour.print(System.Object)
UnityEngine.MonoBehaviour.useGUILayout
UnityEngine.MonoBehaviour.runInEditMode
UnityEngine.Behaviour.enabled
UnityEngine.Behaviour.isActiveAndEnabled
UnityEngine.Component.GetComponent(System.Type)
UnityEngine.Component.GetComponent<T>()
UnityEngine.Component.TryGetComponent(System.Type, UnityEngine.Component)
UnityEngine.Component.TryGetComponent<T>(T)
UnityEngine.Component.GetComponent(System.String)
UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)
UnityEngine.Component.GetComponentInChildren(System.Type)
UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)
UnityEngine.Component.GetComponentInChildren<T>()
UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)
UnityEngine.Component.GetComponentsInChildren(System.Type)
UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)
UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentsInChildren<T>()
UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentInParent(System.Type)
UnityEngine.Component.GetComponentInParent<T>()
UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)
UnityEngine.Component.GetComponentsInParent(System.Type)
UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)
UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentsInParent<T>()
UnityEngine.Component.GetComponents(System.Type)
UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)
UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponents<T>()
UnityEngine.Component.CompareTag(System.String)
UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessageUpwards(System.String, System.Object)
UnityEngine.Component.SendMessageUpwards(System.String)
UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessage(System.String, System.Object)
UnityEngine.Component.SendMessage(System.String)
UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.BroadcastMessage(System.String, System.Object)
UnityEngine.Component.BroadcastMessage(System.String)
UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.transform
UnityEngine.Component.gameObject
UnityEngine.Component.tag
UnityEngine.Object.GetInstanceID()
UnityEngine.Object.GetHashCode()
UnityEngine.Object.Equals(System.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Instantiate<T>(T)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)
UnityEngine.Object.Destroy(UnityEngine.Object)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object)
UnityEngine.Object.FindObjectsOfType(System.Type)
UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)
UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)
UnityEngine.Object.DestroyObject(UnityEngine.Object)
UnityEngine.Object.FindSceneObjectsOfType(System.Type)
UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)
UnityEngine.Object.FindObjectsOfType<T>()
UnityEngine.Object.FindObjectOfType<T>()
UnityEngine.Object.FindObjectsOfTypeAll(System.Type)
UnityEngine.Object.FindObjectOfType(System.Type)
UnityEngine.Object.ToString()
UnityEngine.Object.name
UnityEngine.Object.hideFlags
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: LlamaSoftware.Chat.UI
Assembly: LlamaSoftware.Chat.dll
Syntax
public class UIChatMessage : MonoBehaviour, IPointerClickHandler, IPointerEnterHandler, IPointerExitHandler, IEventSystemHandler

Fields

chatPanel

Declaration
[Space]
[Header("Debug Info - Set by scripts")]
[Tooltip("The ChatPanel this message belongs to.\nIf unset that is a dangerous situation.")]
public ChatPanel chatPanel
Field Value
Type Description
ChatPanel

DefaultColor

Declaration
[Tooltip("The default color for text. This is dynamically overridden by the ChatPanel on a channel-by-channel basis, however Server Messages will be displayed in this color.")]
public Color32 DefaultColor
Field Value
Type Description
UnityEngine.Color32
Declaration
[Tooltip("Select all the types of Links you would like to highlight on mouse over.\nThis typically indicates you want to allow the user to interact with this text somehow")]
public List<LinkType> HighlightLinks
Field Value
Type Description
System.Collections.Generic.List<LinkType>

HoverColor

Declaration
[Tooltip("The color text should change to when a user mouses over a Link")]
public Color32 HoverColor
Field Value
Type Description
UnityEngine.Color32

HoveredLinkId

Declaration
[Tooltip("The LinkId of the hovered text")]
public int HoveredLinkId
Field Value
Type Description
System.Int32

IsDirectMessage

Declaration
[Tooltip("If this message is a direct message or not")]
public bool IsDirectMessage
Field Value
Type Description
System.Boolean

IsTextHovered

Declaration
[Tooltip("If this has a pointer over it")]
public bool IsTextHovered
Field Value
Type Description
System.Boolean

Message

Declaration
[Header("Configuration")]
[Tooltip("The TextMeshProUGUI object to put text into")]
public TextMeshProUGUI Message
Field Value
Type Description
TMPro.TextMeshProUGUI

PlayerId

Declaration
[Tooltip("The Id of the Player who sent this message")]
public string PlayerId
Field Value
Type Description
System.String

PlayerName

Declaration
[Tooltip("The Name of the Player who sent this message")]
public string PlayerName
Field Value
Type Description
System.String

Methods

OnPointerClick(PointerEventData)

Propagates the Click event from UnityEngine.EventSystems.EventTrigger / UnityEngine.EventSystems.IPointerClickHandler to the HandleOnPointerClick(PointerEventData). Called automatically by the EventTrigger

Declaration
public virtual void OnPointerClick(PointerEventData eventData)
Parameters
Type Name Description
UnityEngine.EventSystems.PointerEventData eventData

Event data from the click.

OnPointerEnter(PointerEventData)

Changes any link text to the HoverColor

Declaration
public virtual void OnPointerEnter(PointerEventData eventData)
Parameters
Type Name Description
UnityEngine.EventSystems.PointerEventData eventData

Event data from the PointerEnter event.

OnPointerExit(PointerEventData)

Restores link text to original colors.

Declaration
public virtual void OnPointerExit(PointerEventData eventData)
Parameters
Type Name Description
UnityEngine.EventSystems.PointerEventData eventData

Event data from the PointerExit event

RestoreLinkToOriginalColor()

Restores link text to the original message color

Declaration
protected virtual void RestoreLinkToOriginalColor()

Update()

Hanadles calling RestoreLinkToOriginalColor() and UpdateLinkToHoveredColor() based on mouse position.

Declaration
protected virtual void Update()

UpdateLinkToHoveredColor()

Updates any Link text to the HoverColor

Declaration
protected virtual void UpdateLinkToHoveredColor()

Implements

UnityEngine.EventSystems.IPointerClickHandler
UnityEngine.EventSystems.IPointerEnterHandler
UnityEngine.EventSystems.IPointerExitHandler
UnityEngine.EventSystems.IEventSystemHandler