1
0
Fork 0
mirror of https://github.com/zeldaret/oot.git synced 2024-12-05 01:06:37 +00:00
Commit graph

1086 commits

Author SHA1 Message Date
krm01
2aaa286cf8
[Doc] Actor Bg_Hidan_Fslift (Fire Temple hookshot elevator) (#1579)
* doc bg_hidan_fslift

* improve name for hookshot block pos function

* comment explaining cameraSetting

* improve comment

* Update src/overlays/actors/ovl_Bg_Hidan_Fslift/z_bg_hidan_fslift.c

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

* rename to Idle

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2023-11-19 13:34:25 -05:00
engineer124
aef0335681
Struct Returns (#1574)
* change args

* PR Review

* format
2023-11-19 11:17:31 -05:00
engineer124
3d1ee33d7b
Document Actor "OfferTalk" (#1567)
* OfferTalk

* rm comment

* exch to offer in comment

* reword again

* Partial PR Review

* Actor_AcknowledgeTalking

* Actor_TalkOfferAccepted

* PR Review

* rm part of comment

* rm comment
2023-11-19 11:11:59 -05:00
fig02
c11ce9c994
Player Docs: Some Item Action function names (#1575)
* progress

* unname shield upper action

* add more to sword comment
2023-11-19 09:38:49 -05:00
hiisuya
68bdbf7759
Doc Actor: En_Brob (Jabu Jabu Wobble Flesh Block) (#1581)
* brob function naming

* modified brob header file

* renamed skel, collision, and anims

* named limbs and dls

* renamed shock function

* ran formatter

* doc modifications

* Update assets/xml/objects/object_brob.xml

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2023-11-19 05:11:52 -05:00
engineer124
81a3c3da32
More Camera Flags (#1453)
* Generic Camera Flags

* New flag names

* Add flags to functions

* Finish flag docs

* More docs

* More cleanup

* More clarity

* Better shrinkwindow flag docs

* Improve name

* CAM_INTERFACE_FLAGS

* Better approach to edge cases

* Change ordering for consistency

* Oops

* Add masks to macro

* PR/Discord discussions

* cleanup comment

* Oops

* PR Suggestions

* More PR Feedback

* More PR Suggestions

* More Camera Flags

* PR Suggestions

* More flag style change

* Small cleanup

* More flag docs

* Another flag

* Fix flags

* sync names with other PRs

* more fixes

* fix comments

* update with hud visibility mode docs

* missed one

* fix comments

* Roman PR Suggestions

* interfaceField

* small fix

* letterbox cleanup

* cleanup

* fix macro arg

* fix func declaration

* many more docs

* better docs?

* missed some

* oops, revert

* add flags to name

* cleanup

* flag

* double signal

* simplify cam func name

* more suggestions

* PR Suggestion
2023-11-19 02:17:32 +01:00
krm01
d1df4e4c7e
bombowlman typo (#1582) 2023-11-18 12:30:36 -05:00
krm01
0a48348f8d
doc for menkuri_eye (#1580) 2023-11-14 14:20:23 -05:00
Dragorn421
4c75260097
Fix misc 21 (#1573)
* Make `sNew` in (unused) `code_800FC620.c` a string

It is passed as a filename to `__osMallocDebug` so should be a nul-terminated string, not a char[3] missing an explicit \0

* Fix gcc warning in `JpegDecoder_ParseNextSymbol` about SLL on negative value

-1U is an unsigned value, aka 0xFFFFFFFF
I keep -1 because it seems that's what a jpeg standard has too

References:
https://stackoverflow.com/questions/40508958/shifting-a-negative-signed-value-is-undefined
https://www.w3.org/Graphics/JPEG/itu-t81.pdf (page 105, figure F.12)

* Small cleanup

* Fix few mistakes (thanks gcc warnings)

* Add `@bug` in file select settings draw code, using the wrong array

* format

* format main

* rename arg for a happy formatter

* Move important function call out of a printf
2023-11-12 16:59:52 -05:00
fig02
836adb83ea
Rename "ITEM_LAST_USED" (#1572)
* rename

* format

* remove formatter changes

* change model group comments
2023-11-07 14:11:59 -05:00
fig02
042a5c5530
rename to upper action (#1570) 2023-11-04 02:59:12 -04:00
Dragorn421
8718a5c8c0
Remove (ActorFunc) casts in initvars (#1571)
* Remove `(ActorFunc)` casts in initvars, use `/**/` trick for format

Achieved by using the following regex:

(ActorInit.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(?:\(ActorFunc\))?(.*)(\n\s+)(?:\(ActorFunc\))?(.*)(\n\s+)(?:\(ActorFunc\))?(.*)(\n\s+)(?:\(ActorFunc\))?(.*\n\};)

replaced with

$1$2/**/ $3$4/**/ $5$6/**/ $7$8/**/ $9$10/**/ $11$12/**/ $13$14/**/ $15$16/**/ $17$18/**/ $19

plus a change from /**/ to #if 0 #endif in docs/

* Manual fixes
2023-10-30 10:19:16 -04:00
fig02
4908b8b37c
Player Docs: public facing csAction things (#1561)
* name public csAction functions

* format

* adjust function comment

* format
2023-10-28 07:46:24 -04:00
Tharo
3475651701
libc cleanup (#1568)
* libc cleanup

* Suggested changes, small alloca tweak

* Remove printf include
2023-10-27 16:06:44 +02:00
Tharo
a20163c6ab
Use long over int for s32/u32 types (#1546)
* long s32

* Suggested changes
2023-10-17 21:16:31 +02:00
fig02
181b438393
Player Docs: Propose Named Unions For Shared Variables (#1560)
* make unions

* format

* adjust comment on halt thing
2023-10-07 19:25:45 -04:00
fig02
ebc6ebf232
Player Docs: Initial AnimSfx stuff (#1556)
* initial animsfx docs

* review

* extra space
2023-10-05 10:22:40 -04:00
engineer124
c39578f971
Introduce Player CueIds (#1559)
* cueId

* cleanup
2023-10-05 10:04:41 -04:00
fig02
c5e4357127
initial action-change-list docs (#1540) 2023-09-27 11:02:21 -04:00
fig02
2cb4ff4fd3
Player Docs: csMode -> csAction (#1547)
* csmode -> cs action

* format
2023-09-26 12:48:41 -04:00
engineer124
873c55faad
Improve Matches: Part 4 (#1545)
* more improvements

* small cleanup

* PR Review
2023-09-24 17:51:03 +02:00
engineer124
d7f6961918
Improve Matches: Part 3 (#1544)
* improve matchings

* spacing
2023-09-20 12:41:47 -04:00
engineer124
72334df180
improve matching (#1543) 2023-09-20 10:54:44 -04:00
engineer124
a8d670fe5c
improve matches (#1542) 2023-09-20 10:41:03 -04:00
Billy
107c0288cc
Dekunut Salesman Docs (#1493)
* Dekunut Salesman Docs

* Update src/overlays/actors/ovl_En_Dns/z_en_dns.c

Remove extra param from debug logging

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

* * Full Deku/Potion name usage
* Dialog -> CanBuy
* Revert debug logging symbols
* Proper declaration spacing
* Fix en_shopnuts header doc
* Biz -> Business

* Fix missed deku prefix's

* Synchronize CanBuy sticks and nuts

* Fix enum naming

* Clarified CanBuy success values

* anon review

* fig review

* macro changes

* fix macro usage

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
Co-authored-by: fig02 <fig02srl@gmail.com>
2023-09-19 21:41:42 -04:00
fig02
da3f4718f0
Player docs: Control Stick Input and Movement (#1539)
* document input stuff and movement speed+yaw

* curve -> curved, and other cleanups

* fix + format

* function declaration

* name arguments

* add mode descriptions

* fix typos

* move comment down
2023-09-19 21:37:03 -04:00
Dragorn421
185c9cbf1a
Run formatter (#1541) 2023-09-19 15:01:00 -04:00
Dragorn421
57ce0cf8d9
Doc/Cleanup pass on object handling (#1227)
* `Object_InitBank` -> `Object_InitContext`

* Add and use `OBJECT_SPACE_SIZE_BASE`

* Remove `OBJECT_EXCHANGE_BANK_MAX` -> use `ARRAY_COUNT()` instead

* "object status" -> "object load entry"

* Misc. cleanup/renames

* Partial docs and way too much batch renaming and cleanup for a single commit

* ctrl shift h

* format

* format clang-11.1

* fix regressions

* Improve a `@bug` comment

* Move `OBJECT_SPACE_SIZE_BASE` from header to near `Object_InitContext`

* "objectID" -> "objectId"

* Revert iterator index to `i` in `Actor_KillActorsWithUnloadedObject`

* "object load entry index" -> "object entry"

* `Object_UpdateLoadEntries` -> `Object_UpdateEntries`

* Run format.sh

* "object entry" -> "object slot" (except internal usage)

* Proper `Object_SpawnPersistent` doc

Co-authored-by: fig02 <fig02srl@gmail.com>

* fixup one comment "object bank index" -> "object slot"

* Amend `Object_SpawnPersistent` comment to mention running out of free slots

* `Actor_KillActorsWithUnloadedObject` -> `Actor_KillAllWithMissingObject`

* Remove useless mention of what uses `Object_SpawnPersistent`

* Fix mistake on `Object_SpawnPersistent` doing sync dma, not async

* run formatter

* `Object_InitContext` -> `Object_Init`

* `waitObjectSlot` -> `requiredObjectSlot`

* `Object_Init` -> `func_80097DD8`

* one objectIndex -> objectSlot

* Remove `OBJECT_SPACE_SIZE_BASE`

* light fix on the merge (rm OBJECT_EXCHANGE_BANK_MAX)

* `func_80097DD8` -> `Object_InitContext`

---------

Co-authored-by: fig02 <fig02srl@gmail.com>
2023-09-19 14:10:12 -04:00
fig02
83a13a64c7
Document niche magic spell bug (#1526)
* document magic spell bug

* Update src/overlays/actors/ovl_player_actor/z_player.c

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

* adjust comment

* fix renamed func and reformat

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2023-09-19 13:23:56 -04:00
fig02
5170f2de17
Start Player Item Docs (#1523)
* item docs

* format

* loop change

* some of engineers review

* shorten comment (thanks formatter)

* ProcessItemButtons

* true/false
2023-09-18 00:08:43 -04:00
fig02
6c3e8d63cf
Name player's generic actionVars (#1538)
* name player generic vars

* format
2023-09-17 19:56:41 -04:00
Tharo
9b207c356a
Document Framebuffer Filters, VisCvg and VisZbuf (#1534)
* Document z_viscvg and z_viszbuf

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

* Few more notes

* Some more notes

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>

* Review

* Americanisation, FB RGB

* Oops

* Review

* Minor documentation modifications

* Header, base struct and enums

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>

* functions.h fix

* Suggested changes, further adjustments to file doc comments

* Further suggested changes, standardize capitalization of gfxP

* g

---------

Co-authored-by: Elliptic Ellipsis <elliptic.ellipsis@gmail.com>
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2023-09-16 17:16:58 -04:00
fig02
823e47a0f8
Player Docs: Name actionFunc (#1531)
* progress, going to merge master

* merge master

* finish renmaing functions

* reorder declarations
2023-09-13 20:34:07 -04:00
fig02
bedf07d541
Document Player's bgcheck routine (func_80847BA0) (#1503)
* progress

* progress

* progress

* done for now

* floor pitch comments

* sYDistToFloor

* add function comment

* sFloorShapePitch

* typo in header
2023-09-06 13:15:07 -04:00
Dragorn421
527c3ba704
Player doc: anim wrappers (#1437)
* Player doc: anim wrappers

* revert name callbacks in `D_80854AA4`

* Adj -> Adjusted

* format

* Add `PLAYER_ANIM_ADJUSTED_SPEED`

* format

* Add a comment on `Player_AnimReplaceApplyFlags`

---------

Co-authored-by: fig02 <fig02srl@gmail.com>
2023-09-06 12:43:50 -04:00
Dragorn421
d314cfe923
Document pause states (excluding gameover) (#1483)
* Document PauseContext.state

* Very light docs surrounding pause states

* PAUSE_STATE_UNPAUSE -> PAUSE_STATE_RESUME_GAMEPLAY and comment on purpose in the enum

* PAUSE_STATE_MAIN -> PAUSE_STATE_6

* format

* Player_InitDrawPause -> Player_InitPauseDrawData
2023-09-06 11:14:15 -04:00
blackgamma7
475b8a1eba
z_fishing partially documented (#1424)
* Document z_Fishing

Document code and data RE: Fishing minigame.

* More z_fishing.c progress

Id's more values, added flag for "High score" entries

* moved and renamed Fishing flags

Flags moved outside z_fishing.c - ending sequence checks for "hat stolen" flag.

* more fishing.c Id'ing

added more id's and clarification.

* Update z_fishing.h

clarified not about fish weight.

* more z_fishing.c documenting

missed a bitfeiled in the fishing "highScores" that kept track of your number of fishing trips

* Update z64save.h

a #define got lost for the "fishing games played" increment

* z_fishing: a few formatting and naming changes based on feedback

- removed comments summing textboxes as it was deemed redundant
- tried to unify fish measurment as "length"
- clarified a few vars based on name
- formatted single-line comments to have one space.

* Update z_fishing.c

ran format.py and fixle.sh

* Update z_fishing.c

changed code around a few bools that was still matching.

* `z_en_Fishing`: changes from feedback, id'd rotate phase fields.

* Update z_fishing.c

merge fix

* `z_fishing`: More doc'ing.

* `z_fishing`: changes based on feedback

* `z_fishing`: fixed typo

* `z_fishing`: merge with master

* Update z_fishing.c

sSinkingLureLocationPos was too redundant

* Merge fix, added more comments, #defines, id's

* Update z_fishing.c

adding EN_FISH_PARAM may have led to mismatch.

* `z_fishing`: fixed compare mismatch

* Update z64save.h

fix typo

* Update z_fishing.c

a few more id's
2023-09-06 10:58:17 -04:00
blackgamma7
b2787995f5
z_en_syateki_niw doc (#1449)
* SyatekiNiw doc

started id'ing funcs and fields for SyatekiNiw

* `z_en_syateki_niw` doc

* `z_en_syateki_niw1: (almost) all fields/funcs doc'd

* `z_en_syateki_niw` update

changes based on feedback.

* `z_en_syateki_niw`: limb fields renamed

* Update z_en_syateki_niw.h

renamed fields as suggested.

* Update src/overlays/actors/ovl_En_Syateki_Niw/z_en_syateki_niw.h

fix typo in comment.

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

* Update z_en_bom_bowl_man.c

add minigame enum to actor spawn param

* `z_en_syateki_niw`: updated based on feedback

renamed local vars for claritey, added more comments to struct.

* Update z_en_syateki_niw.c

renamed function and var based on feedback

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2023-08-23 22:50:09 +02:00
Billy
fc3e0f080b
En_Cow Doc (#1492)
* Add Documentation for Cows

* Better naming for cow unlock flag

* Update with MM solutions and PR suggestions

* Readable conditions

* Decimal cycle counter

* Replace params with cow type

* Clean up type usage and function names

* Clean up cylinders

* Fix collider enum

* Rename EnCow rear collider

* Fix spacing

* PR fixes:
COLL -> COLLIDER enum
static prefix
Missed MM function naming
Specific actor flags naming

* Rename of healRot and breathTimer

* Document Epona's song reset behavior

* anon review

* fig review

* whitespace

* rework milk interaction stuff

* changes to milk comment

---------

Co-authored-by: fig02 <fig02srl@gmail.com>
2023-08-19 11:34:48 -04:00
Dragorn421
d6207b17c2
Doc/cleanup pass on effects 1 (#1421)
* Some doc/cleanup on `Effect_Ss_Fhg_Flash`

* Some doc/cleanup on `Effect_Ss_Blast`

* 11DA0 -> Billboard

* doc three lerp funcs in effectss

* Some doc/cleanup on `Effect_Ss_Bomb`

* `rTexIdx` -> `rTexIndex`

* lifespan

* `LIFESPAN` -> `EFFSSBOMB_LIFESPAN`

* --parentheses

* Add todo about "having zapd forward declare static variables"

* try rework comments on effects scale

* lightning -> "a ball of electrical arcs" ?
2023-08-15 20:28:12 -04:00
Dragorn421
4dea0bfb26
Placeholder names for skelanime moveflags (#1489)
* Add defines for all used animflags

* Use named constants (and add two) for players `func_80832F54` flags

* note which flags are player-only

* Attempt at documenting but too FeelsUnkMan again

* forgot something

* ANIM_FLAG_PLAYER_0 -> ANIM_FLAG_0 and amend comment from "player-only" to "no effect outside player"

* 1<<n flags
2023-08-15 22:23:53 +02:00
engineer124
b8aa2a251e
Document z_lib Sfx Functions (#1470)
* document lib sfx

* rename functions
2023-08-15 01:44:20 -04:00
Dragorn421
6e7a6d4181
Split SaveContext into sub-structs (#1393)
* Split SaveContext struct

* run formatter

* Remove temporary-until-split stuff in z_sram

* .

* run formatter
2023-08-13 15:24:26 -04:00
engineer124
0ce0313342
Minor Misc Cleanup 3 (#1502)
* more misc cleanup

* remove z64 conflicts

* undo ISVDbg
2023-07-05 18:36:19 -04:00
adaliaramon
d3c6836df7
Removed unnecessarily duplicated variable (#1508) 2023-07-03 19:26:32 -04:00
Tom Overton
fe1b59eccc
Ensure all boss title cards are extracted as IA8 (#1512)
* Ensure all boss title cards are extracted as IA8

* Drop `Boss` from some of the title card names

* Format
2023-07-03 13:12:51 -04:00
engineer124
35887e25ee
Minor Misc Cleanup 2 (#1422)
* misc cleanup

* more cleanup

* more cleanup

* PR Suggestions

* cleanup cond
2023-02-26 21:48:42 +01:00
playerskel
9f0b7bb8a3
another round of trailing whitespaces (#1495) 2023-02-26 17:26:07 +01:00
Dragorn421
9f09505d34
Put comments on players sAgeProperties with field name (#1490) 2023-01-13 20:19:34 +01:00
Dragorn421
985dd7f520
EnHoll docs (door-less transition between rooms) (#1419)
* some EnHoll cleanup

* some more EnHoll cleanup

* even more EnHoll cleanup

* EnHoll docs

* `enHollFillAlpha` -> `bgCoverAlpha`

* Dl -> DL

* one temp: action -> type

* Move static data out of `EnHoll_HorizontalVisibleNarrow`

* "fade" -> "bgcover"

* spread sentence over several lines

* tweak comments formatting

Co-authored-by: fig02 <fig02srl@gmail.com>
2023-01-12 17:08:38 -05:00
EllipticEllipsis
5f7e376112
Document Bunny Hood 🐰 (#1373)
* Change BunnyEarKinematics struct and some docs

* More complete docs

* Format, quick note in the InitModes array

* remove comment and move struct down

Co-authored-by: fig02 <fig02srl@gmail.com>
2023-01-12 16:57:19 -05:00
engineer124
1149530c92
DbCamera to DebugCamera (#1482)
* better dbCam prefix

* missed some

* PR Suggestions

* alignment

* more debug

* cleanup
2023-01-12 16:06:31 -05:00
Dragorn421
542012efa6
Fix misc 19 (#1488)
* "bgs sword" -> "biggoron sword"

* Animation_ChangeImpl: last arg is `ANIMTAPER_` enum

* TransitionTileStatus -> state

* Tiny gbi.h formatting fixups

* some cleanup on floormaster

* misc float ops cleanup

* sunsSongState = SUNSSONG_INACTIVE

* continueFlag == CS_CMD_STOP

* fix few camera names inconsistency

* textual 0 padding? not on my lawn

* libultra: construct address from end of dmem rather than oob from imem

* more free1 -> 2 fixup
2023-01-10 13:03:31 -05:00
fig02
b4c97ce17e
Cleanup player speed and yaw variable names (#1480)
* initial changes

* add comments
2023-01-02 06:15:48 -05:00
fig02
e37b993483
Name movement related functions in z_actor (#1476)
* rename functions

* dragorns name suggestions

* Revert "dragorns name suggestions"

This reverts commit dd4626ce5e.

* lets try that again

* reword comment

* comments

* projectile speed

* arg name

* more comments

* minVelY comment

* merge master and format
2022-12-30 13:55:14 -05:00
fig02
04641a6b69
Document debug text drawing functions in z_debug.c (#1472)
* name functions and clean up some stuff

* clean up function call args and use enum, format

* slightly change comment

* review

* make things more debug cam oriented

* rename buffer

* regs update comment

* move enum
2022-12-30 02:23:09 +01:00
fig02
7927e7b330
z_demo documentation (#1327)
* commit old stuff

* progress

* progress

* progress

* progress

* more progress, renaming cues next

* small changes

* enum values added for all actions

* hardcoded values removed when possible

* commands renamed

* first pass of action -> cue

* fix some matches

* some more cleanup

* scriptPtr

* forgot one

* remove cue rot union

* more changes

* some more stuff

* more stuff

* fix matching issues

* some more things

* progress, starting to rename destinations

* small changes

* name some destinations

* more names

* need to switch branch

* progress

* first pass of destination names

* usages fixed

* use destination enum

* fix csdis

* format

* command descriptions

* revert accidental zap changes

* forgot some things

* use a single macro for CutsceneCameraPoint (idk why i didnt think of this sooner)

* typo

* review1

* clarify ruby/sapphire comment

* remove endframe for commands that dont use it

* some more review

* most review, but not all

* scriptPtr -> script, and another small change

* ocarina action

* remove +1 from light settings command, change comment

* actionIndex -> cueIdTemp (i guess)

* _SetCueX -> _SetXFromCue

* format

* tweak fade out seq arg names

* use spline terminology

* more dragorn and engineer review

* misc start/end frame note

* cleanup StartPosRotFromCue vs PosRotFromCue

* cleanup spline terminology

* sPrevCamId -> sReturnToCamId

* comment on debug cs data address

* Cutscene_Init -> Cutscene_InitContext

* single point types are not a list

* remove todo comment

* some more review

* rumble struct names

* some review

* more review

* missed one

* reword pointer comment

* even more review

* match transition terminology with z_play

* change condition and format

* frame count

* command specific structs with alignment

* anon review

* remove unneeded arg from time macro

* yeet `CsCmdGeneric`

* remove unused from single point types

* typo

* compromise attempt -- name endFrame everywhere

* fixes

* fix again

* copied the wrong note

* cutscene data note

* review, format

* compat defines

* idk whats going on man

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-12-24 13:55:17 -05:00
fig02
92e03cf747
speedXZ -> speed (#1477)
* speedXZ -> speed

* +=

* revert arg in player function

* anon review

* engineer review

* forgot one

* last review

* revert decimal
2022-12-24 12:18:57 -05:00
Derek Hensley
4a9873775c
TransitionFade docs and clean up other transitions (#1459)
* TransitionFade docs

* PR suggestions

* Fix

* Fill

* Other transitions + enums

* Prefix transition assests with trans

* Fix end_title

* format

* OutNames

* nitpicks PR

* cleaner
2022-12-24 03:46:56 +01:00
fig02
1c6878b070
Name Message_StartOcarina and related things (#1473)
* name functions and msg ctx var

* start ocarina

* clarifying comments

* typo
2022-12-20 23:03:41 +01:00
blackgamma7
75eb3c5c81
z_en_reeba doc (#1442)
* `z_en_reeba` doc

Fields and funcs now ID'd.

* Update z_en_reeba.c

one more func ID'd.

* `z_en_reeba`: change name of "rotYSwitch"

* `z_en_reeba`: added enums, changed stunTimer

also added translation for an osSyncPrintf

* Update z_en_reeba.c

revised DMGEFF enum

* `z_en_reeba` revised

* `z_en_reeba`: merge, case-switch whitespacing

* `z_en_reeba`: revisions

switch case formatted
`isBig` bool to `type` enum
2022-12-19 15:18:51 +01:00
blackgamma7
1a20d0d76d
z_en_toryo doc (#1441)
* `z_en_toryo` doc

- named funcs and fields
- clarified some values with enums
- removed align bytes from struct

* Update z_en_toryo.c

`TalkAction` -> `Main`

* Update z_en_toryo.c

* Update z_en_toryo.c

* Update z_en_toryo.c

* Update z_en_toryo.c

function name suggestions
2022-12-19 04:18:34 -05:00
engineer124
be22b836f6
Name Actor_PlaySfx and Player_PlaySfx (#1469)
* name two main actor sfx functions

* adjust comments

* fix double s in player

* fix commas
2022-12-18 23:18:21 -05:00
Dragorn421
f181c2f10e
DoorShutter logic docs (#1418)
* DoorShutter logic docs

* Comment on two more funcs

* Fix comment on DoorShutter_UnbarredCheckSwitchFlag I mmissed the `!(... == SHUTTER_FRONT_CLEAR)`

* Remove types 8,9,10 from enum as they aren't referenced by any transition actor list in all scenes

* Add `DOORSHUTTER_PARAMS` macro to pack params

* `DoorShutter_WaitPlayerShock` -> `DoorShutter_WaitPlayerSurprised`

* --comma

* moveState -> isActive

* Add mention about SlidingDoorActorBase.isActive being a timer in niche DoorShutter cases
2022-12-18 20:42:24 -05:00
Lauri Koskela
2ae64683a5
Clean up NPC player interaction usages (#1458)
* Clean up player tracking related things in NPCs

* Cleanup Npc_UpdateTalking usages and related things

* Reformat

* Minor fixes based on review comments

* Remove unneeded declarations

* More consistent function names
2022-12-18 19:11:16 -05:00
engineer124
934d488420
z_play: Camera Docs and Cleanup (#1460)
* begin docs

* More suggestions

* more docs

* timer to duration

* partial PR review

* init data with player

* consistent comments

* withPlayer to usingPlayer
2022-12-17 16:07:31 -05:00
engineer124
aa48c66e10
Introduce Player csMode enum (#1462)
* player csmode enum

* cleanup

* missed one, player2

* spell out enum name

* use CSMODE_MAX for data
2022-12-12 22:22:56 -05:00
Dragorn421
880e7c937c
Some cleanup/doc on the item icons (#1263)
* Some cleanup/doc on the item enum and icons

* `gItemIconBigBottlePoeTex` -> `gItemIconBottleBigPoeTex`

* Biggoron sword / giant knife items (?)

* `SPSTONE_` -> `SPIRITUAL_` ?

* `gItemIconBrokenBiggoronSwordTex` -> `gItemIconBrokenGoronsSwordTex`

* `gQuestIcon...MedallionTex` -> `gQuestIconMedallion...Tex`

* `ITEM_MAGIC_` -> `ITEM_MAGIC_JAR_`small/big

* `ITEM_BOW_ARROW_` -> `ITEM_BOW_`

* `MASK_BUNNY` -> `MASK_BUNNY_HOOD`

* Update `GID_` enum from `ITEM_` enum

* ITEM/GID`_ARROW_`small/medium/large -> 5/10/30

* Run formatter

* .

* fix regressions and revert bad ideas

* chicken

* obey the newline police and also prevent the range police from intervening

* fixups

* dimensions -> dimension (singular)

* Note on inconsequential oddities about the `gItemIcons` mapping
2022-12-12 21:45:54 -05:00
Anghelo Carvajal
c420885513
z_actor documentation pass (#1445)
* Actor_Offer* and Actor_SetClosestSecretDistance

* color filter stuff

* KillAll

* format

* comment

* Update src/code/z_actor.c

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

* review

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

* format

* COLORFILTER_INTENSITY_FLAG

* Remove -

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

* yeet COLORFILTER_GET_XLUFLAG

* bug

* frug

* Undo Actor_KillAllFromUnloadedRooms

* update Actor_OfferGetItem comment

* Update Actor_OfferGetItem description

* diving

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-12-12 21:23:14 -05:00
engineer124
2e9e895bf9
Good Camera Mode Names (#1455)
* better camera mode names

* cleanup

* improve aiming modes

* follow boomerang comment

* more mode docs

* cleanup

* hookshotFly, revert to still
2022-12-11 10:46:03 +01:00
Parker Burnett
85a4d23fc6
Documentation For En_Ik (#1190)
* pushing up to save changes

* syncing up some more docs

* finishing what I can

* PR feedback

* fixing typo

* Addressing comments

* master merge

* naming object

* ummm committing this for now before catching up

* other review + my review

* more review

* review2

Co-authored-by: fig02 <fig02srl@gmail.com>
2022-12-08 13:57:17 -05:00
Dragorn421
9bad1d108e
Cleanup post good scene names (#1452)
* Cleanup scene names

* missing scene id use

* rename scene draw config functions

* remove now useless comments

* format

* fix double defense/magic swapped

* try precision on "from potion shop"

Co-authored-by: engineer124 <engineer124engineer124@gmail.com>
2022-12-05 13:37:40 -05:00
engineer124
8ff58118b3
Camera Flags (#1225)
* Generic Camera Flags

* New flag names

* Add flags to functions

* Finish flag docs

* More docs

* More cleanup

* More clarity

* Better shrinkwindow flag docs

* Improve name

* CAM_INTERFACE_FLAGS

* Better approach to edge cases

* Change ordering for consistency

* Oops

* Add masks to macro

* PR/Discord discussions

* cleanup comment

* Oops

* PR Suggestions

* More PR Feedback

* More PR Suggestions

* PR Suggestions

* More flag style change

* Small cleanup

* sync names with other PRs

* more fixes

* fix comments

* update with hud visibility mode docs

* missed one

* fix comments

* Roman PR Suggestions

* interfaceField

* small fix

* letterbox cleanup

* fix macro arg

* fix func declaration
2022-12-04 23:02:24 -05:00
engineer124
1587c5505a
Document Camera for Elevator Platforms (Camera_Special7) (#1448)
* document camera for vertical platforms

* cleanup

* another rename

* small

* another rename

* add comment

* PR Suggestions

* more cleanup

* oops

* adjust comment
2022-11-26 18:15:33 -05:00
engineer124
c7a61aa670
Document Surface Material (#1447)
* material

* cleanup

* iron boots

* climb

* more docs

* rename

* small fix

* comments

* adjust bug comment

* simplify comment
2022-11-26 18:11:06 -05:00
Dragorn421
186ecc72b5
Name scenes (scene enum, entrance enum, various identifiers) (#1343)
* Comment names on titled scenes

* Comment some more scene names

* Comment some map assets symbol prefixes

* Name collapse sequence scenes (from the non-collapse equivalent scene's name + `_COLLAPSE`)

* Name ganon/ganondorf boss scenes (symbol prefix suffixed with `Scene` to prevent confusion with boss actors)

* Fix symbol prefix for back alley night scene

* Name the two grave scenes (normal and fairy's fountain variant)

* Name most houses, name/update misc scenes

Co-authored-by: fig02 <fig02srl@gmail.com>

* (hakaana) `GRAVE` -> `REDEAD_GRAVE` to be more specific

Co-authored-by: fig02 <fig02srl@gmail.com>

* `miharigoya_scene`: `market_guard_house`

* `kakariko_scene` -> `kakariko_center_house`

* `richards_house` -> `dog_lady_house` (for localization differences)

* Revert "Comment some map assets symbol prefixes"

This reverts commit 210a38a628.

* remove other xml prefixes

* ganon_boss, ganondorf_boss

* comments to namefixer

* `KAKARIKO_CENTER_HOUSE` -> `KAKARIKO_CENTER_GUEST_HOUSE`

* two collapse sequence scenes -> `GANONS_TOWER_COLLAPSE_`interior/exterior

* Run namefixer

`find src include -type f -exec ./tools/namefixer.py {} \;`

* run formatter

Co-authored-by: fig02 <fig02srl@gmail.com>
2022-11-26 16:15:41 -05:00
Dragorn421
274743738b
Player doc: Temporary PLAYER_ANIMGROUP names from original animation names (#1446)
* Name `PLAYER_ANIMGROUP_` based on original names

* format

* add comment indicating source of names
2022-11-26 12:31:24 -05:00
Lauri Koskela
b57f2162ee
Document NPC talking and player tracking (#1426)
* Rename npc dialog state variable

* Rename and doc NPC actor talking funtion

* Introduce NpcTalkState enum

* Rename NPC_TALK_STATE enum values

* Document NpcPlayerInteractionState and related functions

* Rename player tracking opt enum variants

* Rename npc functions, interact info

* Minor npc actor function tweaks

* Minor comment fixes for npc

* Generalize NPC player tracking to point tracking

* Change unused NpcInteractInfo field type and name

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Rename headRot and torsoRot

* Rename GetTalkState to UpdateTalkState

* Minor comment fixes

* Rename rotateActorShape and clarify related comments

* Remove unneeded parentheses in z_en_heishi4.c

* Reformat

* Remove unclear comment

* Rename yPosOffset to yOffset

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
2022-11-25 12:52:28 -05:00
engineer124
9c35716fe2
Document Hud Mode (#1323)
* begin interface alpha docs

* more progress/docs

* First draft of docs done

* cleanup

* Consistency

* Display -> Mode

* Remaining display -> mode

* Better docs

* Small touchups

* Small Update

* Apply discord discussion

* small fix

* More discussions

* PR Suggestions

* Roman PR Suggestions

* better comments

* PR Suggestions

* another suggestion

* discord discussions

* cleanup comments

* more discord/pr suggestions
2022-11-22 04:01:44 +01:00
Charles Averill
9bdf6ded2f
Document En_Ko Animations (#1306)
* Document Kokiri Children animations

* Remove BOY, GIRL, and FADO prefixes

* Formatting

* Further prefix removal

* more fixups

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-11-21 16:30:27 -05:00
Derek Hensley
83c3b64b1c
Doc object_rs (#1439) 2022-11-21 06:12:54 -05:00
blackgamma7
39e4e63b4d
z_obj_lift: doc remaining funcs and field (#1440)
* `z_obj_lift`: doc funcs and field

doc remaining funcs and field in `z_obj_lift`

* `z_obj_lift`: shakeVec->shakeOrientation

* removed space from copy-paste of field name
2022-11-19 16:30:56 +01:00
blackgamma7
1666517f47
z_shot_sun: minor doc (#1429)
* z_shot_sun: minor doc

document one field and function remaining in z_shot_sun

* z_shot_sun: updated state doc'ing

* Update z_shot_sun.c

format enum

* ran format.py

* `z_shot_sun`: changes based on feedback

gave enum better name, removed redundant comment.

* Update z_shot_sun.c

enum changed.
2022-11-18 08:24:27 -05:00
blackgamma7
edb6a25cee
z_en_bird doc (#1431)
* `z_en_bird` doc

Documented `z_en_bird`

* `Z_en_bird` changes from feedback

* Update z_en_bird.c

* `z_en_bird`: suggested changes

* `z_en_bird`: changes based on feedback

animation speed mod field changed, redundant comments removed.
2022-11-17 15:44:40 -05:00
Tharo
7ecafcfe7d
More documentation for z_std_dma.c (#1415)
* More documentation for z_std_dma

* uintptr casts for rom symbols in z64animation.h and z_kanfont.c

* Format

* Suggested changes, more defines for static texture sizes

* PI Interface -> PI

* Further suggested changes

* Format

* Comments about item_name and map_name texture assumptions
2022-11-16 21:57:02 -05:00
engineer124
40639e698d
Document Timers (#1412)
* Document Timers, First Draft

* some progress

* more timer docs

* cleanup

* small cleanup

* more cleanup

* comments

* more cleanup

* extra comment

* more docs

* brackets

* PR Suggestions

* cleanup, missed some

* more suggestions

* more PR Suggestions

* small change

* environmental
2022-11-16 13:41:27 -05:00
Dragorn421
cc2409606e
Update item names (#1376)
* Reevaluate item names (`ItemID` enum)

* format

* Carry `ItemID` changes to `ExchangeItemID`

* format

* Add item enum comments on items to slots array

* Rename slots according to current item enum names

* Add item enum comments on items to PlayerItemAction array

* Rename PlayerItemAction enum names according to current item enum names

* gi, gid names...

* `QUEST_GERUDO_CARD` -> `QUEST_GERUDOS_CARD`

* `DUNGEON_KEY_BOSS` -> `DUNGEON_BOSS_KEY`

* `UPG_` sticks/nuts : +deku

* Fixed remove array enum comments in `sDebugSaveEquips`

* "magic beans" -> "magic bean" (singular)

* cucco -> chicken (the one from weird egg, "alarm clock bird" from literal japanese translation)
2022-11-16 13:23:27 -05:00
blackgamma7
6451fbc24f
z_en_horse_zelda doc (#1430)
* z_en_horse_zelda doc

Zelda's horse has been better documented. Horse seemed to follow a path around Hyrule Field

* `z_en_horse_zelda` revised based on feedback

* Update z_en_horse_zelda.c

EnHorseZelda_ResetAnimation -> EnHorseZelda_SetupStop

* z_horse_zelda: changes based on feedback
2022-11-16 02:14:11 -05:00
Dragorn421
abb4201e57
Fix misc 18 (#1423)
* two more ABS

* fixup item_name_static texs outnames

* fixup CollisionCheck_SetOCvsOC docs

* Cleanup int comments alignments

* collsion -> collision

* `SQ*` macros fixup

* use `LERP` more

* static -> `s` prefix

* grammar: dont -> don't

* 3
2022-11-13 23:47:25 +01:00
Derek Hensley
d8175501ad
Objects tw and tr (#1410)
* Tr

* Update from MM prs

* Twinrova kotake and koume

* Animations

* textures

* DLs and final clean up

* limb enum

* blobs

* Move blobs
2022-11-02 00:42:16 +01:00
Dragorn421
ab90300062
Rename vt.h to terminal.h (#1339)
* `vt.h` -> `terminal.h`

* `VT_` -> `T_` (as in Terminal)

* `vt.h` -> `terminal.h` in includes too Pepega

* Sort out tiny terminal.h include inconsistencies

* Format

* -> `TE_`

* format

* `TE_` -> back to `VT_` (parkour!)

* explicit VT
2022-11-01 19:17:11 -04:00
Dragorn421
d2191a5d48
Some doc on env light settings (#1307)
* remove `LightSettings` struct, typedef for zapd

* more decimal

* fog far -> z far

* `LIGHTCTX_FOGNEAR_MAX`, `LIGHTCTX_ZFAR_MAX`

* name sp88,sp8C in `Environment_Update`

* `EnvLightSettings.fogNear` -> `blendRateAndFogNear` and macros

* A different struct for `EnvironmentContext.lightSettings`

* Uniform zapd compat typedefs todos

* `LIGHTCTX_` -> `ENV_`

* Comment on `blendRateAndFogNear` + "fogFar"

* Move fogFar~1000 comment to zFar

* comment rewrite attempt

* move relevant macros down

Co-authored-by: fig02 <fig02srl@gmail.com>
2022-11-01 19:00:38 -04:00
Dragorn421
c0a0688dc5
Remove const from ActorInit initvars declarations (#1417) 2022-10-24 19:29:38 -04:00
Dragorn421
ce2e5e71c8
Documentation pass on DoorShutter (#1352)
* Documentation pass on `DoorShutter`

* lockTimer -> unlockTimer

* Add `DOORSHUTTER_STYLE_FROM_SCENE`

* `DoorShutter_SetupType` -> `DoorShutter_WaitForObject`

* perpendicularly -> perpendicular

* `DoorShutter_CheckShouldDraw` -> `DoorShutter_ShouldDraw`

* Improve comment on `DoorShutter_GetPlayerSide`

* `jabuDoorClosed`/`barsClosed` +`Amount`

* attempt to improve a comment

* fix shameful left-aligned numbers

* unname closing/opening

* action funcs names

* run formatter

* enums improvements

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
2022-10-24 15:58:33 -04:00
engineer124
e4c1a4b512
Document Crawlspaces (#1286)
* Crawlspace docs, first draft

* Add wall docs

* OnePointDemo, fix

* format

* More player docs

* Document bgCamData

* Magic docs WIP

* More docs, first round finished

* Better docs

* More renaming

* Simpler name

* Another small adjustment

* rm if(1)

* Better names again after in-game testing

* Change comments

* change comment

* Big rename based on all the suggestions

* Small touch-up

* More PR Suggestions

* RESTORE_IDLE -> RESET

* More docs

* Capitalization

* PR suggestions

* Make declaration consistent

* Health_ChangeBy (amount)

* cleanup

* Document bgCamData

* More changes and cleanup

* More docs

* Clarify comments

* PR Suggestions

* Missed one

* More PR Suggestions

* Change comment

* Add another clarity comment

* format

* PR Feedback, rename bgcheck functions

* remove fallthrough cleanup (other pr that deals with that)

* PR Suggestions

* bug report

* sync with bgCamData PR

* small cleanup

* Another comment

* bgCamDataIndexBeforeUnderwater

* PR/Discord Discussions

* Missed some

* sync function header args

* Another suggestion

* cleanup

* Comments

* Change bgCamData to s16 for now

* PR suggestions

* the

* use "info"

* Missed a suggestion

* Discord Discussion

* Document playerFlag

* typo

* Revert bgCamFuncData to Vec3s

* format

* format

* First PR suggestion

* Some PR Suggestions, still need to test

* followup docs

* small cleanup

* target offset

* more PR

* forwardYaw

* crawlspace func/flag

* comment

* format

* Update include/z64player.h

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

* More PR Suggestions

* Update src/overlays/actors/ovl_player_actor/z_player.c

Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
2022-10-23 17:32:51 -04:00
Derek Hensley
2cb423d9ec
Document object_os (#1414) 2022-10-21 19:57:49 -04:00
engineer124
a715bf63d0
improve matches (#1413) 2022-10-21 18:57:30 -04:00
fig02
26d6028ff1
Rename scene lists (#1344)
* first pass

* revert unwanted zap change

* review

* name Actor_InitContext, change arg name

* change bzero to use type
2022-10-16 18:00:18 -04:00
engineer124
e4664b4750
Misc Sequence Docs (#1400)
* misc bgm and fanfare docs

* more docs

* function.h cleanup

* fix horse

* typo

* add comment to song of storms cutscene in windmill

* PR review

* woopsie

* seqId macros

* revert macro
2022-10-16 12:12:36 -04:00
Dragorn421
17073af8a3
Enum comments on some arrays (#1404)
* Comment enums on some big arrays

* z_camera_data too

* comment in get item table on own lines

* `sDebugSaveInventory.ammo`

* More in z_sram

* `0xFF` -> `ITEM_NONE` in `sNewSaveInventory.items`
2022-10-15 20:02:54 -04:00