include/unit/effect

struct BattleEffectIndexWindow

What BattleFx_BuildCenteredIndexList (unused) reads: a value to find in a list, and how many indices either side of it to keep.

Field	Declared as
`unk_00`	`s32 unk_00[3]`	not named by TBS code
`currentValue`	`s32 currentValue`	the value looked for in values
`indexRadius`	`s32 indexRadius`	indices kept either side of where it sits
`entryLimit`	`s32 entryLimit`	indices from this up are dropped
`unk_18`	`s32 unk_18[3]`	not named by TBS code
`values`	`s16 values[1]`	indexRadius * 2 + 1 values, searched in order

Used by BattleFx_BuildCenteredIndexList.

Line 209

Point2D

struct Point2D

Two-dimensional {x, y} pair for position or velocity, a local of the summon scenes (Nereid, Procne, Tiamat and Ramses).

Field	Declared as
`x`	`s32 x`	16.16 pixels in every scene that uses it
`y`	`s32 y`	16.16 pixels

Used by BattleFx_RunDragonCloud, BattleFx_RunNereid, BattleFx_RunPaletteParticles, BattleFx_RunProcne, BattleFx_RunRamses.

Line 236

Value	=
`SCENE_EFFECT_RAMSES`	`1`	BattleFx_RunRamses (ramses.c)
`SCENE_EFFECT_NEREID`		BattleFx_RunNereid (nereid.c)
`SCENE_EFFECT_KIRIN`		BattleFx_RunKirin (kirin.c)
`SCENE_EFFECT_ATALANTA`		BattleFx_RunAtalanta (atalanta.c)
`SCENE_EFFECT_CYBELE`		BattleFx_RunCybele (cybele.c)
`SCENE_EFFECT_NEPTUNE`		BattleFx_RunNeptune (neptune.c)
`SCENE_EFFECT_TIAMAT`		BattleFx_RunTiamat (tiamat.c)
`SCENE_EFFECT_PROCNE`		BattleFx_RunProcne (procne.c)
`SCENE_EFFECT_JUDGMENT`		BattleFx_RunJudgment (judgment.c)
`SCENE_EFFECT_BOREAS`		BattleFx_RunBoreas (boreas.c)
`SCENE_EFFECT_METEOR`		BattleFx_RunMeteor (particle_streams.c)
`SCENE_EFFECT_THOR`		BattleFx_RunThor (thor.c)

Effect kinds: the kind an ability's gBattle_ActionFlags entry selects, by the handler that plays it; a later kind that shares a handler adds its number. Kinds without a handler have no name. Kind 0 is the dispatcher's.

