proc_maximum.lua functions + Card.AddCounter, Xyz.AddProcedure

api/functions/Card/AddCenterToSideEffectHandler.yml

@@ -2,14 +2,15 @@
 name: AddCenterToSideEffectHandler
 namespace: Card
 description: |-
-  Rush related function
+  Grants an Effect to a center Maximum Monster's [L] and [R] pieces. Primarily used to share protection effects.
+summary: Grants an Effect to a Maximum Monster's [L] and [R] pieces.
 status:
   index: stable
 parameters:
   - name: c
-    type: [ any ]
-    description: (To be added)
+    type: [ Card ]
+    description: The main (center) Maximum Monster Card.
   - name: eff
-    type: [ any ]
-    description: (To be added)
-tags: [ under-construction ]
+    type: [ Effect ]
+    description: The Effect to be granted to the Left and Right monsters.
+tags: [ rush ]

api/functions/Card/AddCounter.yml

@@ -2,25 +2,28 @@
 name: AddCounter
 namespace: Card
 description: |-
-  Adds a number (int count) of the specified counter (int countertype) to a card (Card c). If singly is set to a number, then it will be added by that number each time. When the number of added counter would exceed the limit for that card, it is not added.
+  Adds any number of counters of the specified type to a Card.
+summary: Adds a specific counter to a Card.
 status:
   index: stable
 parameters:
   - name: c
     type: [ Card ]
-    description: (To be added)
+    description: The Card that will receive the counter
   - name: countertype
     type: [ int ]
-    description: (To be added)
+    description: The value (or corresponding constant) for the type of the counter that will be placed.
   - name: count
     type: [ int ]
-    description: (To be added)
-  - name: singly
-    type: [ int ]
-    description: (To be added)
+    description: The number of counters to be placed.
+  - name: checklimits
+    type: [ bool ]
+    description: |-
+      If set to `true`, only places counters up to the maximum value
+      set by an `EFFECT_COUNTER_LIMIT` Effect on the card for that counter.
+      If `false`, does not place any counter if the limit would be exceeded.
     required: false
     defaultValue: false
 returns:
   - type: [ bool ]
-    description: (To be added)
-tags: [ under-construction ]
+    description: Returns `true` if counters were successfully placed.

api/functions/Card/AddDoubleTribute.yml

@@ -2,26 +2,31 @@
 name: AddDoubleTribute
 namespace: Card
 description: |-
-  Rush related function
+  Adds an Effect to a Card that allows it to be used as a double tribute in Rush Duels.
+summary: Allows a Card to be used as a double tribute in Rush Duels.
 status:
   index: stable
 parameters:
   - name: c
-    type: [ any ]
-    description: (To be added)
+    type: [ Card ]
+    description: The Card that will receive the Effect.
   - name: id
-    type: [ any ]
-    description: (To be added)
+    type: [ int ]
+    description: |-
+      A Card ID, from which the strings 0 and 1 are called when the tribute summon would happen, to identify which double tribute Effect is being used.
   - name: otfilter
-    type: [ any ]
-    description: (To be added)
+    type: [ CardFilter ]
+    # TODO: better description
+    description: Filters which monsters on the field can be tributed for this alternative summoning method.
   - name: eftg
-    type: [ any ]
-    description: (To be added)
-  - name: reset
-    type: [ any ]
-    description: (To be added)
+    # TODO: settle how to refer to overloads
+    type: [ EffectTarget ]
+    description: Filters which monsters can use the affected Card as double tribute.
+  - name: resets
+    type: [ int ]
+    description: Reset values to be used with the Effect.
+    defaultValue: 0
   - name: ...
-    type: [ any ]
-    description: (To be added)
-tags: [ under-construction ]
+    type: [ int ]
+    description: Any number of FLAG_DOUBLE_TRIB constants, that will be registered to the Card as a flag Effect, with the same reset values from `resets`.
+tags: [ rush ]

api/functions/Card/AddMaximumAtkHandler.yml

@@ -2,11 +2,13 @@
 name: AddMaximumAtkHandler
 namespace: Card
 description: |-
-  Rush related function
+  Adds an Effect to a Card that changes its original ATK to be its Maximum ATK when in Maximum Mode.
+  The Maximum ATK is obtained from the Card's metatable.
+summary: Implements the Maximum ATK of a Maximum monster.
 status:
   index: stable
 parameters:
   - name: c
