functions from object_helpers.c

apply_drag_to_value

Lua Example

apply_drag_to_value(value, dragStrength)

Parameters

Field	Type
value	`Pointer` <`number`>
dragStrength	`number`

Returns

None

C Prototype

void apply_drag_to_value(f32 *value, f32 dragStrength);

approach_f32_signed

Lua Example

local integerValue = approach_f32_signed(value, target, increment)

Parameters

Field	Type
value	`Pointer` <`number`>
target	`number`
increment	`number`

Returns

integer

C Prototype

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

approach_f32_symmetric

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

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);

bhv_dust_smoke_loop

Lua Example

bhv_dust_smoke_loop()

Parameters

None

Returns

None

C Prototype

void bhv_dust_smoke_loop(void);

bhv_init_room

Lua Example

bhv_init_room()

Parameters

None

Returns

None

C Prototype

void bhv_init_room(void);

bit_shift_left

Lua Example

local integerValue = bit_shift_left(a0)

Parameters

Field	Type
a0	`integer`

Returns

integer

C Prototype

s32 bit_shift_left(s32 a0);

chain_segment_init

Lua Example

chain_segment_init(segment)

Parameters

Field	Type
segment	ChainSegment

Returns

None

C Prototype

void chain_segment_init(struct ChainSegment *segment);

clear_move_flag

Lua Example

local integerValue = clear_move_flag(bitSet, flag)

Parameters

Field	Type
bitSet	`Pointer` <`integer`>
flag	`integer`

Returns

integer

C Prototype

s32 clear_move_flag(u32 *bitSet, s32 flag);

clear_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);

count_objects_with_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);

count_unimportant_objects

Lua Example

local integerValue = count_unimportant_objects()

Parameters

None

Returns

integer

C Prototype

s32 count_unimportant_objects(void);

create_transformation_from_matrices

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(Mat4 a0, Mat4 a1, Mat4 a2);

cur_obj_abs_y_dist_to_home

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

Lua Example

local integerValue = cur_obj_advance_looping_anim()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_advance_looping_anim(void);

cur_obj_align_gfx_with_floor

Lua Example

cur_obj_align_gfx_with_floor()

Parameters

None

Returns

None

C Prototype

void cur_obj_align_gfx_with_floor(void);

cur_obj_angle_to_home

Lua Example

local integerValue = cur_obj_angle_to_home()

Parameters

None

Returns

integer

C Prototype

s16 cur_obj_angle_to_home(void);

cur_obj_apply_drag_xz

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_become_intangible

Lua Example

cur_obj_become_intangible()

Parameters

None

Returns

None

C Prototype

void cur_obj_become_intangible(void);

cur_obj_become_tangible

Lua Example

cur_obj_become_tangible()

Parameters

None

Returns

None

C Prototype

void cur_obj_become_tangible(void);

cur_obj_can_mario_activate_textbox

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

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_change_action

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_check_anim_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

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);

cur_obj_check_frame_prior_current_frame

Lua Example

local integerValue = cur_obj_check_frame_prior_current_frame(a0)

Parameters

Field	Type
a0	`Pointer` <`integer`>

Returns

integer

C Prototype

s32 cur_obj_check_frame_prior_current_frame(s16 *a0);

cur_obj_check_grabbed_mario

Lua Example

local integerValue = cur_obj_check_grabbed_mario()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_check_grabbed_mario(void);

cur_obj_check_if_at_animation_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_if_near_animation_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_interacted

Lua Example

local integerValue = cur_obj_check_interacted()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_check_interacted(void);

cur_obj_clear_interact_status_flag

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);

cur_obj_compute_vel_xz

Lua Example

cur_obj_compute_vel_xz()

Parameters

None

Returns

None

C Prototype

void cur_obj_compute_vel_xz(void);

cur_obj_count_objects_with_behavior

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);

cur_obj_detect_steep_floor

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_disable

Lua Example

cur_obj_disable()

Parameters

None

Returns

None

C Prototype

void cur_obj_disable(void);

cur_obj_disable_rendering

Lua Example

cur_obj_disable_rendering()

Parameters

None

Returns

None

C Prototype

void cur_obj_disable_rendering(void);

cur_obj_disable_rendering_and_become_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_dist_to_nearest_object_with_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_enable_rendering

Lua Example

cur_obj_enable_rendering()

Parameters

None

Returns

None

C Prototype

void cur_obj_enable_rendering(void);

cur_obj_enable_rendering_2

Lua Example

cur_obj_enable_rendering_2()

Parameters

None

Returns

None

C Prototype

void cur_obj_enable_rendering_2(void);

