Skip to content

Xyz.AddProcedure

Source Code | Usage Examples | Xyz Functions

Registers an effect to a card that allows it to be Xyz Summoned.

Signature

Xyz.AddProcedure(Card c, CardFilter|nil f, int|nil lv, int ct, [CardFilter alterf = nil, int desc = 0, int maxct = ct, XyzExtraOperation op = nil, bool mustbemat = false, XyzExtraCheck exchk = nil]) → nil

lua
Xyz.AddProcedure(c,f,lv,ct,alterf,desc,maxct,op,mustbemat,exchk)

Parameters

  • Card c

    The card that will receive the procedure.

  • CardFilter|nil f

    A filter for the cards that can be used as Xyz materials, in addition to the default matching level requirement.

  • int|nil lv

    The level the materials must have. Set to nil if no specific level is required.

  • int ct

    The number of required materials. If the card allows a variable number of materials, this parameter is used as the minimum.

  • CardFilter alterf

    Optional. Defaults to nil.

    A filter for alternative material(s), if allowed by the card (e.g. Number C39: Utopia Ray).

  • int desc

    Optional. Defaults to 0.

    The hint description shown when attempting to Xyz Summon using the alternative materials. Mandatory if alterf is not nil.

  • int maxct

    Optional. Defaults to ct.

    The maximum number of materials.

  • XyzExtraOperation op

    Optional. Defaults to nil.

    An additional function to execute when Xyz Summoning.

  • bool mustbemat

    Optional. Defaults to false.

    If true, restricts the materials to specifically listed materials. This disables the effects of cards such as Orichalcum Chain (minus 1 material) and Triangle Evolution (triple material).

  • XyzExtraCheck exchk

    Optional. Defaults to nil.

    An additional check to perform on material groups.


xyz-related, registers-effect