-    type: [ any ]
-    description: (To be added)
-tags: [ under-construction ]
+    type: [ Card ]
+    description: The Card that will receive the Effect.
+tags: [ rush ]

api/functions/Xyz/AddProcedure.yml

@@ -2,39 +2,62 @@
 name: AddProcedure
 namespace: Xyz
 description: |-
-  Adds an Xyz Procedure where (function f) is the required Xyz Material, and (int lv) is the required level, but it can also be nil if there is no required Level. (int ct) is the required number of materials. (function alterf) is the alternate material, e.g. Number C39: Utopia Ray. (int desc) is the description shown when attempting to Xyz Summon using (function alterf). (int maxct) is the maximum number of materials, which defaults to (int ct). (function op) is used by some monsters do something else in addition to using an Xyz Material (e.g. Digital Bug Corebage (detach 2 materials) or Number 99: Utopic Dragon (discard 1 "Rank-Up-Magic")). (bool mustbemat) is used if you can only use the listed materials during the Xyz Summon, this disallows Anime effects such as Orichalcum Chain (minus 1 material) or Triangle Evolution (triple material). (function exchk) is an additional check at the end of selecting materials (e.g. Number F0: Utopic Future (checks if the materials have the same Rank)
+  Registers an Effect to a Card an  that allows it to be Xyz Summoned.
+summary: Adds an Xyz Summon procedure to a Card
 status:
   index: stable
 parameters:
   - name: c
     type: [ Card ]
-    description: (To be added)
+    description: The Card that will receive the procedure.
   - name: f
-    type: [ function, nil ]
-    description: (To be added)
+    type: [ CardFilter, nil ]
+    description: |-
+      A filter function for the Cards that can be used as Xyz materials.
+      Set to `nil` if no property other than level is required, `nil` is also valid.
   - name: lv
     type: [ int, nil ]
-    description: (To be added)
+    description: |-
+      The level the materials must have.
+      If no specific level is required, `nil` is also valid.
   - name: ct
     type: [ int ]
-    description: (To be added)
+    description: |-
+      The number of required materials.
+      If the Card allows a variable number of materials, ct is used as the minimum.
   - name: alterf
-    type: [ function, nil ]
-    description: (To be added)
+    type: [ CardFilter, nil ]
+    description: Alternative material(s), if allowed by the Card (e.g. Number C39 Utopia Ray).
+    required: false
+    defaultValue: nil
   - name: desc
-    type: [ int ]
-    description: (To be added)
+    type: [ string ]
+    description: |-
+      An integer pointing to a string for the description shown when attempting to Xyz Summon using the alternative materials.
+      Mandatory when `alterf` is used.
+    required: false
+    defaultValue: 0
   - name: maxct
     type: [ int ]
-    description: (To be added)
+    description: The maximum number of materials.
+    required: false
     defaultValue: ct
   - name: op
     type: [ function ]
-    description: (To be added)
+    description: |-
+      A function to be used when an extra operation must be executed in addition to using Xyz Materials (e.g. Digital Bug Corebage,  Number 99 Utopic Dragon)
+    required: false
+    defaultValue: nil
   - name: mustbemat
     type: [ bool ]
-    description: (To be added)
+    description: |-
+      A parameter that restricts the materials to specifically listed materials.
+      This disables the Effects of Cards such as Orichalcum Chain (minus 1 material) or Triangle Evolution (triple material).
+    required: false
+    defaultValue: false
   - name: exchk
     type: [ function ]
-    description: (To be added)
-tags: [ under-construction ]
+    description: |-
+      Additional checks that are performed in the material group (e.g. Number F0 Utopic Future)
+    required: false
+    defaultValue: nil

api/tags/rush.yml

@@ -1,4 +1,5 @@
 ---!tag
 name: rush
 description: |-
-  Related to Rush Duels.
+  Functions and constants related to the implementation of [Rush Duel](https://yugipedia.com/wiki/Yu-Gi-Oh!_Rush_Duel) cards and rules.
+  Implementations can be found in [proc_maximum.lua](https://github.com/ProjectIgnis/CardScripts/blob/master/proc_maximum.lua)