Path of Exile Superfilter

Path of Exile 财物过滤器的预处理器，它向 GGG 的财物过滤器语法添加变量、混合、算术和许多其他有用功能，并将使用扩展语法编写的过滤器编译成可以在游戏中使用的纯财物过滤器。

您可以在本存储库的发行页面下载当前版本。

语法

混合

混合是可以包含在任何地方的可重用指令块。它们可以用来自动化过滤器中重复部分的重叠。

Mixin FlaskMagic($type)
	Class Flask
	Rarity Magic
	BaseType $type
	SetTextColor 100 100 255 255
	SetBorderColor 100 100 100
	SetFontSize 38

Show
	+FlaskMagic("Small")
	ItemLevel <= 5

Show
	+FlaskMagic("Medium")
	ItemLevel <= 8
	ItemLevel >= 3

这会编译为

Show
	Class Flask
	Rarity Magic
	BaseType "Small"
	SetTextColor 100 100 255 255
	SetBorderColor 100 100 100
	SetFontSize 38
	ItemLevel <= 5

Show
	Class Flask
	Rarity Magic
	BaseType "Medium"
	SetTextColor 100 100 255 255
	SetBorderColor 100 100 100
	SetFontSize 38
	ItemLevel <= 8
	ItemLevel >= 3

变量

您可以定义如下变量

$var = "value"
$var2 = "this" "is" "a" "test"
$num = 10

它们可以包含任何可以传递给过滤器指令的值，包括值列表。

变量定义可以在两个地方使用

1. 在第一个块之前

   在这里定义的变量将在全局范围内可见。

2. 在块内部

   如果放置在块内部，则该变量将只在该块及其嵌套的块中可见，并且只对变量定义之后的指令可见。

算术

您基本上可以在任何地方使用简单的数学表达式。

$scale = 1.2
Show
    SetFontSize 38 * $scale

请注意，尽管您可以使用非整数数字，但所有计算的结果在渲染时都会四舍五入到整数，因为 GGG 的财物过滤器语法只支持整数。

这也是有效的语法，但您可能希望添加说明性括号。

Show
    SetTextColor 100 * $foo 100 255 + $bar 255
    # Probably better like that:
    SetTextColor (100 * $foo) 100 (255 + $bar) 255

导入

您可以使用导入语句导入其他 Superfilter 文件。那里定义的混合和全局变量也将可在包含文件中使用。

Import "some_file.sf"

条件块

您可以根据条件包含或排除块。要表达条件，您可以使用简单的相等和比较检查或布尔值。

$yes = True
$no = 1 > 2

Show if True # This block will be included
    SetStatement 123

Show if False # this won't
    SetStatement 234

Show if 2 > 3
    SetStatement 345

Show if 3 > 2
    SetStatement 456

Show if $yes
    SetStatement 567

Show if $no
    SetStatement 678

注释

根据您的使用情况，您可能希望注释通过输出或不要通过。您可以使用 --comments 选项来更改此行为。如果提供了该选项，则注释将通过输出，否则将被丢弃。

在要正确格式化输出时，如果注释位于显示/隐藏块之前，有一个小的注意事项

Show
    # comment
    Class Flask
    # another comment

# comments for this following block
# more comments
Show
    Class Flask
    
---- This will actually produce the following output:

Show
    # comment
    Class Flask
    # another comment
    # comments for this following block
    # more comments

Show
    Class Flask

为了避免这种行为，您可以使用特殊的“块注释”语法

Show
    # comment
    Class Flask
    # another comment

#! comment for this following block
#! more comments
Show
    Class Flask

----- Output:
Show
    # comment
    Class Flask
    # another comment
    
# comments for this following block
# more comments
Show
    Class Flask

这样做是为了使语法更不模糊 - 没有显式的块注释，就无法在块的末尾有注释行，因为无法将其与描述下一个块的注释区分开来。

命令行使用

USAGE:
    superfilter.exe [FLAGS] [OPTIONS] <PATH>

FLAGS:
    -c, --comments    Include comments in the output
    -h, --help        Prints help information
    -p, --pretty      Include indentation and other formatting in the output
    -V, --version     Prints version information

OPTIONS:
    -l, --line-endings <LINE_ENDING>    Type of line ending used (LF OR CRLF) defaults to the platform line ending
                                        [values: lf, crlf]
    -o, --output <FILE>                 Output file. If this option is omitted, the output will be printed to the
                                        console.

ARGS:
    <PATH>    Path of the input file

对脚本创建者的说明

如果您打算将您创建的过滤器分发给其他玩家，您可能希望提供一个简单的方法，让他们在修改您的过滤器时可以轻松地重新编译您的脚本。

具体如何操作由您决定，但您可以在存储库中使用一个PowerShell脚本（compile-script.ps1）来帮助实现这一点，并将其包含在您的过滤器中。它仅编译指定文件，但还会检查Superfilter是否已安装以及是否是足够新的版本。如果它不是，则打印错误消息并将用户导向下载页面以安装工具。要使用此脚本，只需更改其中的文件名以符合您的过滤器需求，然后执行它以重新编译您的过滤器。

路线图

如果您有建议，请随时打开一个问题，告诉我所有关于它的事情！

已经计划好的事情，不分先后

• 改进对布尔表达式的支持（在布尔值上添加和/或操作）