diff --git a/api/functions/Duel/IsBattlePhase.yml b/api/functions/Duel/IsBattlePhase.yml index c4eb446c..3d5ba78b 100644 --- a/api/functions/Duel/IsBattlePhase.yml +++ b/api/functions/Duel/IsBattlePhase.yml @@ -1,11 +1,17 @@ ---!function name: IsBattlePhase namespace: Duel -description: >- - Returns if the current phase is the Battle Phase (between PHASE_BATTLE_START and PHASE_BATTLE) +description: &desc >- + Checks if it is currently the Battle Phase. +summary: *desc status: index: stable +parameters: + - name: player + type: [ int ] + description: If provided, the function will also check if it is currently that player's turn. + required: false returns: - type: [ bool ] - description: (To be added) -tags: [ under-construction ] + description: >- + `true` if it is currently the Battle Phase, `false` otherwise. diff --git a/api/functions/Duel/IsBattleStep.yml b/api/functions/Duel/IsBattleStep.yml new file mode 100644 index 00000000..aa6d7475 --- /dev/null +++ b/api/functions/Duel/IsBattleStep.yml @@ -0,0 +1,16 @@ +---!function +name: IsBattleStep +namespace: Duel +description: &desc Checks if it is currently the Battle Step. +summary: *desc +status: + index: stable +parameters: + - name: player + type: [ int ] + description: If provided, the function will also check if it is currently that player's turn. + required: false +returns: + - type: [ bool ] + description: >- + `true` if it is currently the Battle Step, `false` otherwise. diff --git a/api/functions/Duel/IsDamageCalculation.yml b/api/functions/Duel/IsDamageCalculation.yml new file mode 100644 index 00000000..e46c4b90 --- /dev/null +++ b/api/functions/Duel/IsDamageCalculation.yml @@ -0,0 +1,17 @@ +---!function +name: IsDamageCalculation +namespace: Duel +description: &desc >- + Checks if it is currently during Damage Calculation. +summary: *desc +status: + index: stable +parameters: + - name: player + type: [ int ] + description: If provided, the function will also check if it is currently that player's turn. + required: false +returns: + - type: [ bool ] + description: >- + `true` if it is currently during Damage Calculation, `false` otherwise. diff --git a/api/functions/Duel/IsDamageStep.yml b/api/functions/Duel/IsDamageStep.yml new file mode 100644 index 00000000..484fa33e --- /dev/null +++ b/api/functions/Duel/IsDamageStep.yml @@ -0,0 +1,17 @@ +---!function +name: IsDamageStep +namespace: Duel +description: &desc >- + Checks if it is currently the Damage Step. +summary: *desc +status: + index: stable +parameters: + - name: player + type: [ int ] + description: If provided, the function will also check if it is currently that player's turn. + required: false +returns: + - type: [ bool ] + description: >- + `true` if it is currently the Damage Step, `false` otherwise. diff --git a/api/functions/Duel/IsDrawPhase.yml b/api/functions/Duel/IsDrawPhase.yml new file mode 100644 index 00000000..531b4091 --- /dev/null +++ b/api/functions/Duel/IsDrawPhase.yml @@ -0,0 +1,17 @@ +---!function +name: IsDrawPhase +namespace: Duel +description: &desc >- + Checks if it is currently the Draw Phase. +summary: *desc +status: + index: stable +parameters: + - name: player + type: [ int ] + description: If provided, the function will also check if it is currently that player's turn. + required: false +returns: + - type: [ bool ] + description: >- + `true` if it is currently the Draw Phase, `false` otherwise. diff --git a/api/functions/Duel/IsEndOfBattlePhase.yml b/api/functions/Duel/IsEndOfBattlePhase.yml new file mode 100644 index 00000000..8a240d3d --- /dev/null +++ b/api/functions/Duel/IsEndOfBattlePhase.yml @@ -0,0 +1,21 @@ +---!function +name: IsEndOfBattlePhase +namespace: Duel +description: &desc >- + Checks if it is currently the end of the Battle Phase (End Step). +summary: *desc +status: + index: stable +aliases: + - name: Duel.IsEndStep + status: + index: stable +parameters: + - name: player + type: [ int ] + description: If provided, the function will also check if it is currently that player's turn. + required: false +returns: + - type: [ bool ] + description: >- + `true` if it is currently the end of the Battle Phase (End Step), `false` otherwise. diff --git a/api/functions/Duel/IsEndPhase.yml b/api/functions/Duel/IsEndPhase.yml new file mode 100644 index 00000000..13650a48 --- /dev/null +++ b/api/functions/Duel/IsEndPhase.yml @@ -0,0 +1,17 @@ +---!function +name: IsEndPhase +namespace: Duel +description: &desc >- + Checks if it is currently the End Phase. +summary: *desc +status: + index: stable +parameters: + - name: player + type: [ int ] + description: If `player` is provided it will also check that it is currently that player's turn. + required: false +returns: + - type: [ bool ] + description: >- + `true` if it is currently the End Phase, `false` otherwise. diff --git a/api/functions/Duel/IsMainPhase.yml b/api/functions/Duel/IsMainPhase.yml index 4e7e59dc..833c4d6b 100644 --- a/api/functions/Duel/IsMainPhase.yml +++ b/api/functions/Duel/IsMainPhase.yml @@ -1,11 +1,17 @@ ---!function name: IsMainPhase namespace: Duel -description: >- - Returns if the current phase is either Main Phase 1 or Main Phase 2. +description: &desc >- + Checks if it is currently the Main Phase. +summary: *desc status: index: stable +parameters: + - name: player + type: [ int ] + description: If `player` is provided it will also check that it is currently that player's turn. + required: false returns: - type: [ bool ] - description: (To be added) -tags: [ under-construction ] + description: >- + `true` if it is currently the Main Phase, `false` otherwise. diff --git a/api/functions/Duel/IsMainPhase1.yml b/api/functions/Duel/IsMainPhase1.yml new file mode 100644 index 00000000..0bad92bb --- /dev/null +++ b/api/functions/Duel/IsMainPhase1.yml @@ -0,0 +1,17 @@ +---!function +name: IsMainPhase1 +namespace: Duel +description: &desc >- + Checks if it is currently the Main Phase 1. +summary: *desc +status: + index: stable +parameters: + - name: player + type: [ int ] + description: If `player` is provided it will also check that it is currently that player's turn. + required: false +returns: + - type: [ bool ] + description: >- + `true` if it is currently the Main Phase 1, `false` otherwise. diff --git a/api/functions/Duel/IsMainPhase2.yml b/api/functions/Duel/IsMainPhase2.yml new file mode 100644 index 00000000..6a198369 --- /dev/null +++ b/api/functions/Duel/IsMainPhase2.yml @@ -0,0 +1,17 @@ +---!function +name: IsMainPhase2 +namespace: Duel +description: &desc >- + Checks if it is currently the Main Phase 2. +summary: *desc +status: + index: stable +parameters: + - name: player + type: [ int ] + description: If `player` is provided it will also check that it is currently that player's turn. + required: false +returns: + - type: [ bool ] + description: >- + `true` if it is currently the Main Phase 2, `false` otherwise. diff --git a/api/functions/Duel/IsStandbyPhase.yml b/api/functions/Duel/IsStandbyPhase.yml new file mode 100644 index 00000000..6f0a0f26 --- /dev/null +++ b/api/functions/Duel/IsStandbyPhase.yml @@ -0,0 +1,17 @@ +---!function +name: IsStandbyPhase +namespace: Duel +description: &desc >- + Checks if it is currently the Standby Phase. +summary: *desc +status: + index: stable +parameters: + - name: player + type: [ int ] + description: If `player` is provided it will also check that it is currently that player's turn. + required: false +returns: + - type: [ bool ] + description: >- + `true` if it is currently the Standby Phase, `false` otherwise. diff --git a/api/functions/Duel/IsStartOfBattlePhase.yml b/api/functions/Duel/IsStartOfBattlePhase.yml new file mode 100644 index 00000000..216aafbd --- /dev/null +++ b/api/functions/Duel/IsStartOfBattlePhase.yml @@ -0,0 +1,21 @@ +---!function +name: IsStartOfBattlePhase +namespace: Duel +description: &desc >- + Checks if it is currently the start of the Battle Phase (Start Step). +summary: *desc +status: + index: stable +aliases: + - name: Duel.IsStartStep + status: + index: stable +parameters: + - name: player + type: [ int ] + description: If `player` is provided it will also check that it is currently that player's turn. + required: false +returns: + - type: [ bool ] + description: >- + `true` if it is currently the start of the Battle Phase (Start Step), `false` otherwise. diff --git a/api/functions/Duel/ProcedureSummon.yml b/api/functions/Duel/ProcedureSummon.yml index 6b926b4a..4c18da51 100644 --- a/api/functions/Duel/ProcedureSummon.yml +++ b/api/functions/Duel/ProcedureSummon.yml @@ -2,35 +2,35 @@ name: ProcedureSummon namespace: Duel description: >- - A player (int player) "Procedure Summons" (the SummonType performed is determined by the corresponding parameter) a card (Card c) using "must_use" as part of its materials, choosing among "mg", with "min" and "max" materials to be used for the Summon. + Summons a monster such that it is considered to have been [properly Summoned](https://yugipedia.com/wiki/Special_Summon_Monster#Properly_Special_Summoned). +summary: Summons a monster such that it is considered to have been properly Summoned. status: index: stable parameters: - name: player type: [ int ] - description: (To be added) - - name: sumtype - type: [ int ] - description: (To be added) + description: The player performing the Summon. - name: c type: [ Card ] - description: (To be added) + description: The monster to Summon. + - name: sumtype + type: [ int ] + description: The [type of the Summon](/api/enums/SummonType). - name: must_use type: [ Group, Card, nil ] - description: (To be added) + description: A card(s) that must be used as material for the Summon. required: false - name: mg type: [ Group, Card, nil ] - description: (To be added) + description: A card(s) that the player can choose to use as material for the Summon. required: false - name: minc type: [ int ] - description: (To be added) + description: The minimum amount of materials that can be used for the Summon. required: false defaultValue: 0 - name: maxc type: [ int ] - description: (To be added) + description: The maximum amount of materials that can be used for the Summon. required: false - defaultValue: 0 -tags: [ under-construction ] + defaultValue: 0 \ No newline at end of file