Class SocialUIPopup

This is largely the same as ChatPopup. We need different references here like Player instead of UIChatMessage for example. A popup container for propagating clicks on Social UI elements.

Assign your own custom subclass of SocialUIClickHandler to manage the actual clicking functionality.

Note: OnDeselect(BaseEventData) calls UnityEngine.Animator.SetTrigger(System.String) with FADE_OUT. To avoid warnings the UnityEngine.RuntimeAnimatorController should have a Trigger with that name.

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

SocialUIPopup

Implements

UnityEngine.EventSystems.IDeselectHandler

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 SocialUIPopup : MonoBehaviour, IDeselectHandler, IEventSystemHandler

Fields

AnimationController

Optional RuntimeAnimatorController. If assigned it will override whatever is assigned to the animator in Awake().

Declaration

public RuntimeAnimatorController AnimationController

Field Value

Type	Description
UnityEngine.RuntimeAnimatorController

animator

Animator for this Popup. Automatically assigned in Awake(). If AnimationController is assigned, will override whatever is set up in the inspector.

Declaration

[HideInInspector]
public Animator animator

Field Value

Type	Description
UnityEngine.Animator

canvasGroup

CanvasGroup for this Popup. Automatically assigned / configured in Awake().

Declaration

[HideInInspector]
public CanvasGroup canvasGroup

Field Value

Type	Description
UnityEngine.CanvasGroup

chatPanel

Chat Panel instance. This is assigned by the ChatPanel.

Declaration

public ChatPanel chatPanel

Field Value

Type	Description
ChatPanel

ClickedPlayer

The Player that was clicked.

Declaration

public SocialPlayer ClickedPlayer

Field Value

Type	Description
SocialPlayer

ClickHandler

Click handler to manage events.

Declaration

public SocialUIClickHandler ClickHandler

Field Value

Type	Description
SocialUIClickHandler

IsSelected

If this is selected or not. If you want to show this popup then you should assign it to true in your custom HandleClick(ChatPopup, TMP_LinkInfo, PointerEventData). Is set to false automatically in the OnDeselect(BaseEventData).

Declaration

public bool IsSelected

Field Value

Type	Description
System.Boolean

LocalPlayer

Local Player_Chat instance. Assigned in OnStartLocalPlayer().

Declaration

public Player_Chat LocalPlayer

Field Value

Type	Description
Player_Chat

Options

List of available Chat Item options.

Declaration

public List<DynamicChatItem> Options

Field Value

Type	Description
System.Collections.Generic.List<DynamicChatItem>

rectTransform

RectTransform for this Popup. Automatically assigned / configured in Awake()

Declaration

[HideInInspector]
public RectTransform rectTransform

Field Value

Type	Description
UnityEngine.RectTransform

selectable

Selectable for this Popup. Automatically assigned / configured in Awake()

Declaration

[HideInInspector]
public Selectable selectable

Field Value

Type	Description
UnityEngine.UI.Selectable

Methods

Awake()

Sets up the component, adds required components if missing

Declaration

protected virtual void Awake()

HandleClick(SocialPlayer, PointerEventData)

Just calls the click handler and give it a referece to this class since we have a lot of referenes it will need to do any interesting behaviors.

Declaration

public virtual void HandleClick(SocialPlayer ClickedPlayer, PointerEventData pointerEventData)

Parameters

Type	Name	Description
SocialPlayer	ClickedPlayer	Player that was clicked on.
UnityEngine.EventSystems.PointerEventData	pointerEventData	Event Data

OnDeselect(BaseEventData)

This is automatically called on deselect because of UnityEngine.EventSystems.IDeselectHandler. Resets IsSelected = false and calls UnityEngine.Animator.SetTrigger(System.String) with FADE_OUT.

Declaration

public virtual void OnDeselect(BaseEventData eventData)

Parameters

Type	Name	Description
UnityEngine.EventSystems.BaseEventData	eventData

Implements

UnityEngine.EventSystems.IDeselectHandler

UnityEngine.EventSystems.IEventSystemHandler