cur_obj_enable_rendering_and_become_tangible

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_if_mario_in_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_end_dialog

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_extend_animation_if_at_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_find_nearby_held_actor

Lua Example

local ObjectValue = cur_obj_find_nearby_held_actor(behavior, maxDist)

Parameters

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

Returns

C Prototype

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

cur_obj_find_nearest_object_with_behavior

Lua Example

local ObjectValue = cur_obj_find_nearest_object_with_behavior(behavior, dist)

Parameters

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

Returns

C Prototype

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

cur_obj_find_nearest_pole

Lua Example

local ObjectValue = cur_obj_find_nearest_pole()

Parameters

None

Returns

C Prototype

struct Object* cur_obj_find_nearest_pole(void);

cur_obj_follow_path

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);

cur_obj_forward_vel_approach_upward

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);

cur_obj_get_dropped

Lua Example

cur_obj_get_dropped()

Parameters

None

Returns

None

C Prototype

void cur_obj_get_dropped(void);

cur_obj_get_thrown_or_placed

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_has_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);

cur_obj_has_model

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_hide

Lua Example

cur_obj_hide()

Parameters

None

Returns

None

C Prototype

void cur_obj_hide(void);

cur_obj_hide_if_mario_far_away_y

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);

cur_obj_if_hit_wall_bounce_away

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_init_animation

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_and_anim_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

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

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_init_animation_with_accel_and_sound

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_init_animation_with_sound

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);

cur_obj_is_any_player_on_platform

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_is_mario_ground_pounding_platform

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);

cur_obj_is_mario_on_platform

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_lateral_dist_from_mario_to_home

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_from_obj_to_home

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_to_home

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_mario_far_away

Lua Example

local integerValue = cur_obj_mario_far_away()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_mario_far_away(void);

cur_obj_move_after_thrown_or_dropped

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_move_standard

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_move_up_and_down

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);

cur_obj_move_update_ground_air_flags

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_update_underwater_flags

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_using_fvel_and_gravity

Lua Example

cur_obj_move_using_fvel_and_gravity()

Parameters

None

Returns

None

C Prototype

void cur_obj_move_using_fvel_and_gravity(void);

cur_obj_move_using_vel

Lua Example

cur_obj_move_using_vel()

Parameters

None

Returns

None

C Prototype

void cur_obj_move_using_vel(void);

cur_obj_move_using_vel_and_gravity

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_xz

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_xz_using_fvel_and_yaw

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

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_move_y_and_get_water_level

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_with_terminal_vel

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_nearest_object_with_behavior

Lua Example

local ObjectValue = cur_obj_nearest_object_with_behavior(behavior)

Parameters

Field	Type
behavior	`Pointer` <`BehaviorScript`>

Returns

C Prototype

struct Object *cur_obj_nearest_object_with_behavior(const BehaviorScript *behavior);

cur_obj_outside_home_rectangle

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_outside_home_square

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_push_mario_away

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

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);

cur_obj_reflect_move_angle_off_wall

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_reset_timer_and_subaction

Lua Example

cur_obj_reset_timer_and_subaction()

Parameters

None

Returns

None

C Prototype

void cur_obj_reset_timer_and_subaction(void);

cur_obj_resolve_wall_collisions

Lua Example

local integerValue = cur_obj_resolve_wall_collisions()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_resolve_wall_collisions(void);

cur_obj_reverse_animation

Lua Example

cur_obj_reverse_animation()

Parameters

None

Returns

None

C Prototype

void cur_obj_reverse_animation(void);

cur_obj_rotate_face_angle_using_vel

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_rotate_move_angle_using_vel

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_yaw_toward

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);

cur_obj_scale

Lua Example

cur_obj_scale(scale)

Parameters

Field	Type
scale	`number`

Returns

None

C Prototype

void cur_obj_scale(f32 scale);

cur_obj_scale_over_time

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_behavior

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);

cur_obj_set_billboard_if_vanilla_cam

Lua Example

cur_obj_set_billboard_if_vanilla_cam()

Parameters

None

Returns

None

C Prototype

void cur_obj_set_billboard_if_vanilla_cam(void);

cur_obj_set_face_angle_to_move_angle

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_set_hitbox_and_die_if_attacked

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);

cur_obj_set_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_home_once

Lua Example

cur_obj_set_home_once()

Parameters

None

Returns

None

C Prototype

void cur_obj_set_home_once(void);

cur_obj_set_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);

cur_obj_set_pos_relative

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

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_set_pos_to_home

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

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_set_pos_to_home_with_debug

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);

cur_obj_set_pos_via_transform

Lua Example

cur_obj_set_pos_via_transform()

Parameters

None

Returns

None

C Prototype

void cur_obj_set_pos_via_transform(void);

