Card

Functions for working with cards. This is also used as the metatable for Script tables, which in turn are used as the metatable for all card instances of that script. This means functions in this namespace can be used as "methods" of card objects, e.g. instead of Card.GetLevel(c), one can use c.GetLevel(c) or c:GetLevel(). It is recommended to use the colon syntax.

Functions

• Card.AddCannotBeSpecialSummoned - Adds a "Cannot be Special Summoned" Summoning condition to a monster

• Card.AddCenterToSideEffectHandler - Grants an effect to a Maximum Monster's [L] and [R] pieces.

• Card.AddCounter - Places counters to a card.

• Card.AddDoubleTribute - Allows using cards as double (or triple) tributes in Rush Duels.

• Card.AddMaximumAtkHandler - Implements the Maximum ATK of a Maximum monster.

• Card.AddMonsterAttribute - Transforms the provided card into a monster.

• Card.AddMonsterAttributeComplete - Completes the transformation of a card into a monster.

• Card.AddMustBeFusionSummoned - Adds a "Must be Fusion Summoned" Summoning condition to a monster

• Card.AddMustBeLinkSummoned - Adds a "Must be Link Summoned" Summoning condition to a monster

• Card.AddMustBePendulumSummoned - Adds a "Must be Pendulum Summoned" Summoning condition to a monster

• Card.AddMustBeRitualSummoned - Adds a "Must be Ritual Summoned" Summoning condition to a monster

• Card.AddMustBeSpecialSummoned - Adds a "Must be Special Summoned" Summoning condition to a monster

• Card.AddMustBeSpecialSummonedByCardEffect - Adds a "Must be Special Summoned by card effect" Summoning condition to a card

• Card.AddMustBeSpecialSummonedByDarkFusion - Adds a "Must be Special Summoned by Dark Fusion" Summoning condition to a card

• Card.AddMustBeSynchroSummoned - Adds a "Must be Synchro Summoned" Summoning condition to a monster

• Card.AddMustBeXyzSummoned - Adds a "Must be Xyz Summoned" Summoning condition to a monster

• Card.AddMustFirstBeFusionSummoned - Adds a "Must first be Fusion Summoned" Summoning condition to a monster

• Card.AddMustFirstBeLinkSummoned - Adds a "Must first be Link Summoned" Summoning condition to a monster

• Card.AddMustFirstBePendulumSummoned - Adds a "Must first be Pendulum Summoned" Summoning condition to a monster

• Card.AddMustFirstBeRitualSummoned - Adds a "Must first be Ritual Summoned" Summoning condition to a monster

• Card.AddMustFirstBeSynchroSummoned - Adds a "Must first be Synchro Summoned" Summoning condition to a monster

• Card.AddMustFirstBeXyzSummoned - Adds a "Must first be Xyz Summoned" Summoning condition to a monster

• Card.AddNoTributeCheck

• Card.AddPiercing

• Card.AddSetcodesRule - Adds any number of archetypes (setcodes) to a card.

• Card.AddSideMaximumHandler

• Card.Alias - Returns a card's alias.

• Card.AnnounceAnotherAttribute - Makes a player declare an attribute other than the ones a card currently has.

• Card.AnnounceAnotherRace - Makes a player declare a race other than the ones a card currently has.

• Card.AssumeProperty - Temporarily assumes a property for a card.

• Card.Attack - Returns a card's original ATK.

• Card.Attribute - Returns the card's original attribute(s).

• Card.CanAttack - Checks if a card can declare an attack.

• Card.CanBeDoubleTribute

• Card.CanChainAttack - Checks if a card can make a number of attacks in a row.

• Card.CanGetPiercingRush

• Card.CanSummonOrSet - Checks if a card can be Normal Summoned or Set.

• Card.CancelCardTarget - Makes a card stop targeting another card.

• Card.CancelToGrave - Changes the behavior of the rule that sends certain card types to the GY.

• Card.CheckActivateEffect

• Card.CheckAdjacent

• Card.CheckEquipTarget - Checks if a card can be equipped to another.

• Card.CheckEquipTargetRush

• Card.CheckFusionMaterial

• Card.CheckFusionSubstitute

• Card.CheckRemoveOverlayCard

• Card.CheckUnionTarget

