Alchemy
Loading...
Searching...
No Matches

BattleObj Struct Reference

A unit's place on the battlefield: its sprite object, resources and animations, its anchor spot and scale, and the conditions it shows. More...

#include <battle/battle_session.h>

Data Fields

struct MotionObject * object
 NULL once released.
u16 resource
 the unit's sprite
u16 overlay
 a second sprite drawn over it, the weapon; 0 for none
u16 animation
 the status icon's animation shown; 0 for none
u16 effect
 an effect sprite drawn with the unit
s32 anchorX
 16.16 fixed-point pixels
s32 anchorZ
 16.16 fixed-point pixels
s32 palette
 the unit sprite's palette
s32 scale
 16.16 fixed point, 0x10000 full size
u16 activeConditions
 a bit per status with an icon (ICON_)
u8 selectedCondition
 the status whose icon is shown
s8 cycleTimer
 frames until the next status icon
struct SpriteEntry * animationEntry
 the status icon's sprite, or NULL
struct SpriteEntry * effectEntry
 the effect sprite, or NULL
s16 active
 Set by BattleObj_MarkForRelease: the object is released with the others by BattleMotion_DestroyAllSlotObjects.
s16 fading
 set while a fallen enemy's picture is being removed

Detailed Description

A unit's place on the battlefield: its sprite object, resources and animations, its anchor spot and scale, and the conditions it shows.

Definition at line 16 of file battle_session.h.

Field Documentation

◆ object

struct MotionObject* BattleObj::object

NULL once released.

Definition at line 17 of file battle_session.h.

Referenced by BattleActor_DestroyTemporaryObject(), BattleActor_SpawnObjectsForList(), BattleActor_UpdateSpritePriorities(), BattleCommand_BuildPlan(), BattleEvent_Playback(), BattleFx_InitializeRisingObject(), BattleFx_RunAnnihilation(), BattleFx_RunAstralBlast(), BattleFx_RunBeamSequence(), BattleFx_RunBind(), BattleFx_RunBreak(), BattleFx_RunBurstScene(), BattleFx_RunCastingImpact(), BattleFx_RunCondemn(), BattleFx_RunCybele(), BattleFx_RunDeathPlunge(), BattleFx_RunDjinnBeams(), BattleFx_RunDjinnHeal(), BattleFx_RunDjinniEntrance(), BattleFx_RunDrain(), BattleFx_RunFire(), BattleFx_RunFroth(), BattleFx_RunGatheringLights(), BattleFx_RunGround(), BattleFx_RunHaunt(), BattleFx_RunHealingMotes(), BattleFx_RunHelmSplitter(), BattleFx_RunLobbedShells(), BattleFx_RunMoteFountain(), BattleFx_RunNereid(), BattleFx_RunOrbitingSkulls(), BattleFx_RunOrbitingSpirals(), BattleFx_RunParticleStreams(), BattleFx_RunPlanetDiver(), BattleFx_RunProcne(), BattleFx_RunProjectileVolley(), BattleFx_RunQuake(), BattleFx_RunRagnarok(), BattleFx_RunRingAndSparkScene(), BattleFx_RunRushingStrike(), BattleFx_RunShiningStar(), BattleFx_RunSleep(), BattleFx_RunStatBoost(), BattleFx_RunStatReduction(), BattleFx_RunStreakVolley(), BattleFx_RunSwirlSwipe(), BattleFx_RunTargetBursts(), BattleFx_RunTargetMotes(), BattleFx_RunTargetStrike(), BattleFx_RunTriangleStrike(), BattleFx_RunVolcano(), BattleFx_RunVolleyWithAction(), BattleFx_SetApproachMotion(), BattleMotion_ApplyPairMidpoint(), BattleMotion_ApplyVariantMotion(), BattleMotion_ApproachTarget(), BattleMotion_DestroyAllSlotObjects(), BattleMotion_InitializeObject(), BattleMotion_InterpolatePosition(), BattleMotion_ProjectConditionalPosition(), BattleMotion_ProjectPosition(), BattleMotion_ProjectScaledPosition(), BattleMotion_ResetObjectAtScaledAnchor(), BattleMotion_ResetSlotObjectMode2(), BattleMotion_SetMode5AndActivateSlot(), BattleMotion_SetObjectPosition(), BattleMotion_SetupEscapeObject(), BattleMotion_SpawnSlotEffectAndWait(), BattleObjMake(), BattlePres_RunApproachAction(), BattlePres_RunAttack(), BattlePres_RunEntryTransition(), BattlePres_RunItem(), BattlePres_RunPlainAttack(), BattlePres_RunPsynergyCast(), BattlePres_RunUnitAction(), BattlePres_SetupTransitionAtPairMidpoint(), BattlePresentation_ApplyUnitDamage(), BattlePresentation_RunPairedUnitTransition(), BattlePresentation_RunUnitTransition(), BattleStatusIcon_Cycle(), BattleUnit_ProjectToScreen(), ObjectGroup_UpdateMembers(), ObjMotRst(), ReleaseBattleObjectRecords(), and Ui_RunOwnerStatusScreen().

