From 363be99499c696d884a038cf6cd24c8b90385127 Mon Sep 17 00:00:00 2001 From: pyrQ <30827955+pyrQ@users.noreply.github.com> Date: Wed, 20 Nov 2024 02:34:25 +0200 Subject: [PATCH 01/12] Add files via upload --- api/functions/Auxiliary/SelfRevealCost.yml | 39 ++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 api/functions/Auxiliary/SelfRevealCost.yml diff --git a/api/functions/Auxiliary/SelfRevealCost.yml b/api/functions/Auxiliary/SelfRevealCost.yml new file mode 100644 index 00000000..574edffb --- /dev/null +++ b/api/functions/Auxiliary/SelfRevealCost.yml @@ -0,0 +1,39 @@ +---!function +name: SelfRevealCost +namespace: aux +description: A baseline [cost function](/api/types/EffectCost) used for effects that reveal the activating card itself as cost, such as `You can reveal this card in your hand; ...` (e.g. "Sakitama"). +summary: Cost function for effects that reveal the card itself 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 From 77204b1e872c3df802d9d920ec85afcb3d27f7e6 Mon Sep 17 00:00:00 2001 From: pyrQ <30827955+pyrQ@users.noreply.github.com> Date: Wed, 20 Nov 2024 12:26:04 +0200 Subject: [PATCH 02/12] Update "Duel.HintSelection" descriptions --- api/functions/Duel/HintSelection.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/api/functions/Duel/HintSelection.yml b/api/functions/Duel/HintSelection.yml index 5e2834d2..3c1d4a54 100644 --- a/api/functions/Duel/HintSelection.yml +++ b/api/functions/Duel/HintSelection.yml @@ -2,16 +2,16 @@ name: HintSelection namespace: Duel description: >- - If log_as_selection is true, that selection will be logged by the client as "card(s) selected" rather than "card(s) targeted" + Highlights a card(s) similar to targeting, that is typically on the field, in the GY, or that is banished. Also logs it in the in-client `Log` tab. Used for effects that select a card(s) without targeting it to indicate which card(s) was selected (e.g. "Fiendsmith Engraver", "Vision HERO Poisoner"). status: index: stable parameters: - - name: selection + - name: card_or_group type: [ Card, Group ] - description: (To be added) + description: The card(s) that are highlighted. - name: log_as_selection type: [ bool ] - description: (To be added) + description: If set to `false` the log in the client will say "targeted" (string 1610) instead of "selected" (string 1680). required: false - defaultValue: false -tags: [ under-construction ] + defaultValue: true +tags: [ ] From 2e1ba71a5aa88ba8fca1edfa54d22fcf23157cdb Mon Sep 17 00:00:00 2001 From: pyrQ <30827955+pyrQ@users.noreply.github.com> Date: Fri, 14 Feb 2025 21:57:30 +0200 Subject: [PATCH 03/12] Added page for "EVENT_BREAK_EFFECT" --- api/constants/Event/EVENT_BREAK_EFFECT.yml | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 api/constants/Event/EVENT_BREAK_EFFECT.yml diff --git a/api/constants/Event/EVENT_BREAK_EFFECT.yml b/api/constants/Event/EVENT_BREAK_EFFECT.yml new file mode 100644 index 00000000..5d5471c6 --- /dev/null +++ b/api/constants/Event/EVENT_BREAK_EFFECT.yml @@ -0,0 +1,9 @@ +---!constant +name: EVENT_BREAK_EFFECT +enum: Event +value: 1050 +description: >- + This event is raised when the [Duel.BreakEffect](https://projectignis.github.io/scrapi-book/api/functions/Duel/BreakEffect.html) function is executed. +status: + index: stable +tags: [ under-construction ] From 21abd46d0f8a3d9ee51e68f5554a686a8c5896df Mon Sep 17 00:00:00 2001 From: pyrQ <30827955+pyrQ@users.noreply.github.com> Date: Fri, 14 Feb 2025 22:07:58 +0200 Subject: [PATCH 04/12] Update SpecialSummonComplete.yml Returns int --- api/functions/Duel/SpecialSummonComplete.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/api/functions/Duel/SpecialSummonComplete.yml b/api/functions/Duel/SpecialSummonComplete.yml index 449e5a4c..c6fdffe6 100644 --- a/api/functions/Duel/SpecialSummonComplete.yml +++ b/api/functions/Duel/SpecialSummonComplete.yml @@ -2,7 +2,11 @@ name: SpecialSummonComplete namespace: Duel description: >- - Completes Special Summons conducted with Duel.SpecialSummonStep. This has to be called even if all the Duel.SpecialSummonStep fails. + Completes any Special Summons conducted with [Duel.SpecialSummonStep](https://projectignis.github.io/scrapi-book/api/functions/Duel/SpecialSummonStep.html). Can be called after using `Duel.SpecialSummonStep` regardless of its success. +returns: + - type: [ int ] + description: >- + The number of monsters that were successfully Special Summoned. status: index: stable tags: [ under-construction ] From 17a152b1226fc9a7325ae434cb5b4125fc865659 Mon Sep 17 00:00:00 2001 From: pyrQ <30827955+pyrQ@users.noreply.github.com> Date: Fri, 14 Feb 2025 22:16:14 +0200 Subject: [PATCH 05/12] Update IsReasonCard.yml The parameters are flipped --- api/functions/Card/IsReasonCard.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/api/functions/Card/IsReasonCard.yml b/api/functions/Card/IsReasonCard.yml index 89fb88be..509108f5 100644 --- a/api/functions/Card/IsReasonCard.yml +++ b/api/functions/Card/IsReasonCard.yml @@ -5,12 +5,12 @@ description: >- Returns `true` if a given card caused the [Event](/api/enums/Event) that happened to another card. summary: Checks if a card caused the event that happened to another card parameters: + - name: rc + type: [ Card ] + description: The card being checked to determine if it caused the event. - name: c type: [ Card ] description: The card to check the reason of. - - name: rc - type: [ int ] - description: The card being checked to determine if it caused the event. returns: - type: [ bool ] description: If `rc` caused the event that happened to `c`. From 01e1365799b0e81cd3aaf308291994e871673403 Mon Sep 17 00:00:00 2001 From: pyrQ <30827955+pyrQ@users.noreply.github.com> Date: Fri, 14 Feb 2025 22:31:35 +0200 Subject: [PATCH 06/12] Added pages for "RESETS_STANDARD_PHASE_END" and "RESETS_STANDARD_DISABLE_PHASE_END" --- .../Reset/RESETS_STANDARD_DISABLE_PHASE_END.yml | 9 +++++++++ api/constants/Reset/RESETS_STANDARD_PHASE_END.yml | 9 +++++++++ 2 files changed, 18 insertions(+) create mode 100644 api/constants/Reset/RESETS_STANDARD_DISABLE_PHASE_END.yml create mode 100644 api/constants/Reset/RESETS_STANDARD_PHASE_END.yml diff --git a/api/constants/Reset/RESETS_STANDARD_DISABLE_PHASE_END.yml b/api/constants/Reset/RESETS_STANDARD_DISABLE_PHASE_END.yml new file mode 100644 index 00000000..c52f490e --- /dev/null +++ b/api/constants/Reset/RESETS_STANDARD_DISABLE_PHASE_END.yml @@ -0,0 +1,9 @@ +---!constant +name: RESETS_STANDARD_DISABLE_PHASE_END +enum: Reset +value: 0x41ff1200 +description: >- + Complex reset. The sum of [RESETS_STANDARD_PHASE_END](https://projectignis.github.io/scrapi-book/api/constants/Reset/RESETS_STANDARD_PHASE_END.html) and [RESET_DISABLE](https://projectignis.github.io/scrapi-book/api/constants/Reset/RESET_DISABLE.html). +status: + index: stable +tags: [ under-construction ] diff --git a/api/constants/Reset/RESETS_STANDARD_PHASE_END.yml b/api/constants/Reset/RESETS_STANDARD_PHASE_END.yml new file mode 100644 index 00000000..da5ca88f --- /dev/null +++ b/api/constants/Reset/RESETS_STANDARD_PHASE_END.yml @@ -0,0 +1,9 @@ +---!constant +name: RESETS_STANDARD_PHASE_END +enum: Reset +value: 0x41fe1200 +description: >- + Complex reset. The sum of [RESET_EVENT](https://projectignis.github.io/scrapi-book/api/constants/Reset/RESET_EVENT.html), [RESETS_STANDARD](https://projectignis.github.io/scrapi-book/api/constants/Reset/RESETS_STANDARD.html), [RESET_PHASE](https://projectignis.github.io/scrapi-book/api/constants/Reset/RESET_PHASE.html), and [PHASE_END](https://projectignis.github.io/scrapi-book/api/constants/Reset/PHASE_END.html). +status: + index: stable +tags: [ under-construction ] From 05f6d5b26feebb2fbe54e1af63785d8ebfa37687 Mon Sep 17 00:00:00 2001 From: pyrQ <30827955+pyrQ@users.noreply.github.com> Date: Tue, 18 Feb 2025 20:06:16 +0200 Subject: [PATCH 07/12] Added page for "Card.GetMainCardType" --- api/functions/Card/GetMainCardType.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 api/functions/Card/GetMainCardType.yml diff --git a/api/functions/Card/GetMainCardType.yml b/api/functions/Card/GetMainCardType.yml new file mode 100644 index 00000000..f1d5fbae --- /dev/null +++ b/api/functions/Card/GetMainCardType.yml @@ -0,0 +1,15 @@ +---!function +name: GetMainCardType +namespace: Card +description: >- + Returns the main current type of a card ([TYPE_MONSTER](https://projectignis.github.io/scrapi-book/api/constants/CardType/TYPE_MONSTER.html), [TYPE_SPELL](https://projectignis.github.io/scrapi-book/api/constants/CardType/TYPE_SPELL.html), or [TYPE_TRAP](https://projectignis.github.io/scrapi-book/api/constants/CardType/TYPE_TRAP.html)). +status: + index: stable +parameters: + - name: c + type: [ Card ] + description: The card to get the main current type of. +returns: + - type: [ int ] + description: The main current type of the card. +tags: [ under-construction ] From ead4aae7a64c56e5a9887f56fa87aa2bf7be5436 Mon Sep 17 00:00:00 2001 From: pyrQ <30827955+pyrQ@users.noreply.github.com> Date: Tue, 18 Feb 2025 20:16:04 +0200 Subject: [PATCH 08/12] Added page for "aux.StatChangeDamageStepCondition" --- .../StatChangeDamageStepCondition.yml | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 api/functions/Auxiliary/StatChangeDamageStepCondition.yml diff --git a/api/functions/Auxiliary/StatChangeDamageStepCondition.yml b/api/functions/Auxiliary/StatChangeDamageStepCondition.yml new file mode 100644 index 00000000..34e2fbcd --- /dev/null +++ b/api/functions/Auxiliary/StatChangeDamageStepCondition.yml @@ -0,0 +1,35 @@ +---!function +name: StatChangeDamageStepCondition +namespace: aux +description: A baseline [condition function](/api/types/EffectCondition) used for effects that can be activated during the Damage Step because they change a monster's ATK/DEF, but only up until before damage calculation (e.g. "Rush Recklessly"). +summary: Condition function for effects that can be used during the Damage Step because they change a monster's ATK/DEF. +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. +returns: + - type: [ bool ] + description: `true` if it is currently not both the Damage Step and damage calculation has already occurred, `false` otherwise. From 5512a4986f3d096c9834e5b5eab8ac2b8785ec20 Mon Sep 17 00:00:00 2001 From: pyrQ <30827955+pyrQ@users.noreply.github.com> Date: Tue, 18 Feb 2025 20:20:11 +0200 Subject: [PATCH 09/12] Update StatChangeDamageStepCondition.yml Fix indentation --- api/functions/Auxiliary/StatChangeDamageStepCondition.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/api/functions/Auxiliary/StatChangeDamageStepCondition.yml b/api/functions/Auxiliary/StatChangeDamageStepCondition.yml index 34e2fbcd..f4821c9c 100644 --- a/api/functions/Auxiliary/StatChangeDamageStepCondition.yml +++ b/api/functions/Auxiliary/StatChangeDamageStepCondition.yml @@ -3,8 +3,6 @@ name: StatChangeDamageStepCondition namespace: aux description: A baseline [condition function](/api/types/EffectCondition) used for effects that can be activated during the Damage Step because they change a monster's ATK/DEF, but only up until before damage calculation (e.g. "Rush Recklessly"). summary: Condition function for effects that can be used during the Damage Step because they change a monster's ATK/DEF. -status: - index: stable parameters: - name: e type: [ Effect ] @@ -32,4 +30,7 @@ parameters: description: The player that caused the event that prompted the effect activation. returns: - type: [ bool ] - description: `true` if it is currently not both the Damage Step and damage calculation has already occurred, `false` otherwise. + description: >- + `true` if it is currently not both the Damage Step and damage calculation has already occurred, `false` otherwise. +status: + index: stable From 31d1be17581353cb92a64aa4c86a6203ca82281e Mon Sep 17 00:00:00 2001 From: pyrQ <30827955+pyrQ@users.noreply.github.com> Date: Tue, 18 Feb 2025 20:22:54 +0200 Subject: [PATCH 10/12] Update StatChangeDamageStepCondition.yml Shorten summary --- api/functions/Auxiliary/StatChangeDamageStepCondition.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api/functions/Auxiliary/StatChangeDamageStepCondition.yml b/api/functions/Auxiliary/StatChangeDamageStepCondition.yml index f4821c9c..8d872c32 100644 --- a/api/functions/Auxiliary/StatChangeDamageStepCondition.yml +++ b/api/functions/Auxiliary/StatChangeDamageStepCondition.yml @@ -1,8 +1,8 @@ ---!function name: StatChangeDamageStepCondition namespace: aux -description: A baseline [condition function](/api/types/EffectCondition) used for effects that can be activated during the Damage Step because they change a monster's ATK/DEF, but only up until before damage calculation (e.g. "Rush Recklessly"). -summary: Condition function for effects that can be used during the Damage Step because they change a monster's ATK/DEF. +description: A baseline [condition function](/api/types/EffectCondition) used for [fast effects](https://yugipedia.com/wiki/Fast_effect) that can be activated during the Damage Step because they change a monster's ATK/DEF, but only up until before damage calculation (e.g. "Rush Recklessly"). +summary: Condition function for fast effects that change a monster's ATK/DEF. parameters: - name: e type: [ Effect ] From ada72978ccf16dca19b8755270e648bb54fbbd4d Mon Sep 17 00:00:00 2001 From: pyrQ <30827955+pyrQ@users.noreply.github.com> Date: Tue, 18 Feb 2025 20:46:23 +0200 Subject: [PATCH 11/12] Update RegisterClientHint.yml Change "reg.player" to "reg_player" to make it easier to edit after copying it + general page update. --- .../Auxiliary/RegisterClientHint.yml | 22 ++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/api/functions/Auxiliary/RegisterClientHint.yml b/api/functions/Auxiliary/RegisterClientHint.yml index 5b721de3..58547c6f 100644 --- a/api/functions/Auxiliary/RegisterClientHint.yml +++ b/api/functions/Auxiliary/RegisterClientHint.yml @@ -2,32 +2,34 @@ name: RegisterClientHint namespace: aux description: >- - Auxiliary function to simplify registering EFFECT_FLAG_CLIENT_HINT to players. (Card c) is card that creates the HintMessage, (int property_code) are additional properties like EFFECT_FLAG_OATH (PLAYER_TARGET and CLIENT_HINT are the flags registered by default). (int reg. player) is the player that is registering the hint, to himself (int s) and/or the opponent (int o), with a description called from a string defined in (str). Additional resets, other than the default RESET_PHASE+PHASE_END, can be passed in (int reset_code) and its reset count (int ct). + Registers an effect that applies a hint on a player(s) which is visible when you hover over a player's info box at the top of the client. Typically used for effects that are scripted to affect monsters but will also apply to any appropriate monster that is placed in the relevant location at a later point (e.g. "Exosister Gibrine"). status: index: stable parameters: - name: c type: [ Card ] - description: (To be added) + description: The card that is registering the effect that applies the hint. - name: property_code type: [ int ] - description: (To be added) - - name: reg.player + description: Additional properties to set to the effect. Defaults to `EFFECT_FLAG_PLAYER_TARGET|EFFECT_FLAG_CLIENT_HINT`. + - name: reg_player type: [ int ] - description: (To be added) + description: The player registering the effect. - name: s type: [ int ] - description: (To be added) + description: The first player to apply the effect to. Set it to `1` to apply the effect to the registering player, set it to `0` otherwise. - name: o type: [ int ] - description: (To be added) + description: The second player to apply the effect to. Set it to `1` to apply the effect to the opponent of the registering player, set it to `0` otherwise. - name: str type: [ any ] - description: (To be added) + description: The string to display on the hint. - name: reset_code type: [ int ] - description: (To be added) + description: Additional resets to set to the effect. Defaults to `RESET_PHASE|PHASE_END`. + required: false - name: ct type: [ int ] - description: (To be added) + description: Different reset count to set to the effect. Defaults to `1`. + required: false tags: [ under-construction ] From e2391d51bbdbacf08ad8709a54c72b2d4dcbc890 Mon Sep 17 00:00:00 2001 From: Hatter <47074795+that-hatter@users.noreply.github.com> Date: Sun, 23 Feb 2025 00:21:02 +0800 Subject: [PATCH 12/12] some edits --- api/constants/Event/EVENT_BREAK_EFFECT.yml | 4 ++-- .../Reset/RESETS_STANDARD_DISABLE_PHASE_END.yml | 5 +++-- .../Reset/RESETS_STANDARD_PHASE_END.yml | 3 ++- api/functions/Auxiliary/RegisterClientHint.yml | 17 ++++++++++------- api/functions/Card/GetMainCardType.yml | 3 +-- api/functions/Card/IsReasonCard.yml | 2 +- api/functions/Duel/HintSelection.yml | 3 +-- api/functions/Duel/SpecialSummonComplete.yml | 6 ++---- 8 files changed, 22 insertions(+), 21 deletions(-) diff --git a/api/constants/Event/EVENT_BREAK_EFFECT.yml b/api/constants/Event/EVENT_BREAK_EFFECT.yml index 5d5471c6..b5718e49 100644 --- a/api/constants/Event/EVENT_BREAK_EFFECT.yml +++ b/api/constants/Event/EVENT_BREAK_EFFECT.yml @@ -3,7 +3,7 @@ name: EVENT_BREAK_EFFECT enum: Event value: 1050 description: >- - This event is raised when the [Duel.BreakEffect](https://projectignis.github.io/scrapi-book/api/functions/Duel/BreakEffect.html) function is executed. + This event is raised when the [`Duel.BreakEffect`](/api/functions/Duel/BreakEffect) function is executed. +summary: An event raised when Duel.BreakEffect is executed. status: index: stable -tags: [ under-construction ] diff --git a/api/constants/Reset/RESETS_STANDARD_DISABLE_PHASE_END.yml b/api/constants/Reset/RESETS_STANDARD_DISABLE_PHASE_END.yml index c52f490e..ed047db5 100644 --- a/api/constants/Reset/RESETS_STANDARD_DISABLE_PHASE_END.yml +++ b/api/constants/Reset/RESETS_STANDARD_DISABLE_PHASE_END.yml @@ -3,7 +3,8 @@ name: RESETS_STANDARD_DISABLE_PHASE_END enum: Reset value: 0x41ff1200 description: >- - Complex reset. The sum of [RESETS_STANDARD_PHASE_END](https://projectignis.github.io/scrapi-book/api/constants/Reset/RESETS_STANDARD_PHASE_END.html) and [RESET_DISABLE](https://projectignis.github.io/scrapi-book/api/constants/Reset/RESET_DISABLE.html). + Composite reset value. The sum of [`RESETS_STANDARD_PHASE_END`](/api/constants/Reset/RESETS_STANDARD_PHASE_END) and [`RESET_DISABLE`](/api/constants/Reset/RESET_DISABLE). +summary: The sum of RESETS_STANDARD_PHASE_END and RESET_DISABLE. status: index: stable -tags: [ under-construction ] +tags: [ composite-bits ] diff --git a/api/constants/Reset/RESETS_STANDARD_PHASE_END.yml b/api/constants/Reset/RESETS_STANDARD_PHASE_END.yml index da5ca88f..1ed9f0a0 100644 --- a/api/constants/Reset/RESETS_STANDARD_PHASE_END.yml +++ b/api/constants/Reset/RESETS_STANDARD_PHASE_END.yml @@ -3,7 +3,8 @@ name: RESETS_STANDARD_PHASE_END enum: Reset value: 0x41fe1200 description: >- - Complex reset. The sum of [RESET_EVENT](https://projectignis.github.io/scrapi-book/api/constants/Reset/RESET_EVENT.html), [RESETS_STANDARD](https://projectignis.github.io/scrapi-book/api/constants/Reset/RESETS_STANDARD.html), [RESET_PHASE](https://projectignis.github.io/scrapi-book/api/constants/Reset/RESET_PHASE.html), and [PHASE_END](https://projectignis.github.io/scrapi-book/api/constants/Reset/PHASE_END.html). + Composite reset value. The sum of [`RESET_EVENT`](/api/constants/Reset/RESET_EVENT), [`RESETS_STANDARD`](/api/constants/Reset/RESETS_STANDARD), [`RESET_PHASE`](api/constants/Reset/RESET_PHASE), and [`PHASE_END`](/api/constants/Reset/PHASE_END). +summary: The sum of RESET_EVENT, RESETS_STANDARD, RESET_PHASE, and RESET_DISABLE. status: index: stable tags: [ under-construction ] diff --git a/api/functions/Auxiliary/RegisterClientHint.yml b/api/functions/Auxiliary/RegisterClientHint.yml index 58547c6f..53369489 100644 --- a/api/functions/Auxiliary/RegisterClientHint.yml +++ b/api/functions/Auxiliary/RegisterClientHint.yml @@ -3,6 +3,7 @@ name: RegisterClientHint namespace: aux description: >- Registers an effect that applies a hint on a player(s) which is visible when you hover over a player's info box at the top of the client. Typically used for effects that are scripted to affect monsters but will also apply to any appropriate monster that is placed in the relevant location at a later point (e.g. "Exosister Gibrine"). +summary: Registers an effect that displays a hint on players' info box. status: index: stable parameters: @@ -10,8 +11,8 @@ parameters: type: [ Card ] description: The card that is registering the effect that applies the hint. - name: property_code - type: [ int ] - description: Additional properties to set to the effect. Defaults to `EFFECT_FLAG_PLAYER_TARGET|EFFECT_FLAG_CLIENT_HINT`. + type: [ int, nil ] + description: Composite [EffectProperty](/api/enums/EffectProperty) to set to the effect in addition to `EFFECT_FLAG_PLAYER_TARGET|EFFECT_FLAG_CLIENT_HINT`. - name: reg_player type: [ int ] description: The player registering the effect. @@ -22,14 +23,16 @@ parameters: type: [ int ] description: The second player to apply the effect to. Set it to `1` to apply the effect to the opponent of the registering player, set it to `0` otherwise. - name: str - type: [ any ] - description: The string to display on the hint. + type: [ int ] + description: The id of the string to display on the hint. - name: reset_code type: [ int ] - description: Additional resets to set to the effect. Defaults to `RESET_PHASE|PHASE_END`. + description: Additional resets to set to the effect. required: false + defaultValue: RESET_PHASE|PHASE_END - name: ct type: [ int ] - description: Different reset count to set to the effect. Defaults to `1`. + description: Different reset count to set to the effect. required: false -tags: [ under-construction ] + defaultValue: 1 +tags: [ registers-effect ] diff --git a/api/functions/Card/GetMainCardType.yml b/api/functions/Card/GetMainCardType.yml index f1d5fbae..c8bbc755 100644 --- a/api/functions/Card/GetMainCardType.yml +++ b/api/functions/Card/GetMainCardType.yml @@ -2,7 +2,7 @@ name: GetMainCardType namespace: Card description: >- - Returns the main current type of a card ([TYPE_MONSTER](https://projectignis.github.io/scrapi-book/api/constants/CardType/TYPE_MONSTER.html), [TYPE_SPELL](https://projectignis.github.io/scrapi-book/api/constants/CardType/TYPE_SPELL.html), or [TYPE_TRAP](https://projectignis.github.io/scrapi-book/api/constants/CardType/TYPE_TRAP.html)). + Returns the current main type of a card ([`TYPE_MONSTER`](api/constants/CardType/TYPE_MONSTER), [`TYPE_SPELL`]/api/constants/CardType/TYPE_SPELL), or [`TYPE_TRAP`](/api/constants/CardType/TYPE_TRAP)). status: index: stable parameters: @@ -12,4 +12,3 @@ parameters: returns: - type: [ int ] description: The main current type of the card. -tags: [ under-construction ] diff --git a/api/functions/Card/IsReasonCard.yml b/api/functions/Card/IsReasonCard.yml index 509108f5..83e358df 100644 --- a/api/functions/Card/IsReasonCard.yml +++ b/api/functions/Card/IsReasonCard.yml @@ -3,7 +3,7 @@ name: IsReasonCard namespace: Card description: >- Returns `true` if a given card caused the [Event](/api/enums/Event) that happened to another card. -summary: Checks if a card caused the event that happened to another card +summary: Checks if a card caused the event that happened to another card. parameters: - name: rc type: [ Card ] diff --git a/api/functions/Duel/HintSelection.yml b/api/functions/Duel/HintSelection.yml index 3c1d4a54..7a87a82f 100644 --- a/api/functions/Duel/HintSelection.yml +++ b/api/functions/Duel/HintSelection.yml @@ -8,10 +8,9 @@ status: parameters: - name: card_or_group type: [ Card, Group ] - description: The card(s) that are highlighted. + description: The card(s) to highlight. - name: log_as_selection type: [ bool ] description: If set to `false` the log in the client will say "targeted" (string 1610) instead of "selected" (string 1680). required: false defaultValue: true -tags: [ ] diff --git a/api/functions/Duel/SpecialSummonComplete.yml b/api/functions/Duel/SpecialSummonComplete.yml index c6fdffe6..21f0fa99 100644 --- a/api/functions/Duel/SpecialSummonComplete.yml +++ b/api/functions/Duel/SpecialSummonComplete.yml @@ -2,11 +2,9 @@ name: SpecialSummonComplete namespace: Duel description: >- - Completes any Special Summons conducted with [Duel.SpecialSummonStep](https://projectignis.github.io/scrapi-book/api/functions/Duel/SpecialSummonStep.html). Can be called after using `Duel.SpecialSummonStep` regardless of its success. + Completes any Special Summons conducted with [Duel.SpecialSummonStep](/api/functions/Duel/SpecialSummonStep). Can be called after using `Duel.SpecialSummonStep` regardless of its success. returns: - type: [ int ] - description: >- - The number of monsters that were successfully Special Summoned. + description: The number of monsters that were successfully Special Summoned. status: index: stable -tags: [ under-construction ]