• Card.CheckUniqueOnField

• Card.ClearEffectRelation

• Card.Code - Returns a card's current passcode/ID.

• Card.CompleteProcedure

• Card.CopyEffect - Copy the effects of a card to another.

• Card.Cover

• Card.CreateEffectRelation

• Card.CreateRelation

• Card.Defense - Returns a card's original DEF.

• Card.EnableCounterPermit - Allows a card to hold a counter that needs permissions.

• Card.EnableGeminiState

• Card.EnableGeminiStatus

• Card.EnableReviveLimit

• Card.EnableUnsummonable

• Card.EquipByEffectAndLimitRegister

• Card.EquipByEffectLimit

• Card.FromLuaRef

• Card.GetActivateEffect - Gets a card's activation effects.

• Card.GetAllCounters - Gets all counters a card currently has.

• Card.GetAttack - Gets the current ATK of a card.

• Card.GetAttackAnnouncedCount

• Card.GetAttackableTarget

• Card.GetAttackedCount

• Card.GetAttackedGroup

• Card.GetAttackedGroupCount

• Card.GetAttribute - Gets the current attribute(s) of a card.

• Card.GetBaseAttack - Gets the original ATK of a card.

• Card.GetBaseDefense - Gets the original DEF of a card.

• Card.GetBattlePosition - Gets the battle position of a monster at the start of the Damage Step

• Card.GetBattleTarget

• Card.GetBattledGroup

• Card.GetBattledGroupCount

• Card.GetCardEffect - Gets all the effects being applied to a card

• Card.GetCardID

• Card.GetCardTarget

• Card.GetCardTargetCount

• Card.GetCode

• Card.GetColumnGroup

• Card.GetColumnGroupCount

• Card.GetColumnZone

• Card.GetControler

• Card.GetCounter - Gets the number of counters of a certain type a card has.

• Card.GetDefense - Gets the current DEF of a card.

• Card.GetDestination - Returns the location a card would be sent to

• Card.GetEffectCount

• Card.GetEquipCount

• Card.GetEquipGroup

• Card.GetEquipTarget

• Card.GetFieldID - Gets a card's current location ID

• Card.GetFirstCardTarget

• Card.GetFlagEffect

• Card.GetFlagEffectLabel

• Card.GetFreeLinkedZone

• Card.GetLeaveFieldDest - Gets a card's destination when it leaves the field

• Card.GetLeftScale

• Card.GetLevel

• Card.GetLink

• Card.GetLinkMarker

• Card.GetLinkedGroup

• Card.GetLinkedGroupCount

• Card.GetLinkedZone

• Card.GetLocation

• Card.GetLuaRef

• Card.GetMainCardType

• Card.GetMaterial

• Card.GetMaterialCount

• Card.GetMaximumAttack

• Card.GetMetatable

• Card.GetMutualLinkedGroup

• Card.GetMutualLinkedGroupCount

• Card.GetMutualLinkedZone

• Card.GetOriginalAttribute

• Card.GetOriginalCode

• Card.GetOriginalCodeRule

• Card.GetOriginalLeftScale

• Card.GetOriginalLevel

• Card.GetOriginalRace

• Card.GetOriginalRank

• Card.GetOriginalRightScale

• Card.GetOriginalSetCard

• Card.GetOriginalType

• Card.GetOverlayCount

• Card.GetOverlayGroup

• Card.GetOverlayTarget

• Card.GetOwnEffects - Gets all the effects registered or being granted to a card

• Card.GetOwner - Gets the owner of a card

• Card.GetOwnerTarget

• Card.GetOwnerTargetCount

• Card.GetPosition

• Card.GetPreviousAttackOnField

• Card.GetPreviousAttributeOnField

• Card.GetPreviousCodeOnField

• Card.GetPreviousControler

• Card.GetPreviousDefenseOnField

• Card.GetPreviousEquipTarget

• Card.GetPreviousLevelOnField

• Card.GetPreviousLocation

• Card.GetPreviousPosition

• Card.GetPreviousRaceOnField

• Card.GetPreviousRankOnField

• Card.GetPreviousSequence

• Card.GetPreviousSetCard

• Card.GetPreviousTypeOnField

• Card.GetRace

