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

1113 commits

Author SHA1 Message Date
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
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