thirdpartymirrors/sm64coopdx

Fork 0

mirror of https://github.com/coop-deluxe/sm64coopdx.git synced 2026-06-11 02:21:11 +00:00

Agent X 2ed8b3252f

Build coop / build-linux (push) Waiting to run

Details

Build coop / build-steamos (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

Achieve 100% function documentation (1972/1972 smlua functions) (#1289 )

* Achieve 100% function documentation

Jeez man

* Fix borked character

* Fix an error I must have made a while ago

2026-05-31 16:15:18 -04:00

⏪ Lua Functions

< prev | 1 | 2 | 3 | 4 | 5 | 6 | 7 | next >]

functions from object_helpers.c

clear_move_flag

Description

Clears the flag from the bitSet

Lua Example

local integerValue, bitSet = clear_move_flag(bitSet, flag)

Parameters

Field	Type
bitSet	`integer`
flag	`integer`

Returns

integer
integer

C Prototype

s32 clear_move_flag(INOUT u32 *bitSet, s32 flag);

🔼

Field	Type
room	`integer`

obj_update_pos_from_parent_transformation

Description

Updates an object's position based on a parent transformation matrix

Lua Example

obj_update_pos_from_parent_transformation(a0, a1)

Parameters

Field	Type
a0	Mat4
a1	Object

Returns

None

C Prototype

void obj_update_pos_from_parent_transformation(Mat4 a0, struct Object *a1);

🔼

obj_apply_scale_to_matrix

Description

Applies an object's scale to a transformation matrix

Lua Example

obj_apply_scale_to_matrix(obj, dst, src)

Parameters

Field	Type
obj	Object
dst	Mat4
src	Mat4

Returns

None

C Prototype

void obj_apply_scale_to_matrix(struct Object *obj, VEC_OUT Mat4 dst, Mat4 src);

🔼

create_transformation_from_matrices

Description

Combines two transformation matrices into a single result matrix

Lua Example

create_transformation_from_matrices(a0, a1, a2)

Parameters

Field	Type
a0	Mat4
a1	Mat4
a2	Mat4

Returns

None

C Prototype

void create_transformation_from_matrices(VEC_OUT Mat4 a0, Mat4 a1, Mat4 a2);

🔼

obj_set_held_state

Description

Sets an object's held state based on the behavior script it will perform

Lua Example

obj_set_held_state(obj, heldBehavior)

Parameters

Field	Type
obj	Object
heldBehavior	`Pointer` <`BehaviorScript`>

Returns

None

C Prototype

void obj_set_held_state(struct Object *obj, const BehaviorScript *heldBehavior);

🔼

lateral_dist_between_objects

Description

Calculates the lateral (XZ) distance between two objects

Lua Example

local numberValue = lateral_dist_between_objects(obj1, obj2)

Parameters

Field	Type
obj1	Object
obj2	Object

Returns

number

C Prototype

f32 lateral_dist_between_objects(struct Object *obj1, struct Object *obj2);

🔼

dist_between_objects

Description

Calculates the 3D distance between two objects

Lua Example

local numberValue = dist_between_objects(obj1, obj2)

Parameters

Field	Type
obj1	Object
obj2	Object

Returns

number

C Prototype

f32 dist_between_objects(struct Object *obj1, struct Object *obj2);

🔼

dist_between_object_and_point

Description

Calculates the 3D distance between an object and a point

Lua Example

local numberValue = dist_between_object_and_point(obj, pointX, pointY, pointZ)

Parameters

Field	Type
obj	Object
pointX	`number`
pointY	`number`
pointZ	`number`

Returns

number

C Prototype

f32 dist_between_object_and_point(struct Object *obj, f32 pointX, f32 pointY, f32 pointZ);

🔼

cur_obj_forward_vel_approach_upward

Description

Increases the current object's forward velocity toward target by increment

Lua Example

cur_obj_forward_vel_approach_upward(target, increment)

Parameters

Field	Type
target	`number`
increment	`number`

Returns

None

C Prototype

void cur_obj_forward_vel_approach_upward(f32 target, f32 increment);

🔼

approach_f32_signed

Description

Approaches a value toward a target using signed increments. Returns TRUE when target is reached

Lua Example

local integerValue, value = approach_f32_signed(value, target, increment)

Parameters

Field	Type
value	`number`
target	`number`
increment	`number`

Returns

integer
number

C Prototype

s32 approach_f32_signed(INOUT f32 *value, f32 target, f32 increment);

🔼

approach_f32_symmetric

Description

Approaches a value toward a target using symmetric increments

Lua Example

local numberValue = approach_f32_symmetric(value, target, increment)

Parameters

Field	Type
value	`number`
target	`number`
increment	`number`

Returns

number

C Prototype

f32 approach_f32_symmetric(f32 value, f32 target, f32 increment);

🔼

approach_s16_symmetric

Description

Approaches a 16-bit value toward a target using symmetric increments

Lua Example

local integerValue = approach_s16_symmetric(value, target, increment)

Parameters

Field	Type
value	`integer`
target	`integer`
increment	`integer`

Returns

integer

C Prototype

s16 approach_s16_symmetric(s16 value, s16 target, s16 increment);

🔼

cur_obj_rotate_yaw_toward

Description

Rotates the current object's yaw angle toward a target. Returns TRUE when target is reached

Lua Example

local integerValue = cur_obj_rotate_yaw_toward(target, increment)

Parameters

Field	Type
target	`integer`
increment	`integer`

Returns

integer

C Prototype

s32 cur_obj_rotate_yaw_toward(s16 target, s16 increment);

🔼

obj_angle_to_object

Description

Calculates the angle from one object to another in yaw

Lua Example

local integerValue = obj_angle_to_object(obj1, obj2)

Parameters

Field	Type
obj1	Object
obj2	Object

Returns

integer

C Prototype

s16 obj_angle_to_object(struct Object *obj1, struct Object *obj2);

🔼

obj_pitch_to_object

Description

Calculates the pitch angle from one object to another

Lua Example

local integerValue = obj_pitch_to_object(obj, target)

Parameters

Field	Type
obj	Object
target	Object

Returns

integer

C Prototype

s16 obj_pitch_to_object(struct Object* obj, struct Object* target);

🔼

obj_angle_to_point

Description

Calculates the yaw angle from an object to a point

Lua Example

local integerValue = obj_angle_to_point(obj, pointX, pointZ)

Parameters

Field	Type
obj	Object
pointX	`number`
pointZ	`number`

Returns

integer

C Prototype

s16 obj_angle_to_point(struct Object *obj, f32 pointX, f32 pointZ);

🔼

obj_turn_toward_object

Description

Rotates an object's specified angle toward another object by turnAmount

Lua Example

local integerValue = obj_turn_toward_object(obj, target, angleIndex, turnAmount)

Parameters

Field	Type
obj	Object
target	Object
angleIndex	`integer`
turnAmount	`integer`

Returns

integer

C Prototype

s16 obj_turn_toward_object(struct Object *obj, struct Object *target, s16 angleIndex, s16 turnAmount);

🔼

obj_set_parent_relative_pos

Description

Sets an object's position relative to its parent

Lua Example

obj_set_parent_relative_pos(obj, relX, relY, relZ)

Parameters

Field	Type
obj	Object
relX	`integer`
relY	`integer`
relZ	`integer`

Returns

None

C Prototype

void obj_set_parent_relative_pos(struct Object *obj, s16 relX, s16 relY, s16 relZ);

🔼

obj_set_pos

Description

Sets an object's position in 3D space

Lua Example

obj_set_pos(obj, x, y, z)

Parameters

Field	Type
obj	Object
x	`integer`
y	`integer`
z	`integer`

Returns

None

C Prototype

void obj_set_pos(struct Object *obj, s16 x, s16 y, s16 z);

🔼

obj_set_angle

Description

Sets an object's face and move angles to the same pitch, yaw, and roll

Lua Example

obj_set_angle(obj, pitch, yaw, roll)

Parameters

Field	Type
obj	Object
pitch	`integer`
yaw	`integer`
roll	`integer`

Returns

None

C Prototype

void obj_set_angle(struct Object *obj, s16 pitch, s16 yaw, s16 roll);

🔼

obj_set_move_angle

Description

Sets an object's movement angle (pitch, yaw, roll)

Lua Example

obj_set_move_angle(obj, pitch, yaw, roll)

Parameters

Field	Type
obj	Object
pitch	`integer`
yaw	`integer`
roll	`integer`

Returns

None

C Prototype

void obj_set_move_angle(struct Object *obj, s16 pitch, s16 yaw, s16 roll);

🔼

obj_set_face_angle

Description

Sets an object's face angle (pitch, yaw, roll)

Lua Example

obj_set_face_angle(obj, pitch, yaw, roll)

Parameters

Field	Type
obj	Object
pitch	`integer`
yaw	`integer`
roll	`integer`

Returns

None

C Prototype

void obj_set_face_angle(struct Object *obj, s16 pitch, s16 yaw, s16 roll);

🔼

obj_set_gfx_angle

Description

Sets the graphics angle for an object (pitch, yaw, roll)

Lua Example

obj_set_gfx_angle(obj, pitch, yaw, roll)

Parameters

Field	Type
obj	Object
pitch	`integer`
yaw	`integer`
roll	`integer`

Returns

None

C Prototype

void obj_set_gfx_angle(struct Object *obj, s16 pitch, s16 yaw, s16 roll);

🔼

obj_set_gfx_pos

Description

Sets the graphics position for an object in 3D space

Lua Example

obj_set_gfx_pos(obj, x, y, z)

Parameters

Field	Type
obj	Object
x	`number`
y	`number`
z	`number`

Returns

None

C Prototype

void obj_set_gfx_pos(struct Object *obj, f32 x, f32 y, f32 z);

🔼

obj_set_gfx_scale

Description

Sets the graphics scale for an object in X, Y, Z dimensions

Lua Example

obj_set_gfx_scale(obj, x, y, z)

Parameters

Field	Type
obj	Object
x	`number`
y	`number`
z	`number`

Returns

None

C Prototype

void obj_set_gfx_scale(struct Object *obj, f32 x, f32 y, f32 z);

🔼

spawn_water_droplet

Description

Spawns a water droplet object with the specified parameters

Lua Example

local objectValue = spawn_water_droplet(parent, params)

Parameters

Field	Type
parent	Object
params	WaterDropletParams

Returns

Object

C Prototype

struct Object *spawn_water_droplet(struct Object *parent, struct WaterDropletParams *params);

🔼

obj_build_relative_transform

Description

Builds a relative transformation matrix for an object based on parent-relative position and face angle

Lua Example

obj_build_relative_transform(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_build_relative_transform(struct Object *obj);

🔼

cur_obj_move_using_vel

Description

Moves the current object using its velocity vector

Lua Example

cur_obj_move_using_vel()

Parameters

None

Returns

None

C Prototype

void cur_obj_move_using_vel(void);

🔼

obj_copy_graph_y_offset

Description

Copies the graph Y offset from one object to another

Lua Example

obj_copy_graph_y_offset(dst, src)

Parameters

Field	Type
dst	Object
src	Object

Returns

None

C Prototype

void obj_copy_graph_y_offset(struct Object *dst, struct Object *src);

🔼

obj_copy_pos_and_angle

Description

Copies both position and angles from one object to another

Lua Example

obj_copy_pos_and_angle(dst, src)

Parameters

Field	Type
dst	Object
src	Object

Returns

None

C Prototype

void obj_copy_pos_and_angle(struct Object *dst, struct Object *src);

🔼

obj_copy_pos

Description

Copies position from one object to another

Lua Example

obj_copy_pos(dst, src)

Parameters

Field	Type
dst	Object
src	Object

Returns

None

C Prototype

void obj_copy_pos(struct Object *dst, struct Object *src);

🔼

obj_copy_angle

Description

Copies move and face angles from one object to another

Lua Example

obj_copy_angle(dst, src)

Parameters

Field	Type
dst	Object
src	Object

Returns

None

C Prototype

void obj_copy_angle(struct Object *dst, struct Object *src);

🔼

obj_set_gfx_pos_from_pos

Description

Synchronizes an object's graphics position with its physical position

Lua Example

obj_set_gfx_pos_from_pos(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_set_gfx_pos_from_pos(struct Object *obj);

🔼

obj_init_animation

Description

Initializes an animation for an object by index

Lua Example

obj_init_animation(obj, animIndex)

Parameters

Field	Type
obj	Object
animIndex	`integer`

Returns

None

C Prototype

void obj_init_animation(struct Object *obj, s32 animIndex);

🔼

linear_mtxf_mul_vec3f

Description

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

linear_mtxf_mul_vec3f(m, dst, v)

Parameters

Field	Type
m	Mat4
dst	Vec3f
v	Vec3f

Returns

None

C Prototype

void linear_mtxf_mul_vec3f(Mat4 m, VEC_OUT Vec3f dst, Vec3f v);

🔼

linear_mtxf_transpose_mul_vec3f

Description

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

linear_mtxf_transpose_mul_vec3f(m, dst, v)

Parameters

Field	Type
m	Mat4
dst	Vec3f
v	Vec3f

Returns

None

C Prototype

void linear_mtxf_transpose_mul_vec3f(Mat4 m, VEC_OUT Vec3f dst, Vec3f v);

🔼

obj_apply_scale_to_transform

Description

Applies an object's scale to its transformation matrix

Lua Example

obj_apply_scale_to_transform(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_apply_scale_to_transform(struct Object *obj);

🔼

obj_copy_scale

Description

Copies the scale from one object to another

Lua Example

obj_copy_scale(dst, src)

Parameters

Field	Type
dst	Object
src	Object

Returns

None

C Prototype

void obj_copy_scale(struct Object *dst, struct Object *src);

🔼

obj_scale_xyz

Description

Sets an object's scale independently for X, Y, Z dimensions

Lua Example

obj_scale_xyz(obj, xScale, yScale, zScale)

Parameters

Field	Type
obj	Object
xScale	`number`
yScale	`number`
zScale	`number`

Returns

None

C Prototype

void obj_scale_xyz(struct Object *obj, f32 xScale, f32 yScale, f32 zScale);

🔼

obj_scale

Description

Sets an object's uniform scale for all dimensions

Lua Example

obj_scale(obj, scale)

Parameters

Field	Type
obj	Object
scale	`number`

Returns

None

C Prototype

void obj_scale(struct Object *obj, f32 scale);

🔼

Field	Type
scale	`number`

cur_obj_init_animation

Description

Initializes an animation for the current object by index

Lua Example

cur_obj_init_animation(animIndex)

Parameters

Field	Type
animIndex	`integer`

Returns

None

C Prototype

void cur_obj_init_animation(s32 animIndex);

🔼

cur_obj_init_animation_with_sound

Description

Initializes an animation for the current object and sets sound state

Lua Example

cur_obj_init_animation_with_sound(animIndex)

Parameters

Field	Type
animIndex	`integer`

Returns

None

C Prototype

void cur_obj_init_animation_with_sound(s32 animIndex);

🔼

obj_init_animation_with_accel_and_sound

Description

Initializes an animation with acceleration and sound state for an object

Lua Example

obj_init_animation_with_accel_and_sound(obj, animIndex, accel)

Parameters

Field	Type
obj	Object
animIndex	`integer`
accel	`number`

Returns

None

C Prototype

void obj_init_animation_with_accel_and_sound(struct Object *obj, s32 animIndex, f32 accel);

🔼

cur_obj_init_animation_with_accel_and_sound

Description

Initializes an animation with acceleration and sound state for the current object

Lua Example

cur_obj_init_animation_with_accel_and_sound(animIndex, accel)

Parameters

Field	Type
animIndex	`integer`
accel	`number`

Returns

None

C Prototype

void cur_obj_init_animation_with_accel_and_sound(s32 animIndex, f32 accel);

🔼

cur_obj_enable_rendering_and_become_tangible

Description

Enables rendering and tangibility for an object

Lua Example

cur_obj_enable_rendering_and_become_tangible(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void cur_obj_enable_rendering_and_become_tangible(struct Object *obj);

🔼

cur_obj_enable_rendering

Description

Enables rendering for the current object

Lua Example

cur_obj_enable_rendering()

Parameters

None

Returns

None

C Prototype

void cur_obj_enable_rendering(void);

🔼

cur_obj_disable_rendering_and_become_intangible

Description

Disables rendering and makes an object intangible

Lua Example

cur_obj_disable_rendering_and_become_intangible(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void cur_obj_disable_rendering_and_become_intangible(struct Object *obj);

🔼

cur_obj_disable_rendering

Description

Disables rendering for the current object

Lua Example

cur_obj_disable_rendering()

Parameters

None

Returns

None

C Prototype

void cur_obj_disable_rendering(void);

🔼

cur_obj_unhide

Description

Makes the current object visible by removing the invisible flag

Lua Example

cur_obj_unhide()

Parameters

None

Returns

None

C Prototype

void cur_obj_unhide(void);

🔼

cur_obj_hide

Description

Hides the current object by setting the invisible flag

Lua Example

cur_obj_hide()

Parameters

None

Returns

None

C Prototype

void cur_obj_hide(void);

🔼

cur_obj_set_pos_relative

Description

Sets the current object's position relative to another object's facing direction

Lua Example

cur_obj_set_pos_relative(other, dleft, dy, dforward)

Parameters

Field	Type
other	Object
dleft	`number`
dy	`number`
dforward	`number`

Returns

None

C Prototype

void cur_obj_set_pos_relative(struct Object *other, f32 dleft, f32 dy, f32 dforward);

🔼

cur_obj_set_pos_relative_to_parent

Description

Sets the current object's position relative to its parent's facing direction

Lua Example

cur_obj_set_pos_relative_to_parent(dleft, dy, dforward)

Parameters

Field	Type
dleft	`number`
dy	`number`
dforward	`number`

Returns

None

C Prototype

void cur_obj_set_pos_relative_to_parent(f32 dleft, f32 dy, f32 dforward);

🔼

cur_obj_enable_rendering_2

Description

Alternative function that enables rendering for the current object

Lua Example

cur_obj_enable_rendering_2()

Parameters

None

Returns

None

C Prototype

void cur_obj_enable_rendering_2(void);

🔼

cur_obj_unused_init_on_floor

Description

Unused function that initializes the current object on the floor

Lua Example

cur_obj_unused_init_on_floor()

Parameters

None

Returns

None

C Prototype

void cur_obj_unused_init_on_floor(void);

🔼

obj_set_face_angle_to_move_angle

Description

Synchronizes an object's face angle with its move angle

Lua Example

obj_set_face_angle_to_move_angle(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_set_face_angle_to_move_angle(struct Object *obj);

🔼

get_object_list_from_behavior

Description

Retrieves the object list type that a behavior script belongs to

Lua Example

local integerValue = get_object_list_from_behavior(behavior)

Parameters

Field	Type
behavior	`Pointer` <`BehaviorScript`>

Returns

integer

C Prototype

u32 get_object_list_from_behavior(const BehaviorScript *behavior);

🔼

cur_obj_nearest_object_with_behavior

Description

Finds the nearest object with the specified behavior to the current object

Lua Example

local objectValue = cur_obj_nearest_object_with_behavior(behavior)

Parameters

Field	Type
behavior	`Pointer` <`BehaviorScript`>

Returns

Object

C Prototype

struct Object *cur_obj_nearest_object_with_behavior(const BehaviorScript *behavior);

🔼

cur_obj_dist_to_nearest_object_with_behavior

Description

Calculates the distance from the current object to the nearest object with specified behavior

Lua Example

local numberValue = cur_obj_dist_to_nearest_object_with_behavior(behavior)

Parameters

Field	Type
behavior	`Pointer` <`BehaviorScript`>

Returns

number

C Prototype

f32 cur_obj_dist_to_nearest_object_with_behavior(const BehaviorScript *behavior);

🔼

cur_obj_find_nearest_pole

Description

Finds the nearest pole-like object to the current object

Lua Example

local objectValue = cur_obj_find_nearest_pole()

Parameters

None

Returns

Object

C Prototype

struct Object* cur_obj_find_nearest_pole(void);

🔼

cur_obj_find_nearest_object_with_behavior

Description

Finds the nearest object with specified behavior and returns distance via pointer

Lua Example

local objectValue, dist = cur_obj_find_nearest_object_with_behavior(behavior)

Parameters

Field	Type
behavior	`Pointer` <`BehaviorScript`>

Returns

Object
number

C Prototype

struct Object *cur_obj_find_nearest_object_with_behavior(const BehaviorScript *behavior, RET f32 *dist);

🔼

cur_obj_count_objects_with_behavior

Description

Counts objects with specified behavior within distance of current object

Lua Example

local integerValue = cur_obj_count_objects_with_behavior(behavior, dist)

Parameters

Field	Type
behavior	`Pointer` <`BehaviorScript`>
dist	`number`

Returns

integer

C Prototype

u16 cur_obj_count_objects_with_behavior(const BehaviorScript* behavior, f32 dist);

🔼

find_unimportant_object

Description

Finds an unimportant object from the unimportant object list

Lua Example

local objectValue = find_unimportant_object()

Parameters

None

Returns

Object

C Prototype

struct Object *find_unimportant_object(void);

🔼

count_unimportant_objects

Description

Counts the number of unimportant objects in the unimportant object list

Lua Example

local integerValue = count_unimportant_objects()

Parameters

None

Returns

integer

C Prototype

s32 count_unimportant_objects(void);

🔼

count_objects_with_behavior

Description

Counts the number of objects with the specified behavior

Lua Example

local integerValue = count_objects_with_behavior(behavior)

Parameters

Field	Type
behavior	`Pointer` <`BehaviorScript`>

Returns

integer

C Prototype

s32 count_objects_with_behavior(const BehaviorScript *behavior);

🔼

find_object_with_behavior

Description

Finds any object with the specified behavior

Lua Example

local objectValue = find_object_with_behavior(behavior)

Parameters

Field	Type
behavior	`Pointer` <`BehaviorScript`>

Returns

Object

C Prototype

struct Object *find_object_with_behavior(const BehaviorScript *behavior);

🔼

cur_obj_find_nearby_held_actor

Description

Finds an object with specified behavior within maxDist that is being held by a player

Lua Example

local objectValue = cur_obj_find_nearby_held_actor(behavior, maxDist)

Parameters

Field	Type
behavior	`Pointer` <`BehaviorScript`>
maxDist	`number`

Returns

Object

C Prototype

struct Object *cur_obj_find_nearby_held_actor(const BehaviorScript *behavior, f32 maxDist);

🔼

cur_obj_reset_timer_and_subaction

Description

Resets the current object's timer and sub-action to 0

Lua Example

cur_obj_reset_timer_and_subaction()

Parameters

None

Returns

None

C Prototype

void cur_obj_reset_timer_and_subaction(void);

🔼

cur_obj_change_action

Description

Changes the current object's action and resets timer and subaction

Lua Example

cur_obj_change_action(action)

Parameters

Field	Type
action	`integer`

Returns

None

C Prototype

void cur_obj_change_action(s32 action);

🔼

cur_obj_set_vel_from_mario_vel

Description

Sets the current object's forward velocity based on Mario's velocity with scaling

Lua Example

cur_obj_set_vel_from_mario_vel(m, f12, f14)

Parameters

Field	Type
m	MarioState
f12	`number`
f14	`number`

Returns

None

C Prototype

void cur_obj_set_vel_from_mario_vel(struct MarioState* m, f32 f12, f32 f14);

🔼

cur_obj_reverse_animation

Description

Decreases the current object's animation frame by one

Lua Example

cur_obj_reverse_animation()

Parameters

None

Returns

None

C Prototype

void cur_obj_reverse_animation(void);

🔼

cur_obj_extend_animation_if_at_end

Description

Extends the current object's animation frame if at loop end

Lua Example

cur_obj_extend_animation_if_at_end()

Parameters

None

Returns

None

C Prototype

void cur_obj_extend_animation_if_at_end(void);

🔼

cur_obj_check_if_near_animation_end

Description

Checks if the current object's animation is near the end

Lua Example

local integerValue = cur_obj_check_if_near_animation_end()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_check_if_near_animation_end(void);

🔼

cur_obj_check_if_at_animation_end

Description

Checks if the current object's animation is at the end

Lua Example

local integerValue = cur_obj_check_if_at_animation_end()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_check_if_at_animation_end(void);

🔼

cur_obj_check_anim_frame

Description

Checks if the current object's animation is at a specific frame

Lua Example

local integerValue = cur_obj_check_anim_frame(frame)

Parameters

Field	Type
frame	`integer`

Returns

integer

C Prototype

s32 cur_obj_check_anim_frame(s32 frame);

🔼

cur_obj_check_anim_frame_in_range

Description

Checks if the current object's animation frame is within a range

Lua Example

local integerValue = cur_obj_check_anim_frame_in_range(startFrame, rangeLength)

Parameters

Field	Type
startFrame	`integer`
rangeLength	`integer`

Returns

integer

C Prototype

s32 cur_obj_check_anim_frame_in_range(s32 startFrame, s32 rangeLength);

🔼

mario_is_in_air_action

Description

Checks if Mario is in an air action

Lua Example

local integerValue = mario_is_in_air_action(m)

Parameters

Field	Type
m	MarioState

Returns

integer

C Prototype

s32 mario_is_in_air_action(struct MarioState* m);

🔼

mario_is_dive_sliding

Description

Checks if Mario is performing a dive slide action

Lua Example

local integerValue = mario_is_dive_sliding(m)

Parameters

Field	Type
m	MarioState

Returns

integer

C Prototype

s32 mario_is_dive_sliding(struct MarioState* m);

🔼

cur_obj_set_y_vel_and_animation

Description

Sets the current object's vertical velocity and initializes an animation

Lua Example

cur_obj_set_y_vel_and_animation(sp18, sp1C)

Parameters

Field	Type
sp18	`number`
sp1C	`integer`

Returns

None

C Prototype

void cur_obj_set_y_vel_and_animation(f32 sp18, s32 sp1C);

🔼

cur_obj_unrender_and_reset_state

Description

Disables rendering, makes intangible, and resets action and animation

Lua Example

cur_obj_unrender_and_reset_state(sp18, sp1C)

Parameters

Field	Type
sp18	`integer`
sp1C	`integer`

Returns

None

C Prototype

void cur_obj_unrender_and_reset_state(s32 sp18, s32 sp1C);

🔼

cur_obj_move_after_thrown_or_dropped

Description

Moves an object after being thrown or dropped with gravity applied

Lua Example

cur_obj_move_after_thrown_or_dropped(forwardVel, velY)

Parameters

Field	Type
forwardVel	`number`
velY	`number`

Returns

None

C Prototype

void cur_obj_move_after_thrown_or_dropped(f32 forwardVel, f32 velY);

🔼

cur_obj_get_thrown_or_placed

Description

Handles object state when it's been thrown or placed by a player

Lua Example

cur_obj_get_thrown_or_placed(forwardVel, velY, thrownAction)

Parameters

Field	Type
forwardVel	`number`
velY	`number`
thrownAction	`integer`

Returns

None

C Prototype

void cur_obj_get_thrown_or_placed(f32 forwardVel, f32 velY, s32 thrownAction);

🔼

cur_obj_get_dropped

Description

Handles object state when it's been dropped by a player

Lua Example

cur_obj_get_dropped()

Parameters

None

Returns

None

C Prototype

void cur_obj_get_dropped(void);

🔼

cur_obj_clear_interact_status_flag

Description

Clears a flag from the current object's interaction status

Lua Example

local integerValue = cur_obj_clear_interact_status_flag(flag)

Parameters

Field	Type
flag	`integer`

Returns

integer

C Prototype

s32 cur_obj_clear_interact_status_flag(s32 flag);

🔼

obj_mark_for_deletion

Description

Marks an object to be unloaded at the end of the frame

Lua Example

obj_mark_for_deletion(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_mark_for_deletion(struct Object *obj);

🔼

cur_obj_disable

Description

Disables the current object by hiding, disabling rendering, and making intangible

Lua Example

cur_obj_disable()

Parameters

None

Returns

None

C Prototype

void cur_obj_disable(void);

🔼

cur_obj_become_intangible

Description

Makes the current object intangible

Lua Example

cur_obj_become_intangible()

Parameters

None

Returns

None

C Prototype

void cur_obj_become_intangible(void);

🔼

cur_obj_become_tangible

Description

Makes the current object tangible

Lua Example

cur_obj_become_tangible()

Parameters

None

Returns

None

C Prototype

void cur_obj_become_tangible(void);

🔼

obj_become_tangible

Description

Makes an object tangible

Lua Example

obj_become_tangible(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_become_tangible(struct Object *obj);

🔼

cur_obj_update_floor_height

Description

Updates the current object's floor height based on its position

Lua Example

cur_obj_update_floor_height()

Parameters

None

Returns

None

C Prototype

void cur_obj_update_floor_height(void);

🔼

cur_obj_update_floor_height_and_get_floor

Description

Updates the current object's floor height and returns the floor surface under it

Lua Example

local surfaceValue = cur_obj_update_floor_height_and_get_floor()

Parameters

None

Returns

Surface

C Prototype

struct Surface *cur_obj_update_floor_height_and_get_floor(void);

🔼

apply_drag_to_value

Description

Applies nonlinear drag to a value pointer based on drag strength

Lua Example

local value = apply_drag_to_value(value, dragStrength)

Parameters

Field	Type
value	`number`
dragStrength	`number`

Returns

number

C Prototype

void apply_drag_to_value(INOUT f32 *value, f32 dragStrength);

🔼

cur_obj_apply_drag_xz

Description

Applies drag to the current object's horizontal velocity components

Lua Example

cur_obj_apply_drag_xz(dragStrength)

Parameters

Field	Type
dragStrength	`number`

Returns

None

C Prototype

void cur_obj_apply_drag_xz(f32 dragStrength);

🔼

cur_obj_move_xz

Description

Attempts to move the current object in XZ, handling floor slope, edges, and room boundaries

Lua Example

local integerValue = cur_obj_move_xz(steepSlopeNormalY, careAboutEdgesAndSteepSlopes)

Parameters

Field	Type
steepSlopeNormalY	`number`
careAboutEdgesAndSteepSlopes	`integer`

Returns

integer

C Prototype

s32 cur_obj_move_xz(f32 steepSlopeNormalY, s32 careAboutEdgesAndSteepSlopes);

🔼

cur_obj_move_update_underwater_flags

Description

Updates underwater movement flags and vertical damping while submerged

Lua Example

cur_obj_move_update_underwater_flags()

Parameters

None

Returns

None

C Prototype

void cur_obj_move_update_underwater_flags(void);

🔼

cur_obj_move_update_ground_air_flags

Description

Updates ground and air movement flags after a vertical move

Lua Example

cur_obj_move_update_ground_air_flags(gravity, bounciness)

Parameters

Field	Type
gravity	`number`
bounciness	`number`

Returns

None

C Prototype

void cur_obj_move_update_ground_air_flags(UNUSED f32 gravity, f32 bounciness);

🔼

cur_obj_move_y_and_get_water_level

Description

Applies gravity and buoyancy to vertical velocity and returns the water level at the current XZ position

Lua Example

local numberValue = cur_obj_move_y_and_get_water_level(gravity, buoyancy)

Parameters

Field	Type
gravity	`number`
buoyancy	`number`

Returns

number

C Prototype

f32 cur_obj_move_y_and_get_water_level(f32 gravity, f32 buoyancy);

🔼

cur_obj_move_y

Description

Moves the current object vertically while handling ground, water surface, and underwater states

Lua Example

cur_obj_move_y(gravity, bounciness, buoyancy)

Parameters

Field	Type
gravity	`number`
bounciness	`number`
buoyancy	`number`

Returns

None

C Prototype

void cur_obj_move_y(f32 gravity, f32 bounciness, f32 buoyancy);

🔼

cur_obj_unused_resolve_wall_collisions

Description

Performs a wall collision sweep for the current object if the radius is positive

Lua Example

cur_obj_unused_resolve_wall_collisions(offsetY, radius)

Parameters

Field	Type
offsetY	`number`
radius	`number`

Returns

None

C Prototype

void cur_obj_unused_resolve_wall_collisions(f32 offsetY, f32 radius);

🔼

abs_angle_diff

Description

Returns the absolute difference between two 16-bit angles

Lua Example

local integerValue = abs_angle_diff(x0, x1)

Parameters

Field	Type
x0	`integer`
x1	`integer`

Returns

integer

C Prototype

s16 abs_angle_diff(s16 x0, s16 x1);

🔼

cur_obj_move_xz_using_fvel_and_yaw

Description

Sets the current object's horizontal velocity from forward speed and yaw, then moves it in XZ

Lua Example

cur_obj_move_xz_using_fvel_and_yaw()

Parameters

None

Returns

None

C Prototype

void cur_obj_move_xz_using_fvel_and_yaw(void);

🔼

cur_obj_move_y_with_terminal_vel

Description

Moves the current object vertically and caps downward speed at terminal velocity

Lua Example

cur_obj_move_y_with_terminal_vel()

Parameters

None

Returns

None

C Prototype

void cur_obj_move_y_with_terminal_vel(void);

🔼

cur_obj_compute_vel_xz

Description

Computes the current object's horizontal velocity from forward speed and yaw

Lua Example

cur_obj_compute_vel_xz()

Parameters

None

Returns

None

C Prototype

void cur_obj_compute_vel_xz(void);

🔼

increment_velocity_toward_range

Description

Returns a signed velocity increment that moves a value toward a target range around center

Lua Example

local numberValue = increment_velocity_toward_range(value, center, zeroThreshold, increment)

Parameters

Field	Type
value	`number`
center	`number`
zeroThreshold	`number`
increment	`number`

Returns

number

C Prototype

f32 increment_velocity_toward_range(f32 value, f32 center, f32 zeroThreshold, f32 increment);

🔼

obj_check_if_collided_with_object

Description

Checks whether obj1's collided object list contains obj2

Lua Example

local integerValue = obj_check_if_collided_with_object(obj1, obj2)

Parameters

Field	Type
obj1	Object
obj2	Object

Returns

integer

C Prototype

s32 obj_check_if_collided_with_object(struct Object *obj1, struct Object *obj2);

🔼

cur_obj_set_behavior

Description

Sets the current object's behavior script

Lua Example

cur_obj_set_behavior(behavior)

Parameters

Field	Type
behavior	`Pointer` <`BehaviorScript`>

Returns

None

C Prototype

void cur_obj_set_behavior(const BehaviorScript *behavior);

🔼

obj_set_behavior

Description

Sets the specified object's behavior script

Lua Example

obj_set_behavior(obj, behavior)

Parameters

Field	Type
obj	Object
behavior	`Pointer` <`BehaviorScript`>

Returns

None

C Prototype

void obj_set_behavior(struct Object *obj, const BehaviorScript *behavior);

🔼

cur_obj_has_behavior

Description

Checks whether the current object has the specified behavior

Lua Example

local integerValue = cur_obj_has_behavior(behavior)

Parameters

Field	Type
behavior	`Pointer` <`BehaviorScript`>

Returns

integer

C Prototype

s32 cur_obj_has_behavior(const BehaviorScript *behavior);

🔼

obj_has_behavior

Description

Checks whether an object has the specified behavior

Lua Example

local integerValue = obj_has_behavior(obj, behavior)

Parameters

Field	Type
obj	Object
behavior	`Pointer` <`BehaviorScript`>

Returns

integer

C Prototype

s32 obj_has_behavior(struct Object *obj, const BehaviorScript *behavior);

🔼

cur_obj_lateral_dist_from_obj_to_home

Description

Calculates the lateral distance from another object to the current object's home position

Lua Example

local numberValue = cur_obj_lateral_dist_from_obj_to_home(obj)

Parameters

Field	Type
obj	Object

Returns

number

C Prototype

f32 cur_obj_lateral_dist_from_obj_to_home(struct Object *obj);

🔼

cur_obj_lateral_dist_from_mario_to_home

Description

Calculates Mario's lateral distance to the current object's home position

Lua Example

local numberValue = cur_obj_lateral_dist_from_mario_to_home()

Parameters

None

Returns

number

C Prototype

f32 cur_obj_lateral_dist_from_mario_to_home(void);

🔼

cur_obj_lateral_dist_to_home

Description

Calculates the current object's lateral distance to its home position

Lua Example

local numberValue = cur_obj_lateral_dist_to_home()

Parameters

None

Returns

number

C Prototype

f32 cur_obj_lateral_dist_to_home(void);

🔼

cur_obj_outside_home_square

Description

Checks whether the current object is outside a square centered on its home position

Lua Example

local integerValue = cur_obj_outside_home_square(halfLength)

Parameters

Field	Type
halfLength	`number`

Returns

integer

C Prototype

s32 cur_obj_outside_home_square(f32 halfLength);

🔼

cur_obj_outside_home_rectangle

Description

Checks whether the current object is outside a rectangle centered on its home position

Lua Example

local integerValue = cur_obj_outside_home_rectangle(minX, maxX, minZ, maxZ)

Parameters

Field	Type
minX	`number`
maxX	`number`
minZ	`number`
maxZ	`number`

Returns

integer

C Prototype

s32 cur_obj_outside_home_rectangle(f32 minX, f32 maxX, f32 minZ, f32 maxZ);

🔼

cur_obj_set_pos_to_home

Description

Teleports the current object to its home position

Lua Example

cur_obj_set_pos_to_home()

Parameters

None

Returns

None

C Prototype

void cur_obj_set_pos_to_home(void);

🔼

cur_obj_set_pos_to_home_and_stop

Description

Teleports the current object to its home position and stops its motion

Lua Example

cur_obj_set_pos_to_home_and_stop()

Parameters

None

Returns

None

C Prototype

void cur_obj_set_pos_to_home_and_stop(void);

🔼

cur_obj_start_cam_event

Description

Starts a camera event and makes the current object the secondary camera focus

Lua Example

cur_obj_start_cam_event(obj, cameraEvent)

Parameters

Field	Type
obj	Object
cameraEvent	`integer`

Returns

None

C Prototype

void cur_obj_start_cam_event(UNUSED struct Object *obj, s32 cameraEvent);

🔼

set_mario_interact_hoot_if_in_range

Description

Sets Mario's interact status to hoot-grabbed if Mario is within range

Lua Example

set_mario_interact_hoot_if_in_range(sp0, sp4, sp8)

Parameters

Field	Type
sp0	`integer`
sp4	`integer`
sp8	`number`

Returns

None

C Prototype

void set_mario_interact_hoot_if_in_range(UNUSED s32 sp0, UNUSED s32 sp4, f32 sp8);

🔼

obj_set_billboard

Description

Enables billboard rendering for an object

Lua Example

obj_set_billboard(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_set_billboard(struct Object *obj);

🔼

obj_set_cylboard

Description

Enables cylindrical billboard rendering for an object

Lua Example

obj_set_cylboard(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_set_cylboard(struct Object *obj);

🔼

cur_obj_set_billboard_if_vanilla_cam

Description

Chooses the appropriate billboard type for the current object based on camera mode

Lua Example

cur_obj_set_billboard_if_vanilla_cam()

Parameters

None

Returns

None

C Prototype

void cur_obj_set_billboard_if_vanilla_cam(void);

🔼

obj_set_hitbox_radius_and_height

Description

Sets an object's hitbox radius and height

Lua Example

obj_set_hitbox_radius_and_height(obj, radius, height)

Parameters

Field	Type
obj	Object
radius	`number`
height	`number`

Returns

None

C Prototype

void obj_set_hitbox_radius_and_height(struct Object *obj, f32 radius, f32 height);

🔼

obj_set_hurtbox_radius_and_height

Description

Sets an object's hurtbox radius and height

Lua Example

obj_set_hurtbox_radius_and_height(obj, radius, height)

Parameters

Field	Type
obj	Object
radius	`number`
height	`number`

Returns

None

C Prototype

void obj_set_hurtbox_radius_and_height(struct Object *obj, f32 radius, f32 height);

🔼

cur_obj_set_hitbox_radius_and_height

Description

Sets the current object's hitbox radius and height

Lua Example

cur_obj_set_hitbox_radius_and_height(radius, height)

Parameters

Field	Type
radius	`number`
height	`number`

Returns

None

C Prototype

void cur_obj_set_hitbox_radius_and_height(f32 radius, f32 height);

🔼

cur_obj_set_hurtbox_radius_and_height

Description

Sets the current object's hurtbox radius and height

Lua Example

cur_obj_set_hurtbox_radius_and_height(radius, height)

Parameters

Field	Type
radius	`number`
height	`number`

Returns

None

C Prototype

void cur_obj_set_hurtbox_radius_and_height(f32 radius, f32 height);

🔼

obj_spawn_loot_coins

Description

Spawns loot coins from an object using the specified behavior, jitter, and model

Lua Example

obj_spawn_loot_coins(obj, numCoins, sp30, coinBehavior, posJitter, model)

Parameters

Field	Type
obj	Object
numCoins	`integer`
sp30	`number`
coinBehavior	`Pointer` <`BehaviorScript`>
posJitter	`integer`
model	`integer`

Returns

None

C Prototype

void obj_spawn_loot_coins(struct Object *obj, s32 numCoins, f32 sp30, const BehaviorScript *coinBehavior, s16 posJitter, s16 model);

🔼

obj_spawn_loot_blue_coins

Description

Spawns blue loot coins from an object

Lua Example

obj_spawn_loot_blue_coins(obj, numCoins, sp28, posJitter)

Parameters

Field	Type
obj	Object
numCoins	`integer`
sp28	`number`
posJitter	`integer`

Returns

None

C Prototype

void obj_spawn_loot_blue_coins(struct Object *obj, s32 numCoins, f32 sp28, s16 posJitter);

🔼

obj_spawn_loot_yellow_coins

Description

Spawns yellow loot coins from an object

Lua Example

obj_spawn_loot_yellow_coins(obj, numCoins, sp28)

Parameters

Field	Type
obj	Object
numCoins	`integer`
sp28	`number`

Returns

None

C Prototype

void obj_spawn_loot_yellow_coins(struct Object *obj, s32 numCoins, f32 sp28);

🔼

cur_obj_spawn_loot_coin_at_mario_pos

Description

Spawns a yellow coin at Mario's position and decrements the current object's loot count

Lua Example

cur_obj_spawn_loot_coin_at_mario_pos(m)

Parameters

Field	Type
m	MarioState

Returns

None

C Prototype

void cur_obj_spawn_loot_coin_at_mario_pos(struct MarioState* m);

🔼

cur_obj_abs_y_dist_to_home

Description

Returns the absolute vertical distance from the object to its home position

Lua Example

local numberValue = cur_obj_abs_y_dist_to_home()

Parameters

None

Returns

number

C Prototype

f32 cur_obj_abs_y_dist_to_home(void);

🔼

cur_obj_advance_looping_anim

Description

Advances the current object animation frame and returns the normalized frame progress

Lua Example

local integerValue = cur_obj_advance_looping_anim()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_advance_looping_anim(void);

🔼

cur_obj_detect_steep_floor

Description

Checks whether the object is moving into a steep floor or death plane and returns a collision code

Lua Example

local integerValue = cur_obj_detect_steep_floor(steepAngleDegrees)

Parameters

Field	Type
steepAngleDegrees	`integer`

Returns

integer

C Prototype

s32 cur_obj_detect_steep_floor(s16 steepAngleDegrees);

🔼

cur_obj_resolve_wall_collisions

Description

Resolves wall collisions for the current object and returns TRUE if it hit a steep wall

Lua Example

local integerValue = cur_obj_resolve_wall_collisions()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_resolve_wall_collisions(void);

🔼

cur_obj_update_floor

Description

Updates the current object's floor pointer, floor type, and floor room based on the surface below it

Lua Example

cur_obj_update_floor()

Parameters

None

Returns

None

C Prototype

void cur_obj_update_floor(void);

🔼

cur_obj_update_floor_and_resolve_wall_collisions

Description

Updates the floor and resolves walls for the current object, setting move flags accordingly

Lua Example

cur_obj_update_floor_and_resolve_wall_collisions(steepSlopeDegrees)

Parameters

Field	Type
steepSlopeDegrees	`integer`

Returns

None

C Prototype

void cur_obj_update_floor_and_resolve_wall_collisions(s16 steepSlopeDegrees);

🔼

cur_obj_update_floor_and_walls

Description

Updates the current object floor and wall state using a default steep slope threshold

Lua Example

cur_obj_update_floor_and_walls()

Parameters

None

Returns

None

C Prototype

void cur_obj_update_floor_and_walls(void);

🔼

cur_obj_move_standard

Description

Updates the current object velocity and position using standard gravity, drag, and slope behavior

Lua Example

cur_obj_move_standard(steepSlopeAngleDegrees)

Parameters

Field	Type
steepSlopeAngleDegrees	`integer`

Returns

None

C Prototype

void cur_obj_move_standard(s16 steepSlopeAngleDegrees);

🔼

cur_obj_within_12k_bounds

Description

Checks whether the current object is within a 12,000-unit world bound on all axes

Lua Example

local integerValue = cur_obj_within_12k_bounds()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_within_12k_bounds(void);

🔼

cur_obj_move_using_vel_and_gravity

Description

Applies object velocity and gravity directly to the object's position with no terminal velocity

Lua Example

cur_obj_move_using_vel_and_gravity()

Parameters

None

Returns

None

C Prototype

void cur_obj_move_using_vel_and_gravity(void);

🔼

cur_obj_move_using_fvel_and_gravity

Description

Computes the object's XZ velocity from forward velocity then applies gravity-based movement

Lua Example

cur_obj_move_using_fvel_and_gravity()

Parameters

None

Returns

None

C Prototype

void cur_obj_move_using_fvel_and_gravity(void);

🔼

obj_set_pos_relative

Description

Sets an object position relative to another object using local left, up, and forward offsets

Lua Example

obj_set_pos_relative(obj, other, dleft, dy, dforward)

Parameters

Field	Type
obj	Object
other	Object
dleft	`number`
dy	`number`
dforward	`number`

Returns

None

C Prototype

void obj_set_pos_relative(struct Object *obj, struct Object *other, f32 dleft, f32 dy, f32 dforward);

🔼

cur_obj_angle_to_home

Description

Returns the yaw angle from the current object toward its home position

Lua Example

local integerValue = cur_obj_angle_to_home()

Parameters

None

Returns

integer

C Prototype

s16 cur_obj_angle_to_home(void);

🔼

obj_set_gfx_pos_at_obj_pos

Description

Copies an object's world position and orientation into another object's graphics node

Lua Example

obj_set_gfx_pos_at_obj_pos(obj1, obj2)

Parameters

Field	Type
obj1	Object
obj2	Object

Returns

None

C Prototype

void obj_set_gfx_pos_at_obj_pos(struct Object *obj1, struct Object *obj2);

🔼

obj_translate_local

Description

Transforms the vector at localTranslateIndex into the object's local coordinates, and then adds it to the vector at posIndex

Lua Example

obj_translate_local(obj, posIndex, localTranslateIndex)

Parameters

Field	Type
obj	Object
posIndex	`integer`
localTranslateIndex	`integer`

Returns

None

C Prototype

void obj_translate_local(struct Object *obj, s16 posIndex, s16 localTranslateIndex);

🔼

obj_build_transform_from_pos_and_angle

Description

Copies an object's position and rotation into its transform matrix using the specified field indices

Lua Example

obj_build_transform_from_pos_and_angle(obj, posIndex, angleIndex)

Parameters

Field	Type
obj	Object
posIndex	`integer`
angleIndex	`integer`

Returns

None

C Prototype

void obj_build_transform_from_pos_and_angle(struct Object *obj, s16 posIndex, s16 angleIndex);

🔼

obj_set_throw_matrix_from_transform

Description

Sets the object's graphics throw matrix from its transform and applies object scale if needed

Lua Example

obj_set_throw_matrix_from_transform(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_set_throw_matrix_from_transform(struct Object *obj);

🔼

obj_build_transform_relative_to_parent

Description

Builds the object's world transform relative to its parent and updates its world position

Lua Example

obj_build_transform_relative_to_parent(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_build_transform_relative_to_parent(struct Object *obj);

🔼

obj_create_transform_from_self

Description

Initializes the object's own transform matrix from its current world position

Lua Example

obj_create_transform_from_self(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_create_transform_from_self(struct Object *obj);

🔼

cur_obj_rotate_move_angle_using_vel

Description

Rotates the current object's move angles by its angular velocity components

Lua Example

cur_obj_rotate_move_angle_using_vel()

Parameters

None

Returns

None

C Prototype

void cur_obj_rotate_move_angle_using_vel(void);

🔼

cur_obj_rotate_face_angle_using_vel

Description

Rotates the current object's face angles by its angular velocity components

Lua Example

cur_obj_rotate_face_angle_using_vel()

Parameters

None

Returns

None

C Prototype

void cur_obj_rotate_face_angle_using_vel(void);

🔼

cur_obj_set_face_angle_to_move_angle

Description

Copies the current object's move angles into its face angles

Lua Example

cur_obj_set_face_angle_to_move_angle()

Parameters

None

Returns

None

C Prototype

void cur_obj_set_face_angle_to_move_angle(void);

🔼

cur_obj_follow_path

Description

Advances path-following state and returns whether a waypoint or path end was reached

Lua Example

local integerValue = cur_obj_follow_path(unusedArg)

Parameters

Field	Type
unusedArg	`integer`

Returns

integer

C Prototype

s32 cur_obj_follow_path(UNUSED s32 unusedArg);

🔼

chain_segment_init

Description

Initializes a chain segment's position and orientation to identity values

Lua Example

chain_segment_init(segment)

Parameters

Field	Type
segment	ChainSegment

Returns

None

C Prototype

void chain_segment_init(struct ChainSegment *segment);

🔼

random_f32_around_zero

Description

Returns a random floating-point value within +/- diameter/2

Lua Example

local numberValue = random_f32_around_zero(diameter)

Parameters

Field	Type
diameter	`number`

Returns

number

C Prototype

f32 random_f32_around_zero(f32 diameter);

🔼

obj_scale_random

Description

Randomly scales an object within a range and applies a minimum scale

Lua Example

obj_scale_random(obj, rangeLength, minScale)

Parameters

Field	Type
obj	Object
rangeLength	`number`
minScale	`number`

Returns

None

C Prototype

void obj_scale_random(struct Object *obj, f32 rangeLength, f32 minScale);

🔼

obj_translate_xyz_random

Description

Applies a random translation to an object on all three axes

Lua Example

obj_translate_xyz_random(obj, rangeLength)

Parameters

Field	Type
obj	Object
rangeLength	`number`

Returns

None

C Prototype

void obj_translate_xyz_random(struct Object *obj, f32 rangeLength);

🔼

obj_translate_xz_random

Description

Applies a random translation to an object on the X and Z axes

Lua Example

obj_translate_xz_random(obj, rangeLength)

Parameters

Field	Type
obj	Object
rangeLength	`number`

Returns

None

C Prototype

void obj_translate_xz_random(struct Object *obj, f32 rangeLength);

🔼

obj_build_vel_from_transform

Description

Builds the object's world velocity from its transform basis vectors

Lua Example

obj_build_vel_from_transform(a0)

Parameters

Field	Type
a0	Object

Returns

None

C Prototype

void obj_build_vel_from_transform(struct Object *a0);

🔼

cur_obj_set_pos_via_transform

Description

Moves the current object using its transform-derived velocity

Lua Example

cur_obj_set_pos_via_transform()

Parameters

None

Returns

None

C Prototype

void cur_obj_set_pos_via_transform(void);

🔼

cur_obj_reflect_move_angle_off_wall

Description

Reflects the current object's move angle across its wall normal

Lua Example

local integerValue = cur_obj_reflect_move_angle_off_wall()

Parameters

None

Returns

integer

C Prototype

s16 cur_obj_reflect_move_angle_off_wall(void);

🔼

cur_obj_spawn_particles

Description

Spawns particles based on information in a SpawnParticlesInfo structure

Lua Example

cur_obj_spawn_particles(info)

Parameters

Field	Type
info	SpawnParticlesInfo

Returns

None

C Prototype

void cur_obj_spawn_particles(struct SpawnParticlesInfo *info);

🔼

obj_set_hitbox

Description

Sets an object's hitbox and hurtbox quantities then makes it tangible

Lua Example

obj_set_hitbox(obj, hitbox)

Parameters

Field	Type
obj	Object
hitbox	ObjectHitbox

Returns

None

C Prototype

void obj_set_hitbox(struct Object *obj, struct ObjectHitbox *hitbox);

🔼

cur_obj_wait_then_blink

Description

Makes the current object blink after a delay and returns TRUE when blinking is complete

Lua Example

local integerValue = cur_obj_wait_then_blink(timeUntilBlinking, numBlinks)

Parameters

Field	Type
timeUntilBlinking	`integer`
numBlinks	`integer`

Returns

integer

C Prototype

s32 cur_obj_wait_then_blink(s32 timeUntilBlinking, s32 numBlinks);

🔼

cur_obj_is_mario_ground_pounding_platform

Description

Returns TRUE if any active player is ground-pounding the current platform object

Lua Example

local integerValue = cur_obj_is_mario_ground_pounding_platform()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_is_mario_ground_pounding_platform(void);

🔼

obj_is_mario_ground_pounding_platform

Description

Checks whether a MarioState is ground-pounding the specified platform object

Lua Example

local integerValue = obj_is_mario_ground_pounding_platform(m, obj)

Parameters

Field	Type
m	MarioState
obj	Object

Returns

integer

C Prototype

s32 obj_is_mario_ground_pounding_platform(struct MarioState *m, struct Object *obj);

🔼

spawn_mist_particles

Description

Spawns mist particles at the current object without playing sound

Lua Example

spawn_mist_particles()

Parameters

None

Returns

None

C Prototype

void spawn_mist_particles(void);

🔼

spawn_mist_particles_with_sound

Description

Spawns mist particles at the current object and plays the specified sound

Lua Example

spawn_mist_particles_with_sound(sp18)

Parameters

Field	Type
sp18	`integer`

Returns

None

C Prototype

void spawn_mist_particles_with_sound(u32 sp18);

🔼

cur_obj_push_mario_away

Description

Pushes any player within a radius away from the current object on the XZ plane

Lua Example

cur_obj_push_mario_away(radius)

Parameters

Field	Type
radius	`number`

Returns

None

C Prototype

void cur_obj_push_mario_away(f32 radius);

🔼

cur_obj_push_mario_away_from_cylinder

Description

Pushes any player within a vertical cylinder away from the current object

Lua Example

cur_obj_push_mario_away_from_cylinder(radius, extentY)

Parameters

Field	Type
radius	`number`
extentY	`number`

Returns

None

C Prototype

void cur_obj_push_mario_away_from_cylinder(f32 radius, f32 extentY);

🔼

bhv_dust_smoke_loop

Description

Behavior loop function for dust smoke

Lua Example

bhv_dust_smoke_loop()

Parameters

None

Returns

None

C Prototype

void bhv_dust_smoke_loop(void);

🔼

stub_obj_helpers_3

Description

Placeholder function with no behavior

Lua Example

stub_obj_helpers_3(sp0, sp4)

Parameters

Field	Type
sp0	`integer`
sp4	`integer`

Returns

None

C Prototype

void stub_obj_helpers_3(UNUSED s32 sp0, UNUSED s32 sp4);

🔼

cur_obj_scale_over_time

Description

Smoothly scales the current object over time using enabled axes

Lua Example

cur_obj_scale_over_time(a0, a1, sp10, sp14)

Parameters

Field	Type
a0	`integer`
a1	`integer`
sp10	`number`
sp14	`number`

Returns

None

C Prototype

void cur_obj_scale_over_time(s32 a0, s32 a1, f32 sp10, f32 sp14);

🔼

cur_obj_set_pos_to_home_with_debug

Description

Moves an object to its home position while applying debug position offsets

Lua Example

cur_obj_set_pos_to_home_with_debug()

Parameters

None

Returns

None

C Prototype

void cur_obj_set_pos_to_home_with_debug(void);

🔼

stub_obj_helpers_4

Description

Placeholder function with no behavior

Lua Example

stub_obj_helpers_4()

Parameters

None

Returns

None

C Prototype

void stub_obj_helpers_4(void);

🔼

cur_obj_is_mario_on_platform

Description

Returns TRUE if Mario is currently standing on the current platform object

Lua Example

local integerValue = cur_obj_is_mario_on_platform()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_is_mario_on_platform(void);

🔼

cur_obj_is_any_player_on_platform

Description

Returns TRUE if any player is standing on the current platform object

Lua Example

local integerValue = cur_obj_is_any_player_on_platform()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_is_any_player_on_platform(void);

🔼

cur_obj_shake_y_until

Description

Oscillates the current object vertically until a specified number of cycles passes

Lua Example

local integerValue = cur_obj_shake_y_until(cycles, amount)

Parameters

Field	Type
cycles	`integer`
amount	`integer`

Returns

integer

C Prototype

s32 cur_obj_shake_y_until(s32 cycles, s32 amount);

🔼

cur_obj_move_up_and_down

Description

Moves the current object up and down along a preset displacement table

Lua Example

local integerValue = cur_obj_move_up_and_down(a0)

Parameters

Field	Type
a0	`integer`

Returns

integer

C Prototype

s32 cur_obj_move_up_and_down(s32 a0);

🔼

spawn_star_with_no_lvl_exit

Description

Spawns a star object without triggering level exit behavior

Lua Example

local objectValue = spawn_star_with_no_lvl_exit(sp20, sp24)

Parameters

Field	Type
sp20	`integer`
sp24	`integer`

Returns

Object

C Prototype

struct Object *spawn_star_with_no_lvl_exit(s32 sp20, s32 sp24);

🔼

spawn_base_star_with_no_lvl_exit

Description

Spawns a base star with default parameters and no level exit behavior

Lua Example

spawn_base_star_with_no_lvl_exit()

Parameters

None

Returns

None

C Prototype

void spawn_base_star_with_no_lvl_exit(void);

🔼

cur_obj_mario_far_away

Description

Returns TRUE if the current object is farther than 2000 units from every active Mario

Lua Example

local integerValue = cur_obj_mario_far_away()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_mario_far_away(void);

🔼

is_mario_moving_fast_or_in_air

Description

Returns TRUE if the current Mario is moving faster than threshold or is airborne

Lua Example

local integerValue = is_mario_moving_fast_or_in_air(speedThreshold)

Parameters

Field	Type
speedThreshold	`integer`

Returns

integer

C Prototype

s32 is_mario_moving_fast_or_in_air(s32 speedThreshold);

🔼

is_item_in_array

Description

Checks whether a signed item appears in a terminated array

Lua Example

local integerValue = is_item_in_array(item, array)

Parameters

Field	Type
item	`integer`
array	`Pointer` <`integer`>

Returns

integer

C Prototype

s32 is_item_in_array(s8 item, s8 *array);

🔼

bhv_init_room

Description

Sets the current object's room based on the floor surface underneath it

Lua Example

bhv_init_room()

Parameters

None

Returns

None

C Prototype

void bhv_init_room(void);

🔼

cur_obj_enable_rendering_if_mario_in_room

Description

Enables rendering for the current object if any active player is in a connected room

Lua Example

cur_obj_enable_rendering_if_mario_in_room()

Parameters

None

Returns

None

C Prototype

void cur_obj_enable_rendering_if_mario_in_room(void);

🔼

cur_obj_set_hitbox_and_die_if_attacked

Description

Gives the current object a hitbox and kills it if attacked, with optional loot suppression

Lua Example

local integerValue = cur_obj_set_hitbox_and_die_if_attacked(hitbox, deathSound, noLootCoins)

Parameters

Field	Type
hitbox	ObjectHitbox
deathSound	`integer`
noLootCoins	`integer`

Returns

integer

C Prototype

s32 cur_obj_set_hitbox_and_die_if_attacked(struct ObjectHitbox *hitbox, s32 deathSound, s32 noLootCoins);

🔼

obj_explode_and_spawn_coins

Description

Explodes the current object, spawns particles, and optionally spawns coins

Lua Example

obj_explode_and_spawn_coins(sp18, sp1C)

Parameters

Field	Type
sp18	`number`
sp1C	`integer`

Returns

None

C Prototype

void obj_explode_and_spawn_coins(f32 sp18, s32 sp1C);

🔼

cur_obj_if_hit_wall_bounce_away

Description

Sets the current object to bounce away if it hit a wall

Lua Example

cur_obj_if_hit_wall_bounce_away()

Parameters

None

Returns

None

C Prototype

void cur_obj_if_hit_wall_bounce_away(void);

🔼

cur_obj_hide_if_mario_far_away_y

Description

Hides the current object if Mario is too far above or below it, otherwise ensures it is visible

Lua Example

local integerValue = cur_obj_hide_if_mario_far_away_y(distY)

Parameters

Field	Type
distY	`number`

Returns

integer

C Prototype

s32 cur_obj_hide_if_mario_far_away_y(f32 distY);

🔼

obj_is_hidden

Description

Returns TRUE if the given object is currently hidden from rendering

Lua Example

local integerValue = obj_is_hidden(obj)

Parameters

Field	Type
obj	Object

Returns

integer

C Prototype

s32 obj_is_hidden(struct Object *obj);

🔼

enable_time_stop

Description

Enables global time stop state

Lua Example

enable_time_stop()

Parameters

None

Returns

None

C Prototype

void enable_time_stop(void);

🔼

enable_time_stop_if_alone

Description

Enables time stop only when the local player is alone

Lua Example

enable_time_stop_if_alone()

Parameters

None

Returns

None

C Prototype

void enable_time_stop_if_alone(void);

🔼

disable_time_stop

Description

Disables global time stop state

Lua Example

disable_time_stop()

Parameters

None

Returns

None

C Prototype

void disable_time_stop(void);

🔼

set_time_stop_flags

Description

Sets global time stop flags

Lua Example

set_time_stop_flags(flags)

Parameters

Field	Type
flags	`integer`

Returns

None

C Prototype

void set_time_stop_flags(s32 flags);

🔼

set_time_stop_flags_if_alone

Description

Sets time stop flags only if the local player is alone

Lua Example

set_time_stop_flags_if_alone(flags)

Parameters

Field	Type
flags	`integer`

Returns

None

C Prototype

void set_time_stop_flags_if_alone(s32 flags);

🔼

clear_time_stop_flags

Description

Clears selected global time stop flags

Lua Example

clear_time_stop_flags(flags)

Parameters

Field	Type
flags	`integer`

Returns

None

C Prototype

void clear_time_stop_flags(s32 flags);

🔼

cur_obj_can_mario_activate_textbox

Description

Checks whether Mario can activate the current object's textbox within a vertical and horizontal range

Lua Example

local integerValue = cur_obj_can_mario_activate_textbox(m, radius, height, unused)

Parameters

Field	Type
m	MarioState
radius	`number`
height	`number`
unused	`integer`

Returns

integer

C Prototype

s32 cur_obj_can_mario_activate_textbox(struct MarioState* m, f32 radius, f32 height, UNUSED s32 unused);

🔼

cur_obj_can_mario_activate_textbox_2

Description

Wrapper that checks Mario textbox activation using a fixed unused parameter value

Lua Example

local integerValue = cur_obj_can_mario_activate_textbox_2(m, radius, height)

Parameters

Field	Type
m	MarioState
radius	`number`
height	`number`

Returns

integer

C Prototype

s32 cur_obj_can_mario_activate_textbox_2(struct MarioState* m, f32 radius, f32 height);

🔼

cur_obj_end_dialog

Description

Ends dialog state for the current object and records Mario's response

Lua Example

cur_obj_end_dialog(m, dialogFlags, dialogResult)

Parameters

Field	Type
m	MarioState
dialogFlags	`integer`
dialogResult	`integer`

Returns

None

C Prototype

void cur_obj_end_dialog(struct MarioState* m, s32 dialogFlags, s32 dialogResult);

🔼

cur_obj_has_model

Description

Checks whether the current object uses the specified model geometry

Lua Example

local integerValue = cur_obj_has_model(modelID)

Parameters

Field	Type
modelID	`integer`

Returns

integer

C Prototype

s32 cur_obj_has_model(u16 modelID);

🔼

cur_obj_align_gfx_with_floor

Description

Aligns the current object's graphics with the floor normal at its position

Lua Example

cur_obj_align_gfx_with_floor()

Parameters

None

Returns

None

C Prototype

void cur_obj_align_gfx_with_floor(void);

🔼

mario_is_within_rectangle

Description

Returns TRUE if Mario's position lies within a 2D rectangle on the XZ plane

Lua Example

local integerValue = mario_is_within_rectangle(minX, maxX, minZ, maxZ)

Parameters

Field	Type
minX	`integer`
maxX	`integer`
minZ	`integer`
maxZ	`integer`

Returns

integer

C Prototype

s32 mario_is_within_rectangle(s16 minX, s16 maxX, s16 minZ, s16 maxZ);

🔼

cur_obj_shake_screen

Description

Shakes the camera around the current object with a given intensity

Lua Example

cur_obj_shake_screen(shake)

Parameters

Field	Type
shake	`integer`

Returns

None

C Prototype

void cur_obj_shake_screen(s32 shake);

🔼

obj_attack_collided_from_other_object

Description

Marks another object as attacked by the current object and returns whether it collided

Lua Example

local integerValue = obj_attack_collided_from_other_object(obj)

Parameters

Field	Type
obj	Object

Returns

integer

C Prototype

s32 obj_attack_collided_from_other_object(struct Object *obj);

🔼

cur_obj_was_attacked_or_ground_pounded

Description

Returns TRUE if the current object was attacked or ground-pounded and clears interact status

Lua Example

local integerValue = cur_obj_was_attacked_or_ground_pounded()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_was_attacked_or_ground_pounded(void);

🔼

obj_copy_behavior_params

Description

Copies behavior parameters from one object to another

Lua Example

obj_copy_behavior_params(dst, src)

Parameters

Field	Type
dst	Object
src	Object

Returns

None

C Prototype

void obj_copy_behavior_params(struct Object *dst, struct Object *src);

🔼

cur_obj_init_animation_and_anim_frame

Description

Initializes the current object's animation and sets a specific frame

Lua Example

cur_obj_init_animation_and_anim_frame(animIndex, animFrame)

Parameters

Field	Type
animIndex	`integer`
animFrame	`integer`

Returns

None

C Prototype

void cur_obj_init_animation_and_anim_frame(s32 animIndex, s32 animFrame);

🔼

cur_obj_init_animation_and_check_if_near_end

Description

Initializes the current object's animation and checks if it is near the end

Lua Example

local integerValue = cur_obj_init_animation_and_check_if_near_end(animIndex)

Parameters

Field	Type
animIndex	`integer`

Returns

integer

C Prototype

s32 cur_obj_init_animation_and_check_if_near_end(s32 animIndex);

🔼

cur_obj_init_animation_and_extend_if_at_end

Description

Initializes the current object's animation and extends it if the animation has ended

Lua Example

cur_obj_init_animation_and_extend_if_at_end(animIndex)

Parameters

Field	Type
animIndex	`integer`

Returns

None

C Prototype

void cur_obj_init_animation_and_extend_if_at_end(s32 animIndex);

🔼

cur_obj_check_grabbed_mario

Description

Checks whether the current object has grabbed Mario and becomes intangible if so

Lua Example

local integerValue = cur_obj_check_grabbed_mario()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_check_grabbed_mario(void);

🔼

player_performed_grab_escape_action

Description

Returns TRUE if the player performed an escape action during a grab

Lua Example

local integerValue = player_performed_grab_escape_action()

Parameters

None

Returns

integer

C Prototype

s32 player_performed_grab_escape_action(void);

🔼

cur_obj_unused_play_footstep_sound

Description

Plays a footstep sound when the current animation reaches one of two frames

Lua Example

cur_obj_unused_play_footstep_sound(animFrame1, animFrame2, sound)

Parameters

Field	Type
animFrame1	`integer`
animFrame2	`integer`
sound	`integer`

Returns

None

C Prototype

void cur_obj_unused_play_footstep_sound(s32 animFrame1, s32 animFrame2, s32 sound);

🔼

enable_time_stop_including_mario

Description

Enables time stop for the world and Mario/doors

Lua Example

enable_time_stop_including_mario()

Parameters

None

Returns

None

C Prototype

void enable_time_stop_including_mario(void);

🔼

disable_time_stop_including_mario

Description

Disables time stop for the world and Mario/doors

Lua Example

disable_time_stop_including_mario()

Parameters

None

Returns

None

C Prototype

void disable_time_stop_including_mario(void);

🔼

cur_obj_check_interacted

Description

Returns TRUE if the current object has been interacted with and clears the status

Lua Example

local integerValue = cur_obj_check_interacted()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_check_interacted(void);

🔼

cur_obj_spawn_loot_blue_coin

Description

Spawns a blue coin from the current object when sufficient loot coins are available

Lua Example

cur_obj_spawn_loot_blue_coin()

Parameters

None

Returns

None

C Prototype

void cur_obj_spawn_loot_blue_coin(void);

🔼

cur_obj_spawn_star_at_y_offset

Description

Temporarily shifts the current object's Y position and spawns a star

Lua Example

cur_obj_spawn_star_at_y_offset(targetX, targetY, targetZ, offsetY)

Parameters

Field	Type
targetX	`number`
targetY	`number`
targetZ	`number`
offsetY	`number`

Returns

None

C Prototype

void cur_obj_spawn_star_at_y_offset(f32 targetX, f32 targetY, f32 targetZ, f32 offsetY);

🔼

cur_obj_set_home_once

Description

Sets the current object's home position once and marks it as initialized

Lua Example

cur_obj_set_home_once()

Parameters

None

Returns

None

C Prototype

void cur_obj_set_home_once(void);

🔼

get_trajectory_length

Description

Gets the number of steps in a trajectory until the end marker

Lua Example

local integerValue = get_trajectory_length(trajectory)

Parameters

Field	Type
trajectory	`Pointer` <`Trajectory`>

Returns

integer

C Prototype

s32 get_trajectory_length(Trajectory* trajectory);

🔼

functions from object_list_processor.h

set_object_respawn_info_bits

Description

Runs an OR operator on the obj's respawn info with bits << 8. If bits is 0xFF, this prevents the object from respawning after leaving and re-entering the area

Lua Example

set_object_respawn_info_bits(obj, bits)

Parameters

Field	Type
obj	Object
bits	`integer`

Returns

None

C Prototype

void set_object_respawn_info_bits(struct Object *obj, u8 bits);

🔼

functions from platform_displacement.h

apply_platform_displacement

Description

Apply one frame of platform rotation to the object using the given platform

Lua Example

apply_platform_displacement(o, platform)

Parameters

Field	Type
o	Object
platform	Object

Returns

None

C Prototype

void apply_platform_displacement(struct Object *o, struct Object *platform);

🔼

functions from rumble_init.h

queue_rumble_data

Description

Queues rumble data

Lua Example

queue_rumble_data(a0, a1)

Parameters

Field	Type
a0	`integer`
a1	`integer`

Returns

None

C Prototype

void queue_rumble_data(s16 a0, s16 a1);

🔼

queue_rumble_data_object

Description

Queues rumble data for object, factoring in its distance from Mario

Lua Example

queue_rumble_data_object(object, a0, a1)

Parameters

Field	Type
object	Object
a0	`integer`
a1	`integer`

Returns

None

C Prototype

void queue_rumble_data_object(struct Object* object, s16 a0, s16 a1);

🔼

queue_rumble_data_mario

Description

Queues rumble data for Mario

Lua Example

queue_rumble_data_mario(m, a0, a1)

Parameters

Field	Type
m	MarioState
a0	`integer`
a1	`integer`

Returns

None

C Prototype

void queue_rumble_data_mario(struct MarioState* m, s16 a0, s16 a1);

🔼

reset_rumble_timers

Description

Resets rumble timers

Lua Example

reset_rumble_timers(m)

Parameters

Field	Type
m	MarioState

Returns

None

C Prototype

void reset_rumble_timers(struct MarioState* m);

🔼

reset_rumble_timers_2

Description

Resets rumble timers and sets a field based on a0

Lua Example

reset_rumble_timers_2(m, a0)

Parameters

Field	Type
m	MarioState
a0	`integer`

Returns

None

C Prototype

void reset_rumble_timers_2(struct MarioState* m, s32 a0);

🔼

functions from save_file.h

get_level_num_from_course_num

Description

Gets the course number's corresponding level number

Lua Example

local integerValue = get_level_num_from_course_num(courseNum)

Parameters

Field	Type
courseNum	`integer`

Returns

integer

C Prototype

s8 get_level_num_from_course_num(s16 courseNum);

🔼

get_level_course_num

Description

Gets the level number's corresponding course number

Lua Example

local integerValue = get_level_course_num(levelNum)

Parameters

Field	Type
levelNum	`integer`

Returns

integer

C Prototype

s8 get_level_course_num(s16 levelNum);

🔼

touch_coin_score_age

Description

Marks the coin score for a specific course as the newest among all save files. Adjusts the age of other scores to reflect the update. Useful for leaderboard tracking or displaying recent progress

Lua Example

touch_coin_score_age(fileIndex, courseIndex)

Parameters

Field	Type
fileIndex	`integer`
courseIndex	`integer`

Returns

None

C Prototype

void touch_coin_score_age(s32 fileIndex, s32 courseIndex);

🔼

save_file_do_save

Description

Saves the current state of the game into a specified save file. Includes data verification and backup management. Useful for maintaining game progress during play or when saving manually

Lua Example

save_file_do_save(fileIndex, forceSave)

Parameters

Field	Type
fileIndex	`integer`
forceSave	`integer`

Returns

None

C Prototype

void save_file_do_save(s32 fileIndex, s8 forceSave);

🔼

save_file_erase

Description

Erases all data in a specified save file, including backup slots. Marks the save file as modified and performs a save to apply the changes. Useful for resetting a save file to its default state

Lua Example

save_file_erase(fileIndex)

Parameters

Field	Type
fileIndex	`integer`

Returns

None

C Prototype

void save_file_erase(s32 fileIndex);

🔼

save_file_erase_current_backup_save

Description

Erases the backup data for the current save file without affecting the primary save data. Reloads the save file afterward

Lua Example

save_file_erase_current_backup_save()

Parameters

None

Returns

None

C Prototype

void save_file_erase_current_backup_save(void);

🔼

save_file_reload

Description

Reloads the save file data into memory, optionally resetting all save files. Marks the save file as modified. Useful for reloading state after data corruption or during development debugging

Lua Example

save_file_reload(load_all)

Parameters

Field	Type
load_all	`integer`

Returns

None

C Prototype

void save_file_reload(u8 load_all);

🔼

Determines the maximum coin score for a course across all save files. Returns the score along with the file index of the save containing it. Useful for leaderboard-style comparisons and overall progress tracking

Lua Example

local integerValue = save_file_get_max_coin_score(courseIndex)

Parameters

Field	Type
courseIndex	`integer`

Returns

integer

C Prototype

u32 save_file_get_max_coin_score(s32 courseIndex);

🔼

save_file_get_course_star_count

Description

Calculates the total number of stars collected in a specific course for a given save file. Useful for determining completion status of individual levels

Lua Example

local integerValue = save_file_get_course_star_count(fileIndex, courseIndex)

Parameters

Field	Type
fileIndex	`integer`
courseIndex	`integer`

Returns

integer

C Prototype

s32 save_file_get_course_star_count(s32 fileIndex, s32 courseIndex);

🔼

save_file_get_total_star_count

Description

Calculates the total number of stars collected across multiple courses within a specified range. Useful for determining the overall progress toward game completion

Lua Example

local integerValue = save_file_get_total_star_count(fileIndex, minCourse, maxCourse)

Parameters

Field	Type
fileIndex	`integer`
minCourse	`integer`
maxCourse	`integer`

Returns

integer

C Prototype

s32 save_file_get_total_star_count(s32 fileIndex, s32 minCourse, s32 maxCourse);

🔼

save_file_set_flags

Description

Adds new flags to the save file's flag bitmask. Useful for updating progress or triggering new gameplay features

Lua Example

save_file_set_flags(flags)

Parameters

Field	Type
flags	`integer`

Returns

None

C Prototype

void save_file_set_flags(u32 flags);

🔼

save_file_clear_flags

Description

Clears specific flags in the current save file. The flags are specified as a bitmask in the flags parameter. Ensures that the save file remains valid after clearing. Useful for removing specific game states, such as collected items or completed objectives, without resetting the entire save

Lua Example

save_file_clear_flags(flags)

Parameters

Field	Type
flags	`integer`

Returns

None

C Prototype

void save_file_clear_flags(u32 flags);

🔼

save_file_get_flags

Description

Retrieves the bitmask of flags representing the current state of the save file. Flags indicate collected items, completed objectives, and other game states. Useful for checking specific game progress details

Lua Example

local integerValue = save_file_get_flags()

Parameters

None

Returns

integer

C Prototype

u32 save_file_get_flags(void);

🔼

save_file_get_star_flags

Description

Retrieves the bitmask of stars collected in a specific course or castle secret stars (-1). Useful for evaluating level progress and completion

Lua Example

local integerValue = save_file_get_star_flags(fileIndex, courseIndex)

Parameters

Field	Type
fileIndex	`integer`
courseIndex	`integer`

Returns

integer

C Prototype

u32 save_file_get_star_flags(s32 fileIndex, s32 courseIndex);

🔼

save_file_set_star_flags

Description

Adds specific star flags to the save file, indicating collected stars for a course or castle secret stars. Updates the save file flags as necessary. Useful for recording progress after star collection

Lua Example

save_file_set_star_flags(fileIndex, courseIndex, starFlags)

Parameters

Field	Type
fileIndex	`integer`
courseIndex	`integer`
starFlags	`integer`

Returns

None

C Prototype

void save_file_set_star_flags(s32 fileIndex, s32 courseIndex, u32 starFlags);

🔼

save_file_remove_star_flags

Description

Removes specific star flags from the save file. This modifies the bitmask representing collected stars for a course or castle secret stars. Useful for undoing progress or debugging collected stars

Lua Example

save_file_remove_star_flags(fileIndex, courseIndex, starFlagsToRemove)

Parameters

Field	Type
fileIndex	`integer`
courseIndex	`integer`
starFlagsToRemove	`integer`

Returns

None

C Prototype

void save_file_remove_star_flags(s32 fileIndex, s32 courseIndex, u32 starFlagsToRemove);

🔼

save_file_get_course_coin_score

Description

Returns the highest coin score for a specified course in the save file. Performs checks to ensure the coin score is valid. Useful for tracking player achievements and high scores

Lua Example

local integerValue = save_file_get_course_coin_score(fileIndex, courseIndex)

Parameters

Field	Type
fileIndex	`integer`
courseIndex	`integer`

Returns

integer

C Prototype

s32 save_file_get_course_coin_score(s32 fileIndex, s32 courseIndex);

🔼

save_file_set_course_coin_score

Description

Updates the coin score for a specific course in the save file. The new score is provided in the coinScore parameter. Useful for manually setting achievements such as high coin counts in individual levels

Lua Example

save_file_set_course_coin_score(fileIndex, courseIndex, coinScore)

Parameters

Field	Type
fileIndex	`integer`
courseIndex	`integer`
coinScore	`integer`

Returns

None

C Prototype

void save_file_set_course_coin_score(s32 fileIndex, s32 courseIndex, u8 coinScore);

🔼

save_file_is_cannon_unlocked

Description

Checks whether the cannon in the specified course is unlocked. Returns true if the cannon is unlocked, otherwise false. Useful for tracking course-specific progress and enabling shortcuts

Lua Example

local integerValue = save_file_is_cannon_unlocked(fileIndex, courseIndex)

Parameters

Field	Type
fileIndex	`integer`
courseIndex	`integer`

Returns

integer

C Prototype

s32 save_file_is_cannon_unlocked(s32 fileIndex, s32 courseIndex);

🔼

save_file_set_cannon_unlocked

Description

Unlocks the cannon in the current course

Lua Example

save_file_set_cannon_unlocked()

Parameters

None

Returns

None

C Prototype

void save_file_set_cannon_unlocked(void);

🔼

save_file_get_cap_pos

Description

Retrieves the current position of Mario's cap, if it is on the ground in the current level and area. The position is stored in the provided capPos parameter. Useful for tracking the cap's location after it has been dropped or lost

Lua Example

local integerValue = save_file_get_cap_pos(capPos)

Parameters

Field	Type
capPos	Vec3s

Returns

integer

C Prototype

s32 save_file_get_cap_pos(VEC_OUT Vec3s capPos);

🔼

save_file_get_sound_mode

Description

Returns the current sound mode (e.g., stereo, mono) stored in the save file. Useful for checking the audio output preferences when loading a save

Lua Example

local integerValue = save_file_get_sound_mode()

Parameters

None

Returns

integer

C Prototype

u16 save_file_get_sound_mode(void);

🔼

functions from seqplayer.h

sequence_player_get_tempo

Description

Gets the tempo of player

Lua Example

local integerValue = sequence_player_get_tempo(player)

Parameters

Field	Type
player	`integer`

Returns

integer

C Prototype

u16 sequence_player_get_tempo(u8 player);

🔼

sequence_player_set_tempo

Description

Sets the tempo of player. Resets when another sequence is played

Lua Example

sequence_player_set_tempo(player, tempo)

Parameters

Field	Type
player	`integer`
tempo	`integer`

Returns

None

C Prototype

void sequence_player_set_tempo(u8 player, u16 tempo);

🔼

sequence_player_get_tempo_acc

Description

Gets the tempoAcc (tempo accumulation) of player

Lua Example

local integerValue = sequence_player_get_tempo_acc(player)

Parameters

Field	Type
player	`integer`

Returns

integer

C Prototype

u16 sequence_player_get_tempo_acc(u8 player);

🔼

sequence_player_set_tempo_acc

Description

Sets the tempoAcc (tempo accumulation) of player. Resets when another sequence is played

Lua Example

sequence_player_set_tempo_acc(player, tempoAcc)

Parameters

Field	Type
player	`integer`
tempoAcc	`integer`

Returns

None

C Prototype

void sequence_player_set_tempo_acc(u8 player, u16 tempoAcc);

🔼

sequence_player_get_transposition

Description

Gets the transposition (pitch) of player

Lua Example

local integerValue = sequence_player_get_transposition(player)

Parameters

Field	Type
player	`integer`

Returns

integer

C Prototype

u16 sequence_player_get_transposition(u8 player);

🔼

sequence_player_set_transposition

Description

Sets the transposition (pitch) of player. Resets when another sequence is played

Lua Example

sequence_player_set_transposition(player, transposition)

Parameters

Field	Type
player	`integer`
transposition	`integer`

Returns

None

C Prototype

void sequence_player_set_transposition(u8 player, u16 transposition);

🔼

sequence_player_get_volume

Description

Gets the volume of player

Lua Example

local numberValue = sequence_player_get_volume(player)

Parameters

Field	Type
player	`integer`

Returns

number

C Prototype

f32 sequence_player_get_volume(u8 player);

🔼

sequence_player_get_fade_volume

Description

Gets the fade volume of player

Lua Example

local numberValue = sequence_player_get_fade_volume(player)

Parameters

Field	Type
player	`integer`

Returns

number

C Prototype

f32 sequence_player_get_fade_volume(u8 player);

🔼

sequence_player_get_mute_volume_scale

Description

Gets the mute volume scale of player

Lua Example

local numberValue = sequence_player_get_mute_volume_scale(player)

Parameters

Field	Type
player	`integer`

Returns

number

C Prototype

f32 sequence_player_get_mute_volume_scale(u8 player);

🔼

functions from smlua_anim_utils.h

get_mario_vanilla_animation

Description

Gets a vanilla mario Animation with index

Lua Example

local animationValue = get_mario_vanilla_animation(index)

Parameters

Field	Type
index	`integer`

Returns

Animation

C Prototype

struct Animation *get_mario_vanilla_animation(u16 index);

🔼

smlua_anim_util_set_animation

Description

Sets the animation of obj to the animation name corresponds to

Lua Example

smlua_anim_util_set_animation(obj, name)

Parameters

Field	Type
obj	Object
name	`string`

Returns

None

C Prototype

void smlua_anim_util_set_animation(struct Object *obj, const char *name);

🔼

smlua_anim_util_get_current_animation_name

Description

Gets the name of the current animation playing on obj, returns nil if there's no name

Lua Example

local stringValue = smlua_anim_util_get_current_animation_name(obj)

Parameters

Field	Type
obj	Object

Returns

string

C Prototype

const char *smlua_anim_util_get_current_animation_name(struct Object *obj);

🔼

functions from smlua_audio_utils.h

smlua_audio_utils_reset_all

Description

Resets all custom sequences back to vanilla

Lua Example

smlua_audio_utils_reset_all()

Parameters

None

Returns

None

C Prototype

void smlua_audio_utils_reset_all(void);

🔼

smlua_audio_utils_replace_sequence

Description

Replaces the sequence corresponding to sequenceId with one called m64Name.m64 with bankId and defaultVolume

Lua Example

smlua_audio_utils_replace_sequence(sequenceId, bankId, defaultVolume, m64Name)

Parameters

Field	Type
sequenceId	`integer`
bankId	`integer`
defaultVolume	`integer`
m64Name	`string`

Returns

None

C Prototype

void smlua_audio_utils_replace_sequence(u8 sequenceId, u8 bankId, u8 defaultVolume, const char* m64Name);

🔼

smlua_audio_utils_allocate_sequence

Description

Allocates a new sequence ID

Lua Example

local integerValue = smlua_audio_utils_allocate_sequence()

Parameters

None

Returns

integer

C Prototype

u8 smlua_audio_utils_allocate_sequence(void);

🔼

audio_stream_load

Description

Loads an audio stream by filename (with extension)

Lua Example

local modAudioValue = audio_stream_load(filename)

Parameters

Field	Type
filename	`string`

Returns

ModAudio

C Prototype

struct ModAudio* audio_stream_load(const char* filename);

🔼

audio_stream_destroy

Description

Destroys an audio stream

Lua Example

audio_stream_destroy(audio)

Parameters

Field	Type
audio	ModAudio

Returns

None

C Prototype

void audio_stream_destroy(struct ModAudio* audio);

🔼

audio_stream_play

Description

Plays an audio stream with volume. restart sets the elapsed time back to 0.

Lua Example

audio_stream_play(audio, restart, volume)

Parameters

Field	Type
audio	ModAudio
restart	`boolean`
volume	`number`

Returns

None

C Prototype

void audio_stream_play(struct ModAudio* audio, bool restart, f32 volume);

🔼

audio_stream_pause

Description

Pauses an audio stream

Lua Example

audio_stream_pause(audio)

Parameters

Field	Type
audio	ModAudio

Returns

None

C Prototype

void audio_stream_pause(struct ModAudio* audio);

🔼

audio_stream_stop

Description

Stops an audio stream

Lua Example

audio_stream_stop(audio)

Parameters

Field	Type
audio	ModAudio

Returns

None

C Prototype

void audio_stream_stop(struct ModAudio* audio);

🔼

audio_stream_get_position

Description

Gets the position of an audio stream in seconds

Lua Example

local numberValue = audio_stream_get_position(audio)

Parameters

Field	Type
audio	ModAudio

Returns

number

C Prototype

f32 audio_stream_get_position(struct ModAudio* audio);

🔼

audio_stream_set_position

Description

Sets the position of an audio stream in seconds

Lua Example

audio_stream_set_position(audio, pos)

Parameters

Field	Type
audio	ModAudio
pos	`number`

Returns

None

C Prototype

void audio_stream_set_position(struct ModAudio* audio, f32 pos);

🔼

audio_stream_get_looping

Description

Gets if an audio stream is looping or not

Lua Example

local booleanValue = audio_stream_get_looping(audio)

Parameters

Field	Type
audio	ModAudio

Returns

boolean

C Prototype

bool audio_stream_get_looping(struct ModAudio* audio);

🔼

audio_stream_set_looping

Description

Sets if an audio stream is looping or not

Lua Example

audio_stream_set_looping(audio, looping)

Parameters

Field	Type
audio	ModAudio
looping	`boolean`

Returns

None

C Prototype

void audio_stream_set_looping(struct ModAudio* audio, bool looping);

🔼

audio_stream_set_loop_points

Description

Sets an audio stream's loop points in samples

Lua Example

audio_stream_set_loop_points(audio, loopStart, loopEnd)

Parameters

Field	Type
audio	ModAudio
loopStart	`integer`
loopEnd	`integer`

Returns

None

C Prototype

void audio_stream_set_loop_points(struct ModAudio* audio, s64 loopStart, s64 loopEnd);

🔼

audio_stream_get_frequency

Description

Gets the frequency of an audio stream

Lua Example

local numberValue = audio_stream_get_frequency(audio)

Parameters

Field	Type
audio	ModAudio

Returns

number

C Prototype

f32 audio_stream_get_frequency(struct ModAudio* audio);

🔼

audio_stream_set_frequency

Description

Sets the frequency of an audio stream

Lua Example

audio_stream_set_frequency(audio, freq)

Parameters

Field	Type
audio	ModAudio
freq	`number`

Returns

None

C Prototype

void audio_stream_set_frequency(struct ModAudio* audio, f32 freq);

🔼

audio_stream_get_volume

Description

Gets the volume of an audio stream

Lua Example

local numberValue = audio_stream_get_volume(audio)

Parameters

Field	Type
audio	ModAudio

Returns

number

C Prototype

f32 audio_stream_get_volume(struct ModAudio* audio);

🔼

audio_stream_set_volume

Description

Sets the volume of an audio stream

Lua Example

audio_stream_set_volume(audio, volume)

Parameters

Field	Type
audio	ModAudio
volume	`number`

Returns

None

C Prototype

void audio_stream_set_volume(struct ModAudio* audio, f32 volume);

🔼

audio_stream_get_volume_channel

Description

Gets the volume channel of an audio stream

Lua Example

local integerValue = audio_stream_get_volume_channel(audio)

Parameters

Field	Type
audio	ModAudio

Returns

integer

C Prototype

u8 audio_stream_get_volume_channel(struct ModAudio *audio);

🔼

audio_stream_set_volume_channel

Description

Sets the volume channel of an audio stream

Lua Example

audio_stream_set_volume_channel(audio, channel)

Parameters

Field	Type
audio	ModAudio
channel	`integer`

Returns

None

C Prototype

void audio_stream_set_volume_channel(struct ModAudio *audio, u8 channel);

🔼

audio_sample_load

Description

Loads an audio sample

Lua Example

local modAudioValue = audio_sample_load(filename)

Parameters

Field	Type
filename	`string`

Returns

ModAudio

C Prototype

struct ModAudio* audio_sample_load(const char* filename);

🔼

audio_sample_destroy

Description

Destroys an audio sample

Lua Example

audio_sample_destroy(audio)

Parameters

Field	Type
audio	ModAudio

Returns

None

C Prototype

void audio_sample_destroy(struct ModAudio* audio);

🔼

audio_sample_stop

Description

Stops an audio sample

Lua Example

audio_sample_stop(audio)

Parameters

Field	Type
audio	ModAudio

Returns

None

C Prototype

void audio_sample_stop(struct ModAudio* audio);

🔼

audio_sample_play

Description

Plays an audio sample at position with volume

Lua Example

audio_sample_play(audio, position, volume)

Parameters

Field	Type
audio	ModAudio
position	Vec3f
volume	`number`

Returns

None

C Prototype

void audio_sample_play(struct ModAudio* audio, Vec3f position, f32 volume);

🔼

functions from smlua_camera_utils.h

camera_reset_overrides

Description

Resets camera config overrides

Lua Example

camera_reset_overrides()

Parameters

None

Returns

None

C Prototype

void camera_reset_overrides(void);

🔼

camera_freeze

Description

Freezes the camera by not updating it

Lua Example

camera_freeze()

Parameters

None

Returns

None

C Prototype

void camera_freeze(void);

🔼

camera_unfreeze

Description

Unfreezes the camera

Lua Example

camera_unfreeze()

Parameters

None

Returns

None

C Prototype

void camera_unfreeze(void);

🔼

camera_is_frozen

Description

Checks if the camera is frozen

Lua Example

local booleanValue = camera_is_frozen()

Parameters

None

Returns

boolean

C Prototype

bool camera_is_frozen(void);

🔼

camera_romhack_allow_only_mods

Description

Sets if only mods are allowed to modify the camera (Enabling prevents the player from modifying the camera through the settings)

Lua Example

camera_romhack_allow_only_mods(allow)

Parameters

Field	Type
allow	`integer`

Returns

None

C Prototype

void camera_romhack_allow_only_mods(u8 allow);

🔼

camera_set_romhack_override

Description

Sets the romhack camera override status

Lua Example

camera_set_romhack_override(rco)

Parameters

Field	Type
rco	enum RomhackCameraOverride

Returns

None

C Prototype

void camera_set_romhack_override(enum RomhackCameraOverride rco);

🔼

camera_romhack_allow_switchable

Description

Sets if the romhack camera should allow water/flying switching, triggered with the L button

Lua Example

camera_romhack_allow_switchable(allow)

Parameters

Field	Type
allow	`integer`

Returns

None

C Prototype

void camera_romhack_allow_switchable(u8 allow);

🔼

camera_allow_toxic_gas_camera

Description

Sets if the romhack camera should fly above poison gas

Lua Example

camera_allow_toxic_gas_camera(allow)

Parameters

Field	Type
allow	`integer`

Returns

None

C Prototype

void camera_allow_toxic_gas_camera(u8 allow);

🔼

camera_romhack_allow_dpad_usage

Description

Sets if the romhack camera should allow D-Pad movement

Lua Example

camera_romhack_allow_dpad_usage(allow)

Parameters

Field	Type
allow	`integer`

Returns

None

C Prototype

void camera_romhack_allow_dpad_usage(u8 allow);

🔼

camera_romhack_set_collisions

Description

Toggles collision settings for the ROM hack camera. This enables or disables specific collision behaviors in modded levels

Lua Example

camera_romhack_set_collisions(enable)

Parameters

Field	Type
enable	`integer`

Returns

None

C Prototype

void camera_romhack_set_collisions(u8 enable);

🔼

camera_romhack_set_zoomed_in_dist

Description

Sets the romhack camera's zoomed in distance (Default: 900)

Lua Example

camera_romhack_set_zoomed_in_dist(val)

Parameters

Field	Type
val	`integer`

Returns

None

C Prototype

void camera_romhack_set_zoomed_in_dist(u32 val);

🔼

camera_romhack_set_zoomed_out_dist

Description

Sets the romhack camera's zoomed out additional distance (Default: 500)

Lua Example

camera_romhack_set_zoomed_out_dist(val)

Parameters

Field	Type
val	`integer`

Returns

None

C Prototype

void camera_romhack_set_zoomed_out_dist(u32 val);

🔼

camera_romhack_set_zoomed_in_height

Description

Sets the romhack camera's zoomed in height (Default: 300)

Lua Example

camera_romhack_set_zoomed_in_height(val)

Parameters

Field	Type
val	`integer`

Returns

None

C Prototype

void camera_romhack_set_zoomed_in_height(u32 val);

🔼

camera_romhack_set_zoomed_out_height

Description

Sets the romhack camera's zoomed out additional height (Default: 150)

Lua Example

camera_romhack_set_zoomed_out_height(val)

Parameters

Field	Type
val	`integer`

Returns

None

C Prototype

void camera_romhack_set_zoomed_out_height(u32 val);

🔼

camera_romhack_get_zoomed_in_dist

Description

Gets the romhack camera's zoomed in distance

Lua Example

local integerValue = camera_romhack_get_zoomed_in_dist()

Parameters

None

Returns

integer

C Prototype

u32 camera_romhack_get_zoomed_in_dist(void);

🔼

camera_romhack_get_zoomed_out_dist

Description

Gets the romhack camera's additional zoomed out distance

Lua Example

local integerValue = camera_romhack_get_zoomed_out_dist()

Parameters

None

Returns

integer

C Prototype

u32 camera_romhack_get_zoomed_out_dist(void);

🔼

camera_romhack_get_zoomed_in_height

Description

Gets the romhack camera's zoomed in height

Lua Example

local integerValue = camera_romhack_get_zoomed_in_height()

Parameters

None

Returns

integer

C Prototype

u32 camera_romhack_get_zoomed_in_height(void);

🔼

camera_romhack_get_zoomed_out_height

Description

Gets the romhack camera's additional zoomed out height

Lua Example

local integerValue = camera_romhack_get_zoomed_out_height()

Parameters

None

Returns

integer

C Prototype

u32 camera_romhack_get_zoomed_out_height(void);

🔼

camera_get_romhack_override

Description

Gets the current romhack camera override status

Lua Example

local enumValue = camera_get_romhack_override()

Parameters

None

Returns

enum RomhackCameraOverride

C Prototype

enum RomhackCameraOverride camera_get_romhack_override(void);

🔼

camera_romhack_get_allow_switchable

Description

Gets if the romhack camera should allow water/flying switching

Lua Example

local integerValue = camera_romhack_get_allow_switchable()

Parameters

None

Returns

integer

C Prototype

u8 camera_romhack_get_allow_switchable(void);

🔼

camera_get_allow_toxic_gas_camera

Description

Gets if the romhack camera should fly above poison gas

Lua Example

local integerValue = camera_get_allow_toxic_gas_camera()

Parameters

None

Returns

integer

C Prototype

u8 camera_get_allow_toxic_gas_camera(void);

🔼

camera_romhack_get_allow_dpad_usage

Description

Gets if the romhack camera should allow D-Pad movement

Lua Example

local integerValue = camera_romhack_get_allow_dpad_usage()

Parameters

None

Returns

integer

C Prototype

u8 camera_romhack_get_allow_dpad_usage(void);

🔼

camera_romhack_get_collisions

Description

Gets if the romhack camera has surface collisions

Lua Example

local integerValue = camera_romhack_get_collisions()

Parameters

None

Returns

integer

C Prototype

u8 camera_romhack_get_collisions(void);

🔼

camera_config_is_free_cam_enabled

Description

Checks if Free Camera is enabled

Lua Example

local booleanValue = camera_config_is_free_cam_enabled()

Parameters

None

Returns

boolean

C Prototype

bool camera_config_is_free_cam_enabled(void);

🔼

camera_config_is_analog_cam_enabled

Description

Checks if Analog Camera is enabled

Lua Example

local booleanValue = camera_config_is_analog_cam_enabled()

Parameters

None

Returns

boolean

C Prototype

bool camera_config_is_analog_cam_enabled(void);

🔼

camera_config_is_dpad_enabled

Description

Checks if Freecam DPad Behavior is enabled

Lua Example

local booleanValue = camera_config_is_dpad_enabled()

Parameters

None

Returns

boolean

C Prototype

bool camera_config_is_dpad_enabled(void);

🔼

camera_config_is_collision_enabled

Description

Checks if Camera Collision is enabled

Lua Example

local booleanValue = camera_config_is_collision_enabled()

Parameters

None

Returns

boolean

C Prototype

bool camera_config_is_collision_enabled(void);

🔼

camera_config_is_mouse_look_enabled

Description

Checks if Mouse Look is enabled

Lua Example

local booleanValue = camera_config_is_mouse_look_enabled()

Parameters

None

Returns

boolean

C Prototype

bool camera_config_is_mouse_look_enabled(void);

🔼

camera_config_is_x_inverted

Description

Checks if camera X is inverted

Lua Example

local booleanValue = camera_config_is_x_inverted()

Parameters

None

Returns

boolean

C Prototype

bool camera_config_is_x_inverted(void);

🔼

camera_config_is_y_inverted

Description

Checks if camera Y is inverted

Lua Example

local booleanValue = camera_config_is_y_inverted()

Parameters

None

Returns

boolean

C Prototype

bool camera_config_is_y_inverted(void);

🔼

camera_config_get_x_sensitivity

Description

Gets camera X sensitivity

Lua Example

local integerValue = camera_config_get_x_sensitivity()

Parameters

None

Returns

integer

C Prototype

u32 camera_config_get_x_sensitivity(void);

🔼

camera_config_get_y_sensitivity

Description

Gets camera Y sensitivity

Lua Example

local integerValue = camera_config_get_y_sensitivity()

Parameters

None

Returns

integer

C Prototype

u32 camera_config_get_y_sensitivity(void);

🔼

camera_config_get_aggression

Description

Gets camera aggression

Lua Example

local integerValue = camera_config_get_aggression()

Parameters

None

Returns

integer

C Prototype

u32 camera_config_get_aggression(void);

🔼

camera_config_get_pan_level

Description

Gets camera pan level

Lua Example

local integerValue = camera_config_get_pan_level()

Parameters

None

Returns

integer

C Prototype

u32 camera_config_get_pan_level(void);

🔼

camera_config_get_deceleration

Description

Gets camera deceleration

Lua Example

local integerValue = camera_config_get_deceleration()

Parameters

None

Returns

integer

C Prototype

u32 camera_config_get_deceleration(void);

🔼

camera_config_get_centering

Description

Gets if the L button will center the camera

Lua Example

local booleanValue = camera_config_get_centering()

Parameters

None

Returns

boolean

C Prototype

bool camera_config_get_centering(void);

🔼

camera_config_enable_free_cam

Description

Overrides if Free Camera is enabled

Lua Example

camera_config_enable_free_cam(enable)

Parameters

Field	Type
enable	`boolean`

Returns

None

C Prototype

void camera_config_enable_free_cam(bool enable);

🔼

camera_config_enable_analog_cam

Description

Overrides if Analog Camera is enabled

Lua Example

camera_config_enable_analog_cam(enable)

Parameters

Field	Type
enable	`boolean`

Returns

None

C Prototype

void camera_config_enable_analog_cam(bool enable);

🔼

camera_config_enable_centering

Description

Overrides if the L button will center the camera

Lua Example

camera_config_enable_centering(enable)

Parameters

Field	Type
enable	`boolean`

Returns

None

C Prototype

void camera_config_enable_centering(bool enable);

🔼

camera_config_enable_dpad

Description

Overrides if Freecam DPad Behavior is enabled

Lua Example

camera_config_enable_dpad(enable)

Parameters

Field	Type
enable	`boolean`

Returns

None

C Prototype

void camera_config_enable_dpad(bool enable);

🔼

camera_config_enable_collisions

Description

Overrides if Camera Collision is enabled

Lua Example

camera_config_enable_collisions(enable)

Parameters

Field	Type
enable	`boolean`

Returns

None

C Prototype

void camera_config_enable_collisions(bool enable);

🔼

camera_config_enable_mouse_look

Description

Overrides if camera mouse look is enabled

Lua Example

camera_config_enable_mouse_look(enable)

Parameters

Field	Type
enable	`boolean`

Returns

None

C Prototype

void camera_config_enable_mouse_look(bool enable);

🔼

camera_config_invert_x

Description

Overrides if camera X is inverted

Lua Example

camera_config_invert_x(invert)

Parameters

Field	Type
invert	`boolean`

Returns

None

C Prototype

void camera_config_invert_x(bool invert);

🔼

camera_config_invert_y

Description

Overrides if camera Y is inverted

Lua Example

camera_config_invert_y(invert)

Parameters

Field	Type
invert	`boolean`

Returns

None

C Prototype

void camera_config_invert_y(bool invert);

🔼

camera_config_set_x_sensitivity

Description

Overrides camera X sensitivity

Lua Example

camera_config_set_x_sensitivity(value)

Parameters

Field	Type
value	`integer`

Returns

None

C Prototype

void camera_config_set_x_sensitivity(u32 value);

🔼

camera_config_set_y_sensitivity

Description

Overrides camera Y sensitivity

Lua Example

camera_config_set_y_sensitivity(value)

Parameters

Field	Type
value	`integer`

Returns

None

C Prototype

void camera_config_set_y_sensitivity(u32 value);

🔼

camera_config_set_aggression

Description

Overrides camera aggression

Lua Example

camera_config_set_aggression(value)

Parameters

Field	Type
value	`integer`

Returns

None

C Prototype

void camera_config_set_aggression(u32 value);

🔼

camera_config_set_pan_level

Description

Overrides camera pan level

Lua Example

camera_config_set_pan_level(value)

Parameters

Field	Type
value	`integer`

Returns

None

C Prototype

void camera_config_set_pan_level(u32 value);

🔼

camera_config_set_deceleration

Description

Overrides camera deceleration

Lua Example

camera_config_set_deceleration(value)

Parameters

Field	Type
value	`integer`

Returns

None

C Prototype

void camera_config_set_deceleration(u32 value);

🔼

camera_get_checking_surfaces

Description

Checks if the camera should account for surfaces

Lua Example

local booleanValue = camera_get_checking_surfaces()

Parameters

None

Returns

boolean

C Prototype

bool camera_get_checking_surfaces(void);

🔼

camera_set_checking_surfaces

Description

Sets if the camera should account for surfaces

Lua Example

camera_set_checking_surfaces(value)

Parameters

Field	Type
value	`boolean`

Returns

None

C Prototype

void camera_set_checking_surfaces(bool value);

🔼

center_free_camera

Description

Centers the free camera. This function is designed for rotating the camera to face Mario's facing angle when Free Camera is enabled

Lua Example

center_free_camera()

Parameters

None

Returns

None

C Prototype

void center_free_camera(void);

🔼

---

< prev | 1 | 2 | 3 | 4 | 5 | 6 | 7 | next >]

141 KiB Raw Blame History

functions from object_helpers.c

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

Returns

C Prototype

Description

Lua Example

Parameters

141 KiB

Raw Blame History