Lua 节

docs/advanced/cross_mod_interactions.md → docs/Coding/advanced/cross_mod_interactions.md

@@ -56,7 +56,7 @@ public override void Load()
 
 一个 Mod 可以通过 `ModExportName` 特性导出一组方法, 而其他的 Mod 可以通过 `ModImportName` 特性导入这些方法作为委托以调用.
 
-!!! info
+!!! note
     如果被依赖的 Mod 被禁用, 其通过 `ModExportName` 导出的委托将会是 `null`, 调用它们将导致游戏崩溃.
     我们应该检查被依赖的 Mod 是否启用以决定是否调用.
 
@@ -81,6 +81,8 @@ public static class MyCelesteModExports
     // 添加于 1.0.0 版本
     public static void LogStuff() => Logger.Log(LogLevel.Info, "MyCelesteMod", "Someone is calling this method!");
     // 添加于 1.0.0 版本
+    public static void LogNumber(int number) => Logger.Log(LogLevel.Info, "MyCelesteMod", $"Number is {number}!");
+    // 添加于 1.0.0 版本
     public static bool TryDoubleIfEven(int number, out int? doubledNumber)
     {
         if (number % 2 == 0)
@@ -97,7 +99,7 @@ public static class MyCelesteModExports
 }
 ```
 
-!!! info
+!!! note
     请记住, API 是一种**契约**. 使用你的 API 的 Mod 作者会期望它至少能在你的 API 下一个主要版本前保持稳定.
     因此, 我们**强烈**建议你记录每个版本 API 的修改, 至少包括每个方法的添加版本.
     这样可以帮助其他 Mod 作者了解哪些 API 是新增的, 哪些是更改过的, 尽可能避免因接口变动而导致的问题.
@@ -121,7 +123,7 @@ public override void Load()
 
 下面我们新建另一个 Mod `AnotherCelesteMod` 导入 `MyCelesteMod` 提供的 API:
 
-!!! info
+!!! note
     在导入前记得在 `everest.yaml` 中添加 `MyCelesteMod` 的可选依赖.
 
 ```cs title="MyCelesteModAPI.cs"
@@ -138,11 +140,12 @@ public static class MyCelesteModAPI
 
     // 如果没有返回值, 也就是返回值是 void 则使用 Action
     public static Action LogStuff;
+    public static Action<int> LogNumber;
 
-    // 如果导出的方法参数中有 out 或 ref 需要定义自定义委托类型以进行导入
-    // Func 并不支持参数中带有 out 或 ref 的情况
-    public static TryDoubleIfEvenDelegate TryDoubleIfEven;
+    // 如果导出的方法参数中有 in, out 或 ref 需要定义自定义委托类型以进行导入
+    // Func 并不支持参数中带有 in, out 或 ref 的情况
     public delegate bool TryDoubleIfEvenDelegate(int number, out int? doubledNumber);
+    public static TryDoubleIfEvenDelegate TryDoubleIfEven;
 }
 ```
 
@@ -166,11 +169,9 @@ if (MyCelesteModAPI.MultiplyByTwo(myNumber) > 400)
     MyCelesteModAPI.LogStuff();
 }
 
-int myDoubledNumber;
-
 if (MyCelesteModAPI.TryDoubleIfEven(myNumber, out int? doubledNumber))
 {
-    myDoubledNumber = doubledNumber;
+    MyCelesteModAPI.LogNumber(doubledNumber);
 }
 ```
 
@@ -219,14 +220,13 @@ Everest 会将所有 Code Mod 的程序集使用 MonoMod 进行 patch 处理后
 </Project>
 ```
 
-!!! info
+!!! note
     在引用之前我们需要确认目标 Mod 在 `Cache` 中的是否存在, 以上面引用的 Mod 为例. `Cache` 中应该存在:
 
     - GravityHelper.GravityHelper.dll
     - ExtendedVariantMode.ExtendedVariantMode.dll
-    ` FrostHelper.FrostTempleHelper.dll
+    - FrostHelper.FrostTempleHelper.dll
 
-    我们填写目标 Mod 在 `Cache` 中名称的前半段就行.
 
 ### lib-stripped
 

docs/coding_setup/preference.md → docs/Coding/arc/preference.md

@@ -34,7 +34,7 @@
 
 ```
 !!! note
-    这个文件是 XML 格式的, 如果你不熟悉 XML 的话你可以到[这里](../other/xml-speedrun.md)简单看一下, 免得你不知道我们讨论的东西都是什么
+    这个文件是 XML 格式的, 如果你不熟悉 XML 的话你可以到[这里](../extra/xml/xml_speedrun.md)简单看一下, 免得你不知道我们讨论的东西都是什么
 
 其中我们只需要关注里面的 `PropertyGroup` 以及 `ItemGroup` 节点  
 `PropertyGroup` 节点定义了这个项目有哪些属性, 比如项目框架版本, 语言版本, 程序集昵称等  

docs/basics/session_settings_savedata.md → docs/Coding/basics/session_settings_savedata.md

@@ -15,7 +15,7 @@ Settings, 顾名思义就是选项的意思. Everest 为我们封装了一个非
 在此之前, 我们先保存一下我们的 `EverestModule` 实例以方便我们访问它的实例(Everest 会确保它是单例的):
 
 ```cs
