Duel.GetMatchingGroup

Signature

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

Description

Returns a Group containing 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.

How To Use It

Use this when you need to keep or further process all matching cards rather than only checking if they exist.

s and o are location masks from player's point of view. For example, LOCATION_MZONE,0 means that player's Monster Zone, while 0,LOCATION_MZONE means the opponent's Monster Zone.

local g=Duel.GetMatchingGroup(s.filter,tp,LOCATION_MZONE,LOCATION_MZONE,nil)
if #g>0 then
    Duel.HintSelection(g)
end

Parameters

• 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.
• ex Card|Group|nil optional - Card or Group excluded from the result; nil excludes nothing.
• ... any - Extra values forwarded to f after the candidate Card.

Returns

• Group - New Group containing every matching card.

Source

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

Guided Examples

Learn how to use this function in context:

• Methods for Affecting Cards
• Beginner Script Ladder
• Filters, Card Objects, and Group Objects
• First Scripts To Study
• Min/Max Stat Card Selection
• Special Summon-Only Monster Guide

Used By

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

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

Card	ID	Script	Detected Calls
Salamandra with Chain	62091148	Scripts/c62091148.lua	4
Astrograph Sorcerer, the Starfrost Magician	48171151	Scripts/c48171151.lua	3
Artmage Non-Finito	74631897	Scripts/c74631897.lua	3
Pendulum Evolution	55795155	Scripts/c55795155.lua	1
Levia-Dragoon - Daedalus	78579058	Scripts/c78579058.lua	2
Lady's Dragonmaid	48658295	Scripts/c48658295.lua	6
Azure Ocean Dragon Lord - Neo-Daedalus Rage	41570943	Scripts/c41570943.lua	5
Eternal Favorite	87532344	Scripts/c87532344.lua	4
Surprise Fusion	35167375	Scripts/c35167375.lua	2
Astrograph Sorcerer	76794549	Scripts/c76794549.lua	2
Spellbook of the Grand Circle	11911336	Scripts/c11911336.lua	4
Ultra Polymerization	76647978	Scripts/c76647978.lua	2
Accel Synchro Stardust Dragon	30983281	Scripts/c30983281.lua	3
Melffy Playtime Surprise	58036097	Scripts/c58036097.lua	2
Ashtraja Susanoo	17020474	Scripts/c17020474.lua	1
Deftero Enneacraft - "alazoneIA"	92171126	Scripts/c92171126.lua	2
Destiny HERO - Destro-Dogma	25158975	Scripts/c25158975.lua	5
Yomagna the Fire Phantom	17350692	Scripts/c17350692.lua	6
Fiendsmith's Sequence	49867899	Scripts/c49867899.lua	4
D/D/D Alfred the Divine Sage King	11852093	Scripts/c11852093.lua	4
El Shaddoll Apkallone	50907446	Scripts/c50907446.lua	2
Mementotlan Fusion	66518509	Scripts/c66518509.lua	5
Favorite HERO Flame Wingman	13243124	Scripts/c13243124.lua	3
Mixousia the Confounder	80843006	Scripts/c80843006.lua	4
...and 3248 more

Script Examples

Salamandra with Chain (62091148)

Source: Scripts/c62091148.lua

		local chkf=tp
		local mg1=Duel.GetFusionMaterial(tp)
		local mg2=Duel.GetMatchingGroup(s.filter0,tp,LOCATION_GRAVE,0,nil)
		mg1:Merge(mg2)
		local res=Duel.IsExistingMatchingCard(s.filter2,tp,LOCATION_EXTRA,0,1,nil,e,tp,mg1,nil,chkf)

Astrograph Sorcerer, the Starfrost Magician (48171151)

Source: Scripts/c48171151.lua

	local chkf=tp
	local mg1=Duel.GetFusionMaterial(tp):Filter(s.filter0,nil,e)
	local mg2=Duel.GetMatchingGroup(s.filter1,tp,LOCATION_EXTRA,0,nil,e)
	mg1:Merge(mg2)
	local sg1=Duel.GetMatchingGroup(s.filter2,tp,LOCATION_EXTRA,0,nil,e,tp,mg1,nil,chkf)

Artmage Non-Finito (74631897)

Source: Scripts/c74631897.lua

function s.sptg(e,tp,eg,ep,ev,re,r,rp,chk,c)
	local g=s.getrg(tp,c)
	local g2=Duel.GetMatchingGroup(s.cfilter,tp,LOCATION_HAND,0,nil)
	Duel.Hint(HINT_SELECTMSG,tp,HINTMSG_DISCARD)
	local tc=g2:SelectUnselect(nil,tp,false,true,1,1)