Duel.SendtoHand

Signature

Duel.SendtoHand(Card|Group targets, [int|nil player], int reason, [int reason_player]) -> int

Description

Sends targets to a hand for reason and returns the number of cards actually moved. Pass nil for player to use the normal return destination. Pass a specific player only when the effect says the cards go to that player's hand. When a hidden card is added and must be shown, confirm the moved card after this call succeeds.

How To Use It

Use this for adding or returning cards to the hand.

Pass nil for player when the card should go to its normal return destination. Pass a specific player only when the effect explicitly sends the card to that player's hand.

if Duel.SendtoHand(sg,nil,REASON_EFFECT)>0 then
    Duel.ConfirmCards(1-tp,sg)
end

When the card came from a hidden location and must be shown, reveal the result with Duel.ConfirmCards after it reaches the hand.

Related Functions

• Card.IsAbleToHand
• Duel.SetOperationInfo

Parameters

• targets Card|Group
• player int|nil optional
• reason int
• reason_player int optional

Returns

• int

Source

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

Guided Examples

Learn how to use this function in context:

• Functions That Move Cards Across Locations
• Spirit Monsters

Used By

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

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

Card	ID	Script	Detected Calls
Pendulum Evolution	55795155	Scripts/c55795155.lua	1
Astrograph Sorcerer	76794549	Scripts/c76794549.lua	1
Spellbook of the Grand Circle	11911336	Scripts/c11911336.lua	1
Melffy Playtime Surprise	58036097	Scripts/c58036097.lua	1
Ashtraja Susanoo	17020474	Scripts/c17020474.lua	2
Deftero Enneacraft - "alazoneIA"	92171126	Scripts/c92171126.lua	3
El Shaddoll Apkallone	50907446	Scripts/c50907446.lua	1
Mementotlan Fusion	66518509	Scripts/c66518509.lua	1
Meteoroa Drytron	24166324	Scripts/c24166324.lua	1
Gem-Knight Dispersion	24220368	Scripts/c24220368.lua	1
Performage Cup Tricker	6812770	Scripts/c6812770.lua	1
Ehther the Heavenly Monarch	96570609	Scripts/c96570609.lua	1
Ghostrick Renovation	61818176	Scripts/c61818176.lua	1
Magnet Bonding	65514302	Scripts/c65514302.lua	2
Hecahands Tartaros	57809669	Scripts/c57809669.lua	1
Ursarctic Polari	27693363	Scripts/c27693363.lua	1
Odd-Eyes Revolution Dragon	16306932	Scripts/c16306932.lua	1
Aiwass, Divine Spirit of the Law	84288367	Scripts/c84288367.lua	1
GMX 55th Experiment Report	38984832	Scripts/c38984832.lua	1
PSY-Framelord Omega	74586817	Scripts/c74586817.lua	1
D/D Count Surveyor	5997110	Scripts/c5997110.lua	1
Nekroz Kaleidoscope	51124303	Scripts/c51124303.lua	1
Enneacraft - Aiza.LEON	82359538	Scripts/c82359538.lua	1
Junoldo the Shadespirit Power Patron	10266279	Scripts/c10266279.lua	1
...and 3020 more

Script Examples

Pendulum Evolution (55795155)

Source: Scripts/c55795155.lua

	local g=Duel.SelectMatchingCard(tp,c55795155.thfilter,tp,LOCATION_DECK,0,1,1,nil,e:GetLabel())
	if g:GetCount()>0 then
		Duel.SendtoHand(g,nil,REASON_EFFECT)
		Duel.ConfirmCards(1-tp,g)
	end

Astrograph Sorcerer (76794549)

Source: Scripts/c76794549.lua

			Duel.Hint(HINT_SELECTMSG,tp,HINTMSG_ATOHAND)
			local sg=Duel.SelectMatchingCard(tp,c76794549.thfilter2,tp,LOCATION_DECK,0,1,1,nil,cg:GetFirst():GetCode())
			Duel.SendtoHand(sg,nil,REASON_EFFECT)
			Duel.ConfirmCards(1-tp,sg)
		end

Spellbook of the Grand Circle (11911336)

Source: Scripts/c11911336.lua

	Duel.Hint(HINT_SELECTMSG,tp,HINTMSG_ATOHAND)
	local sg=g:SelectSubGroup(tp,aux.dabcheck,false,4,4)
	if Duel.SendtoHand(sg,nil,REASON_EFFECT)>0 then
		Duel.ConfirmCards(1-tp,sg)
		if sg:IsExists(Card.IsLocation,1,nil,LOCATION_HAND) and Duel.GetFieldGroupCount(tp,LOCATION_HAND,0)>1 then