-public class MyCelesteModModule : EverestModule
+public sealed class MyCelesteModModule : EverestModule
 {
     public static MyCelesteModModule Instance { get; private set; }
 
@@ -33,7 +33,7 @@ public class MyCelesteModModule : EverestModule
 然后新建一个名字最好以 mod 开头, `Settings` 结尾的 `MyCelesteModSettings` 类并继承 `EverestModuleSettings`:
 
 ```cs
-public class MyCelesteModSettings : EverestModuleSettings
+public sealed class MyCelesteModSettings : EverestModuleSettings
 {
 
 }
@@ -42,7 +42,7 @@ public class MyCelesteModSettings : EverestModuleSettings
 然后在 module 类里这样注册这个类:
 
 ```cs hl_lines="5-6"
-public class MyCelesteModModule : EverestModule
+public sealed class MyCelesteModModule : EverestModule
 {
     public static MyCelesteModModule Instance { get; private set; }
 
@@ -63,7 +63,7 @@ public class MyCelesteModModule : EverestModule
 现在, 我们向选项中新加一条**公开**的 bool 类型的属性:
 
 ```cs
-public class MyCelesteModSettings : EverestModuleSettings
+public sealed class MyCelesteModSettings : EverestModuleSettings
 {
     public bool AnInterestingSwitch { get; set; }
 }
@@ -78,7 +78,7 @@ public class MyCelesteModSettings : EverestModuleSettings
 除此之外 Everest 还支持枚举, 字符串和数字, 它们分别会生成这样的选项:
 
 ```cs
-public class MyCelesteModSettings : EverestModuleSettings
+public sealed class MyCelesteModSettings : EverestModuleSettings
 {
     public bool AnInterestingSwitch { get; set; }
 
@@ -126,7 +126,7 @@ public class MyCelesteModSettings : EverestModuleSettings
 在这里, 我们需要的本地化键名是 `modoptions_{类名}_{属性名}`, 例如如下类:
 
 ```cs
-public class MyCelesteModSettings : EverestModuleSettings
+public sealed class MyCelesteModSettings : EverestModuleSettings
 {
     public bool EnableFunnyThing { get; set; }
 }
@@ -201,17 +201,13 @@ Session 是一个蔚蓝中保存数据的概念, 它用于保存 "保存并退
 与 Settings 相同, 我们需要先创建一个继承于 `EverestModuleSession` 的类, 然后在模块类中声明它:
 
 ```cs title="MyCelesteModSession.cs"
-namespace Celeste.Mod.MyCelesteMod;
-
-public class MyCelesteModSession : EverestModuleSession
+public sealed class MyCelesteModSession : EverestModuleSession
 {
 }
 ```
 
 ```cs title="MyCelesteModModule.cs"
-namespace Celeste.Mod.MyCelesteMod;
-
-public class MyCelesteModModule : EverestModule
+public sealed class MyCelesteModModule : EverestModule
 {
     public static MyCelesteModModule Instance { get; private set; }
 
@@ -239,19 +235,13 @@ public class MyCelesteModModule : EverestModule
 退出了游戏, 再次进入时你会发现重生点是新的, 而 `PassByRefill` 的冲刺数又变回 `1` 了, 所以接下来我们尝试通过 `Session` 来修正这个错误.  
 
 ```cs title="MyCelesteModSession.cs"
-namespace Celeste.Mod.MyCelesteMod;
-
-public class MyCelesteModSession : EverestModuleSession
+public sealed class MyCelesteModSession : EverestModuleSession
 {
     public Dictionary<string, int> RoomIdToPassByRefillDashes = new();  // 我们将记录每个房间名对应的PassByRefill的冲刺数
 }
 ```
 
 ```cs title="SetPassByRefillDashesTrigger.cs"
-using Celeste.Mod.Entities;
-
-namespace MyCelesteMod;
-
 [CustomEntity("MyCelesteMod/SetPassByRefillDashesTrigger")]
 public class SetPassByRefillDashesTrigger : Trigger
 {
@@ -272,10 +262,6 @@ public class SetPassByRefillDashesTrigger : Trigger
 ```
 
 ```cs title="PassByRefill.cs"
-using Celeste.Mod.Entities;
-
-namespace MyCelesteMod;
-
 [CustomEntity("MyCelesteMod/PassByRefill")]
 public class PassByRefill : Entity
 {
@@ -321,17 +307,13 @@ public class PassByRefill : Entity
 使用它与使用 `Session` 极其相似:
 
 ```cs title="MyCelesteModSaveData.cs"
-namespace Celeste.Mod.MyCelesteMod;
-
-public class MyCelesteModSaveData : EverestModuleSaveData
+public sealed class MyCelesteModSaveData : EverestModuleSaveData
 {
 }
 ```
 
 ```cs title="MyCelesteModModule.cs"
-namespace Celeste.Mod.MyCelesteMod;
-
-public class MyCelesteModModule : EverestModule
+public sealed class MyCelesteModModule : EverestModule
 {
     public static MyCelesteModModule Instance { get; private set; }
 

docs/coding_challenges/simple_entity.md → docs/Coding/coding_challenges/simple_entity.md

@@ -31,8 +31,6 @@
 那么你应该会写出如下的代码:
 
 ```cs title="PassByRefill.cs"
-namespace MyCelesteMod;
-
 public class PassByRefill : Entity
 {
 
@@ -60,8 +58,10 @@ public PassByRefill(Vector2 position, Vector2 size, int dashes)
 接下来, 我们需要声明一个特殊的构造函数, 以让 Everest 反射调用并使得我们的实体可以正常获取地图的数据:
 ```cs title="PassByRefill.cs"
 public PassByRefill(EntityData data, Vector2 offset) 
-        : this(data.Position + offset, new Vector2(data.Width, data.Height), data.Int("dashes"))
-    { }
+    : this(data.Position + offset, new Vector2(data.Width, data.Height), data.Int("dashes"))
+{ 
+
+}
 ```
 在这里, `EntityData data` 储存了作图软件保存的相关数据, 我们要提取它们很简单.  
 比如说我们要提取一个名为 `dashes` 的 `int` 类型的数据, 我们就简单地调用它的方法 `Int(string name)`,
@@ -83,7 +83,8 @@ public PassByRefill(EntityData data, Vector2 offset)
 [CustomEntity("MyCelesteMod/PassByRefill")]
 public class PassByRefill : Entity
 {
-......
+    // ......
+}
 ```
 在这里 "名称 ID" 我们一般推荐以 "{Mod名}/该实体类名" 进行命名, 就像这里一样, Mod 名为 `MyCelesteMod`, 类名为 `PassByRefill`, 实体 "名称 ID" 就是 `MyCelesteMod/PassByRefill`. 这里我建议你记住它, 待会我们会在作图软件配置的时候用到.
 
@@ -243,10 +244,6 @@ Draw.Rect(Position, Width, Height, c);
 
 如果你遇到了困难, 你可以对比一下最终的代码:
 ```cs title="PassByRefill.cs"
-using Celeste.Mod.Entities;
-
-namespace MyCelesteMod;
-
 [CustomEntity("MyCelesteMod/PassByRefill")]
 public class PassByRefill : Entity
 {
@@ -262,7 +259,9 @@ public class PassByRefill : Entity
 
     public PassByRefill(EntityData data, Vector2 offset)
         : this(data.Position + offset, new Vector2(data.Width, data.Height), data.Int("dashes"))
-    { }
+    { 
+
+    }
 
     public override void Update()
     {

docs/coding_challenges/simple_texturing.md → docs/Coding/coding_challenges/simple_texturing.md

@@ -28,7 +28,9 @@
 
     public PassByRefill(EntityData data, Vector2 offset)
         : this(data.Position + offset, data.Int("dashes"))
-    { }
+    {
+
+    }
     ```
 === "Before"
     ```cs title="PassByRefill.cs"
@@ -42,7 +44,9 @@
 
     public PassByRefill(EntityData data, Vector2 offset)
         : this(data.Position + offset, new Vector2(data.Width, data.Height), data.Int("dashes"))
-    { }
+    { 
+
+    }
     ```
 
 !!! info
@@ -108,7 +112,9 @@ public class PassByRefill : Entity
 
     public PassByRefill(EntityData data, Vector2 offset)
         : this(data.Position + offset, data.Int("dashes"))
-    { }
+    {
+
+    }
 
     public override void Update()
     {

docs/coding_challenges/simple_trigger.md → docs/Coding/coding_challenges/simple_trigger.md

@@ -126,10 +126,6 @@ foreach(var refill in refills)
 
 最后, 你的代码应该总体上是这个样子:
 ```cs title="SetPassByRefillDashesTrigger.cs"
-using Celeste.Mod.Entities;
-
-namespace MyCelesteMod;
-
 [CustomEntity("MyCelesteMod/SetPassByRefillDashesTrigger")]
 public class SetPassByRefillDashesTrigger : Trigger
 {