Value	=
`BATTLE_FX_QUAKE`	`1`
`BATTLE_FX_SPIRE`	`2`
`BATTLE_FX_GAIA`	`3`
`BATTLE_FX_GROWTH`	`4`
`BATTLE_FX_THORN`	`5`
`BATTLE_FX_FROST`	`6`
`BATTLE_FX_ICE`	`7`
`BATTLE_FX_PRISM`	`8`
`BATTLE_FX_DOUSE`	`9`
`BATTLE_FX_FROTH`	`10`
`BATTLE_FX_FLARE`	`11`
`BATTLE_FX_FIRE`	`12`
`BATTLE_FX_VOLCANO`	`13`
`BATTLE_FX_BLAST`	`14`
`BATTLE_FX_NOVA`	`15`
`BATTLE_FX_BOLT`	`16`
`BATTLE_FX_RAY`	`17`
`BATTLE_FX_PLASMA`	`18`
`BATTLE_FX_SLASH`	`19`
`BATTLE_FX_WHIRLWIND`	`20`
`BATTLE_FX_CURE`	`21`
`BATTLE_FX_PLY`	`22`
`BATTLE_FX_WISH`	`23`
`BATTLE_FX_CURE_POISON`	`24`
`BATTLE_FX_REVIVE`	`25`
`BATTLE_FX_IMPACT`	`26`
`BATTLE_FX_DULL`	`27`
`BATTLE_FX_GUARD`	`28`
`BATTLE_FX_IMPAIR`	`29`
`BATTLE_FX_WARD`	`30`
`BATTLE_FX_WEAKEN`	`31`
`BATTLE_FX_TAINT`	`32`
`BATTLE_FX_DELUDE`	`33`
`BATTLE_FX_ORBITING_SPIRALS`	`34`	no ability uses it
`BATTLE_FX_HEARTRENDER`	`35`
`BATTLE_FX_PARALYZE`	`36`
`BATTLE_FX_SLEEP`	`37`
`BATTLE_FX_BIND`	`38`
`BATTLE_FX_HAUNT`	`39`
`BATTLE_FX_CONDEMN`	`40`
`BATTLE_FX_CURSE`	`41`
`BATTLE_FX_DRAIN`	`42`
`BATTLE_FX_BREAK`	`43`
`BATTLE_FX_WISH_44`	`44`
`BATTLE_FX_WISH_45`	`45`
`BATTLE_FX_IMPACT_46`	`46`
`BATTLE_FX_IMPAIR_47`	`47`
`BATTLE_FX_DRAGON_CLOUD`	`49`
`BATTLE_FX_DEMON_NIGHT`	`50`
`BATTLE_FX_HELM_SPLITTER`	`51`
`BATTLE_FX_QUICK_STRIKE`	`52`
`BATTLE_FX_DEATH_PLUNGE`	`53`
`BATTLE_FX_SHURIKEN`	`54`
`BATTLE_FX_ANNIHILATION`	`55`
`BATTLE_FX_PUNJI`	`56`
`BATTLE_FX_CUTTING_EDGE`	`57`
`BATTLE_FX_RAGNAROK`	`58`
`BATTLE_FX_HEAT_WAVE`	`59`
`BATTLE_FX_PLANET_DIVER`	`60`
`BATTLE_FX_TITAN_BLADE`	`61`
`BATTLE_FX_SHINING_STAR`	`62`
`BATTLE_FX_BLIZZARD`	`63`
`BATTLE_FX_DEMON_FIRE`	`64`
`BATTLE_FX_VORPAL_SLASH`	`65`
`BATTLE_FX_DROWN`	`66`
`BATTLE_FX_TRIANGLE_STRIKE`	`67`	no ability uses it
`BATTLE_FX_ASTRAL_BLAST`	`68`
`BATTLE_FX_GRANITE`	`200`
`BATTLE_FX_REVIVE_201`	`201`
`BATTLE_FX_VINE`	`202`
`BATTLE_FX_GROUND`	`203`
`BATTLE_FX_PLY_204`	`204`
`BATTLE_FX_SLEET`	`205`
`BATTLE_FX_WISH_206`	`206`
`BATTLE_FX_HAIL`	`207`
`BATTLE_FX_TONIC`	`208`
`BATTLE_FX_DEW`	`209`
`BATTLE_FX_IMPACT_210`	`210`
`BATTLE_FX_GUARD_211`	`211`
`BATTLE_FX_PSY_CRYSTAL`	`212`
`BATTLE_FX_FLASH`	`213`
`BATTLE_FX_TORCH`	`214`
`BATTLE_FX_WARD_215`	`215`
`BATTLE_FX_ZEPHYR`	`216`
`BATTLE_FX_KITE`	`217`
`BATTLE_FX_BIND_218`	`218`
`BATTLE_FX_GUST`	`219`
`BATTLE_FX_VENUS`	`250`
`BATTLE_FX_MERCURY`	`251`
`BATTLE_FX_MARS`	`252`
`BATTLE_FX_JUPITER`	`253`
`BATTLE_FX_SONIC_WAVE`	`300`
`BATTLE_FX_SHRIEK`	`301`
`BATTLE_FX_BANSHEE_HOWL`	`302`
`BATTLE_FX_CRAZY_VOICE`	`303`
`BATTLE_FX_WAR_CRY`	`304`
`BATTLE_FX_WICKED_HOWL`	`305`
`BATTLE_FX_WING_BEAT`	`306`
`BATTLE_FX_WING_FLUTTER`	`307`
`BATTLE_FX_RUMBLE`	`308`
`BATTLE_FX_BONE_CHILLER`	`309`
`BATTLE_FX_GUST_310`	`310`
`BATTLE_FX_BONE_CHARGE`	`311`
`BATTLE_FX_MYSTIC_FLAME`	`312`
`BATTLE_FX_NUMBING_STING`	`313`
`BATTLE_FX_BRUTE_FORCE`	`314`
`BATTLE_FX_STICKY_GOO`	`315`
`BATTLE_FX_CANNIBAL_FANG`	`316`
`BATTLE_FX_BEAR_CLAW`	`317`
`BATTLE_FX_POISONOUS_BITE`	`318`
`BATTLE_FX_FLYING_ATTACK`	`319`
`BATTLE_FX_UNDEAD_SWORD`	`320`
`BATTLE_FX_RANSACK`	`321`
`BATTLE_FX_STICKY_POISON`	`322`
`BATTLE_FX_POISONOUS_BITE_323`	`323`
`BATTLE_FX_ELECTRIC_BITE`	`324`
`BATTLE_FX_POISON_TAIL`	`325`
`BATTLE_FX_ONSLAUGHT`	`326`
`BATTLE_FX_VAMPIRIC_FANG`	`327`
`BATTLE_FX_BACTERIA_RUSH`	`328`
`BATTLE_FX_FLYING_ATTACK_329`	`329`
`BATTLE_FX_ROTTEN_BLOOD`	`330`
`BATTLE_FX_DOUBLE_FANG`	`332`
`BATTLE_FX_MORTAL_BLOW`	`333`
`BATTLE_FX_FREEBITE_RUSH`	`334`
`BATTLE_FX_TWIN_BEAKS`	`335`
`BATTLE_FX_RABID_FANG`	`336`
`BATTLE_FX_ACID_BITE`	`337`
`BATTLE_FX_DYNAMITE`	`338`
`BATTLE_FX_HEADBUTT`	`339`
`BATTLE_FX_POISON_INK`	`340`
`BATTLE_FX_BEAR_CLAW_342`	`342`
`BATTLE_FX_RANSACK_343`	`343`
`BATTLE_FX_SOOTHING_STAR`	`344`
`BATTLE_FX_SPIDER_WEB`	`345`
`BATTLE_FX_HEARTRENDER_346`	`346`
`BATTLE_FX_MAD_SPATTER`	`347`
`BATTLE_FX_SPASM`	`348`
`BATTLE_FX_SLEEP_STAR`	`349`
`BATTLE_FX_DECOMPOSE`	`350`
`BATTLE_FX_HAUNTING`	`351`
`BATTLE_FX_CURE_352`	`352`
`BATTLE_FX_BERSERK`	`353`
`BATTLE_FX_CURSE_354`	`354`
`BATTLE_FX_SMOKE_BOMB`	`380`
`BATTLE_FX_WING_STROKE`	`381`
`BATTLE_FX_POISON_BEAT`	`382`
`BATTLE_FX_SPINNING_BEAT`	`383`
`BATTLE_FX_OUTER_SPACE`	`384`
`BATTLE_FX_DRAGON_DRIVER`	`385`
`BATTLE_FX_DRAIN_FANG`	`386`
`BATTLE_FX_SPARK_APPROACH_VARIANT3`	`387`	no ability uses it
`BATTLE_FX_THRASH`	`388`
`BATTLE_FX_RECOVERY`	`389`
`BATTLE_FX_FIRE_BLESSING`	`400`
`BATTLE_FX_WATER_BLESSING`	`401`
`BATTLE_FX_ICE_BLESSING`	`402`
`BATTLE_FX_DARK_BLESSING`	`403`
`BATTLE_FX_ACID_BLESSING`	`404`
`BATTLE_FX_STORM_BLESSING`	`405`
`BATTLE_FX_EVIL_BLESSING`	`406`
`BATTLE_FX_DEADLY_GAS`	`407`
`BATTLE_FX_KIND_COUNT`	`408`	one more than the last kind

