Merge pull request #36 from ProjectIgnis/pyrQ-patch-4

Added new function descriptions

api/constants/SummonType/SUMMON_TYPE_TRIBUTE.yml

@@ -0,0 +1,12 @@
+---!constant
+name: SUMMON_TYPE_TRIBUTE
+enum: SummonType
+value: 0x11000000
+description: The value used for a [Tribute Summon](https://yugipedia.com/wiki/Tribute_Summon).
+summary: Tribute Summon
+status:
+  index: stable
+aliases:
+  - name: SUMMON_TYPE_ADVANCE
+    status:
+      index: deleted

api/functions/Auxiliary/DiscardCost.yml

@@ -0,0 +1,27 @@
+---!function
+name: DiscardCost
+namespace: aux
+description: Creates a baseline [cost function](/api/types/EffectCost) used for effects that discard a card(s) as cost, such as `Discard 1 card; ...` (e.g. "Raigeki Break").
+summary: Creates a cost function for effects that discard a card(s) as cost.
+status:
+  index: stable
+parameters:
+  - name: filter
+    type: [ CardFilter ]
+    description: Additional filter to be used for the card(s) that are to be discarded (e.g. `Pendulum Monster` for "Dragonpit Magician").
+    required: false
+    defaultValue: Card.IsDiscardable
+  - name: other
+    type: [ bool ]
+    description: If set to `true`, the activating card itself will be excluded from the discard check and the discarding itself. Used for effects such as `You can discard 1 other card; ...` as well as Spell/Trap activations (e.g. "Twin Twisters").
+    required: false
+    defaultValue: false
+  - name: count
+    type: [ int ]
+    description: The number of cards to be discarded.
+    required: false
+    defaultValue: 1
+returns:
+  - type: [ CostFunction ]
+    description: The cost function generated based on the given parameters.
+    guaranteed: true

api/functions/Auxiliary/PayLPCost.yml

@@ -0,0 +1,20 @@
+---!function
+name: PayLPCost
+namespace: aux
+description: Creates a baseline [cost function](/api/types/EffectCost) used for effects that pay LP as cost, such as `Pay X LP; ...` (e.g. "Instant Fusion").
+summary: Creates a cost function for effects that pay LP as cost.
+status:
+  index: stable
+parameters:
+  - name: lp_value
+    type: [ number ]
+    description: The amount of LP that must be paid. If set to less than `1`, then that fraction of LP will be paid instead (e.g. `1/2` to pay half, "Solemn Judgment").
+  - name: pay_until
+    type: [ bool ]
+    description: If set to `true`, the cost will become `Pay LP so that you only have "lp_value" left; ...` (e.g. "The Winged Dragon of Ra").
+    required: false
+    defaultValue: false
+returns:
+  - type: [ CostFunction ]
+    description: The cost function generated based on the given parameters.
+    guaranteed: true

api/functions/Auxiliary/SelfBanishCost.yml

@@ -0,0 +1,46 @@
+---!function
+name: SelfBanishCost
+namespace: aux
+description: A baseline [cost function](/api/types/EffectCost) used for effects that banish the activating card itself as cost, such as `You can banish this card (you control/from.../etc); ...` (e.g. "Destiny HERO - Malicious").
+summary: Cost function for effects that banish the card itself as cost.
+status:
+  index: stable
+aliases:
+  - name: aux.bfgcost
+    status:
+      index: deprecated
+  - name: aux.selfbanishcost
+    status:
+      index: deprecated
+parameters:
+  - name: e
+    type: [ Effect ]
+    description: The effect being activated.
+  - name: tp
+    type: [ int ]
+    description: The player activating the effect.
+  - name: eg
+    type: [ Group ]
+    description: A group of cards associated to the event that prompted the effect activation. The specifics of this group vary depending on the [event code](/api/enums/Event).
+  - name: ep
+    type: [ int ]
+    description: The player associated to the event that prompted the effect activation.
+  - name: ev
+    type: [ Group ]
+    description: A value associated to the event that prompted the effect activation. The specifics of this value vary depending on the event code.
+  - name: re
+    type: [ Effect ]
+    description: The effect that caused the event that prompted the effect activation.
+  - name: r
+    type: [ int ]
+    description: Composite [Reason](/api/enums/Reason) value of the event that prompted the effect activation.
+  - name: rp
+    type: [ int ]
+    description: The player that caused the event that prompted the effect activation.
+  - name: chk
+    type: [ int ]
+    description: Must be `0` when checking if the cost can be paid, and `1` when performing the cost.
+returns:
+  - type: [ bool ]
+    description: If `chk` is `0`, returns `true` if the cost can be paid.
+    guaranteed: false

api/functions/Auxiliary/selfbanishcost.yml → api/functions/Auxiliary/SelfDiscardCost.yml

@@ -1,14 +1,10 @@
 ---!function
-name: selfbanishcost
+name: SelfDiscardCost
 namespace: aux
-description: An [EffectCost](/api/types/EffectCost) function that checks if an effect's handler can banish itself as activation cost.
-summary: Cost function for effects that banish their handler as activation cost.
+description: A baseline [cost function](/api/types/EffectCost) used for effects that discard the activating card itself as cost, such as `You can discard this card; ...` (e.g. "Ash Blossom & Joyous Spring").
+summary: Cost function for effects that discard the card itself as cost.
 status:
   index: stable
-aliases:
-  - name: aux.bfgcost
-    status:
-      index: deprecated
 parameters:
   - name: e
     type: [ Effect ]

api/functions/Auxiliary/selfreleasecost.yml → api/functions/Auxiliary/SelfDiscardToGraveCost.yml

@@ -1,8 +1,8 @@
 ---!function
-name: selfreleasecost
+name: SelfDiscardToGraveCost
 namespace: aux
-description: An [EffectCost](/api/types/EffectCost) function that checks if an effect's handler can tribute itself as activation cost.
-summary: Cost function for effects that tribute their handler as activation cost.
+description: A baseline [cost function](/api/types/EffectCost) used for effects that discard the activating card itself to the GY as cost, such as `You can discard this card to the GY; ...` (e.g. "D.D. Crow").
+summary: Cost function for effects that discard the card itself to the GY as cost.
 status:
   index: stable
 parameters:

api/functions/Auxiliary/SelfToDeckCost.yml

@@ -0,0 +1,39 @@
+---!function
+name: SelfToDeckCost
+namespace: aux
+description: A baseline [cost function](/api/types/EffectCost) used for effects that shuffle the activating card itself to the Main Deck as cost, such as `You can shuffle this card (you control/from.../etc) into the Deck; ...` (e.g. "Rescue Ferret").
+summary: Cost function for effects that shuffle the card itself to the Deck as cost.
+status:
+  index: stable
+parameters:
+  - name: e
+    type: [ Effect ]
+    description: The effect being activated.
+  - name: tp
+    type: [ int ]
+    description: The player activating the effect.
+  - name: eg
+    type: [ Group ]
+    description: A group of cards associated to the event that prompted the effect activation. The specifics of this group vary depending on the [event code](/api/enums/Event).
+  - name: ep
+    type: [ int ]
+    description: The player associated to the event that prompted the effect activation.
+  - name: ev
+    type: [ Group ]
+    description: A value associated to the event that prompted the effect activation. The specifics of this value vary depending on the event code.
+  - name: re
+    type: [ Effect ]
+    description: The effect that caused the event that prompted the effect activation.
+  - name: r
+    type: [ int ]
+    description: Composite [Reason](/api/enums/Reason) value of the event that prompted the effect activation.
+  - name: rp
+    type: [ int ]
+    description: The player that caused the event that prompted the effect activation.
+  - name: chk
+    type: [ int ]
+    description: Must be `0` when checking if the cost can be paid, and `1` when performing the cost.
+returns:
+  - type: [ bool ]
+    description: If `chk` is `0`, returns `true` if the cost can be paid.
+    guaranteed: false

api/functions/Auxiliary/SelfToExtraCost.yml

@@ -0,0 +1,39 @@
+---!function
+name: SelfToExtraCost
+namespace: aux
+description: A baseline [cost function](/api/types/EffectCost) used for effects that return the activating card itself to the Extra Deck as cost, such as `You can return this card (you control/from.../etc) to the Extra Deck; ...` (e.g. "Gladiator Beast Gyzarus").
+summary: Cost function for effects that return the card itself to the Extra Deck as cost.
+status:
+  index: stable
+parameters:
+  - name: e
+    type: [ Effect ]
+    description: The effect being activated.
+  - name: tp
+    type: [ int ]
+    description: The player activating the effect.
+  - name: eg
+    type: [ Group ]
+    description: A group of cards associated to the event that prompted the effect activation. The specifics of this group vary depending on the [event code](/api/enums/Event).
+  - name: ep
+    type: [ int ]
+    description: The player associated to the event that prompted the effect activation.
+  - name: ev
+    type: [ Group ]
+    description: A value associated to the event that prompted the effect activation. The specifics of this value vary depending on the event code.
+  - name: re
+    type: [ Effect ]
+    description: The effect that caused the event that prompted the effect activation.
+  - name: r
+    type: [ int ]
+    description: Composite [Reason](/api/enums/Reason) value of the event that prompted the effect activation.
+  - name: rp
+    type: [ int ]
+    description: The player that caused the event that prompted the effect activation.
+  - name: chk
+    type: [ int ]
+    description: Must be `0` when checking if the cost can be paid, and `1` when performing the cost.
+returns:
+  - type: [ bool ]
+    description: If `chk` is `0`, returns `true` if the cost can be paid.
+    guaranteed: false

api/functions/Auxiliary/SelfToGraveCost.yml

@@ -0,0 +1,39 @@
+---!function
+name: SelfToGraveCost
+namespace: aux
+description: A baseline [cost function](/api/types/EffectCost) used for effects that send the activating card itself to the GY as cost, such as `You can send this card (you control/from.../etc) to the GY; ...` (e.g. "Rescue Cat").
+summary: Cost function for effects that send the card itself to the GY as cost.
+status:
+  index: stable
+parameters:
+  - name: e
+    type: [ Effect ]
+    description: The effect being activated.
+  - name: tp
+    type: [ int ]
+    description: The player activating the effect.
+  - name: eg
+    type: [ Group ]
+    description: A group of cards associated to the event that prompted the effect activation. The specifics of this group vary depending on the [event code](/api/enums/Event).
+  - name: ep
+    type: [ int ]
+    description: The player associated to the event that prompted the effect activation.
+  - name: ev
+    type: [ Group ]
+    description: A value associated to the event that prompted the effect activation. The specifics of this value vary depending on the event code.
+  - name: re
+    type: [ Effect ]
+    description: The effect that caused the event that prompted the effect activation.
+  - name: r
+    type: [ int ]
+    description: Composite [Reason](/api/enums/Reason) value of the event that prompted the effect activation.
+  - name: rp
+    type: [ int ]
+    description: The player that caused the event that prompted the effect activation.
+  - name: chk
+    type: [ int ]
+    description: Must be `0` when checking if the cost can be paid, and `1` when performing the cost.
+returns:
+  - type: [ bool ]
+    description: If `chk` is `0`, returns `true` if the cost can be paid.
+    guaranteed: false

api/functions/Auxiliary/SelfToHandCost.yml

@@ -0,0 +1,39 @@
+---!function
+name: SelfToHandCost
+namespace: aux
+description: A baseline [cost function](/api/types/EffectCost) used for effects that return the activating card itself to the hand as cost, such as `You can return this card (you control/from.../etc) to the/your hand; ...` (e.g. "Sauravis, the Ancient and Ascended").
+summary: Cost function for effects that return the card itself to the hand as cost.
+status:
+  index: stable
+parameters:
+  - name: e
+    type: [ Effect ]
+    description: The effect being activated.
+  - name: tp
+    type: [ int ]
+    description: The player activating the effect.
+  - name: eg
+    type: [ Group ]
+    description: A group of cards associated to the event that prompted the effect activation. The specifics of this group vary depending on the [event code](/api/enums/Event).
+  - name: ep
+    type: [ int ]
+    description: The player associated to the event that prompted the effect activation.
+  - name: ev
+    type: [ Group ]
+    description: A value associated to the event that prompted the effect activation. The specifics of this value vary depending on the event code.
+  - name: re
+    type: [ Effect ]
+    description: The effect that caused the event that prompted the effect activation.
+  - name: r
+    type: [ int ]
+    description: Composite [Reason](/api/enums/Reason) value of the event that prompted the effect activation.
+  - name: rp
+    type: [ int ]
+    description: The player that caused the event that prompted the effect activation.
+  - name: chk
+    type: [ int ]
+    description: Must be `0` when checking if the cost can be paid, and `1` when performing the cost.
+returns:
+  - type: [ bool ]
+    description: If `chk` is `0`, returns `true` if the cost can be paid.
+    guaranteed: false

api/functions/Auxiliary/SelfTributeCost.yml

@@ -0,0 +1,46 @@
+---!function
+name: SelfTributeCost
+namespace: aux
+description: A baseline [cost function](/api/types/EffectCost) used for effects that Tribute the activating card itself as cost, such as `You can Tribute this card (you control/from.../etc); ...` (e.g. "Kaibaman").
+summary: Cost function for effects that Tribute the card itself as cost.
+status:
+  index: stable
+aliases:
+  - name: aux.SelfReleaseCost
+    status:
+      index: stable
+  - name: aux.selfreleasecost
+    status:
+      index: deprecated
+parameters:
+  - name: e
+    type: [ Effect ]
+    description: The effect being activated.
+  - name: tp
+    type: [ int ]
+    description: The player activating the effect.
+  - name: eg
+    type: [ Group ]
+    description: A group of cards associated to the event that prompted the effect activation. The specifics of this group vary depending on the [event code](/api/enums/Event).
+  - name: ep
+    type: [ int ]
+    description: The player associated to the event that prompted the effect activation.
+  - name: ev
+    type: [ Group ]
+    description: A value associated to the event that prompted the effect activation. The specifics of this value vary depending on the event code.
+  - name: re
+    type: [ Effect ]
+    description: The effect that caused the event that prompted the effect activation.
+  - name: r
+    type: [ int ]
+    description: Composite [Reason](/api/enums/Reason) value of the event that prompted the effect activation.
+  - name: rp
+    type: [ int ]
+    description: The player that caused the event that prompted the effect activation.
+  - name: chk
+    type: [ int ]
+    description: Must be `0` when checking if the cost can be paid, and `1` when performing the cost.
+returns:
+  - type: [ bool ]
+    description: If `chk` is `0`, returns `true` if the cost can be paid.
+    guaranteed: false

api/functions/Card/IsFlipSummoned.yml

@@ -0,0 +1,16 @@
+---!function
+name: IsFlipSummoned
+namespace: Card
+description: >-
+  Checks if a card is currently [Flip Summoned](https://yugipedia.com/wiki/Flip_Summon).
+summary: Checks if a card is currently Flip Summoned.
+parameters:
+  - name: c
+    type: [ Card ]
+    description: The card to check.
+returns:
+  - type: [ bool ]
+    description: >-
+      `true` if the card is currently Flip Summoned, `false` otherwise.
+status: { index: stable }
+tags: [ card-check ]

api/functions/Card/IsFusionSummoned.yml

@@ -0,0 +1,16 @@
+---!function
+name: IsFusionSummoned
+namespace: Card
+description: >-
+  Checks if a card is currently [Fusion Summoned](https://yugipedia.com/wiki/Fusion_Summon).
+summary: Checks if a card is currently Fusion Summoned.
+parameters:
+  - name: c
+    type: [ Card ]
+    description: The card to check.
+returns:
+  - type: [ bool ]
+    description: >-
+      `true` if the card is currently Fusion Summoned, `false` otherwise.
+status: { index: stable }
+tags: [ card-check ]