BattleSpriteDefinition Struct Reference

An enemy class's battle sprite: its animation, size, attack effect, palette and defeat-sound kind. More...

#include <battle/battle_summon.h>

Data Fields
u16	animation
	the class's battle sprite
u8	unk04 [4]
	[0] is the effect height (BattleClass_GetEffectHeight)
u8	spriteBit0: 1
	The byte at 2.
u8	spriteBits1: 4
	the attack-effect kind; 0 reads as 1
u8	spriteBits5: 3
	the attack-hop height
u8	layoutBit0: 1
	The byte at 3.
u8	layoutBits1: 4
	the sprite's palette
u8	layoutKind: 3
	the defeat-sound kind; above 4 reads as none

Detailed Description

An enemy class's battle sprite: its animation, size, attack effect, palette and defeat-sound kind.

Definition at line 15 of file battle_summon.h.

Field Documentation

animation

u16 BattleSpriteDefinition::animation

the class's battle sprite

Definition at line 16 of file battle_summon.h.

Referenced by BattleClass_GetPalette(), and BattleClass_GetSprite().

spriteBit0

u8 BattleSpriteDefinition::spriteBit0

The byte at 2.

bits: 7..5 spriteBits5 | 4..1 spriteBits1 | 0 spriteBit0 1 for a small enemy, which takes one sprite slot

Definition at line 20 of file battle_summon.h.

spriteBits1

u8 BattleSpriteDefinition::spriteBits1

the attack-effect kind; 0 reads as 1

Definition at line 21 of file battle_summon.h.

Referenced by BattleClass_GetAttackEffect().

spriteBits5

u8 BattleSpriteDefinition::spriteBits5

the attack-hop height

Definition at line 22 of file battle_summon.h.

Referenced by BattleClass_GetAttackHop().

layoutBit0

u8 BattleSpriteDefinition::layoutBit0

The byte at 3.

bits: 7..5 layoutKind | 4..1 layoutBits1 | 0 layoutBit0 read by Summon_IsEntrySecondaryFlagged only

Definition at line 27 of file battle_summon.h.

Referenced by Summon_IsEntrySecondaryFlagged().

layoutBits1

u8 BattleSpriteDefinition::layoutBits1

the sprite's palette

Definition at line 28 of file battle_summon.h.

Referenced by BattleClass_GetPalette().

layoutKind

u8 BattleSpriteDefinition::layoutKind

the defeat-sound kind; above 4 reads as none

Definition at line 29 of file battle_summon.h.

Referenced by BattleClass_GetDefeatSoundKind().

unk04

u8 BattleSpriteDefinition::unk04[4]

[0] is the effect height (BattleClass_GetEffectHeight)

Definition at line 31 of file battle_summon.h.

Referenced by BattleClass_GetEffectHeight().