• Card.GetRank

• Card.GetRealFieldID - Gets a card's current location ID

• Card.GetReason

• Card.GetReasonCard

• Card.GetReasonEffect

• Card.GetReasonPlayer

• Card.GetRightScale

• Card.GetRitualLevel

• Card.GetScale

• Card.GetSequence

• Card.GetSetCard

• Card.GetSummonLocation

• Card.GetSummonPlayer

• Card.GetSummonType

• Card.GetSynchroLevel

• Card.GetTextAttack - Gets the printed ATK of a card.

• Card.GetTextDefense - Gets the printed DEF of a card.

• Card.GetToBeLinkedZone

• Card.GetTributeRequirement

• Card.GetTurnCounter

• Card.GetTurnID

• Card.GetType

• Card.GetUnionCount

• Card.HasCounter - Checks if a card has a specified counter

• Card.HasCounters

• Card.HasDefense - Checks if a card currently has a DEF value.

• Card.HasEquipCard - Checks if a card has any number of equipped cards

• Card.HasFlagEffect

• Card.HasLevel - Checks if a card has a level

• Card.HasNonZeroAttack

• Card.HasNonZeroDefense

• Card.HasRank - Checks if a card has a rank

• Card.IsAbleToChangeControler

• Card.IsAbleToDeck

• Card.IsAbleToDeckAsCost

• Card.IsAbleToDeckOrExtraAsCost

• Card.IsAbleToExtra

• Card.IsAbleToExtraAsCost

• Card.IsAbleToGrave

• Card.IsAbleToGraveAsCost

• Card.IsAbleToHand

• Card.IsAbleToHandAsCost

• Card.IsAbleToRemove

• Card.IsAbleToRemoveAsCost

• Card.IsAllColumn

• Card.IsAttack

• Card.IsAttackAbove

• Card.IsAttackBelow

• Card.IsAttackPos

• Card.IsAttribute

• Card.IsAttributeExcept

• Card.IsBaseAttack - Checks a card's original ATK

• Card.IsBaseDefense - Checks a card's original DEF

• Card.IsBattleDestroyed

• Card.IsBattlePosition - Checks a card's battle position at the start of the Damage Step

• Card.IsCanAddCounter

• Card.IsCanBeBattleTarget

• Card.IsCanBeDisabledByEffect

• Card.IsCanBeEffectTarget

• Card.IsCanBeFusionMaterial

• Card.IsCanBeLinkMaterial

• Card.IsCanBeMaterial

• Card.IsCanBeRitualMaterial

• Card.IsCanBeSpecialSummoned

• Card.IsCanBeSynchroMaterial

• Card.IsCanBeXyzMaterial

• Card.IsCanChangePosition

• Card.IsCanChangePositionRush

• Card.IsCanRemoveCounter

• Card.IsCanTurnSet

• Card.IsCode

• Card.IsColumn

• Card.IsContinuousSpell - Checks if a card is currently a Continuous Spell.

• Card.IsContinuousSpellTrap - Checks if a card is currently a Continuous Spell/Trap.

• Card.IsContinuousTrap - Checks if a card is currently a Continuous Trap.

• Card.IsControler

• Card.IsControlerCanBeChanged

• Card.IsCounterTrap - Checks if a card is currently a Counter Trap.

• Card.IsDefense

• Card.IsDefenseAbove

• Card.IsDefenseBelow

• Card.IsDefensePos

• Card.IsDeleted

• Card.IsDestination - Checks if a card would be sent to a given location

• Card.IsDestructable

• Card.IsDifferentAttribute

• Card.IsDifferentRace

• Card.IsDirectAttacked

• Card.IsDisabled

• Card.IsDiscardable

• Card.IsDoubleTribute

• Card.IsEquipCard - Checks if a card is currently a Equip Card.

• Card.IsEquipSpell - Checks if a card is currently a Equip Spell.

• Card.IsEvenScale

• Card.IsExactType

• Card.IsExtraLinked

• Card.IsFacedown - Checks if a card is currently face-down.

• Card.IsFaceup - Checks if a card is currently face-up.

• Card.IsFieldID - Checks a card's current location ID

• Card.IsFieldSpell - Checks if a card is currently a Field Spell.

