@my-swu/simulator-client 0.1.0

package/schema/game-command.schema.json

@@ -0,0 +1,775 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "GameCommand",
+  "oneOf": [
+    {
+      "type": "string",
+      "enum": [
+        "deployLeader",
+        "takeInitiative",
+        "pass",
+        "concede"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "chooseInitiativePlayer": {
+          "type": "object",
+          "properties": {
+            "seat": {
+              "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/Seat"
+            }
+          },
+          "required": [
+            "seat"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "chooseInitiativePlayer"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "chooseMulligan": {
+          "type": "object",
+          "properties": {
+            "takeMulligan": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "takeMulligan"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "chooseMulligan"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "chooseOpeningResources": {
+          "type": "object",
+          "properties": {
+            "cardInstanceIds": {
+              "type": "array",
+              "items": {
+                "type": "integer",
+                "format": "uint32",
+                "minimum": 0
+              }
+            }
+          },
+          "required": [
+            "cardInstanceIds"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "chooseOpeningResources"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "playCard": {
+          "type": "object",
+          "properties": {
+            "attachedToUnitId": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "format": "uint64",
+              "minimum": 0
+            },
+            "captureSelections": {
+              "type": "array",
+              "items": {
+                "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/CaptureSelection"
+              }
+            },
+            "cardInstanceId": {
+              "type": "integer",
+              "format": "uint32",
+              "minimum": 0
+            },
+            "creditTokensToSpend": {
+              "type": "integer",
+              "format": "uint",
+              "minimum": 0
+            },
+            "exploitUnitIds": {
+              "type": "array",
+              "items": {
+                "type": "integer",
+                "format": "uint64",
+                "minimum": 0
+              }
+            },
+            "modeIndices": {
+              "type": "array",
+              "items": {
+                "type": "integer",
+                "format": "uint",
+                "minimum": 0
+              }
+            },
+            "smuggleCostTarget": {
+              "anyOf": [
+                {
+                  "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AbilityTarget"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "smuggleKind": {
+              "anyOf": [
+                {
+                  "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/SmuggleKind"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "target": {
+              "anyOf": [
+                {
+                  "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AbilityTarget"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "targets": {
+              "type": "array",
+              "items": {
+                "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AbilityTarget"
+              }
+            }
+          },
+          "required": [
+            "cardInstanceId",
+            "exploitUnitIds",
+            "targets",
+            "modeIndices",
+            "captureSelections",
+            "creditTokensToSpend"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "playCard"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "useLeaderAction": {
+          "type": "object",
+          "properties": {
+            "creditTokensToSpend": {
+              "type": "integer",
+              "format": "uint",
+              "minimum": 0
+            },
+            "modeIndices": {
+              "type": "array",
+              "items": {
+                "type": "integer",
+                "format": "uint",
+                "minimum": 0
+              }
+            },
+            "target": {
+              "anyOf": [
+                {
+                  "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AbilityTarget"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "targets": {
+              "type": "array",
+              "items": {
+                "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AbilityTarget"
+              }
+            }
+          },
+          "required": [
+            "targets",
+            "modeIndices",
+            "creditTokensToSpend"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "useLeaderAction"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "useActionAbility": {
+          "type": "object",
+          "properties": {
+            "creditTokensToSpend": {
+              "type": "integer",
+              "format": "uint",
+              "minimum": 0
+            },
+            "modeIndices": {
+              "type": "array",
+              "items": {
+                "type": "integer",
+                "format": "uint",
+                "minimum": 0
+              }
+            },
+            "source": {
+              "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/ActionAbilitySource"
+            },
+            "target": {
+              "anyOf": [
+                {
+                  "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AbilityTarget"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "targets": {
+              "type": "array",
+              "items": {
+                "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AbilityTarget"
+              }
+            }
+          },
+          "required": [
+            "source",
+            "targets",
+            "modeIndices",
+            "creditTokensToSpend"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "useActionAbility"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "deployLeaderAsPilot": {
+          "type": "object",
+          "properties": {
+            "attachedToUnitId": {
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            }
+          },
+          "required": [
+            "attachedToUnitId"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "deployLeaderAsPilot"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "deployLeaderByIndex": {
+          "type": "object",
+          "properties": {
+            "leaderIndex": {
+              "type": "integer",
+              "format": "uint",
+              "minimum": 0
+            }
+          },
+          "required": [
+            "leaderIndex"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "deployLeaderByIndex"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "deployLeaderAsPilotByIndex": {
+          "type": "object",
+          "properties": {
+            "attachedToUnitId": {
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            },
+            "leaderIndex": {
+              "type": "integer",
+              "format": "uint",
+              "minimum": 0
+            }
+          },
+          "required": [
+            "leaderIndex",
+            "attachedToUnitId"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "deployLeaderAsPilotByIndex"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "attack": {
+          "type": "object",
+          "properties": {
+            "attackerId": {
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            },
+            "target": {
+              "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AttackTarget"
+            }
+          },
+          "required": [
+            "attackerId",
+            "target"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "attack"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "resolveAbility": {
+          "type": "object",
+          "properties": {
+            "abilityId": {
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            },
+            "attachedToUnitId": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "format": "uint64",
+              "minimum": 0
+            },
+            "captureSelections": {
+              "type": "array",
+              "items": {
+                "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/CaptureSelection"
+              }
+            },
+            "creditTokensToSpend": {
+              "description": "Exact Credits selected for a paid Plot resolution. Legacy payloads\nomitted this field before Plot could spend Credits.",
+              "type": "integer",
+              "format": "uint",
+              "default": 0,
+              "minimum": 0
+            },
+            "exploitUnitIds": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "integer",
+                "format": "uint64",
+                "minimum": 0
+              }
+            },
+            "modeIndices": {
+              "type": "array",
+              "items": {
+                "type": "integer",
+                "format": "uint",
+                "minimum": 0
+              }
+            },
+            "target": {
+              "anyOf": [
+                {
+                  "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AbilityTarget"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "targets": {
+              "type": "array",
+              "items": {
+                "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AbilityTarget"
+              }
+            }
+          },
+          "required": [
+            "abilityId",
+            "targets",
+            "modeIndices",
+            "captureSelections"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "resolveAbility"
+      ]
+    },
+    {
+      "description": "Explicitly accepts a targetless optional ability.",
+      "type": "object",
+      "properties": {
+        "acceptAbility": {
+          "type": "object",
+          "properties": {
+            "abilityId": {
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            }
+          },
+          "required": [
+            "abilityId"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "acceptAbility"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "declineAbility": {
+          "type": "object",
+          "properties": {
+            "abilityId": {
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            }
+          },
+          "required": [
+            "abilityId"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "declineAbility"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "chooseAbilityModes": {
+          "type": "object",
+          "properties": {
+            "abilityId": {
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            },
+            "modeIndices": {
+              "type": "array",
+              "items": {
+                "type": "integer",
+                "format": "uint",
+                "minimum": 0
+              }
+            }
+          },
+          "required": [
+            "abilityId",
+            "modeIndices"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "chooseAbilityModes"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "chooseAbilityCards": {
+          "type": "object",
+          "properties": {
+            "abilityId": {
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            },
+            "cardInstanceIds": {
+              "type": "array",
+              "items": {
+                "type": "integer",
+                "format": "uint32",
+                "minimum": 0
+              }
+            },
+            "creditTokensToSpend": {
+              "type": "integer",
+              "format": "uint",
+              "minimum": 0
+            }
+          },
+          "required": [
+            "abilityId",
+            "creditTokensToSpend",
+            "cardInstanceIds"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "chooseAbilityCards"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "chooseAbilityName": {
+          "type": "object",
+          "properties": {
+            "abilityId": {
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            },
+            "name": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "abilityId",
+            "name"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "chooseAbilityName"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "chooseAbilityAspect": {
+          "type": "object",
+          "properties": {
+            "abilityId": {
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            },
+            "aspect": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "abilityId",
+            "aspect"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "chooseAbilityAspect"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "chooseAbilityAttack": {
+          "type": "object",
+          "properties": {
+            "abilityId": {
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            },
+            "attackerId": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "format": "uint64",
+              "minimum": 0
+            },
+            "target": {
+              "anyOf": [
+                {
+                  "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AttackTarget"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            }
+          },
+          "required": [
+            "abilityId"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "chooseAbilityAttack"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "chooseDistributionAssignments": {
+          "type": "object",
+          "properties": {
+            "abilityId": {
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            },
+            "assignments": {
+              "type": "array",
+              "items": {
+                "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/DistributionAssignment"
+              }
+            }
+          },
+          "required": [
+            "abilityId",
+            "assignments"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "chooseDistributionAssignments"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "chooseTriggeredAbilityPlayerOrder": {
+          "type": "object",
+          "properties": {
+            "firstSeat": {
+              "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/Seat"
+            }
+          },
+          "required": [
+            "firstSeat"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "chooseTriggeredAbilityPlayerOrder"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "takeAvailableCounter": {
+          "type": "object",
+          "properties": {
+            "counter": {
+              "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/TwinSunsCounter"
+            }
+          },
+          "required": [
+            "counter"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "takeAvailableCounter"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "choosePlanCard": {
+          "type": "object",
+          "properties": {
+            "cardInstanceId": {
+              "type": "integer",
+              "format": "uint32",
+              "minimum": 0
+            }
+          },
+          "required": [
+            "cardInstanceId"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "choosePlanCard"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "chooseRegroupResource": {
+          "type": "object",
+          "properties": {
+            "cardInstanceId": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "format": "uint32",
+              "minimum": 0
+            }
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "chooseRegroupResource"
+      ]
+    }
+  ]
+}