the second step

friendlyhj · Mar 25, 2022 · 2c8d033 · 2c8d033
1 parent 7d9b70b
commit 2c8d033
Showing 1 changed file with 119 additions and 34 deletions.
diff --git a/advanced/common-errors.md b/advanced/common-errors.md
@@ -1,52 +1,56 @@
 # 编写脚本时的常见错误
 
-### 前言
+## 前言
 
 在编写魔改脚本时，可能会出现一些常见的，有通用解的错误，在此列出名称、起因。
 
-人工整理，可能有加较多纰漏，欢迎纠错。
+语法错误最好在 /ct syntax 检查出来，在游戏加载时加载脚本可能脚本有语法错误，却依旧尝试编译，导致又臭又长的也看不懂的字节码错误。有时候一个错误会导致很多别的错误。比如没导包的错误，可能会导致之后一堆 `any type is not supported` 错误。但是只有第一条错误 `cannot find XXX` 才是最重要的。而游戏聊天栏显示数量有限，第一条报错就顶掉了，所以报错请第一时间看日志。
 
+人工整理，可能有加较多纰漏，欢迎纠错。
 
-### 语法错误
+## 语法错误
 
 缺分号，括号不对称等。
 
 示例：
+
 ```csharp
 // 缺少分号
 // 讲真，这连插件语法检查都过不去...
 recipes.remove(<minecraft:apple>)
 ```
 
 报错：
+
 ```log
 [INITIALIZATION][CLIENT][ERROR] blah_blah_blah.zs:2 > unexpected end of file - ; expected
 [INITIALIZATION][CLIENT][ERROR] [crafttweaker | SIDE_CLIENT]: Error parsing blah_blah_blah.zs:2 -- ; expected
 ```
 
-
-### 导包错误
+## 导包错误
 
 导入的包不存在。
 
 示例：
+
 ```csharp
 // 少打了个 .
 import crafttweaker.itemIItemStack;
 ```
 
 报错：
+
 ```log
 [INITIALIZATION][CLIENT][ERROR] no_easter_egg_for_you.zs:1 > No such member: itemIItemStack
 [INITIALIZATION][CLIENT][ERROR] no_easter_egg_for_you.zs:1 > Not a valid type
 ```
 
-
-### 缺少导包
+## 缺少导包
 
 除了基本数据类型，其他所有出现 `as Type` 的语句，比如声明变量，函数的参数与返回值，强制转型等，都需要导入对应的类。
 
 示例：
+
 ```csharp
 // 需要导入 IItemStack 包
 val apple as IItemStack = <item:minecraft:apple>;
@@ -57,18 +61,19 @@ function foo(item as IItemStack) {
 ```
 
 报错：
+
 ```log
 [INITIALIZATION][CLIENT][ERROR] did_you_miss_me.zs:1 > could not find type IItemStack
 [INITIALIZATION][CLIENT][ERROR] did_you_miss_me.zs:3 > could not find type IItemStack
 [INITIALIZATION][CLIENT][ERROR] did_you_miss_me.zs:4 > any values not yet supported
 ```
 
-
-### 导入语句未写在脚本头部
+## 导入语句未写在脚本头部
 
 所有 import 必须写在一起，且在脚本的头部。
 
 示例：
+
 ```csharp
 val foo as string = "bar";
 
@@ -77,14 +82,15 @@ val apple as IItemStack = <item:minecraft:apple>;
 ```
 
 报错：
+
 ```log
 [INITIALIZATION][CLIENT][ERROR] [crafttweaker | SIDE_CLIENT]: Error parsing hello_mister_freeman.zs:3 -- Invalid expression, last token: import
 ```
 
-
-### 方法传入参数错误
+## 方法传入参数错误
 
 示例：
+
 ```csharp
 // 输入为 recipes.addShaped(string, IOreDictEntry, IIngredient[][]);
 // 其中 IOreDictEntry 类型错误，输出类型只能为 IItemStack。
@@ -96,6 +102,7 @@ recipes.addShaped("recipe_name_here", <ore:ingotCopper>, [
 ```
 
 报错：
+
 ```log
 // 有 2 个可用方法，但你的脚本并不匹配其中任何一个
 [INITIALIZATION][CLIENT][ERROR] wake_up_and_smell_the_ashes.zs:1 > 2 methods available but none matches the parameters (string, ZenTypeNative: crafttweaker.oredict.IOreDictEntry, any[])
@@ -108,34 +115,35 @@ addShaped(string, ZenTypeNative: crafttweaker.item.IItemStack, ZenTypeNative: cr
 addShaped(ZenTypeNative: crafttweaker.item.IItemStack, ZenTypeNative: crafttweaker.item.IIngredient[][], Optional ZenTypeNative: crafttweaker.recipes.IRecipeFunction, Optional ZenTypeNative: crafttweaker.recipes.IRecipeAction)
 ```
 
