Duel.SelectMatchingCard

Signature

Duel.SelectMatchingCard(int sel_player, [function|nil f], int player, int s, int o, int min, int max, [Card|Group|nil ex], ... any) -> Group|nil

Description

Lets sel_player choose min to max cards from the specified locations that satisfy filter f and are not excluded by ex. s is player's own location mask and o is the opponent's location mask from that player's viewpoint. Extra arguments after ex are passed to f. This does not register official Chain targets; use Duel.SelectTarget for card text that targets.

How To Use It

Use this when the selected cards do not need to become official effect targets.

A common pattern is to check with Duel.IsExistingMatchingCard, select with Duel.SelectMatchingCard, then move or modify the selected group during the operation:

local g=Duel.SelectMatchingCard(tp,s.filter,tp,LOCATION_GRAVE,0,1,1,nil,e,tp)
if #g>0 then
    Duel.SpecialSummon(g,0,tp,tp,false,false,POS_FACEUP)
end

Use Duel.SelectTarget in a Target callback when later resolution must re-check tc:IsRelateToEffect(e) or when the card text says the effect targets. Use Group.Select when you already built a Group and only need the player to choose from it.

Related Functions

• Duel.IsExistingMatchingCard
• Group.Select
• Duel.SelectTarget

Parameters

• sel_player int - Player who makes the selection; invalid players make the core return no values.
• f function|nil optional - Filter callback; nil accepts cards that pass location and exclusion checks.
• player int - Reference player for the s and o location masks.
• s int - Location mask on player's side.
• o int - Location mask on the opponent's side from player's viewpoint.
• min int - Minimum number of cards to select.
• max int - Maximum number of cards to select.
• ex Card|Group|nil optional - Card or Group excluded from selectable cards; nil excludes nothing.
• ... any - Extra values forwarded to f after the candidate Card.

Returns

• Group|nil - New Group containing the selected cards, or nil if sel_player is invalid.

Source

• D:\Programs\GitHub\ygopro-core\libduel.cpp:4973

Guided Examples

Learn how to use this function in context:

• Beginner Script Ladder
• Client UI And Prompt Behavior
• Common Script Errors And Debugging
• Filters, Card Objects, and Group Objects
• Selection And Group Handling

Used By

Generated from the local Scripts/ folder and cards.cdb.

• Detected in 5452 indexed script(s).
• Search this function in the Script Explorer with Duel.SelectMatchingCard.

Card	ID	Script	Detected Calls
Salamandra with Chain	62091148	Scripts/c62091148.lua	1
Astrograph Sorcerer, the Starfrost Magician	48171151	Scripts/c48171151.lua	1
Artmage Non-Finito	74631897	Scripts/c74631897.lua	1
Pendulum Evolution	55795155	Scripts/c55795155.lua	2
Levia-Dragoon - Daedalus	78579058	Scripts/c78579058.lua	2
Lady's Dragonmaid	48658295	Scripts/c48658295.lua	1
Azure Ocean Dragon Lord - Neo-Daedalus Rage	41570943	Scripts/c41570943.lua	1
Eternal Favorite	87532344	Scripts/c87532344.lua	1
Astrograph Sorcerer	76794549	Scripts/c76794549.lua	3
Spellbook of the Grand Circle	11911336	Scripts/c11911336.lua	1
Accel Synchro Stardust Dragon	30983281	Scripts/c30983281.lua	2
Ashtraja Susanoo	17020474	Scripts/c17020474.lua	2
Deftero Enneacraft - "alazoneIA"	92171126	Scripts/c92171126.lua	2
El Shaddoll Apkallone	50907446	Scripts/c50907446.lua	1
Mementotlan Fusion	66518509	Scripts/c66518509.lua	2
Meteoroa Drytron	24166324	Scripts/c24166324.lua	2
Gem-Knight Dispersion	24220368	Scripts/c24220368.lua	1
Performage Cup Tricker	6812770	Scripts/c6812770.lua	2
Ehther the Heavenly Monarch	96570609	Scripts/c96570609.lua	2
Ghostrick Renovation	61818176	Scripts/c61818176.lua	1
Pere-Zenet Em Heru	46273941	Scripts/c46273941.lua	2
Am Duazenet	45151304	Scripts/c45151304.lua	2
Magnet Bonding	65514302	Scripts/c65514302.lua	2
Ursarctic Polari	27693363	Scripts/c27693363.lua	2
...and 5428 more

Script Examples

Salamandra with Chain (62091148)

Source: Scripts/c62091148.lua

			Duel.BreakEffect()
			Duel.Hint(HINT_SELECTMSG,tp,HINTMSG_FACEUP)
			local g=Duel.SelectMatchingCard(tp,s.posfilter,tp,LOCATION_MZONE,LOCATION_MZONE,1,1,nil)
			Duel.HintSelection(g)
			local tc2=g:GetFirst()

Astrograph Sorcerer, the Starfrost Magician (48171151)

Source: Scripts/c48171151.lua

	if Duel.Destroy(c,REASON_EFFECT)==0 then return end
	Duel.Hint(HINT_SELECTMSG,tp,HINTMSG_TOFIELD)
	local g=Duel.SelectMatchingCard(tp,s.pfilter,tp,LOCATION_HAND+LOCATION_DECK,0,1,1,nil,tp)
	local tc=g:GetFirst()
	if tc and Duel.MoveToField(tc,tp,tp,LOCATION_PZONE,POS_FACEUP,true) then

Artmage Non-Finito (74631897)

Source: Scripts/c74631897.lua

function s.setop(e,tp,eg,ep,ev,re,r,rp)
	Duel.Hint(HINT_SELECTMSG,tp,HINTMSG_SET)
	local g=Duel.SelectMatchingCard(tp,s.setfilter,tp,LOCATION_DECK,0,1,1,nil)
	local tc=g:GetFirst()
	if tc then