cur_obj_set_vel_from_mario_vel

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_set_y_vel_and_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_shake_screen

Lua Example

cur_obj_shake_screen(shake)

Parameters

Field	Type
shake	`integer`

Returns

None

C Prototype

void cur_obj_shake_screen(s32 shake);

cur_obj_shake_y

Lua Example

cur_obj_shake_y(amount)

Parameters

Field	Type
amount	`number`

Returns

None

C Prototype

void cur_obj_shake_y(f32 amount);

cur_obj_shake_y_until

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_spawn_loot_blue_coin

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_loot_coin_at_mario_pos

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_spawn_particles

Lua Example

cur_obj_spawn_particles(info)

Parameters

Field	Type
info	SpawnParticlesInfo

Returns

None

C Prototype

void cur_obj_spawn_particles(struct SpawnParticlesInfo *info);

cur_obj_spawn_star_at_y_offset

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_start_cam_event

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);

cur_obj_unhide

Lua Example

cur_obj_unhide()

Parameters

None

Returns

None

C Prototype

void cur_obj_unhide(void);

cur_obj_unrender_and_reset_state

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_unused_init_on_floor

Lua Example

cur_obj_unused_init_on_floor()

Parameters

None

Returns

None

C Prototype

void cur_obj_unused_init_on_floor(void);

cur_obj_unused_play_footstep_sound

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);

cur_obj_unused_resolve_wall_collisions

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);

cur_obj_update_floor

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

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

Lua Example

cur_obj_update_floor_and_walls()

Parameters

None

Returns

None

C Prototype

void cur_obj_update_floor_and_walls(void);

cur_obj_update_floor_height

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

Lua Example

local SurfaceValue = cur_obj_update_floor_height_and_get_floor()

Parameters

None

Returns

C Prototype

struct Surface *cur_obj_update_floor_height_and_get_floor(void);

cur_obj_wait_then_blink

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_was_attacked_or_ground_pounded

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);

cur_obj_within_12k_bounds

Lua Example

local integerValue = cur_obj_within_12k_bounds()

Parameters

None

Returns

integer

C Prototype

s32 cur_obj_within_12k_bounds(void);

disable_time_stop

Lua Example

disable_time_stop()

Parameters

None

Returns

None

C Prototype

void disable_time_stop(void);

disable_time_stop_including_mario

Lua Example

disable_time_stop_including_mario()

Parameters

None

Returns

None

C Prototype

void disable_time_stop_including_mario(void);

dist_between_object_and_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);

dist_between_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);

enable_time_stop

Lua Example

enable_time_stop()

Parameters

None

Returns

None

C Prototype

void enable_time_stop(void);

enable_time_stop_if_alone

Lua Example

enable_time_stop_if_alone()

Parameters

None

Returns

None

C Prototype

void enable_time_stop_if_alone(void);

enable_time_stop_including_mario

Lua Example

enable_time_stop_including_mario()

Parameters

None

Returns

None

C Prototype

void enable_time_stop_including_mario(void);

find_object_with_behavior

Lua Example

local ObjectValue = find_object_with_behavior(behavior)

Parameters

Field	Type
behavior	`Pointer` <`BehaviorScript`>

Returns

C Prototype

struct Object *find_object_with_behavior(const BehaviorScript *behavior);

find_unimportant_object

Lua Example

local ObjectValue = find_unimportant_object()

Parameters

None

Returns

C Prototype

struct Object *find_unimportant_object(void);

geo_offset_klepto_debug

Lua Example

local integerValue = geo_offset_klepto_debug(callContext, a1, sp8)

Parameters

Field	Type
callContext	`integer`
a1	GraphNode
sp8	`integer`

Returns

integer

C Prototype

s32 geo_offset_klepto_debug(s32 callContext, struct GraphNode *a1, UNUSED s32 sp8);

get_object_list_from_behavior

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);

get_trajectory_length

Lua Example

local integerValue = get_trajectory_length(trajectory)

Parameters

Field	Type
trajectory	`Pointer` <`Trajectory`>

Returns

integer

C Prototype

s32 get_trajectory_length(Trajectory* trajectory);

increment_velocity_toward_range

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);

is_item_in_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);

is_mario_moving_fast_or_in_air

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);

lateral_dist_between_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);

linear_mtxf_mul_vec3f

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, Vec3f dst, Vec3f v);

linear_mtxf_transpose_mul_vec3f

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, Vec3f dst, Vec3f v);

mario_is_dive_sliding

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);

mario_is_in_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_within_rectangle

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);

mario_set_flag

Lua Example

mario_set_flag(flag)

Parameters

Field	Type
flag	`integer`

Returns

None

C Prototype

