114 KiB
⏪ Lua Functions
functions from object_helpers.c
abs_angle_diff
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);
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);
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_progress_direction_table
Lua Example
local integerValue = cur_obj_progress_direction_table()
Parameters
- None
Returns
integer
C Prototype
s32 cur_obj_progress_direction_table(void);
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_direction_table
Lua Example
local integerValue = cur_obj_set_direction_table(a0)
Parameters
| Field | Type |
|---|---|
| a0 | Pointer <integer> |
Returns
integer
C Prototype
s32 cur_obj_set_direction_table(s8 *a0);
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_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);
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);
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_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_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_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_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_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_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);
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_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_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_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);
functions from smlua_audio_utils.h
audio_sample_destroy
Lua Example
audio_sample_destroy(audio)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
Returns
- None
C Prototype
void audio_sample_destroy(struct BassAudio* audio);
audio_sample_load
Lua Example
local BassAudioValue = audio_sample_load(filename)
Parameters
| Field | Type |
|---|---|
| filename | string |
Returns
C Prototype
struct BassAudio* audio_sample_load(const char* filename);
audio_sample_play
Lua Example
audio_sample_play(audio, position, volume)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
| position | Vec3f |
| volume | number |
Returns
- None
C Prototype
void audio_sample_play(struct BassAudio* audio, Vec3f position, f32 volume);
audio_stream_destroy
Lua Example
audio_stream_destroy(audio)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
Returns
- None
C Prototype
void audio_stream_destroy(struct BassAudio* audio);
audio_stream_get_frequency
Lua Example
local numberValue = audio_stream_get_frequency(audio)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
Returns
number
C Prototype
f32 audio_stream_get_frequency(struct BassAudio* audio);
audio_stream_get_looping
Lua Example
local booleanValue = audio_stream_get_looping(audio)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
Returns
boolean
C Prototype
bool audio_stream_get_looping(struct BassAudio* audio);
audio_stream_get_position
Lua Example
local numberValue = audio_stream_get_position(audio)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
Returns
number
C Prototype
f32 audio_stream_get_position(struct BassAudio* audio);
audio_stream_get_tempo
Lua Example
local numberValue = audio_stream_get_tempo(audio)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
Returns
number
C Prototype
f32 audio_stream_get_tempo(struct BassAudio* audio);
audio_stream_get_volume
Lua Example
local numberValue = audio_stream_get_volume(audio)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
Returns
number
C Prototype
f32 audio_stream_get_volume(struct BassAudio* audio);
audio_stream_load
Lua Example
local BassAudioValue = audio_stream_load(filename)
Parameters
| Field | Type |
|---|---|
| filename | string |
Returns
C Prototype
struct BassAudio* audio_stream_load(const char* filename);
audio_stream_pause
Lua Example
audio_stream_pause(audio)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
Returns
- None
C Prototype
void audio_stream_pause(struct BassAudio* audio);
audio_stream_play
Lua Example
audio_stream_play(audio, restart, volume)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
| restart | boolean |
| volume | number |
Returns
- None
C Prototype
void audio_stream_play(struct BassAudio* audio, bool restart, f32 volume);
audio_stream_set_frequency
Lua Example
audio_stream_set_frequency(audio, freq)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
| freq | number |
Returns
- None
C Prototype
void audio_stream_set_frequency(struct BassAudio* audio, f32 freq);
audio_stream_set_looping
Lua Example
audio_stream_set_looping(audio, looping)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
| looping | boolean |
Returns
- None
C Prototype
void audio_stream_set_looping(struct BassAudio* audio, bool looping);
audio_stream_set_position
Lua Example
audio_stream_set_position(audio, pos)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
| pos | number |
Returns
- None
C Prototype
void audio_stream_set_position(struct BassAudio* audio, f32 pos);
audio_stream_set_speed
Lua Example
audio_stream_set_speed(audio, initial_freq, speed, pitch)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
| initial_freq | number |
| speed | number |
| pitch | boolean |
Returns
- None
C Prototype
void audio_stream_set_speed(struct BassAudio* audio, f32 initial_freq, f32 speed, bool pitch);
audio_stream_set_tempo
Lua Example
audio_stream_set_tempo(audio, tempo)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
| tempo | number |
Returns
- None
C Prototype
void audio_stream_set_tempo(struct BassAudio* audio, f32 tempo);
audio_stream_set_volume
Lua Example
audio_stream_set_volume(audio, volume)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
| volume | number |
Returns
- None
C Prototype
void audio_stream_set_volume(struct BassAudio* audio, f32 volume);
audio_stream_stop
Lua Example
audio_stream_stop(audio)
Parameters
| Field | Type |
|---|---|
| audio | BassAudio |
Returns
- None
C Prototype
void audio_stream_stop(struct BassAudio* 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_collision_utils.h
collision_find_surface_on_ray
Lua Example
local RayIntersectionInfoValue = collision_find_surface_on_ray(startX, startY, startZ, endX, endY, endZ)
Parameters
| Field | Type |
|---|---|
| startX | number |
| startY | number |
| startZ | number |
| endX | number |
| endY | number |
| endZ | number |
Returns
C Prototype
struct RayIntersectionInfo* collision_find_surface_on_ray(f32 startX, f32 startY, f32 startZ, f32 endX, f32 endY, f32 endZ);
get_water_surface_pseudo_floor
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_get
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);
functions from smlua_misc_utils.h
allocate_mario_action
Lua Example
local integerValue = allocate_mario_action(actFlags)
Parameters
| Field | Type |
|---|---|
| actFlags | integer |
Returns
integer
C Prototype
u32 allocate_mario_action(u32 actFlags);
camera_freeze
Lua Example
camera_freeze()
Parameters
- None
Returns
- None
C Prototype
void camera_freeze(void);
camera_unfreeze
Lua Example
camera_unfreeze()
Parameters
- None
Returns
- None
C Prototype
void camera_unfreeze(void);
deref_s32_pointer
Lua Example
local integerValue = deref_s32_pointer(pointer)
Parameters
| Field | Type |
|---|---|
| pointer | Pointer <integer> |
Returns
integer
C Prototype
s32 deref_s32_pointer(s32* pointer);
get_current_save_file_num
Lua Example
local integerValue = get_current_save_file_num()
Parameters
- None
Returns
integer
C Prototype
s16 get_current_save_file_num(void);
get_environment_region
Lua Example
local numberValue = get_environment_region(index)
Parameters
| Field | Type |
|---|---|
| index | integer |
Returns
number
C Prototype
f32 get_environment_region(u8 index);
get_hand_foot_pos_x
Lua Example
local numberValue = get_hand_foot_pos_x(m, index)
Parameters
| Field | Type |
|---|---|
| m | MarioState |
| index | integer |
Returns
number
C Prototype
f32 get_hand_foot_pos_x(struct MarioState* m, u8 index);
get_hand_foot_pos_y
Lua Example
local numberValue = get_hand_foot_pos_y(m, index)
Parameters
| Field | Type |
|---|---|
| m | MarioState |
| index | integer |
Returns
number
C Prototype
f32 get_hand_foot_pos_y(struct MarioState* m, u8 index);
get_hand_foot_pos_z
Lua Example
local numberValue = get_hand_foot_pos_z(m, index)
Parameters
| Field | Type |
|---|---|
| m | MarioState |
| index | integer |
Returns
number
C Prototype
f32 get_hand_foot_pos_z(struct MarioState* m, u8 index);
get_network_area_timer
Lua Example
local integerValue = get_network_area_timer()
Parameters
- None
Returns
integer
C Prototype
u32 get_network_area_timer(void);
get_temp_s32_pointer
Lua Example
local PointerValue = get_temp_s32_pointer(initialValue)
Parameters
| Field | Type |
|---|---|
| initialValue | integer |
Returns
Pointer<integer>
C Prototype
s32* get_temp_s32_pointer(s32 initialValue);
hud_get_value
Lua Example
local integerValue = hud_get_value(type)
Parameters
| Field | Type |
|---|---|
| type | enum HudDisplayValue |
Returns
integer
C Prototype
s32 hud_get_value(enum HudDisplayValue type);
hud_hide
Lua Example
hud_hide()
Parameters
- None
Returns
- None
C Prototype
void hud_hide(void);
hud_render_power_meter
Lua Example
hud_render_power_meter(health, x, y, width, height)
Parameters
| Field | Type |
|---|---|
| health | integer |
| x | number |
| y | number |
| width | number |
| height | number |
Returns
- None
C Prototype
void hud_render_power_meter(s32 health, f32 x, f32 y, f32 width, f32 height);
hud_set_value
Lua Example
hud_set_value(type, value)
Parameters
| Field | Type |
|---|---|
| type | enum HudDisplayValue |
| value | integer |
Returns
- None
C Prototype
void hud_set_value(enum HudDisplayValue type, s32 value);
hud_show
Lua Example
hud_show()
Parameters
- None
Returns
- None
C Prototype
void hud_show(void);
is_game_paused
Lua Example
local booleanValue = is_game_paused()
Parameters
- None
Returns
boolean
C Prototype
bool is_game_paused(void);
movtexqc_register
Lua Example
movtexqc_register(name, level, area, type)
Parameters
| Field | Type |
|---|---|
| name | string |
| level | integer |
| area | integer |
| type | integer |
Returns
- None
C Prototype
void movtexqc_register(const char* name, s16 level, s16 area, s16 type);
play_transition
Lua Example
play_transition(transType, time, red, green, blue)
Parameters
| Field | Type |
|---|---|
| transType | integer |
| time | integer |
| red | integer |
| green | integer |
| blue | integer |
Returns
- None
C Prototype
void play_transition(s16 transType, s16 time, u8 red, u8 green, u8 blue);
save_file_set_using_backup_slot
Lua Example
save_file_set_using_backup_slot(usingBackupSlot)
Parameters
| Field | Type |
|---|---|
| usingBackupSlot | boolean |
Returns
- None
C Prototype
void save_file_set_using_backup_slot(bool usingBackupSlot);
set_environment_region
Lua Example
set_environment_region(index, value)
Parameters
| Field | Type |
|---|---|
| index | integer |
| value | integer |
Returns
- None
C Prototype
void set_environment_region(u8 index, s32 value);
set_override_far
Lua Example
local numberValue = set_override_far(far)
Parameters
| Field | Type |
|---|---|
| far | number |
Returns
number
C Prototype
f32 set_override_far(f32 far);
set_override_fov
Lua Example
local numberValue = set_override_fov(fov)
Parameters
| Field | Type |
|---|---|
| fov | number |
Returns
number
C Prototype
f32 set_override_fov(f32 fov);
set_override_near
Lua Example
local numberValue = set_override_near(near)
Parameters
| Field | Type |
|---|---|
| near | number |
Returns
number
C Prototype
f32 set_override_near(f32 near);
warp_exit_level
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
Lua Example
local booleanValue = warp_restart_level()
Parameters
- None
Returns
boolean
C Prototype
bool warp_restart_level(void);
warp_to_castle
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
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);
functions from smlua_model_utils.h
smlua_model_util_get_id
Lua Example
local integerValue = smlua_model_util_get_id(name)
Parameters
| Field | Type |
|---|---|
| name | string |
Returns
integer
C Prototype
u32 smlua_model_util_get_id(const char* name);
functions from smlua_obj_utils.h
get_temp_object_hitbox
Lua Example
local ObjectHitboxValue = get_temp_object_hitbox()
Parameters
- None
Returns
C Prototype
struct ObjectHitbox* get_temp_object_hitbox(void);
get_trajectory
Lua Example
local PointerValue = get_trajectory(name)
Parameters
| Field | Type |
|---|---|
| name | string |
Returns
Pointer<Trajectory>
C Prototype
Trajectory* get_trajectory(const char* name);
obj_check_hitbox_overlap
Lua Example
local integerValue = obj_check_hitbox_overlap(o1, o2)
Parameters
| Field | Type |
|---|---|
| o1 | Object |
| o2 | Object |
Returns
integer
C Prototype
s32 obj_check_hitbox_overlap(struct Object *o1, struct Object *o2);
obj_count_objects_with_behavior_id
Lua Example
local integerValue = obj_count_objects_with_behavior_id(behaviorId)
Parameters
| Field | Type |
|---|---|
| behaviorId | enum BehaviorId |
Returns
integer
C Prototype
s32 obj_count_objects_with_behavior_id(enum BehaviorId behaviorId);
obj_get_first
Lua Example
local ObjectValue = obj_get_first(objList)
Parameters
| Field | Type |
|---|---|
| objList | enum ObjectList |
Returns
C Prototype
struct Object *obj_get_first(enum ObjectList objList);
obj_get_first_with_behavior_id
Lua Example
local ObjectValue = obj_get_first_with_behavior_id(behaviorId)
Parameters
| Field | Type |
|---|---|
| behaviorId | enum BehaviorId |
Returns
C Prototype
struct Object *obj_get_first_with_behavior_id(enum BehaviorId behaviorId);
obj_get_first_with_behavior_id_and_field_f32
Lua Example
local ObjectValue = obj_get_first_with_behavior_id_and_field_f32(behaviorId, fieldIndex, value)
Parameters
| Field | Type |
|---|---|
| behaviorId | enum BehaviorId |
| fieldIndex | integer |
| value | number |
Returns
C Prototype
struct Object *obj_get_first_with_behavior_id_and_field_f32(enum BehaviorId behaviorId, s32 fieldIndex, f32 value);
obj_get_first_with_behavior_id_and_field_s32
Lua Example
local ObjectValue = obj_get_first_with_behavior_id_and_field_s32(behaviorId, fieldIndex, value)
Parameters
| Field | Type |
|---|---|
| behaviorId | enum BehaviorId |
| fieldIndex | integer |
| value | integer |
Returns
C Prototype
struct Object *obj_get_first_with_behavior_id_and_field_s32(enum BehaviorId behaviorId, s32 fieldIndex, s32 value);
obj_get_nearest_object_with_behavior_id
Lua Example
local ObjectValue = obj_get_nearest_object_with_behavior_id(o, behaviorId)
Parameters
| Field | Type |
|---|---|
| o | Object |
| behaviorId | enum BehaviorId |
Returns
C Prototype
struct Object *obj_get_nearest_object_with_behavior_id(struct Object *o, enum BehaviorId behaviorId);
obj_get_next
Lua Example
local ObjectValue = obj_get_next(o)
Parameters
| Field | Type |
|---|---|
| o | Object |
Returns
C Prototype
struct Object *obj_get_next(struct Object *o);
obj_get_next_with_same_behavior_id
Lua Example
local ObjectValue = obj_get_next_with_same_behavior_id(o)
Parameters
| Field | Type |
|---|---|
| o | Object |
Returns
C Prototype
struct Object *obj_get_next_with_same_behavior_id(struct Object *o);
obj_get_next_with_same_behavior_id_and_field_f32
Lua Example
local ObjectValue = obj_get_next_with_same_behavior_id_and_field_f32(o, fieldIndex, value)
Parameters
| Field | Type |
|---|---|
| o | Object |
| fieldIndex | integer |
| value | number |
Returns
C Prototype
struct Object *obj_get_next_with_same_behavior_id_and_field_f32(struct Object *o, s32 fieldIndex, f32 value);
obj_get_next_with_same_behavior_id_and_field_s32
Lua Example
local ObjectValue = obj_get_next_with_same_behavior_id_and_field_s32(o, fieldIndex, value)
Parameters
| Field | Type |
|---|---|
| o | Object |
| fieldIndex | integer |
| value | integer |
Returns
C Prototype
struct Object *obj_get_next_with_same_behavior_id_and_field_s32(struct Object *o, s32 fieldIndex, s32 value);
obj_get_temp_spawn_particles_info
Lua Example
local SpawnParticlesInfoValue = obj_get_temp_spawn_particles_info(modelId)
Parameters
| Field | Type |
|---|---|
| modelId | enum ModelExtendedId |
Returns
C Prototype
struct SpawnParticlesInfo* obj_get_temp_spawn_particles_info(enum ModelExtendedId modelId);
obj_has_behavior_id
Lua Example
local integerValue = obj_has_behavior_id(o, behaviorId)
Parameters
| Field | Type |
|---|---|
| o | Object |
| behaviorId | enum BehaviorId |
Returns
integer
C Prototype
s32 obj_has_behavior_id(struct Object *o, enum BehaviorId behaviorId);
obj_has_model_extended
Lua Example
local integerValue = obj_has_model_extended(o, modelId)
Parameters
| Field | Type |
|---|---|
| o | Object |
| modelId | enum ModelExtendedId |
Returns
integer
C Prototype
s32 obj_has_model_extended(struct Object *o, enum ModelExtendedId modelId);
obj_is_valid_for_interaction
Lua Example
local integerValue = obj_is_valid_for_interaction(o)
Parameters
| Field | Type |
|---|---|
| o | Object |
Returns
integer
C Prototype
s32 obj_is_valid_for_interaction(struct Object *o);
obj_move_xyz
Lua Example
obj_move_xyz(o, dx, dy, dz)
Parameters
| Field | Type |
|---|---|
| o | Object |
| dx | number |
| dy | number |
| dz | number |
Returns
- None
C Prototype
void obj_move_xyz(struct Object *o, f32 dx, f32 dy, f32 dz);
obj_set_model_extended
Lua Example
obj_set_model_extended(o, modelId)
Parameters
| Field | Type |
|---|---|
| o | Object |
| modelId | enum ModelExtendedId |
Returns
- None
C Prototype
void obj_set_model_extended(struct Object *o, enum ModelExtendedId modelId);
obj_set_vel
Lua Example
obj_set_vel(o, vx, vy, vz)
Parameters
| Field | Type |
|---|---|
| o | Object |
| vx | number |
| vy | number |
| vz | number |
Returns
- None
C Prototype
void obj_set_vel(struct Object *o, f32 vx, f32 vy, f32 vz);
spawn_non_sync_object
Lua Example
local ObjectValue = spawn_non_sync_object(behaviorId, modelId, x, y, z, objSetupFunction)
Parameters
| Field | Type |
|---|---|
| behaviorId | enum BehaviorId |
| modelId | enum ModelExtendedId |
| x | number |
| y | number |
| z | number |
| objSetupFunction | Lua Function () |
Returns
C Prototype
struct Object* spawn_non_sync_object(enum BehaviorId behaviorId, enum ModelExtendedId modelId, f32 x, f32 y, f32 z, LuaFunction objSetupFunction);
spawn_sync_object
Lua Example
local ObjectValue = spawn_sync_object(behaviorId, modelId, x, y, z, objSetupFunction)
Parameters
| Field | Type |
|---|---|
| behaviorId | enum BehaviorId |
| modelId | enum ModelExtendedId |
| x | number |
| y | number |
| z | number |
| objSetupFunction | Lua Function () |
Returns
C Prototype
struct Object* spawn_sync_object(enum BehaviorId behaviorId, enum ModelExtendedId modelId, f32 x, f32 y, f32 z, LuaFunction objSetupFunction);
functions from smlua_text_utils.h
smlua_text_utils_castle_secret_stars_replace
Lua Example
smlua_text_utils_castle_secret_stars_replace(name)
Parameters
| Field | Type |
|---|---|
| name | string |
Returns
- None
C Prototype
void smlua_text_utils_castle_secret_stars_replace(const char* name);
smlua_text_utils_course_acts_replace
Lua Example
smlua_text_utils_course_acts_replace(courseNum, courseName, act1, act2, act3, act4, act5, act6)
Parameters
| Field | Type |
|---|---|
| courseNum | integer |
| courseName | string |
| act1 | string |
| act2 | string |
| act3 | string |
| act4 | string |
| act5 | string |
| act6 | string |
Returns
- None
C Prototype
void smlua_text_utils_course_acts_replace(s16 courseNum, const char* courseName, const char* act1, const char* act2, const char* act3, const char* act4, const char* act5, const char* act6);
smlua_text_utils_dialog_replace
Lua Example
smlua_text_utils_dialog_replace(dialogId, unused, linesPerBox, leftOffset, width, str)
Parameters
| Field | Type |
|---|---|
| dialogId | enum DialogId |
| unused | integer |
| linesPerBox | integer |
| leftOffset | integer |
| width | integer |
| str | string |
Returns
- None
C Prototype
void smlua_text_utils_dialog_replace(enum DialogId dialogId, u32 unused, s8 linesPerBox, s16 leftOffset, s16 width, const char* str);
smlua_text_utils_extra_text_replace
Lua Example
smlua_text_utils_extra_text_replace(index, text)
Parameters
| Field | Type |
|---|---|
| index | integer |
| text | string |
Returns
- None
C Prototype
void smlua_text_utils_extra_text_replace(s16 index, const char* text);
smlua_text_utils_reset_all
Lua Example
smlua_text_utils_reset_all()
Parameters
- None
Returns
- None
C Prototype
void smlua_text_utils_reset_all(void);
smlua_text_utils_secret_star_replace
Lua Example
smlua_text_utils_secret_star_replace(courseNum, courseName)
Parameters
| Field | Type |
|---|---|
| courseNum | integer |
| courseName | string |
Returns
- None
C Prototype
void smlua_text_utils_secret_star_replace(s16 courseNum, const char* courseName);
functions from sound_init.h
disable_background_sound
Lua Example
disable_background_sound()
Parameters
- None
Returns
- None
C Prototype
void disable_background_sound(void);
enable_background_sound
Lua Example
enable_background_sound()
Parameters
- None
Returns
- None
C Prototype
void enable_background_sound(void);
fadeout_cap_music
Lua Example
fadeout_cap_music()
Parameters
- None
Returns
- None
C Prototype
void fadeout_cap_music(void);
fadeout_level_music
Lua Example
fadeout_level_music(fadeTimer)
Parameters
| Field | Type |
|---|---|
| fadeTimer | integer |
Returns
- None
C Prototype
void fadeout_level_music(s16 fadeTimer);
fadeout_music
Lua Example
fadeout_music(fadeOutTime)
Parameters
| Field | Type |
|---|---|
| fadeOutTime | integer |
Returns
- None
C Prototype
void fadeout_music(s16 fadeOutTime);
lower_background_noise
Lua Example
lower_background_noise(a)
Parameters
| Field | Type |
|---|---|
| a | integer |
Returns
- None
C Prototype
void lower_background_noise(s32 a);
play_cap_music
Lua Example
play_cap_music(seqArgs)
Parameters
| Field | Type |
|---|---|
| seqArgs | integer |
Returns
- None
C Prototype
void play_cap_music(u16 seqArgs);
play_cutscene_music
Lua Example
play_cutscene_music(seqArgs)
Parameters
| Field | Type |
|---|---|
| seqArgs | integer |
Returns
- None
C Prototype
void play_cutscene_music(u16 seqArgs);
play_infinite_stairs_music
Lua Example
play_infinite_stairs_music()
Parameters
- None
Returns
- None
C Prototype
void play_infinite_stairs_music(void);
play_menu_sounds
Lua Example
play_menu_sounds(soundMenuFlags)
Parameters
| Field | Type |
|---|---|
| soundMenuFlags | integer |
Returns
- None
C Prototype
void play_menu_sounds(s16 soundMenuFlags);
play_painting_eject_sound
Lua Example
play_painting_eject_sound()
Parameters
- None
Returns
- None
C Prototype
void play_painting_eject_sound(void);
play_shell_music
Lua Example
play_shell_music()
Parameters
- None
Returns
- None
C Prototype
void play_shell_music(void);
raise_background_noise
Lua Example
raise_background_noise(a)
Parameters
| Field | Type |
|---|---|
| a | integer |
Returns
- None
C Prototype
void raise_background_noise(s32 a);
reset_volume
Lua Example
reset_volume()
Parameters
- None
Returns
- None
C Prototype
void reset_volume(void);
set_background_music
Lua Example
set_background_music(a, seqArgs, fadeTimer)
Parameters
| Field | Type |
|---|---|
| a | integer |
| seqArgs | integer |
| fadeTimer | integer |
Returns
- None
C Prototype
void set_background_music(u16 a, u16 seqArgs, s16 fadeTimer);
stop_cap_music
Lua Example
stop_cap_music()
Parameters
- None
Returns
- None
C Prototype
void stop_cap_music(void);
stop_shell_music
Lua Example
stop_shell_music()
Parameters
- None
Returns
- None
C Prototype
void stop_shell_music(void);
functions from spawn_sound.c
calc_dist_to_volume_range_1
Lua Example
local integerValue = calc_dist_to_volume_range_1(distance)
Parameters
| Field | Type |
|---|---|
| distance | number |
Returns
integer
C Prototype
s32 calc_dist_to_volume_range_1(f32 distance);
calc_dist_to_volume_range_2
Lua Example
local integerValue = calc_dist_to_volume_range_2(distance)
Parameters
| Field | Type |
|---|---|
| distance | number |
Returns
integer
C Prototype
s32 calc_dist_to_volume_range_2(f32 distance);
cur_obj_play_sound_1
Lua Example
cur_obj_play_sound_1(soundMagic)
Parameters
| Field | Type |
|---|---|
| soundMagic | integer |
Returns
- None
C Prototype
void cur_obj_play_sound_1(s32 soundMagic);
cur_obj_play_sound_2
Lua Example
cur_obj_play_sound_2(soundMagic)
Parameters
| Field | Type |
|---|---|
| soundMagic | integer |
Returns
- None
C Prototype
void cur_obj_play_sound_2(s32 soundMagic);
exec_anim_sound_state
Lua Example
exec_anim_sound_state(soundStates)
Parameters
| Field | Type |
|---|---|
| soundStates | SoundState |
Returns
- None
C Prototype
void exec_anim_sound_state(struct SoundState *soundStates);
functions from surface_collision.h
find_ceil_height
Lua Example
local numberValue = find_ceil_height(x, y, z)
Parameters
| Field | Type |
|---|---|
| x | number |
| y | number |
| z | number |
Returns
number
C Prototype
f32 find_ceil_height(f32 x, f32 y, f32 z);
find_floor_height
Lua Example
local numberValue = find_floor_height(x, y, z)
Parameters
| Field | Type |
|---|---|
| x | number |
| y | number |
| z | number |
Returns
number
C Prototype
f32 find_floor_height(f32 x, f32 y, f32 z);
find_poison_gas_level
Lua Example
local numberValue = find_poison_gas_level(x, z)
Parameters
| Field | Type |
|---|---|
| x | number |
| z | number |
Returns
number
C Prototype
f32 find_poison_gas_level(f32 x, f32 z);
find_wall_collisions
Lua Example
local integerValue = find_wall_collisions(colData)
Parameters
| Field | Type |
|---|---|
| colData | WallCollisionData |
Returns
integer
C Prototype
s32 find_wall_collisions(struct WallCollisionData *colData);
find_water_level
Lua Example
local numberValue = find_water_level(x, z)
Parameters
| Field | Type |
|---|---|
| x | number |
| z | number |
Returns
number
C Prototype
f32 find_water_level(f32 x, f32 z);
functions from surface_load.h
alloc_surface_pools
Lua Example
alloc_surface_pools()
Parameters
- None
Returns
- None
C Prototype
void alloc_surface_pools(void);
clear_dynamic_surfaces
Lua Example
clear_dynamic_surfaces()
Parameters
- None
Returns
- None
C Prototype
void clear_dynamic_surfaces(void);
get_area_terrain_size
Lua Example
local integerValue = get_area_terrain_size(data)
Parameters
| Field | Type |
|---|---|
| data | Pointer <integer> |
Returns
integer
C Prototype
u32 get_area_terrain_size(s16 *data);
load_area_terrain
Lua Example
load_area_terrain(index, data, surfaceRooms, macroObjects)
Parameters
| Field | Type |
|---|---|
| index | integer |
| data | Pointer <integer> |
| surfaceRooms | Pointer <integer> |
| macroObjects | Pointer <integer> |
Returns
- None
C Prototype
void load_area_terrain(s16 index, s16 *data, s8 *surfaceRooms, s16 *macroObjects);
load_object_collision_model
Lua Example
load_object_collision_model()
Parameters
- None
Returns
- None
C Prototype
void load_object_collision_model(void);