Line 37

Types

BattleFxHandler

typedef void (*BattleFxHandler)(struct BattleEffectArgument *effect);

An effect handler: plays one effect over the battle, frame by frame, and returns when it is over.

Used by gBattleFx_EffectHandlers.

Line 33

BlitterPair

typedef DrawRectangle BlitterPair[2];

A blitter pair: [0] built in HEAP_SLOT_BLITTER and [1] in HEAP_SLOT_BLITTER_ALTERNATE (BattleFx_FetchRectangleBlitters fills one). Many effects keep this pair in their stack frame.

Used by BattleFx_FetchRectangleBlitters, BattleFx_RunAstralBlast, BattleFx_RunAtalanta, BattleFx_RunBeamSequence, BattleFx_RunBind, BattleFx_RunBladeRain, BattleFx_RunBolt, BattleFx_RunBurstScene, BattleFx_RunBurstShower, BattleFx_RunCastingImpact, BattleFx_RunCondemn, BattleFx_RunCybele, BattleFx_RunDeathPlunge, BattleFx_RunDjinnBeams, BattleFx_RunDjinnHeal, BattleFx_RunDjinniEntrance, BattleFx_RunElementBurst, BattleFx_RunElementPillar, BattleFx_RunEruption, BattleFx_RunFire, BattleFx_RunFrost, BattleFx_RunFroth, BattleFx_RunGaia, BattleFx_RunGatheringLights, BattleFx_RunGround, BattleFx_RunHail, BattleFx_RunHaunt, BattleFx_RunHealingMotes, BattleFx_RunIce, BattleFx_RunJupiter, BattleFx_RunLobbedShells, BattleFx_RunMars, BattleFx_RunMercury, BattleFx_RunMirroredWall, BattleFx_RunMoteFountain, BattleFx_RunNereid, BattleFx_RunOrbitingSkulls, BattleFx_RunOrbitingSpirals, BattleFx_RunPaletteParticles, BattleFx_RunPlanetDiver and 23 more.

