Commit Graph

5 Commits

Author SHA1 Message Date
Jed Grabman c68b3d481f Steering (#761)
* Document steering

* Refer to steering position, instead of steering angle

Refer to steering position instead of steering angle, to make clear that it is not the same thing as degrees.

* Change comment to block format
2026-04-13 17:18:45 -06:00
Jed Grabman a5526cc5bf Document effects and define magic values (#733)
* Document projection matrix function

Document function for computing a projection matrix. Used for camera and graphics.

* Fix loop index bug

Fix straightforward loop index bug introduced in last commit

* Style guide updates

Changes to match style recommendations
* Update function variables to camelCase
* Use dOxygen tags
* Use block comment

* Document math functions

* Give all functions in src\racing\math_util.c descriptive names

* Improve documentation for math_util

Improves a number of functions by giving descriptive argument names and comments

* Additional merge

* Fix style issues

update variables / parameters to use camelCase instead of snakeCase

* doxygen and other documentation

* Add doxygen documentation
* Rename mat -> mtx for consistency among matrices
* Theta -> Angle for angles
* Give some arguments more descriptive names

* Partial documentation for calculate_orientation_matrix

Documentation for when cosAxisY is 1 and observations that things break when if it does not equal 1.

* Rename functions

Renamed multiple functions for accuracy or clarity

* doxygen whitespace alignment

Improve readability of doxygen info by aligning text

* Make format check

Formatting updates suggested by make format

* Make skyboxes static

* Change function name

angle_from_coords -> get_angle_between_coords

* Math values renamed

Functions:
render_distance_squared -> distance_if_visible
mtxf_rotation_zxy_translate -> mtxf_rotate_zxy_translate

Arguments:
vecTrans -> translate

* Document many effects

Define effects for
* Braking
* Drifting
* Spinning out (driving and bananas)
* Mini turbos
* Losing at GP
* Tumbling on terrain
* CPU rubberbanding

And substitute some pre-existing defined effect names in place of bit flags

* Replace effect magic numbers with defined values

* Separate effect bit-flags into components

* Document more effects

* Rename some effects

* Replace effect bit_flags with defined values

* Formatting fixes

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-07-17 20:53:11 -06:00
Maciek Baron 8d4fa64f5a Document functions and variables (balloons, acceleration, a button handling etc.) (#720)
* Document various functions and variables

* Fix code changes

* Rename function based on discussion

* Identify global table of player speeds

* Improve names of functions

* Label further things related to playerIndex

* Label further balloon related things

* Document further balloon related things

* Use STAR_DURATION

* Update vars

* Fix missing arg
2025-06-10 13:59:02 -06:00
coco875 c6e40bcec0 fix name introduce by the previous pr (#701)
* fix more name

* Update cpu_vehicles_camera_path.c

* more fix of name

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-05-18 14:20:05 -06:00
coco875 731b24eabf Doc code 80005fd0 (#697)
* Document code_80005FD0.c
2025-01-18 17:24:09 -07:00