void mario_set_flag(s32 flag);

obj_angle_to_object

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_angle_to_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_apply_scale_to_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, Mat4 dst, Mat4 src);

obj_apply_scale_to_transform

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_attack_collided_from_other_object

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);

obj_become_tangible

Lua Example

obj_become_tangible(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_become_tangible(struct Object *obj);

obj_build_relative_transform

Lua Example

obj_build_relative_transform(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_build_relative_transform(struct Object *obj);

obj_build_transform_from_pos_and_angle

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_build_transform_relative_to_parent

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_build_vel_from_transform

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);

obj_check_if_collided_with_object

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);

obj_copy_angle

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_copy_behavior_params

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);

obj_copy_graph_y_offset

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

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_pos_and_angle

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_scale

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_create_transform_from_self

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);

obj_explode_and_spawn_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);

obj_has_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);

obj_init_animation

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);

obj_init_animation_with_accel_and_sound

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);

obj_init_animation_with_sound

Lua Example

obj_init_animation_with_sound(obj, animations, animIndex)

Parameters

Field	Type
obj	Object
animations	AnimationTable
animIndex	`integer`

Returns

None

C Prototype

void obj_init_animation_with_sound(struct Object *obj, const struct AnimationTable* animations, s32 animIndex);

obj_is_hidden

Lua Example

local integerValue = obj_is_hidden(obj)

Parameters

Field	Type
obj	Object

Returns

integer

C Prototype

s32 obj_is_hidden(struct Object *obj);

obj_mark_for_deletion

Lua Example

obj_mark_for_deletion(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_mark_for_deletion(struct Object *obj);

obj_pitch_to_object

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_scale

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);

obj_scale_random

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_scale_xyz

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_set_angle

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_behavior

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);

obj_set_billboard

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

Lua Example

obj_set_cylboard(obj)

Parameters

Field	Type
obj	Object

Returns

None

C Prototype

void obj_set_cylboard(struct Object *obj);

obj_set_face_angle

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_face_angle_to_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);

obj_set_gfx_angle

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

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_pos_at_obj_pos

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_set_gfx_pos_from_pos

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_set_gfx_scale

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);

obj_set_held_state

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);

obj_set_hitbox

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);

obj_set_hitbox_radius_and_height

Lua Example

obj_set_hitbox_radius_and_height(o, radius, height)

Parameters

Field	Type
o	Object
radius	`number`
height	`number`

Returns

None

C Prototype

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

obj_set_hurtbox_radius_and_height

Lua Example

obj_set_hurtbox_radius_and_height(o, radius, height)

Parameters

Field	Type
o	Object
radius	`number`
height	`number`

Returns

None

C Prototype

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

obj_set_move_angle

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_parent_relative_pos

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

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_pos_relative

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);

obj_set_throw_matrix_from_transform

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_spawn_loot_blue_coins

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_coins

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_yellow_coins

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);

obj_translate_local

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_translate_xyz_random

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

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_turn_toward_object

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_update_pos_from_parent_transformation

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);

player_performed_grab_escape_action

Lua Example

local integerValue = player_performed_grab_escape_action()

Parameters

None

Returns

integer

C Prototype

s32 player_performed_grab_escape_action(void);

random_f32_around_zero

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);

set_mario_interact_hoot_if_in_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);

set_room_override

Lua Example

set_room_override(room)

Parameters

Field	Type
room	`integer`

Returns

None

C Prototype

void set_room_override(s16 room);

set_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

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);

signum_positive

Lua Example

local integerValue = signum_positive(x)

Parameters

Field	Type
x	`integer`

Returns

integer

C Prototype

s32 signum_positive(s32 x);

spawn_base_star_with_no_lvl_exit

Lua Example

spawn_base_star_with_no_lvl_exit()

Parameters

None

Returns

None

C Prototype

void spawn_base_star_with_no_lvl_exit(void);

spawn_mist_particles

Lua Example

spawn_mist_particles()

Parameters

None

Returns

None

C Prototype

void spawn_mist_particles(void);

spawn_mist_particles_with_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);

spawn_star_with_no_lvl_exit

Lua Example

local ObjectValue = spawn_star_with_no_lvl_exit(sp20, sp24)

Parameters

Field	Type
sp20	`integer`
sp24	`integer`

Returns

C Prototype

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

spawn_water_droplet

Lua Example

local ObjectValue = spawn_water_droplet(parent, params)

Parameters

Field	Type
parent	Object
params	WaterDropletParams

Returns

C Prototype

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

stub_obj_helpers_3

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);

stub_obj_helpers_4

Lua Example

stub_obj_helpers_4()

Parameters

None

Returns

None

C Prototype

