summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAnghelo Carvajal <angheloalf95@gmail.com>2023-03-09 14:35:23 -0300
committerGitHub <noreply@github.com>2023-03-09 12:35:23 -0500
commitc833969ea79ba31c3103e25e94ef88098c0287de (patch)
treebc60d4135593ee06a17dff9972ef80b794c89982 /docs
parent496b4928ea8bdf310949a88bbe221d91c2d3ebff (diff)
`z_actor` documentation pass (#1154)
* ActorContext_unk_1F4 * a * ACTOR_FLAG_IGNORE_QUAKE * ACTOR_FLAG_TALK_REQUESTED and ACTOR_FLAG_CANT_LOCK_ON * actorCtx->unkC => ctorCtx->halfDaysBit * HALFDAYBIT defines * actor.halfDaysBits * format * Actor_InitHalfDaysBit * Name actor-killing functions * cleanup variables.h a bit * DAWN * bss * Actor_RequestRumble and Actor_GetArrowDmgFlags * name vars of func_800BC620 * format * fix missing PLAYER_IA * Actor_OfferGetItem * Actor_SetClosestSecretDistance * freezeCategoryPlayerFlags1 Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * DROPFLAG_ * a * COLORFILTER * format * sCategoryFreezeMasks * Actor_OfferCarry * review Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * change hex to dec * COLORFILTER_INTENSITY_FLAG * format * review Co-authored-by: Derek Hensley <hensley.derek58@gmail.com> * shiftedHalfDaysBit Co-authored-by: Derek Hensley <hensley.derek58@gmail.com> * cleanup * Undo Actor_RequestRumble * Undo ACTOR_FLAG_IGNORE_QUAKE * format * Remove COLORFILTER_GET_BUFFLAG * Undo Actor_KillAllFromUnloadedRooms * format * Update Actor_OfferGetItem comment * Update Actor_OfferGetItem description * diving * bss * namefixer * format * speed * review --------- Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/tutorial/advanced_control_flow.md34
-rw-r--r--docs/tutorial/introduction.md4
2 files changed, 19 insertions, 19 deletions
diff --git a/docs/tutorial/advanced_control_flow.md b/docs/tutorial/advanced_control_flow.md
index 48ef9661b..95b0d6b86 100644
--- a/docs/tutorial/advanced_control_flow.md
+++ b/docs/tutorial/advanced_control_flow.md
@@ -107,7 +107,7 @@ void func_809529AC(EnMs* this, PlayState* play) {
func_800B8500(&this->actor, play, this->actor.xzDistToPlayer, this->actor.playerHeightRel, 0);
this->actionFunc = func_80952A1C;
} else {
- Actor_PickUp(&this->actor, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
+ Actor_OfferGetItem(&this->actor, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
}
}
@@ -168,7 +168,7 @@ void func_809527F8(EnMs* this, PlayState* play) {
}
if (Message_ShouldAdvance(play) != 0) {
func_801477B4(play);
- Actor_PickUp((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
this->actionFunc = func_809529AC;
return;
}
@@ -198,7 +198,7 @@ void func_809527F8(EnMs* this, PlayState* play) {
return;
}
func_8019F208();
- Actor_PickUp((Actor *) this, play, 0x35, 90.0f, 10.0f);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
Rupees_ChangeBy(-0xA);
this->actionFunc = func_809529AC;
}
@@ -257,7 +257,7 @@ block_5:
goto block_17;
}
func_801477B4(play);
- Actor_PickUp((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
this->actionFunc = func_809529AC;
return;
block_7:
@@ -289,7 +289,7 @@ block_13:
return;
block_15:
func_8019F208();
- Actor_PickUp((Actor *) this, play, 0x35, 90.0f, 10.0f);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
Rupees_ChangeBy(-0xA);
this->actionFunc = func_809529AC;
return;
@@ -360,7 +360,7 @@ block_5:
goto block_17;
}
func_801477B4(play);
- Actor_PickUp((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
this->actionFunc = func_809529AC;
return;
block_7:
@@ -390,7 +390,7 @@ block_11:
}
func_8019F208();
- Actor_PickUp((Actor *) this, play, 0x35, 90.0f, 10.0f);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
Rupees_ChangeBy(-0xA);
this->actionFunc = func_809529AC;
return;
@@ -429,7 +429,7 @@ block_5:
return;
}
func_801477B4(play);
- Actor_PickUp((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
this->actionFunc = func_809529AC;
return;
block_7:
@@ -459,7 +459,7 @@ block_11:
}
func_8019F208();
- Actor_PickUp((Actor *) this, play, 0x35, 90.0f, 10.0f);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
Rupees_ChangeBy(-0xA);
this->actionFunc = func_809529AC;
return;
@@ -509,7 +509,7 @@ So let us rewrite the entire second half as a switch:
}
func_8019F208();
- Actor_PickUp((Actor *) this, play, 0x35, 90.0f, 10.0f);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
Rupees_ChangeBy(-0xA);
this->actionFunc = func_809529AC;
return;
@@ -541,7 +541,7 @@ There's a couple of other obvious things here:
func_80151938(play, 0x937U);
} else {
func_8019F208();
- Actor_PickUp((Actor *) this, play, 0x35, 90.0f, 10.0f);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
Rupees_ChangeBy(-0xA);
this->actionFunc = func_809529AC;
}
@@ -589,7 +589,7 @@ block_5:
return;
}
func_801477B4(play);
- Actor_PickUp((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
this->actionFunc = func_809529AC;
return;
block_7:
@@ -606,7 +606,7 @@ block_7:
func_80151938(play, 0x937U);
} else {
func_8019F208();
- Actor_PickUp((Actor *) this, play, 0x35, 90.0f, 10.0f);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
Rupees_ChangeBy(-0xA);
this->actionFunc = func_809529AC;
}
@@ -653,7 +653,7 @@ void func_809527F8(EnMs* this, PlayState* play) {
return;
}
func_801477B4(play);
- Actor_PickUp((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
this->actionFunc = func_809529AC;
break;
@@ -671,7 +671,7 @@ void func_809527F8(EnMs* this, PlayState* play) {
func_80151938(play, 0x937U);
} else {
func_8019F208();
- Actor_PickUp((Actor *) this, play, 0x35, 90.0f, 10.0f);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
Rupees_ChangeBy(-0xA);
this->actionFunc = func_809529AC;
}
@@ -704,7 +704,7 @@ void func_809527F8(EnMs* this, PlayState* play) {
case 5:
if (Message_ShouldAdvance(play) != 0) {
func_801477B4(play);
- Actor_PickUp((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
this->actionFunc = func_809529AC;
}
break;
@@ -723,7 +723,7 @@ void func_809527F8(EnMs* this, PlayState* play) {
func_80151938(play, 0x937U);
} else {
func_8019F208();
- Actor_PickUp((Actor *) this, play, 0x35, 90.0f, 10.0f);
+ Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
Rupees_ChangeBy(-0xA);
this->actionFunc = func_809529AC;
}
diff --git a/docs/tutorial/introduction.md b/docs/tutorial/introduction.md
index 2115faace..aba8beede 100644
--- a/docs/tutorial/introduction.md
+++ b/docs/tutorial/introduction.md
@@ -27,7 +27,7 @@ glabel func_809529AC
/* 0003D8 809529F8 C484009C */ lwc1 $f4, 0x9c($a0)
/* 0003DC 809529FC 8C870098 */ lw $a3, 0x98($a0)
/* 0003E0 80952A00 24060035 */ addiu $a2, $zero, 0x35
-/* 0003E4 80952A04 0C02E287 */ jal Actor_PickUp
+/* 0003E4 80952A04 0C02E287 */ jal Actor_OfferGetItem
/* 0003E8 80952A08 E7A40010 */ swc1 $f4, 0x10($sp)
.L80952A0C:
/* 0003EC 80952A0C 8FBF001C */ lw $ra, 0x1c($sp)
@@ -46,7 +46,7 @@ void func_809529AC(EnMs* this, PlayState* play) {
func_800B8500(&this->actor, play, this->actor.xzDistToPlayer, this->actor.playerHeightRel, 0);
this->actionFunc = func_80952A1C;
} else {
- Actor_PickUp(&this->actor, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
+ Actor_OfferGetItem(&this->actor, play, 0x35, this->actor.xzDistToPlayer, this->actor.playerHeightRel);
}
}
```