Duel.GetLocationCount

Signature

Duel.GetLocationCount(int player, int location, [int use_player], [int reason], [int zone]) -> int,int

Description

Returns how many zones of location are available on player's field and the corresponding usable zone mask. location is normally LOCATION_MZONE or LOCATION_SZONE. use_player, reason, and zone are used by effects that restrict where cards can be placed, such as Kaiser Colosseum-style restrictions. The count can be negative, so scripts that free a zone as a cost sometimes check ft > -1 instead of ft > 0.

Parameters

• player int - Player whose field is checked.
• location int - Location to count, normally LOCATION_MZONE or LOCATION_SZONE.
• use_player int optional - Player treated as placing the card. Defaults to the current reason player.
• reason int optional - Placement reason such as LOCATION_REASON_TOFIELD or LOCATION_REASON_CONTROL. Defaults to LOCATION_REASON_TOFIELD.
• zone int optional - Zone mask to restrict the count. Defaults to 0xff.

Returns

• int - Available zone count. The core comment notes this can be negative.
• int - Usable zone mask.

Source

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

Guided Examples

Learn how to use this function in context:

• Activation Legality
• Common Script Errors And Debugging
• Field Zones And Sequences
• Pendulum Procedure Guide
• Special Summon-Only Monster Guide
• Tribute Summon Materials

Used By

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

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

Card	ID	Script	Detected Calls
Astrograph Sorcerer, the Starfrost Magician	48171151	Scripts/c48171151.lua	2
Pendulum Evolution	55795155	Scripts/c55795155.lua	2
Levia-Dragoon - Daedalus	78579058	Scripts/c78579058.lua	2
Lady's Dragonmaid	48658295	Scripts/c48658295.lua	2
Azure Ocean Dragon Lord - Neo-Daedalus Rage	41570943	Scripts/c41570943.lua	2
Eternal Favorite	87532344	Scripts/c87532344.lua	1
Surprise Fusion	35167375	Scripts/c35167375.lua	1
Astrograph Sorcerer	76794549	Scripts/c76794549.lua	3
Ultra Polymerization	76647978	Scripts/c76647978.lua	2
Goyo Emperor	59255742	Scripts/c59255742.lua	4
Accel Synchro Stardust Dragon	30983281	Scripts/c30983281.lua	2
Ashtraja Susanoo	17020474	Scripts/c17020474.lua	3
Deftero Enneacraft - "alazoneIA"	92171126	Scripts/c92171126.lua	2
Destiny HERO - Destro-Dogma	25158975	Scripts/c25158975.lua	1
Yomagna the Fire Phantom	17350692	Scripts/c17350692.lua	1
Fiendsmith's Sequence	49867899	Scripts/c49867899.lua	2
D/D/D Alfred the Divine Sage King	11852093	Scripts/c11852093.lua	3
Favorite HERO Flame Wingman	13243124	Scripts/c13243124.lua	1
Invoked Sorath	43989315	Scripts/c43989315.lua	1
Performage Cup Tricker	6812770	Scripts/c6812770.lua	1
Ehther the Heavenly Monarch	96570609	Scripts/c96570609.lua	2
Spirit Illusion	71939275	Scripts/c71939275.lua	2
Pere-Zenet Em Heru	46273941	Scripts/c46273941.lua	1
Am Duazenet	45151304	Scripts/c45151304.lua	1
...and 5350 more

Script Examples

Astrograph Sorcerer, the Starfrost Magician (48171151)

Source: Scripts/c48171151.lua

	if not c:IsCanBeSpecialSummoned(e,0,tp,false,false) or not c:IsControler(tp) then return false end
	if c:IsLocation(LOCATION_EXTRA) then return c:IsFaceup() and Duel.GetLocationCountFromEx(tp,tp,nil,c)>0 end
	if c:IsLocation(LOCATION_GRAVE) then return aux.NecroValleyFilter()(c) and Duel.GetLocationCount(tp,LOCATION_MZONE)>0 end
	return false
end

Pendulum Evolution (55795155)

Source: Scripts/c55795155.lua

		if lpz==nil or rpz==nil then return false end
		local loc=0
		if Duel.GetLocationCount(tp,LOCATION_MZONE)>0 then loc=loc+LOCATION_HAND end
		if Duel.GetLocationCountFromEx(tp,tp,nil,TYPE_PENDULUM)>0 then loc=loc+LOCATION_EXTRA end
		if loc==0 then return false end

Levia-Dragoon - Daedalus (78579058)

Source: Scripts/c78579058.lua

end
function s.sptg(e,tp,eg,ep,ev,re,r,rp,chk)
	if chk==0 then return Duel.GetLocationCount(tp,LOCATION_MZONE)>0
		and Duel.IsExistingMatchingCard(s.spfilter,tp,LOCATION_DECK,0,1,nil,e,tp) end
	Duel.SetOperationInfo(0,CATEGORY_SPECIAL_SUMMON,nil,1,tp,LOCATION_DECK)