void stub_obj_helpers_4(void);

functions from object_list_processor.h

set_object_respawn_info_bits

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 rumble_init.c

queue_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_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);

queue_rumble_data_object

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);

reset_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

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

save_file_clear_flags

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_do_save

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

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

Lua Example

save_file_erase_current_backup_save()

Parameters

None

Returns

None

C Prototype

void save_file_erase_current_backup_save(void);

save_file_get_cap_pos

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(Vec3s capPos);

save_file_get_course_coin_score

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_get_course_star_count

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_flags

Lua Example

local integerValue = save_file_get_flags()

Parameters

None

Returns

integer

C Prototype

u32 save_file_get_flags(void);

save_file_get_max_coin_score

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_sound_mode

Lua Example

local integerValue = save_file_get_sound_mode()

Parameters

None

Returns

integer

C Prototype

u16 save_file_get_sound_mode(void);

save_file_get_star_flags

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_get_total_star_count

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_is_cannon_unlocked

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_reload

Lua Example

save_file_reload(load_all)

Parameters

Field	Type
load_all	`integer`

Returns

None

C Prototype

void save_file_reload(u8 load_all);

save_file_remove_star_flags

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_set_course_coin_score

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_set_flags

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_set_star_flags

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);

touch_coin_score_age

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);

functions from seqplayer.h

sequence_player_get_tempo

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_get_tempo_acc

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_get_transposition

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_tempo

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_set_tempo_acc

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_set_transposition

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);

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_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);

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);

functions from smlua_audio_utils.h

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_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_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);

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_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_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_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_get_position

Description

Gets the position of an audio stream

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_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_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_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_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_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_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_position

Description

Sets the position of an audio stream

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_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_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);

smlua_audio_utils_replace_sequence

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_reset_all

Lua Example

smlua_audio_utils_reset_all()

Parameters

None

Returns

None

C Prototype

void smlua_audio_utils_reset_all(void);

functions from smlua_camera_utils.h

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_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_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_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_get_aggression

Lua Example

local integerValue = camera_config_get_aggression()

Parameters

None

Returns

integer

C Prototype

u32 camera_config_get_aggression(void);

camera_config_get_deceleration

Lua Example

local integerValue = camera_config_get_deceleration()

Parameters

None

Returns

integer

C Prototype

u32 camera_config_get_deceleration(void);

camera_config_get_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_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

Lua Example

local integerValue = camera_config_get_y_sensitivity()

Parameters

None

Returns

integer

C Prototype

u32 camera_config_get_y_sensitivity(void);

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_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_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_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_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_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_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_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_freeze

Description

Freezes the camera by not updating it

Lua Example

camera_freeze()

Parameters

None

Returns

None

C Prototype

void camera_freeze(void);

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_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_reset_overrides

Description

Resets camera config overrides

Lua Example

camera_reset_overrides()

Parameters

None

Returns

None

C Prototype

void camera_reset_overrides(void);

camera_romhack_allow_centering

Description

Sets if the romhack camera should allow centering

Lua Example

camera_romhack_allow_centering(allow)

Parameters

Field	Type
allow	`integer`

Returns

None

C Prototype

void camera_romhack_allow_centering(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_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);

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_unfreeze

Description

Unfreezes the camera

Lua Example

camera_unfreeze()

Parameters

None

Returns

None

C Prototype

void camera_unfreeze(void);

functions from smlua_collision_utils.h

collision_find_ceil

Description

Finds a potential ceiling at the given x, y, and z values

Lua Example

local SurfaceValue = collision_find_ceil(x, y, z)

Parameters

Field	Type
x	`number`
y	`number`
z	`number`

Returns

C Prototype

struct Surface* collision_find_ceil(f32 x, f32 y, f32 z);

collision_find_floor

Description

Finds a potential floor at the given x, y, and z values

Lua Example

local SurfaceValue = collision_find_floor(x, y, z)

Parameters

Field	Type
x	`number`
y	`number`
z	`number`

Returns

C Prototype

struct Surface* collision_find_floor(f32 x, f32 y, f32 z);

collision_get_temp_wall_collision_data

Description

Returns a temporary wall collision data pointer

Lua Example

local WallCollisionDataValue = collision_get_temp_wall_collision_data()

Parameters

None

Returns

WallCollisionData

C Prototype

struct WallCollisionData* collision_get_temp_wall_collision_data(void);

get_surface_from_wcd_index

Description

Gets the surface corresponding to index from wcd

Lua Example

local SurfaceValue = get_surface_from_wcd_index(wcd, index)

Parameters

Field	Type
wcd	WallCollisionData
index	`integer`

Returns

C Prototype

