* Make `sNew` in (unused) `code_800FC620.c` a string
It is passed as a filename to `__osMallocDebug` so should be a nul-terminated string, not a char[3] missing an explicit \0
* Fix gcc warning in `JpegDecoder_ParseNextSymbol` about SLL on negative value
-1U is an unsigned value, aka 0xFFFFFFFF
I keep -1 because it seems that's what a jpeg standard has too
References:
https://stackoverflow.com/questions/40508958/shifting-a-negative-signed-value-is-undefinedhttps://www.w3.org/Graphics/JPEG/itu-t81.pdf (page 105, figure F.12)
* Small cleanup
* Fix few mistakes (thanks gcc warnings)
* Add `@bug` in file select settings draw code, using the wrong array
* format
* format main
* rename arg for a happy formatter
* Move important function call out of a printf
* Remove `(ActorFunc)` casts in initvars, use `/**/` trick for format
Achieved by using the following regex:
(ActorInit.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(?:\(ActorFunc\))?(.*)(\n\s+)(?:\(ActorFunc\))?(.*)(\n\s+)(?:\(ActorFunc\))?(.*)(\n\s+)(?:\(ActorFunc\))?(.*\n\};)
replaced with
$1$2/**/ $3$4/**/ $5$6/**/ $7$8/**/ $9$10/**/ $11$12/**/ $13$14/**/ $15$16/**/ $17$18/**/ $19
plus a change from /**/ to #if 0 #endif in docs/
* Manual fixes
* 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
* 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>
* 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
* 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
* 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>
* 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" ?
* 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
* 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>
* 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>
* "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
* 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
* 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
* 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>
* 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
* 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
* begin docs
* More suggestions
* more docs
* timer to duration
* partial PR review
* init data with player
* consistent comments
* withPlayer to usingPlayer
* 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>
* 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>
* document camera for vertical platforms
* cleanup
* another rename
* small
* another rename
* add comment
* PR Suggestions
* more cleanup
* oops
* adjust comment
* 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>
* 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>
* `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
* 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.
* 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
* 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
* 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
* `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
* 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>
* 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>
* 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`
* 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
* `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>
* 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
