The work of a Psynergy effect scene: its caster and target, where it takes place, the map state it restores and its 24 effect slots. More...
#include <battle/fx_scene.h>
Data Fields | |
| s32 | angle |
| 1/65536 turns | |
| s32 | x |
| 16.16 fixed-point pixels | |
| s32 | y |
| 16.16 fixed-point pixels | |
| s32 | z |
| 16.16 fixed-point pixels | |
| void * | mainObject |
| the caster's object | |
| void * | child |
| the target's object, or NULL | |
| s16 | firstObjectId |
| the caster's object id | |
| s16 | secondObjectId |
| the target's object id, -1 for none | |
| u16 | action |
| the ability id | |
| s16 | fieldKind |
| the ability's field kind (FIELD_KIND_) | |
| s8 | enabled |
| Set at the start: Force then aims in front of the caster; cleared once the target has been dispatched. | |
| u8 | mode |
| where the effect runs; MODE_WORLD_MAP on the world map | |
| s8 | visible |
| set at the start: the caster flashes with a sound | |
| s8 | active |
| set at the start: the ability's name is announced | |
| void(*) | finishCallback (void) |
| run, when set, as Ply's effect ends | |
| u8 | unk28 [0x0c] |
| not named by TBS code | |
| s8 | childOption |
| Set by some scenes before an effect; Carry, Frost, Force and Reveal treat the target differently with it. | |
| s8 | childMode |
| set by some scenes: Frost and Force leave the target be | |
| u8 | unk36 [2] |
| not named by TBS code | |
| u8 | unk40 [4] |
| not named by TBS code | |
| u8 | savedPalette |
| the target's first sprite's param, saved likewise | |
| u8 | lit |
| set in two Mercury Lighthouse maps; not read by name | |
| u16 | tileSlot |
| resource entry holding the spark tiles | |
| u16 | unk48 |
| not named by TBS code | |
| u16 | freeBlocks |
| 512 less the free resource blocks at the start | |
| struct EffectSlot | slots [24] |
| u8 | unk718 [2] |
| not named by TBS code | |
| s16 | arcTileSlot |
| resource entry of Avoid's and Retreat's arcs | |
| s8 | messageMode |
| the announcement's box mode: 1, a scene adds 8 | |
| u8 | unk71d [3] |
| not named by TBS code | |
| void(*) | savedCallback (union FieldObject *object) |
| The target's update hook and script, saved at the start and restored when Move or Carry lets it go. | |
| const s32 * | savedScript |
| s32 | savedShakeX |
| The map's shake and its decay, restored when the effect ends. | |
| s32 | savedShakeY |
| s32 | savedShakeDecay |
The work of a Psynergy effect scene: its caster and target, where it takes place, the map state it restores and its 24 effect slots.
Definition at line 31 of file fx_scene.h.
| s32 BattleFxScene::angle |
1/65536 turns
Definition at line 32 of file fx_scene.h.
Referenced by BattleEffect_SpawnBurstParticleField(), BattleFx_SetupObjectPair(), BattleFx_SteerPushedTarget(), BattleFx_UpdateRadialBurst(), FieldFx_RunCatch(), and FieldFx_RunForce().
| s32 BattleFxScene::x |
16.16 fixed-point pixels
Definition at line 33 of file fx_scene.h.
Referenced by BattleEffect_RunFallbackObjectTransition(), BattleEffect_SpawnBurstParticleField(), BattleFx_RunSparkEmitter(), BattleFx_SetupObjectPair(), BattleFx_SteerLiftedTarget(), BattleFx_UpdateRadialCamera(), BattleFx_UpdateShrinkingOrbitObject(), FieldFx_RunCatch(), FieldFx_RunForce(), FieldFx_RunFrost(), FieldFx_RunLiftOnTarget(), FieldFx_RunPly(), and FieldFx_RunWhirlwind().
| s32 BattleFxScene::y |
16.16 fixed-point pixels
Definition at line 34 of file fx_scene.h.
Referenced by BattleEffect_RunFallbackObjectTransition(), BattleEffect_SpawnBurstParticleField(), BattleFx_RunSparkEmitter(), BattleFx_SetupObjectPair(), BattleFx_SteerLiftedTarget(), BattleFx_UpdateRadialCamera(), BattleFx_UpdateShrinkingOrbitObject(), FieldFx_RunCatch(), FieldFx_RunForce(), FieldFx_RunFrost(), FieldFx_RunLiftOnTarget(), FieldFx_RunPly(), and FieldFx_RunWhirlwind().
| s32 BattleFxScene::z |
16.16 fixed-point pixels
Definition at line 35 of file fx_scene.h.
Referenced by BattleEffect_RunFallbackObjectTransition(), BattleEffect_SpawnBurstParticleField(), BattleFx_RunSparkEmitter(), BattleFx_SetupObjectPair(), BattleFx_SteerLiftedTarget(), BattleFx_UpdateRadialCamera(), BattleFx_UpdateShrinkingOrbitObject(), FieldFx_RunCatch(), FieldFx_RunForce(), FieldFx_RunFrost(), FieldFx_RunLiftOnTarget(), FieldFx_RunPly(), and FieldFx_RunWhirlwind().
| void* BattleFxScene::mainObject |
the caster's object
Definition at line 36 of file fx_scene.h.
Referenced by AltmillerCave_BeginRetreat(), BattleEffect_RunFallbackObjectTransition(), BattleFx_SetupObjectPair(), BattleFx_SpawnDescendingArcParticles(), BattleFx_SpawnScaledArcObjects(), BattleFx_SteerLiftedTarget(), BattleFx_SteerPushedTarget(), BattleFx_UpdateRadialBurst(), BattleFx_UpdateRadialLaunch(), EffectRuntime_StopCurrentObject(), EventObject_Initialize(), FieldFx_RunAvoid(), FieldFx_RunCatch(), FieldFx_RunForce(), FieldFx_RunLiftOnTarget(), FieldFx_RunMove(), FieldFx_RunPly(), FieldFx_RunRetreat(), FieldFx_RunWhirlwind(), and Object_Spawn().
| void* BattleFxScene::child |
the target's object, or NULL
Definition at line 37 of file fx_scene.h.
Referenced by BattleFx_ClearChildValueOnMismatch(), BattleFx_DispatchRequestKind(), BattleFx_MarkChildAndRunFallbackTransition(), BattleFx_SetupObjectPair(), BattleFx_SpawnFallingParticles(), BattleFx_SteerLiftedTarget(), BattleFx_SteerPushedTarget(), FieldFx_RunCatch(), FieldFx_RunForce(), FieldFx_RunFrost(), FieldFx_RunFrostOnTarget(), FieldFx_RunGrowthOnTarget(), FieldFx_RunLiftOnTarget(), FieldFx_RunWhirlwind(), SolSanctumEruption_SpawnEffectPair(), ValeBabi_SpawnEffectPair(), ValeHome_SpawnEffectPair(), ValeStorm_SpawnEffectPair(), VenusLighthouseAerie_SpawnLinkedPairEffects(), and WorldMap_CreateLinkedEffects().
| s16 BattleFxScene::firstObjectId |
the caster's object id
Definition at line 38 of file fx_scene.h.
Referenced by AltmillerCave_BeginRetreat(), BattleFx_DispatchRequestKind(), BattleFx_Run(), BattleFx_SetupObjectPair(), and FieldFx_RunRetreat().
| s16 BattleFxScene::secondObjectId |
the target's object id, -1 for none
Definition at line 39 of file fx_scene.h.
Referenced by BattleFx_ClearChildValueOnMismatch(), BattleFx_DispatchRequestKind(), BattleFx_Run(), and BattleFx_SetupObjectPair().
| u16 BattleFxScene::action |
the ability id
Definition at line 40 of file fx_scene.h.
Referenced by BattleFx_LoadActionEffectResources(), and EventObject_Initialize().
| s16 BattleFxScene::fieldKind |
the ability's field kind (FIELD_KIND_)
Definition at line 41 of file fx_scene.h.
Referenced by BattleEffect_CleanupSceneObjects(), BattleFx_ClearChildValueOnMismatch(), BattleFx_DispatchRequestKind(), BattleFx_LoadActionEffectResources(), BattleFx_Run(), and FieldEvent_RunTypeHandler().
| s8 BattleFxScene::enabled |
Set at the start: Force then aims in front of the caster; cleared once the target has been dispatched.
Definition at line 44 of file fx_scene.h.
Referenced by BattleFx_DispatchRequestKind(), BattleFx_LoadActionEffectResources(), FieldFx_RunCatch(), FieldFx_RunForce(), FieldFx_RunFrost(), FieldFx_RunFrostOnTarget(), FieldFx_RunPly(), and FieldFx_RunWhirlwind().
| u8 BattleFxScene::mode |
where the effect runs; MODE_WORLD_MAP on the world map
Definition at line 45 of file fx_scene.h.
Referenced by AltmillerCave_ReleaseWallBurst(), BattleFx_LoadActionEffectResources(), and EventObject_Initialize().
| s8 BattleFxScene::visible |
set at the start: the caster flashes with a sound
Definition at line 46 of file fx_scene.h.
Referenced by BattleFx_LoadActionEffectResources(), and EventObject_Initialize().
| s8 BattleFxScene::active |
set at the start: the ability's name is announced
Definition at line 47 of file fx_scene.h.
Referenced by AltmillerCave_ReleaseWallBurst(), BattleFx_LoadActionEffectResources(), and EventObject_Initialize().
| void(*) BattleFxScene::finishCallback(void) |
run, when set, as Ply's effect ends
Definition at line 48 of file fx_scene.h.
Referenced by FieldFx_RunPly().
| u8 BattleFxScene::unk28[0x0c] |
not named by TBS code
Definition at line 49 of file fx_scene.h.
| s8 BattleFxScene::childOption |
Set by some scenes before an effect; Carry, Frost, Force and Reveal treat the target differently with it.
Definition at line 52 of file fx_scene.h.
Referenced by AltmillerCave_EndReveal(), BabiLighthouse_EnableChildOption(), Event_DouseCastAtStorm(), Event_StartDousingTravelMarker(), FieldFx_RunForce(), FieldFx_RunFrost(), Fuchin_EndRevealLighting(), and ResetSceneTransitionEffect().
| s8 BattleFxScene::childMode |
set by some scenes: Frost and Force leave the target be
Definition at line 53 of file fx_scene.h.
Referenced by AltmillerCave_CheckFrostTargetCollision(), AltmillerCave_FreezePuddle(), DebugMenu_EnableEffectChildMode(), Event_PrepareForce(), FieldFx_RunForce(), FieldFx_RunFrostOnTarget(), and ItemLevel_EnableEffectChildMode().
| u8 BattleFxScene::unk36[2] |
not named by TBS code
Definition at line 54 of file fx_scene.h.
| void(*) BattleFxScene::savedCallback(union FieldObject *object) |
The target's update hook and script, saved at the start and restored when Move or Carry lets it go.
Definition at line 58 of file fx_scene.h.
Referenced by BattleFx_SetupObjectPair().
| const s32* BattleFxScene::savedScript |
Definition at line 59 of file fx_scene.h.
Referenced by BattleFx_SetupObjectPair().
| u8 BattleFxScene::unk40[4] |
not named by TBS code
Definition at line 61 of file fx_scene.h.
| u8 BattleFxScene::savedPalette |
the target's first sprite's param, saved likewise
Definition at line 62 of file fx_scene.h.
Referenced by BattleFx_SetupObjectPair().
| u8 BattleFxScene::lit |
set in two Mercury Lighthouse maps; not read by name
Definition at line 63 of file fx_scene.h.
Referenced by BattleFx_LoadActionEffectResources().
| u16 BattleFxScene::tileSlot |
resource entry holding the spark tiles
Definition at line 64 of file fx_scene.h.
Referenced by BattleEffect_CleanupSceneObjects(), BattleFx_LoadActionEffectResources(), BattleFx_SpawnScaledArcObjects(), SolSanctumEruption_SpawnEffectPair(), ValeBabi_SpawnEffectPair(), ValeHome_SpawnEffectPair(), ValeStorm_SpawnEffectPair(), VenusLighthouseAerie_SpawnLinkedPairEffects(), and WorldMap_CreateLinkedEffects().
| u16 BattleFxScene::unk48 |
not named by TBS code
Definition at line 65 of file fx_scene.h.
| u16 BattleFxScene::freeBlocks |
512 less the free resource blocks at the start
Definition at line 66 of file fx_scene.h.
Referenced by BattleFx_LoadActionEffectResources().
| s32 BattleFxScene::savedShakeX |
The map's shake and its decay, restored when the effect ends.
Definition at line 69 of file fx_scene.h.
Referenced by BattleEffect_CleanupSceneObjects(), and BattleFx_LoadActionEffectResources().
| s32 BattleFxScene::savedShakeY |
Definition at line 70 of file fx_scene.h.
Referenced by BattleEffect_CleanupSceneObjects(), and BattleFx_LoadActionEffectResources().
| s32 BattleFxScene::savedShakeDecay |
Definition at line 71 of file fx_scene.h.
Referenced by BattleEffect_CleanupSceneObjects(), and BattleFx_LoadActionEffectResources().
| struct EffectSlot BattleFxScene::slots[24] |
Definition at line 73 of file fx_scene.h.
Referenced by AltmillerCave_ReleaseWallBurst(), BattleEffect_CleanupSceneObjects(), BattleEffect_RunFallbackObjectTransition(), BattleFx_ClearActiveSlotsAndScheduleUpdates(), BattleFx_RunMercuryDjinnCapture(), BattleFx_RunVenusDjinnCapture(), Djinn_RunJupiterJoinEffect(), Djinn_RunMarsJoinEffect(), FieldFx_RunForce(), FieldFx_RunRetreat(), and FieldFx_UpdateSceneSlots().
| u8 BattleFxScene::unk718[2] |
not named by TBS code
Definition at line 74 of file fx_scene.h.
| s16 BattleFxScene::arcTileSlot |
resource entry of Avoid's and Retreat's arcs
Definition at line 75 of file fx_scene.h.
Referenced by BattleFx_SpawnDescendingArcParticles(), and FieldFx_RunAvoid().
| s8 BattleFxScene::messageMode |
the announcement's box mode: 1, a scene adds 8
Definition at line 76 of file fx_scene.h.
Referenced by BattleFx_LoadActionEffectResources(), EventObject_Initialize(), and MercuryLighthouse_MiaCastsPlyOnEntrance().
| u8 BattleFxScene::unk71d[3] |
not named by TBS code
Definition at line 77 of file fx_scene.h.