/Scorpio-CSharp

Unity游戏热更新脚本

Primary LanguageC#GNU General Public License v3.0GPL-3.0

基础介绍

sco是c#实现的解释型脚本,是一种高效,轻量,可嵌入的脚本语言,语法类似javascript,类型为弱类型,通过使用基于栈的虚拟机解释字节码来运行.

安装 sco 命令

Windows

  • 方式1（推荐）
  • 方式2，winget(Windows 10 1709以上版本系统自带)安装，运行命令（推荐）
winget install Scorpio.sco
  • 方式2
    • 下载Release压缩包并添加环境变量

Mac

  • 方式1 - brew安装，运行命令（推荐）
brew tap qingfeng346/brew
brew install sco
  • 方式2
    • 下载Release压缩包并添加环境变量

Linux

  • 方式1
    • 下载Release压缩包并添加环境变量
  • 方式2，运行命令（已安装PowerShell Core的机器）
pwsh -Command "Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://qingfeng346.gitee.io/installsco.ps1'))"

Unity导入

upm导入（推荐）

// 添加地址 https://github.com/qingfeng346/upm.git?path=/Packages/com.scorpio.sco#sco/[version]
// 示例:
"dependencies": {
    "com.scorpio.sco": "https://github.com/qingfeng346/upm.git?path=/Packages/com.scorpio.sco#sco/2.3.5",
}

openupm导入（推荐）

openupm install com.scorpio.sco

源码导入

  • 导入源码目录 Scorpio/src 即可,不同版本可以下载Release的Source Code

兼容的 .net 平台

  • unity2018及以上
  • .net framework 4.0 及以上
  • .net standard 2.0 及以上
  • .net core 2.0 及以上
  • asp.net
  • asp.net core
  • mono
  • xamarin

Unity相关

  • 支持的Unity版本

    • Unity2018及以上
    • 请设置 PlayerSetting 内 Api Compatibility Level 为 .NET Standard 2.0

  • 支持的Unity平台:

    • PC, Mac & Linux Standalone(包括IL2CPP)
    • iOS(包括IL2CPP)
    • Android(包括IL2CPP)
    • UWP(仅支持IL2CPP)
    • WebGL

注意事项

  • 脚本文本文件编码要改成 utf8 without bom (无签名的utf8格式)
  • 使用 importType 函数引入一个c#类, 参数字符串请参考 Type.GetType, 类似
    • TopNamespace.SubNameSpace.ContainingClass+NestedClass,MyAssembly
    • TopNamespace.Sub+Namespace.ContainingClass+NestedClass,MyAssembly
  • 脚本内所有c#实例(除了bool,number,string,enum等基础类型) 均为引用, struct 变量也一样
  • event 对象 += -= 操作可以使用函数 add_[event变量名] remove_[event变量名] 代替
  • c# 扩展函数, 请先调用 importExtension("类型") 引用
  • Unity3d 使用 IL2CPP 后, 部分Unity3D的类或函数不能反射获取,请配置link.xml或者使用快速反射功能
  • genericMethod, genericType 函数在IL2CPP下生成未声明过的类型会报错

脚本调用c#运算符重载

运算符号 反射名称 脚本是否支持直接调用
+ op_Addition 支持
- op_Subtraction 支持
* op_Multiply 支持
/ op_Division 支持
% op_Modulus 支持
| op_BitwiseOr 支持
& op_BitwiseAnd 支持
^ op_ExclusiveOr 支持
> op_GreaterThan 支持
>= op_GreaterThanOrEqual 支持
< op_LessThan 支持
<= op_LessThanOrEqual 支持
== op_Equality 支持
!= op_Inequality 不支持, 脚本 != 会直接取反 ==
[] get_Item(获取变量) 支持 key 不为string的情况
[] set_Item(设置变量) 支持 key 不为string的情况

快速反射

  • 快速反射类生成
    • 使用命令行可以生成快速反射类文件,示例
    sco fast -dll [dll文件路径] -class [class完整名] -output [输出目录]
  • 快速反射类使用
    • 例如使用快速反射的类为 UnityEngine.GameObject , 生成的快速反射类则为ScorpioClass_UnityEngine_GameObject, 然后 c# 调用
    Scorpio.Userdata.TypeManager.SetFastReflectClass(typeof(UnityEngine.GameObject), new ScorpioClass_UnityEngine_GameObject(script))

Showcases

Name Icon Download
Dragonscapes Dragonscapes

捐助作者