123 lines
4.2 KiB
C#
123 lines
4.2 KiB
C#
|
/// ---------------------------------------------
|
|||
|
|
/// Ultimate Character Controller
|
|||
|
|
/// Copyright (c) Opsive. All Rights Reserved.
|
|||
|
|
/// https://www.opsive.com
|
|||
|
|
/// ---------------------------------------------
|
|||
|
|
|
|||
|
|
namespace Opsive.UltimateCharacterController.UI
|
|||
|
|
{
|
|||
|
|
using Opsive.Shared.Events;
|
|||
|
|
using Opsive.Shared.Game;
|
|||
|
|
using Opsive.UltimateCharacterController.StateSystem;
|
|||
|
|
using Opsive.UltimateCharacterController.Utility;
|
|||
|
|
using UnityEngine;
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// The CameraMonitor component allows for UI elements to mapped to a specific character (allowing for split screen and coop).
|
|||
|
|
/// </summary>
|
|||
|
|
public abstract class CharacterMonitor : StateBehavior
|
|||
|
|
{
|
|||
|
|
[Tooltip("The character that uses the UI represents. Can be null.")]
|
|||
|
|
[SerializeField] protected GameObject m_Character;
|
|||
|
|
[Tooltip("Is the UI visible?")]
|
|||
|
|
[SerializeField] protected bool m_Visible = true;
|
|||
|
|
|
|||
|
|
public GameObject Character { get { return m_Character; } set { OnAttachCharacter(value); } }
|
|||
|
|
public bool Visible { get { return m_Visible; } set { m_Visible = value; ShowUI(m_ShowUI); } }
|
|||
|
|
|
|||
|
|
protected bool m_ShowUI = true;
|
|||
|
|
protected GameObject m_CameraGameObject;
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Initialize the default values.
|
|||
|
|
/// </summary>
|
|||
|
|
protected override void Awake()
|
|||
|
|
{
|
|||
|
|
base.Awake();
|
|||
|
|
|
|||
|
|
var camera = UnityEngineUtility.FindCamera(m_Character);
|
|||
|
|
if (camera != null) {
|
|||
|
|
m_CameraGameObject = camera.gameObject;
|
|||
|
|
if (m_Character == null) {
|
|||
|
|
m_Character = m_CameraGameObject.GetCachedComponent<UltimateCharacterController.Camera.CameraController>().Character;
|
|||
|
|
}
|
|||
|
|
EventHandler.RegisterEvent<GameObject>(m_CameraGameObject, "OnCameraAttachCharacter", OnAttachCharacter);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
// Start disabled - attaching the character will enabe the component.
|
|||
|
|
enabled = false;
|
|||
|
|
|
|||
|
|
if (m_Character != null) {
|
|||
|
|
var character = m_Character;
|
|||
|
|
m_Character = null;
|
|||
|
|
OnAttachCharacter(character);
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Attaches the monitor to the specified character.
|
|||
|
|
/// </summary>
|
|||
|
|
/// <param name="character">The character to attach the monitor to.</param>
|
|||
|
|
protected virtual void OnAttachCharacter(GameObject character)
|
|||
|
|
{
|
|||
|
|
if (m_Character == character) {
|
|||
|
|
return;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (m_Character != null) {
|
|||
|
|
StateManager.LinkGameObjects(m_Character, gameObject, false);
|
|||
|
|
EventHandler.UnregisterEvent<bool>(m_Character, "OnShowUI", ShowUI);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
m_Character = character;
|
|||
|
|
|
|||
|
|
if (m_Character != null) {
|
|||
|
|
StateManager.LinkGameObjects(m_Character, gameObject, true);
|
|||
|
|
EventHandler.RegisterEvent<bool>(m_Character, "OnShowUI", ShowUI);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
// The monitor may be in the process of being destroyed.
|
|||
|
|
enabled = m_Character != null;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Hides the UI if it's not visible.
|
|||
|
|
/// </summary>
|
|||
|
|
public void Start()
|
|||
|
|
{
|
|||
|
|
if (!CanShowUI()) {
|
|||
|
|
gameObject.SetActive(false);
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Shows or hides the UI.
|
|||
|
|
/// </summary>
|
|||
|
|
/// <param name="show">Should the UI be shown?</param>
|
|||
|
|
private void ShowUI(bool show)
|
|||
|
|
{
|
|||
|
|
m_ShowUI = show;
|
|||
|
|
gameObject.SetActive(CanShowUI());
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Can the UI be shown?
|
|||
|
|
/// </summary>
|
|||
|
|
/// <returns>True if the UI can be shown.</returns>
|
|||
|
|
protected virtual bool CanShowUI()
|
|||
|
|
{
|
|||
|
|
return m_ShowUI && m_Visible;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// The object has been destroyed.
|
|||
|
|
/// </summary>
|
|||
|
|
protected virtual void OnDestroy()
|
|||
|
|
{
|
|||
|
|
if (m_CameraGameObject != null) {
|
|||
|
|
EventHandler.UnregisterEvent<GameObject>(m_CameraGameObject, "OnCameraAttachCharacter", OnAttachCharacter);
|
|||
|
|
}
|
|||
|
|
OnAttachCharacter(null);
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|