Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions api/functions/Card/AddCannotBeFlipSummoned.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---!function
name: AddCannotBeFlipSummoned
namespace: Card
description: >-
Creates and registers an [Effect](/api/types/Effect) to a monster card
that applies a "Cannot be Flip Summoned" Summoning condition to it
summary: Adds a "Cannot be Flip Summoned" Summoning condition to a monster
parameters:
- name: c
type: [ Card ]
description: The monster to register the effect to.
returns:
- type: [ Effect ]
description: The registered effect.
status:
index: stable
tags: [ registers-effect ]
17 changes: 17 additions & 0 deletions api/functions/Card/AddCannotBeNormalSummoned.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---!function
name: AddCannotBeNormalSummoned
namespace: Card
description: >-
Creates and registers an [Effect](/api/types/Effect) to a monster card
that applies a "Cannot be Normal Summoned" Summoning condition to it
summary: Adds a "Cannot be Normal Summoned" Summoning condition to a monster
parameters:
- name: c
type: [ Card ]
description: The monster to register the effect to.
returns:
- type: [ Effect ]
description: The registered effect.
status:
index: stable
tags: [ registers-effect ]
60 changes: 40 additions & 20 deletions api/functions/Card/IsAttributeExcept.yml
Original file line number Diff line number Diff line change
@@ -1,30 +1,50 @@
---!function
name: IsAttributeExcept
namespace: Card
description: >-
Checks if (Card c) has any attribute other than (int att). If the optional parameters are passed, does the checks by calling the equivalent behavior with such parameters with Card.GetAttribute
description: Checks if a card currently has any attribute other than a specified attribute(s).
summary: Checks if a card currently has any attribute other than a specified attribute(s)
status:
index: stable
aliases:
- name: Card.IsDifferentAttribute
status:
index: deleted
parameters:
- name: c
- &c
name: c
type: [ Card ]
description: (To be added)
- name: att
description: The monster to check the attribute(s) of.
- &attr
name: attr
type: [ int ]
description: (To be added)
- name: scard
type: [ Card ]
description: (To be added)
required: false
- name: sumtype
type: [ int ]
description: (To be added)
required: false
- name: playerid
type: [ int ]
description: (To be added)
required: false
description: >-
Composite [MonsterAttribute](/api/enums/MonsterAttribute) value to check.
`c` needs to have any attribute other than this value.
returns:
- type: [ bool ]
description: (To be added)
tags: [ under-construction ]
description: >-
`true` if `c` has any attribute other than `attr`, `false` otherwise.
overloads:
- description: Checks if a card would be treated as any attribute other than a specified attribute(s) if it would be used as material to Summon a monster.
parameters:
- *c
- *attr
- name: scard
type: [ Card ]
description: The monster that would be Summoned using `c` as material.
- name: sumtype
type: [ int ]
description: The [type of Summon](/api/enums/SummonType).
- name: playerid
type: [ int ]
description: The player that would perform the Summon.
returns:
- type: [ bool ]
description: >-
`true` if `c` would be treated as any attribute other than `attr` when used as material for the Summon of `scard`, `false` otherwise.
suggestedLinks:
- name: Card.IsAttribute
link: /api/functions/Card/IsAttribute
- name: Card.GetAttribute
link: /api/functions/Card/GetAttribute
tags: [ card-check, attribute-related ]
18 changes: 0 additions & 18 deletions api/functions/Card/IsDifferentAttribute.yml

This file was deleted.

18 changes: 0 additions & 18 deletions api/functions/Card/IsDifferentRace.yml

This file was deleted.