struct Surface* get_surface_from_wcd_index(struct WallCollisionData* wcd, s8 index);

get_water_surface_pseudo_floor

Description

Finds a potential ceiling at the given x, y, and z values

Lua Example

local SurfaceValue = get_water_surface_pseudo_floor()

Parameters

None

Returns

C Prototype

struct Surface* get_water_surface_pseudo_floor(void);

smlua_collision_util_find_surface_types

Description

Gets a table of the surface types from data

Lua Example

smlua_collision_util_find_surface_types(data)

Parameters

Field	Type
data	`Pointer` <`Collision`>

Returns

None

C Prototype

void smlua_collision_util_find_surface_types(Collision* data);

smlua_collision_util_get

Description

Gets the Collision with name

Lua Example

local PointerValue = smlua_collision_util_get(name)

Parameters

Field	Type
name	`string`

Returns

Pointer <Collision>

C Prototype

Collision* smlua_collision_util_get(const char* name);

smlua_collision_util_get_current_terrain_collision

Description

Gets the current level terrain collision

Lua Example

local PointerValue = smlua_collision_util_get_current_terrain_collision()

Parameters

None

Returns

Pointer <Collision>

C Prototype

Collision* smlua_collision_util_get_current_terrain_collision(void);

smlua_collision_util_get_level_collision

Description

Gets the level terrain collision from area

Lua Example

local PointerValue = smlua_collision_util_get_level_collision(level, area)

Parameters

Field	Type
level	`integer`
area	`integer`

Returns

Pointer <Collision>

C Prototype

Collision *smlua_collision_util_get_level_collision(u32 level, u16 area);

functions from smlua_deprecated.h

functions from smlua_gfx_utils.h

get_fog_color

Description

Gets a value of the global fog color

Lua Example

local integerValue = get_fog_color(index)

Parameters

Field	Type
index	`integer`

Returns

integer

C Prototype

u8 get_fog_color(u8 index);

get_fog_intensity

Description

Gets the intensity of the fog

Lua Example

local numberValue = get_fog_intensity()

Parameters

None

Returns

number

C Prototype

f32 get_fog_intensity(void);

get_lighting_color

Description

Gets a value of the global lighting color

Lua Example

local integerValue = get_lighting_color(index)

Parameters

Field	Type
index	`integer`

Returns

integer

C Prototype

u8 get_lighting_color(u8 index);

get_lighting_color_ambient

Description

Gets a value of the global ambient lighting color

Lua Example

local integerValue = get_lighting_color_ambient(index)

Parameters

Field	Type
index	`integer`

Returns

integer

C Prototype

u8 get_lighting_color_ambient(u8 index);

get_lighting_dir

Description

Gets a value of the global lighting direction

Lua Example

local numberValue = get_lighting_dir(index)

Parameters

Field	Type
index	`integer`

Returns

number

C Prototype

f32 get_lighting_dir(u8 index);

get_skybox

Description

Gets the current skybox

Lua Example

local integerValue = get_skybox()

Parameters

None

Returns

integer

C Prototype

s8 get_skybox(void);

get_skybox_color

Description

Gets a value of the global skybox color

Lua Example

local integerValue = get_skybox_color(index)

Parameters

Field	Type
index	`integer`

Returns

integer

C Prototype

u8 get_skybox_color(u8 index);

get_vertex_color

Description

Gets a value of the global vertex shading color

Lua Example

local integerValue = get_vertex_color(index)

Parameters

Field	Type
index	`integer`

Returns

integer

C Prototype

u8 get_vertex_color(u8 index);

set_fog_color

Description

Sets a value of the global fog color

Lua Example

set_fog_color(index, value)

Parameters

Field	Type
index	`integer`
value	`integer`

Returns

None

C Prototype

void set_fog_color(u8 index, u8 value);

set_fog_intensity

Description

Sets the intensity of the fog (this value scales very quickly, 1.0 to 1.1 is a desirable range)

Lua Example

set_fog_intensity(intensity)

Parameters

Field	Type
intensity	`number`

Returns

None

C Prototype

void set_fog_intensity(f32 intensity);

set_lighting_color

Description

Sets a value of the global lighting color

Lua Example

set_lighting_color(index, value)

Parameters

Field	Type
index	`integer`
value	`integer`

Returns

None

C Prototype

void set_lighting_color(u8 index, u8 value);

set_lighting_color_ambient

Description

Sets a value of the global lighting color (run this after set_lighting_color for the ambient color to not be overriden)

Lua Example

set_lighting_color_ambient(index, value)

Parameters

Field	Type
index	`integer`
value	`integer`

Returns

None

C Prototype

void set_lighting_color_ambient(u8 index, u8 value);

set_lighting_dir

