private List <UInt32> writeSubroutineInitMapIdsForMapIcons(AddressMapper addressMapper, VAVAddr entryAddr)
{
var JUtility_memset = addressMapper.toVersionAgnosticAddress((BSVAddr)0x80004714);
// precondition: r3 is newly created map icon array
// r16 is the amount of map ids in the array (size / 4)
// r24 is unused
// postcondition: r24 is the map icon array
var asm = new List <UInt32>();
asm.Add(PowerPcAsm.mflr(24)); // save the link register
asm.Add(PowerPcAsm.li(4, -1)); // fill with 0xff
asm.Add(PowerPcAsm.rlwinm(5, 16, 0x3, 0x0, 0x1d)); // get the size of the array
asm.Add(PowerPcAsm.bl(entryAddr, asm.Count, JUtility_memset)); // call JUtility_memset(array*, 0xff, array.size)
asm.Add(PowerPcAsm.mtlr(24)); // restore the link register
asm.Add(PowerPcAsm.mr(24, 3)); // move array* to r24
asm.Add(PowerPcAsm.blr()); // return
return(asm);
}
protected override void writeAsm(EndianBinaryWriter stream, AddressMapper addressMapper, List <MapDescriptor> mapDescriptors)
{
var mapIcons = writeIconStrings(mapDescriptors);
Dictionary <string, VAVAddr> iconTableMap;
VAVAddr iconTableAddr = writeIconTable(mapIcons, out iconTableMap);
VAVAddr mapIconPointerTable = writeMapIconPointerTable(mapDescriptors, iconTableMap);
ushort iconCount = (ushort)iconTableMap.Count;
short tableRowCount = (short)mapDescriptors.Count;
PowerPcAsm.Pair16Bit v = PowerPcAsm.make16bitValuePair((UInt32)iconTableAddr);
PowerPcAsm.Pair16Bit w = PowerPcAsm.make16bitValuePair((UInt32)mapIconPointerTable);
// note: To add custom icons, the following files need to be editted as well:
// - ui_menu_19_00a.brlyt within game_sequence.arc and within game_sequence_wifi.arc
// - ui_menu_19_00a_Tag_*.brlan within game_sequence.arc and within game_sequence_wifi.arc
// custom map icon hack (change it that way that it will call the GetMapDifficulty routine instead of the GetMapOrigin routine
// the GetMapDifficulty routine is mostly unused by the game and we repurpose it to return the pointer to the pointer of the string of the map icon instead
// then we go through all map icon pointer pointers and check if it is the same as the one retrieved. If it is then we make it visible, otherwise we set the visibility to false.
var GetMapDifficulty = addressMapper.toVersionAgnosticAddress((BSVAddr)0x80211da4);
// bl GetMapOrigin -> bl GetMapDifficulty
var offset = addressMapper.toVersionAgnosticAddress((BSVAddr)0x8021e77c);
stream.Seek(addressMapper.toFileAddress(offset), SeekOrigin.Begin); stream.Write(PowerPcAsm.bl(offset, GetMapDifficulty));
// cmpw r28,r30 -> cmpw r29,r30
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x8021e790), SeekOrigin.Begin); stream.Write(PowerPcAsm.cmpw(29, 30));
// cmplwi r28,0x12 -> cmplwi r28,iconCount
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x8021e7c0), SeekOrigin.Begin); stream.Write(PowerPcAsm.cmplwi(28, iconCount));
// bl GetMapOrigin -> bl GetMapDifficulty
offset = addressMapper.toVersionAgnosticAddress((BSVAddr)0x8021e8a4);
stream.Seek(addressMapper.toFileAddress(offset), SeekOrigin.Begin); stream.Write(PowerPcAsm.bl(offset, GetMapDifficulty));
// cmpw r29,r28 -> cmpw r30,r28
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x8021e8b8), SeekOrigin.Begin); stream.Write(PowerPcAsm.cmpw(30, 28));
// cmplwi r29,0x12 -> cmplwi r29,iconCount
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x8021e8e8), SeekOrigin.Begin); stream.Write(PowerPcAsm.cmplwi(29, iconCount));
// bl GetMapOrigin -> bl GetMapDifficulty
offset = addressMapper.toVersionAgnosticAddress((BSVAddr)0x8021e824);
stream.Seek(addressMapper.toFileAddress(offset), SeekOrigin.Begin); stream.Write(PowerPcAsm.bl(offset, GetMapDifficulty));
// cmplwi r28,0x12 -> cmplwi r28,iconCount
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x8021e84c), SeekOrigin.Begin); stream.Write(PowerPcAsm.cmplwi(28, iconCount));
// r29 <- 0x8047f5c0 -> r29 <- iconTableAddr
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x8021e780), SeekOrigin.Begin); stream.Write(PowerPcAsm.lis(29, v.upper16Bit)); stream.Seek(4, SeekOrigin.Current); stream.Write(PowerPcAsm.addi(29, 29, v.lower16Bit));
// r30 <- 0x8047f5c0 -> r30 <- iconTableAddr
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x8021e8a8), SeekOrigin.Begin); stream.Write(PowerPcAsm.lis(30, v.upper16Bit)); stream.Seek(4, SeekOrigin.Current); stream.Write(PowerPcAsm.addi(30, 30, v.lower16Bit));
// r30 <- 0x8047f5c0 -> r30 <- iconTableAddr
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x8021e828), SeekOrigin.Begin); stream.Write(PowerPcAsm.lis(30, v.upper16Bit)); stream.Seek(4, SeekOrigin.Current); stream.Write(PowerPcAsm.addi(30, 30, v.lower16Bit));
// mr r3,r28 -> mr r3,r26
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x8021e94c), SeekOrigin.Begin); stream.Write(PowerPcAsm.mr(3, 26));
// mr r3,r28 -> mr r3,r26
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x8021e968), SeekOrigin.Begin); stream.Write(PowerPcAsm.mr(3, 26));
// Modify the GetMapDifficulty routine to retrieve the current map icon addr addr
// subi r31,r3,0x15 -> nop
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x80211dc8), SeekOrigin.Begin); stream.Write(PowerPcAsm.nop());
// cmpwi r31,0x12 -> cmpwi r31,tableRowCount
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x80211dd4), SeekOrigin.Begin); stream.Write(PowerPcAsm.cmpwi(31, tableRowCount));
// li r3,0x15 -> nop
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x80211e4c), SeekOrigin.Begin); stream.Write(PowerPcAsm.nop());
// mulli r4,r3,0x24 -> mulli r4,r3,0x04
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x80211e58), SeekOrigin.Begin); stream.Write(PowerPcAsm.mulli(4, 3, 0x04));
// r3 <- 804363c8 -> r3 <- mapIconPointerTable
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x80211e5c), SeekOrigin.Begin); stream.Write(PowerPcAsm.lis(3, w.upper16Bit)); stream.Write(PowerPcAsm.addi(3, 3, w.lower16Bit));
// mulli r0,r31,0x24 -> mulli r0,r31,0x04
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x80211e64), SeekOrigin.Begin); stream.Write(PowerPcAsm.mulli(0, 31, 0x04));
// lwz r3,0x1c(r3) -> lwz r3,0x0(r3)
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x80211e78), SeekOrigin.Begin); stream.Write(PowerPcAsm.lwz(3, 0x0, 3));
// --- Hack to make icons invisible which do not have a map ---
// -- Init Maps in the map array with -1 --
var subroutineInitMapIdsForMapIcons = allocate(writeSubroutineInitMapIdsForMapIcons(addressMapper, VAVAddr.NullAddress), "SubroutineInitMapIdsForMapIcons");
stream.Seek(addressMapper.toFileAddress(subroutineInitMapIdsForMapIcons), SeekOrigin.Begin);
stream.Write(writeSubroutineInitMapIdsForMapIcons(addressMapper, subroutineInitMapIdsForMapIcons)); // re-write the routine again since now we know where it is located in the main dol
// increase the array size
// rlwinm r3,r16,0x2,0x0,0x1d -> r3,r16,0x3,0x0,0x1d
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x80187794), SeekOrigin.Begin); stream.Write(PowerPcAsm.rlwinm(3, 16, 0x3, 0x0, 0x1d));
var hijackAddr = addressMapper.toVersionAgnosticAddress((BSVAddr)0x8018779c);
// cmpwi r3,0x0 -> bl subroutineInitMapIdsForMapIcons
stream.Seek(addressMapper.toFileAddress(hijackAddr), SeekOrigin.Begin); stream.Write(PowerPcAsm.bl(hijackAddr, subroutineInitMapIdsForMapIcons));
// mr r24,r3 -> cmpwi r3,0x0
stream.Write(PowerPcAsm.cmpwi(3, 0));
// increase the array size
// rlwinm r3,r16,0x2,0x0,0x1d -> r3,r16,0x3,0x0,0x1d
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x80187aa4), SeekOrigin.Begin); stream.Write(PowerPcAsm.rlwinm(3, 16, 0x3, 0x0, 0x1d));
hijackAddr = addressMapper.toVersionAgnosticAddress((BSVAddr)0x80187aac);
// cmpwi r3,0x0 -> bl subroutineInitMapIdsForMapIcons
stream.Seek(addressMapper.toFileAddress(hijackAddr), SeekOrigin.Begin); stream.Write(PowerPcAsm.bl(hijackAddr, subroutineInitMapIdsForMapIcons));
// mr r24,r3 -> cmpwi r3,0x0
stream.Write(PowerPcAsm.cmpwi(3, 0));
// -- if a map id is -1, make the map icon invisible --
hijackAddr = addressMapper.toVersionAgnosticAddress((BSVAddr)0x8021e73c);
var returnContinueAddr = addressMapper.toVersionAgnosticAddress((BSVAddr)0x8021e740);
var returnMakeInvisibleAddr = addressMapper.toVersionAgnosticAddress((BSVAddr)0x8021e808);
var subroutineMakeNoneMapIconsInvisible = allocate(writeSubroutineMakeNoneMapIconsInvisible(addressMapper, VAVAddr.NullAddress, returnContinueAddr, returnMakeInvisibleAddr), "SubroutineMakeNoneMapIconsInvisibleMultiplayer");
stream.Seek(addressMapper.toFileAddress(subroutineMakeNoneMapIconsInvisible), SeekOrigin.Begin);
stream.Write(writeSubroutineMakeNoneMapIconsInvisible(addressMapper, subroutineMakeNoneMapIconsInvisible, returnContinueAddr, returnMakeInvisibleAddr)); // re-write the routine again since now we know where it is located in the main dol
// lwz r0,0x184(r3) -> b subroutineMakeNoneMapIconsInvisible
stream.Seek(addressMapper.toFileAddress(hijackAddr), SeekOrigin.Begin); stream.Write(PowerPcAsm.b(hijackAddr, subroutineMakeNoneMapIconsInvisible));
// -- if the map id is -1, do not check if it has been unlocked or not ---
hijackAddr = addressMapper.toVersionAgnosticAddress((BSVAddr)0x8021e570);
returnContinueAddr = addressMapper.toVersionAgnosticAddress((BSVAddr)0x8021e574);
var returnSkipMapUnlockedCheck = addressMapper.toVersionAgnosticAddress((BSVAddr)0x8021e5a8);
var subroutineWriteSubroutineSkipMapUnlockCheck = allocate(writeSubroutineSkipMapUnlockCheck(addressMapper, VAVAddr.NullAddress, returnContinueAddr, returnSkipMapUnlockedCheck), "SubroutineWriteSubroutineSkipMapUnlockCheck");
stream.Seek(addressMapper.toFileAddress(subroutineWriteSubroutineSkipMapUnlockCheck), SeekOrigin.Begin);
stream.Write(writeSubroutineSkipMapUnlockCheck(addressMapper, subroutineWriteSubroutineSkipMapUnlockCheck, returnContinueAddr, returnSkipMapUnlockedCheck)); // re-write the routine again since now we know where it is located in the main dol
// or r3,r26,r26 -> b subroutineWriteSubroutineSkipMapUnlockCheck
stream.Seek(addressMapper.toFileAddress(hijackAddr), SeekOrigin.Begin); stream.Write(PowerPcAsm.b(hijackAddr, subroutineWriteSubroutineSkipMapUnlockCheck));
// --- Various Map UI Fixes ---
// -- if the map index is over the map array size, do not loop around to the first map index again --
// ble 0x80187e1c -> b 0x80187e1c
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x80187dfc), SeekOrigin.Begin); stream.Write(PowerPcAsm.b(8));
// -- fix map selection going out of bounds in tour mode --
// bne 0x80188258 -> nop
stream.Seek(addressMapper.toFileAddress((BSVAddr)0x80188230), SeekOrigin.Begin); stream.Write(PowerPcAsm.nop());
}
