This commit is contained in:
milimoe 2023-11-25 01:44:17 +08:00 committed by GitHub
parent b4e4b35df5
commit 37c4c54445
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 1954 additions and 35 deletions

View File

@ -22,14 +22,10 @@ namespace Milimoe.FunGame.Core.Api.Transmittal
/// </summary>
public string Error => Worker.Error;
/// <summary>
/// 获取ResultData中key值对应的Json字符串
/// -- 此索引器仅返回Json字符串对象类型请使用反序列化方法GetResult<T>() --
/// -- 当然也可以自己反序列化 --
/// -- 基本类型可能有效,但仍建议使用反序列化方法 --
/// </summary>
/// <param name="key"></param>
/// <returns></returns>
// 获取ResultData中key值对应的Json字符串
// -- 此索引器仅返回Json字符串对象类型请使用反序列化方法GetResult<T>() --
// -- 当然也可以自己反序列化 --
// -- 基本类型可能有效,但仍建议使用反序列化方法 --
public object? this[string key]
{
get

View File

@ -22,7 +22,6 @@ namespace Milimoe.FunGame.Core.Api.Transmittal
/// <summary>
/// 执行一个命令
/// </summary>
/// <param name="Result">执行结果</param>
/// <returns>影响的行数</returns>
public abstract int Execute();
@ -30,14 +29,12 @@ namespace Milimoe.FunGame.Core.Api.Transmittal
/// 执行一个指定的命令
/// </summary>
/// <param name="Script">命令</param>
/// <param name="Result">执行结果</param>
/// <returns>影响的行数</returns>
public abstract int Execute(string Script);
/// <summary>
/// 查询DataSet
/// </summary>
/// <param name="Result">执行结果</param>
/// <returns>结果集</returns>
public abstract DataSet ExecuteDataSet();
@ -45,7 +42,6 @@ namespace Milimoe.FunGame.Core.Api.Transmittal
/// 执行指定的命令查询DataSet
/// </summary>
/// <param name="Script">命令</param>
/// <param name="Result">执行结果</param>
/// <returns>结果集</returns>
public abstract DataSet ExecuteDataSet(string Script);

View File

@ -80,8 +80,8 @@ namespace Milimoe.FunGame.Core.Api.Utility
/// <summary>
/// 通过DataSet获取房间实例
/// </summary>
/// <param name="DsRoom"></param>
/// <param name="DsUser"></param>
/// <param name="DrRoom"></param>
/// <param name="User"></param>
/// <returns></returns>
public static Room GetRoom(DataRow DrRoom, User User)
{
@ -222,7 +222,7 @@ namespace Milimoe.FunGame.Core.Api.Utility
/// <summary>
/// 获取用户实例
/// </summary>
/// <param name="ds"></param>
/// <param name="dr"></param>
/// <returns></returns>
public static User GetUser(DataRow dr)
{

View File

@ -4,17 +4,17 @@ using Milimoe.FunGame.Core.Library.Constant;
namespace Milimoe.FunGame.Core.Api.Utility
{
/// <summary>
/// Interface的定义已经搬至
/// Milimoe.FunGame.Core.Library.Constant 中的 &InterfaceType 和 &InterfaceSet
/// See: <see cref="InterfaceType"/>, <see cref="InterfaceSet"/>, <see cref="InterfaceMethod"/>
/// </summary>
public class Implement
{
/// <summary>
/// 获取FunGame.Implement.dll中接口的实现方法
/// </summary>
/// <param name="Assembly">程序集</param>
/// <param name="Interface">接口代号</param>
/// <returns></returns>
private static Type? GetFunGameImplementType(System.Reflection.Assembly Assembly, InterfaceType Interface)
private static Type? GetFunGameImplementType(Assembly Assembly, InterfaceType Interface)
{
// 通过类名获取命名空间+类名称
string ClassName = GetImplementClassName(Interface);

View File

@ -34,7 +34,7 @@ namespace Milimoe.FunGame.Core.Api.Utility
/// <summary>
/// 注册多个自定义转换器,支持 <see cref="BaseEntityConverter{T}"/>
/// </summary>
/// <param name="converter"></param>
/// <param name="converters"></param>
public void AddConverters(IEnumerable<JsonConverter> converters)
{
foreach (JsonConverter converter in converters)

View File

@ -44,7 +44,6 @@ namespace Milimoe.FunGame.Core.Api.Utility
/// </summary>
/// <param name="username"></param>
/// <param name="code"></param>
/// <param name="msg"></param>
/// <returns></returns>
public bool Authenticate(string username, string code)
{

View File

@ -80,7 +80,6 @@ namespace Milimoe.FunGame.Core.Controller
/// <summary>
/// 关闭事件
/// </summary>
/// <param name="SocketObject">SocketObject</param>
protected delegate void DisposedEvent();
/// <summary>
@ -93,7 +92,6 @@ namespace Milimoe.FunGame.Core.Controller
/// <summary>
/// 触发关闭事件
/// </summary>
/// <param name="SocketObject">SocketObject</param>
protected void OnDisposed()
{
Disposed?.Invoke();

View File

@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net7.0</TargetFramework>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<BaseOutputPath>bin\</BaseOutputPath>
@ -14,14 +14,18 @@
<RootNamespace>Milimoe.$(MSBuildProjectName.Replace(" ", "_"))</RootNamespace>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<AssemblyName>$(MSBuildProjectName)</AssemblyName>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
<DocumentationFile>docs\api.xml</DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<DebugType>embedded</DebugType>
<NoWarn>1701;1702;CS1591;CS1587</NoWarn>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<DebugType>embedded</DebugType>
<NoWarn>1701;1702;CS1591;CS1587</NoWarn>
</PropertyGroup>
</Project>

View File

@ -2,7 +2,7 @@
{
/// <summary>
/// 继承这个类可以获得异步等待的功能
/// <para>参考实现 <see cref="SocketHandlerModel"/></para>
/// <para>参考实现 <see cref="Controller.SocketHandlerController"/></para>
/// </summary>
public abstract class AsyncAwaiter<T>
{

View File

@ -12,15 +12,10 @@ namespace Milimoe.FunGame.Core.Library.Common.Network
public object[] Parameters { get; } = Array.Empty<object>();
public int Length => Parameters.Length;
/// <summary>
/// 从参数列表中获取指定索引的参数的Json字符串
/// -- 此索引器仅返回Json字符串对象类型请使用反序列化方法GetParam<T>() --
/// -- 当然也可以自己反序列化 --
/// -- 基本类型可能有效,但仍建议使用反序列化方法 --
/// </summary>
/// <param name="index">索引</param>
/// <returns></returns>
/// <exception cref="IndexOutOfArrayLengthException">索引超过数组上限</exception>
// 从参数列表中获取指定索引的参数的Json字符串
// -- 此索引器仅返回Json字符串对象类型请使用反序列化方法GetParam<T>() --
// -- 当然也可以自己反序列化 --
// -- 基本类型可能有效,但仍建议使用反序列化方法 --
public object? this[int index]
{
get

View File

@ -228,7 +228,7 @@ namespace Milimoe.FunGame.Core.Library.Constant
/// <summary>
/// 获取字符串对应的枚举
/// </summary>
/// <param name="type"></param>
/// <param name="typestring"></param>
/// <returns></returns>
public static RoomType GetRoomType(string typestring)
{

View File

@ -9,6 +9,7 @@ namespace Milimoe.FunGame.Core.Service
/// 从plugins目录加载所有插件
/// </summary>
/// <param name="plugins"></param>
/// <param name="objs"></param>
/// <returns></returns>
internal static Dictionary<string, BasePlugin> LoadPlugins(Dictionary<string, BasePlugin> plugins, params object[] objs)
{

View File

@ -78,7 +78,6 @@ namespace Milimoe.FunGame.Core.Service
/// 反序列化Json对象此方法可能无法返回正确的类型请注意辨别
/// </summary>
/// <param name="json"></param>
/// <param name=""></param>
/// <param name="options"></param>
/// <returns></returns>
internal static object? GetObject(string json, JsonSerializerOptions options)

1931
docs/api.xml Normal file

File diff suppressed because it is too large Load Diff