Skip to content

Commit e0ce6e0

Browse files
author
Jiang Yin
committed
调整配置接口
1 parent 1ca283e commit e0ce6e0

File tree

3 files changed

+244
-144
lines changed

3 files changed

+244
-144
lines changed

‎GameFramework/Setting/ISettingHelper.cs‎

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -29,156 +29,156 @@ public interface ISettingHelper
2929
/// <summary>
3030
/// 检查是否存在指定配置项。
3131
/// </summary>
32-
/// <param name="key">要检查配置项的名称。</param>
32+
/// <param name="settingName">要检查配置项的名称。</param>
3333
/// <returns>指定的配置项是否存在。</returns>
34-
bool HasKey(string key);
34+
bool HasSetting(string settingName);
3535

3636
/// <summary>
3737
/// 移除指定配置项。
3838
/// </summary>
39-
/// <param name="key">要移除配置项的名称。</param>
40-
void RemoveKey(string key);
39+
/// <param name="settingName">要移除配置项的名称。</param>
40+
void RemoveSetting(string settingName);
4141

4242
/// <summary>
4343
/// 清空所有配置项。
4444
/// </summary>
45-
void RemoveAllKeys();
45+
void RemoveAllSettings();
4646

4747
/// <summary>
4848
/// 从指定配置项中读取布尔值。
4949
/// </summary>
50-
/// <param name="key">要获取配置项的名称。</param>
50+
/// <param name="settingName">要获取配置项的名称。</param>
5151
/// <returns>读取的布尔值。</returns>
52-
bool GetBool(string key);
52+
bool GetBool(string settingName);
5353

5454
/// <summary>
5555
/// 从指定配置项中读取布尔值。
5656
/// </summary>
57-
/// <param name="key">要获取配置项的名称。</param>
57+
/// <param name="settingName">要获取配置项的名称。</param>
5858
/// <param name="defaultValue">当指定的配置项不存在时，返回此默认值。</param>
5959
/// <returns>读取的布尔值。</returns>
60-
bool GetBool(string key, bool defaultValue);
60+
bool GetBool(string settingName, bool defaultValue);
6161

6262
/// <summary>
6363
/// 向指定配置项写入布尔值。
6464
/// </summary>
65-
/// <param name="key">要写入配置项的名称。</param>
65+
/// <param name="settingName">要写入配置项的名称。</param>
6666
/// <param name="value">要写入的布尔值。</param>
67-
void SetBool(string key, bool value);
67+
void SetBool(string settingName, bool value);
6868

6969
/// <summary>
7070
/// 从指定配置项中读取整数值。
7171
/// </summary>
72-
/// <param name="key">要获取配置项的名称。</param>
72+
/// <param name="settingName">要获取配置项的名称。</param>
7373
/// <returns>读取的整数值。</returns>
74-
int GetInt(string key);
74+
int GetInt(string settingName);
7575

7676
/// <summary>
7777
/// 从指定配置项中读取整数值。
7878
/// </summary>
79-
/// <param name="key">要获取配置项的名称。</param>
79+
/// <param name="settingName">要获取配置项的名称。</param>
8080
/// <param name="defaultValue">当指定的配置项不存在时，返回此默认值。</param>
8181
/// <returns>读取的整数值。</returns>
82-
int GetInt(string key, int defaultValue);
82+
int GetInt(string settingName, int defaultValue);
8383

8484
/// <summary>
8585
/// 向指定配置项写入整数值。
8686
/// </summary>
87-
/// <param name="key">要写入配置项的名称。</param>
87+
/// <param name="settingName">要写入配置项的名称。</param>
8888
/// <param name="value">要写入的整数值。</param>
89-
void SetInt(string key, int value);
89+
void SetInt(string settingName, int value);
9090

9191
/// <summary>
9292
/// 从指定配置项中读取浮点数值。
9393
/// </summary>
94-
/// <param name="key">要获取配置项的名称。</param>
94+
/// <param name="settingName">要获取配置项的名称。</param>
9595
/// <returns>读取的浮点数值。</returns>
96-
float GetFloat(string key);
96+
float GetFloat(string settingName);
9797

9898
/// <summary>
9999
/// 从指定配置项中读取浮点数值。
100100
/// </summary>
101-
/// <param name="key">要获取配置项的名称。</param>
101+
/// <param name="settingName">要获取配置项的名称。</param>
102102
/// <param name="defaultValue">当指定的配置项不存在时，返回此默认值。</param>
103103
/// <returns>读取的浮点数值。</returns>
104-
float GetFloat(string key, float defaultValue);
104+
float GetFloat(string settingName, float defaultValue);
105105