Description

Sets a value of the global lighting direction

Lua Example

set_lighting_dir(index, value)

Parameters

Field	Type
index	`integer`
value	`number`

Returns

None

C Prototype

void set_lighting_dir(u8 index, f32 value);

set_override_far

Description

Sets the override far plane

Lua Example

set_override_far(far)

Parameters

Field	Type
far	`number`

Returns

None

C Prototype

void set_override_far(f32 far);

set_override_fov

Description

Sets the override FOV

Lua Example

set_override_fov(fov)

Parameters

Field	Type
fov	`number`

Returns

None

C Prototype

void set_override_fov(f32 fov);

set_override_near

Description

Sets the override near plane

Lua Example

set_override_near(near)

Parameters

Field	Type
near	`number`

Returns

None

C Prototype

void set_override_near(f32 near);

set_override_skybox

Description

Sets the override skybox

Lua Example

set_override_skybox(background)

Parameters

Field	Type
background	`integer`

Returns

None

C Prototype

void set_override_skybox(s8 background);

set_skybox_color

Description

Sets a value of the global skybox color

Lua Example

set_skybox_color(index, value)

Parameters

Field	Type
index	`integer`
value	`integer`

Returns

None

C Prototype

void set_skybox_color(u8 index, u8 value);

set_vertex_color

Description

Sets a value of the global vertex shading color

Lua Example

set_vertex_color(index, value)

Parameters

Field	Type
index	`integer`
value	`integer`

Returns

None

C Prototype

void set_vertex_color(u8 index, u8 value);

functions from smlua_level_utils.h

level_is_vanilla_level

Description

Checks if levelNum is a vanilla level

Lua Example

local booleanValue = level_is_vanilla_level(levelNum)

Parameters

Field	Type
levelNum	`integer`

Returns

boolean

C Prototype

bool level_is_vanilla_level(s16 levelNum);

level_register

Description

Registers a fully custom level. Level ID begins at 50

Lua Example

local integerValue = level_register(scriptEntryName, courseNum, fullName, shortName, acousticReach, echoLevel1, echoLevel2, echoLevel3)

Parameters

Field	Type
scriptEntryName	`string`
courseNum	`integer`
fullName	`string`
shortName	`string`
acousticReach	`integer`
echoLevel1	`integer`
echoLevel2	`integer`
echoLevel3	`integer`

Returns

integer

C Prototype

s16 level_register(const char* scriptEntryName, s16 courseNum, const char* fullName, const char* shortName, u32 acousticReach, u32 echoLevel1, u32 echoLevel2, u32 echoLevel3);

smlua_level_util_change_area

Description

Instantly changes the current area to areaIndex

Lua Example

smlua_level_util_change_area(areaIndex)

Parameters

Field	Type
areaIndex	`integer`

Returns

None

C Prototype

void smlua_level_util_change_area(s32 areaIndex);

smlua_level_util_get_info

Description

Gets information on a custom level from levelNum

Lua Example

local CustomLevelInfoValue = smlua_level_util_get_info(levelNum)

Parameters

Field	Type
levelNum	`integer`

Returns

CustomLevelInfo

C Prototype

struct CustomLevelInfo* smlua_level_util_get_info(s16 levelNum);

smlua_level_util_get_info_from_course_num

Description

Gets information on a custom level from courseNum

Lua Example

local CustomLevelInfoValue = smlua_level_util_get_info_from_course_num(courseNum)

Parameters

Field	Type
courseNum	`integer`

Returns

CustomLevelInfo

C Prototype

struct CustomLevelInfo* smlua_level_util_get_info_from_course_num(u8 courseNum);

smlua_level_util_get_info_from_short_name

Description

Gets information on a custom level from shortName

Lua Example

local CustomLevelInfoValue = smlua_level_util_get_info_from_short_name(shortName)

Parameters

Field	Type
shortName	`string`

Returns

CustomLevelInfo

C Prototype

struct CustomLevelInfo* smlua_level_util_get_info_from_short_name(const char* shortName);

warp_exit_level

Description

Exits the current level after aDelay

Lua Example

local booleanValue = warp_exit_level(aDelay)

Parameters

Field	Type
aDelay	`integer`

Returns

boolean

C Prototype

bool warp_exit_level(s32 aDelay);

warp_restart_level

Description

Restarts the current level

Lua Example

local booleanValue = warp_restart_level()

Parameters

None

Returns

boolean

C Prototype

bool warp_restart_level(void);

warp_to_castle

Description

Warps back to the castle from aLevel

Lua Example

local booleanValue = warp_to_castle(aLevel)

Parameters

Field	Type
aLevel	`integer`

Returns

boolean

C Prototype

