Effect.SetDescription

Signature

Effect.SetDescription(Effect e, int desc) -> void

Description

Sets e's description id, usually produced with Auxiliary.Stringid for card text choices.

How To Use It

Descriptions are integer string ids, not raw text.

Most card scripts use aux.Stringid(id,n) to point at the nth string for that card:

e1:SetDescription(aux.Stringid(id,0))

Descriptions are commonly shown for optional triggers, selectable effects, and effects registered to Spell/Trap activations.

Related Functions

• Auxiliary.Stringid
• Duel.Hint

Parameters

• e Effect
• desc int

Source

• D:\Programs\GitHub\ygopro-core\libeffect.cpp:612

Guided Examples

Learn how to use this function in context:

• Card Data And Script Wiring

Used By

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

• Detected in 9207 indexed script(s).
• Search this function in the Script Explorer with Effect.SetDescription.

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

Script Examples

Astrograph Sorcerer, the Starfrost Magician (48171151)

Source: Scripts/c48171151.lua

	--place
	local e1=Effect.CreateEffect(c)
	e1:SetDescription(aux.Stringid(id,0))
	e1:SetCategory(CATEGORY_DESTROY)
	e1:SetType(EFFECT_TYPE_IGNITION)

Artmage Non-Finito (74631897)

Source: Scripts/c74631897.lua

	--set
	local e4=Effect.CreateEffect(c)
	e4:SetDescription(aux.Stringid(id,0))
	e4:SetCategory(CATEGORY_SSET)
	e4:SetType(EFFECT_TYPE_SINGLE+EFFECT_TYPE_TRIGGER_O)

Pendulum Evolution (55795155)

Source: Scripts/c55795155.lua

	--to hand
	local e2=Effect.CreateEffect(c)
	e2:SetDescription(aux.Stringid(55795155,0))
	e2:SetCategory(CATEGORY_SEARCH+CATEGORY_TOHAND)
	e2:SetType(EFFECT_TYPE_IGNITION)