• Card.IsFlipSummoned - Checks if a card is currently Flip Summoned.

• Card.IsForbidden

• Card.IsFusionSummonableCard

• Card.IsFusionSummoned - Checks if a card is currently Fusion Summoned.

• Card.IsGeminiState

• Card.IsGeminiStatus

• Card.IsGeminiSummoned - Checks if a card is currently Gemini Summoned.

• Card.IsHasCardTarget

• Card.IsHasEffect - Gets all the effects of a given code being applied to a card

• Card.IsImmuneToEffect

• Card.IsInExtraMZone

• Card.IsInMainMZone

• Card.IsLeaveFieldDest - Checks if a card would be sent to a given location when it leaves the field

• Card.IsLevel - Checks the level of a card

• Card.IsLevelAbove - Checks if the level of a card is greater than or equal to a given level

• Card.IsLevelBelow - Checks if the level of a card is less than or equal to a given level

• Card.IsLevelBetween - Checks if the level of a card is between two levels

• Card.IsLink

• Card.IsLinkAbove

• Card.IsLinkBelow

• Card.IsLinkCode

• Card.IsLinkMarker

• Card.IsLinkMonster - Checks if a card is currently a Link Monster.

• Card.IsLinkSetCard

• Card.IsLinkSpell - Checks if a card is currently a Link Spell.

• Card.IsLinkSummonable

• Card.IsLinkSummoned - Checks if a card is currently Link Summoned.

• Card.IsLinked

• Card.IsLocation

• Card.IsMSetable

• Card.IsMaximumMode

• Card.IsMaximumModeCenter

• Card.IsMaximumModeLeft

• Card.IsMaximumModeRight

• Card.IsMaximumModeSide

• Card.IsMonster - Checks if a card is currently a monster.

• Card.IsMonsterCard - Checks if a card is originally a Monster Card.

• Card.IsNegatable

• Card.IsNegatableMonster

• Card.IsNegatableSpellTrap

• Card.IsNonEffectMonster - Checks if a card is a Non-Effect monster

• Card.IsNormalSpell - Checks if a card is currently a Normal Spell.

• Card.IsNormalSpellTrap - Checks if a card is currently a Normal Spell/Trap.

• Card.IsNormalSummoned - Checks if a card is currently Normal Summoned/Set.

• Card.IsNormalTrap - Checks if a card is currently a Normal Trap.

• Card.IsNotMaximumModeSide

• Card.IsNotTuner - Checks if a card can be used for a Synchro Summon as a non-Tuner monster

• Card.IsOddScale

• Card.IsOnField - Checks if a card is currently on the field.

• Card.IsOriginalAttribute

• Card.IsOriginalCode

• Card.IsOriginalCodeRule

• Card.IsOriginalLevel - Checks a card's original level

• Card.IsOriginalRace

• Card.IsOriginalRank - Checks a card's original rank

• Card.IsOriginalSetCard

• Card.IsOriginalType

• Card.IsOwner - Checks a card's owner

• Card.IsPendulumSummoned - Checks if a card is currently Pendulum Summoned.

• Card.IsPosition

• Card.IsPreviousAttackOnField - Checks a card's previous ATK

• Card.IsPreviousAttributeOnField - Checks a card's previous attribute

• Card.IsPreviousCodeOnField - Checks a card's previous passcode

• Card.IsPreviousControler

• Card.IsPreviousDefenseOnField - Checks a card's previous DEF

• Card.IsPreviousLevelOnField - Checks a card's previous level

• Card.IsPreviousLocation

• Card.IsPreviousPosition

• Card.IsPreviousRaceOnField - Checks a card's previous race

• Card.IsPreviousRankOnField - Checks a card's previous rank

• Card.IsPreviousSequence - Checks a card's previous sequence

• Card.IsPreviousSetCard

• Card.IsPreviousTypeOnField - Checks a card's previous card type

• Card.IsProcedureSummonable

• Card.IsPublic

• Card.IsQuickPlaySpell - Checks if a card is currently a Quick-Play Spell.

• Card.IsRace

• Card.IsRank

• Card.IsRankAbove

• Card.IsRankBelow

• Card.IsRealFieldID - Checks a card's unique duel ID

• Card.IsReason

