Group.Filter

Signature

Group.Filter(Group g, function f, [Card|Group|nil ex], ... any) -> Group

Description

Returns a new Group containing cards from g that satisfy filter f and are not excluded by ex. Extra arguments after ex are passed to f after the card argument. The source Group is not modified.

How To Use It

Use this when you already have a Group and want a smaller Group from it.

local g=Duel.GetFieldGroup(tp,LOCATION_MZONE,0)
local fg=g:Filter(Card.IsFaceup,nil)

Extra arguments after ex are passed to the filter after the card. The original Group is not destroyed; the function returns a new Group.

Related Functions

• Group.FilterCount
• Group.Select
• Group.FilterSelect

Parameters

• g Group - Group to filter; it is not modified.
• f function - Filter callback called for each candidate card.
• ex Card|Group|nil optional - Card or Group excluded before filtering; nil excludes nothing.
• ... any - Extra values forwarded to f after the candidate Card.

Returns

• Group - New Group containing cards that passed f.

Source

• D:\Programs\GitHub\ygopro-core\libgroup.cpp:912

Guided Examples

Learn how to use this function in context:

• Filters, Card Objects, and Group Objects
• Selection And Group Handling

Used By

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

• Detected in 839 indexed script(s).
• Search this function in the Script Explorer with Group.Filter.

Card	ID	Script	Detected Calls
Salamandra with Chain	62091148	Scripts/c62091148.lua	3
Astrograph Sorcerer, the Starfrost Magician	48171151	Scripts/c48171151.lua	6
Artmage Non-Finito	74631897	Scripts/c74631897.lua	6
Pendulum Evolution	55795155	Scripts/c55795155.lua	2
Levia-Dragoon - Daedalus	78579058	Scripts/c78579058.lua	4
Lady's Dragonmaid	48658295	Scripts/c48658295.lua	5
Azure Ocean Dragon Lord - Neo-Daedalus Rage	41570943	Scripts/c41570943.lua	4
Goyo Emperor	59255742	Scripts/c59255742.lua	3
Ashtraja Susanoo	17020474	Scripts/c17020474.lua	5
Deftero Enneacraft - "alazoneIA"	92171126	Scripts/c92171126.lua	1
Destiny HERO - Destro-Dogma	25158975	Scripts/c25158975.lua	4
Fiendsmith's Sequence	49867899	Scripts/c49867899.lua	2
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	4
Meteoroa Drytron	24166324	Scripts/c24166324.lua	7
Performage Cup Tricker	6812770	Scripts/c6812770.lua	1
Lubellion the Searing Dragon	70534340	Scripts/c70534340.lua	2
Pere-Zenet Em Heru	46273941	Scripts/c46273941.lua	2
Am Duazenet	45151304	Scripts/c45151304.lua	2
Magnet Bonding	65514302	Scripts/c65514302.lua	2
Prank-Kids Weather Washer	44509529	Scripts/c44509529.lua	2
PSY-Framelord Omega	74586817	Scripts/c74586817.lua	2
Graydle Split	75361204	Scripts/c75361204.lua	1
...and 815 more

Script Examples

Salamandra with Chain (62091148)

Source: Scripts/c62091148.lua

function s.spop(e,tp,eg,ep,ev,re,r,rp)
	local chkf=tp
	local mg1=Duel.GetFusionMaterial(tp):Filter(s.filter1,nil,e)
	local mg2=Duel.GetMatchingGroup(s.filter1,tp,LOCATION_GRAVE,0,nil,e)
	mg1:Merge(mg2)

Astrograph Sorcerer, the Starfrost Magician (48171151)

Source: Scripts/c48171151.lua

			and c:IsCanBeSpecialSummoned(e,0,tp,false,false)
	end
	local desg=eg:Filter(s.desfilter,nil,tp)
	Duel.SetTargetCard(desg)
	Duel.SetOperationInfo(0,CATEGORY_SPECIAL_SUMMON,c,1,0,0)

Artmage Non-Finito (74631897)

Source: Scripts/c74631897.lua

function s.getrg(tp,sc)
	local rg=Duel.GetReleaseGroup(tp,true,REASON_SPSUMMON)
	local mrg=rg:Filter(Card.IsHasEffect,nil,EFFECT_EXTRA_RELEASE)
	if mrg:GetCount()>0 then
		return mrg:Filter(s.spfilter,nil,tp,sc)