Object/coin

This article is about the object »coin« (object id 0x73). Coins are only used in Coin Runners mode of Battle Arenas and in some tournaments.

Settings

Only settings 2 and 3 are used by Nintendo on battle arenas. Setting 1 is used on tournaments, and the rest (4 to 8) are always 0.

Setting #2: Start or respawn place

This setting decides about the characteristic starting place or respawn place.

• Values between 0..49 are used for starting places. Nintendo used unique numbers, but it seems, that any mix is working. At some slots, numbers >50 (may be up to 100) will work too.
• The slots have different limits of usable starting places. It varies between 21 and 42.
• At battle start, all usable starting places start with a coin.
• Respawn places have always value -1 (=65535) and generally used for respawned and new coins. On some slots they are used as starting place too, if the number of starting places is too small.
• The total number of coins is limited by the total number of coin objects. Additionally, all slots have different absolute limits for coins (not for coin objects) between 53 and 71.

Setting #3: Spawning type

Nintendo uses types 0, 1 and 2. The tests of Wiimm additionally cover type 3:

• Type 0 and 1: Coins are inserted at place.
• Type 2: Coins fall down from the sky and keep their X and Z value.
• Type 3: Coins fall down from the sky when they fall on a slope they ricochet.
• Coins from starting places of all types except type 1 are moved to respawn places at the beginning of Phase 2 (see below).

Phases

There exist 3 coin phases:

• In Phase 1, coins are only available at start places. The game starts usually in Phase 1.
• In Phase 2, coins of starting places (except type 1) moved to respawn places.
• In Phase 3, additional coins (not starting coins) become available and will be spawned time by time.

The triggering of the phases are not really clear. It seems that there are different triggers for each phase.

Phase 2 is triggered:

• when a player is damaged (is respawned and maybe hit).
• when about the half of the starting coins are caught.
• if to less starting places defined (slot dependent), the game starts directly in phase 2.

Phase 3 is triggered:

• when in Phase 2 and if a player is damaged (is respawned and maybe hit) and lost at least 1 coin.
• when many coins from respawn places were caught.
• if there are not many starting places defined (slot dependent), the game starts directly in Phase 3 or skips Phase 2.

Observations

For the observations more than 50 setups with different number of objects and respawn types were tested by Wiimm. And here the results:

• If no respawn slots defined, coins will not respawned.
• In 3 setups with 63, 68 and 100 starting places, no coins were respawned. All other setups had 60 or less starting places.
• A starting place with index of ≥60 is ignored. Moreover, it disables respawning at all.
• With less than about 20 starting places (value may depend on slot), ...
  • ... respawn slots were used as additional staring slots.
  • ... the battle starts directly in coin phase 2 or 3.
• There are different events (may be slot dependent) that will trigger phases 2 and 3.
• As more respawn places defined, as faster the coins will be respawned.
• Some original arenas defined more starting places than used by the related slot. Either this is a mistake by Nintendo, or there exists another overlooked parameter or impact.

Slot dependency

The values of the following table are extracted from file minigame.kmg and from KMP section GOBJ of the arena files.

Slot dependent limits of coins and usage of slot object

Slot	Index	Arena name	Coins at start	Max coins	Number of start places			Number of respawn places
					Type 0	Type 1	Type 2	Type 0	Type 1	Type 2
1.1	1	Block Plaza	12–40	21–67	40	—	—	—	—	53
1.2	0	Delfino Pier	12–40	21–71	10	4	28	8	2	82
1.3	3	Funky Stadium	10–42	21–71	12	30	—	3	3	42
1.4	2	Chain Chomp Wheel	10–28	21–55	48	2	—	—	18	39
1.5	4	Thwomp Desert	12–30	21–55	28	—	—	—	—	52
2.1	7	SNES Battle Course 4	12–30	21–57	32	—	—	60	—	—
2.2	8	GBA Battle Course 3	10–30	21–63	50	—	—	—	—	54
2.3	9	N64 Skyscraper	10–28	21–55	40	—	—	—	—	56
2.4	5	GCN Cookie Land	12–21	21–53	27	—	—	—	—	45
2.5	6	DS Twilight House	10–30	21–57	40	—	—	11	—	45

Notes

• Index is the zero based internal index to address battle dependent tables (e.g. on file minigame.kmg).
• Coins at start (number of coins at battle start) and Max coins (maximal number of available coins) depend on the arena slot and the number of players. The related tables are placed in minigame.kmg at offsets 0x394 and 0x470.

More technical information

The coin model is not fully loaded from coin.brres. Instead, there is raw model data which contains vertex, UV and normal information into StaticR.rel. The data is found at offset 0x3A2000 for the PAL version of the game, 0x3A1A40 for NTSC-US and 0x3A17E0 for NTSC-J.

However, texture and animation data, as well as the coin's shadow and pile_coin are still used from coin.brres.

Guidelines for good custom setups

These guideline are based on the observations above.

• Use between 20 and 42 starting places. Additional places are simply ignored. If using less than 20 starting places, curious effects like starting in phase 2 or 3 will happen (depends on slot).
• Use unique identifiers for setting #2 of starting places. Preferred is a zero based unique index. Most likely these identifiers are irrelevant, but only most likely. Indices equal or greater the slot limit will be ignored and values >60 may disable the respawn functionality at all. Best is to use always values <42.
• Use 20 to 80 respawn places. If using few respawn places, the respawning process is slowed down.
• If using many coins, give the user a recommendation about the slot usage, because some slots have small limits.
• Think about the respawn modes. Only coins of type 1 will stay at the defined position until caught. And only coins of type 2 fall from the sky. The choices for start and respawn places can differ.
• Use different positions for all coin objects, so that 2 coins are never placed at the same position. An exception is a starting place with type other than 1 and a respawn place; they never hold a coin at same time.
• Give automated height correction a chance to adjust positions.
• Scatter the coins around the whole arena, but only in places where enemies will drive. Good places are along the enemy routes. Read the »Enemy routes in battle arenas« tutorial to get good enemy routes.

Links

Custom Track Tutorials

Main Tutorials
Introduction – Textures – Scale – Modeling ⇒ Using Blender – BRRES: CTools
BRRES: BrawlBox – BRRES: RiiStudio – Minimap – Solidity – KCL: Wiimms Tools – KMP Editing
Object Editing – Cameras – Cannons – Post-effects – Videos

Battle Arenas
Battle Arenas – Enemy routes in battle arenas ⇒ Using Wiimm's Tools – Coins

Misc. Tutorials
Getting Files – BrawlBox Tricks – Animations – Shadows – Mipmaps
Custom Effects – Moving Terrain – Music – Ports – Paint Remakes – Tutorial Archive
Extended presence flags: Track Tutorial – LE-CODE Track FAQ

Testing and Reviewing
Testing a Track – Visual Review – Track Transformation – Fixing Errors

Software
3D Tools – BrawlBox – CTools Pack – KMP3D – KMP Cloud – KMP Modifier
Lorenzi's KMP Editor – MagicY – Material Tool – Post-Effect Editor – Wiimms SZS Tools – Wiimm's Tool Manager

Other
KMP Objects – Custom Objects – Model Database – Tutorial Archive