summaryrefslogtreecommitdiff
path: root/include
AgeCommit message (Collapse)Author
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
2022-12-19OnePointCutscene Cleanup (#1467)engineer124
* cleanup * more cleanup * attention cs * remove comment
2022-12-17`z_play`: Camera Docs and Cleanup (#1460)engineer124
* begin docs * More suggestions * more docs * timer to duration * partial PR review * init data with player * consistent comments * withPlayer to usingPlayer
2022-12-12Introduce Player csMode enum (#1462)engineer124
* player csmode enum * cleanup * missed one, player2 * spell out enum name * use CSMODE_MAX for data
2022-12-12Some cleanup/doc on the item icons (#1263)Dragorn421
* 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`z_actor` documentation pass (#1445)Anghelo Carvajal
* 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-12Fix misc GCC compatibility issues (#1463)Dragorn421
* Fix osGetMemSize being optimized to `return 8MB` by gcc Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com> Co-authored-by: ariahiro64 <45049787+ariahiro64@users.noreply.github.com> * Workaround f32 to s16 cast for binang being UB if binang doesn't fit s16 Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com> Co-authored-by: ariahiro64 <45049787+ariahiro64@users.noreply.github.com> * osGetMemSize fixup * include z64math in z64camera Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com> Co-authored-by: ariahiro64 <45049787+ariahiro64@users.noreply.github.com>
2022-12-11OnePointDemo ActionFlags Macros (#1451)engineer124
* actionflags * more macros * distinguish enums better * PR Suggestions * Update src/code/z_camera_data.inc.c Co-authored-by: Derek Hensley <hensley.derek58@gmail.com> * Update src/code/z_camera_data.inc.c Co-authored-by: Derek Hensley <hensley.derek58@gmail.com> Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>
2022-12-11Good Camera Mode Names (#1455)engineer124
* better camera mode names * cleanup * improve aiming modes * follow boomerang comment * more mode docs * cleanup * hookshotFly, revert to still
2022-12-05Cleanup post good scene names (#1452)Dragorn421
* 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-04Camera Flags (#1225)engineer124
* 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-11-30Skelanime/Animation header cleanup (#1434)Dragorn421
* Skelanime/Animation header cleanup * touch up names of the two existing moveFlags macros * formatter is a dum dum D:
2022-11-26Document Camera for Elevator Platforms (Camera_Special7) (#1448)engineer124
* document camera for vertical platforms * cleanup * another rename * small * another rename * add comment * PR Suggestions * more cleanup * oops * adjust comment
2022-11-26Document Surface Material (#1447)engineer124
* material * cleanup * iron boots * climb * more docs * rename * small fix * comments * adjust bug comment * simplify comment
2022-11-26Add skybox .h and cleanup, `SkyboxDraw_` -> `Skybox_` (#1435)Dragorn421
* Add skybox .h and cleanup * move forward declared structs to top of file * `SkyboxDraw_` -> `Skybox_` * format * move more forward declared structs to top of file
2022-11-26Name scenes (scene enum, entrance enum, various identifiers) (#1343)Dragorn421
* 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 210a38a6288d5d2fa318059f31988ca7ceb5c708. * 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-26Document HREG debugging system (#1351)fig02
* progress * progress * change * named most * name prerender things * fix and format * play prefix * address most comments (still a few more things to do) * fix error * reword input test comments * some more * rework env draw flags * add hilite * merge and format * init to proper values * rename env draw flag names * 7 to 6 * more small changes
2022-11-26Player doc: Temporary `PLAYER_ANIMGROUP` names from original animation names ↵Dragorn421
(#1446) * Name `PLAYER_ANIMGROUP_` based on original names * format * add comment indicating source of names
2022-11-25Document NPC talking and player tracking (#1426)Lauri Koskela
* 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-22Document Hud Mode (#1323)engineer124
* 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-16More documentation for `z_std_dma.c` (#1415)Tharo
* 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-16Document Timers (#1412)engineer124
* 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-16Update item names (#1376)Dragorn421
* 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-16Mempak doc (#1382)Tharo
* Mempak doc * Format * Suggested changes * Further changes
2022-11-13TwoHeadArena and TwoHeadGfxArena docs (#1349)Tharo
* TwoHeadArena and TwoHeadGfxArena docs, ALIGNOF macro * AllocStart -> AllocHead , AllocEnd -> AllocTail * Format * Suggested changes * Fix * Further suggested changes
2022-11-13Improvements to Video Interface related functions and data (#1332)Tharo
* Improvements to VI related functions * Fix * Suggested changes * Comment enum values Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com> * Suggested changes, plus comments in visetspecial.c * Name gViConfigModeType * Further suggested changes * Format * Fix comment on modeLPN2 Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
2022-11-13Fix misc 18 (#1423)Dragorn421
* 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-13Improve rcp.h, remove `HW_REG` macro (#1425)Tharo
* Real rcp.h * Correction to comment in initialize.c * Try fix R4300.h * Adjust rcp.h formatting, remove defines in other headers that are now in rcp.h * Suggested changes, document a bug in the modified osAiSetNextBuffer * More rcp.h formatting changes
2022-11-01Rename `vt.h` to `terminal.h` (#1339)Dragorn421
* `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-01Some doc on env light settings (#1307)Dragorn421
* 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-10-29Doc speed_meter timers and misc. low-ish level stuff (#1364)Dragorn421
* Misc docs (somewhat lower level) * Run formatter * Simplify comment * `a = a +` -> `a +=` with pad removal Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> * `isPreNMIStateRunning` -> `inPreNMIState` * line breaks Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> Co-authored-by: fig02 <fig02srl@gmail.com>
2022-10-24Documentation pass on `DoorShutter` (#1352)Dragorn421
* 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-23Document Crawlspaces (#1286)engineer124
* 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-16Rename scene lists (#1344)fig02
* first pass * revert unwanted zap change * review * name Actor_InitContext, change arg name * change bzero to use type
2022-10-16Some `OREG` docs (camera data regs) (#1405)Dragorn421
* very wip oreg docs * more * more * more * more useful comment
2022-10-16Misc Sequence Docs (#1400)engineer124
* 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-15Lightweight trigonometry doc (#1356)Dragorn421
* 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`gbi.h` and `ucode_disas.c` cleanups (#1267)Tharo
* Merge GfxMod and Gfx, various ucode_disas improvements, gdSPDefMtx, gbi.h formatting improvements * Suggested changes * Further suggested changes * Fix matrix Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Formatting changes Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Clarify Gnoop callback * the thing Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Switch spaces, uintptr Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-10-15Document elf_message scripting system (#1398)fig02
* `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-15Cleanup `VecSph`: Better Distinguish Between "Spherical" vs. "Geographic" ↵engineer124
Coordinates (#1407) * begin geo and sph docs * cleanup * cleanup * cleanup struct * PR suggestions * spacing
generated by cgit v1.2.3 (git 2.25.1) at 2026-09-20 07:19:17 +0000