跳到主要内容

epScript 参考



如何开始​

以下操作中如果有看不懂的地方，可以尝试通过搜索引擎解决。
这里假设你已经会使用 ScmDraft2 进行基本的地形设计。

  • 如果不会可参考：SCMD

这里假设你已经对 EUD 的基本概念有一定了解。

环境准备​

准备一台 Windows 10 以上的 PC，或者虚拟机。
准备好 ScmDraft2；如果还没准备，往回看几行。

地图准备​

准备一个普通地图文件，可以用 ScmDraft2 新建，然后保存为 Starcraft: Remastered Broodwar Map (*.scx) 格式。
依然保存到纯英文且没有空格的路径中，例如 D:\Projects\test\basemap.scx

建立工程​

  1. 新建一个文本文档，并将它的扩展名改为 edd，例如 D:\Projects\test\test.edd。
    使用 VSCode 打开这个 edd 文件（直接将文件拖到已打开的 VSCode 界面中即可）。
    然后将它的内容改为：

    [main]
    input: basemap.scx
    output: test.scx

    [main.eps]

    以上代码以相对路径为例，实际也支持绝对路径。

  2. 新建一个文本文档，并将它的扩展名改为 eps，例如 D:\Projects\test\main.eps。
    使用 VSCode 打开这个 eps 文件。
    然后将它的内容改为：

    function onPluginStart() { // 游戏开始时会执行一次这个函数
        DisplayTextAll("Hello World");
    }

    function beforeTriggerExec() { // 游戏每帧都会先执行一次这个函数，然后执行传统触发器

    }

    function afterTriggerExec() { // 游戏每帧执行完传统触发器后，会执行一次这个函数

    }

  3. 新建一个文本文档，并将它的扩展名改为 bat，例如 D:\Projects\test\build.bat。
    使用 VSCode 打开这个 bat 文件，然后将它的内容改为：

    D:\SCRMapDevTools\euddraft0.9.9.9\euddraft.exe test.edd

    以上代码假设你将 euddraft 解压到了 D:\SCRMapDevTools\euddraft0.9.9.9 这个位置。如果它不在这里，你需要替换为实际路径。

    至此，工程已经建立好。直接双击运行 build.bat 就可以生成 test.scx；将这个地图放入星际重制版的地图目录中，然后进游戏就能看到它在屏幕上输出 Hello World。

示例工程​



运行模式​

脚本文件扩展名区别​

  • 如果是 py 格式的脚本，那么在 eds/edd 文件中可以不写扩展名；如果是 eps 格式，则需要写上扩展名。

    [main]
    input: basemap.scx
    output: outputmap.scx

    [eudTurbo]
    :: 它实际是加载的一个文件名为 eudTurbo.py 的脚本

    [main.eps]
    :: 如果是 eps 格式就这么加载

加载顺序​

  • 配置文件中插件名的先后顺序，与它们在游戏开始后的加载顺序相关。游戏开始后，会先执行一次脚本中的 onPluginStart()，然后在所有玩家的机器上循环执行 beforeTriggerExec()、触发器、afterTriggerExec()。

    例如有如下配置 main.edd：

    [main]
    input: in.scx
    output: out.scx

    [eudTurbo]
    [a.eps]
    [b.eps]

    游戏开始后的执行顺序为：

    eudTurbo.onPluginStart()
    a.onPluginStart()
    b.onPluginStart()
    每帧循环执行:
        eudTurbo.beforeTriggerExec()
        a.beforeTriggerExec()
        b.beforeTriggerExec()
        SCMD 触发器
        b.afterTriggerExec()
        a.afterTriggerExec()
        eudTurbo.afterTriggerExec()

edd 和 eds 的区别​

euddraft 对这两种扩展名的处理方式不同。

  • 对 edd 格式​

    它会在顺利编译生成地图后保持等待；如果项目目录中的文件发生变化，它会自动再次编译生成地图。
    如果编译不顺利，则会输出错误信息，你可以在修改后按 R 键让它再次编译生成。

  • 对 eds 格式​

    它会在顺利编译生成地图后退出。
    如果编译不顺利，会输出错误信息并等待你按回车键退出。

数据同步说明​

如果将非同步数据（例如玩家当前鼠标位置）赋值给变量，该变量在每个玩家的机器上都会不同。若以该变量的状态作为判断条件，执行了会影响需要同步的数据的动作（例如创建单位），则可能导致多人游戏中玩家之间的需要同步的数据不同步（例如 A 机器上创建了单位，B 机器上却没有创建单位），进而引发掉线。

这类任务通常可以使用 MSQC 插件辅助解决。



游戏时间说明​

