thirdpartymirrors/sm64coopdx
1
0
Fork 0
mirror of https://github.com/coop-deluxe/sm64coopdx.git synced 2025-10-30 08:01:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix wrongly documented functions (#783)
Some checks are pending
Build coop / build-ubuntu (push) Waiting to run
Details
Build coop / build-windows (push) Waiting to run
Details
Build coop / build-macos-arm (push) Waiting to run
Details
Build coop / build-macos-intel (push) Waiting to run
Details

Browse source
This commit is contained in:
PeachyPeach 2025-05-02 16:34:43 +02:00 • committed by GitHub
parent af6e0afbcf
commit d94cf00eb9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 30 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
autogen/lua_definitions/functions.lua
View file

@ -7819,7 +7819,7 @@ end
--- @param m Mat4 --- @param m Mat4
--- @param dst Vec3f --- @param dst Vec3f
--- @param v Vec3f --- @param v Vec3f
--- Overrides the current room Mario is in. Set to -1 to reset override --- Multiplies a vector by a matrix of the form: `| ? ? ? 0 |` `| ? ? ? 0 |` `| ? ? ? 0 |` `| 0 0 0 1 |` i.e. a matrix representing a linear transformation over 3 space
function linear_mtxf_mul_vec3f(m, dst, v) function linear_mtxf_mul_vec3f(m, dst, v)
-- ... -- ...
end end
@ -7827,7 +7827,7 @@ end
--- @param m Mat4 --- @param m Mat4
--- @param dst Vec3f --- @param dst Vec3f
--- @param v Vec3f --- @param v Vec3f
--- Overrides the current room Mario is in. Set to -1 to reset override --- Multiplies a vector by the transpose of a matrix of the form: `| ? ? ? 0 |` `| ? ? ? 0 |` `| ? ? ? 0 |` `| 0 0 0 1 |` i.e. a matrix representing a linear transformation over 3 space
function linear_mtxf_transpose_mul_vec3f(m, dst, v) function linear_mtxf_transpose_mul_vec3f(m, dst, v)
-- ... -- ...
end end
@ -8118,7 +8118,7 @@ function cur_obj_clear_interact_status_flag(flag)
end end
--- @param obj Object --- @param obj Object
--- Overrides the current room Mario is in. Set to -1 to reset override --- Marks an object to be unloaded at the end of the frame
function obj_mark_for_deletion(obj) function obj_mark_for_deletion(obj)
-- ... -- ...
end end
@ -8458,7 +8458,7 @@ end
--- @param obj Object --- @param obj Object
--- @param posIndex integer --- @param posIndex integer
--- @param localTranslateIndex integer --- @param localTranslateIndex integer
--- Overrides the current room Mario is in. Set to -1 to reset override --- Transforms the vector at `localTranslateIndex` into the object's local coordinates, and then adds it to the vector at `posIndex`
function obj_translate_local(obj, posIndex, localTranslateIndex) function obj_translate_local(obj, posIndex, localTranslateIndex)
-- ... -- ...
end end

8
docs/lua/functions-5.md
View file

@ -2748,7 +2748,7 @@ Overrides the current room Mario is in. Set to -1 to reset override
## [linear_mtxf_mul_vec3f](#linear_mtxf_mul_vec3f) ## [linear_mtxf_mul_vec3f](#linear_mtxf_mul_vec3f)
### Description ### Description
Overrides the current room Mario is in. Set to -1 to reset override Multiplies a vector by a matrix of the form: `| ? ? ? 0 |` `| ? ? ? 0 |` `| ? ? ? 0 |` `| 0 0 0 1 |` i.e. a matrix representing a linear transformation over 3 space
### Lua Example ### Lua Example
`linear_mtxf_mul_vec3f(m, dst, v)` `linear_mtxf_mul_vec3f(m, dst, v)`
@ -2773,7 +2773,7 @@ Overrides the current room Mario is in. Set to -1 to reset override
## [linear_mtxf_transpose_mul_vec3f](#linear_mtxf_transpose_mul_vec3f) ## [linear_mtxf_transpose_mul_vec3f](#linear_mtxf_transpose_mul_vec3f)
### Description ### Description
Overrides the current room Mario is in. Set to -1 to reset override Multiplies a vector by the transpose of a matrix of the form: `| ? ? ? 0 |` `| ? ? ? 0 |` `| ? ? ? 0 |` `| 0 0 0 1 |` i.e. a matrix representing a linear transformation over 3 space
### Lua Example ### Lua Example
`linear_mtxf_transpose_mul_vec3f(m, dst, v)` `linear_mtxf_transpose_mul_vec3f(m, dst, v)`
@ -3814,7 +3814,7 @@ Overrides the current room Mario is in. Set to -1 to reset override
## [obj_mark_for_deletion](#obj_mark_for_deletion) ## [obj_mark_for_deletion](#obj_mark_for_deletion)
### Description ### Description
Overrides the current room Mario is in. Set to -1 to reset override Marks an object to be unloaded at the end of the frame
### Lua Example ### Lua Example
`obj_mark_for_deletion(obj)` `obj_mark_for_deletion(obj)`
@ -5012,7 +5012,7 @@ Overrides the current room Mario is in. Set to -1 to reset override
## [obj_translate_local](#obj_translate_local) ## [obj_translate_local](#obj_translate_local)
### Description ### Description
Overrides the current room Mario is in. Set to -1 to reset override Transforms the vector at `localTranslateIndex` into the object's local coordinates, and then adds it to the vector at `posIndex`
### Lua Example ### Lua Example
`obj_translate_local(obj, posIndex, localTranslateIndex)` `obj_translate_local(obj, posIndex, localTranslateIndex)`