106106
/// <summary>
107107
/// 向指定配置项写入浮点数值。
108108
/// </summary>
109-
/// <param name="key">要写入配置项的名称。</param>
109+
/// <param name="settingName">要写入配置项的名称。</param>
110110
/// <param name="value">要写入的浮点数值。</param>
111-
void SetFloat(string key, float value);
111+
void SetFloat(string settingName, float value);
112112

113113
/// <summary>
114114
/// 从指定配置项中读取字符串值。
115115
/// </summary>
116-
/// <param name="key">要获取配置项的名称。</param>
116+
/// <param name="settingName">要获取配置项的名称。</param>
117117
/// <returns>读取的字符串值。</returns>
118-
string GetString(string key);
118+
string GetString(string settingName);
119119

120120
/// <summary>
121121
/// 从指定配置项中读取字符串值。
122122
/// </summary>
123-
/// <param name="key">要获取配置项的名称。</param>
123+
/// <param name="settingName">要获取配置项的名称。</param>
124124
/// <param name="defaultValue">当指定的配置项不存在时，返回此默认值。</param>
125125
/// <returns>读取的字符串值。</returns>
126-
string GetString(string key, string defaultValue);
126+
string GetString(string settingName, string defaultValue);
127127

128128
/// <summary>
129129
/// 向指定配置项写入字符串值。
130130
/// </summary>
131-
/// <param name="key">要写入配置项的名称。</param>
131+
/// <param name="settingName">要写入配置项的名称。</param>
132132
/// <param name="value">要写入的字符串值。</param>
133-
void SetString(string key, string value);
133+
void SetString(string settingName, string value);
134134

135135
/// <summary>
136136
/// 从指定配置项中读取对象。
137137
/// </summary>
138138
/// <typeparam name="T">要读取对象的类型。</typeparam>
139-
/// <param name="key">要获取配置项的名称。</param>
139+
/// <param name="settingName">要获取配置项的名称。</param>
140140
/// <returns>读取的对象。</returns>
141-
T GetObject<T>(string key);
141+
T GetObject<T>(string settingName);
142142

143143
/// <summary>
144144
/// 从指定配置项中读取对象。
145145
/// </summary>
146146
/// <param name="objectType">要读取对象的类型。</param>
147-
/// <param name="key">要获取配置项的名称。</param>
147+
/// <param name="settingName">要获取配置项的名称。</param>
148148
/// <returns></returns>
149-
object GetObject(Type objectType, string key);
149+
object GetObject(Type objectType, string settingName);
150150

151151
/// <summary>
152152
/// 从指定配置项中读取对象。
153153
/// </summary>
154154
/// <typeparam name="T">要读取对象的类型。</typeparam>
155-
/// <param name="key">要获取配置项的名称。</param>
155+
/// <param name="settingName">要获取配置项的名称。</param>
156156
/// <param name="defaultObj">当指定的配置项不存在时，返回此默认对象。</param>
157157
/// <returns>读取的对象。</returns>
158-
T GetObject<T>(string key, T defaultObj);
158+
T GetObject<T>(string settingName, T defaultObj);
159159

160160
/// <summary>
161161
/// 从指定配置项中读取对象。
162162
/// </summary>
163163
/// <param name="objectType">要读取对象的类型。</param>
164-
/// <param name="key">要获取配置项的名称。</param>
164+
/// <param name="settingName">要获取配置项的名称。</param>
165165
/// <param name="defaultObj">当指定的配置项不存在时，返回此默认对象。</param>
166166
/// <returns></returns>
167-
object GetObject(Type objectType, string key, object defaultObj);
167+
object GetObject(Type objectType, string settingName, object defaultObj);
168168

169169
/// <summary>
170170
/// 向指定配置项写入对象。
171171
/// </summary>
172172
/// <typeparam name="T">要写入对象的类型。</typeparam>
173-
/// <param name="key">要写入配置项的名称。</param>
173+
/// <param name="settingName">要写入配置项的名称。</param>
174174
/// <param name="obj">要写入的对象。</param>
175-
void SetObject<T>(string key, T obj);
175+
void SetObject<T>(string settingName, T obj);
176176

177177
/// <summary>
178178
/// 向指定配置项写入对象。
179179
/// </summary>
180-
/// <param name="key">要写入配置项的名称。</param>
180+
/// <param name="settingName">要写入配置项的名称。</param>
181181
/// <param name="obj">要写入的对象。</param>
182-
void SetObject(string key, object obj);
182+
void SetObject(string settingName, object obj);
183183
}
184184
}