17 changes: 17 additions & 0 deletions api/functions/Card/IsEffectMonster.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---!function
name: IsEffectMonster
namespace: Card
description: >-
Checks if a card is currently an [Effect Monster](https://yugipedia.com/wiki/Effect_Monster).
summary: Checks if a card is currently an Effect Monster.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: >-
`true` if the card is currently an Effect Monster, `false` otherwise.
status:
index: stable
tags: [ card-check, card-type-related ]
17 changes: 17 additions & 0 deletions api/functions/Card/IsFusionMonster.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---!function
name: IsFusionMonster
namespace: Card
description: >-
Checks if a card is currently a [Fusion Monster](https://yugipedia.com/wiki/Fusion_Monster).
summary: Checks if a card is currently a Fusion Monster.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: >-
`true` if the card is currently a Fusion Monster, `false` otherwise.
status:
index: stable
tags: [ card-check, card-type-related ]
17 changes: 17 additions & 0 deletions api/functions/Card/IsPendulumMonster.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---!function
name: IsPendulumMonster
namespace: Card
description: >-
Checks if a card is currently a [Pendulum Monster](https://yugipedia.com/wiki/Pendulum_Monster).
summary: Checks if a card is currently a Pendulum Monster.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: >-
`true` if the card is currently a Pendulum Monster, `false` otherwise.
status:
index: stable
tags: [ card-check, card-type-related ]
50 changes: 50 additions & 0 deletions api/functions/Card/IsRaceExcept.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---!function
name: IsRaceExcept
namespace: Card
description: &desc Checks if a card currently has any race other than a specified race(s).
summary: *desc
status:
index: stable
aliases:
- name: Card.IsDifferentRace
status:
index: deleted
parameters:
- &c
name: c
type: [ Card ]
description: The monster to check the race(s) of.
- &race
name: race
type: [ int ]
description: >-
Composite [MonsterRace](/api/enums/MonsterRace) value to check.
`c` needs to have any race other than this value.
returns:
- type: [ bool ]
description: >-
`true` if `c` has any race other than the specified `race`, `false` otherwise.
overloads:
- description: Checks if a card would be treated as any race other than a specified race(s) if it would be used as material to Summon a monster.
parameters:
- *c
- *race
- name: scard
type: [ Card ]
description: The monster that would be Summoned using `c` as material.
- name: sumtype
type: [ int ]
description: The [type of Summon](/api/enums/SummonType).
- name: playerid
type: [ int ]
description: The player that would perform the Summon.
returns:
- type: [ bool ]
description: >-
`true` if `c` would be treated as any race other than the specified `race` when used as material for the Summon of `scard`, `false` otherwise.
suggestedLinks:
- name: Card.IsRace
link: /api/functions/Card/IsRace
- name: Card.GetRace
link: /api/functions/Card/GetRace
tags: [ card-check, race-related ]
17 changes: 17 additions & 0 deletions api/functions/Card/IsSynchroMonster.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---!function
name: IsSynchroMonster
namespace: Card
description: >-
Checks if a card is currently a [Synchro Monster](https://yugipedia.com/wiki/Synchro_Monster).
summary: Checks if a card is currently a Synchro Monster.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: >-
`true` if the card is currently a Synchro Monster, `false` otherwise.
status:
index: stable
tags: [ card-check, card-type-related ]
17 changes: 17 additions & 0 deletions api/functions/Card/IsXyzMonster.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---!function
name: IsXyzMonster
namespace: Card
description: >-
Checks if a card is currently an [Xyz Monster](https://yugipedia.com/wiki/Xyz_Monster).
summary: Checks if a card is currently an Xyz Monster.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: >-
`true` if the card is currently an Xyz Monster, `false` otherwise.
status:
index: stable
tags: [ card-check, card-type-related ]
20 changes: 12 additions & 8 deletions api/functions/Card/RemoveCounter.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
---!function
name: RemoveCounter
namespace: Card
description: >-
Removes a number (int count) of the specified counter (int countertype) from a card (Card c), with reason described by (int reason)
description: &desc Removes any amount of a specified counter from a card.
summary: *desc
status:
index: stable
parameters:
- name: c
type: [ Card ]
description: (To be added)
description: The card to remove counters from.
- name: player
type: [ int ]
description: (To be added)
description: The player removing the counters.
- name: countertype
type: [ int ]
description: (To be added)
description: The type of counter to remove.
- name: count
type: [ int ]
description: (To be added)
description: The amount of counters to remove.
- name: reason
type: [ int ]
description: (To be added)
tags: [ under-construction ]
description: Composite [Reason](/api/enums/Reason) value describing why the counters are being removed.
returns:
- type: [ bool ]
description: >-
`true` if at least 1 counter was successfully removed, `false` otherwise.
tags: [ counters-related ]
24 changes: 16 additions & 8 deletions api/functions/Card/UpdateAttack.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,34 @@
---!function
name: UpdateAttack
namespace: Card
description: >-
Applies an ATK change to card c, equal to int amount. If the reset values (int reset) are not provided, the default is RESET_EVENT (+RESETS_STANDARD_DISABLE , if rc == c, or just +RESETS_STANDARD). If the reason card rc is not provided, uses as default card c. Returns the amount of ATK successfully changed.
description: Increases the ATK of a card by a specified value (or decreases it if the value is negative).
summary: Increases (or decreases) the ATK of a card.
status:
index: stable
parameters:
- name: c
type: [ Card ]
description: (To be added)
description: The card to update the ATK of.
- name: amount
type: [ int ]
description: (To be added)
description: >-
The value to add to the card's current ATK.
Can be negative to decrease the card's ATK.
- name: reset
type: [ int ]
description: (To be added)
description: Composite [Reset](/api/enums/Reset) value describing when the ATK change stops applying.
required: false
- name: rc
type: [ Card ]
description: (To be added)
description: The card causing the ATK change.
required: false
defaultValue: c
- name: reset_count
type: [ int ]
description: How many times `reset` must happen for the ATK change to stop applying.
required: false
defaultValue: 1
returns:
- type: [ int ]
description: (To be added)
tags: [ under-construction ]
description: The amount of ATK successfully changed (the difference between the card's new ATK and its previous ATK).
tags: [ atk-related, registers-effect ]
Loading