45
src/game/object_helpers.c
View file

@ -816,14 +816,14 @@ void obj_init_animation(struct Object *obj, s32 animIndex) {
} }
} }
/** /* |description|
* Multiply a vector by a matrix of the form Multiplies a vector by a matrix of the form:
* | ? ? ? 0 | `| ? ? ? 0 |`
* | ? ? ? 0 | `| ? ? ? 0 |`
* | ? ? ? 0 | `| ? ? ? 0 |`
* | 0 0 0 1 | `| 0 0 0 1 |`
* i.e. a matrix representing a linear transformation over 3 space. i.e. a matrix representing a linear transformation over 3 space
*/ |descriptionEnd| */
void linear_mtxf_mul_vec3f(Mat4 m, Vec3f dst, Vec3f v) { void linear_mtxf_mul_vec3f(Mat4 m, Vec3f dst, Vec3f v) {
s32 i; s32 i;
for (i = 0; i < 3; i++) { for (i = 0; i < 3; i++) {
@ -831,14 +831,14 @@ void linear_mtxf_mul_vec3f(Mat4 m, Vec3f dst, Vec3f v) {
} }
} }
/** /* |description|
* Multiply a vector by the transpose of a matrix of the form Multiplies a vector by the transpose of a matrix of the form:
* | ? ? ? 0 | `| ? ? ? 0 |`
* | ? ? ? 0 | `| ? ? ? 0 |`
* | ? ? ? 0 | `| ? ? ? 0 |`
* | 0 0 0 1 | `| 0 0 0 1 |`
* i.e. a matrix representing a linear transformation over 3 space. i.e. a matrix representing a linear transformation over 3 space
*/ |descriptionEnd| */
void linear_mtxf_transpose_mul_vec3f(Mat4 m, Vec3f dst, Vec3f v) { void linear_mtxf_transpose_mul_vec3f(Mat4 m, Vec3f dst, Vec3f v) {
s32 i; s32 i;
for (i = 0; i < 3; i++) { for (i = 0; i < 3; i++) {
@ -1469,9 +1469,9 @@ s32 cur_obj_clear_interact_status_flag(s32 flag) {
return FALSE; return FALSE;
} }
/** /* |description|
* Mark an object to be unloaded at the end of the frame. Marks an object to be unloaded at the end of the frame
*/ |descriptionEnd| */
void obj_mark_for_deletion(struct Object *obj) { void obj_mark_for_deletion(struct Object *obj) {
//! This clears all activeFlags. Since some of these flags disable behavior, //! This clears all activeFlags. Since some of these flags disable behavior,
// setting it to 0 could potentially enable unexpected behavior. After an // setting it to 0 could potentially enable unexpected behavior. After an
@ -2314,10 +2314,9 @@ void obj_set_gfx_pos_at_obj_pos(struct Object *obj1, struct Object *obj2) {
obj1->header.gfx.angle[2] = obj2->oMoveAngleRoll & 0xFFFF; obj1->header.gfx.angle[2] = obj2->oMoveAngleRoll & 0xFFFF;
} }
/** /* |description|
* Transform the vector at localTranslateIndex into the object's local Transforms the vector at `localTranslateIndex` into the object's local coordinates, and then adds it to the vector at `posIndex`
* coordinates, and then add it to the vector at posIndex. |descriptionEnd| */
*/
void obj_translate_local(struct Object *obj, s16 posIndex, s16 localTranslateIndex) { void obj_translate_local(struct Object *obj, s16 posIndex, s16 localTranslateIndex) {
if (obj == NULL) { return; } if (obj == NULL) { return; }
f32 dx = obj->rawData.asF32[localTranslateIndex + 0]; f32 dx = obj->rawData.asF32[localTranslateIndex + 0];