‎GameFramework/Setting/ISettingManager.cs‎

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -35,156 +35,156 @@ public interface ISettingManager
3535
/// <summary>
3636
/// 检查是否存在指定配置项。
3737
/// </summary>
38-
/// <param name="key">要检查配置项的名称。</param>
38+
/// <param name="settingName">要检查配置项的名称。</param>
3939
/// <returns>指定的配置项是否存在。</returns>
40-
bool HasKey(string key);
40+
bool HasSetting(string settingName);
4141

4242
/// <summary>
4343
/// 移除指定配置项。
4444
/// </summary>
45-
/// <param name="key">要移除配置项的名称。</param>
46-
void RemoveKey(string key);
45+
/// <param name="settingName">要移除配置项的名称。</param>
46+
void RemoveSetting(string settingName);
4747

4848
/// <summary>
4949
/// 清空所有配置项。
5050
/// </summary>
51-
void RemoveAllKeys();
51+
void RemoveAllSettings();
5252

5353
/// <summary>
5454
/// 从指定配置项中读取布尔值。
5555
/// </summary>
56-
/// <param name="key">要获取配置项的名称。</param>
56+
/// <param name="settingName">要获取配置项的名称。</param>
5757
/// <returns>读取的布尔值。</returns>
58-
bool GetBool(string key);
58+
bool GetBool(string settingName);
5959

6060
/// <summary>
6161
/// 从指定配置项中读取布尔值。
6262
/// </summary>
63-
/// <param name="key">要获取配置项的名称。</param>
63+
/// <param name="settingName">要获取配置项的名称。</param>
6464
/// <param name="defaultValue">当指定的配置项不存在时，返回此默认值。</param>
6565
/// <returns>读取的布尔值。</returns>
66-
bool GetBool(string key, bool defaultValue);
66+
bool GetBool(string settingName, bool defaultValue);
6767

6868
/// <summary>
6969
/// 向指定配置项写入布尔值。
7070
/// </summary>
71-
/// <param name="key">要写入配置项的名称。</param>
71+
/// <param name="settingName">要写入配置项的名称。</param>
7272
/// <param name="value">要写入的布尔值。</param>
73-
void SetBool(string key, bool value);
73+
void SetBool(string settingName, bool value);
7474

7575
/// <summary>
7676
/// 从指定配置项中读取整数值。
7777
/// </summary>
78-
/// <param name="key">要获取配置项的名称。</param>
78+
/// <param name="settingName">要获取配置项的名称。</param>
7979
/// <returns>读取的整数值。</returns>
80-
int GetInt(string key);
80+
int GetInt(string settingName);
8181

8282
/// <summary>
8383
/// 从指定配置项中读取整数值。
8484
/// </summary>
85-
/// <param name="key">要获取配置项的名称。</param>
85+
/// <param name="settingName">要获取配置项的名称。</param>
8686
/// <param name="defaultValue">当指定的配置项不存在时，返回此默认值。</param>
8787
/// <returns>读取的整数值。</returns>
88-
int GetInt(string key, int defaultValue);
88+
int GetInt(string settingName, int defaultValue);
8989

9090
/// <summary>
9191
/// 向指定配置项写入整数值。
9292
/// </summary>
93-
/// <param name="key">要写入配置项的名称。</param>
93+
/// <param name="settingName">要写入配置项的名称。</param>
9494
/// <param name="value">要写入的整数值。</param>
95-
void SetInt(string key, int value);
95+
void SetInt(string settingName, int value);
9696

9797
/// <summary>
9898
/// 从指定配置项中读取浮点数值。
9999
/// </summary>
100-
/// <param name="key">要获取配置项的名称。</param>
100+
/// <param name="settingName">要获取配置项的名称。</param>
101101
/// <returns>读取的浮点数值。</returns>
102-
float GetFloat(string key);
102+
float GetFloat(string settingName);
103103

104104
/// <summary>
105105
/// 从指定配置项中读取浮点数值。
106106
/// </summary>
107-
/// <param name="key">要获取配置项的名称。</param>
107+
/// <param name="settingName">要获取配置项的名称。</param>
108108
/// <param name="defaultValue">当指定的配置项不存在时，返回此默认值。</param>
109109
/// <returns>读取的浮点数值。</returns>
110-
float GetFloat(string key, float defaultValue);
110+
float GetFloat(string settingName, float defaultValue);
111111

