enjine 0.1.0

data/docs/reference/filters.md

@@ -0,0 +1,172 @@
+# Target filters and selectors
+
+<!-- Generated by `rake docs` from the primitive registry. Do not edit. -->
+
+## any_target
+
+A creature, player or planeswalker (battles: later).
+
+Rules: CR 115.4
+
+```json
+"any_target"
+```
+
+## artifact
+
+An artifact on the battlefield.
+
+Rules: CR 115.1
+
+```json
+"artifact"
+```
+
+## creature
+
+A creature on the battlefield.
+
+Rules: CR 115.1
+
+```json
+"creature"
+```
+
+## creature_or_planeswalker
+
+A creature or planeswalker on the battlefield.
+
+Rules: CR 115.1
+
+```json
+"creature_or_planeswalker"
+```
+
+## graveyard_card
+
+A card in a graveyard (any player's, in seat order; restrict with `controller` for its owner and `any_of`/`not` for its card types).
+
+Rules: CR 404.1, CR 115.1
+
+```json
+{
+  "graveyard_card": {
+    "any_of": [
+      "creature"
+    ]
+  }
+}
+```
+
+## land
+
+A land on the battlefield.
+
+Rules: CR 115.1
+
+```json
+"land"
+```
+
+## one_of
+
+Anything at least one of the listed filters matches (each may have restrictions).
+
+Rules: CR 115.1, CR 109.2
+
+| Parameter | Description |
+| --- | --- |
+| `(list)` | two or more filters |
+
+```json
+{
+  "one_of": [
+    {
+      "permanent": {
+        "any_of": [
+          "artifact",
+          "enchantment"
+        ]
+      }
+    },
+    {
+      "creature": {
+        "power": {
+          "at_least": 4
+        }
+      }
+    }
+  ]
+}
+```
+
+## opponent
+
+An opponent of the ability's controller.
+
+Rules: CR 102.2
+
+```json
+"opponent"
+```
+
+## permanent
+
+Any permanent on the battlefield.
+
+Rules: CR 110.1
+
+```json
+"permanent"
+```
+
+## planeswalker
+
+A planeswalker on the battlefield.
+
+Rules: CR 115.1
+
+```json
+"planeswalker"
+```
+
+## player
+
+A player.
+
+Rules: CR 115.1
+
+```json
+"player"
+```
+
+## spell
+
+A spell on the stack.
+
+Rules: CR 112.1, CR 115.1
+
+```json
+"spell"
+```
+
+## stack_ability
+
+An activated or triggered ability on the stack. `kind`: "activated" or "triggered" for only one of them; `controller`: you | opponent; `source`: a filter its source matches (e.g. "creature", "artifact").
+
+Rules: CR 113.1b, CR 115.1, CR 605.3b, CR 113.7
+
+| Parameter | Description |
+| --- | --- |
+| `kind` | activated | triggered |
+| `controller` | you | opponent |
+| `source` | filter |
+
+```json
+{
+  "stack_ability": {
+    "controller": "you",
+    "source": "creature"
+  }
+}
+```