Pokémon data structure (Generation III): Difference between revisions

From Bulbapedia, the community-driven Pokémon encyclopedia.
Jump to navigationJump to search
m (Text replacement - "}}<br>↵{{Project Games notice" to "}} {{Project Games notice")
 
(84 intermediate revisions by 38 users not shown)
Line 1: Line 1:
Pokémon in the games Ruby, Sapphire, FireRed, LeafGreen, and Emerald are all stored the same way in a 100-byte structure.
Pokémon in the {{game|Ruby and Sapphire|s}}, {{2v2|FireRed|LeafGreen}}, and {{v|Emerald}}s are all stored the same way in a 100-byte structure. All numbers are stored in little-endian order.


==Notes==


=Notes=
{| style="border: 1px solid #88a; background: #f8f8ff; padding: 0.5em; border-collapse: collapse; float: right; margin: 0 0 0.5em 0.5em;" cellpadding="2"
 
{| style="border: 1px solid #88a; background: #f8f8ff; padding: 0.5em; border-collapse: collapse; float: right; margin: 0 0 0.5em 0.5em;" cellspacing="1" cellpadding="2"
|-  
|-  
! colspan="3" style="text-align: center; background: #ccf;" | '''Pokémon'''
! colspan="5" style="text-align: center; background: #{{hoenn color}};" | '''Pokémon'''
|-
|-
! || type || offset
! || type || offset || length<br />(in bytes) || offset<br />(decimal)
|-
|-
| [[Personality]] || dword || 0
| [[Personality value]] || u32 || 0x00 || 4 || 0
|-
|-
| OT ID || dword || 4
| [[Original Trainer|OT]] [[Trainer ID number|ID]] || u32 || 0x04 || 4 || 4
|-
|-
| Nickname || 10 bytes || 8
| [[Nickname]] || u8[10] || 0x08 || 10 || 8
|-
|-
| Font || byte || 18
| Language || u8 || 0x12 || 1 || 18
|-
|-
| Sanity byte? || byte || 19
| [[#Misc. Flags|Misc. Flags]] || u8 || 0x13 || 1 || 19
|-
|-
| OT name || 7 bytes || 20
| OT name || u8[7] || 0x14 || 7 || 20
|-
|-
| Mark || byte || 27
| [[Marking]]s || u8 || 0x1B || 1 || 27
|-
|-
| Checksum || word || 28
| Checksum || u16 || 0x1C || 2 || 28
|-
|-
| ???? || word  || 30
| ???? || u16 || 0x1E || 2 || 30
|-
|-
| [[Pokémon data substructures in the GBA|Data]] || 48 bytes || 32
| {{OBP|Pokémon data substructures|Generation III|Data}} || u8[48] || 0x20 || 48 || 32
|-
|-
| [[Status ailment]] || dword || 80
| [[Status condition]] || u32 || 0x50 || 4 || 80
|-
|-
| Level || byte || 84
| [[Level]] || u8 || 0x54 || 1 || 84
|-
|-
| ???? || byte || 85
| [[#Mail ID|Mail ID]] || u8 || 0x55 || 1 || 85
|-
|-
| Current HP || word || 86
| Current [[stats|HP]] || u16 || 0x56 || 2 || 86
|-
|-
| Total HP || word || 88
| Total [[stats|HP]] || u16 || 0x58 || 2 || 88
|-
|-
| Attack || word || 90
| [[stats|Attack]] || u16 || 0x5A || 2 || 90
|-
|-
| Defense || word || 92
| [[stats|Defense]] || u16 || 0x5C || 2 || 92
|-
|-
| Speed || word || 94
| [[stats|Speed]] || u16 || 0x5E || 2 || 94
|-
|-
| Sp. Attack || word || 96
| [[stats|Sp. Attack]] || u16 || 0x60 || 2 || 96
|-
|-
| Sp. Defense || word || 98
| [[stats|Sp. Defense]] || u16 || 0x62 || 2 || 98
|}
|}


==Personality value==
===Personality value===
The [[personality value]] controls many things, including gender, Unown letter, Spinda's dots, [[nature]], and others.
The [[personality value]] controls many things, including [[gender]], {{p|Unown}}'s letter, {{p|Spinda}}'s dots, any Pokémon's [[Nature]], and more.


==OT ID==
===OT ID===
The Original Trainer's ID Number. Part of the XOR encryption key for the data section, also used in shiny determination and the lottery.
The [[Original Trainer]]'s [[Trainer ID number|ID number]]. This number is part of the XOR encryption key for the {{OBP|Pokémon data substructures|Generation III|data}} section, and is also used in {{Shiny}} determination and the [[Loto-ID|lottery]]. The least significant bytes of this number are the Trainer ID visible on the status screen. The most significant bits (top 16) are the Secret ID of the trainer that caught it.


==Nickname==
===Nickname===
The Pokémon's nickname, limited to 10 characters. <!-- Use the [[Pokéscii Table]] to convert to readable characters. -->
The Pokémon's [[nickname]], limited to 10 characters. The characters represented by each byte are determined by the {{OBP|Character encoding|Generation III|proprietary character set}}.


==Font==
===Language===
Determines which character set is used for the nickname (?).
The [[language of origin]] is language of the game the Pokémon originates from.
This is used to determine what color should be used to write nicknames in a Pokémon's status screen. They may appear in either blue (boy) or pink (girl).


==OT name==
In Western languages, a Pokémon's language of origin determines which font to use to display its name and Original Trainer. This allows the names and Original Trainers of Pokémon from Japanese games to display correctly, including displaying Latin letters as {{wp|fullwidth}} characters.
The name of the original trainer of the Pokémon. <!-- Use the Pokéscii Table to convert to readable characters. -->


==Mark==
In Japanese, the language of origin is entirely ignored—names are always rendered using the Japanese character set. This causes all names to be truncated to five characters (even though they can be up to 10 characters in Western languages). In some cases, this causes characters to render as {{wp|mojibake}}; for example, if the {{DL|In-game trade|Pokémon FireRed and LeafGreen|in-game trade}} {{p|Seel}} from Spanish {{game|FireRed and LeafGreen|s}} (whose nickname is normally SEELÍN) is traded to a Japanese game, its nickname will be displayed as ＳＥＥＬコ.
The marks seen in the storage box. These marks serve only to aide in organizing large collections of Pokémon.
 
[[Image:SapphireMarkingsLANETTE.png|float|left]]
The values that the languages correspond to are:
{| style="border: 1px solid #88a; background: #f8f8ff; padding: 0.5em; border-collapse: collapse; margin: 0 0 0.5em 0.5em;" cellspacing="1" cellpadding="2"
 
|-  
{| class="wikitable"
| '''Bit||Mark'''
! Index || Language
|-
| 1 || Japanese
|-
| 2 || English
|-
| 3 || French
|-
| 4 || Italian
|-
| 5 || German
|-
| 6 || ''unused''
|-
|-
|0|| Circle
| 7 || Spanish
|}
 
In the Generation III games, [[Pokémon Egg|Eggs]] always have their language set to Japanese. This does not cause any issues as, upon hatching, the language of the Egg is set to the language of the game it hatched in.
 
===Misc. Flags===
This byte houses 4 flags:
 
* '''Is Bad Egg (Bit 0):''' When this flag is set, the Pokémon will be treated as a [[Bad Egg]]. If a Pokémon's [[#Checksum|checksum]] is invalid, this flag is set, marking it as a Bad Egg and making it unusable.
* '''Has Species (Bit 1):''' This flag is set whenever the Pokémon species index is non-zero, which should be the case for any Pokémon. It is used as a sanity check for empty spaces, and any Pokémon without this flag set cannot be bred and will disappear when group selected.
* '''Use Egg Name (Bit 2):''' When this flag is set, the Pokémon will ignore their [[#Nickname|nickname]] and display the game's regional variant of "EGG". Only eggs should have this flag set. Note that this flag is independent from the [[Pokémon data substructures (Generation III)#IVs, Egg, and Ability|egg flag]] in the subdata structure.
* '''Block Box RS (Bit 3):''' When this flag is set, the Pokémon cannot be deposited into [[Pokémon Box Ruby & Sapphire]]. This flag likely had a broader purpose but, in practice, this is its only known effect.
* '''Bits 4-7''': These bits are unused, and are just padding for the other flags. They should be set to 0.
 
===OT name===
The name of the Pokémon's Original Trainer. The characters represented by each byte are determined by the {{OBP|Character encoding|Generation III|proprietary character set}}.
 
===Markings===
The markings seen in the [[Pokémon Storage System|storage Box]]. These markings serve only to aid in organizing large collections of Pokémon.
{| style="border: 1px solid #88a; background: #f8f8ff; padding: 0.5em; border-collapse: collapse; margin: 0 0 0.5em 0.5em" cellpadding=2
! Bit || Mark
|-
|-
|1|| Square
| 0 || ●
|-
|-
|2|| Triangle
| 1 || ■
|-
|-
|3|| Heart
| 2 || ▲
|-
|-
| 3 || ♥
|}
|}
<BR clear=all>


==Checksum==
===Checksum===
The checksum is of the 48-byte data section in the structure. It is computed by simply adding all the unencrypted values one word at a time. If this value does not match the real checksum, the Pokémon is interpreted as a [[Bad egg]].
The checksum for the 48-byte {{OBP|Pokémon data substructures|Generation III|data}} section of this structure. It is computed by adding all of the unencrypted values of that section one word at a time. If the computed sum and the stored checksum do not match, the Pokémon is interpreted as a [[Bad Egg]].
 
===????===
Unknown, possibly simply padding (not used and usually set to either 0 or -1, depending on the data type).
 
===Data===
Certain {{OBP|Pokémon data substructures|Generation III|data}} pertaining to the Pokémon that is stored in a special and encrypted format.
 
===Status condition===
The Pokémon's [[status condition]] is stored as follows:
 
{| style="border: 1px solid #88a; background: #f8f8ff; padding: 0.5em; border-collapse: collapse; margin: 0 0 0.5em 0.5em" cellpadding=2
! Bit || colspan=2 | Status
|-
| 0-2 || class="roundy" style="background:#{{status color}}; border:1px solid #f8f8ff; text-align:center" width="32px" | <small>{{color2|FFFFFF|Sleep (status condition)|SLP}}</small> || Sleep
|-
| 3 || class="roundy" style="background:#{{poison color}}; border:1px solid #f8f8ff; text-align:center" | <small>{{color2|FFFFFF|Poison (status condition)|PSN}}</small> || Poison
|-
| 4 || class="roundy" style="background:#{{fire color}}; border:1px solid #f8f8ff; text-align:center" | <small>{{color2|FFF|Burn (status condition)|BRN}}</small> || Burn
|-
| 5 || class="roundy" style="background:#{{ice color}}; border:1px solid #f8f8ff; text-align:center" | <small>{{color2|FFFFFF|Freeze (status condition)|FRZ}}</small> || Freeze
|-
| 6 || class="roundy" style="background:#{{electric color}}; border:1px solid #f8f8ff; text-align:center" | <small>{{color2|FFFFFF|Paralysis (status condition)|PAR}}</small> || Paralysis
|-
| 7 || class="roundy" style="background:#{{poison color}}; border:1px solid #f8f8ff; border-bottom:1px solid; text-align:center" | <small>{{color2|FFFFFF|Poison (status condition)|PSN}}</small> || Bad Poison
|}
The three sleep bits are used to indicate turns of sleep. So 111<sub>2</sub> = 7 turns of sleep, 101<sub>2</sub> = 5 turns, et cetera.


==Padding==
===Mail ID===
Any entry marked (Padding) is not used and usually set to either 0 or -1 of the respective data type.
In the Gen 3 games, when a player receives a Pokémon holding a [[mail]] item (whether from an in-game trade or from a friend) the message tied to that mail is not stored not on the Pokémon itself, but instead somewhere else in the trainer's [[Save_data_structure_(Generation_III)|save data]]. Each of these messages has a unique ID associated with it. This byte stores that ID. If the Pokémon is not holding a mail item, this byte is set to 0xFF (255).
==Status ailment==
The Pokémon's [[status ailments]] are stored as follows:


0-2: Sleep bits. Indicates turns of sleep, so 111b = 7 turns, 101b = 5 turns, etc.<br>
==Data location==
3: Poison<br>
{{incomplete|section|Are the addresses below only for US games? Also, is the mentioned "general region" of box data correct?}}
4: Burned<br>
A Trainer's [[party]] starts at the following addresses in the GBA's RAM.
5: Frozen<br>
{| style="border: 1px solid #88a; background: #f8f8ff; padding: 0.5em; border-collapse: collapse; margin: 0 0 0.5em 0.5em" cellpadding=2
6: Paralysis<br>
! Game || Address
7: Bad poison<br>
|-
| '''{{color2|{{ruby color}}|Pokémon Ruby and Sapphire Versions|Ruby}}''' || rowspan=2 | 0x03004360
|-
| '''{{color2|{{sapphire color}}|Pokémon Ruby and Sapphire Versions|Sapphire}}'''
|-
| '''{{color2|{{emerald color}}|Pokémon Emerald Version|Emerald}}''' || 0x02024190<br>0x020244EC<sup>{{tt|US,FR|for US and FR games}}</sup>
|-
| '''{{color2|{{firered color}}|Pokémon FireRed and LeafGreen Versions|FireRed}}''' || 0x02024284
|-
| '''{{color2|{{leafgreen color}}|Pokémon FireRed and LeafGreen Versions|LeafGreen}}''' || 0x020241E4<br>0x02024284<sup>{{tt|US|for US games}}</sup>
|}
An opponent's party, or a wild Pokémon, starts at the following addresses.
{| style="border: 1px solid #88a; background: #f8f8ff; padding: 0.5em; border-collapse: collapse; margin: 0 0 0.5em 0.5em" cellpadding=2
! Game || Address
|-
| '''{{color2|{{ruby color}}|Pokémon Ruby and Sapphire Versions|Ruby}}''' || rowspan=2 | 0x030045C0
|-
| '''{{color2|{{sapphire color}}|Pokémon Ruby and Sapphire Versions|Sapphire}}'''
|-
| '''{{color2|{{emerald color}}|Pokémon Emerald Version|Emerald}}''' || 0x02024744
|-
| '''{{color2|{{firered color}}|Pokémon FireRed and LeafGreen Versions|FireRed}}''' || rowspan=2 | 0x0202402C
|-
| '''{{color2|{{leafgreen color}}|Pokémon Ruby and Sapphire Versions|LeafGreen}}'''
|-


=Location=
|}


A trainer's [[party|team]] starts at the following addresses in the GBA's RAM (for US games?):
The 600 bytes following these addresses describe a whole team of 6 Pokémon.


* Ruby: 0x03004360
The full 100-byte structure for a Pokémon is only used to describe Pokémon being held in the player's party. When Pokémon are stored in the PC, their data is recorded using only the first 80 bytes of this structure, stopping after the {{OBP|Pokémon data substructures|Generation III|data}} field. The last 20 bytes (excepting status condition, current  HP, and Pokerus remaining byte) can all be recalculated from data in the data substructure when a Pokémon is withdrawn (level being derived from experience). This also explains why Pokémon suffering a status condition are "cured" when put in the PC.
* Sapphire: 0x03004360
* Emerald: 0x02024190 (0x020244EC for US games??)
* FireRed: 0x02024284
* LeafGreen: 0x020241e4


There are 6 Pokémon per team, so the whole team continues for 600 bytes afterward.
This means there are also 33,600 bytes (80 bytes * 30 per Box * 14 Boxes) elsewhere in the GBA's RAM describing Pokémon in the PC. When the GBA's saved state (including memory contents) is unzipped into a 740,000+ byte file and viewed, the 14 Boxes of 420 Pokémon are stored in the general region of $038000 and $040000. In the US version of Pokémon Emerald, box data is between 0x02FE9888 and 0x02FF1BC8, non-inclusive. (Some emulators may address their RAM slightly differently.) The first 6 80-byte structures make up, from left to right, the first row of Pokémon in box 1. The next Pokémon gets placed on the next row. After 5 rows (30 80-byte structures), the next Pokémon is placed in box 2, and so on.


This structure is used to save data on Pokémon stored in your team.
==See also==
The structure for Pokémon saved in the PC stops after the data field, making it only 80 bytes long.<br>
* [[Pokémon data substructures (Generation III)]]
This explains why Pokémon injured by status ailment will cure themselves when put in the PC.
It also applies to stats and level, which are recalculated based on Experience.<br>
Thus, there are also 33600 (14*30*80) bytes stored somewhere else in the GBA's RAM to save data on Pokémon in the PC.


When the VBA's saved state (including memory contents) are unzipped into a 740,000+ byte file and viewed, the 14 boxes of 420 Pokémon are stored in the general region of $038000 $040000.
==Links==
* [http://www.ppnstudio.com/maker/PokemonMakerHelp.txt PokemonMakerV4x Help and 80 bytes Make a Pokémon]
* [https://github.com/pret/pokeemerald/blob/master/include/pokemon.h pokemon.h | pokeemerald decomp ]


[[Category:Structures]]
{{data structure}}
[[Category:Game mechanics]]
{{Project Games notice|data structure}}

Latest revision as of 17:32, 16 September 2024

Pokémon in the Pokémon Ruby and Sapphire, FireRed and LeafGreen, and Emerald Versions are all stored the same way in a 100-byte structure. All numbers are stored in little-endian order.

Notes

Pokémon
type offset length
(in bytes)		 offset
(decimal)
Personality value u32 0x00 4 0
OT ID u32 0x04 4 4
Nickname u8[10] 0x08 10 8
Language u8 0x12 1 18
Misc. Flags u8 0x13 1 19
OT name u8[7] 0x14 7 20
Markings u8 0x1B 1 27
Checksum u16 0x1C 2 28
???? u16 0x1E 2 30
Data u8[48] 0x20 48 32
Status condition u32 0x50 4 80
Level u8 0x54 1 84
Mail ID u8 0x55 1 85
Current HP u16 0x56 2 86
Total HP u16 0x58 2 88
Attack u16 0x5A 2 90
Defense u16 0x5C 2 92
Speed u16 0x5E 2 94
Sp. Attack u16 0x60 2 96
Sp. Defense u16 0x62 2 98

Personality value

The personality value controls many things, including gender, Unown's letter, Spinda's dots, any Pokémon's Nature, and more.

OT ID

The Original Trainer's ID number. This number is part of the XOR encryption key for the data section, and is also used in Shiny determination and the lottery. The least significant bytes of this number are the Trainer ID visible on the status screen. The most significant bits (top 16) are the Secret ID of the trainer that caught it.

Nickname

The Pokémon's nickname, limited to 10 characters. The characters represented by each byte are determined by the proprietary character set.

Language

The language of origin is language of the game the Pokémon originates from.

In Western languages, a Pokémon's language of origin determines which font to use to display its name and Original Trainer. This allows the names and Original Trainers of Pokémon from Japanese games to display correctly, including displaying Latin letters as fullwidth characters.

In Japanese, the language of origin is entirely ignored—names are always rendered using the Japanese character set. This causes all names to be truncated to five characters (even though they can be up to 10 characters in Western languages). In some cases, this causes characters to render as mojibake; for example, if the in-game trade Seel from Spanish Pokémon FireRed and LeafGreen (whose nickname is normally SEELÍN) is traded to a Japanese game, its nickname will be displayed as ＳＥＥＬコ.

The values that the languages correspond to are:

Index Language
1 Japanese
2 English
3 French
4 Italian
5 German
6 unused
7 Spanish

In the Generation III games, Eggs always have their language set to Japanese. This does not cause any issues as, upon hatching, the language of the Egg is set to the language of the game it hatched in.

Misc. Flags

This byte houses 4 flags:

  • Is Bad Egg (Bit 0): When this flag is set, the Pokémon will be treated as a Bad Egg. If a Pokémon's checksum is invalid, this flag is set, marking it as a Bad Egg and making it unusable.
  • Has Species (Bit 1): This flag is set whenever the Pokémon species index is non-zero, which should be the case for any Pokémon. It is used as a sanity check for empty spaces, and any Pokémon without this flag set cannot be bred and will disappear when group selected.
  • Use Egg Name (Bit 2): When this flag is set, the Pokémon will ignore their nickname and display the game's regional variant of "EGG". Only eggs should have this flag set. Note that this flag is independent from the egg flag in the subdata structure.
  • Block Box RS (Bit 3): When this flag is set, the Pokémon cannot be deposited into Pokémon Box Ruby & Sapphire. This flag likely had a broader purpose but, in practice, this is its only known effect.
  • Bits 4-7: These bits are unused, and are just padding for the other flags. They should be set to 0.

OT name

The name of the Pokémon's Original Trainer. The characters represented by each byte are determined by the proprietary character set.

Markings

The markings seen in the storage Box. These markings serve only to aid in organizing large collections of Pokémon.

Bit Mark
0 ●
1 ■
2 ▲
3 ♥

Checksum

The checksum for the 48-byte data section of this structure. It is computed by adding all of the unencrypted values of that section one word at a time. If the computed sum and the stored checksum do not match, the Pokémon is interpreted as a Bad Egg.

????

Unknown, possibly simply padding (not used and usually set to either 0 or -1, depending on the data type).

Data

Certain data pertaining to the Pokémon that is stored in a special and encrypted format.

Status condition

The Pokémon's status condition is stored as follows:

Bit Status
0-2 SLP Sleep
3 PSN Poison
4 BRN Burn
5 FRZ Freeze
6 PAR Paralysis
7 PSN Bad Poison

The three sleep bits are used to indicate turns of sleep. So 1112 = 7 turns of sleep, 1012 = 5 turns, et cetera.

Mail ID

In the Gen 3 games, when a player receives a Pokémon holding a mail item (whether from an in-game trade or from a friend) the message tied to that mail is not stored not on the Pokémon itself, but instead somewhere else in the trainer's save data. Each of these messages has a unique ID associated with it. This byte stores that ID. If the Pokémon is not holding a mail item, this byte is set to 0xFF (255).

Data location

050Diglett.png This section is incomplete.
Please feel free to edit this section to add missing information and complete it.
Reason: Are the addresses below only for US games? Also, is the mentioned "general region" of box data correct?

A Trainer's party starts at the following addresses in the GBA's RAM.

Game Address
Ruby 0x03004360
Sapphire
Emerald 0x02024190
0x020244ECUS,FR
FireRed 0x02024284
LeafGreen 0x020241E4
0x02024284US

An opponent's party, or a wild Pokémon, starts at the following addresses.

Game Address
Ruby 0x030045C0
Sapphire
Emerald 0x02024744
FireRed 0x0202402C
LeafGreen

The 600 bytes following these addresses describe a whole team of 6 Pokémon.

The full 100-byte structure for a Pokémon is only used to describe Pokémon being held in the player's party. When Pokémon are stored in the PC, their data is recorded using only the first 80 bytes of this structure, stopping after the data field. The last 20 bytes (excepting status condition, current HP, and Pokerus remaining byte) can all be recalculated from data in the data substructure when a Pokémon is withdrawn (level being derived from experience). This also explains why Pokémon suffering a status condition are "cured" when put in the PC.

This means there are also 33,600 bytes (80 bytes * 30 per Box * 14 Boxes) elsewhere in the GBA's RAM describing Pokémon in the PC. When the GBA's saved state (including memory contents) is unzipped into a 740,000+ byte file and viewed, the 14 Boxes of 420 Pokémon are stored in the general region of $038000 and $040000. In the US version of Pokémon Emerald, box data is between 0x02FE9888 and 0x02FF1BC8, non-inclusive. (Some emulators may address their RAM slightly differently.) The first 6 80-byte structures make up, from left to right, the first row of Pokémon in box 1. The next Pokémon gets placed on the next row. After 5 rows (30 80-byte structures), the next Pokémon is placed in box 2, and so on.

See also

Links


Data structure in the Pokémon games
General Character encoding
Generation I Pokémon species • Pokémon • Poké Mart • Character encoding (Stadium) • Save
Generation II Pokémon species • Pokémon • Trainer • Character encoding (Stadium • Korean) • Save
Generation III Pokémon species (Evolution • Pokédex • Type chart)
Pokémon (substructures) • Move • Contest • Contest move • Item
Trainer Tower • Battle Frontier • Character encoding (GameCube) • Save
Generation IV Pokémon species (Evolution • Learnsets)
Pokémon • Save • Character encoding (Wii)
Generation V–present Character encoding
Generation VIII Save
TCG GB and GB2 Character encoding
Project Games logo.png This data structure article is part of Project Games, a Bulbapedia project that aims to write comprehensive articles on the Pokémon games.
Retrieved from "https://bulbapedia.bulbagarden.net/w/index.php?title=Pokémon_data_structure_(Generation_III)&oldid=4114294"