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

1120 commits

Author SHA1 Message Date
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
Dragorn421
0283493db8
Lightweight trigonometry doc (#1356)
* Doc units of trig functions

* "Very simple" yet I made a mistake

* sins returns in [-0x7FFF,0x7FFF] as the [-1,1] range

* Also `sys_math_atan.c`

* Remove `@param`s without descriptions

* Add note on Math_Atan2S/F arguments being unlike atan2

* "from (1,0) to (x,y)" -> "from vector ..."

* arg names -> `angle`

* Improve `@return` comment on atans
2022-10-15 17:29:36 -04:00
fig02
fd24ad6e67
Document elf_message scripting system (#1398)
* `cUpElfMsgs` -> `cUpMsgs`

Motivation:
ElfMessage is the name of the system that handles c-up messages from navi, but also messages from child/adult saria
so it would make sense to name this after the system name like "ElfMsg"
but "cUpElf" primarily reads like (to me) "c up navi" since the actor implementing navi is EnElf

I think it'd be better to clear that confusion between "navi" and "elfmsg system" by just not using "elf" in the name

* Standardize c-up navi messages ElfMessage data to be named after "CUp"

* -> "Navi"

* Make symbols in `elf_message_` segments static

* new docs

* change commands, format

* introduce navi file id

* use enum

* remove concat

* add clarifying comment for skip

* concat cmd type

* Hints -> QuestHint

* rename command header

* s -> g

* missed enum name

* singular

* missed one

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-10-15 13:24:13 -04:00
Dragorn421
eb9b707157
Further ObjSwitch docs (#1406)
* Doc fixups for ObjSwitch

* rev

* params macros
2022-10-15 16:08:54 +02:00
engineer124
a2d62eedb2
Cleanup VecSph: Better Distinguish Between "Spherical" vs. "Geographic" Coordinates (#1407)
* begin geo and sph docs

* cleanup

* cleanup

* cleanup struct

* PR suggestions

* spacing
2022-10-15 15:43:59 +02:00
Lauri Koskela
b806ac0191
Document Talon (En_Ta) (#1348)
* Rename flags related to Talon

* Document Talon (ovl_En_Ta)

* Formatting

* ovl_En_Ta review fixes

* Add horse eventinf flag usage comments

* Rename TALON_STATE_FLAG_3

* Review fixes

* More review fixes

* Fix super-cucco zero-gravity time comment

* Fix formatting

* Talon review comment fixes

* Review comment fixes

* Rename waking up action funcs
2022-10-15 06:28:05 -04:00
engineer124
9675051377
Quake Documentation Pass (#1402)
* begin quake docs

* continue cleanup

* quake offset

* many more docs

* cleanup

* more cleanup

* cleanup headers

* move quake value to internal

* update, still need to test shake zoom/yaw

* more docs

* better docs

* add file descriptions

* fix comment

* explain random index

* cleanup comments

* better type 6 docs

* expand orientation comment

* fix old names, add comment

* remove comment, twas a mistake

* easy PR feedback

* duration in dec

* rm offset, clear up roll

* oops

* merge shakeInfo and QuakeCamData

* match order that always appears in code

* more PR suggestions

* adjust comment

* zeroVec

* rm extra space

* roman PR suggestions
2022-10-15 02:16:37 -04:00
engineer124
d624733bf9
better match (#1409) 2022-10-14 18:53:11 -04:00
krm01
f82b9bd208
[Doc] actor En_Bombf (Bombflower) - just the last unk (#1378)
* name last unk in EnBombfType

* rename to isActive

* isEnabled with comment

* rename to isFuseEnabled
2022-10-14 18:44:49 -04:00
Dragorn421
22b78f169f
Fix misc 17 (#1392)
* Some cleanup on bgcheck waterbox y funcs

* Fix some typo/spelling

* EnFz_ApplyDamage match fixup

* Turn another sus construction into a switch

* Fixup comment on restoring MS as adult

* "doesnt, isnt" -> "doesn't, isn't"

* Hunt down whitespace at end of lines

* Format (clang-format does not like figs bug comment on bongo cutscene unskip sadge)

* Viewport z scale/translation: `0x1FF` -> `G_MAXZ/2` (see proman "9.7 Mixing CPU and SP Addresses", "12.7.6 Depth Source")

* static symbols: g -> s prefix

* Link young/old -> child/adult

* Fixups

* Get rid of signed vs unsigned comparison warning by changing room temps to s32

* waterbox search funcs consistency

* Revert "waterbox search funcs consistency"

This reverts commit 8f386e038f.

* `curWaterBox` -> `waterBox`
2022-10-13 04:06:49 -04:00
Tom Overton
c3dc299448
Document all non-Koume/Kotake parts of object_tw (#1401)
* Document all non-Koume/Kotake parts of object_tw

* Fix the names of two textures I accidentally swapped
2022-10-12 15:56:28 -04:00
Tom Overton
a6276fb5c1
Document object_bdoor (boss doors) (#1403) 2022-10-12 13:12:26 -04:00
Dragorn421
40a4abefa5
Doc dynapoly move flags (#1372)
* Doc dynapoly move flags

* Use `DYNAPOLYMOVE_UPD_` more

* remove `DynaPolyActor.unk_15A` (padding)

* `DYNAPOLYMOVE_UPD_` -> `DYNA_MOVE_`

* Remove `DYNA_MOVE_POS_AND_ROT_Y`

* Actual docs

* Update function names

* transformFlags and Carried names

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

* Fixup comment on `DynaPolyActor_UpdateCarriedActorPos`

* Format

* `DYNA_TRANSFORM_NONE` -> 0

* Touch up mentioning the `DYNA_TRANSFORM_` flags in docs

Co-authored-by: fig02 <fig02srl@gmail.com>
Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
2022-10-12 00:47:33 +02:00
engineer124
3ee2190b8d
Document Malon's Singing (#1395)
* malon singing docs

* typo

* more cleanup

* more cleanup

* cleanup comments

* PR Suggestions

* add more comments for clarity

* grammar
2022-10-10 06:52:33 +02:00
Dragorn421
b6d9a8183b
PlayerActionParam -> PlayerItemAction (#1394)
* `PLAYER_AP_` -> `PLAYER_IA_`

* Change temps, args, comments, members to "item action"

* Format
2022-10-09 15:59:57 +02:00
engineer124
062f4d8e15
Document code_800F9280.c -> audio_seqcmd.c i.e. (Audio_QueueSeqCmd) (#1234)
* Document SoundSources

* PR Suggestions

* Duration timers to dec

* `PlaySfxByPosAndId` -> `PlaySoundByPosition`

* Begin importing docs from MM

* Finish cleanup using code from MM

* Start documenting commands

* First attempt at thorough AudioSeqCmd wrappers

* Improve names

* Merge branch 'master' into audio_seqCmd

fix name to minimize conflicts

* Combine macros, implement them through repo

* Improve docs

* More progress, begin sequence command docs

* seqcmd.h

* More documentation of seqcmd.h

* More docs

* cleanup

* More cleanup

* More docs

* VOL_SCALE_INDEX enum

* missed enums

* More Cleanup

* docs

* More docs

* Add comments about sfxChannelLayout

* More cleanup

* Even better docs

* Add a file description

* small touchups

* More cleanup of comments

* more

* More cleanup

* More cleanup

* Missing space

* typos

* Audio_SetVolumeScaleNow

* More cleanup

* Fill in enum

* one more cleanup

* Capitalize macros

* remove AUDIO_

* cleanup

* more cleanup

* Small Fix

* Add a lot of backticks for docs

* Restructuring docs

* More cleanup

* swap channel args, cleanup

* Typos

* Many suggestions, revert filename

* pr suggestions

* even more PR

* more pr suggestions

* pr suggestion
2022-10-07 13:29:33 +02:00
Tom Overton
a99d41bf35
Document object_bw (Torch Slug) (#1390)
* Document object_bw (Torch Slug)

* Get rid of "Wrapper" terminology
2022-10-06 22:10:49 -04:00
HylianFreddy
8c17339e06
Document Bg_Ice_Shelter (Red Ice) (#1358)
* Doc BgIceShelter

* Fix comment and add macro

* Various fixes

* Rename switch flag macro
2022-10-06 21:57:26 -04:00
Roman971
1cb00350d9
Skip compiling C-included files during the build (#1386)
* Update the makefile to skip .inc.c files when building

* Rename all C-included source files to .inc.c
2022-10-04 12:36:25 +02:00
Roman971
2f4c25da53
Fix many missing NULLs (#1389)
* Fix many missing NULLs

* Fix a raw actor id in en_horse
2022-10-04 01:18:50 -04:00
Roman971
78e528d6fb
Various minor fixes (#1383)
* Swap REGION_US and REGION_JP

* Fix a few missing EXCH_ITEM enum values

* Remove unnecessary casts on alloc functions

* Fix a double slash in the spec file

* Swap top and bottom args in StackCheck_Init

* Remove some unnecessary & in array references

* Run formatter

* Fix the comments for US and JP codes
2022-10-02 17:40:09 -04:00
Tom Overton
a2c8eabbc5
Document everything in ovl_Boss_Ganon2.xml (#1377)
* Document everything in ovl_Boss_Ganon2.xml

* Add translation I forgot to do

* Remove leading zeroes
2022-10-02 16:47:27 -04:00
fig02
e257416c07
document bongo cutscene bug (#1384) 2022-09-30 16:41:16 -04:00
Tharo
4f65d08eb5
Rumble doc (#1375)
* Rumble doc

* Fixes, suggested changes

* Improve padmgr retrace callback related code

* Name some rumble-adjacent things, further suggested changes

* Further suggested changes

* Suggested changes
2022-09-27 12:40:26 -04:00
Tom Overton
82e04ede5f
Replace player animation names with original names derived from OoT3D (#1369)
* Name every player animation after the original name from OoT3D

* Also update link_animetion with original names
2022-09-12 20:43:06 +02:00
Dragorn421
2e18eb334b
Fix misc 16 (#1371)
* Replace tabs in exceptasm.s source

* Replace tabs with \t in strings

* Fix grammar in various comments

* Fix "initalize" typos in code

* (fix typo) `__osMallocIsInitalized` -> `__osMallocIsInitialized`

* Some Link -> Player

* Use `EXCH_ITEM_` more

* "bgm music" -> "background music"

* Fix typos in `place_title_cards.xml`

* `SkelAnime_Update` returns a boolean

* Run formatter
2022-08-30 17:35:00 -04:00
mzxrules
327a813b37
Fix RaycastFloor flags (#1328)
* fix raycast floor flags

* format.sh

* Name flags

* Rename RaycastFloor functions, clean up caller code, document z_bg_spot15_rrbox

* change comment to prevent format wrap

* change to "if BGCHECK_GROUND_CHECK_ON is set"

* roman suggestions
2022-08-30 17:49:51 +02:00
Tom Overton
fe8d5988b9
Document object_gndd (Young Ganondorf) (#1353) 2022-08-29 20:03:29 -04:00
Tom Overton
f5f6f2ef6c
Document Ganon objects (#1345)
* Document Ganon objects

* Better name for one texture
2022-08-29 19:44:17 -04:00
krm01
16e62d45be
[Doc] actor En_Dodojr (Baby Dodongo) (#1311)
* doc baby dodongo

* remove unnecessary prototypes

* run formatter

* comment for bug that dragorn noticed

* use boolean return values

* clearer conditional checks on boolean functions

* rename bounceCounter -> counter

* renaming suggestions from review

* rename to EnDodojr_UpdateBounces per review

* rename to SetupSwallowedBombEffects

* rename to TryEatBomb

* last rename hopefully
2022-08-28 17:13:07 +02:00
mracsys
20b90a633b
use correct name for player trade item comparison in en_ko (#1365) 2022-08-26 08:50:44 +02:00
engineer124
9e2aee3fa3
Minor Misc Cleanup (#1360)
* misc cleanup

* missed one

* EffectSsDust_UpdateFire

* revert change, needs more testing
2022-08-23 21:13:03 -04:00
fig02
fec5cd84af
Doc shrink_window, rename system to Letterbox (#1341)
* docs

* missed some hex

* document Gfx_SetupFrame

* review
2022-08-15 09:39:06 -04:00
Derek Hensley
9c6461751d
sceneNum -> sceneId (#1338)
* sceneNum -> sceneId

* forgot to save play

* scene -> sceneId where appropriate

* Missed 1 + format

* Update src/code/z_sram.c

Co-authored-by: mzxrules <mzxrules@gmail.com>

* Update src/code/z_sram.c

Co-authored-by: mzxrules <mzxrules@gmail.com>

* PR

* Fix

Co-authored-by: mzxrules <mzxrules@gmail.com>
2022-07-31 19:44:47 -04:00
Dragorn421
706d5596bf
Doc, macros, enums for SurfaceType.data (#1293)
* `SURFACETYPE`0/1 getter macros

* Cleanup/assess/revert existing names

* `SURFACETYPE0_30` -> "soft"

* `SURFACETYPE0_`13/26 -> floortype/floorproperty

* Introduce `SURFACETYPE_FLOORTYPE_` enum

* Introduce `SURFACETYPE_FLOORPROPERTY_` enum

* `SURFACETYPE0_21` -> "wall type", and maps to "wall flags"

* Introduce `SURFACETYPE_WALLTYPE_` enum

* Introduce `SURFACETYPE_WALLFLAG_` defines

* `SURFACETYPE1_0` -> "sfx type"

* `SurfaceType_GetSfx` -> `GetSfxId` and cleanup

* Introduce `SURFACETYPE_SFXTYPE_` enum

* Note oddity on `Player.unk_89E` (more docs needed)

* `SURFACETYPE1_4` -> "floor effect" (not 100% set on the name, just something different from type and property)

* Introduce `SURFACETYPE_FLOOREFFECT_` enum

* Introduce `SURFACETYPE_CONVEYORSPEED_` enum

* Add `SURFACETYPE_CONVEYORDIRECTION_TO_BINANG` macro

* `wallDamage` -> `hasFlag27`

* Be more underscore-happy

* Revert "`SURFACETYPE`0/1 getter macros"

This reverts commit e61cccf2e6.

* remove mention to removed define

* Remove surfacetype_ prefix, `SFX_TYPE_` -> `SURFACE_SFX_TYPE_`, `FLOOREFFECT_` -> `FLOOR_EFFECT_`

* Formatting

* 0-pad litteral to 8 nibbles
2022-07-31 20:57:18 +02:00
Dragorn421
6889c275cb
Doc pass on EnDoor and transition actors (#1243)
* Doc pass on EnDoor and transition actors

* (re)Name things

* Forgot to change gameplay_keep.xml

* "actor transition index" -> "transition actor index"

* Run formatter

* Better names for `DOOR_DL_` enum

* `TRANSITION_ACTOR_INDEX` -> `GET_TRANSITION_ACTOR_INDEX`

* name endoor params macros with get/is, _mask to _flag for the doubledoor flag

* Move last ; from `DOOR_ACTOR_BASE` expansion to usage
2022-07-30 20:57:44 -04:00
Tharo
455321d2e8
Fix various small gfx issues (#1313)
* Fix various small gfx issues

* Use 0xFFFF instead of -1 for max prim depth

* More fixed point numbers

* scale -> texCoordScale, better cycle 2 render mode in z_title

* GFXP_CHAR_* defines renamed to SPACING

* Fix some gDPLoadMultiBlock uses
2022-07-30 17:49:10 -04:00
fig02
afbc312024
Rename "Scene Setup Index" to "Scene Layer" (#1300)
* setup -> layer

* IS_CUTSCENE_LAYER

* review

* backtick

* remove some more mentions of setup

* alt header block

* clarifying comment
2022-07-30 17:28:50 -04:00
engineer124
1d19f37b26
Rename "Sound" to "Sfx" (#1292)
* First attempt

* More

* rename

* more sound -> sfx / sound effect (#7)

* PR Suggestions

* PR Suggestions

* Small fix

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
Co-authored-by: fig02 <fig02srl@gmail.com>
2022-07-30 09:05:27 -04:00
Roman971
7254adec9f
Use intptr types in overlays and dmadata (#1325) 2022-07-29 20:29:48 -04:00
krm01
3122143f96
[Doc] actor En_Skb (Stalchild) (#1299)
* en_skb stalchild actor doc

* missed a sneaky one

* rename Main to DecideNextAction

* action state rename and become enum

* tweak bodybreak comment

* rename SPAWNING to BURIED

* rename to headlessWalkYawOffset

* rename hitboxActive to enableATCollision

* use bools for enableATCollision

* formatting

* move EnSkbActionState out of header

* rename enableATCollision -> setColliderAT

* remove unnecessary prototypes

* renaming per review, settle on breakFlags
2022-07-28 03:02:46 -04:00
engineer124
79cb1f8d5c
Misc Cleanup/Docs (#1315)
* Misc Cleanup

* More cleanup
2022-07-14 16:26:10 -04:00
Charles Averill
cf52184766
Name EnMd limb indices (#1314) 2022-07-14 20:37:23 +02:00
Derek Hensley
354a2c29f8
object_cne (#1310) 2022-07-12 22:26:49 -04:00
Dragorn421
2f07874a5f
Remove BINANG_SUB (#1297) 2022-07-12 12:17:07 -04:00
Derek Hensley
8607c54e75
BossDodongo_OverrideLimbDraw Better match? (#1322)
* Better match?

* Update src/overlays/actors/ovl_Boss_Dodongo/z_boss_dodongo.c

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

Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
2022-07-11 19:24:30 +02:00
Dragorn421
ed0ab877c9
Some names and docs on dynapoly (#1287)
* Add `BG_DYNA_ACTOR_FLAG_` for `DynaCollisionContext.bgActorFlags`

* Document 3/4 bgActor flags

* `func_8003EE6C` -> `DynaPoly_InvalidateLookup`

* `DynaPoly_ExpandSRT` -> `DynaPoly_AddBgActorToLookup`

* Add `DYNAPOLYACTOR_UNK160_` for `DynaPolyActor.unk_160`

* More dynapoly docs

* One comment

* Some `DynaPoly_` -> `DynaPolyActor_`

* run formatter

* .

* `BG_DYNA_ACTOR_FLAG_IS_USED` -> `BG_DYNA_ACTOR_FLAG_IN_USE`

* `BG_DYNA_ACTOR_FLAG_` -> `BGACTOR_`

* `DYNAPOLYACTOR_INTERACT_FLAG_` -> `DYNA_INTERACT_`

* `ResetInteractFlags` -> `ClearInteractFlags`

* Remove Has/Is prefix on dyna interact flags getters

* format

* remove now useless comments

* Remove `!= 0` on interact flags getter usage

* ceilings collision -> ceiling collision

* `ClearInteractFlags` -> `UnsetInteractFlags` (pepega)

* `UnsetInteractFlags` -> `UnsetAllInteractFlags` (pepega x2)

* Add back `Is` prefix (no `Has` this time) to dyna interact flags getters
2022-06-25 09:53:26 -04:00
Dragorn421
397e481f9a
Fix misc 15 (#1298)
* Use `SCENE_` enum more

* Decimal for pos in `D_8011F9B8`

* `__osEventStateTab`: length `OS_NUM_EVENTS + 1` -> `OS_NUM_EVENTS`

* thone -> throne

* `s` on local data

* minor sfxId cleanup

* Run formatter

* Fixup 0x19 + 1 = 0x1A, not 0x20 lol

* Tlut -> TLUT

* DemoKankyo params usage cleanup

* Some proofreading (up to z_actor.c)

* Revert 0 -> sfxId, add todo comment (sfxId=0 is weird apparently)

* `sZdWaterBox` -> `sZorasDomainWaterBox`

* `msgMode == MSGMODE_`, not `GAMEMODE_` (my bad Sadge)
2022-06-24 19:45:05 -04:00
Dragorn421
984871eb38
Document SaveContext.gameMode (#1295)
* Document `SaveContext.gameMode`

* end credits

* Remove no longer needed comment
2022-06-23 21:32:48 -04:00
engineer124
e7e2da86a8
Remove OoB SfxIds (#1291) 2022-06-20 21:32:17 -04:00
engineer124
d88a23f4a0
Document Viewpoints and Scene Cam Types (#1285)
* Document bgCamData

* More changes and cleanup

* More docs

* Clarify comments

* PR Feedback, rename bgcheck functions

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

* PR Suggestions

* bug report

* bgCamDataIndexBeforeUnderwater

* PR/Discord Discussions

* Missed some

* sync function header args

* Another suggestion

* cleanup

* Comments

* Indoor BgCamData

* Change bgCamData to s16 for now

* PR suggestions

* the

* use "info"

* Missed a suggestion

* Update and sync docs

* More docs

* Even more docs

* Revert macro

* Add comment

* Better comments

* More cleanup

* Better Cam Scene Docs

* Small change

* Market -> Pivot

* "only"

* swap

* Better comment

* Another comment

* to

* Implement suggestions from discord

* Discord Discussion

* Revert bgCamFuncData to Vec3s

* cleanup

* Remaining cleanup

* docs cleanup

* format

* More docs

* Improve notes

* Cleanup

* Change enum

* PR Suggestions

* Improve comment

* Rephrase

* Implement discussion from discord

* Discord discussion

* fixed to locked

* Update comments

* Few more comments

* Update include/z64.h

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

* Update include/z64camera.h

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

* Better comments

* PR Suggestions

* rm numbers

* Update src/code/z_play.c

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

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-06-20 20:31:53 -04:00
Roman971
6d52684020
Format script improvements and use strict name checks (#1275)
* Prioritize using clang-tidy 6 and improve format.sh

* Use clang-tidy-6.0 when available since it's better at applying 'readability-inconsistent-declaration-parameter-name'
* Add -m32 and -Wno-everything to compiler options to avoid unwanted errors and warnings
* Remove -fsyntax-only since it serves no purpose in the context of clang-tidy

* Apply clang-tidy fixes for argument names

* Run format.sh again

* Use 'Strict' option instead of relying on clang-tidy 6

* Run format script

* Add --fix-notes to clang-tidy options for version 13+
2022-06-20 16:31:53 -04:00
Dragorn421
017a3aaf5c
Some doc on actor overlays alloc types (#1266)
* Some doc on actor overlays alloc types

* Line breaks between defines at the top of actor.h

* plain english

* `ACTOR_ALLOC_` -> `ACTOROVL_ALLOC_`

* More line breaks

* `ACTOR_OVERLAY_ABSOLUTE_SPACE_SIZE` -> `ACTOROVL_ABSOLUTE_SPACE_SIZE`

* Document bug about Scarecrow's Song not setting the flag to restore Nayru's Love

* Try to document the check for needing to actor_kill to leave the absolute space being too broad

* "which overlay uses" (bad english) -> simplify to "which uses"

* Run formatter
2022-06-20 16:17:09 -04:00
engineer124
b602276fef
Introduce Sfx Flags (#1278)
* Sfx Flags

* Discord Discussion

* Move macro to sound_params

* Oops

* PR Suggestions

* Clarify comment

* Missed switch

* More suggestions

* Update src/code/audio_sound_params.c

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

* sfxs

* PR Suggestions

* revert back to flag

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-06-20 14:24:21 -04:00
engineer124
849fdbf9ea
Document Camera BgCamData (#1232)
* Document bgCamData

* More changes and cleanup

* More docs

* Clarify comments

* PR Feedback, rename bgcheck functions

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

* PR Suggestions

* bug report

* 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

* Revert bgCamFuncData to Vec3s

* format
2022-06-17 20:25:42 +02:00
Roman971
08c8126ba5
Enable int-conversion warnings and fix all current instances (#1280)
* Enable int-conversion warnings for gcc/clang

* Fix all current int-conversion warnings

* Run format.sh

* Apply review suggestions
2022-06-15 20:15:44 -04:00
Dragorn421
5299208291
Macros for Entranceinfo.field (#1270)
* Macros for `Entranceinfo.field`

* `ENTRANCE_INFO_FIELD_` -> `ENTRANCE_INFO_`

* Remove mentioning the transition types being "default"

* comment on macros what they are for

* Shorten "transition" -> "trans" for `EntranceInfo.field` usage
2022-06-15 20:41:47 +02:00
EllipticEllipsis
030594a457
Actor prototype cleanup (#1276)
* Fix some ActorFunc prototypes

* Add defaults to switches in object_kankyo
2022-06-13 18:25:02 +02:00
Dragorn421
0832b5af68
Fix misc 14 (#1279)
* Remove fake temp in `BossDodongo_DrawEffects`

* `OS_WRITE` for `__osSpRawStartDma` `direction`

* remove outdated comment

* fixup osRecvMesg

* make sShopkeeperStores static

* `PHYSICAL_TO_VIRTUAL(gSegments[0])` -> `SEGMENTED_TO_VIRTUAL(NULL)` (mimics `CollisionHeader_SegmentedToVirtual`)

* Run formatter

* Remove assets from include path in suggested vscode properties

* Fix `osCreateMesgQueue` getting `OS_MESG_BLOCK` as `count` instead of `1`
2022-06-13 17:38:20 +02:00
Roman971
feadb0d9ee
Enable more IDO warnings and apply fixes (#1264)
* Update asm-processor and fix includes with EARLY

* Enable more IDO warnings and disable unwanted warning 516

* Fix most new and remaining warnings

* Improve skelanime comment

* Improve asmproc pragma comment

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

* Add suggested comment for a wrong prototype

* Update asm-processor with the latest fix

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
2022-06-12 19:24:45 -04:00
Kenton M
4cb1c3345f
Small doc for Item00 actor (#1268)
* EnItem00.unk_15A rename to despawnTimer

* func_8001E5C8 rename to EnItem00_BounceAfterCollected

* shorten to Item00_Collected
2022-06-12 19:15:15 -04:00
EllipticEllipsis
be57b6bf4c
Document flag for swinging bottle (#1272)
* Document flag for swinging bottle

* Add bug, minor documentation to func_8084ECA4

* Update comments

* Add newline to z64cutscene_commands.h

* Review
2022-06-12 18:58:13 -04:00
Roman971
a33965c1d0
Minor cleanups in z_std_dma.c and yaz0.c (#1269)
* Cleanup dma and yaz0 functions using pointers for ram

Also includes a minor cleanup of yaz0 names to better fit their purpose

* Run formatter

* Additional cleanups on dma and yaz0 functions
2022-06-11 03:42:05 -04:00
Roman971
04ade9a255
Update clang-tidy configuration in format.sh and apply fixes for a new check (#1257)
* Update format.sh compiler options and add a check for clang-tidy

* Enable clang-tidy option to find inconsistent argument names

* Remove -Iassets from clang-tidy compiler options
2022-06-07 00:34:28 -04:00
Roman971
b0bfa9eb69
Fix asset file includes to always start with assets/ (#1260)
* Fix asset includes to consistently start with assets/

* Fix header paths in asset xmls to start with assets/

* Remove -Iassets from compiler options
2022-06-06 15:37:25 -04:00
Roman971
b28ad659e3
More minor isolated fixes (#1258)
* Fix reversed array access in z_boss_dodongo.c

* Remove useless return in z_en_encount2.c

* Remove some redundant externs or declarations

* Move some undefs to be performed as early as possible

* AudioOcarina_ResetStaffs -> AudioOcarina_ResetStaves

The plural appears to be staves for the music term

* Remove some uses of UNK_PTR

* Use NULL for pointers set to 0 in z_game_dlftbls.c

* Remove useless !! in z_en_tk.c

* Revert "AudioOcarina_ResetStaffs -> AudioOcarina_ResetStaves"

This reverts commit 1b7fe62408.

* Remove more redundant externs from PR suggestion
2022-06-05 12:48:44 -04:00
Dragorn421
1a41694d58
Add enum for setup dls and name z_rcp.c functions (#1196)
* Introduce `SetupDL` enum

* wip

* wip

* Remove comments on each setupdl index

* Name setup dl functions by setupdl index

* `Gfx_SetupDl` -> `Gfx_SetupDL`

* Run formatter

* globalctx -> play

* fix regressions

* `Gfx_SetupDL` -> `Gfx_SetupDL_` (add separating underscore)

* `CallSetupDL` -> `SetupDL`
2022-06-03 18:25:48 -04:00
Dragorn421
b3b913d33d
Use DMG_ defines in code (#1245)
* Use `DMG_` defines for `dmgFlags` when single bits are used

* Pass on several (in code, no colliders)

* Conditional cleanup

* Remove wip comment, just use the flags 4head
2022-06-03 20:36:04 +02:00
Derek Hensley
b2752a6a2e
Doc Actor Rotation Functions (last 4 funcs in actor.c) (#1249)
* Cleanup functions

* Rename functions

* functions comments

* fix apostrophes

* Renames TurnTo -> Track, other review comments
2022-06-03 20:29:23 +02:00
Tharo
451b24f79b
Fix a number of warnings when compiling with GCC (#1239)
* Silence a number of GCC warnings

* Remove

* Suggested changes

* Format

* Fix comment in en_go2
2022-06-03 18:51:23 +02:00
engineer124
0a95d17aa8
Document Sequence Cutscene Effects (Sequence 109) (#1246)
* Seq 109 docs

* Fix

* Reorder function name
2022-06-02 03:49:10 -04:00
Dragorn421
fa1ea37d54
Fix misc 13 (#1244)
* Squared variables fixup

* `sAnimSoundFrames` fixup

* `ocElemFlags` fixup

* `toucherFlags` fixup

* `bumperFlags` fixup

* `atFlags` fixup

* `acFlags` fixup

* `ocFlags1` fixup

* `ocFlags2` fixup

* `&=`

* `TOUCH_SFX_NONE` -> `_MASK` in `CollisionCheck_HitSolid`
2022-05-31 14:48:41 -04:00
Dragorn421
d39ce02458
Documentation pass centered on z_player_lib (#1230) 2022-05-29 07:52:15 -04:00
engineer124
e68f321777
Document Magic (#1199)
* 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)

* PR Suggestions

* Missed one

* More PR Suggestions

* Change comment

* Add another clarity comment

* Discord discussions on `magicFillTarget`

* Comments

* grammar

* More comment clarity

* Another bad comment

* PR suggestions, improved comments

* One more comment

* one more thing

* bar -> meter
2022-05-23 18:52:01 +02:00
fig02
2e6279bc8e
PlayState Rename (#1231)
* global context -> play

* fix PlayState* PlayState
2022-05-21 14:23:43 -04:00
Dragorn421
154f44b6da
Documentation pass on scene/room commands (#1226)
* Rename handler functions

* Rename cmd_id enum names for consistency

* `char` -> `s8` for explicit padding in cmd structs

* `Room.unk03/03` -> `behaviorType2/1`

* `UNK_PTR` -> `void*`

* `showInvisActors` -> `lensActorsMode` + enum

* Add `ROOM_BEHAVIOR_TYPE1/2_` enums

* "mesh" -> "mesh header"

* `Polygon polygon` -> `PolygonBase base` (for now...)

* Misc cleanup

* "lens actors mode" -> "lens actor mode"

* Revert "`char` -> `s8` for explicit padding in cmd structs"

This reverts commit 59b9295828.

* `LENS_ACTOR_MODE_` -> `LENS_MODE_HIDE/SHOW_ACTORS`
2022-05-21 08:54:51 -04:00
fig02
4f0018bf36
Environment documentation pass (#1115)
* some docs, start introducing time macro

* most usages of CLOCK_TIME

* finish up clock time defines, format

* saving incase i need to revert

* more docs

* more docs progress

* some more docs

* format with 11

* change sos to storm

* update functions.h

* some depth stuff

* review 1 and 2

* whoops

* update zbuf stuff

* most of review 3

* enum name

* storm state enum

* review 4

* fix enum

* add comment to skyboxischanging

* review

* things dont match, committing so i can change branches

* revert struct changes

* define for override_full_control

* new clock_time macro

* fill alpha -> glare strength

* update comment

* remove indoor/outdoor, new name for underwater light variable

* remove copy pasted comment

* fix comments

* remove whitespave

* review
2022-05-20 14:40:13 -04:00
Dragorn421
d7bbe43ba7
Document eventChkInf usage of freed carpenters flags (#1210)
* Document `eventChkInf` usage of freed carpenters flags

* +`()`
2022-05-20 19:54:47 +02:00
EllipticEllipsis
0e51a51fb1
Document SkelCurve system (#1192)
* Rename and document SkelCurve

* AVOID_UB in DemoTreLgt_OverrideLimbDraw

* Rename code_8006C510

* Objdump flags in the makefile

* Move CC_CHECK above compilation

* Review 1

* Review 2

* Review 3

* Review
Add doxygen comments to file head
use angle macro,
improve bug comment,
make arguments of SkelCurve_Draw more consistent,
Change this temp to pad in MagicWind
2022-05-20 02:27:54 -04:00
fig02
aadb5f9c47
Gameplay_ -> Play_ and this (#1229) 2022-05-18 00:41:50 +02:00
Dragorn421
f6c472ae5e
Doc misc 5 (#1223)
* Annotate global equip and upgrade masks data

* Trivial respawn doc stuff

Move the respawn mode enum up to use the _MAX enum value in the save context struct

* Comment on the `sceneFlags[127]` debug-strings-suggested out-of-bounds access

* Reword `room_inf[127]` comments (attempt)
2022-05-17 00:14:08 +02:00
Dragorn421
d4b6b31b15
Document entrances 0x7FF9-0x7FFF as "Return Entrances" (#1217)
* Document entrances 0x7FF9-0x7FFF as "Exit Entrances"

* `ENTR_EXIT_` -> `ENTR_RETURN_`

* "exit entrance" -> "return entrance"

* Less plural
2022-05-15 11:26:59 -04:00
engineer124
bf56c94f0f
Document Sub-Cameras (#989)
* Copying SubCam Changes from PR 908, made it to the end of bosses

* Finish copying over PR

* format

* More cleanup

* clean-up

* PR Suggestions, Clean-Up, Improvement in CS

* Remove substructs from fd/fd2

* format

* Improve fishing

* minor fix

* Make CutsceneCameraDir more general

* `sActiveCamMove` -> `sCamMove`

* Fix conflict with object kankyo

* Add CAM_ID_MAIN to object_kankyo

* Improve cam cutscenes further

* Revert cutscene cmd names (better for a separate PR)

* At -> LookAt in the context of Cutscenes

* Missed naming in diving game

* Format

* Fill in Ganon2 Names (now that it's matching)

* format

* `sActiveCamId` -> `sReturnToCamId`

* activeCamId -> returnToCamId

* Discord Discussions

* FIRST

* Move macro to bottom, comments

* More suggestions

* PR suggestion, cleanup comment

* Oops

* add comments

* Adjust comment

* Change edge-case

* whoops

Co-authored-by: fig02 <fig02srl@gmail.com>
2022-05-12 20:35:31 +02:00
Roman971
92aef346f2
Remove many redundant parentheses (eg. in boolean conditions) (#1220)
* Remove many unnecessary parens around boolean conditions

* Remove duplicate parens in some expressions

* Apply review suggestions

* Update src/overlays/actors/ovl_Bg_Jya_Lift/z_bg_jya_lift.c

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

Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
2022-05-12 09:04:37 -04:00
Roman971
c799176a30
Various minor cleanups (#1218)
* Fix assert in z_en_horse.c

* Fix UB sceneFlags access in z_en_elf.c

* Add Object_Spawn to public object functions

This function is used externally in MM and works as a standalone, so it most likely belongs to the public interface

* Fix float literals to always use lowercase e for the exponent

* Remove "mininap" in one of the map data variables

sDgnMinimapTexIndexBase is also used for the pause menu map so naming it for the minimap turned out to be inaccurate
2022-05-10 15:51:38 -04:00
fig02
2efd00863a
Introduce DEFINE_ENTRANCE for entrance table and create entrance enum (#1213)
* entrance table OK

* entrance enum fixed

* most entrances using enum, still need to do conditionals

* more entrances

* entrance_table.h cleanups

* some review

* remove _0 from first entrance in a group of setups

* change table description

* typo

* wens spellcheck in vscode

* remove extra line
2022-05-09 13:45:53 -04:00
engineer124
95b4317931
Audio Ocarina Documentation (#1026)
* Begin ocarina documentation

* Many ocarina-related docs

* More ocarina docs

* Introduce Ocarina Fonts Enum

* Fix ocarina font enum

* Fix incorrect documentation, more documentation

* Ocarina recording documentation

* cleanup

* Small touch-ups

* Fix font -> instrument

* format

* Better docs on playback, memory game

* more cleanup

* Add z64ocarina.h

* Clean up names

* final cleanup

* typo

* Fix description

* better docs

* Fix channel -> channelIdx

* Fix old "font" name to correct "instrument" name, add io port docs

* Add comments to clarify certain lines/functions

* format

* Rename noteIdx to pitch

* Missed a name

* Add comment on pitch

* `reset` -> `SetInstrument` and `displayed` -> `playback`

* Clarify audio_update and windmill comment

* Minor PR fixes

* Revert Audio_Update because there are 2 different Audio_Update functions

* PR Feedback

* Ocarina Idx -> Index

* Introduce OCARINA_BTN_C_RIGHT_OR_C_LEFT

* PR Suggestions

* Next PR Suggestions

* Next PR Feedback

* consistency

* Better docs (PR)

* Better comment
2022-05-09 18:59:23 +02:00
Dragorn421
6cd8029cd5
Fixup weird horse flags usage (#1214)
* wip: refactor flag defines for `eventInf[0]`

* Cleanup attempt

* run formatter

* remove spacing in enum indices comments

* Add line breaks

* Macros +`()` -`;`
2022-05-08 18:17:10 -04:00
Dragorn421
3b0e095ee6
Document EnInsect actor (#1184)
* Initial commit

* Go through the rest of the code

* Fix length of EnAnubice.flameCircles

The length used to be 4, but in a for loop 5 elements were used. There
was unused unknown space right after the array and that is now part of
flameCircles.

* Fix offset comment in EnAnubice header

* Fix length of BossGanon2.unk_234

The length used to be 16, but only 15 elements seem to be used. The for
loops only went to 14, and the indicse gotten from a lookup table are
also never higher than 14.

* Revert some ARRAY_COUNTs back to literals

In these cases, using ARRAY_COUNT can make the code more confusing to
read, since the lengths of these arrays are already assumed in other
places in the code or the index is used in multiple arrays.

* Initial commit

* Rename stateTimer to actionTimer

This name is more consistent with actionFunc.

* Name (Setup)Crawl and (Setup)CrawlToSpawn functions

* Rename (Setup)Sink to (Setup)Dig and add (Setup)Sink and (Setup)Drown

* Add IS_DROPPED macro

This is way shorter than checking type == ... || type = ... every time.

* Rename INSECT_FLAG_6 to INSECT_FLAG_LANDED

* Name INSECT_FLAG_0 and the two remaining functions

* Rename INSECT_FLAG_1 to INSECT_FLAG_ON_GROUND

* Replace 'bug' with 'insect' in comment

* Revert changes made in array-count branch

* Update INSECT_DROPPED name in z_player.c

Seems I forgot to rebuild before committing.

* Use bug instead of insect in comments

* Apply suggested changes

* Fix faulty merge

* Run formatter

* Improve `sInitInsectFlags` formatting

* Revert `INSECT_FLAG_ON_GROUND` to `INSECT_FLAG_1`, purpose unclear (to me at least)

* Revert `INSECT_FLAG_TEMP_AND_ALIVE` to `INSECT_FLAG_0`, purpose unclear (to me at least)

* `INSECT_FLAG_TEMP` -> `INSECT_FLAG_IS_SHORT_LIVED`

* `Sink` -> `WalkOnWater`

* `INSECT_FLAG_LANDED` -> `INSECT_FLAG_DROPPED_HAS_LANDED`

* `EnInsect_FoundNearbySoil` -> `EnInsect_TryFindNearbySoil` and cleanup the function

* Run formatter

* Cleanup `actionTimer`

* Some cleanup

* Add `_TYPE_` in `EnInsectType` enum names

* `crawlSoundTimer` -> `crawlSoundDelay`

* Remove `IS_DROPPED` macro

Co-authored-by: Milo van der Tier <milo@vdtier.nl>
2022-05-08 17:59:27 -04:00
Dragorn421
2dfccbb919
Document eventChkInf usage of frogs played songs flags (#1211)
* Document `eventChkInf` usage of frogs played songs flags

* Prettify frogs flags defines

* Friendlier macro names
2022-05-08 17:52:35 -04:00
Tom Overton
74bed3ec9b
Document En_Rd (#1179)
* Port a ton of stuff from MM

* Damage effect enum

* Enum for type

* Enum for action

* Limb enum

* Match MM styling as much as possible

* Divide object into sections

* Document values in EnRdDamageEffect

* Respond to Dragorn's review

* Apply Dragorn's suggestion for the union

* Respond to Dragorn's second review

* Move all actions away from -ing

* Fix typos

* Respond to Fig and Roman's reviews

* Fix build error, whoops

* Bring back // fallthrough
2022-05-07 16:43:01 +02:00
engineer124
80186ec1ab
HealthMeter_ -> Health_ (#1202)
* HealthMeter_ -> Health_

* PR Suggestion
2022-05-07 10:18:42 -04:00
engineer124
5cc5cf5a7e
Cleanup pad's in z_scene_table.c (#1215)
* cleanup

* More cleanup
2022-05-07 16:10:06 +02:00
Dragorn421
ca77b26c90
Fix misc 11 (#1209)
* Pass boolean for `freezeFlag` to `Actor_SetDropFlag`

* Use `else if`s in `func_80835F44`

* Cleanup `transitionCtx` usage of instance data

* `TransitionContext.setEnvColor` -> `TransitionContext.setUnkColor`

* Fixup one comment

* linebreaks (#1)

* Run formatter

Co-authored-by: fig02 <fig02srl@gmail.com>
2022-05-04 21:25:26 +02:00
EllipticEllipsis
e84f5ab387
Memstuff (#1164)
* Un-fake a couple of matches in memory manip functions

* Document fmodf

* Un-fake a couple of matches in memory manip functions

* Document fmodf

* Rename functions and files

* Document memmove, memsets, memcpys

* Format

* Sort out some missing sizeofs

* Name fmodf

* Rename local variables

* size_t

* Use COBRA_SHADOW_TEX_SIZE

* Review

* Tweak the Doxyfile to remove @brief requirement

* Roman's review

* Fix a bug comment

* Change fmodf
2022-05-02 00:06:35 +02:00
Dragorn421
b9fded7b4e
Doc equips usage (inventory, current and player-specific constants) (#1142)
* Doc equips usage (inventory, current and player-specific constants)

* Improve some comments

* `currentSword`(`Item`) -> `currentSwordItemId`

* Comments on the right in `D_801261F8`

* Improve `sDebugSaveInventory.equipment` formatting with extra parentheses

* Use constants for `sNewSaveInventory.equipment`

* Run formatter

* Make comments in z64save.h header a single line even if very long

* `CHECK_OWNED_EQUIP_ALT`

* One more use of `CHECK_OWNED_EQUIP`

* `OWNED_EQUIP_FLAG`

* `OWNED_EQUIP_FLAG_ALT`

* Improve (?) giving sword by item id

* "half-byte" -> "nibble"

* Improve equips for setting kokiri sword

* Improve (?) checking boots by item id

* Improve (?) checking equips by item id

* Fixup one spot assuming `EQUIP_TYPE_SWORD == 0`

* Comments on the right in `sBootDListGroups`
2022-04-30 18:18:56 +02:00
Dragorn421
72847660eb
Fix misc 10 (#1208)
* Cleanup around `Item_DropCollectible`

* Cleanup around `Math3D_Vec3fDistSq`, `Math3D_Dist2DSq`

* Material/Model naming for one dlist pair

* Minor comments fixup

* Explicit `!= NULL` check

* Signed decimal for an array of coordinates

* Fixup comments some more
2022-04-30 08:33:28 -04:00
Dragorn421
4a6bfcdd21
Cleanup clang-format off (#1195)
* Run formatter

* Remove useless `// clang-format off`

* Improve manual formatting inside `clang-format off` blocks

* Remove `// clang-format off` where used only for code style formatting

* Remove some `// clang-format off` with a for loop "trick"

* Reduce the size of `clang-format off` blocks

* Remove one `clang-format off` by moving assignment to inside line

* Revert "Remove some `// clang-format off` with a for loop "trick""

This reverts commit 30c344b800.

* Put some `// clang-format on` back on the same level as `off`
2022-04-29 15:06:08 -04:00
Dragorn421
0d7670f059
Fixup feetFloorFlags doc and -> feetFloorFlag (#1180) 2022-04-29 14:29:49 -04:00
Dragorn421
6336df5fcd
Defines for SaveContext flags (eventChkInf, itemGetInf, infTable, eventInf) (#1094)
* script-assisted `itemGetInf` flags

* comment near non-trivial `itemGetInf` usage

* Run formatter

* Try something with the itemgetinf flags that can't use the packed value

* Add defines for `eventChkInf` (direct access)

* Add defines for `eventChkInf` (access through `Flags_GetEventChkInf`)

* Add defines for `eventChkInf` (access through `Flags_SetEventChkInf`)

* Add defines for `infTable` (direct access)

* Add defines for `infTable` (used by `Flags_GetInfTable`)

* Add defines for `infTable` (used by `Flags_SetInfTable`)

* Add defines for `eventInf`

* parenthesis cleanup near `GET_EVENTCHKINF` usage

* parenthesis cleanup near `GET_ITEMGETINF` usage

* parenthesis cleanup near `GET_INFTABLE` usage

* fixup one `eventInf` usage

* parenthesis cleanup near `GET_EVENTINF` usage

* parenthesis cleanup near `Flags_GetEventChkInf` usage

* slight `z64save.h` formatting improvement

* Improve itemGetInf flags in z_bg_dy_yoseizo

* Questionable improvement in z_en_ge2

* Questionable improvement in z_en_daiku

* Questionable improvement in z_en_mu

* Run formatter

* Parentheses around `gSaveContext` macros arguments

* Move individual flags define to the end of z64save.h, and improve comments separating the groups
2022-04-29 14:19:48 -04:00
fig02
16790bc253
Document Transition System (#1131)
* transition type enum

* mode enum, start documenting some types

* some more

* use enums for entrance table

* entrance table filled out

* sceneLoadFlag -> transitionTrigger

* sandstorm state/mode/type

* done i think

* fixes

* clean up circle weirdness

* circle use enum + fix texture names

* fix

* how did that even happen lol

* jesus

* review2

* some more review

* most review, still some more to do

* new transition trigger names

* some of review

* next type default
2022-04-27 16:00:25 -04:00
Dragorn421
fed9ac3e20
Angle cleanup - macros names (#1193)
* Move binang utility macros out of angle conversion macros block

* `BINANG_TO_DEGF` -> `BINANG_TO_DEG_ALT` (it may even be warranted to name it _approx instead of _alt, unsure)

* Add `BINANG_TO_DEG` (unused by oot) (for completeness)

* `DEGF_TO_BINANG` -> `DEG_TO_BINANG_ALT` (again may even be _approx, or maybe _cam)

* Add `DEG_TO_BINANG` (unused by oot) (for completeness)

* `RADF_TO_BINANG` -> `RAD_TO_BINANG`

* `RADF_TO_DEGF` -> `RAD_TO_DEG`

* Cleanup argument names in angle conversion macros

* Format for angle macros changes

* Run formatter

* Move `DEG_TO_BINANG_ALT`, `BINANG_TO_DEG_ALT` to z64camera.h

* Remove `DEG_TO_BINANG`, `BINANG_TO_DEG`

* Remove `_ALT` from `DEG_TO_BINANG`, `BINANG_TO_DEG`

* Add comment about inaccuracy near `DEG_TO_BINANG`, `BINANG_TO_DEG`

* run formatter

* `CAM_` prefix on `DEG_TO_BINANG`, `BINANG_TO_DEG` macros

* Revert "Remove `DEG_TO_BINANG`, `BINANG_TO_DEG`"

This reverts commit 5321647e5b.
2022-04-24 10:23:49 -04:00
engineer124
ef870bdd11
Name variables for Audio_PlaySoundGeneral (#1198)
* Rename variables and function

* Improve comment

* PR Suggestion

* PR Suggestions

* Revert back to `Audio_PlaySoundGeneral`, make a separate PR `Sound` -> `Sfx`

* Oops, fixed that
2022-04-23 10:55:18 -04:00
engineer124
1e03b662f2
Parameter/Item Misc Cleanup (#1201)
* Misc parameter cleanup

* More cleanup

* More cleanup

* ia4, more readable

* More comments

* PR Suggestion
2022-04-23 16:41:17 +02:00
playerskel
32e66c2da8
document most navi enemies as enum type (#1110)
* document most navi enemies as enum type

* enum value auto increments, add enemy default for 0

* also define and comment navi enemy tektite blue

* Update include/z64actor.h

Co-authored-by: mzxrules <mzxrules@gmail.com>

* Update include/z64actor.h

Co-authored-by: mzxrules <mzxrules@gmail.com>

* Update include/z64actor.h

Co-authored-by: mzxrules <mzxrules@gmail.com>

* Update include/z64actor.h

Co-authored-by: mzxrules <mzxrules@gmail.com>

* Update include/z64actor.h

Co-authored-by: mzxrules <mzxrules@gmail.com>

* Update include/z64actor.h

Co-authored-by: mzxrules <mzxrules@gmail.com>

* apply navi enemy updates accepted so far

* update names

* review

* review

* freezzard -> freezard

Co-authored-by: mzxrules <mzxrules@gmail.com>
Co-authored-by: fig02 <fig02srl@gmail.com>
2022-04-18 18:23:12 -04:00
Dragorn421
38bcbdb0b9
Doc misc 3 (#1176)
* Misc doc/cleanup

* run formatter
2022-04-09 06:31:49 -04:00
Dragorn421
76cffddf29
Cleanup pass on in-actor effects systems (#1167)
* Name in-actor effect functions / improve naming consistency

"particle" -> "effect"

Fixup: consistent effect functions names, missed a bunch

* Use `materialFlag` as int for the "is material already set" "boolean"

Fixup `materialFlag` (actually a boolean one), and `objectFlag`

More actually boolean `materialFlag`s

* Consistently use `_EFFECTS_COUNT` defines (except partial buffer usage, for now)

`BOSSFD_EFFECT_COUNT` -> `BOSSFD_EFFECTS_COUNT`

`EFFECT_COUNT` -> `FISHING_EFFECTS_COUNT`

Place `_EFFECTS_COUNT` defines before effect struct definition

* Name `countLimit` the "max new effect index" argument

* Rename all effect buffers to `effects`/`sEffects`

* Fixup some array/pointer usage

* `EnNiw` also has this pseudo-effects system

* `EnSyatekiNiw` also has this pseudo-effects system

* `EnFz` also has this pseudo-effects system

* `_EFFECTS_COUNT` -> `_EFFECT_COUNT`

* `effects` -> `effect` where used as iterator (hopefully covers everything)

* Run formatter
2022-04-08 20:29:26 -04:00
Robin Allen
9984c267d9
Names for some view things (#1191)
* Names for some view things

* Review: ORTHOGRAPHIC → ORTHO

* Review: dirty → dirtyFlags

* Review: Doc comment style

* Review: Define constants in terms of each other

* Review: Rename the ApplyToOverlay functions

* Update include/z64.h

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

* Review: Better View_LookAtInternal doc

* arg1 → mask

* View_LookAtInternal → View_LookAtUnsafe

* Review: View_SanityCheckEyePosition → View_ErrorCheckEyePosition

* sViewNotInitialized → sLogOnNextViewInit

* Remove VIEW_FORCE_ALL

* near/far → zNear/zFar

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

* lookAt → at

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

* near/far → zNear/zFar

* View_ApplyPerspective/Ortho: Remove from header instead of commenting

* lookAt → at

* Add fwd decls

* Fix external view->at accesses

* Missed these somehow

* lookAt → at

* Omit "Apply" in comments

* dirtyFlags → flags

* View_ApplyScissor → View_ApplyShrinkWindow

* Update src/code/z_view.c

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

Co-authored-by: fig02 <fig02srl@gmail.com>
Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-04-09 00:50:28 +02:00
Dragorn421
b9b40805f7
Fix misc 9 (#1183)
* Fix typo `tranform` -> `transform`

* (may be controversial) `indexes` (noun) -> `indices`, both are correct but `indices` prevails in the repo currently, and seems prefered in technical contexts

* Fixup one `@bug`

* Fix typo `relfect` -> `reflect`

* Rename and `@bug` `DemoTreLgt_OverrideLimbDraw`

* Fixup `PLAYER_AP_` to `ARROW_` type conversion

* `posModel` -> `modelPos`

* `effSpawnPosModel` -> `effSpawnModelPos`

* Gohma decay bug: Verified that timers do not prevent UB access

* Reorder summation in a more meaningful way

Co-authored-by: JoshDuMan <40190173+JoshDuMan@users.noreply.github.com>
2022-04-03 18:33:50 -04:00
engineer124
04fb0ac1b1
Document Pushing Player: Bg Conveyors and Climbing Slopes (#1103)
* Document pushing Player

* Cleaner and better names

* Tiny cleanup

* Add enum to func

* PR Feedback

* Change conveyor to `IsFloorConveyor`

* Small touchup

* Attempt at better comments

* Clarify comments

* Clarify comment further

* Fix formatting

* PR Feedback
2022-04-04 00:06:25 +02:00
Dragorn421
3ce701cfd8
Angle cleanup - miscellaneous (#1159)
* Add `BINANG_TO_RAD_ALT2`

* Few hex constants in place of decimal cardinal angles

* Use `BINANG_TO_DEGF` more

* Use `DEG_TO_RAD(int)` for angle literals

* `BINANG_TO_RAD_ALT(literal)` -> use `BINANG_TO_RAD`

* Somewhat arbitrary literal angles cleanup
2022-04-03 14:32:18 -04:00
Dragorn421
4729ac131a
Angle cleanup - DEG_TO_RAD (#1157)
* Run formatter

* Touch up angle macros (parentheses and hex constants)

* Remove `DEGF_TO_RADF`, use `DEG_TO_RAD` instead

* Remove `DEGTORAD`, use `DEG_TO_RAD` instead

* Use `DEG_TO_RAD` more
2022-03-20 19:33:29 -04:00
Dragorn421
c42c172e72
Use BINANG_TO_RAD_ALT more (#1156) 2022-03-20 18:58:36 -04:00
Dragorn421
8f9e309452
Doc (partially) player model and anim code data (#1143)
* Doc (partially) player model and anim data

* `Player_OverrideLimbDrawPause` -> `func_80091880`

* Enum comments: use hex

* Change `D_80853914` to 1D array, change accesses to use new macro `PLAYER_ANIM_BY_GROUP_AND_TYPE`

* `PLAYER_ANIM_BY_GROUP_AND_TYPE` -> `GET_PLAYER_ANIM`
2022-03-20 23:42:01 +01:00
Dragorn421
0e5ecdcd73
Angle cleanup - BINANG_TO_RAD, BINANG_TO_RAD_ALT (#1158)
* Run formatter

* Touch up angle macros (parentheses and hex constants)

* Add `BINANG_TO_RAD_ALT`

* Swap `BINANG_TO_RAD` and `BINANG_TO_RAD_ALT`

* Run formatter
2022-03-19 20:16:33 -04:00
Dragorn421
4f6967b027
Doc misc 4 (#1177)
* Doc/cleanup misc

* Name `prevFrame`/`beforeCurFrame`/`afterPrevFrame` and related variables

* Actually this pad variable I renamed can be removed
2022-03-19 19:42:11 -04:00
Dragorn421
b2a3fb2f7f
Fix misc 8 (#1150)
* Use `s32` as type instead of `StackStatus` enum type

* `bossLimbDl` -> `bossLimbDL`

* Fixup comment refering to `Actor.velocity` by struct offset

* Fixup `feetFloorFlags` doc and -> `feetFloorFlag`

* Fixup `xyzDistToPlayerSq` comment

* Make `SkelAnime.mode` comment refer to `AnimationMode` (<- `AnimationModes`)

* Use enum names to refer to anim modes and break long lines in z64animation.h

* `EnDha_OverridePostDraw` -> `EnDha_PostLimbDraw`

* ichains cleanup

* Scene command ids usage cleanup

* Properly name unkXXX members as unk_XXX

* change `gSceneCmdHandlers` length in variables.h too

* Revert Unknown flags to unk0 & unk1

* Remove "current scene" mention from `Flags_*Unknown` as they aren't saved or loaded so not scene-specific

* `Struct_8011FAF0`: unk_00, unk_04

* Run formatter

* Do not break long lines in headers

* Revert "Fixup `feetFloorFlags` doc and -> `feetFloorFlag`"

This reverts commit c45b3611e7.
2022-03-16 22:14:56 +01:00
Dragorn421
61b864a89c
Angle cleanup - RADF_TO_BINANG (#1155)
* Run formatter

* Touch up angle macros (parentheses and hex constants)

* Use `RADF_TO_BINANG` more
2022-03-13 14:46:46 -04:00
Dragorn421
054bac7583
Doc player drawing (#1098)
* Introduce and use more enums and defines for equips and data involved in player drawing

* `EQUIP_TYPE_`, `EQUIP_INV_`, `EQUIP_VALUE_`

* Improve doc on ItemEquips/Inventory's `equipment` field

* Run formatter

* Add `PLAYER_MODELGROUPENTRY_*` for second index of `gPlayerModelTypes`

* Name `PLAYER_MODELGROUPENTRY_*` from existing documentation

* Partial doc on `PLAYER_MODELTYPE_*`

* Some doc on `PLAYER_MODELGROUP_*`

* Run formatter

* Name and some doc/cleanup on the various player draw functions

* Name symbols used for player position in pause menu

* Name player override/post limb draw callbacks

* `BOOTS_NORMAL` -> `BOOTS_KOKIRI`

* `EQUIP_INV_SWORD_GIANTKNIFE` -> `EQUIP_INV_SWORD_BROKENGIANTKNIFE`

* `currentSword` -> `currentSwordItem` to avoid confusion with `PlayerSword` enum

* Make one constant more explicit

* Document severe bug (not an issue by luck)

* Some doc on `PLAYER_MODELTYPE_RH_FF`

* Actually name most of `PlayerModelType`

* Actually name most of `PlayerModelGroup` and improve comments

* Make equipment in debug save data use equip enums

* Name symbol for computing player's `bodyPartsPos` and fix struct access

* Name right/left `HandType` symbols

* Add `PlayerBodyPart` enum

* Run formatter

* Introduce defines for pause player render dimensions and cleanup viewport usage in pause drawing

* Document `playerSegment` related usage

* Run formatter

* Revert player bodypart changes

* Revert equips doc changes

* Revert player model and anim data changes

* Revert drawing-unrelated changes

* Move `sTunicColors` tunic comments to after data
2022-03-12 19:06:43 -05:00
playerskel
a160fb96c8
Naming1 (#1113)
* typo

* rename 800636C0 to gameinfo_init

* fix incorrect casing in cup button

* some constants

* add item00_none enum value

* rename 80009460 to gdmaverbose

* fix typos

* Revert "some constants"

This reverts commit 27a07204d7.

* rename gdmaverbose to gdmamgrverbose

* Revert "rename 800636C0 to gameinfo_init"

This reverts commit c74e255929.

* Revert "fix incorrect casing in cup button"

This reverts commit ac313b3965.

* a couple of typos

* minor changes based on clang-format
2022-03-10 21:21:46 +01:00
Dragorn421
c55a8530ee
PlayerMeleeWeaponAnimation enum (#1154)
* Move `PlayerSwordAnimation` from `z_en_torch2.c` to `z64player.h`

* `PlayerSwordAnimation` -> `PlayerMeleeWeaponAnimation`

* Add `PWMA_` prefix to `PlayerMeleeWeaponAnimation` values

* Use `PlayerMeleeWeaponAnimation` enum more

* Add `PWMA_MAX`

* Update comments in z_en_kanban.c

* Some cleanup around conditionals with `meleeWeaponAnimation`

* Comment `PWMA_` index value in `D_80854190`

* `PMWA_` -> `PLAYER_MWA_`

* Minor fixup

* Missed one spot

* Run formatter
2022-03-09 12:52:28 -05:00
Dragorn421
5cadc5df8a
Document/fix Player.bodyPartsPos usage (#1141)
* Document/fix `Player#bodyPartsPos` usage

* `distFromLinksHead` -> `distFromPlayerHat`

* Comment on `bodyPartsPos[-1]`

* Run formatter

* Use `PLAYER_BODYPART_MAX` more

* Use hex for `PlayerBodyPart` enum comments
2022-03-08 19:50:27 -05:00
Dragorn421
c73053db6f
Name variables holding poly normals and variables used in COLPOLY_GET_NORMAL (#1168) 2022-03-08 19:43:07 -05:00
Dragorn421
ed6ec5bceb
Doc misc 1 (#1160)
* Misc documentation 1

* Add parentheses

Co-authored-by: EllipticEllipsis <73679967+EllipticEllipsis@users.noreply.github.com>

* Move the parentheses to the right place

* `curByte`(2) -> `curChar`(2)

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

* Revert `isMaterialSet` boolean usage

* Fix misplaced line (how did that happen)

* Fixup

Co-authored-by: EllipticEllipsis <73679967+EllipticEllipsis@users.noreply.github.com>
Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
2022-02-27 16:32:05 -05:00
Dragorn421
145b14dbc4
sword -> meleeWeapon (#1147) 2022-02-20 18:45:12 -05:00
Dragorn421
b9cc31dc74
Defines for flags passed to Actor_UpdateBgCheckInfo (#1127)
* Tool-assisted flags for `Actor_UpdateBgCheckInfo`

* Manual flags separation

* Run formatter

* Light doc on the flags

* `UPDBGCHECKINFOFLAG_` -> `UPDBGCHECKINFO_FLAG_` (what an improvement!)

* Run formatter

* Run formatter
2022-02-20 18:41:55 -05:00
Dragorn421
e51fd73704
Fix misc 7 (#1149)
* Fixup `Math3D_LineClosestToPoint`

* `gDodongosCavernBossLavaFloorTex` is 32x64

* Name empty-dlist-making functions `_EmptyDList`

* Fix typos

* transitionRate -> morphFrames

* Compare `xyzDistToPlayerSq` to squared values

* Fix hookshot target/post collision header names being swapped

* Fix description of `z_bg_mizu_movebg.c`

* Add scene command comment to `func_80098508` to match other scene command handlers

* Some fixup in `Camera_Demo5`

* `1` -> `ALLOCTYPE_ABSOLUTE` in comment on `ActorContext.absoluteSpace`
2022-02-20 08:31:31 -05:00
Dragorn421
a9526a3354
Fix misc 6 (#1148)
* Fix typo `vertexs` -> `vertices`

* Fix typo `limbMatricies` -> `limbMatrices`

* Fix some `gSPTextureRectangle` usage of fixed point constants

* Run formatter

* `ALIGN8` macro

* `object_skj` cleanup

* sholder -> shoulder

* cleanup `stdbool.h`

* Some function prototypes cleanup

* Use macros in `osVirtualToPhysical`
2022-02-20 14:22:29 +01:00
Revo
c3533052ca
Add GCC compiler option. (#1056)
* GCC support.

* Add note about gcc-mips-linux-gnu requirement to README.md.

* changes

* changes based on Tharo's suggestion

* Cant reproduce file_choose.h error. Removing unnecessary -I

* changes

* wording based on Fig's suggestion

* add AVOID_UB for eyes/mouth reordering issue.

* remove unneeded flags and deprecate ZAPDFLAGS.

* some changes, waiting on prs for the rest

* fixes

* discard header sections

* change section handling in mkldscript

* avoid_ub in DmaMgr_GetFileNameImpl

* move asm to inline asm (consolidate gcc functions)

* change prefix back

* remove space

* fix warnings

* Revert "remove space"

This reverts commit 94af6977b3.

* Revert "fix warnings"

This reverts commit d729ddf457.

* finish up missing_gcc_functions

* revert unwanted mkldscript change

* temporary workaround. TODO: Stop the asm processor from choking

* fix ido build

* Revert "temporary workaround. TODO: Stop the asm processor from choking"

This reverts commit 9df892b7ac.

* review

* remove unused line in mkldscript

* remove tabs

* clarify zf comment

* review2

* review

* remove duplicate cc_check

* vanilla code always come first

* std_dma avoid ub

* add compiler_gcc to cflags

* only use two blocks when necessary

* clarify zf comment

Co-authored-by: fig02 <fig02srl@gmail.com>
2022-02-19 16:50:56 -05:00
Dragorn421
67f294774b
Defines for Actor#bgCheckFlags (#1126)
* First pass, tool assisted bgCheckFlags

* Few manual bgCheckFlags

* Run formatter

* Remove fake bgCheckFlags 10-15

* Move existing documentation to the defines

* Comment on `bgCheckFlags` and rephrase some doc

* Name obvious flags, and some cleanup

* Comment on flag 9 being wall-interaction-related (thanks engineer and fig)

* Run formatter

* `BGCHECKFLAG_7` -> `BGCHECKFLAG_GROUND_STRICT`

* Touch up water-related bgcheckflags doc

* `BGCHECKFLAG_9` -> `BGCHECKFLAG_PLAYER_WALL_INTERACT`
2022-02-18 21:16:19 -05:00
Dragorn421
ed0daabf98
Run formatter (#1139) 2022-02-13 00:29:48 +01:00
EllipticEllipsis
c8d150afe2
Anubice fix, bit more documentation (#1136)
* Add file comment to BgJyaMegami

* Fix and clean Anubice up a bit

* Review

* Improve names, add some usage comments

* Revert to fireballPos

* headPitch

* Rename to AimFireball

* Review

* Put abdomen the right way up
2022-02-11 18:20:48 -05:00
EllipticEllipsis
eadc477187
New relocation-generating program (#1016)
* Update makefiles

* git subrepo clone git@github.com:EllipticEllipsis/fado.git tools/fado

subrepo:
  subdir:   "tools/fado"
  merged:   "46c4d751a"
upstream:
  origin:   "git@github.com:EllipticEllipsis/fado.git"
  branch:   "master"
  commit:   "46c4d751a"
git-subrepo:
  version:  "0.4.3"
  origin:   "https://github.com/ingydotnet/git-subrepo.git"
  commit:   "2f68596"

* git subrepo pull tools/fado

subrepo:
  subdir:   "tools/fado"
  merged:   "88114ebce"
upstream:
  origin:   "git@github.com:EllipticEllipsis/fado.git"
  branch:   "master"
  commit:   "88114ebce"
git-subrepo:
  version:  "0.4.3"
  origin:   "https://github.com/ingydotnet/git-subrepo.git"
  commit:   "2f68596"

* A few ideas for computing dependencies

* Remove reserved identifiers from spec.h and util.h
and add required headers

* Fix a couple more headers

* Program for reloc prerequisites

* git subrepo pull tools/fado

subrepo:
  subdir:   "tools/fado"
  merged:   "36a905f72"
upstream:
  origin:   "git@github.com:EllipticEllipsis/fado.git"
  branch:   "master"
  commit:   "36a905f72"
git-subrepo:
  version:  "0.4.3"
  origin:   "https://github.com/ingydotnet/git-subrepo.git"
  commit:   "2f68596"

* Update makefile to make dependency files and use overlay's name

* git subrepo pull tools/fado

subrepo:
  subdir:   "tools/fado"
  merged:   "43c339a59"
upstream:
  origin:   "git@github.com:EllipticEllipsis/fado.git"
  branch:   "master"
  commit:   "43c339a59"
git-subrepo:
  version:  "0.4.3"
  origin:   "https://github.com/ingydotnet/git-subrepo.git"
  commit:   "2f68596"

* Change awk to grep, delete ZAPD files, gitignore elf

* Delete all the cfg files

* Fix memory leaks

* Rename and add coloured errors

* Makefile tweaks
- preprocess spec before grep
- split order prerequisites via phony target to reduce dependency edges
- remove `resources` target
- remove separate overlays targets
- use `$(SPEC)` throughout
- change to using filenames of relocs for overlay names via `$*`
- Rearrange targets to better reflect their categories

* Update gitignore

* Review

* Add a check for the reloc file name

* get_segment_by_name

* get_stmt_id_by_stmt_name

* Cleaning up

* algorithm change

* function rename

* Fix typos

Co-authored-by: angie <angheloalf95@gmail.com>
2022-02-06 14:40:26 -05:00
Tharo
c8f4d66b00
Documentation for fault.c and fault_drawer.c (#1106)
* Mostly document fault and fault_drawer

* FaultDrawer printf functions return s32

* Review Suggestions for comments

Co-authored-by: EllipticEllipsis <73679967+EllipticEllipsis@users.noreply.github.com>

* Some further review suggestions

* Further changes from suggestions

* Fix Fault_AddClient doc comment

* Bug comment for memdump overrun, add more to Fault_PadCallback bug comment

* mb -> MB, comment about bss above externs

* Fix color codes

Co-authored-by: EllipticEllipsis <73679967+EllipticEllipsis@users.noreply.github.com>
2022-02-02 16:43:34 -05:00
hatal175
aecd883bbc
Document some z_actor.c functions (#1091) 2022-01-31 18:36:58 +09:00
playerskel
82cedcc3ef
proposal for link age macros (#1119)
* proposal for link age macros

* apply @Dragorn421 suggestions

* also annotate the slinkage variable
2022-01-24 19:08:37 -05:00
playerskel
621b91e2b6
vector change proposal from @Kelebek1 (#1120) 2022-01-24 19:00:30 -05:00
fig02
7877966f03
fix function (#1118) 2022-01-24 18:55:34 -05:00
Yanis42
2dbe518f16
Document Obj_Switch subtypes (#1082)
* * Named subtypes enums
* Updated the comment for unk_17F

* Removed unk_17F comment

* * Merged SubTypes enums
* Fixed JntSphElement items count
* Used ARRAY_COUNT where it's needed

* Used subtype enum names for SetOn and SetOff
Changed "SUBTYPE_DEFAULT" to "SUBTYPE_ONCE"
Updated some comments

* Updated reset subtyped names
Documented a bug with the inverted reset subtype

* Comments

* forgot one comment

* Formatting

* Review

* Review 2

* Missed one comment
2022-01-24 18:51:14 -05:00
louist103
d1ac7eb80d
Document the lens system (#1079)
* merge master

* A little bit

* start docs on lens

* Delete Jenkinsfile

* Make sense of the numbers in `Actor_DrawLensOfTruthMask` f3dzex commands

* More comments on `Actor_DrawLens` f3dzex usage

* remove padding

* renames

* Simplify gfx comments

* Add some line breaks

* Remove undef

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
Co-authored-by: Louis <louist103@pop-os.localdomain>
2022-01-25 00:42:36 +01:00
playerskel
f4a72303cb
Whitespace (#1112)
* remove trailing whitespaces

* minor docs tweaks

* some more trailing whitespaces

* few more tweaks
2022-01-23 18:09:02 -05:00
Dragorn421
6479913daa
Defines for player state flags (#1081)
* script-assisted player state flags

* Run formatter

* manually convert state flags in `D_80116068`

* `PLAYER_STATE_FLAG_` -> `PLAYER_STATE`

* Run formatter
2022-01-17 19:04:07 -05:00
Dragorn421
2a4fb604fb
Cleanup symbols 7 (#1073)
* Cleanup symbols, mostly from non-matching objects

* ZAPD supports unaligned textures!

* Uncomment `object_oF1s`
2022-01-17 18:50:18 -05:00
Dragorn421
98259a128d
Misc. doc/cleanup 4 (#1093)
* Cleanup parameters passed to `Actor_SpawnFloorDustRing`

* `10` -> `ARROW_NUT` for spawning EnArrow

* Missing empty line after declaration

* Introduce `ACTORCAT_MAX`

* Minor cleanup

* Run formatter

* `sgiDrawIds` -> `giDrawIds`

* `sDmaMgrDataExistError` -> `sDmaMgrIsRomCompressed` bool

* Add Makefile dependencies to rebuild some files when editing actor, object and effect tables in `include/tables/`

* Run formatter

* Revert "Add Makefile dependencies to rebuild some files when editing actor, object and effect tables in `include/tables/`"

This reverts commit c6b9a92139.
2022-01-17 21:30:30 +01:00
engineer124
9450272503
Improve River_Sound Docs (#1100)
* river_sound docs

* Small touch-up

* PR Suggestions

* Improve comments on river line calculations

* More PR Feedback

* after analyzing the filter data for MM, lowPassFilter is reverse to what I thought it was
2022-01-14 17:13:04 -05:00
Anghelo Carvajal
9fec455805
Small Skin system documentation pass (#1017)
* some docs

* rename a bunch of callbacks

* more cleanup

* format

* last cleanup

* some updates

* more docs

* done i think

* name flag and format

* name unused variable

* comments

* revert unwanted change

* z64skin.h

* format

* Address review

* Rename PostLimbDraw callbacks to PostDraw and some PR addressing

* add true/false for setTranslation

* ahhhh

* remove "you"

Co-authored-by: fig02 <fig02srl@gmail.com>
2022-01-12 18:00:28 -05:00
Dragorn421
e5ecdfd559
Misc. doc/cleanup 5 (#1096)
* `0` -> `CHEST_ANIM_SHORT` in `GET_ITEM` z_player macro

* fix typos in z_en_skj

Co-authored-by: Yanis42 <yalink88@gmail.com>

* `unkSkjStruct` -> `EnSkjUnkStruct`

* Use `EFFECT_SS_` enum in all `EffectSs_Spawn` calls

* Decimal for all `EffectSs_Spawn` priorities

* Use `OBJECT_INVALID` more

* `Object_IsLoaded` returns a boolean

* Add `@bug` in `DmaMgr_SendRequestImpl` about passing partially uninitialized struct

* Fix typo `forc_structure_alignment` -> "force"

* Move `CMD_F` to `z64cutscene_commands.h` since it is specifically for cutscene data

* Use `ALIGN16` macro more

* Use `ALIGN256` macro more

* Add `@bug` on two messed up 8-bytes-aligns

* Set `gSaveContext.nightFlag` to 0/1 instead of false/true

* Use `IS_DAY` macro more

* Run formatter

Co-authored-by: Yanis42 <yalink88@gmail.com>
2022-01-12 15:48:04 -05:00
Dragorn421
11917bf640
Cleanup around some generic animation info structs (#1059)
* Name generic anim info structs and cleanup usage

* Make `EnDaiku` use generic struct

* Add `/* decimalid */` comments to all added enums

* small fixes

* Two more generic animinfo structs

* Cleanup usage of newly generic structs

* Cleanup x2 usage of newly generic structs

* `transitionRate` -> `morphFrames`

* Properly name generic anim structs (attempt to at least)

* `anim` -> `animation`

* fixes

* run formatter

* Use consistent prototypes for each actor's ChangeAnim helper

* run formatter

* minor cleanup

* Run formatter

* `Animation_ChangeInfo` -> `Animation_ChangeByInfo`
2022-01-11 21:10:43 -05:00
engineer124
59e212c197
Document code_8006BA00 (Audio Sound Sources) (#997)
* Document SoundSources

* PR Suggestions

* Duration timers to dec

* `PlaySfxByPosAndId` -> `PlaySoundByPosition`

* Improve names

* `PlaySfxAtStationaryPosition` -> `PlaySfxAtFixedWorldPos` and `originWorldPos` -> `worldPos`

* format
2022-01-10 20:31:53 -05:00
Dragorn421
b1d3844325
Document undocumented matrix functions (#955)
* Document `func_800D1694` as `Matrix_TranslateRotateYXZ`

* Document `func_800D1FD4` as `Matrix_ReplaceRotation`

* Cleanup `Matrix_RotateAxis`

* Document `func_800A7EC0` as `SkinMatrix_SetRotateAxis`

* Document `func_800D2A34` and `func_800D2A98` as `Matrix_SetTranslateScaleMtx`(`F`)

* Document mostly unused functions at the end of `sys_matrix.c`

* Add in-use renamed functions to `namefixer.py`

* Add `Matrix_SetTranslateScaleMtx2` to `namefixer.py`

* Run formatter

* Fix namefixer.py mistake from #952

* Format clang-11.1

* Fix `Matrix_TranslateRotateYXZ` wrongly documented, it actually is `Matrix_SetTranslateRotateYXZ`

* VS Code is stellar at refactoring (no)

* Run formatter

* Come on VS Code

* Improve `Matrix_ReplaceRotation` docs

* Fix typo

* Fix namefixer.py
2022-01-11 00:28:01 +01:00
Dragorn421
0b8edc21c0
ACTOR_FLAG_11 -> ACTOR_FLAG_ENKUSA_CUT (#1065) 2021-12-27 13:24:41 -05:00
engineer124
b8b983dd7f
Nature Ambience Documentation (#1063)
* Document nature ambience io data

* Document nature ambience functions

* Function headers

* Doc storing main bgm for nature/miniboss bgm

* Give temporary names to functions

* small cleanup

* add docs to clarify

* Break up nature ambience channel io data for easier reading

* Add info to where each nature ambience Id is used

* Name environmental sequence functions

* Use channel macros globally

* Add nature enum, revert env name

* Revert tough-to-name functions, use nature channel enum instead

* Fill in remaining enums from sequence 1

* PR Suggestions

* Improve macros

* remove clang-format off

* MINI_GAME_2 -> TIMED_MINI_GAME

* Revert to generic name

* Fix Spacing
2021-12-27 12:35:05 -05:00
louist103
a862411f00
Objects4 (#1057)
* remove fake match

* merge master

* animations

* dog limbs

* textures

* KZ limbs and DL

* a few KZ textures and make a file for link_boy

* the rest of KZ

* Far Limb DLs

* near DLs and limbs

* small fix to child

* boots and some sword and more child clean ups

* a bunch of DLs

* fix boy

* fix link child for real this time

* adult should be good now

* progress

* all undefined symbols done

* progress

* done (for now)

* restore makefile

* child -> adult

* child -> adult

* dog fixes

* KZ fixes

* more player fixes

* remove unneeded enum in dog

* rename hookshot stuff

* Update z_player_lib.c

* revert model group stuff

* move comment

* fix mirror shield upper

* remove useless 2

* OOT -> Oot

* gauntlet plate 2 fix

* fix

Co-authored-by: Louis <louist103@pop-os.localdomain>
2021-12-27 08:08:26 -05:00
Dragorn421
05b2cbfc60
Doc dodongo's cavern stuff (#1019)
* Document `func_80033480` more

* More doc in `BgDdanKd`

* WIP Document BgDodoago

The dodongo skull light-eyes-with-bomb puzzle
Some TODOs, jank/legacy code which I'm unsure if it achieves something significant

* Finish documenting BgDodoago

* `BgDodoago_WaitExplosives_` -> `BgDodoago_WaitExplosives`

* Run formatter

* `dlistBuffer` -> `displayListHead`
2021-12-10 20:21:19 -05:00
Dragorn421
15d3796574
Replace more constants with proper asset symbols (#1071) 2021-12-07 20:10:44 +01:00
Dragorn421
a9284494f2
Use defines for actor flags (#873)
* Add ACTOR_FLAG_ defines

* Add ACTOR_FLAGS_ALL macro and use ACTOR_FLAG_* constants everywhere

* Remove unused ACTOR_FLAG_* constants

* actor flags in bigokuta & ko

* actor flags in obj_mure

* actor flags in stalfos, twinrova & ganon2

* actor flags in morpha & barinade

* name some previously missed actor flags

* found some comments using hex for actor flags

* Actor flags in ovl_En_Ganon_Mant

* Actor flags in EnWf

* Flags in en_zf

* Actor flags in BossGanon (FeelsOKMan)

* Remove `ACTOR_FLAG_NONE`

* Wrap expansion of `FLAGS` in parentheses

* `ACTOR_FLAGS_ALL` -> `CHECK_FLAG_ALL`

* Move `CHECK_FLAG_ALL` to `macros.h`

* Run formatter
2021-12-05 19:11:38 -05:00
engineer124
79220ba58a
Document Sequence Modes and Related Functions (#1046)
* Document Audio_SetSequenceMode

* Cleanup surrounding docs

* format

* Clean-up

* fix capital `I` in `playeridx`

* Dist -> DistSq

* `SetCamModeAndSeqMode` -> `UpdateCamAndSeqModes`

* Get rid of extra padding

* PR Feedback
2021-12-05 12:13:53 -05:00
fig02
e635e34265
Remove THIS macro (#1047)
* remove THIS

* fix

* forgot dorf
2021-12-04 11:33:00 -05:00
engineer124
5e9d24fca4
Clean Up Sequence Structs in Scene/Save/z64 (#1051)
* Clean up sound scene struct

* Follow-up cleaning

* cleanup

* Document forcedSeqId

* Update include/z64save.h

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

* Update include/z64.h

Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com>

Co-authored-by: fig02 <fig02srl@gmail.com>
Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com>
2021-12-03 09:49:32 -05:00
fig02
4390dd74b6
boss_ganon (Ganondorf) OK (#1037)
* data migrated and OK

* some functions ported

* everything ported and updated

* merge message

* plenty of functions matched

* remove unwanted file

* 5 more, progress on update

* update matched

* fix proto

* fix

* func_808E06FC

* asm

* 2 left

* 1 more

* last function inital decomp

* Dbg MQ OK

* docs progress

* revert limb stuff

* some more docs

* docs progress

* more docs

* done with docs for now i think

* revert unwanted change

* some symbols

* anime2

* format

* small changes

* some more changes

* merge master and fix matrices

* reviews 1 and 2

* remove continue

* review 3 and 4

* un-name bodyPartsPos for now
2021-12-02 17:31:39 -05:00
Dragorn421
8ff1f242fa
Replace some more constants with proper asset symbols (#1053) 2021-12-02 16:19:19 -05:00
engineer124
1ac6e42b56
Cutscene Camera Commands: POS -> EYE, FOCUS -> LOOK_AT (#993)
* Cutscene Camera Commands: `POS` -> `EYE`, `FOCUS` -> `LOOK_AT`

* PR Suggestion: Update names with REL_TO

* Use newer name in macros, address PR comment
2021-12-02 22:04:55 +01:00
Dragorn421
b3d5f549e7
Document Actor_DrawDoorLock (#1045) 2021-12-01 19:32:23 -05:00
Dragorn421
ff49ace524
Symbol cleanup 4 (#1050)
* Replace some hardcoded constants with proper asset symbols

* Remove Blob which turned out to be a texture
2021-12-01 19:21:32 -05:00
Tharo
f1d183d6fe
libultra files and directories restructure (#1038)
* Restructure files, begin header restructure

* Format

* us2dex

* Fix parallel spelling

Co-authored-by: JoshDuMan <40190173+JoshDuMan@users.noreply.github.com>

* Use OS_K0_TO_PHYSICAL in place of VIRTUAL_TO_PHYSICAL in osAiSetNextBuffer

* Uppercase hex, exception vector address defines

* Interrupt flags 1

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

* Interrupt flags 2

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

Co-authored-by: JoshDuMan <40190173+JoshDuMan@users.noreply.github.com>
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2021-11-30 19:08:57 -05:00
engineer124
eabc918817
Name the coordinate transformation matrices (#1042) 2021-11-30 18:52:16 -05:00
Dragorn421
669732abbe
Misc Cleanup 2 (#1007)
* Cleanup `UNK_TYPE`, `UNK_PTR` usage

* Add some missing empty lines after declarations

* Remove some legacy comments from non-matching times

* Fix some grammar (mostly "it's"/"its")

* Use proper names for two symbols after ZAPD bugfix

* Cleanup `place_title_cards.xml`

* Use `NULL` to check against `D_8012D260` pointer

* Parentheses around some macro arguments

* wip proofread headers up to z64animation.h
2021-11-30 18:40:42 -05:00