An animated sprite: its image and shadow, scale, rotation, size and up to four animation layers. More...
#include <field/animspr.h>
Data Fields | |
| struct AnimationSpritePart | image |
| struct AnimationSpritePart | shadow |
| s32 | scale |
| 16.16 fixed point, 0x10000 full size | |
| u8 | slot |
| VRAM cache entry holding its tiles. | |
| u8 | retainCacheEntry: 1 |
| Keeps the VRAM cache entry when it is released or off screen. | |
| u8 | useOwnScale: 1 |
| Drawn at its own scale, not scaled by distance (fixed camera). | |
| u8 | unk1d2: 6 |
| not named by TBS code | |
| u16 | rotation |
| 1/65536 turns | |
| u8 | width |
| pixels; zero marks a free sprite | |
| u8 | height |
| pixels | |
| s8 | offsetX |
| pixels | |
| s8 | offsetY |
| pixels | |
| u8 | lastNo |
| The animation number last selected, which selecting again skips. | |
| u8 | dirty |
| nonzero redraws its pixels into VRAM when next drawn | |
| u8 | flags |
| bits: 1 outlined in ObjectSystemWork's edge and fill colours | 0 shadow drawn (set when created) | |
| u8 | count |
| layers in use, up to the last one present | |
| struct AnimationEntry * | entries [4] |
| its layers; empty ones null | |
An animated sprite: its image and shadow, scale, rotation, size and up to four animation layers.
| struct AnimationSpritePart AnimationObject::image |
Definition at line 109 of file animspr.h.
Referenced by BabiPalace_ApplyEntryState(), BattleActor_UpdateSpritePriorities(), BattleEffect_UpdatePhasedRadialParticle(), BattleFx_RunBoreas(), BattleFx_RunGaia(), BattleFx_RunJudgment(), BattleFx_RunKirin(), BattleFx_RunParticleStreams(), BattleFx_RunRamses(), BattleFx_SpawnItemBreakMode3(), BattleFx_SpawnObjects(), BattleFx_StartEffectObject22(), BattleFx_StartRandomParticleEmitter(), BattlePres_SetActorRecordMode(), Bilibin_SpawnRiverEffect(), Colosso_FadeInCompetitor(), Colosso_ShowItemIcon(), Effect_ConfigureSpawnedParticle(), Effect_InitializeMotion(), EffectSlot_Initialize(), Event_EnterJail(), Event_EnterJail(), Event_EnterNortheastHouse(), Event_EnterNortheastHouse(), Event_EnterNorthHouse(), Event_EnterNorthHouse(), Event_GatherAfterRiverRescue(), Event_HurryToThePlaza(), Event_Rock11Falls(), Event_ShowMythrilBag(), Event_UseBlackOrb(), FieldFx_SpawnBurstParticle(), FieldObject_UpdatePlayerControl(), GomaCavePillar_SpawnFragment(), Imil_InitializeRisingEffect(), ImilFuchinFalls_PlaceDragonsEye(), ImilFuchinFalls_SpawnDust(), Kolima_SpawnCurseSparkle(), Kolima_UpdateCurseDust(), KolimaForestBridge_SpawnCurseSparkle(), KolimaForestTree_SpawnRejectionSpark(), Lalivero_Initialize(), Menu_UpdateEntryObjectTransforms(), MercuryLighthouse_ArriveWithSparks(), MercuryLighthouse_ChargeLights(), MercuryLighthouse_RestoreLights(), MercuryLighthouse_SpawnSparkPair(), MercuryLighthouseAerie_FlickerBeacon(), Object_InitializeSparkle(), Object_MoveOnWorldMap(), Object_Spawn(), ObjectDispatch_SetChildBlendMode(), ObjectMotion_SetActionVariant(), ObjectSystem_UpdateCamera(), ObjectTable_Restore(), ObjectTable_Snapshot(), ObjectVisual_CopyAttributes(), OverlayObject_SpawnKind24AtObject(), OverlayObject_SpawnKind24AtObject(), PsynergyMenu_InitializeEntryObjects(), Render_ApplyProjectedPlacement(), Render_PlaceProjectedSprite(), Render_PlaceSpritePartPair(), Sanctum_RaiseItemIcon(), Sanctum_ShowHealerAfterimage(), Sanctum_SpawnActorSpark(), Sanctum_SpawnOrbitingEffect(), SaveMenu_ShowDjinnSprites(), SaveMenu_ShowPartySprites(), SolSanctumElementalStarRoom_PresentStar(), SolSanctumEruption_PlayWiseOneRescue(), SolSanctumEruption_RaiseElementalArcs(), SolSanctumEruption_SpawnEffectPair(), TolbiShipInteriors_LayFlat(), TolbiShipInteriors_PlaceAnchorCharm(), TolbiShipMast_ShrinkAndStopActor(), ValeBabi_SpawnEffectPair(), ValeHome_SpawnEffectPair(), ValeStorm_CopyLeaderSpritePriority(), ValeStorm_ShowBoulderSweepingDownriver(), ValeStorm_SpawnEffectPair(), Vault_OpenDoorwayAndEnter(), Vault_SpawnDriftingEffect(), VaultInteriors_DefeatThieves(), VaultInteriors_SetPartyImagePriority(), VenusLighthouse_CreateBlendedPassageEffect(), VenusLighthouse_CreateOccludingPassageEffect(), VenusLighthouse_ReleaseFallenCarryBlock(), VenusLighthouseAerie_CombineSaturosAndMenardi(), VenusLighthouseAerie_SpawnLinkedPairEffects(), VenusLighthouseAerie_SpawnSideOrbitParticles(), VenusLighthouseAerie_SpawnUpperOrbitParticles(), VenusLighthouseAerie_UpdateBeaconRise(), WorldMap_CreateLinkedEffects(), WorldMap_SpawnActorEightPuff(), and WorldMap_UpdateTransitionEffect().
| struct AnimationSpritePart AnimationObject::shadow |
Definition at line 110 of file animspr.h.
Referenced by BattlePres_SetActorRecordMode(), Colosso_FadeInCompetitor(), ObjectMotion_SetActionVariant(), ObjectSystem_UpdateCamera(), ObjectTable_Restore(), Render_ApplyProjectedPlacement(), Render_PlaceProjectedSprite(), Render_PlaceSpritePartPair(), and TolbiShipInteriors_LayFlat().
| s32 AnimationObject::scale |
16.16 fixed point, 0x10000 full size
Definition at line 111 of file animspr.h.
Referenced by Animation_InitializeObjects(), BattleActor_SpawnObjectsForList(), BattleFx_DrawScaledObject(), BattleFx_RunJudgment(), BattleFx_SpawnItemBreakMode3(), BattleMotion_ProjectConditionalPosition(), BattleMotion_ProjectPosition(), BattleMotion_ProjectScaledPosition(), BattleUnit_ProjectToScreen(), Event_RiseToElementalStarRoom(), Event_SpawnObjectTable(), FieldFx_RunForce(), FourObjectMotion_UpdateAllPositions(), FourObjectMotion_UpdateBottomRow(), Menu_UpdateEntryObjectTransforms(), ObjectSystem_UpdateCamera(), Render_PlaceProjectedSprite(), ResourceMetadata_Register(), SaveMenu_PlaceDjinnSprites(), SaveMenu_PlacePartySprites(), ValeStorm_ShowBoulderSweepingDownriver(), ValeStorm_UpdatePulsingGlow(), and WorldMap_UpdateTransitionEffect().
| u8 AnimationObject::slot |
VRAM cache entry holding its tiles.
Definition at line 112 of file animspr.h.
Referenced by BabiPalace_ApplyEntryState(), BattleEvent_Playback(), BattleFx_ClearOwnedSlot(), BattleFx_RunMercuryDjinnCapture(), BattleFx_SpawnScaledArcObjects(), BattleFx_StartEffectObject22(), BattleFx_StartRandomParticleEmitter(), BattlePres_SetActorRecordMode(), Colosso_ShowItemIcon(), Event_ShowMythrilBag(), Event_SpawnObjectTable(), Event_UseBlackOrb(), FieldFx_RunForce(), FieldFx_RunPly(), ImilFuchinFalls_PlaceDragonsEye(), Lalivero_Initialize(), Map_RenderAnimatedTileFrame(), ObjectSystem_UpdateCamera(), ObjectVisual_CopyAttributes(), Render_PlaceProjectedSprite(), ResourceObject_Create(), ResourceObject_Release(), Sanctum_ChooseRestartOption(), Sanctum_RaiseItemIcon(), SolSanctumElementalStarRoom_PresentStar(), SolSanctumEruption_PlayWiseOneRescue(), SolSanctumEruption_SpawnEffectPair(), Sprite_ShareVramCache(), TolbiShipInteriors_PlaceAnchorCharm(), TolbiShipInteriors_RunSceneCommand(), ValeBabi_CyclePaletteOnOddFrames(), ValeBabi_SpawnEffectPair(), ValeHome_SpawnEffectPair(), ValeStorm_SpawnEffectPair(), VenusLighthouseAerie_CombineSaturosAndMenardi(), VenusLighthouseAerie_SpawnLinkedPairEffects(), and WorldMap_CreateLinkedEffects().
| u8 AnimationObject::retainCacheEntry |
Keeps the VRAM cache entry when it is released or off screen.
Definition at line 114 of file animspr.h.
Referenced by Event_SpawnObjectTable(), ObjectGroup_ApplyRandomChildValues(), ObjectSystem_UpdateCamera(), Render_PlaceProjectedSprite(), ResourceObject_Release(), SolSanctumEruption_SpawnEffectPair(), Sprite_ShareVramCache(), ValeBabi_SpawnEffectPair(), ValeHome_SpawnEffectPair(), ValeStorm_SpawnEffectPair(), VenusLighthouseAerie_SpawnLinkedPairEffects(), and WorldMap_CreateLinkedEffects().
| u8 AnimationObject::useOwnScale |
Drawn at its own scale, not scaled by distance (fixed camera).
Definition at line 116 of file animspr.h.
Referenced by ObjectDispatch_SetChildFixedScale(), and Render_PlaceProjectedSprite().
| u16 AnimationObject::rotation |
1/65536 turns
Definition at line 118 of file animspr.h.
Referenced by AltinPeak_ForceRockOver(), Effect_AdvanceMotion(), Event_DoraWakesIsaac(), Event_KnockDownObstacle(), FieldFx_UpdateParticleMotionAndScale(), FieldObject_UpdatePlayerControl(), FuchinTemple_FehSeesChi(), FuchinTemple_FeizhiLeavesForHsu(), FuchinTemple_StudentsSeeTreeFall(), GomaCaveEntrance_SpinStump(), GomaCaveWaterway_SpinStump(), Kalay_UpdateNutOrbit(), Render_ApplyProjectedPlacement(), Render_PlaceProjectedSprite(), ResourceObject_Create(), SolSanctumEruption_PlayWiseOneRescue(), SolSanctumEruption_ThrowEruptionRing(), Ui_FillGridColumnFromMetadata(), VenusLighthouseAerie_StepSpriteRotation(), WorldMap_ApplyMapRotation(), WorldMap_ApplyMapRotationAndCollision(), and Xian_RotateTrainingTree().
| u8 AnimationObject::width |
pixels; zero marks a free sprite
Definition at line 119 of file animspr.h.
Referenced by Animation_InitializeObjects(), BattleActor_SpawnObjectsForList(), BattleEvent_Playback(), BattleStatusIcon_Cycle(), Map_RenderAnimatedTileFrame(), Render_ApplyProjectedPlacement(), Render_PlaceProjectedSprite(), Render_PlaceSpritePartPair(), ResourceMetadata_Register(), ResourceObject_Create(), and Ui_FindNextSpriteWithImage().
| u8 AnimationObject::height |
pixels
Definition at line 120 of file animspr.h.
Referenced by Animation_InitializeObjects(), BattleEvent_Playback(), BattleUnit_GetEffectHeight(), Map_RenderAnimatedTileFrame(), Render_ApplyProjectedPlacement(), Render_PlaceProjectedSprite(), Render_PlaceSpritePartPair(), ResourceMetadata_Register(), and SaveMenu_PlaceDjinnSprites().
| s8 AnimationObject::offsetX |
pixels
Definition at line 121 of file animspr.h.
Referenced by Animation_InitializeObjects(), AnimationObjects_SelectAnimation(), PsynergyMenu_InitializeEntryObjects(), Render_ApplyProjectedPlacement(), Render_PlaceProjectedSprite(), ResourceMetadata_Register(), and SolSanctumEruption_ThrowEruptionRing().
| s8 AnimationObject::offsetY |
pixels
Definition at line 122 of file animspr.h.
Referenced by Animation_InitializeObjects(), AnimationObjects_SelectAnimation(), Render_ApplyProjectedPlacement(), Render_PlaceProjectedSprite(), Render_PlaceSpritePartPair(), ResourceMetadata_Register(), Ui_FillGridColumnFromMetadata(), ValeStorm_FlickerGlowOffset(), ValeStorm_ShowBoulderSweepingDownriver(), and ValeStorm_UpdatePulsingGlow().
| u8 AnimationObject::lastNo |
The animation number last selected, which selecting again skips.
Definition at line 124 of file animspr.h.
Referenced by Actor_WaitForAnimationEnd(), AnimationObjects_SelectAnimation(), Event_SpawnObjectTable(), ObjectMotion_WaitForAnimationChange(), ObjectTable_Snapshot(), Sprite_ComposeAnimationFrame(), and VenusLighthouse_DispatchPushScript().
| u8 AnimationObject::dirty |
nonzero redraws its pixels into VRAM when next drawn
Definition at line 125 of file animspr.h.
Referenced by AltinPeak_StopLogAndJumpOff(), Animation_ApplyChildPalette(), BattleActor_UpdateSpritePriorities(), BattleStatusIcon_Cycle(), Colosso_ShowItemIcon(), FieldFx_BlinkAvoidCaster(), FieldFx_EndCloak(), FieldFx_RunAvoid(), FieldFx_StartCloak(), MercuryLighthouse_FollowLeader(), ObjectDispatch_ApplyValueToKind200Children(), ObjectGroup_ApplyIndexedChildValue(), ObjectGroup_ApplyRandomChildValues(), ObjectGroup_SetChildValue(), ObjectGroup_SetChildValueUnlessFifteen(), ObjectSystem_UpdateCamera(), Render_PlaceProjectedSprite(), ResourceObject_Create(), Sanctum_ShowHealerAfterimage(), Sprite_ComposeAnimationFrame(), Storm_SetActorFrameMode(), and SuhallaDesert_SetUpSecondSceneStorms().
| u8 AnimationObject::flags |
bits: 1 outlined in ObjectSystemWork's edge and fill colours | 0 shadow drawn (set when created)
Definition at line 128 of file animspr.h.
Referenced by BattleActor_SpawnObjectsForList(), BattleFx_ConfigureLinkedObject(), BattleFx_RunGaia(), BattleFx_RunJudgment(), BattleFx_SpawnLinked(), BattleFx_SpawnScaledArcObjects(), BattleFx_StartEffectObject22(), BattleFx_StartRandomParticleEmitter(), Bilibin_SpawnRiverEffect(), Colosso_ShowItemIcon(), EffectSlot_Initialize(), Event_RiseToElementalStarRoom(), Event_UseBlackOrb(), Field_ClimbUp(), Field_TryJumpForward(), FieldFx_BlinkAvoidCaster(), FieldFx_EndCloak(), FieldFx_RunAvoid(), FieldFx_SpawnBurstParticle(), FieldFx_StartCloak(), FieldObject_UpdatePlayerControl(), GomaCavePillar_SpawnFragment(), ImilFuchinFalls_PlaceDragonsEye(), ImilFuchinFalls_SpawnDust(), Kolima_SpawnCurseSparkle(), Kolima_UpdateCurseDust(), KolimaForestBridge_SpawnCurseSparkle(), KolimaForestTree_SpawnRejectionSpark(), MercuryLighthouse_ChargeLights(), MercuryLighthouse_HopAcrossPool(), MercuryLighthouse_RestoreLights(), MercuryLighthouse_SpawnSparkPair(), MercuryLighthouseAerie_FlickerBeacon(), Object_MoveOnWorldMap(), ObjectEffect_EndContextEffect(), ObjectEffect_PrepareContextEffect(), ObjectTable_Snapshot(), OverlayObject_SpawnKind24AtObject(), OverlayObject_SpawnKind24AtObject(), PsynergyMenu_InitializeEntryObjects(), Render_ApplyProjectedPlacement(), Render_PlaceProjectedSprite(), ResourceObject_Create(), Sanctum_RaiseItemIcon(), Sanctum_SpawnActorSpark(), Sanctum_SpawnOrbitingEffect(), SaveMenu_ShowDjinnSprites(), SaveMenu_ShowPartySprites(), SolSanctumElementalStarRoom_PresentStar(), SolSanctumEruption_PlayWiseOneRescue(), SolSanctumEruption_RaiseElementalArcs(), SolSanctumEruption_SpawnEffectPair(), Sprite_ComposeAnimationFrame(), SuhallaDesert_SetUpSecondSceneStorms(), TolbiShipInteriors_MoveCameraAndWait(), Ui_RunIconMonitor(), Vale_MoveActorAlongHigherZPath(), Vale_MoveActorAlongLowerZPath(), ValeBabi_SpawnEffectPair(), ValeHome_SpawnEffectPair(), ValeStorm_SpawnEffectPair(), Vault_SpawnDriftingEffect(), VenusLighthouseAerie_SpawnLinkedPairEffects(), VenusLighthouseAerie_SpawnSideOrbitParticles(), VenusLighthouseAerie_SpawnUpperOrbitParticles(), VenusLighthouseAerie_UpdateBeaconRise(), WorldMap_ApplyMapRotation(), WorldMap_CreateLinkedEffects(), WorldMap_SpawnActorEightPuff(), and WorldMap_UpdateTransitionEffect().
| u8 AnimationObject::count |
layers in use, up to the last one present
Definition at line 129 of file animspr.h.
Referenced by AltinPeak_StopLogAndJumpOff(), Animation_ApplyChildPalette(), Animation_InitializeObjects(), AnimationObjects_SetActiveFrameTimers(), AnimationObjects_SetActiveTimerSteps(), BabiPalace_ApplyEntryState(), BattleActor_UpdateSpritePriorities(), BattleEvent_Playback(), BattleFx_StartEffectObject22(), BattleFx_StartRandomParticleEmitter(), BattleMotion_SetRecordChildValues(), BattlePres_RunItem(), BattlePres_RunPsynergyCast(), BattlePres_RunUnitAction(), BattlePresentation_RunUnitTransition(), Colosso_ShowItemIcon(), Event_ShowMythrilBag(), Event_UseBlackOrb(), ImilFuchinFalls_PlaceDragonsEye(), Lalivero_Initialize(), Map_RenderAllAnimatedTileFrames(), Menu_ReleaseEntryObjects(), Object_MoveOnWorldMap(), ObjectEffect_EndContextEffect(), ObjectGroup_ApplyIndexedChildValue(), ObjectGroup_ApplyRandomChildValues(), ObjectGroup_SetChildValue(), ObjectGroup_SetChildValueUnlessFifteen(), ObjectGroup_UpdateMembers(), ResourceMetadata_Register(), ResourceMetadata_ReleaseSlot(), ResourceMetadata_Unregister(), Sanctum_RaiseItemIcon(), Sanctum_ShowHealerAfterimage(), SceneActor_ResetActorRun(), SolSanctumElementalStarRoom_PresentStar(), SolSanctumEruption_PlayWiseOneRescue(), Sprite_ComposeAnimationFrame(), Storm_SetActorFrameMode(), TolbiShipInteriors_PlaceAnchorCharm(), TolbiSpring_SetActorAppearance(), and VenusLighthouseAerie_CombineSaturosAndMenardi().
| struct AnimationEntry* AnimationObject::entries[4] |
its layers; empty ones null
Definition at line 130 of file animspr.h.
Referenced by AltinPeak_StopLogAndJumpOff(), Animation_ApplyChildPalette(), Animation_InitializeObjects(), Animation_SetIndexAndInitObjects(), AnimationObjects_SelectAnimation(), AnimationObjects_SetActiveFrameTimers(), AnimationObjects_SetActiveTimerSteps(), Battle_PlaceActorsByFormationKind(), BattleActor_SpawnObjectsForList(), BattleEvent_Playback(), BattleFx_SetupObjectPair(), BattleMotion_SetRecordChildValues(), BattleMotion_ShowDowned(), BattlePres_RunAttack(), BattlePres_RunItem(), BattlePres_RunPlainAttack(), BattlePres_RunPsynergyCast(), BattlePres_RunUnitAction(), BattlePresentation_RunUnitTransition(), Colosso_ShowItemIcon(), FieldFx_BlinkAvoidCaster(), FieldFx_EndCloak(), FieldFx_RunAvoid(), FieldFx_StartCloak(), Inn_CheckIn(), Map_BuildProbeRing(), MercuryLighthouse_FollowLeader(), Object_MoveOnWorldMap(), ObjectDispatch_ApplyValueToKind200Children(), ObjectEffect_EndContextEffect(), ObjectGroup_ApplyIndexedChildValue(), ObjectGroup_ApplyRandomChildValues(), ObjectGroup_SetChildValue(), ObjectGroup_SetChildValueUnlessFifteen(), ObjectGroup_UpdateMembers(), ObjectTable_ReadActiveValue(), ResetMotionRecordGroup(), ResourceMetadata_Register(), ResourceMetadata_ReleaseSlot(), ResourceMetadata_Unregister(), ResourceObject_Release(), Sanctum_ShowHealerAfterimage(), SolSanctumEruption_SpawnEffectPair(), Sprite_ComposeAnimationFrame(), Storm_SetActorFrameMode(), SuhallaDesert_SetUpSecondSceneStorms(), TolbiSpring_SetActorAppearance(), Ui_FillGridColumnFromMetadata(), Ui_SetGridColumnNumber(), ValeBabi_SpawnEffectPair(), ValeHome_SpawnEffectPair(), ValeStorm_SpawnEffectPair(), VenusLighthouse_DispatchPushScript(), VenusLighthouseAerie_SpawnLinkedPairEffects(), and WorldMap_CreateLinkedEffects().