• Card.IsReasonCard - Checks if a card caused the event that happened to another card.

• Card.IsReasonEffect - Checks if an effect caused the event that happened to card

• Card.IsReasonPlayer - Checks if a player caused the event that happened to card

• Card.IsReincarnationSummoned

• Card.IsRelateToBattle

• Card.IsRelateToCard

• Card.IsRelateToChain

• Card.IsRelateToEffect

• Card.IsReleasable

• Card.IsReleasableByEffect

• Card.IsRikkaReleasable

• Card.IsRitualMonster - Checks if a card is currently a Ritual Monster.

• Card.IsRitualSpell - Checks if a card is currently a Ritual Spell.

• Card.IsRitualSummoned - Checks if a card is currently Ritual Summoned.

• Card.IsSSetable

• Card.IsScale - Checks a card's Pendulum Scale

• Card.IsSequence

• Card.IsSetCard

• Card.IsSpecialSummonable

• Card.IsSpecialSummoned - Checks if a card is currently Special Summoned.

• Card.IsSpell - Checks if a card is currently a Spell.

• Card.IsSpellCard - Checks if a card is originally a Spell Card.

• Card.IsSpellTrap - Checks if a card is currently a Spell/Trap.

• Card.IsSpellTrapCard - Checks if a card is originally a Spell/Trap Card.

• Card.IsStatus

• Card.IsSummonCode

• Card.IsSummonLocation

• Card.IsSummonPlayer

• Card.IsSummonType

• Card.IsSummonable

• Card.IsSummonableCard

• Card.IsSynchroSummonable

• Card.IsSynchroSummoned - Checks if a card is currently Synchro Summoned.

• Card.IsTextAttack - Checks a card's original ATK

• Card.IsTextDefense - Checks a card's original DEF

• Card.IsTrap - Checks if a card is currently a Trap.

• Card.IsTrapCard - Checks if a card is originally a Trap Card.

• Card.IsTrapMonster - Checks if a card is a Trap Monster

• Card.IsTributeSummoned - Checks if a card is currently Tribute Summoned/Set.

• Card.IsType - Checks a card's type

• Card.IsXyzLevel

• Card.IsXyzSummonable

• Card.IsXyzSummoned - Checks if a card is currently Xyz Summoned.

• Card.Level - Returns a card's original level, rank, or link-rating.

• Card.LinkMarker - Returns the card's original link marker(s).

• Card.ListsArchetype

• Card.ListsArchetypeAsMaterial

• Card.ListsCardType

• Card.ListsCode

• Card.ListsCodeAsMaterial

• Card.ListsCodeWithArchetype

• Card.ListsCounter

• Card.Lscale - Returns a card's left Pendulum Scale.

• Card.MoveAdjacent

• Card.NegateEffects

• Card.PlacesCounter

• Card.Race - Returns the card's original race(s).

• Card.Recreate

• Card.RegisterEffect

• Card.RegisterEffectRush

• Card.RegisterFlagEffect

• Card.ReleaseEffectRelation

• Card.ReleaseRelation

• Card.RemoveAllCounters

• Card.RemoveCounter

• Card.RemoveOverlayCard

• Card.ReplaceEffect

• Card.ResetEffect

• Card.ResetFlagEffect

• Card.ResetNegateEffect

• Card.ReverseInDeck

• Card.Rscale - Returns a card's right Pendulum Scale.

• Card.SelectAdjacent

• Card.SetCardTarget

• Card.SetCounterLimit

• Card.SetFlagEffectLabel

• Card.SetHint - Sets a card hint to be displayed on a card when a player hovers it.

• Card.SetMaterial

• Card.SetReason

• Card.SetReasonCard

• Card.SetReasonEffect

• Card.SetReasonPlayer

• Card.SetSPSummonOnce

• Card.SetStatus

• Card.SetTurnCounter

• Card.SetUniqueOnField

• Card.Setcode - Returns the card's original archetype(s).

• Card.Type - Returns a card's original type(s).

• Card.UpdateAttack

• Card.UpdateDefense

• Card.UpdateLevel

• Card.UpdateLink

• Card.UpdateRank

• Card.UpdateScale

• Card.WasMaximumMode

• Card.WasMaximumModeSide