Help:Patching the motorcycle area checks - Revision history

imported>Leoetlino: remove a pretty much unused category

2019-07-31T06:53:08Z

remove a pretty much unused category

← Older revision		Revision as of 06:53, 31 July 2019
Line 145:		Line 145:

	[[Category:Guides]]		[[Category:Guides]]
	~~[[Category:Guides (executable hacking)]]~~

imported>Leoetlino: RideMgr -> MotorcycleMgr

2018-12-29T18:38:52Z

RideMgr -> MotorcycleMgr

← Older revision		Revision as of 18:38, 29 December 2018
Line 38:		Line 38:
	Called from the Motorcycle AI root code.		Called from the Motorcycle AI root code.

	<source lang="cpp">if ( v6 && !~~RideMgr~~::motorcycleCanBeUsed(v6, (float *)&v68, 0LL) ) // 0x71004ADF18		<source lang="cpp">if ( v6 && !MotorcycleMgr::motorcycleCanBeUsed(v6, (float *)&v68, 0LL) ) // 0x71004ADF18
	goto triggerDisappear;</source>		goto triggerDisappear;</source>
	Either change the condition to be always false, or change <code>~~RideMgr~~::motorcycleCanBeUsed</code> (preferred to avoid side effects):		Either change the condition to be always false, or change <code>MotorcycleMgr::motorcycleCanBeUsed</code> (preferred to avoid side effects):

	<source lang="cpp">bool ~~RideMgr~~::motorcycleCanBeUsed(~~RideMgr~~* this, Vec3 *positions, __int64 a3) // 0x7100679D10		<source lang="cpp">bool MotorcycleMgr::motorcycleCanBeUsed(MotorcycleMgr* this, Vec3 *positions, __int64 a3) // 0x7100679D10
	{		{
	if ( (a3 \|\| (a3 = ActorSystem::sInstance->field_C0) != 0)		if ( (a3 \|\| (a3 = ActorSystem::sInstance->field_C0) != 0)
Line 65:		Line 65:
	=== Rune UI/sound effect ===		=== Rune UI/sound effect ===

	Same climate based check as above, but done in a different ~~RideMgr~~ function. Just change:		Same climate based check as above, but done in a different MotorcycleMgr function. Just change:

	<source lang="armasm">.text:0000007100679650 TBNZ W8, #0, loc_710067965C</source>		<source lang="armasm">.text:0000007100679650 TBNZ W8, #0, loc_710067965C</source>
Line 75:		Line 75:
	==== Check 1 ====		==== Check 1 ====

	Deep in some ~~RideMgr~~ function, called from the PlayerNormal AI:		Deep in some MotorcycleMgr function, called from the PlayerNormal AI:

	<source lang="cpp">else if ( !WorldMgr::sInstance		<source lang="cpp">else if ( !WorldMgr::sInstance
Line 94:		Line 94:
	==== Check 2 ====		==== Check 2 ====

	Found in another ~~RideMgr~~ member function and also called from the PlayerNormal AI code.		Found in another MotorcycleMgr member function and also called from the PlayerNormal AI code.

	<source lang="cpp">bool ~~RideMgr~~::checkUsable2(~~RideMgr~~ *this, __int64 a2)		<source lang="cpp">bool MotorcycleMgr::checkUsable2(MotorcycleMgr *this, __int64 a2)
	{		{
	if ( this->someFlag == 1 )		if ( this->someFlag == 1 )
	return 0;		return 0;
	float* v4 = this->gap12C;		float* v4 = this->gap12C;
	~~RideMgr~~::x_7(this, (float *)this->gap12C, (__int64)&this->field_134 + 4);		MotorcycleMgr::x_7(this, (float *)this->gap12C, (__int64)&this->field_134 + 4);
	if ( a2 \|\| (a2 = ActorSystem::sInstance->field_C0) != 0 )		if ( a2 \|\| (a2 = ActorSystem::sInstance->field_C0) != 0 )
	{		{
Line 140:		Line 140:
	==== 6 or 7 other checks ====		==== 6 or 7 other checks ====

	The ~~RideMgr~~ function at 0x7100678E80 (which can be identified with a xref to "GameROMMotorcycle") calls 6 member functions that must all return true; otherwise, the motorcycle cannot be used.		The MotorcycleMgr function at 0x7100678E80 (which can be identified with a xref to "GameROMMotorcycle") calls 6 member functions that must all return true; otherwise, the motorcycle cannot be used.

	The first 4 functions appear to be using the Havok AI NavMesh system. Something called “motorcycle shape cast” is used in the 3 other functions.		The first 4 functions appear to be using the Havok AI NavMesh system. Something called “motorcycle shape cast” is used in the 3 other functions.

imported>Leoetlino at 18:56, 11 November 2018

2018-11-11T18:56:02Z

← Older revision		Revision as of 18:56, 11 November 2018
Line 1:		Line 1:
	Because of arbitrary, hardcoded limitations, the Master Cycle Zero cannot be used in some areas. This article lists and documents checks that must be patched to remove usage restrictions.		Because of arbitrary, hardcoded limitations, the Master Cycle Zero cannot be used in some areas. This article lists and documents checks that must be patched to remove usage restrictions.

	Most of them are located in ~~“RideMgr” (unofficial name) which manages both horses{{check}} and~~ the ~~Master Cycle Zero~~.		Most of them are located in the MotorcycleMgr.

	== Check ==		== Check ==

imported>Leoetlino at 11:30, 7 October 2018

2018-10-07T11:30:25Z

← Older revision		Revision as of 11:30, 7 October 2018
Line 1:		Line 1:
	~~The~~ Master Cycle Zero cannot be used in some areas. This article lists and documents checks that must be patched to remove usage restrictions.		Because of arbitrary, hardcoded limitations, the Master Cycle Zero cannot be used in some areas. This article lists and documents checks that must be patched to remove usage restrictions.

	Most of them are located in ~~a component that is nicknamed the “ride manager”~~ (~~or “RideMgr” when following BotW’s naming conventions~~) ~~since it~~ manages both horses{{check}} and the Master Cycle Zero.		Most of them are located in “RideMgr” (unofficial name) which manages both horses{{check}} and the Master Cycle Zero.

			== Check ==
	The game uses the current climate for the area check<ref>[https://github.com/leoetlino/botw-re-notes/blob/2c0b98c1d5e4cb35a11d4a3ea764323432a596ea/tools/check_master_cycle_ok_areas Extracted check from Switch 1.5.0]</ref>:		The game uses the current climate for the area check<ref>[https://github.com/leoetlino/botw-re-notes/blob/2c0b98c1d5e4cb35a11d4a3ea764323432a596ea/tools/check_master_cycle_ok_areas Extracted check from Switch 1.5.0]</ref>:

Line 25:		Line 26:
	* ✅ KorogForest		* ✅ KorogForest
	* 🚫 GerudoDesertClimateLv2		* 🚫 GerudoDesertClimateLv2

	~~''Note: the addresses in this article are only valid for Switch 1.5.0. Other versions (on Switch or Wii U) can be patched in a similar way, though.''~~

	== Patching ==		== Patching ==
Line 33:		Line 32:

	== Technical details ==		== Technical details ==
			''Note: the addresses below are only valid for Switch 1.5.0. Other versions (on Switch or Wii U) can be patched in a similar way, though.''

	=== Disappearing when entering a blacklisted climate ===		=== Disappearing when entering a blacklisted climate ===

imported>Leoetlino:

 -> armasm

2018-09-25T18:33:32Z

<pre> -> armasm

imported>Leoetlino: /* Disappearing when entering a blacklisted climate */

2018-09-25T18:32:39Z

Disappearing when entering a blacklisted climate

← Older revision		Revision as of 18:32, 25 September 2018
Line 57:		Line 57:
	Patch:		Patch:

	<~~pre~~>.text:0000007100679D84 AND W0, W8, #1</~~pre~~>		<source lang="armasm">.text:0000007100679D84 AND W0, W8, #1</source>
	To:		To:

	<~~pre~~>.text:0000007100679D84 MOV W0, #1</~~pre~~>		<source lang="armasm">.text:0000007100679D84 MOV W0, #1</source>

	=== Rune UI/sound effect ===		=== Rune UI/sound effect ===

imported>Leoetlino at 18:31, 25 September 2018

2018-09-25T18:31:22Z

← Older revision		Revision as of 18:31, 25 September 2018
Line 32:		Line 32:
	* On Wii U, the checks are implemented in the exact same way (which makes sense since it's the same codebase), but only a single instruction has to be patched because the Wii U compiler is not quite as good at inlining functions. Simply patch the instruction at <code>0x02A32A30</code> to <code>li r3, 1</code>.		* On Wii U, the checks are implemented in the exact same way (which makes sense since it's the same codebase), but only a single instruction has to be patched because the Wii U compiler is not quite as good at inlining functions. Simply patch the instruction at <code>0x02A32A30</code> to <code>li r3, 1</code>.

	== Disappearing when entering a blacklisted climate ==		== Technical details ==
			=== Disappearing when entering a blacklisted climate ===

	Called from the Motorcycle AI root code.		Called from the Motorcycle AI root code.
Line 60:		Line 61:

	<pre>.text:0000007100679D84 MOV W0, #1</pre>		<pre>.text:0000007100679D84 MOV W0, #1</pre>
	== Rune UI/sound effect ==		=== Rune UI/sound effect ===

	Same climate based check as above, but done in a different RideMgr function. Just change:		Same climate based check as above, but done in a different RideMgr function. Just change:
Line 68:		Line 69:

	<pre>.text:0000007100679650 B loc_710067965C</pre>		<pre>.text:0000007100679650 B loc_710067965C</pre>
	== Refusing to spawn when in a blacklisted climate ==		=== Refusing to spawn when in a blacklisted climate ===

	=== Check 1 ===		==== Check 1 ====

	Deep in some RideMgr function, called from the PlayerNormal AI:		Deep in some RideMgr function, called from the PlayerNormal AI:
Line 89:		Line 90:
	so that the game always executes the code inside of the if block.		so that the game always executes the code inside of the if block.

	=== Check 2 ===		==== Check 2 ====

	Found in another RideMgr member function and also called from the PlayerNormal AI code.		Found in another RideMgr member function and also called from the PlayerNormal AI code.
Line 117:		Line 118:
	to make the game always return “true”.		to make the game always return “true”.

	== Disappearing when being away from the motorcycle ==		=== Disappearing when being away from the motorcycle ===

	This is checked by Motorcycle AI root code (at 0x71004ADF28).		This is checked by Motorcycle AI root code (at 0x71004ADF28).
Line 127:		Line 128:
	It is easy to change this condition to be always false.		It is easy to change this condition to be always false.

	== Other checks ==		=== Other checks ===

	There are a few more conditions for spawning the motorcycle<ref>0x7100678E80 in Switch 1.5.0</ref>; however patching them is not recommended as they are implemented for good reasons.		There are a few more conditions for spawning the motorcycle<ref>0x7100678E80 in Switch 1.5.0</ref>; however patching them is not recommended as they are implemented for good reasons.

	=== Actor check ===		==== Actor check ====

	If the actor cannot be loaded, the game will not allow the player to use the motorcycle and will show the regular “You can’t use that here” message.		If the actor cannot be loaded, the game will not allow the player to use the motorcycle and will show the regular “You can’t use that here” message.

	=== 6 or 7 other checks ===		==== 6 or 7 other checks ====

	The RideMgr function at 0x7100678E80 (which can be identified with a xref to "GameROMMotorcycle") calls 6 member functions that must all return true; otherwise, the motorcycle cannot be used.		The RideMgr function at 0x7100678E80 (which can be identified with a xref to "GameROMMotorcycle") calls 6 member functions that must all return true; otherwise, the motorcycle cannot be used.

imported>Leoetlino at 18:30, 25 September 2018

2018-09-25T18:30:27Z

← Older revision		Revision as of 18:30, 25 September 2018
Line 26:		Line 26:
	* 🚫 GerudoDesertClimateLv2		* 🚫 GerudoDesertClimateLv2

	''Note: the addresses in this article are only valid for Switch 1.5.0. Other versions (on Switch or Wii U) can be patched in a similar way, though. On Wii U, ~~there~~ are ~~fewer occurrences of~~ the ~~check~~ because the compiler is not as good ~~as GCC~~/~~clang at optimisations~~.''		''Note: the addresses in this article are only valid for Switch 1.5.0. Other versions (on Switch or Wii U) can be patched in a similar way, though.''

			== Patching ==
			* On Switch, read the rest of the article to understand what to patch.
			* On Wii U, the checks are implemented in the exact same way (which makes sense since it's the same codebase), but only a single instruction has to be patched because the Wii U compiler is not quite as good at inlining functions. Simply patch the instruction at <code>0x02A32A30</code> to <code>li r3, 1</code>.

	== Disappearing when entering a blacklisted climate ==		== Disappearing when entering a blacklisted climate ==

imported>Leoetlino: /* 6 or 7 other checks */

2018-09-17T17:13:38Z

6 or 7 other checks

← Older revision		Revision as of 17:13, 17 September 2018
Line 133:		Line 133:
	=== 6 or 7 other checks ===		=== 6 or 7 other checks ===

	The RideMgr function at 0x7100678E80 calls 6 member functions that must all return true; otherwise, the motorcycle cannot be used.		The RideMgr function at 0x7100678E80 (which can be identified with a xref to "GameROMMotorcycle") calls 6 member functions that must all return true; otherwise, the motorcycle cannot be used.

	The first 4 functions appear to be using the Havok AI NavMesh system. Something called “motorcycle shape cast” is used in the 3 other functions.		The first 4 functions appear to be using the Havok AI NavMesh system. Something called “motorcycle shape cast” is used in the 3 other functions.

imported>Leoetlino at 19:11, 16 September 2018

2018-09-16T19:11:00Z

← Older revision		Revision as of 19:11, 16 September 2018
Line 138:		Line 138:

	[[Category:Guides]]		[[Category:Guides]]
			[[Category:Guides (executable hacking)]]

← Older revision		Revision as of 18:33, 25 September 2018
Line 66:		Line 66:
	Same climate based check as above, but done in a different RideMgr function. Just change:		Same climate based check as above, but done in a different RideMgr function. Just change:

	<~~pre~~>.text:0000007100679650 TBNZ W8, #0, loc_710067965C</~~pre~~>		<source lang="armasm">.text:0000007100679650 TBNZ W8, #0, loc_710067965C</source>
	to:		to:

	<~~pre~~>.text:0000007100679650 B loc_710067965C</~~pre~~>		<source lang="armasm">.text:0000007100679650 B loc_710067965C</source>
	=== Refusing to spawn when in a blacklisted climate ===		=== Refusing to spawn when in a blacklisted climate ===

Line 85:		Line 85:
	Patch:		Patch:

	<~~pre~~>.text:0000007100679BA8 CBZ X0, loc_7100679BD8</~~pre~~>		<source lang="armasm">.text:0000007100679BA8 CBZ X0, loc_7100679BD8</source>
	to:		to:

	<~~pre~~>.text:0000007100679BA8 B loc_7100679BD8</~~pre~~>		<source lang="armasm">.text:0000007100679BA8 B loc_7100679BD8</source>
	so that the game always executes the code inside of the if block.		so that the game always executes the code inside of the if block.

Line 113:		Line 113:
	Change:		Change:

	<~~pre~~>.text:000000710067B5FC CBZ X0, loc_710067B62C</~~pre~~>		<source lang="armasm">.text:000000710067B5FC CBZ X0, loc_710067B62C</source>
	to:		to:

	<~~pre~~>.text:000000710067B5FC B loc_710067B62C</~~pre~~>		<source lang="armasm">.text:000000710067B5FC B loc_710067B62C</source>
	to make the game always return “true”.		to make the game always return “true”.