bool warp_to_castle(s32 aLevel);

warp_to_level

Description

Warps to aArea of aLevel in aAct

Lua Example

local booleanValue = warp_to_level(aLevel, aArea, aAct)

Parameters

Field	Type
aLevel	`integer`
aArea	`integer`
aAct	`integer`

Returns

boolean

C Prototype

bool warp_to_level(s32 aLevel, s32 aArea, s32 aAct);

warp_to_start_level

Description

Warps to the start level (Castle Grounds by default)

Lua Example

local booleanValue = warp_to_start_level()

Parameters

None

Returns

boolean

C Prototype

bool warp_to_start_level(void);

warp_to_warpnode

Description

Warps to aWarpId of aArea in aLevel during aAct

Lua Example

local booleanValue = warp_to_warpnode(aLevel, aArea, aAct, aWarpId)

Parameters

Field	Type
aLevel	`integer`
aArea	`integer`
aAct	`integer`
aWarpId	`integer`

Returns

boolean

C Prototype

bool warp_to_warpnode(s32 aLevel, s32 aArea, s32 aAct, s32 aWarpId);

functions from smlua_math_utils.h

clamp

Description

Clamps a signed 32-bit integer a between bounds b (minimum) and c (maximum)

Lua Example

local integerValue = clamp(a, b, c)

Parameters

Field	Type
a	`integer`
b	`integer`
c	`integer`

Returns

integer

C Prototype

s32 clamp(s32 a, s32 b, s32 c);

clampf

Description

Clamps a floating-point number a between bounds b (minimum) and c (maximum)

Lua Example

local numberValue = clampf(a, b, c)

Parameters

Field	Type
a	`number`
b	`number`
c	`number`

Returns

number

C Prototype

f32 clampf(f32 a, f32 b, f32 c);

degrees_to_sm64

Description

Converts an angle from degrees to SM64 format

Lua Example

local integerValue = degrees_to_sm64(degreesAngle)

Parameters

Field	Type
degreesAngle	`number`

Returns

integer

C Prototype

s16 degrees_to_sm64(f32 degreesAngle);

hypotf

Description

Computes the hypotenuse of a right triangle given sides a and b using the Pythagorean theorem

Lua Example

local numberValue = hypotf(a, b)

Parameters

Field	Type
a	`number`
b	`number`

Returns

number

C Prototype

f32 hypotf(f32 a, f32 b);

max

Description

Finds the maximum of two signed 32-bit integers

Lua Example

local integerValue = max(a, b)

Parameters

Field	Type
a	`integer`
b	`integer`

Returns

integer

C Prototype

s32 max(s32 a, s32 b);

maxf

Description

Finds the maximum of two floating-point numbers

Lua Example

local numberValue = maxf(a, b)

Parameters

Field	Type
a	`number`
b	`number`

Returns

number

C Prototype

f32 maxf(f32 a, f32 b);

min

Description

Finds the minimum of two signed 32-bit integers

Lua Example

local integerValue = min(a, b)

Parameters

Field	Type
a	`integer`
b	`integer`

Returns

integer

C Prototype

s32 min(s32 a, s32 b);

minf

Description

Finds the minimum of two floating-point numbers

Lua Example

local numberValue = minf(a, b)

Parameters

Field	Type
a	`number`
b	`number`

Returns

number

C Prototype

f32 minf(f32 a, f32 b);

radians_to_sm64

Description

Converts an angle from radians to SM64 format

Lua Example

local integerValue = radians_to_sm64(radiansAngle)

Parameters

Field	Type
radiansAngle	`number`

Returns

integer

C Prototype

s16 radians_to_sm64(f32 radiansAngle);

sm64_to_degrees

Description

Converts an angle from SM64 format to degrees

Lua Example

local numberValue = sm64_to_degrees(sm64Angle)

Parameters

Field	Type
sm64Angle	`integer`

Returns

number

C Prototype

f32 sm64_to_degrees(s16 sm64Angle);

sm64_to_radians

Description

Converts an angle from SM64 format to radians

Lua Example

local numberValue = sm64_to_radians(sm64Angle)

Parameters

Field	Type
sm64Angle	`integer`

Returns

number

C Prototype

f32 sm64_to_radians(s16 sm64Angle);

sqr

Description

Computes the square of a signed 32-bit integer

Lua Example

local integerValue = sqr(x)

Parameters

Field	Type
x	`integer`

Returns

integer

C Prototype

s32 sqr(s32 x);

sqrf

Description

Computes the square of a floating-point number

Lua Example

local numberValue = sqrf(x)

Parameters

Field	Type
x	`number`

Returns

number

C Prototype

f32 sqrf(f32 x);