◆ resource

u16 BattleObj::resource

the unit's sprite

Definition at line 18 of file battle_session.h.

Referenced by BattleActor_SpawnObjectsForList(), and BattleObjMake().

◆ overlay

u16 BattleObj::overlay

a second sprite drawn over it, the weapon; 0 for none

Definition at line 19 of file battle_session.h.

Referenced by BattleActor_SpawnObjectsForList(), and BattleObjMake().

◆ animation

u16 BattleObj::animation

the status icon's animation shown; 0 for none

Definition at line 20 of file battle_session.h.

Referenced by BattleActor_SpawnObjectsForList(), BattleObjMake(), and BattleStatusIcon_Cycle().

◆ effect

u16 BattleObj::effect

an effect sprite drawn with the unit

Definition at line 21 of file battle_session.h.

Referenced by BattleActor_SpawnObjectsForList(), and BattleObjMake().

◆ anchorX

◆ anchorZ

◆ palette

s32 BattleObj::palette

the unit sprite's palette

Definition at line 24 of file battle_session.h.

Referenced by BattleActor_SpawnObjectsForList(), BattleMotion_GetSlotPalette(), and BattleObjMake().

◆ scale

s32 BattleObj::scale

16.16 fixed point, 0x10000 full size

Definition at line 25 of file battle_session.h.

Referenced by BattleActor_SpawnObjectsForList(), and BattleObjMake().

◆ activeConditions

u16 BattleObj::activeConditions

a bit per status with an icon (ICON_)

Definition at line 26 of file battle_session.h.

Referenced by BattleStatusIcon_Cycle(), and BattleUnit_BuildStatusFlags().

◆ selectedCondition

u8 BattleObj::selectedCondition

the status whose icon is shown

Definition at line 27 of file battle_session.h.

Referenced by BattleStatusIcon_Cycle().

◆ cycleTimer

s8 BattleObj::cycleTimer

frames until the next status icon

Definition at line 28 of file battle_session.h.

Referenced by BattleStatusIcon_Cycle().

◆ animationEntry

struct SpriteEntry* BattleObj::animationEntry

◆ effectEntry

struct SpriteEntry* BattleObj::effectEntry

◆ active

s16 BattleObj::active

Set by BattleObj_MarkForRelease: the object is released with the others by BattleMotion_DestroyAllSlotObjects.

Definition at line 33 of file battle_session.h.

Referenced by BattleActor_DestroyTemporaryObject(), BattleMotion_DestroyAllSlotObjects(), BattleObj_MarkForRelease(), and BattleObjMake().

◆ fading

s16 BattleObj::fading

set while a fallen enemy's picture is being removed

Definition at line 34 of file battle_session.h.

Referenced by BattleObjMake(), and ObjectGroup_UpdateMembers().