星际争霸 1 游戏中的时间概念不同于现实时间。

  • 游戏帧（Frame）​

    星际争霸 1 的最小游戏时间单位为游戏帧（Frame），下文简写为 fr。
    1 fr == 1/16 游戏秒

  • 游戏秒​

    星际争霸 1 中游戏秒与游戏帧换算公式：
    1 游戏秒 == 16 fr

  • 游戏速度​

    《星际争霸 1》中常规游戏速度有七档。
    不同的游戏速度下，每游戏帧（Frame）所表示的操作系统时间是不同的。
    操作系统时间通常等同于现实世界的时间。

    在无网络延迟的情况下，每游戏帧（Frame）对应的操作系统时间（精确值，非近似）
    极慢（Slowest）： 1 fr == 0.167 操作系统秒
    更慢（Slower） ： 1 fr == 0.111 操作系统秒
    慢速（Slow）   ： 1 fr == 0.083 操作系统秒
    普通（Normal） ： 1 fr == 0.067 操作系统秒
    快速（Fast）   ： 1 fr == 0.056 操作系统秒
    更快（Faster） ： 1 fr == 0.048 操作系统秒
    极快（Fastest）： 1 fr == 0.042 操作系统秒

    由此可算得，在极快（Fastest）游戏速度下，1 游戏秒为0.042 × 16 = 0.672现实秒，1 操作系统秒为1 ÷ 0.042 ÷ 16 ≈ 1.488游戏秒。

  • 触发器扫描间隔​

    《星际争霸 1》的触发器是单线程轮询式的。
    在不使用 eudTurbo 和 Wait 动作的情况下触发器的轮询间隔为31 fr，即1.9375 游戏秒。
    并且，游戏开始后的第一次轮询是在第2 fr，即第0.125 游戏秒。

    游戏开始后触发器轮询时间点
    第一次轮询于第   2 游戏帧，即第  0.1250 游戏秒
    第二次轮询于第  33 游戏帧，即第  2.0625 游戏秒
    第三次轮询于第  64 游戏帧，即第  4.0000 游戏秒
    第四次轮询于第  95 游戏帧，即第  5.9375 游戏秒
    第五次轮询于第 126 游戏帧，即第  7.8750 游戏秒
    第六次轮询于第 157 游戏帧，即第  9.8125 游戏秒
    第七次轮询于第 188 游戏帧，即第 11.7500 游戏秒
    第八次轮询于第 219 游戏帧，即第 13.6875 游戏秒
    第九次轮询于第 250 游戏帧，即第 15.6250 游戏秒
                ……以此类推……

    ElapsedTime 条件参数中的游戏秒判断会取整数部分。

    function beforeTriggerExec() {
        if (ElapsedTime(Exactly, 6)) {
            DisplayTextAll("这条消息将不会输出");
        }
    }

    所以，这个条件不会达成，因为第四次轮询在第 5.9375 游戏秒整数部分为 5，第五次轮询在第 7.8750 游戏秒整数部分为 7，所以 ElapsedTime(Exactly, 6) 永远不成立。
    如果希望在第 6 游戏秒后一次性执行某个动作，可以这样写：

    function beforeTriggerExec() {
        once (ElapsedTime(AtLeast, 6)) {
            DisplayTextAll("这条消息会在游戏开始第 6 游戏秒后输出一次");
        }
    }

    同理，CountdownTimer 条件也是取屏幕上方倒计时的整数部分。
    因此在编写有关时间判定的条件时，不应该使用 Exactly（等于），而应该使用 AtLeast（大于或等于）或者 AtMost（小于或等于）。

当前玩家与本机玩家​

当前玩家 与 本机玩家 是两个不同的概念。

当前玩家​

可以将当前玩家视作一个全局变量。在一些触发器动作中，当前玩家会被当作执行参数使用。
一些触发器条件或动作支持传入玩家参数，此时可将玩家参数设为13，以使用当前玩家这个全局变量的值作为参数。
当前玩家这个全局变量的值不一定是任何玩家的编号，它可以存储任何整数值。

只在 当前玩家 == 本机玩家 的机器上生效的动作（允许非同步使用，可单独在部分玩家机器上使用）
  • DisplayText
  • CenterView
  • PlayWAV
  • MinimapPing
  • TalkingPortrait
  • Transmission
  • SetMissionObjectives
只对 当前玩家 生效的动作（必须同步在所有玩家机器上使用，否则掉线）
  • SetAllianceStatus
  • RunAIScript
  • RunAIScriptAt
  • Draw
  • Defeat
  • Victory

setcurpl 函数可以设置当前玩家这个全局变量的值。
getcurpl 函数可以获取当前玩家这个全局变量当前的值。
无论你将当前玩家设置为什么值，代码都会在所有玩家的机器上执行。

setcurpl(P1);
DisplayText("给玩家 1 打印的内容");
setcurpl(P2);
DisplayText("给玩家 2 打印的内容");
setcurpl(P3);
DisplayText("给玩家 3 打印的内容");

// $CurrentPlayer 是常量数字 13，它可以使一些与玩家相关的条件或动作去访问 当前玩家 的值
// $CurrentPlayer != getcurpl()
if ($CurrentPlayer == 13) {
    DisplayTextAll("嗯，对");
}

// 将 Fastest 游戏速度 x2
setcurpl(-122787 + 6);
SetDeaths($CurrentPlayer, SetTo, 21, 0);

本机玩家​

getuserplayerid() 可以获取本机玩家编号。它在每台机器上返回的值都不同，与 setcurpl 函数设置的值没有关联。
可以使用 getuserplayerid() 获取本机玩家编号，意味着你可以在运行时决定是否在本机执行某些代码。
它有助于提升性能。玩家很多时，并不是所有代码都需要对每个玩家执行，例如不需要为所有玩家都生成只针对玩家 1 的文字提示信息。
当然，如果你因不熟悉同步规则，使用 getuserplayerid() 直接或间接污染了需要同步的数据，它也可能导致数据不同步并引发掉线。

setcurpl(P1);
println("当前玩家编号：{}", getuserplayerid());
setcurpl(P2);
println("当前玩家编号：{}", getuserplayerid());
setcurpl(P3);
println("当前玩家编号：{}", getuserplayerid());