scrapi-book

Appearance

Script ​

subtype of table

The card script metatable, where values shared by all copies of a card are defined.

Functions that return this type

Functions that return this type ​

  • GetID - Gets the script metatable and card passcode of the current file.

Fields ​

  • InitialEffect initial_effect ​

    The function that registers a card's initial effects when loading the card. This function is required for a card script to be properly loaded.

  • IntArray|nil listed_names ​

    An array of passcodes/IDs of the cards mentioned in the card text.

  • IntArray|nil listed_series ​

    An array of Archetype values of the archetypes mentioned in the card text.

  • IntArray|nil listed_card_types ​

    An array of CardType values of the card types mentioned in the card text.

  • IntArray|nil counter_list ​

    An array of Counter values mentioned in the card text.

  • IntArray|nil counter_place_list ​

    An array of Counter values that the card can place.

  • IntArray|nil named_material ​

    An array of passcodes of the Summoning materials specifically mentioned in the card text.

  • MaterialArray|nil material ​

    An array of passcodes or filters of the Summoning materials mentioned in the card text.

  • IntArray|nil fit_monster ​

    An array of passcodes/IDs of the cards mentioned by a Ritual Spell as monsters it is used to Ritual Summon.

  • RitualMaterialFilter|nil mat_filter ​

    A filter function for a Ritual Monster's Ritual Summon materials.

  • int material_location ​

    A Location specified as where a Fusion material should be.

  • int material_race ​

    A MonsterRace mentioned as a Fusion material.

  • int|IntArray|nil material_setcode ​

    An Archetype mentioned as a Fusion material, or an array of Archetype values if there are more than one.

  • int material_trap ​

    The passcode/ID of a Trap Card mentioned as a Fusion material.

  • int|nil min_material_count ​

    The minimum number of materials a Fusion Monster uses for its Fusion Summon.

  • int|nil max_material_count ​

    The maximum number of materials a Fusion Monster uses for its Fusion Summon.

  • int|nil material_count ​

    The number of materials a Fusion Monster uses for its Fusion Summon if min_material_count and max_material_count are equal.

  • int|nil synchro_tuner_required ​

    The number of Tuner Synchro monsters required for the card's Synchro Summon.

  • int|nil synchro_nt_required ​

    The number of Non-Tuner Synchro monsters required for the card's Synchro Summon.

  • bool|nil synchro_type ​

    Is true if the card includes an effect that Special Summons itself as a Tuner.

  • bool|nil self_tuner ​

    Is true if the card includes an effect that Special Summons itself as a Tuner.

  • int|nil minxyzct ​

    The minimum number of materials a Xyz Monster uses for its Xyz Summon.

  • int|nil maxxyzct ​

    The maximum number of materials a Xyz Monster uses for its Xyz Summon.

  • int|nil xyz_number ​

    The number of a "Number" Xyz monster.

  • RankUpMaterialFilter|nil rum_limit ​

    Filters what can be used by a Rank-Up-Magic effect to Special Summon an Xyz Monster.

  • RankUpSummonRegister|nil rum_xyzsummon ​

    A function that registers a Special Summon procedure using a Rank-Up-Magic effect.

  • int|nil pendulum_level ​

    The level a monster is treated as for a Pendulum Summon.

  • int|nil MaximumATK ​

    A Maximum Monster's Maximum ATK.

  • bool|nil illegal ​

    Is true if the card is illegal.

  • bool|nil toss_coin ​

    Is true if the card includes an effect that performs a coin toss.

  • bool|nil roll_dice ​

    Is true if the card includes an effect that performs a die roll.

  • bool|nil old_union ​

    Is true if the card is a Union monster that follows the old Union monster rulings.

  • int|nil LVnum ​

    The LV number of an "LV" monster.

  • int|nil LVset ​

    The LV set of an LV monster.

  • ArcanaEffectRegister|nil arcanareg ​

    A function that registers an Arcana Force card's coin-based effects.

  • int|nil assault_mode ​

    The passcode of the Synchro Monster used to Special Summon an "/Assault Mode" monster.

  • bool|nil miracle_synchro_fusion ​

    Is true if the card can be Special Summoned by Miracle Synchro Fusion.

  • bool|nil dark_calling ​

    Is true if the card must be Special Summoned by Dark Fusion, and consequently can be Fusion Summoned by Dark Calling.

  • IntArray|nil enhanced_metalmorph_stats ​

    The level and race of the monster needed to be tributed by Enhanced Metalmorph to Special Summon the card.

under-construction