Line 244

Macros

PARTICLES

#define PARTICLES ((struct EffectStep *)Ram_MapCellBuffer)

The map cell buffer (gMapCellBuffer), which the effects borrow, has two views here: Ram_MapCellBuffer as bytes, at its fixed address, and PARTICLES as particles. The effects use these two, not gMapCellBuffer itself.

Used by BattleFx_ArmWin0HBlankDma, BattleFx_RunAstralBlast, BattleFx_RunAtalanta, BattleFx_RunBolt, BattleFx_RunBoreas, BattleFx_RunBreak, BattleFx_RunBurstScene, BattleFx_RunDjinnBeams, BattleFx_RunDjinnHeal, BattleFx_RunDjinniEntrance, BattleFx_RunDrain, BattleFx_RunElementBurst, BattleFx_RunElementPillar, BattleFx_RunEruption, BattleFx_RunFire, BattleFx_RunFrost, BattleFx_RunGaia, BattleFx_RunGatheringLights, BattleFx_RunGrowingColumns, BattleFx_RunHail, BattleFx_RunHaunt, BattleFx_RunHealingMotes, BattleFx_RunHelmSplitter, BattleFx_RunImpactBurst, BattleFx_RunJudgment, BattleFx_RunJupiter, BattleFx_RunKirin, BattleFx_RunLobbedShells, BattleFx_RunMars, BattleFx_RunMercury, BattleFx_RunMoteFountain, BattleFx_RunNeptune, BattleFx_RunNereid, BattleFx_RunPaletteParticles, BattleFx_RunParticleStreams, BattleFx_RunPlasma, BattleFx_RunPrism, BattleFx_RunProcne, BattleFx_RunProjectileVolley, BattleFx_RunRagnarok and 15 more.