diff --git a/autogen/lua_definitions/functions.lua b/autogen/lua_definitions/functions.lua index c40f5929d..c5c4db40d 100644 --- a/autogen/lua_definitions/functions.lua +++ b/autogen/lua_definitions/functions.lua @@ -12361,7 +12361,7 @@ end --- @param o Object --- @param fieldIndex integer --- @return integer ---- Gets the unsigned 32-bit integer value from the field corresponding to `fieldIndex` +--- Gets the unsigned 32-bit integer value of the object field corresponding to `fieldIndex` function obj_get_field_u32(o, fieldIndex) -- ... end @@ -12369,7 +12369,7 @@ end --- @param o Object --- @param fieldIndex integer --- @return integer ---- Gets the signed 32-bit integer value from the field corresponding to `fieldIndex` +--- Gets the signed 32-bit integer value of the object field corresponding to `fieldIndex` function obj_get_field_s32(o, fieldIndex) -- ... end @@ -12377,7 +12377,7 @@ end --- @param o Object --- @param fieldIndex integer --- @return number ---- Sets the float value from the field corresponding to `fieldIndex` +--- Gets the float value of the object field corresponding to `fieldIndex` function obj_get_field_f32(o, fieldIndex) -- ... end @@ -12386,7 +12386,7 @@ end --- @param fieldIndex integer --- @param fieldSubIndex integer --- @return integer ---- Gets the signed 32-bit integer value from the sub field corresponding to `fieldSubIndex` from the field corresponding to `fieldIndex` +--- Gets the signed 16-bit integer value of the object field and sub field corresponding to `fieldSubIndex` and `fieldIndex` function obj_get_field_s16(o, fieldIndex, fieldSubIndex) -- ... end @@ -12394,7 +12394,7 @@ end --- @param o Object --- @param fieldIndex integer --- @param value integer ---- Sets the unsigned 32-bit integer value from the field corresponding to `fieldIndex` +--- Sets the unsigned 32-bit integer value of the object field corresponding to `fieldIndex` function obj_set_field_u32(o, fieldIndex, value) -- ... end @@ -12402,7 +12402,7 @@ end --- @param o Object --- @param fieldIndex integer --- @param value integer ---- Sets the signed 32-bit integer value from the field corresponding to `fieldIndex` +--- Sets the signed 32-bit integer value of the object field corresponding to `fieldIndex` function obj_set_field_s32(o, fieldIndex, value) -- ... end @@ -12410,7 +12410,7 @@ end --- @param o Object --- @param fieldIndex integer --- @param value number ---- Sets the float value from the field corresponding to `fieldIndex` +--- Sets the float value of the object field corresponding to `fieldIndex` function obj_set_field_f32(o, fieldIndex, value) -- ... end @@ -12419,7 +12419,7 @@ end --- @param fieldIndex integer --- @param fieldSubIndex integer --- @param value integer ---- Sets the signed 32-bit integer value from the sub field corresponding to `fieldSubIndex` from the field corresponding to `fieldIndex` +--- Sets the signed 16-bit integer value of the object field and sub field corresponding to `fieldSubIndex` and `fieldIndex` function obj_set_field_s16(o, fieldIndex, fieldSubIndex, value) -- ... end diff --git a/docs/lua/functions-7.md b/docs/lua/functions-7.md index 6779d5890..a48f12947 100644 --- a/docs/lua/functions-7.md +++ b/docs/lua/functions-7.md @@ -4219,7 +4219,7 @@ Gets the corresponding collided object to an index from `o` ## [obj_get_field_u32](#obj_get_field_u32) ### Description -Gets the unsigned 32-bit integer value from the field corresponding to `fieldIndex` +Gets the unsigned 32-bit integer value of the object field corresponding to `fieldIndex` ### Lua Example `local integerValue = obj_get_field_u32(o, fieldIndex)` @@ -4243,7 +4243,7 @@ Gets the unsigned 32-bit integer value from the field corresponding to `fieldInd ## [obj_get_field_s32](#obj_get_field_s32) ### Description -Gets the signed 32-bit integer value from the field corresponding to `fieldIndex` +Gets the signed 32-bit integer value of the object field corresponding to `fieldIndex` ### Lua Example `local integerValue = obj_get_field_s32(o, fieldIndex)` @@ -4267,7 +4267,7 @@ Gets the signed 32-bit integer value from the field corresponding to `fieldIndex ## [obj_get_field_f32](#obj_get_field_f32) ### Description -Sets the float value from the field corresponding to `fieldIndex` +Gets the float value of the object field corresponding to `fieldIndex` ### Lua Example `local numberValue = obj_get_field_f32(o, fieldIndex)` @@ -4291,7 +4291,7 @@ Sets the float value from the field corresponding to `fieldIndex` ## [obj_get_field_s16](#obj_get_field_s16) ### Description -Gets the signed 32-bit integer value from the sub field corresponding to `fieldSubIndex` from the field corresponding to `fieldIndex` +Gets the signed 16-bit integer value of the object field and sub field corresponding to `fieldSubIndex` and `fieldIndex` ### Lua Example `local integerValue = obj_get_field_s16(o, fieldIndex, fieldSubIndex)` @@ -4316,7 +4316,7 @@ Gets the signed 32-bit integer value from the sub field corresponding to `fieldS ## [obj_set_field_u32](#obj_set_field_u32) ### Description -Sets the unsigned 32-bit integer value from the field corresponding to `fieldIndex` +Sets the unsigned 32-bit integer value of the object field corresponding to `fieldIndex` ### Lua Example `obj_set_field_u32(o, fieldIndex, value)` @@ -4341,7 +4341,7 @@ Sets the unsigned 32-bit integer value from the field corresponding to `fieldInd ## [obj_set_field_s32](#obj_set_field_s32) ### Description -Sets the signed 32-bit integer value from the field corresponding to `fieldIndex` +Sets the signed 32-bit integer value of the object field corresponding to `fieldIndex` ### Lua Example `obj_set_field_s32(o, fieldIndex, value)` @@ -4366,7 +4366,7 @@ Sets the signed 32-bit integer value from the field corresponding to `fieldIndex ## [obj_set_field_f32](#obj_set_field_f32) ### Description -Sets the float value from the field corresponding to `fieldIndex` +Sets the float value of the object field corresponding to `fieldIndex` ### Lua Example `obj_set_field_f32(o, fieldIndex, value)` @@ -4391,7 +4391,7 @@ Sets the float value from the field corresponding to `fieldIndex` ## [obj_set_field_s16](#obj_set_field_s16) ### Description -Sets the signed 32-bit integer value from the sub field corresponding to `fieldSubIndex` from the field corresponding to `fieldIndex` +Sets the signed 16-bit integer value of the object field and sub field corresponding to `fieldSubIndex` and `fieldIndex` ### Lua Example `obj_set_field_s16(o, fieldIndex, fieldSubIndex, value)` diff --git a/src/pc/lua/utils/smlua_obj_utils.h b/src/pc/lua/utils/smlua_obj_utils.h index 518e3b193..0bf45cdd5 100644 --- a/src/pc/lua/utils/smlua_obj_utils.h +++ b/src/pc/lua/utils/smlua_obj_utils.h @@ -94,22 +94,22 @@ struct Object *obj_get_collided_object(struct Object *o, s16 index); // Object fields // -/* |description|Gets the unsigned 32-bit integer value from the field corresponding to `fieldIndex`|descriptionEnd| */ +/* |description|Gets the unsigned 32-bit integer value of the object field corresponding to `fieldIndex`|descriptionEnd| */ u32 obj_get_field_u32(struct Object *o, s32 fieldIndex); -/* |description|Gets the signed 32-bit integer value from the field corresponding to `fieldIndex`|descriptionEnd| */ +/* |description|Gets the signed 32-bit integer value of the object field corresponding to `fieldIndex`|descriptionEnd| */ s32 obj_get_field_s32(struct Object *o, s32 fieldIndex); -/* |description|Sets the float value from the field corresponding to `fieldIndex`|descriptionEnd| */ +/* |description|Gets the float value of the object field corresponding to `fieldIndex`|descriptionEnd| */ f32 obj_get_field_f32(struct Object *o, s32 fieldIndex); -/* |description|Gets the signed 32-bit integer value from the sub field corresponding to `fieldSubIndex` from the field corresponding to `fieldIndex`|descriptionEnd| */ +/* |description|Gets the signed 16-bit integer value of the object field and sub field corresponding to `fieldSubIndex` and `fieldIndex`|descriptionEnd| */ s16 obj_get_field_s16(struct Object *o, s32 fieldIndex, s32 fieldSubIndex); -/* |description|Sets the unsigned 32-bit integer value from the field corresponding to `fieldIndex`|descriptionEnd| */ +/* |description|Sets the unsigned 32-bit integer value of the object field corresponding to `fieldIndex`|descriptionEnd| */ void obj_set_field_u32(struct Object *o, s32 fieldIndex, u32 value); -/* |description|Sets the signed 32-bit integer value from the field corresponding to `fieldIndex`|descriptionEnd| */ +/* |description|Sets the signed 32-bit integer value of the object field corresponding to `fieldIndex`|descriptionEnd| */ void obj_set_field_s32(struct Object *o, s32 fieldIndex, s32 value); -/* |description|Sets the float value from the field corresponding to `fieldIndex`|descriptionEnd| */ +/* |description|Sets the float value of the object field corresponding to `fieldIndex`|descriptionEnd| */ void obj_set_field_f32(struct Object *o, s32 fieldIndex, f32 value); -/* |description|Sets the signed 32-bit integer value from the sub field corresponding to `fieldSubIndex` from the field corresponding to `fieldIndex`|descriptionEnd| */ +/* |description|Sets the signed 16-bit integer value of the object field and sub field corresponding to `fieldSubIndex` and `fieldIndex`|descriptionEnd| */ void obj_set_field_s16(struct Object *o, s32 fieldIndex, s32 fieldSubIndex, s16 value); //