summaryrefslogtreecommitdiff
path: root/include
AgeCommit message (Collapse)Author
2023-10-07Rename Math3D_CylOutsideCyl and Math3D_CylOutsideCylDist (#1557)cadmic
* Rename Math3D_CylOutsideCyl and Math3D_CylOutsideCylDist * radix -> radii Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com> * Make Math3D sphere/cylinder collision check function names more consistent --------- Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
2023-10-07Player Docs: Propose Named Unions For Shared Variables (#1560)fig02
* make unions * format * adjust comment on halt thing
2023-10-05Introduce Player CueIds (#1559)engineer124
* cueId * cleanup
2023-09-26Player Docs: csMode -> csAction (#1547)fig02
* csmode -> cs action * format
2023-09-26Fix gamestate overlay table size declaration (#1555)Tharo
2023-09-25Speedmeter Small cleanup (#1554)Derek Hensley
* Small cleanup * x
2023-09-22Name the main pause state and add placeholder enum for main (sub)states (#1551)Dragorn421
2023-09-19Dekunut Salesman Docs (#1493)Billy
* 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-19Player docs: Control Stick Input and Movement (#1539)fig02
* 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-19Doc/Cleanup pass on object handling (#1227)Dragorn421
* `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-18Start Player Item Docs (#1523)fig02
* item docs * format * loop change * some of engineers review * shorten comment (thanks formatter) * ProcessItemButtons * true/false
2023-09-17Name player's generic `actionVar`s (#1538)fig02
* name player generic vars * format
2023-09-16Change player struct variable spacing (#1537)fig02
* change spacing * missed something * missed another * and another lol
2023-09-16Document Framebuffer Filters, VisCvg and VisZbuf (#1534)Tharo
* 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-13Player Docs: Name actionFunc (#1531)fig02
* progress, going to merge master * merge master * finish renmaing functions * reorder declarations
2023-09-09Apply noreturn attribute where applicable (#1532)Tharo
2023-09-06Document Player's bgcheck routine (`func_80847BA0`) (#1503)fig02
* progress * progress * progress * done for now * floor pitch comments * sYDistToFloor * add function comment * sFloorShapePitch * typo in header
2023-09-06Document pause states (excluding gameover) (#1483)Dragorn421
* 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-06z_fishing partially documented (#1424)blackgamma7
* 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-08-19En_Cow Doc (#1492)Billy
* 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-15Doc/cleanup pass on effects 1 (#1421)Dragorn421
* 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-15Placeholder names for skelanime moveflags (#1489)Dragorn421
* 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-15Cleanup/add bgcheck macros (#1478)Dragorn421
* Cleanup/add bgcheck macros * vIA -> vI * parentheses around bit& * achivement get: formatter contrarian * COLPOLY_VTX_FLAGS -> COLPOLY_VTX_FLAGS_MASKED * & before << in WATERBOX_PROPERTIES packing macro * & before << in SURFACETYPE* packing macro and fix parentheses
2023-08-15Split z64.h: move various things, state, sram, gfx, jpeg, prerender, ↵Dragorn421
speedmeter (#1487) * Split z64.h more * fix speedmeter.h (expect this kind of issue resolution to pop up eventually) * fix z64object.h * fix z64state.h * fix (probably only partially) z64play.h * fix fix speedmeter.h :) * revert making a play header (sadge), add/split transition & transition_instances * move stuff to cutscene, interface * Move `TransitionCircle%` enums to `z64transition_instances.h` * z64state.h -> z64game.h with a "this is not final" comment * forward declare GraphicsContext in z64game.h instead of including the header file for it * don't comment on where the forward declarations are from reasoning: 1) it's easy to go out of sync (like this comment, it was outdated anyway) 2) any IDE can easily find the struct anyway
2023-08-15Document z_lib Sfx Functions (#1470)engineer124
* document lib sfx * rename functions
2023-08-13Split `SaveContext` into sub-structs (#1393)Dragorn421
* Split SaveContext struct * run formatter * Remove temporary-until-split stuff in z_sram * . * run formatter
2023-07-05Minor Misc Cleanup 3 (#1502)engineer124
* more misc cleanup * remove z64 conflicts * undo ISVDbg
2023-07-04Generate gamestate overlay table with an `include/tables/` header (#1504)Tharo
* Generate gamestate overlay table from an include/tables/ header * GameStateIndex -> GameStateId, move to z64.h, add GameStateId enum name field to the gamestate table, adjust and improve gamestate table comment * Shorten zeros in table definition * Generate linker symbols, other suggested changes * GAMESTATE_MAX -> GAMESTATE_ID_MAX like the others
2023-07-03Documentation for skybox drawing (#1515)Tharo
2023-02-27Further documentation for overlay relocation (#1498)Tharo
* Further documentation for overlay relocation * Suggested changes * Format * REL_ -> RELOC_
2023-02-26Minor Misc Cleanup 2 (#1422)engineer124
* misc cleanup * more cleanup * more cleanup * PR Suggestions * cleanup cond
2023-02-26another round of trailing whitespaces (#1495)playerskel
2023-01-12Document OnePointCutscene Init Field (#1465)engineer124
* player csmode enum * cleanup * missed one, player2 * spell out enum name * use CSMODE_MAX for data * doc OnePointDemo Field * PR Suggestions * another suggestion * duplicate word * adjust comment * cleanup comments * oops
2023-01-12`EnHoll` docs (door-less transition between rooms) (#1419)Dragorn421
* 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-12DbCamera to DebugCamera (#1482)engineer124
* better dbCam prefix * missed some * PR Suggestions * alignment * more debug * cleanup
2023-01-10Fix misc 19 (#1488)Dragorn421
* "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-02Cleanup player speed and yaw variable names (#1480)fig02
* initial changes * add comments
2022-12-30Name movement related functions in z_actor (#1476)fig02
* rename functions * dragorns name suggestions * Revert "dragorns name suggestions" This reverts commit dd4626ce5ead0a611e0ff9ca1a2a0e0466d7daf8. * lets try that again * reword comment * comments * projectile speed * arg name * more comments * minVelY comment * merge master and format
2022-12-30Split z64.h: gfxprint, message, pause, view (as new headers), +misc (#1475)Dragorn421
* Split z64.h more * Cleanup Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com> * forward declare `OcarinaStaff` struct for pointer members in message and pause structs * define `struct OcarinaStaff`, not just the `OcarinaStaff` type * PauseBgPreRenderState back to z64.h * Move PauseBgPreRenderState and TransitionTileStatus near the PlayState struct definition Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
2022-12-30Document debug text drawing functions in z_debug.c (#1472)fig02
* 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-28Hack for `CS_TIME` ZAPD compatibility (#1479)Dragorn421
2022-12-28Fbdemo Docs: `TransitionTile` (#1471)Derek Hensley
* TransitionTile' * Final clean up * PR * Header comment * vtx_tn * Name background DL * row <-> col * Rename update functions * Update header * Enum * Done -> Ready + cleanups * Update include/z64transition.h Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-12-26Misc. small cam doc (#1461)Dragorn421
* `Camera.posOffset` -> `Camera.playerToAtOffset` * calcSlopeYAdj bool cleanup * `Camera_CalcAtForLockOn` flags defines -> `CAM_LOCKON_AT_FLAG_` * yOffset * More cleanup * isOffGround
2022-12-24z_demo documentation (#1327)fig02
* 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-24speedXZ -> speed (#1477)fig02
* speedXZ -> speed * += * revert arg in player function * anon review * engineer review * forgot one * last review * revert decimal
2022-12-24TransitionFade docs and clean up other transitions (#1459)Derek Hensley
* TransitionFade docs * PR suggestions * Fix * Fill * Other transitions + enums * Prefix transition assests with trans * Fix end_title * format * OutNames * nitpicks PR * cleaner
2022-12-20Name `Message_StartOcarina` and related things (#1473)fig02
* name functions and msg ctx var * start ocarina * clarifying comments * typo
2022-12-19`R_PAUSE_MENU_MODE` -> `R_PAUSE_BG_PRERENDER_STATE` and docs (#1368)Dragorn421
* `R_PAUSE_MENU_MODE` -> `R_PAUSE_BG_PRERENDER_STATE` and document values and usage * `SREG(33)` -> `R_GRAPH_TASKSET00_FLAGS` * format * `PAUSE_BG_PRERENDER_DRAW` -> `PAUSE_BG_PRERENDER_SETUP` * `PAUSE_BG_PRERENDER_FILTER` -> `PAUSE_BG_PRERENDER_PROCESS` * DList -> display list
2022-12-18Name `Actor_PlaySfx` and `Player_PlaySfx` (#1469)engineer124
* name two main actor sfx functions * adjust comments * fix double s in player * fix commas
2022-12-18DoorShutter logic docs (#1418)Dragorn421
* 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