112112
/// <summary>
113113
/// 向指定配置项写入浮点数值。
114114
/// </summary>
115-
/// <param name="key">要写入配置项的名称。</param>
115+
/// <param name="settingName">要写入配置项的名称。</param>
116116
/// <param name="value">要写入的浮点数值。</param>
117-
void SetFloat(string key, float value);
117+
void SetFloat(string settingName, float value);
118118

119119
/// <summary>
120120
/// 从指定配置项中读取字符串值。
121121
/// </summary>
122-
/// <param name="key">要获取配置项的名称。</param>
122+
/// <param name="settingName">要获取配置项的名称。</param>
123123
/// <returns>读取的字符串值。</returns>
124-
string GetString(string key);
124+
string GetString(string settingName);
125125

126126
/// <summary>
127127
/// 从指定配置项中读取字符串值。
128128
/// </summary>
129-
/// <param name="key">要获取配置项的名称。</param>
129+
/// <param name="settingName">要获取配置项的名称。</param>
130130
/// <param name="defaultValue">当指定的配置项不存在时，返回此默认值。</param>
131131
/// <returns>读取的字符串值。</returns>
132-
string GetString(string key, string defaultValue);
132+
string GetString(string settingName, string defaultValue);
133133

134134
/// <summary>
135135
/// 向指定配置项写入字符串值。
136136
/// </summary>
137-
/// <param name="key">要写入配置项的名称。</param>
137+
/// <param name="settingName">要写入配置项的名称。</param>
138138
/// <param name="value">要写入的字符串值。</param>
139-
void SetString(string key, string value);
139+
void SetString(string settingName, string value);
140140

141141
/// <summary>
142142
/// 从指定配置项中读取对象。
143143
/// </summary>
144144
/// <typeparam name="T">要读取对象的类型。</typeparam>
145-
/// <param name="key">要获取配置项的名称。</param>
145+
/// <param name="settingName">要获取配置项的名称。</param>
146146
/// <returns>读取的对象。</returns>
147-
T GetObject<T>(string key);
147+
T GetObject<T>(string settingName);
148148

149149
/// <summary>
150150
/// 从指定配置项中读取对象。
151151
/// </summary>
152152
/// <param name="objectType">要读取对象的类型。</param>
153-
/// <param name="key">要获取配置项的名称。</param>
153+
/// <param name="settingName">要获取配置项的名称。</param>
154154
/// <returns></returns>
155-
object GetObject(Type objectType, string key);
155+
object GetObject(Type objectType, string settingName);
156156

157157
/// <summary>
158158
/// 从指定配置项中读取对象。
159159
/// </summary>
160160
/// <typeparam name="T">要读取对象的类型。</typeparam>
161-
/// <param name="key">要获取配置项的名称。</param>
161+
/// <param name="settingName">要获取配置项的名称。</param>
162162
/// <param name="defaultObj">当指定的配置项不存在时，返回此默认对象。</param>
163163
/// <returns>读取的对象。</returns>
164-
T GetObject<T>(string key, T defaultObj);
164+
T GetObject<T>(string settingName, T defaultObj);
165165

166166
/// <summary>
167167
/// 从指定配置项中读取对象。
168168
/// </summary>
169169
/// <param name="objectType">要读取对象的类型。</param>
170-
/// <param name="key">要获取配置项的名称。</param>
170+
/// <param name="settingName">要获取配置项的名称。</param>
171171
/// <param name="defaultObj">当指定的配置项不存在时，返回此默认对象。</param>
172172
/// <returns></returns>
173-
object GetObject(Type objectType, string key, object defaultObj);
173+
object GetObject(Type objectType, string settingName, object defaultObj);
174174

175175
/// <summary>
176176
/// 向指定配置项写入对象。
177177
/// </summary>
178178
/// <typeparam name="T">要写入对象的类型。</typeparam>
179-
/// <param name="key">要写入配置项的名称。</param>
179+
/// <param name="settingName">要写入配置项的名称。</param>
180180
/// <param name="obj">要写入的对象。</param>
181-
void SetObject<T>(string key, T obj);
181+
void SetObject<T>(string settingName, T obj);
182182

183183
/// <summary>
184184
/// 向指定配置项写入对象。
185185
/// </summary>
186-
/// <param name="key">要写入配置项的名称。</param>
186+
/// <param name="settingName">要写入配置项的名称。</param>
187187
/// <param name="obj">要写入的对象。</param>
188-
void SetObject(string key, object obj);
188+
void SetObject(string settingName, object obj);
189189
}
190190
}

0 commit comments

Comments
 (0)