Card-script param declarations (batch 1: framework classes)

forge-ai/src/main/java/forge/ai/SpellAbilityAi.java

@@ -37,6 +37,11 @@
  * The three main methods are canPlayAI(), chkAIDrawback and doTriggerAINoCost.
  */
 public abstract class SpellAbilityAi {
+    public static final String[] OPTIONAL_PARAMS = {
+        "AIActivateLast", "AIBidMax", "AICheckSVar", "AILifeThreshold", "AILogic",
+        "AIManaPref", "AIMaxTgtsCount", "AIPhyrexianPayment", "AIRespondsToOwnAbility",
+        "AISVarCompare", "AITgts", "AITgtsStrict", "AIXMax", "UnlessAI",
+    };
 
     public Predicate<Card> CREATURE_OR_TAP_ABILITY = c -> {
         if (c.isCreature()) {

forge-game/src/main/java/forge/game/CardTraitBase.java

@@ -37,6 +37,16 @@
  *
  */
 public abstract class CardTraitBase implements GameObject, IHasCardView, IHasSVars {
+    public static final String[] OPTIONAL_PARAMS = {
+        "Adamant", "Blessing", "Bloodthirst", "CheckDefinedPlayer", "CheckSVar",
+        "CheckSecondSVar", "ClassLevel", "DayTime", "DefinedPlayerCompare", "Delirium",
+        "Desert", "FatefulHour", "Hellbent", "Invert", "IsPresent", "IsPresent2",
+        "LifeAmount", "LifeTotal", "ManaNotSpent", "ManaSpent", "Metalcraft", "Monarch",
+        "PresentCompare", "PresentCompare2", "PresentDefined", "PresentPlayer",
+        "PresentPlayer2", "PresentZone", "PresentZone2", "Revolt", "SVarCompare",
+        "SecondSVarCompare", "Secondary", "Threshold", "WerewolfTransformCondition",
+        "WerewolfUntransformCondition",
+    };
 
     /** The host card. */
     protected Card hostCard;

forge-game/src/main/java/forge/game/ability/AbilityFactory.java

@@ -46,6 +46,17 @@
  * @version $Id$
  */
 public final class AbilityFactory {
+    public static final String[] OPTIONAL_PARAMS = {
+        "BidSubAbility", "CantChooseSubAbility", "Choices", "ChooseNumberSubAbility",
+        "ChooseSubAbility", "ChosenPile", "Cost", "Execute", "FallbackAbility",
+        "FalseSubAbility", "GiftAbility", "GuessCorrect", "GuessWrong", "HeadsSubAbility",
+        "Highest", "LoseSubAbility", "Lowest", "MatchedAbility", "NonBasicSpell",
+        "NotLowest", "Origin", "OtherwiseSubAbility", "PreventionSubAbility",
+        "RegenerationAbility", "RepeatSubAbility", "ResultSubAbilities", "ReturnAbility",
+        "SpellDescription", "SubAbility", "TailsSubAbility", "TrueSubAbility",
+        "UnchosenPile", "UnmatchedAbility", "ValidTgts", "VoteSubAbility",
+        "VoteTiedAbility", "WinSubAbility",
+    };
 
     public static final List<String> additionalAbilityKeys = Lists.newArrayList(
             "WinSubAbility", "OtherwiseSubAbility", // Clash

forge-game/src/main/java/forge/game/ability/AbilityUtils.java

@@ -50,6 +50,13 @@
 import java.util.stream.IntStream;
 
 public class AbilityUtils {
+    public static final String[] OPTIONAL_PARAMS = {
+        "AbilityCount", "AnnounceMax", "Destination", "ETB", "ForgetOtherTargets",
+        "IncludeAllComponentCards", "LockInText", "RememberCostMana", "RememberTargets",
+        "Triggered", "UnlessColor", "UnlessCost", "UnlessPayer", "UnlessResolveSubs",
+        "UnlessSwitched", "UnlessUpTo", "XMax", "XMin",
+    };
+
     private final static ImmutableList<String> cmpList = ImmutableList.of("LT", "LE", "EQ", "GE", "GT", "NE");
 
     // should the three getDefined functions be merged into one? Or better to

forge-game/src/main/java/forge/game/ability/SpellAbilityEffect.java

@@ -41,6 +41,19 @@
  */
 
 public abstract class SpellAbilityEffect {
+    // Card-script parameters read by the framework, declared here so the set each class
+    // consumes is explicit and can be checked against the card scripts. Each framework class
+    // lists the shared (optional) base params it consumes; ability effects additionally
+    // declare REQUIRED_PARAMS (one-of groups) on top.
+    public static final String[] OPTIONAL_PARAMS = {
+        "AfterDescription", "Amount", "Announce", "AtEOTCondition", "AtEOTDesc",
+        "ConditionDescription", "Defined", "DefinedExiler", "Duration",
+        "ExiledWithEffectSource", "ForEach", "Forecast", "GiftDescription",
+        "IncludeAllComponentCards", "Named", "ReplaceDyingCondition", "ReplaceDyingDefined",
+        "ReplaceDyingExiledWith", "ReplaceDyingValid", "ReplaceDyingZone", "ReturnAbility",
+        "ReturnValid", "SpellDescription", "StackDescription", "StartingWith",
+        "ThisDefinedAndTgts",
+    };
 
     public abstract void resolve(SpellAbility sa);
 

forge-game/src/main/java/forge/game/cost/Cost.java

@@ -47,6 +47,15 @@
  * @version $Id$
  */
 public class Cost implements Serializable {
+    public static final String[] OPTIONAL_PARAMS = {
+        "AffectedZone", "Amount", "Announce", "Collected", "CollectedCards", "Color",
+        "Cost", "Exiled", "ExiledCards", "FirstForetell", "ForEachShard", "Foraged",
+        "ForagedCards", "IgnoreGeneric", "MinMana", "ModeCost", "OnlyFirstSpell",
+        "RaiseCost", "RaiseTo", "ReduceAmount", "ReduceCost", "Relative",
+        "SpellDescription", "TapCreaturesForMana", "Type", "UnlessValidTarget", "UpTo",
+        "ValidCard", "ValidSpell", "ValidTarget",
+    };
+
     /**
      * Serializables need a version ID.
      */

forge-game/src/main/java/forge/game/spellability/SpellAbility.java

@@ -74,6 +74,18 @@
  * @version $Id$
  */
 public abstract class SpellAbility extends CardTraitBase implements ISpellAbility, IIdentifiable, Comparable<SpellAbility> {
+    public static final String[] OPTIONAL_PARAMS = {
+        "AlternateCost", "Amount", "Announce", "Boast", "CantCopy", "CloakUp", "CostDesc",
+        "CumulativeUpkeep", "DisguiseUp", "DividedAsYouChoose", "Exhaust", "Hidden",
+        "IsCurse", "ManaRestriction", "ManifestUp", "MaxTotalTargetCMC",
+        "MaxTotalTargetPower", "MorphUp", "Origin", "Planeswalker", "PowerUp",
+        "PrecostDesc", "SpellDescription", "TargetType", "TargetingPlayer",
+        "TargetingPlayerControls", "TargetsWithControllerProperty",
+        "TargetsWithDefinedController", "TargetsWithRelatedProperty",
+        "TargetsWithSharedCardType", "TargetsWithSharedTypes", "Unlock", "ValidAfterStack",
+        "WithoutManaCost", "XColor",
+    };
+
     private static int maxId = 0;
     private static int nextId() { return ++maxId; }
 

forge-game/src/main/java/forge/game/spellability/SpellAbilityCondition.java

@@ -46,6 +46,20 @@
  * @since 1.0.15
  */
 public class SpellAbilityCondition extends SpellAbilityVariables {
+    public static final String[] OPTIONAL_PARAMS = {
+        "Condition", "ConditionActivationLimit", "ConditionCheckSVar",
+        "ConditionChosenColor", "ConditionCompare", "ConditionCompare2", "ConditionDefined",
+        "ConditionDefined2", "ConditionFirstCombat", "ConditionGameTypes",
+        "ConditionLifeAmount", "ConditionLifeTotal", "ConditionManaNotSpent",
+        "ConditionManaSpent", "ConditionNoDifferentColors", "ConditionNotPresent",
+        "ConditionOpponentTurn", "ConditionOptionalPaid", "ConditionPhases",
+        "ConditionPlayerContains", "ConditionPlayerDefined", "ConditionPlayerTurn",
+        "ConditionPresent", "ConditionPresent2", "ConditionSVarCompare",
+        "ConditionSorcerySpeed", "ConditionTargetValidTargeting",
+        "ConditionTargetsSingleTarget", "ConditionZone", "OrConditionCheckSVar",
+        "OrOtherConditionSVarCompare",
+    };
+
     // A class for handling SpellAbility Conditions. These restrictions include:
     // Zone, Phase, OwnTurn, Speed (instant/sorcery), Amount per Turn, Player,
     // Threshold, Metalcraft, LevelRange, etc

forge-game/src/main/java/forge/game/spellability/SpellAbilityRestriction.java

@@ -50,6 +50,16 @@
  * @version $Id$
  */
 public class SpellAbilityRestriction extends SpellAbilityVariables {
+    public static final String[] OPTIONAL_PARAMS = {
+        "Activation", "ActivationAfterBlockers", "ActivationFirstCombat",
+        "ActivationGameTypes", "ActivationLifeAmount", "ActivationLifeTotal",
+        "ActivationLimit", "ActivationPhases", "ActivationZone", "Activator",
+        "AdditionalActivationZone", "Affected", "CheckSVar", "ClassLevel",
+        "GameActivationLimit", "InstantSpeed", "IsPresent", "OpponentTurn", "PlayerTurn",
+        "PresentCompare", "PresentDefined", "PresentZone", "SVarCompare", "SorcerySpeed",
+        "ValidSA",
+    };
+
     // A class for handling SpellAbility Restrictions. These restrictions include:
     // Zone, Phase, OwnTurn, Speed (instant/sorcery), Amount per Turn, Player,
     // Threshold, Metalcraft, LevelRange, etc

forge-game/src/main/java/forge/game/spellability/TargetRestrictions.java

@@ -43,6 +43,16 @@
  * @version $Id$
  */
 public class TargetRestrictions {
+    public static final String[] OPTIONAL_PARAMS = {
+        "MaxTotalTargetCMC", "MaxTotalTargetPower", "RandomNumTargets", "TargetMax",
+        "TargetMin", "TargetUnique", "TargetValidTargeting", "TargetingPlayer",
+        "TargetsAtRandom", "TargetsForEachPlayer", "TargetsWithDifferentCMC",
+        "TargetsWithDifferentControllers", "TargetsWithDifferentNames",
+        "TargetsWithEqualToughness", "TargetsWithSameCardType", "TargetsWithSameController",
+        "TargetsWithSameCreatureType", "TargetsWithoutSameCreatureType", "TgtPrompt",
+        "TgtZone", "ValidTgts", "ValidTgtsDesc",
+    };
+
     // Target has two things happening:
     // Targeting restrictions (Creature, Min/Maxm etc) which are true for this
     // What this Object is restricted to targeting