//------------------------------------------------------------
// Game Framework
// Copyright © 2013-2021 loyalsoft. All rights reserved.
// Homepage: http://www.game7000.com/
// Feedback: http://www.game7000.com/
//------------------------------------------------------------
using GameFramework;
using GameFramework.Setting;
using System;
using System.Collections.Generic;
using UnityEngine;
namespace UnityGameFramework.Runtime
{
///
/// 游戏配置组件。
///
[DisallowMultipleComponent]
[AddComponentMenu("Game Framework/Setting")]
public sealed class SettingComponent : GameFrameworkComponent
{
private ISettingManager m_SettingManager = null;
[SerializeField]
private string m_SettingHelperTypeName = "UnityGameFramework.Runtime.DefaultSettingHelper";
[SerializeField]
private SettingHelperBase m_CustomSettingHelper = null;
///
/// 获取游戏配置项数量。
///
public int Count
{
get
{
return m_SettingManager.Count;
}
}
///
/// 游戏框架组件初始化。
///
protected override void Awake()
{
base.Awake();
m_SettingManager = GameFrameworkEntry.GetModule();
if (m_SettingManager == null)
{
Log.Fatal("Setting manager is invalid.");
return;
}
SettingHelperBase settingHelper = Helper.CreateHelper(m_SettingHelperTypeName, m_CustomSettingHelper);
if (settingHelper == null)
{
Log.Error("Can not create setting helper.");
return;
}
settingHelper.name = "Setting Helper";
Transform transform = settingHelper.transform;
transform.SetParent(this.transform);
transform.localScale = Vector3.one;
m_SettingManager.SetSettingHelper(settingHelper);
}
private void Start()
{
if (!m_SettingManager.Load())
{
Log.Error("Load settings failure.");
}
}
///
/// 保存游戏配置。
///
public void Save()
{
m_SettingManager.Save();
}
///
/// 获取所有游戏配置项的名称。
///
/// 所有游戏配置项的名称。
public string[] GetAllSettingNames()
{
return m_SettingManager.GetAllSettingNames();
}
///
/// 获取所有游戏配置项的名称。
///
/// 所有游戏配置项的名称。
public void GetAllSettingNames(List results)
{
m_SettingManager.GetAllSettingNames(results);
}
///
/// 检查是否存在指定游戏配置项。
///
/// 要检查游戏配置项的名称。
/// 指定的游戏配置项是否存在。
public bool HasSetting(string settingName)
{
return m_SettingManager.HasSetting(settingName);
}
///
/// 移除指定游戏配置项。
///
/// 要移除游戏配置项的名称。
public void RemoveSetting(string settingName)
{
m_SettingManager.RemoveSetting(settingName);
}
///
/// 清空所有游戏配置项。
///
public void RemoveAllSettings()
{
m_SettingManager.RemoveAllSettings();
}
///
/// 从指定游戏配置项中读取布尔值。
///
/// 要获取游戏配置项的名称。
/// 读取的布尔值。
public bool GetBool(string settingName)
{
return m_SettingManager.GetBool(settingName);
}
///
/// 从指定游戏配置项中读取布尔值。
///
/// 要获取游戏配置项的名称。
/// 当指定的游戏配置项不存在时,返回此默认值。
/// 读取的布尔值。
public bool GetBool(string settingName, bool defaultValue)
{
return m_SettingManager.GetBool(settingName, defaultValue);
}
///
/// 向指定游戏配置项写入布尔值。
///
/// 要写入游戏配置项的名称。
/// 要写入的布尔值。
public void SetBool(string settingName, bool value)
{
m_SettingManager.SetBool(settingName, value);
}
///
/// 从指定游戏配置项中读取整数值。
///
/// 要获取游戏配置项的名称。
/// 读取的整数值。
public int GetInt(string settingName)
{
return m_SettingManager.GetInt(settingName);
}
///
/// 从指定游戏配置项中读取整数值。
///
/// 要获取游戏配置项的名称。
/// 当指定的游戏配置项不存在时,返回此默认值。
/// 读取的整数值。
public int GetInt(string settingName, int defaultValue)
{
return m_SettingManager.GetInt(settingName, defaultValue);
}
///
/// 向指定游戏配置项写入整数值。
///
/// 要写入游戏配置项的名称。
/// 要写入的整数值。
public void SetInt(string settingName, int value)
{
m_SettingManager.SetInt(settingName, value);
}
///
/// 从指定游戏配置项中读取浮点数值。
///
/// 要获取游戏配置项的名称。
/// 读取的浮点数值。
public float GetFloat(string settingName)
{
return m_SettingManager.GetFloat(settingName);
}
///
/// 从指定游戏配置项中读取浮点数值。
///
/// 要获取游戏配置项的名称。
/// 当指定的游戏配置项不存在时,返回此默认值。
/// 读取的浮点数值。
public float GetFloat(string settingName, float defaultValue)
{
return m_SettingManager.GetFloat(settingName, defaultValue);
}
///
/// 向指定游戏配置项写入浮点数值。
///
/// 要写入游戏配置项的名称。
/// 要写入的浮点数值。
public void SetFloat(string settingName, float value)
{
m_SettingManager.SetFloat(settingName, value);
}
///
/// 从指定游戏配置项中读取字符串值。
///
/// 要获取游戏配置项的名称。
/// 读取的字符串值。
public string GetString(string settingName)
{
return m_SettingManager.GetString(settingName);
}
///
/// 从指定游戏配置项中读取字符串值。
///
/// 要获取游戏配置项的名称。
/// 当指定的游戏配置项不存在时,返回此默认值。
/// 读取的字符串值。
public string GetString(string settingName, string defaultValue)
{
return m_SettingManager.GetString(settingName, defaultValue);
}
///
/// 向指定游戏配置项写入字符串值。
///
/// 要写入游戏配置项的名称。
/// 要写入的字符串值。
public void SetString(string settingName, string value)
{
m_SettingManager.SetString(settingName, value);
}
///
/// 从指定游戏配置项中读取对象。
///
/// 要读取对象的类型。
/// 要获取游戏配置项的名称。
/// 读取的对象。
public T GetObject(string settingName)
{
return m_SettingManager.GetObject(settingName);
}
///
/// 从指定游戏配置项中读取对象。
///
/// 要读取对象的类型。
/// 要获取游戏配置项的名称。
/// 读取的对象。
public object GetObject(Type objectType, string settingName)
{
return m_SettingManager.GetObject(objectType, settingName);
}
///
/// 从指定游戏配置项中读取对象。
///
/// 要读取对象的类型。
/// 要获取游戏配置项的名称。
/// 当指定的游戏配置项不存在时,返回此默认对象。
/// 读取的对象。
public T GetObject(string settingName, T defaultObj)
{
return m_SettingManager.GetObject(settingName, defaultObj);
}
///
/// 从指定游戏配置项中读取对象。
///
/// 要读取对象的类型。
/// 要获取游戏配置项的名称。
/// 当指定的游戏配置项不存在时,返回此默认对象。
/// 读取的对象。
public object GetObject(Type objectType, string settingName, object defaultObj)
{
return m_SettingManager.GetObject(objectType, settingName, defaultObj);
}
///
/// 向指定游戏配置项写入对象。
///
/// 要写入对象的类型。
/// 要写入游戏配置项的名称。
/// 要写入的对象。
public void SetObject(string settingName, T obj)
{
m_SettingManager.SetObject(settingName, obj);
}
///
/// 向指定游戏配置项写入对象。
///
/// 要写入游戏配置项的名称。
/// 要写入的对象。
public void SetObject(string settingName, object obj)
{
m_SettingManager.SetObject(settingName, obj);
}
}
}