-
-### 使用加号连接字符串与数字
+## 使用加号连接字符串与数字
 
 示例：
+
 ```csharp
 print(3 + "and");
 ```
 
 报错：
+
 ```log
 [INITIALIZATION][CLIENT][ERROR] [crafttweaker]: Error executing {[0:crafttweaker]: i_just_wanna_dance.zs}: For input string: "and"
 java.lang.NumberFormatException: For input string: "and"
-	at java.lang.NumberFormatException.forInputString(NumberFormatException.java:65)
-	at java.lang.Integer.parseInt(Integer.java:580)
-	at java.lang.Integer.parseInt(Integer.java:615)
-	at I_just_wanna_dance.__script__(i_just_wanna_dance.zs:1)
-	at __ZenMain__.run(I_just_wanna_dance)
+    at java.lang.NumberFormatException.forInputString(NumberFormatException.java:65)
+    at java.lang.Integer.parseInt(Integer.java:580)
+    at java.lang.Integer.parseInt(Integer.java:615)
+    at I_just_wanna_dance.__script__(i_just_wanna_dance.zs:1)
+    at __ZenMain__.run(I_just_wanna_dance)
     ......
 ```
 
 请使用飘号 (`~`) 连接字符串。
 
-
 ### 数组越界
 
 数组越界错误有若干成因，在此使用最常见的索引超出数组长度问题举例。
 
 示例：
+
 ```csharp
 import crafttweaker.item.IItemStack;
 
@@ -155,14 +163,15 @@ for i in 0 .. 3 {
 ```
 
 报错：
+
 ```log
 [INITIALIZATION][CLIENT][ERROR] [crafttweaker]: Error executing {[0:crafttweaker]: ladies_and_gentlemen_we_got_him.zs}: 2
 java.lang.ArrayIndexOutOfBoundsException: 2
-	at Ladies_and_gentlemen_we_got_him.__script__(ladies_and_gentlemen_we_got_him.zs:15)
-	at __ZenMain__.run(Ladies_and_gentlemen_we_got_him)
-	at crafttweaker.runtime.CrTTweaker.loadScript(CrTTweaker.java:240)
-	at crafttweaker.runtime.CrTTweaker.loadScript(CrTTweaker.java:105)
-	at crafttweaker.mc1120.events.CommonEventHandler.registerRecipes(CommonEventHandler.java:71)
+    at Ladies_and_gentlemen_we_got_him.__script__(ladies_and_gentlemen_we_got_him.zs:15)
+    at __ZenMain__.run(Ladies_and_gentlemen_we_got_him)
+    at crafttweaker.runtime.CrTTweaker.loadScript(CrTTweaker.java:240)
+    at crafttweaker.runtime.CrTTweaker.loadScript(CrTTweaker.java:105)
+    at crafttweaker.mc1120.events.CommonEventHandler.registerRecipes(CommonEventHandler.java:71)
     ......
 ```
 
@@ -175,24 +184,28 @@ java.lang.ArrayIndexOutOfBoundsException: 2
 缺少双引号的 string 会被识别为变量关键字，但在声明 map 的 key 中例外，变量会被当成字符串处理。
 
 示例：
+
 ```csharp
 // 缺少双引号，按变量关键字处理
 print(itshouldbeastringbutitsnot);
 ```
 
 报错：
+
 ```log
 [INITIALIZATION][CLIENT][ERROR] hey_my_name_is_gary.zs:1 > could not find itshouldbeastringbutitsnot
 ```
 
 ### 没有对应方法
 
 示例：
+
 ```csharp
 <minecraft:apple>.retard();
 ```
 
 报错：
+
 ```log
 // 在 IItemStack 类中（因为 <minecraft:apple> 是 IItemStack）找不到名为 retard 的方法
 [INITIALIZATION][CLIENT][ERROR] whos_next_im_tired.zs:1 > No such member in crafttweaker.item.IItemStack: retard
@@ -205,12 +218,14 @@ IItemStack 类没有名字为 `method` 的方法。
 一般是拼错单词导致的，为啥不用 `/ct hand` 呢？
 
 示例：
+
 ```csharp
 // 我很确定原版没有菠萝
 print(<minecraft:pineapple>.commandString);
 ```
 
 报错：
+
 ```log
 // 无法解析 <minecraft:pineapple>
 [INITIALIZATION][CLIENT][ERROR] what_the_hell_is_a_pineapple.zs:1: Could not resolve <minecraft : pineapple>
