thirdpartymirrors/sm64coopdx
1
0
Fork 0
mirror of https://github.com/coop-deluxe/sm64coopdx.git synced 2025-10-30 08:01:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
sm64coopdx/docs/lua/functions-6.md
Cooliokid956 5fd55ffac1
Some checks failed
Build coop / build-linux (push) Has been cancelled
Details
Build coop / build-steamos (push) Has been cancelled
Details
Build coop / build-windows-opengl (push) Has been cancelled
Details
Build coop / build-windows-directx (push) Has been cancelled
Details
Build coop / build-macos-arm (push) Has been cancelled
Details
Build coop / build-macos-intel (push) Has been cancelled
Details
djui_hud_is_mouse_locked() (#986) 
* djui_hud_get_mouse_locked()

Adds a total of 1 function:
# `bool djui_hud_get_mouse_locked()`
Returns the DJUI mouse lock status

Tip: This won't return the true state of mouse lock, so make sure to use `get_first_person_enabled()` and `camera_config_is_mouse_look_enabled()` as well

---
This also fills in some descriptions left out by Isaac in his viewport/scissor functions

* djui_hud_is_mouse_locked()

Same as before but is

* this is better imo
2025-10-29 18:41:27 +01:00

143 KiB
Raw Blame History

⏪ Lua Functions

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

functions from object_helpers.c


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

🔼


set_room_override

Description

Overrides the current room Mario is in. Set to -1 to reset override

Lua Example

set_room_override(room)

Parameters

Field Type
room integer

Returns

  • None

C Prototype

void set_room_override(s16 room);

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


spawn_water_droplet

Lua Example

local ObjectValue = spawn_water_droplet(parent, params)

Parameters

Field Type
parent Object
params WaterDropletParams

Returns

Object

C Prototype

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

🔼


obj_build_relative_transform

Lua Example

obj_build_relative_transform(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_build_relative_transform(struct Object *obj);

🔼


cur_obj_move_using_vel

Lua Example

cur_obj_move_using_vel()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_move_using_vel(void);

🔼


obj_copy_graph_y_offset

Lua Example

obj_copy_graph_y_offset(dst, src)

Parameters

Field Type
dst Object
src Object

Returns

  • None

C Prototype

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

🔼


obj_copy_pos_and_angle

Lua Example

obj_copy_pos_and_angle(dst, src)

Parameters

Field Type
dst Object
src Object

Returns

  • None

C Prototype

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

🔼


obj_copy_pos

Lua Example

obj_copy_pos(dst, src)

Parameters

Field Type
dst Object
src Object

Returns

  • None

C Prototype

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

🔼


obj_copy_angle

Lua Example

obj_copy_angle(dst, src)

Parameters

Field Type
dst Object
src Object

Returns

  • None

C Prototype

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

🔼


obj_set_gfx_pos_from_pos

Lua Example

obj_set_gfx_pos_from_pos(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_set_gfx_pos_from_pos(struct Object *obj);

🔼


obj_init_animation

Lua Example

obj_init_animation(obj, animIndex)

Parameters

Field Type
obj Object
animIndex integer

Returns

  • None

C Prototype

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

🔼


linear_mtxf_mul_vec3f

Description

Multiplies a vector by a matrix of the form: | ? ? ? 0 | | ? ? ? 0 | | ? ? ? 0 | | 0 0 0 1 | i.e. a matrix representing a linear transformation over 3 space

Lua Example

linear_mtxf_mul_vec3f(m, dst, v)

Parameters

Field Type
m Mat4
dst Vec3f
v Vec3f

Returns

  • None

C Prototype

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

🔼


linear_mtxf_transpose_mul_vec3f

Description

Multiplies a vector by the transpose of a matrix of the form: | ? ? ? 0 | | ? ? ? 0 | | ? ? ? 0 | | 0 0 0 1 | i.e. a matrix representing a linear transformation over 3 space

Lua Example

linear_mtxf_transpose_mul_vec3f(m, dst, v)

Parameters

Field Type
m Mat4
dst Vec3f
v Vec3f

Returns

  • None

C Prototype

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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

Lua Example

cur_obj_enable_rendering()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_enable_rendering(void);

🔼


cur_obj_disable_rendering_and_become_intangible

Lua Example

cur_obj_disable_rendering_and_become_intangible(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void cur_obj_disable_rendering_and_become_intangible(struct Object *obj);

🔼


cur_obj_disable_rendering

Lua Example

cur_obj_disable_rendering()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_disable_rendering(void);

🔼


cur_obj_unhide

Lua Example

cur_obj_unhide()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_unhide(void);

🔼


cur_obj_hide

Lua Example

cur_obj_hide()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_hide(void);

🔼


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

🔼


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

🔼


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

🔼


cur_obj_nearest_object_with_behavior

Lua Example

local ObjectValue = cur_obj_nearest_object_with_behavior(behavior)

Parameters

Field Type
behavior Pointer <BehaviorScript>

Returns

Object

C Prototype

struct Object *cur_obj_nearest_object_with_behavior(const BehaviorScript *behavior);

🔼


cur_obj_dist_to_nearest_object_with_behavior

Lua Example

local numberValue = cur_obj_dist_to_nearest_object_with_behavior(behavior)

Parameters

Field Type
behavior Pointer <BehaviorScript>

Returns

  • number

C Prototype

f32 cur_obj_dist_to_nearest_object_with_behavior(const BehaviorScript *behavior);

🔼


cur_obj_find_nearest_pole

Lua Example

local ObjectValue = cur_obj_find_nearest_pole()

Parameters

  • None

Returns

Object

C Prototype

struct Object* cur_obj_find_nearest_pole(void);

🔼


cur_obj_find_nearest_object_with_behavior

Lua Example

local ObjectValue = cur_obj_find_nearest_object_with_behavior(behavior, dist)

Parameters

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

Returns

Object

C Prototype

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

🔼


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

🔼


find_unimportant_object

Lua Example

local ObjectValue = find_unimportant_object()

Parameters

  • None

Returns

Object

C Prototype

struct Object *find_unimportant_object(void);

🔼


count_unimportant_objects

Lua Example

local integerValue = count_unimportant_objects()

Parameters

  • None

Returns

  • integer

C Prototype

s32 count_unimportant_objects(void);

🔼


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

🔼


find_object_with_behavior

Lua Example

local ObjectValue = find_object_with_behavior(behavior)

Parameters

Field Type
behavior Pointer <BehaviorScript>

Returns

Object

C Prototype

struct Object *find_object_with_behavior(const BehaviorScript *behavior);

🔼


cur_obj_find_nearby_held_actor

Lua Example

local ObjectValue = cur_obj_find_nearby_held_actor(behavior, maxDist)

Parameters

Field Type
behavior Pointer <BehaviorScript>
maxDist number

Returns

Object

C Prototype

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

🔼


cur_obj_reset_timer_and_subaction

Lua Example

cur_obj_reset_timer_and_subaction()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_reset_timer_and_subaction(void);

🔼


cur_obj_change_action

Lua Example

cur_obj_change_action(action)

Parameters

Field Type
action integer

Returns

  • None

C Prototype

void cur_obj_change_action(s32 action);

🔼


cur_obj_set_vel_from_mario_vel

Lua Example

cur_obj_set_vel_from_mario_vel(m, f12, f14)

Parameters

Field Type
m MarioState
f12 number
f14 number

Returns

  • None

C Prototype

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

🔼


cur_obj_reverse_animation

Lua Example

cur_obj_reverse_animation()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_reverse_animation(void);

🔼


cur_obj_extend_animation_if_at_end

Lua Example

cur_obj_extend_animation_if_at_end()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_extend_animation_if_at_end(void);

🔼


cur_obj_check_if_near_animation_end

Lua Example

local integerValue = cur_obj_check_if_near_animation_end()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_check_if_near_animation_end(void);

🔼


cur_obj_check_if_at_animation_end

Lua Example

local integerValue = cur_obj_check_if_at_animation_end()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_check_if_at_animation_end(void);

🔼


cur_obj_check_anim_frame

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

🔼


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

🔼


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

Lua Example

cur_obj_get_dropped()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_get_dropped(void);

🔼


mario_set_flag

Lua Example

mario_set_flag(flag)

Parameters

Field Type
flag integer

Returns

  • None

C Prototype

void mario_set_flag(s32 flag);

🔼


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

🔼


obj_mark_for_deletion

Description

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

Lua Example

obj_mark_for_deletion(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_mark_for_deletion(struct Object *obj);

🔼


cur_obj_disable

Lua Example

cur_obj_disable()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_disable(void);

🔼


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

🔼


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

🔼


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

Surface

C Prototype

struct Surface *cur_obj_update_floor_height_and_get_floor(void);

🔼


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

🔼


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

Lua Example

cur_obj_move_y(gravity, bounciness, buoyancy)

Parameters

Field Type
gravity number
bounciness number
buoyancy number

Returns

  • None

C Prototype

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

🔼


cur_obj_unused_resolve_wall_collisions

Lua Example

cur_obj_unused_resolve_wall_collisions(offsetY, radius)

Parameters

Field Type
offsetY number
radius number

Returns

  • None

C Prototype

void cur_obj_unused_resolve_wall_collisions(f32 offsetY, f32 radius);

🔼


abs_angle_diff

Lua Example

local integerValue = abs_angle_diff(x0, x1)

Parameters

Field Type
x0 integer
x1 integer

Returns

  • integer

C Prototype

s16 abs_angle_diff(s16 x0, s16 x1);

🔼


cur_obj_move_xz_using_fvel_and_yaw

Lua Example

cur_obj_move_xz_using_fvel_and_yaw()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_move_xz_using_fvel_and_yaw(void);

🔼


cur_obj_move_y_with_terminal_vel

Lua Example

cur_obj_move_y_with_terminal_vel()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_move_y_with_terminal_vel(void);

🔼


cur_obj_compute_vel_xz

Lua Example

cur_obj_compute_vel_xz()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_compute_vel_xz(void);

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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_translate_local

Description

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

Lua Example

obj_translate_local(obj, posIndex, localTranslateIndex)

Parameters

Field Type
obj Object
posIndex integer
localTranslateIndex integer

Returns

  • None

C Prototype

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

🔼


obj_build_transform_from_pos_and_angle

Lua Example

obj_build_transform_from_pos_and_angle(obj, posIndex, angleIndex)

Parameters

Field Type
obj Object
posIndex integer
angleIndex integer

Returns

  • None

C Prototype

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

🔼


obj_set_throw_matrix_from_transform

Lua Example

obj_set_throw_matrix_from_transform(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_set_throw_matrix_from_transform(struct Object *obj);

🔼


obj_build_transform_relative_to_parent

Lua Example

obj_build_transform_relative_to_parent(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_build_transform_relative_to_parent(struct Object *obj);

🔼


obj_create_transform_from_self

Lua Example

obj_create_transform_from_self(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_create_transform_from_self(struct Object *obj);

🔼


cur_obj_rotate_move_angle_using_vel

Lua Example

cur_obj_rotate_move_angle_using_vel()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_rotate_move_angle_using_vel(void);

🔼


cur_obj_rotate_face_angle_using_vel

Lua Example

cur_obj_rotate_face_angle_using_vel()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_rotate_face_angle_using_vel(void);

🔼


cur_obj_set_face_angle_to_move_angle

Lua Example

cur_obj_set_face_angle_to_move_angle()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_set_face_angle_to_move_angle(void);

🔼


cur_obj_follow_path

Lua Example

local integerValue = cur_obj_follow_path(unusedArg)

Parameters

Field Type
unusedArg integer

Returns

  • integer

C Prototype

s32 cur_obj_follow_path(UNUSED s32 unusedArg);

🔼


chain_segment_init

Lua Example

chain_segment_init(segment)

Parameters

Field Type
segment ChainSegment

Returns

  • None

C Prototype

void chain_segment_init(struct ChainSegment *segment);

🔼


random_f32_around_zero

Lua Example

local numberValue = random_f32_around_zero(diameter)

Parameters

Field Type
diameter number

Returns

  • number

C Prototype

f32 random_f32_around_zero(f32 diameter);

🔼


obj_scale_random

Lua Example

obj_scale_random(obj, rangeLength, minScale)

Parameters

Field Type
obj Object
rangeLength number
minScale number

Returns

  • None

C Prototype

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

🔼


obj_translate_xyz_random

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

🔼


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

🔼


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

🔼


signum_positive

Lua Example

local integerValue = signum_positive(x)

Parameters

Field Type
x integer

Returns

  • integer

C Prototype

s32 signum_positive(s32 x);

🔼


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

🔼


obj_is_mario_ground_pounding_platform

Lua Example

local integerValue = obj_is_mario_ground_pounding_platform(m, obj)

Parameters

Field Type
m MarioState
obj Object

Returns

  • integer

C Prototype

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

🔼


spawn_mist_particles

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

🔼


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

🔼


bhv_dust_smoke_loop

Lua Example

bhv_dust_smoke_loop()

Parameters

  • None

Returns

  • None

C Prototype

void bhv_dust_smoke_loop(void);

🔼


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

🔼


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

🔼


stub_obj_helpers_4

Lua Example

stub_obj_helpers_4()

Parameters

  • None

Returns

  • None

C Prototype

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

🔼


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

Object

C Prototype

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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


bhv_init_room

Lua Example

bhv_init_room()

Parameters

  • None

Returns

  • None

C Prototype

void bhv_init_room(void);

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


disable_time_stop

Lua Example

disable_time_stop()

Parameters

  • None

Returns

  • None

C Prototype

void disable_time_stop(void);

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

Description

Sets the current object's home only the first time it's called

Lua Example

cur_obj_set_home_once()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_set_home_once(void);

🔼


get_trajectory_length

Description

Gets a trajectory's 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);

🔼


functions from object_list_processor.h


set_object_respawn_info_bits

Description

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

Lua Example

set_object_respawn_info_bits(obj, bits)

Parameters

Field Type
obj Object
bits integer

Returns

  • None

C Prototype

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

🔼


functions from platform_displacement.h


apply_platform_displacement

Description

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

Lua Example

apply_platform_displacement(o, platform)

Parameters

Field Type
o Object
platform Object

Returns

  • None

C Prototype

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

🔼


functions from rumble_init.h


queue_rumble_data

Description

Queues rumble data

Lua Example

queue_rumble_data(a0, a1)

Parameters

Field Type
a0 integer
a1 integer

Returns

  • None

C Prototype

void queue_rumble_data(s16 a0, s16 a1);

🔼


queue_rumble_data_object

Description

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

Lua Example

queue_rumble_data_object(object, a0, a1)

Parameters

Field Type
object Object
a0 integer
a1 integer

Returns

  • None

C Prototype

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

🔼


queue_rumble_data_mario

Description

Queues rumble data for Mario

Lua Example

queue_rumble_data_mario(m, a0, a1)

Parameters

Field Type
m MarioState
a0 integer
a1 integer

Returns

  • None

C Prototype

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

🔼


reset_rumble_timers

Description

Resets rumble timers

Lua Example

reset_rumble_timers(m)

Parameters

Field Type
m MarioState

Returns

  • None

C Prototype

void reset_rumble_timers(struct MarioState* m);

🔼


reset_rumble_timers_2

Description

Resets rumble timers and sets a field based on a0

Lua Example

reset_rumble_timers_2(m, a0)

Parameters

Field Type
m MarioState
a0 integer

Returns

  • None

C Prototype

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

🔼


functions from save_file.h


get_level_num_from_course_num

Description

Gets the course number's corresponding level number

Lua Example

local integerValue = get_level_num_from_course_num(courseNum)

Parameters

Field Type
courseNum integer

Returns

  • integer

C Prototype

s8 get_level_num_from_course_num(s16 courseNum);

🔼


get_level_course_num

Description

Gets the level number's corresponding course number

Lua Example

local integerValue = get_level_course_num(levelNum)

Parameters

Field Type
levelNum integer

Returns

  • integer

C Prototype

s8 get_level_course_num(s16 levelNum);

🔼


touch_coin_score_age

Description

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

Lua Example

touch_coin_score_age(fileIndex, courseIndex)

Parameters

Field Type
fileIndex integer
courseIndex integer

Returns

  • None

C Prototype

void touch_coin_score_age(s32 fileIndex, s32 courseIndex);

🔼


save_file_do_save

Description

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

Lua Example

save_file_do_save(fileIndex, forceSave)

Parameters

Field Type
fileIndex integer
forceSave integer

Returns

  • None

C Prototype

void save_file_do_save(s32 fileIndex, s8 forceSave);

🔼


save_file_erase

Description

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

Lua Example

save_file_erase(fileIndex)

Parameters

Field Type
fileIndex integer

Returns

  • None

C Prototype

void save_file_erase(s32 fileIndex);

🔼


save_file_erase_current_backup_save

Description

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

Lua Example

save_file_erase_current_backup_save()

Parameters

  • None

Returns

  • None

C Prototype

void save_file_erase_current_backup_save(void);

🔼


save_file_reload

Description

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

Lua Example

save_file_reload(load_all)

Parameters

Field Type
load_all integer

Returns

  • None

C Prototype

void save_file_reload(u8 load_all);

🔼


save_file_get_max_coin_score

Description

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

Lua Example

local integerValue = save_file_get_max_coin_score(courseIndex)

Parameters

Field Type
courseIndex integer

Returns

  • integer

C Prototype

u32 save_file_get_max_coin_score(s32 courseIndex);

🔼


save_file_get_course_star_count

Description

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

Lua Example

local integerValue = save_file_get_course_star_count(fileIndex, courseIndex)

Parameters

Field Type
fileIndex integer
courseIndex integer

Returns

  • integer

C Prototype

s32 save_file_get_course_star_count(s32 fileIndex, s32 courseIndex);

🔼


save_file_get_total_star_count

Description

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

Lua Example

local integerValue = save_file_get_total_star_count(fileIndex, minCourse, maxCourse)

Parameters

Field Type
fileIndex integer
minCourse integer
maxCourse integer

Returns

  • integer

C Prototype

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

🔼


save_file_set_flags

Description

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

Lua Example

save_file_set_flags(flags)

Parameters

Field Type
flags integer

Returns

  • None

C Prototype

void save_file_set_flags(u32 flags);

🔼


save_file_clear_flags

Description

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

Lua Example

save_file_clear_flags(flags)

Parameters

Field Type
flags integer

Returns

  • None

C Prototype

void save_file_clear_flags(u32 flags);

🔼


save_file_get_flags

Description

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

Lua Example

local integerValue = save_file_get_flags()

Parameters

  • None

Returns

  • integer

C Prototype

u32 save_file_get_flags(void);

🔼


save_file_get_star_flags

Description

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

Lua Example

local integerValue = save_file_get_star_flags(fileIndex, courseIndex)

Parameters

Field Type
fileIndex integer
courseIndex integer

Returns

  • integer

C Prototype

u32 save_file_get_star_flags(s32 fileIndex, s32 courseIndex);

🔼


save_file_set_star_flags

Description

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

Lua Example

save_file_set_star_flags(fileIndex, courseIndex, starFlags)

Parameters

Field Type
fileIndex integer
courseIndex integer
starFlags integer

Returns

  • None

C Prototype

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

🔼


save_file_remove_star_flags

Description

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

Lua Example

save_file_remove_star_flags(fileIndex, courseIndex, starFlagsToRemove)

Parameters

Field Type
fileIndex integer
courseIndex integer
starFlagsToRemove integer

Returns

  • None

C Prototype

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

🔼


save_file_get_course_coin_score

Description

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

Lua Example

local integerValue = save_file_get_course_coin_score(fileIndex, courseIndex)

Parameters

Field Type
fileIndex integer
courseIndex integer

Returns

  • integer

C Prototype

s32 save_file_get_course_coin_score(s32 fileIndex, s32 courseIndex);

🔼


save_file_set_course_coin_score

Description

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

Lua Example

save_file_set_course_coin_score(fileIndex, courseIndex, coinScore)

Parameters

Field Type
fileIndex integer
courseIndex integer
coinScore integer

Returns

  • None

C Prototype

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

🔼


save_file_is_cannon_unlocked

Description

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

Lua Example

local integerValue = save_file_is_cannon_unlocked(fileIndex, courseIndex)

Parameters

Field Type
fileIndex integer
courseIndex integer

Returns

  • integer

C Prototype

s32 save_file_is_cannon_unlocked(s32 fileIndex, s32 courseIndex);

🔼


save_file_get_cap_pos

Description

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

Lua Example

local integerValue = save_file_get_cap_pos(capPos)

Parameters

Field Type
capPos Vec3s

Returns

  • integer

C Prototype

s32 save_file_get_cap_pos(OUT Vec3s capPos);

🔼


save_file_get_sound_mode

Description

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

Lua Example

local integerValue = save_file_get_sound_mode()

Parameters

  • None

Returns

  • integer

C Prototype

u16 save_file_get_sound_mode(void);

🔼


functions from seqplayer.h


sequence_player_get_tempo

Description

Gets the tempo of player

Lua Example

local integerValue = sequence_player_get_tempo(player)

Parameters

Field Type
player integer

Returns

  • integer

C Prototype

u16 sequence_player_get_tempo(u8 player);

🔼


sequence_player_set_tempo

Description

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

Lua Example

sequence_player_set_tempo(player, tempo)

Parameters

Field Type
player integer
tempo integer

Returns

  • None

C Prototype

void sequence_player_set_tempo(u8 player, u16 tempo);

🔼


sequence_player_get_tempo_acc

Description

Gets the tempoAcc (tempo accumulation) of player

Lua Example

local integerValue = sequence_player_get_tempo_acc(player)

Parameters

Field Type
player integer

Returns

  • integer

C Prototype

u16 sequence_player_get_tempo_acc(u8 player);

🔼


sequence_player_set_tempo_acc

Description

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

Lua Example

sequence_player_set_tempo_acc(player, tempoAcc)

Parameters

Field Type
player integer
tempoAcc integer

Returns

  • None

C Prototype

void sequence_player_set_tempo_acc(u8 player, u16 tempoAcc);

🔼


sequence_player_get_transposition

Description

Gets the transposition (pitch) of player

Lua Example

local integerValue = sequence_player_get_transposition(player)

Parameters

Field Type
player integer

Returns

  • integer

C Prototype

u16 sequence_player_get_transposition(u8 player);

🔼


sequence_player_set_transposition

Description

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

Lua Example

sequence_player_set_transposition(player, transposition)

Parameters

Field Type
player integer
transposition integer

Returns

  • None

C Prototype

void sequence_player_set_transposition(u8 player, u16 transposition);

🔼


sequence_player_get_volume

Description

Gets the volume of player

Lua Example

local numberValue = sequence_player_get_volume(player)

Parameters

Field Type
player integer

Returns

  • number

C Prototype

f32 sequence_player_get_volume(u8 player);

🔼


sequence_player_get_fade_volume

Description

Gets the fade volume of player

Lua Example

local numberValue = sequence_player_get_fade_volume(player)

Parameters

Field Type
player integer

Returns

  • number

C Prototype

f32 sequence_player_get_fade_volume(u8 player);

🔼


sequence_player_get_mute_volume_scale

Description

Gets the mute volume scale of player

Lua Example

local numberValue = sequence_player_get_mute_volume_scale(player)

Parameters

Field Type
player integer

Returns

  • number

C Prototype

f32 sequence_player_get_mute_volume_scale(u8 player);

🔼


functions from smlua_anim_utils.h


get_mario_vanilla_animation

Description

Gets a vanilla mario Animation with index

Lua Example

local AnimationValue = get_mario_vanilla_animation(index)

Parameters

Field Type
index integer

Returns

Animation

C Prototype

struct Animation *get_mario_vanilla_animation(u16 index);

🔼


smlua_anim_util_set_animation

Description

Sets the animation of obj to the animation name corresponds to

Lua Example

smlua_anim_util_set_animation(obj, name)

Parameters

Field Type
obj Object
name string

Returns

  • None

C Prototype

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

🔼


smlua_anim_util_get_current_animation_name

Description

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

Lua Example

local stringValue = smlua_anim_util_get_current_animation_name(obj)

Parameters

Field Type
obj Object

Returns

  • string

C Prototype

const char *smlua_anim_util_get_current_animation_name(struct Object *obj);

🔼


functions from smlua_audio_utils.h


smlua_audio_utils_reset_all

Description

Resets all custom sequences back to vanilla

Lua Example

smlua_audio_utils_reset_all()

Parameters

  • None

Returns

  • None

C Prototype

void smlua_audio_utils_reset_all(void);

🔼


smlua_audio_utils_replace_sequence

Description

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

Lua Example

smlua_audio_utils_replace_sequence(sequenceId, bankId, defaultVolume, m64Name)

Parameters

Field Type
sequenceId integer
bankId integer
defaultVolume integer
m64Name string

Returns

  • None

C Prototype

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

🔼


audio_stream_load

Description

Loads an audio stream by filename (with extension)

Lua Example

local ModAudioValue = audio_stream_load(filename)

Parameters

Field Type
filename string

Returns

ModAudio

C Prototype

struct ModAudio* audio_stream_load(const char* filename);

🔼


audio_stream_destroy

Description

Destroys an audio stream

Lua Example

audio_stream_destroy(audio)

Parameters

Field Type
audio ModAudio

Returns

  • None

C Prototype

void audio_stream_destroy(struct ModAudio* audio);

🔼


audio_stream_play

Description

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

Lua Example

audio_stream_play(audio, restart, volume)

Parameters

Field Type
audio ModAudio
restart boolean
volume number

Returns

  • None

C Prototype

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

🔼


audio_stream_pause

Description

Pauses an audio stream

Lua Example

audio_stream_pause(audio)

Parameters

Field Type
audio ModAudio

Returns

  • None

C Prototype

void audio_stream_pause(struct ModAudio* audio);

🔼


audio_stream_stop

Description

Stops an audio stream

Lua Example

audio_stream_stop(audio)

Parameters

Field Type
audio ModAudio

Returns

  • None

C Prototype

void audio_stream_stop(struct ModAudio* audio);

🔼


audio_stream_get_position

Description

Gets the position of an audio stream in seconds

Lua Example

local numberValue = audio_stream_get_position(audio)

Parameters

Field Type
audio ModAudio

Returns

  • number

C Prototype

f32 audio_stream_get_position(struct ModAudio* audio);

🔼


audio_stream_set_position

Description

Sets the position of an audio stream in seconds

Lua Example

audio_stream_set_position(audio, pos)

Parameters

Field Type
audio ModAudio
pos number

Returns

  • None

C Prototype

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

🔼


audio_stream_get_looping

Description

Gets if an audio stream is looping or not

Lua Example

local booleanValue = audio_stream_get_looping(audio)

Parameters

Field Type
audio ModAudio

Returns

  • boolean

C Prototype

bool audio_stream_get_looping(struct ModAudio* audio);

🔼


audio_stream_set_looping

Description

Sets if an audio stream is looping or not

Lua Example

audio_stream_set_looping(audio, looping)

Parameters

Field Type
audio ModAudio
looping boolean

Returns

  • None

C Prototype

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

🔼


audio_stream_set_loop_points

Description

Sets an audio stream's loop points in samples

Lua Example

audio_stream_set_loop_points(audio, loopStart, loopEnd)

Parameters

Field Type
audio ModAudio
loopStart integer
loopEnd integer

Returns

  • None

C Prototype

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

🔼


audio_stream_get_frequency

Description

Gets the frequency of an audio stream

Lua Example

local numberValue = audio_stream_get_frequency(audio)

Parameters

Field Type
audio ModAudio

Returns

  • number

C Prototype

f32 audio_stream_get_frequency(struct ModAudio* audio);

🔼


audio_stream_set_frequency

Description

Sets the frequency of an audio stream

Lua Example

audio_stream_set_frequency(audio, freq)

Parameters

Field Type
audio ModAudio
freq number

Returns

  • None

C Prototype

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

🔼


audio_stream_get_volume

Description

Gets the volume of an audio stream

Lua Example

local numberValue = audio_stream_get_volume(audio)

Parameters

Field Type
audio ModAudio

Returns

  • number

C Prototype

f32 audio_stream_get_volume(struct ModAudio* audio);

🔼


audio_stream_set_volume

Description

Sets the volume of an audio stream

Lua Example

audio_stream_set_volume(audio, volume)

Parameters

Field Type
audio ModAudio
volume number

Returns

  • None

C Prototype

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

🔼


audio_sample_load

Description

Loads an audio sample

Lua Example

local ModAudioValue = audio_sample_load(filename)

Parameters

Field Type
filename string

Returns

ModAudio

C Prototype

struct ModAudio* audio_sample_load(const char* filename);

🔼


audio_sample_destroy

Description

Destroys an audio sample

Lua Example

audio_sample_destroy(audio)

Parameters

Field Type
audio ModAudio

Returns

  • None

C Prototype

void audio_sample_destroy(struct ModAudio* audio);

🔼


audio_sample_stop

Description

Stops an audio sample

Lua Example

audio_sample_stop(audio)

Parameters

Field Type
audio ModAudio

Returns

  • None

C Prototype

void audio_sample_stop(struct ModAudio* audio);

🔼


audio_sample_play

Description

Plays an audio sample at position with volume

Lua Example

audio_sample_play(audio, position, volume)

Parameters

Field Type
audio ModAudio
position Vec3f
volume number

Returns

  • None

C Prototype

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

🔼


functions from smlua_camera_utils.h


camera_reset_overrides

Description

Resets camera config overrides

Lua Example

camera_reset_overrides()

Parameters

  • None

Returns

  • None

C Prototype

void camera_reset_overrides(void);

🔼


camera_freeze

Description

Freezes the camera by not updating it

Lua Example

camera_freeze()

Parameters

  • None

Returns

  • None

C Prototype

void camera_freeze(void);

🔼


camera_unfreeze

Description

Unfreezes the camera

Lua Example

camera_unfreeze()

Parameters

  • None

Returns

  • None

C Prototype

void camera_unfreeze(void);

🔼


camera_is_frozen

Description

Checks if the camera is frozen

Lua Example

local booleanValue = camera_is_frozen()

Parameters

  • None

Returns

  • boolean

C Prototype

bool camera_is_frozen(void);

🔼


camera_romhack_allow_only_mods

Description

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

Lua Example

camera_romhack_allow_only_mods(allow)

Parameters

Field Type
allow integer

Returns

  • None

C Prototype

void camera_romhack_allow_only_mods(u8 allow);

🔼


camera_set_romhack_override

Description

Sets the romhack camera override status

Lua Example

camera_set_romhack_override(rco)

Parameters

Field Type
rco enum RomhackCameraOverride

Returns

  • None

C Prototype

void camera_set_romhack_override(enum RomhackCameraOverride rco);

🔼


camera_romhack_allow_centering

Description

Sets if the romhack camera should allow centering, triggered with the L button

Lua Example

camera_romhack_allow_centering(allow)

Parameters

Field Type
allow integer

Returns

  • None

C Prototype

void camera_romhack_allow_centering(u8 allow);

🔼


camera_allow_toxic_gas_camera

Description

Sets if the romhack camera should fly above poison gas

Lua Example

camera_allow_toxic_gas_camera(allow)

Parameters

Field Type
allow integer

Returns

  • None

C Prototype

void camera_allow_toxic_gas_camera(u8 allow);

🔼


camera_romhack_allow_dpad_usage

Description

Sets if the romhack camera should allow D-Pad movement

Lua Example

camera_romhack_allow_dpad_usage(allow)

Parameters

Field Type
allow integer

Returns

  • None

C Prototype

void camera_romhack_allow_dpad_usage(u8 allow);

🔼


rom_hack_cam_set_collisions

Description

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

Lua Example

rom_hack_cam_set_collisions(enable)

Parameters

Field Type
enable integer

Returns

  • None

C Prototype

void rom_hack_cam_set_collisions(u8 enable);

🔼


camera_romhack_set_zoomed_in_dist

Description

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

Lua Example

camera_romhack_set_zoomed_in_dist(val)

Parameters

Field Type
val integer

Returns

  • None

C Prototype

void camera_romhack_set_zoomed_in_dist(u32 val);

🔼


camera_romhack_set_zoomed_out_dist

Description

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

Lua Example

camera_romhack_set_zoomed_out_dist(val)

Parameters

Field Type
val integer

Returns

  • None

C Prototype

void camera_romhack_set_zoomed_out_dist(u32 val);

🔼


camera_romhack_set_zoomed_in_height

Description

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

Lua Example

camera_romhack_set_zoomed_in_height(val)

Parameters

Field Type
val integer

Returns

  • None

C Prototype

void camera_romhack_set_zoomed_in_height(u32 val);

🔼


camera_romhack_set_zoomed_out_height

Description

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

Lua Example

camera_romhack_set_zoomed_out_height(val)

Parameters

Field Type
val integer

Returns

  • None

C Prototype

void camera_romhack_set_zoomed_out_height(u32 val);

🔼


camera_romhack_get_zoomed_in_dist

Description

Gets the romhack camera's zoomed in distance

Lua Example

local integerValue = camera_romhack_get_zoomed_in_dist()

Parameters

  • None

Returns

  • integer

C Prototype

u32 camera_romhack_get_zoomed_in_dist(void);

🔼


camera_romhack_get_zoomed_out_dist

Description

Gets the romhack camera's additional zoomed out distance

Lua Example

local integerValue = camera_romhack_get_zoomed_out_dist()

Parameters

  • None

Returns

  • integer

C Prototype

u32 camera_romhack_get_zoomed_out_dist(void);

🔼


camera_romhack_get_zoomed_in_height

Description

Gets the romhack camera's zoomed in height

Lua Example

local integerValue = camera_romhack_get_zoomed_in_height()

Parameters

  • None

Returns

  • integer

C Prototype

u32 camera_romhack_get_zoomed_in_height(void);

🔼


camera_romhack_get_zoomed_out_height

Description

Gets the romhack camera's additional zoomed out height

Lua Example

local integerValue = camera_romhack_get_zoomed_out_height()

Parameters

  • None

Returns

  • integer

C Prototype

u32 camera_romhack_get_zoomed_out_height(void);

🔼


camera_get_romhack_override

Description

Gets the current romhack camera override status

Lua Example

local enumValue = camera_get_romhack_override()

Parameters

  • None

Returns

enum RomhackCameraOverride

C Prototype

enum RomhackCameraOverride camera_get_romhack_override(void);

🔼


camera_romhack_get_allow_centering

Description

Gets if the romhack camera should allow centering

Lua Example

local integerValue = camera_romhack_get_allow_centering()

Parameters

  • None

Returns

  • integer

C Prototype

u8 camera_romhack_get_allow_centering(void);

🔼


camera_get_allow_toxic_gas_camera

Description

Gets if the romhack camera should fly above poison gas

Lua Example

local integerValue = camera_get_allow_toxic_gas_camera()

Parameters

  • None

Returns

  • integer

C Prototype

u8 camera_get_allow_toxic_gas_camera(void);

🔼


camera_romhack_get_allow_dpad_usage

Description

Gets if the romhack camera should allow D-Pad movement

Lua Example

local integerValue = camera_romhack_get_allow_dpad_usage()

Parameters

  • None

Returns

  • integer

C Prototype

u8 camera_romhack_get_allow_dpad_usage(void);

🔼


camera_romhack_get_collisions

Description

Gets if the romhack camera has surface collisions

Lua Example

local integerValue = camera_romhack_get_collisions()

Parameters

  • None

Returns

  • integer

C Prototype

u8 camera_romhack_get_collisions(void);

🔼


camera_config_is_free_cam_enabled

Description

Checks if Free Camera is enabled

Lua Example

local booleanValue = camera_config_is_free_cam_enabled()

Parameters

  • None

Returns

  • boolean

C Prototype

bool camera_config_is_free_cam_enabled(void);

🔼


camera_config_is_analog_cam_enabled

Description

Checks if Analog Camera is enabled

Lua Example

local booleanValue = camera_config_is_analog_cam_enabled()

Parameters

  • None

Returns

  • boolean

C Prototype

bool camera_config_is_analog_cam_enabled(void);

🔼


camera_config_is_dpad_enabled

Description

Checks if Freecam DPad Behavior is enabled

Lua Example

local booleanValue = camera_config_is_dpad_enabled()

Parameters

  • None

Returns

  • boolean

C Prototype

bool camera_config_is_dpad_enabled(void);

🔼


camera_config_is_collision_enabled

Description

Checks if Camera Collision is enabled

Lua Example

local booleanValue = camera_config_is_collision_enabled()

Parameters

  • None

Returns

  • boolean

C Prototype

bool camera_config_is_collision_enabled(void);

🔼


camera_config_is_mouse_look_enabled

Description

Checks if Mouse Look is enabled

Lua Example

local booleanValue = camera_config_is_mouse_look_enabled()

Parameters

  • None

Returns

  • boolean

C Prototype

bool camera_config_is_mouse_look_enabled(void);

🔼


camera_config_is_x_inverted

Description

Checks if camera X is inverted

Lua Example

local booleanValue = camera_config_is_x_inverted()

Parameters

  • None

Returns

  • boolean

C Prototype

bool camera_config_is_x_inverted(void);

🔼


camera_config_is_y_inverted

Description

Checks if camera Y is inverted

Lua Example

local booleanValue = camera_config_is_y_inverted()

Parameters

  • None

Returns

  • boolean

C Prototype

bool camera_config_is_y_inverted(void);

🔼


camera_config_get_x_sensitivity

Description

Gets camera X sensitivity

Lua Example

local integerValue = camera_config_get_x_sensitivity()

Parameters

  • None

Returns

  • integer

C Prototype

u32 camera_config_get_x_sensitivity(void);

🔼


camera_config_get_y_sensitivity

Description

Gets camera Y sensitivity

Lua Example

local integerValue = camera_config_get_y_sensitivity()

Parameters

  • None

Returns

  • integer

C Prototype

u32 camera_config_get_y_sensitivity(void);

🔼


camera_config_get_aggression

Description

Gets camera aggression

Lua Example

local integerValue = camera_config_get_aggression()

Parameters

  • None

Returns

  • integer

C Prototype

u32 camera_config_get_aggression(void);

🔼


camera_config_get_pan_level

Description

Gets camera pan level

Lua Example

local integerValue = camera_config_get_pan_level()

Parameters

  • None

Returns

  • integer

C Prototype

u32 camera_config_get_pan_level(void);

🔼


camera_config_get_deceleration

Description

Gets camera deceleration

Lua Example

local integerValue = camera_config_get_deceleration()

Parameters

  • None

Returns

  • integer

C Prototype

u32 camera_config_get_deceleration(void);

🔼


camera_config_get_centering

Description

Gets if the L button will center the camera

Lua Example

local booleanValue = camera_config_get_centering()

Parameters

  • None

Returns

  • boolean

C Prototype

bool camera_config_get_centering(void);

🔼


camera_config_enable_free_cam

Description

Overrides if Free Camera is enabled

Lua Example

camera_config_enable_free_cam(enable)

Parameters

Field Type
enable boolean

Returns

  • None

C Prototype

void camera_config_enable_free_cam(bool enable);

🔼


camera_config_enable_analog_cam

Description

Overrides if Analog Camera is enabled

Lua Example

camera_config_enable_analog_cam(enable)

Parameters

Field Type
enable boolean

Returns

  • None

C Prototype

void camera_config_enable_analog_cam(bool enable);

🔼


camera_config_enable_centering

Description

Overrides if the L button will center the camera

Lua Example

camera_config_enable_centering(enable)

Parameters

Field Type
enable boolean

Returns

  • None

C Prototype

void camera_config_enable_centering(bool enable);

🔼


camera_config_enable_dpad

Description

Overrides if Freecam DPad Behavior is enabled

Lua Example

camera_config_enable_dpad(enable)

Parameters

Field Type
enable boolean

Returns

  • None

C Prototype

void camera_config_enable_dpad(bool enable);

🔼


camera_config_enable_collisions

Description

Overrides if Camera Collision is enabled

Lua Example

camera_config_enable_collisions(enable)

Parameters

Field Type
enable boolean

Returns

  • None

C Prototype

void camera_config_enable_collisions(bool enable);

🔼


camera_config_enable_mouse_look

Description

Overrides if camera mouse look is enabled

Lua Example

camera_config_enable_mouse_look(enable)

Parameters

Field Type
enable boolean

Returns

  • None

C Prototype

void camera_config_enable_mouse_look(bool enable);

🔼


camera_config_invert_x

Description

Overrides if camera X is inverted

Lua Example

camera_config_invert_x(invert)

Parameters

Field Type
invert boolean

Returns

  • None

C Prototype

void camera_config_invert_x(bool invert);

🔼


camera_config_invert_y

Description

Overrides if camera Y is inverted

Lua Example

camera_config_invert_y(invert)

Parameters

Field Type
invert boolean

Returns

  • None

C Prototype

void camera_config_invert_y(bool invert);

🔼


camera_config_set_x_sensitivity

Description

Overrides camera X sensitivity

Lua Example

camera_config_set_x_sensitivity(value)

Parameters

Field Type
value integer

Returns

  • None

C Prototype

void camera_config_set_x_sensitivity(u32 value);

🔼


camera_config_set_y_sensitivity

Description

Overrides camera Y sensitivity

Lua Example

camera_config_set_y_sensitivity(value)

Parameters

Field Type
value integer

Returns

  • None

C Prototype

void camera_config_set_y_sensitivity(u32 value);

🔼


camera_config_set_aggression

Description

Overrides camera aggression

Lua Example

camera_config_set_aggression(value)

Parameters

Field Type
value integer

Returns

  • None

C Prototype

void camera_config_set_aggression(u32 value);

🔼


camera_config_set_pan_level

Description

Overrides camera pan level

Lua Example

camera_config_set_pan_level(value)

Parameters

Field Type
value integer

Returns

  • None

C Prototype

void camera_config_set_pan_level(u32 value);

🔼


camera_config_set_deceleration

Description

Overrides camera deceleration

Lua Example

camera_config_set_deceleration(value)

Parameters

Field Type
value integer

Returns

  • None

C Prototype

void camera_config_set_deceleration(u32 value);

🔼


camera_get_checking_surfaces

Description

Checks if the camera should account for surfaces

Lua Example

local booleanValue = camera_get_checking_surfaces()

Parameters

  • None

Returns

  • boolean

C Prototype

bool camera_get_checking_surfaces(void);

🔼


camera_set_checking_surfaces

Description

Sets if the camera should account for surfaces

Lua Example

camera_set_checking_surfaces(value)

Parameters

Field Type
value boolean

Returns

  • None

C Prototype

void camera_set_checking_surfaces(bool value);

🔼


functions from smlua_collision_utils.h


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

Surface

C Prototype

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

🔼


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

Surface

C Prototype

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

🔼


get_water_surface_pseudo_floor

Description

Gets the generated water floor surface used when riding a shell

Lua Example

local SurfaceValue = get_water_surface_pseudo_floor()

Parameters

  • None

Returns

Surface

C Prototype

struct Surface* get_water_surface_pseudo_floor(void);

🔼


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

🔼


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

Surface

C Prototype

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

🔼


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

🔼


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

🔼


surface_is_quicksand

Description

Checks if the surface is quicksand

Lua Example

local booleanValue = surface_is_quicksand(surf)

Parameters

Field Type
surf Surface

Returns

  • boolean

C Prototype

bool surface_is_quicksand(struct Surface* surf);

🔼


surface_is_not_hard

Description

Checks if the surface is not a hard surface

Lua Example

local booleanValue = surface_is_not_hard(surf)

Parameters

Field Type
surf Surface

Returns

  • boolean

C Prototype

bool surface_is_not_hard(struct Surface* surf);

🔼


surface_is_painting_warp

Description

Checks if the surface is a painting warp

Lua Example

local booleanValue = surface_is_painting_warp(surf)

Parameters

Field Type
surf Surface

Returns

  • boolean

C Prototype

bool surface_is_painting_warp(struct Surface* surf);

🔼


functions from smlua_deprecated.h


functions from smlua_gfx_utils.h


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


get_skybox

Description

Gets the current skybox

Lua Example

local integerValue = get_skybox()

Parameters

  • None

Returns

  • integer

C Prototype

s8 get_skybox(void);

🔼


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

🔼


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

🔼


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

🔼


gfx_parse

Description

Traverses a display list. Takes a Lua function as a parameter, which is called back for each command in the display list with the parameters cmd (display list pointer), and op

Lua Example

gfx_parse(cmd, func)

Parameters

Field Type
cmd Pointer <Gfx>
func Lua Function ()

Returns

  • None

C Prototype

void gfx_parse(Gfx *cmd, LuaFunction func);

🔼


gfx_get_op

Description

Gets the op of the display list command

Lua Example

local integerValue = gfx_get_op(cmd)

Parameters

Field Type
cmd Pointer <Gfx>

Returns

  • integer

C Prototype

u32 gfx_get_op(Gfx *cmd);

🔼


gfx_get_display_list

Description

Gets the display list from a display list command if it has the op G_DL

Lua Example

local PointerValue = gfx_get_display_list(cmd)

Parameters

Field Type
cmd Pointer <Gfx>

Returns

  • Pointer <Gfx>

C Prototype

Gfx *gfx_get_display_list(Gfx *cmd);

🔼


gfx_get_vertex_buffer

Description

Gets the vertex buffer from a display list command if it has the op G_VTX

Lua Example

local PointerValue = gfx_get_vertex_buffer(cmd)

Parameters

Field Type
cmd Pointer <Gfx>

Returns

  • Pointer <Vtx>

C Prototype

Vtx *gfx_get_vertex_buffer(Gfx *cmd);

🔼


gfx_get_vertex_count

Description

Gets the number of vertices from a display list command if it has the op G_VTX

Lua Example

local integerValue = gfx_get_vertex_count(cmd)

Parameters

Field Type
cmd Pointer <Gfx>

Returns

  • integer

C Prototype

u16 gfx_get_vertex_count(Gfx *cmd);

🔼


gfx_get_texture

Description

Gets the texture from a display list command if it has an image related op

Lua Example

local PointerValue = gfx_get_texture(cmd)

Parameters

Field Type
cmd Pointer <Gfx>

Returns

  • Pointer <Texture>

C Prototype

Texture *gfx_get_texture(Gfx *cmd);

🔼


gfx_get_name

Description

Gets the name of a display list

Lua Example

local stringValue = gfx_get_name(gfx)

Parameters

Field Type
gfx Pointer <Gfx>

Returns

  • string

C Prototype

const char *gfx_get_name(Gfx *gfx);

🔼


gfx_get_length

Description

Gets the max length of a display list

Lua Example

local integerValue = gfx_get_length(gfx)

Parameters

Field Type
gfx Pointer <Gfx>

Returns

  • integer

C Prototype

u32 gfx_get_length(Gfx *gfx);

🔼


gfx_get_command

Description

Gets a command of a display list at position offset

Lua Example

local PointerValue = gfx_get_command(gfx, offset)

Parameters

Field Type
gfx Pointer <Gfx>
offset integer

Returns

  • Pointer <Gfx>

C Prototype

Gfx *gfx_get_command(Gfx *gfx, u32 offset);

🔼


gfx_get_next_command

Description

Gets the next command of a given display list pointer. Intended to use in a for loop

Lua Example

local PointerValue = gfx_get_next_command(gfx)

Parameters

Field Type
gfx Pointer <Gfx>

Returns

  • Pointer <Gfx>

C Prototype

Gfx *gfx_get_next_command(Gfx *gfx);

🔼


gfx_copy

Description

Copies length commands from display list src to display list dest

Lua Example

gfx_copy(dest, src, length)

Parameters

Field Type
dest Pointer <Gfx>
src Pointer <Gfx>
length integer

Returns

  • None

C Prototype

void gfx_copy(Gfx *dest, Gfx *src, u32 length);

🔼


gfx_create

Description

Creates a new named display list of length commands

Lua Example

local PointerValue = gfx_create(name, length)

Parameters

Field Type
name string
length integer

Returns

  • Pointer <Gfx>

C Prototype

Gfx *gfx_create(const char *name, u32 length);

🔼


gfx_resize

Description

Resizes a display list created by gfx_create

Lua Example

gfx_resize(gfx, newLength)

Parameters

Field Type
gfx Pointer <Gfx>
newLength integer

Returns

  • None

C Prototype

void gfx_resize(Gfx *gfx, u32 newLength);

🔼


gfx_delete

Description

Deletes a display list created by gfx_create

Lua Example

gfx_delete(gfx)

Parameters

Field Type
gfx Pointer <Gfx>

Returns

  • None

C Prototype

void gfx_delete(Gfx *gfx);

🔼


gfx_delete_all

Description

Deletes all display lists created by gfx_create

Lua Example

gfx_delete_all()

Parameters

  • None

Returns

  • None

C Prototype

void gfx_delete_all();

🔼


vtx_get_name

Description

Gets the name of a vertex buffer

Lua Example

local stringValue = vtx_get_name(vtx)

Parameters

Field Type
vtx Pointer <Vtx>

Returns

  • string

C Prototype

const char *vtx_get_name(Vtx *vtx);

🔼


vtx_get_count

Description

Gets the max count of vertices of a vertex buffer

Lua Example

local integerValue = vtx_get_count(vtx)

Parameters

Field Type
vtx Pointer <Vtx>

Returns

  • integer

C Prototype

u32 vtx_get_count(Vtx *vtx);

🔼


vtx_get_vertex

Description

Gets a vertex of a vertex buffer at position offset

Lua Example

local PointerValue = vtx_get_vertex(vtx, offset)

Parameters

Field Type
vtx Pointer <Vtx>
offset integer

Returns

  • Pointer <Vtx>

C Prototype

Vtx *vtx_get_vertex(Vtx *vtx, u32 offset);

🔼


vtx_get_next_vertex

Description

Gets the next vertex of a given vertex pointer. Intended to use in a for loop

Lua Example

local PointerValue = vtx_get_next_vertex(vtx)

Parameters

Field Type
vtx Pointer <Vtx>

Returns

  • Pointer <Vtx>

C Prototype

Vtx *vtx_get_next_vertex(Vtx *vtx);

🔼


vtx_copy

Description

Copies count vertices from vertex buffer src to vertex buffer dest

Lua Example

vtx_copy(dest, src, count)

Parameters

Field Type
dest Pointer <Vtx>
src Pointer <Vtx>
count integer

Returns

  • None

C Prototype

void vtx_copy(Vtx *dest, Vtx *src, u32 count);

🔼


vtx_create

Description

Creates a new named vertex buffer of count vertices

Lua Example

local PointerValue = vtx_create(name, count)

Parameters

Field Type
name string
count integer

Returns

  • Pointer <Vtx>

C Prototype

Vtx *vtx_create(const char *name, u32 count);

🔼


vtx_resize

Description

Resizes a vertex buffer created by vtx_create

Lua Example

vtx_resize(vtx, newCount)

Parameters

Field Type
vtx Pointer <Vtx>
newCount integer

Returns

  • None

C Prototype

void vtx_resize(Vtx *vtx, u32 newCount);

🔼


vtx_delete

Description

Deletes a vertex buffer created by vtx_create

Lua Example

vtx_delete(vtx)

Parameters

Field Type
vtx Pointer <Vtx>

Returns

  • None

C Prototype

void vtx_delete(Vtx *vtx);

🔼


vtx_delete_all

Description

Deletes all vertex buffers created by vtx_create

Lua Example

vtx_delete_all()

Parameters

  • None

Returns

  • None

C Prototype

void vtx_delete_all();

🔼


---

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