Duel.GetDecktopGroup

Signature

Duel.GetDecktopGroup(int player, int count) -> Group

Description

Returns a Group containing up to count cards from the top of player's Deck. If count is larger than the remaining Deck size, only the available cards are included. This accessor does not confirm or reveal those cards by itself.

Parameters

• player int - Player whose Deck is read.
• count int - Maximum number of cards to include from the top of the Deck.

Returns

• Group - New Group containing the top Deck cards, or an empty Group if no cards are available.

Source

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

Guided Examples

Learn how to use this function in context:

• Draw, Hand, And Deck Effects

Used By

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

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

Card	ID	Script	Detected Calls
GMX 55th Experiment Report	38984832	Scripts/c38984832.lua	2
Junoldo the Shadespirit Power Patron	10266279	Scripts/c10266279.lua	1
Flower Cardian Peony with Butterfly	57261568	Scripts/c57261568.lua	2
Jupredo the Shademachine Power Patron	43871165	Scripts/c43871165.lua	1
D/D Extra Surveyor	74387963	Scripts/c74387963.lua	2
Nervedo the Shadebeast Power Patron	17473466	Scripts/c17473466.lua	1
Purrely	25550531	Scripts/c25550531.lua	3
Sylvan Dancepione	21903613	Scripts/c21903613.lua	1
Squeeze, the Full Moon of Raise Moon - JACKPOT!	9484285	Scripts/c9484285.lua	1
Materiactor Meltthrough	66059345	Scripts/c66059345.lua	2
Mad Tempest Trirealm Rift Ploutonion	33822112	Scripts/c33822112.lua	2
Time Thief Redoer	55285840	Scripts/c55285840.lua	1
Ma'at	18631392	Scripts/c18631392.lua	2
Loris, Lady of Lament	50699850	Scripts/c50699850.lua	1
Silk Bomb Moth	18300894	Scripts/c18300894.lua	1
Shadowreaver Knight 21	95506252	Scripts/c95506252.lua	3
Bahalutiya, the Grand Radiance	53318263	Scripts/c53318263.lua	2
Materiactor Meltdown	38669664	Scripts/c38669664.lua	2
GMX Applied Experiment #55	18795635	Scripts/c18795635.lua	1
Buerillabaisse de Nouvelles	26223582	Scripts/c26223582.lua	1
Magikey Mechmusket - Batosbuster	19489718	Scripts/c19489718.lua	1
Super Koi Koi	66171432	Scripts/c66171432.lua	1
Mariamne, the True Dracophoenix	94160895	Scripts/c94160895.lua	1
Chaos Ruler, the Chaotic Magical Dragon	3040496	Scripts/c3040496.lua	1
...and 176 more

Script Examples

GMX 55th Experiment Report (38984832)

Source: Scripts/c38984832.lua

	local max_decktop=5
	if count>max_decktop then
		local g=Duel.GetDecktopGroup(tp,count)
		Duel.ConfirmCards(1-tp,g)
	else

Junoldo the Shadespirit Power Patron (10266279)

Source: Scripts/c10266279.lua

end
function s.spcost(e,tp,eg,ep,ev,re,r,rp,chk)
	local g=Duel.GetDecktopGroup(tp,3)
	if chk==0 then return g:FilterCount(Card.IsAbleToRemoveAsCost,nil,POS_FACEDOWN)==3
		and Duel.GetFieldGroupCount(tp,LOCATION_DECK,0)>=3

Flower Cardian Peony with Butterfly (57261568)

Source: Scripts/c57261568.lua

			if ct==0 then return end
			Duel.BreakEffect()
			local g=Duel.GetDecktopGroup(1-tp,ct)
			Duel.ConfirmCards(tp,g)
			local opt=Duel.SelectOption(tp,aux.Stringid(57261568,1),aux.Stringid(57261568,2))