@@ -220,31 +235,101 @@ print(<minecraft:pineapple>.commandString);
 
 这个 `/ct syntax` 查不出来的（
 
-
 ### 找不到变量
 
-打错这算是低级错误。可以提下变量作用域？
+报错 `can not find xxx`
 
+造成这个问题的错误可能有：
 
-### 对 val 变量重新赋值
+* 变量名拼写错误
+* 在变量声明前使用变量
+* 引用 loader 不一样的脚本内的变量
+* 使用作用域之外的变量
+
+作用域代表了变量的可用范围。你不能使用作用域之外的变量，也不能在同一个作用域声明两个重名的变量。ZenScript 分为全局作用域、脚本作用域、参数作用域和局部作用域。
+
+```csharp
+import crafttweaker.item.IItemStack;
+// 全局和静态变量的作用域为全局作用域，可以用于全体脚本
+// 不过不包括 loader 不一样的脚本
+global a as int = 450;
+static b as int = 100;
+
+// 这个变量不属于任何函数，也不在 if for 等代码块内，属于脚本作用域，可以用在这个脚本内的任何地方，但不能用于其他脚本
+val item as IItemStack = <item:minecraft:apple>;
+
+for i in 0 .. 10 { // 这里的 i 属于参数作用域，i 为这个 for 循环的参数，只可在下面大括号内的循环体使用
+    // 每层大括号都是一个局部作用域
+    val j as int = i * 5;
+    val i as int = 233; // 错误，参数作用域内已经定义了 i 变量
+    val item as IItemStack = <item:minecraft:stone>; // 错误，脚本作用域内已经定义了 item 变量
+    if (i < 4) {
+        val k as int = i + 1; // 又开一个局部作用域
+        print(k);
+    }
+    print(k + 1); // 错误，该作用域内未声明 k 变量
+}
+
+print(i); // 错误，i 变量声明在上面的 for 循环的参数作用域内，在这个循环之外 i 变量是不存在的
+
+recipes.addShapeless("nether_recipe",<minecraft:netherrack>,
+[<ore:cobblestone>,<ore:cobblestone>,<ore:cobblestone>],
+    function(output, ins, info) { // 函数参数作用域，该函数体内可以使用这个作用域内的三个变量
+        return info.player.world.dimension == -1 ? output : null; 
+    },
+null);
+
+print(output.commandString); // 错误，output 变量只存在于上面的函数参数作用域内，在这个函数之外 output 变量不存在
+
+// 上面的 output 变量只存在于上面的函数内，所以你可以在函数外声明 output 变量，但你要知道这两个变量只是同名但不是同一个
+val output as IItemStack = <item:minecraft:stone>;
+```
+
+你也可以意识到代码缩进的必要性了，可以很清晰的分清包括变量作用域的代码层次结构。
+
+## 对 val 变量重新赋值
 
 报错 `value cannot be changed`
 
+如果需要重新赋值，请使用 `var` 来声明变量。
 
-### 对函数参数重新赋值
+## 对函数参数重新赋值
 
 报错 `not a valid lvalue`
 
-真的有人在 zs 干这事？但 java 允许，我也经常这么写。
+```csharp
+function foo(bar as int) {
+    print(bar);
+    bar += 1; // 错误，函数参数不可重复赋值
+    print(bar);
+}
+```
 
+如果你真的有这个需求，可以考虑新建一个参数，初值设为参数
 
-### 匿名函数内对外部变量进行赋值
+```csharp
+function foo(bar as int) {
+    var baz as int = bar;
+    print(baz);
+    baz += 1;
+    print(baz);
+}
+```
 
-报错 `not a valid lvalue`
+## 匿名函数内对外部变量进行赋值
 
-事件什么的都是匿名函数的说。不过更新数组、Map 的元素是可以的。
+匿名函数只能重新赋值函数内部的局部变量，不能重新赋值外部变量。事件什么的都是匿名函数的说。不过更新数组、Map 的元素是可以的。
 
+```csharp
+var foo as int = 250;
 
-### 声明重名变量与函数
+recipes.addShapeless("nether_recipe",<minecraft:netherrack>,
+[<ore:cobblestone>,<ore:cobblestone>,<ore:cobblestone>],
+    function(output, ins, info) { // 匿名函数
+        print(foo); // 可以访问外部变量
+        foo = 450; // 错误，不能改变外部变量的值
+        return info.player.world.dimension == -1 ? output : null; 
+    },
+null);
 
-~~哈哈，所以我用 zenclass 有重载~~
+报错 `not a valid lvalue`