sm64coopdx/docs/lua/functions-3.md

⏪ Lua Functions

---

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

---

functions from camera.h

approach_camera_height

Lua Example

approach_camera_height(c, goal, inc)

Parameters

Field	Type
c	Camera
goal	number
inc	number

Returns

• None

C Prototype

void approach_camera_height(struct Camera *c, f32 goal, f32 inc);

🔼

approach_f32_asymptotic

Lua Example

local numberValue = approach_f32_asymptotic(current, target, multiplier)

Parameters

Field	Type
current	number
target	number
multiplier	number

Returns

• number

C Prototype

f32 approach_f32_asymptotic(f32 current, f32 target, f32 multiplier);

🔼

approach_f32_asymptotic_bool

Lua Example

local integerValue = approach_f32_asymptotic_bool(current, target, multiplier)

Parameters

Field	Type
current	Pointer <number>
target	number
multiplier	number

Returns

• integer

C Prototype

s32 approach_f32_asymptotic_bool(f32 *current, f32 target, f32 multiplier);

🔼

approach_s16_asymptotic

Lua Example

local integerValue = approach_s16_asymptotic(current, target, divisor)

Parameters

Field	Type
current	integer
target	integer
divisor	integer

Returns

• integer

C Prototype

s32 approach_s16_asymptotic(s16 current, s16 target, s16 divisor);

🔼

approach_s16_asymptotic_bool

Lua Example

local integerValue = approach_s16_asymptotic_bool(current, target, divisor)

Parameters

Field	Type
current	Pointer <integer>
target	integer
divisor	integer

Returns

• integer

C Prototype

s32 approach_s16_asymptotic_bool(s16 *current, s16 target, s16 divisor);

🔼

approach_vec3f_asymptotic

Lua Example

approach_vec3f_asymptotic(current, target, xMul, yMul, zMul)

Parameters

Field	Type
current	Vec3f
target	Vec3f
xMul	number
yMul	number
zMul	number

Returns

• None

C Prototype

void approach_vec3f_asymptotic(Vec3f current, Vec3f target, f32 xMul, f32 yMul, f32 zMul);

🔼

calc_abs_dist

Lua Example

local numberValue = calc_abs_dist(a, b)

Parameters

Field	Type
a	Vec3f
b	Vec3f

Returns

• number

C Prototype

f32 calc_abs_dist(Vec3f a, Vec3f b);

🔼

calc_hor_dist

Lua Example

local numberValue = calc_hor_dist(a, b)

Parameters

Field	Type
a	Vec3f
b	Vec3f

Returns

• number

C Prototype

f32 calc_hor_dist(Vec3f a, Vec3f b);

🔼

calculate_angles

Lua Example

calculate_angles(from, to, pitch, yaw)

Parameters

Field	Type
from	Vec3f
to	Vec3f
pitch	Pointer <integer>
yaw	Pointer <integer>

Returns

• None

C Prototype

void calculate_angles(Vec3f from, Vec3f to, s16 *pitch, s16 *yaw);

🔼

calculate_pitch

Lua Example

local integerValue = calculate_pitch(from, to)

Parameters

Field	Type
from	Vec3f
to	Vec3f

Returns

• integer

C Prototype

s16 calculate_pitch(Vec3f from, Vec3f to);

🔼

calculate_yaw

Lua Example

local integerValue = calculate_yaw(from, to)

Parameters

Field	Type
from	Vec3f
to	Vec3f

Returns

• integer

C Prototype

s16 calculate_yaw(Vec3f from, Vec3f to);

🔼

cam_select_alt_mode

Lua Example

local integerValue = cam_select_alt_mode(angle)

Parameters

Field	Type
angle	integer

Returns

• integer

C Prototype

s32 cam_select_alt_mode(s32 angle);

🔼

camera_approach_f32_symmetric

Lua Example

local numberValue = camera_approach_f32_symmetric(value, target, increment)

Parameters

Field	Type
value	number
target	number
increment	number

Returns

• number

C Prototype

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

🔼

camera_approach_f32_symmetric_bool

Lua Example

local integerValue = camera_approach_f32_symmetric_bool(current, target, increment)

Parameters

Field	Type
current	Pointer <number>
target	number
increment	number

Returns

• integer

C Prototype

s32 camera_approach_f32_symmetric_bool(f32 *current, f32 target, f32 increment);

🔼

camera_approach_s16_symmetric_bool

Lua Example

local integerValue = camera_approach_s16_symmetric_bool(current, target, increment)

Parameters

Field	Type
current	Pointer <integer>
target	integer
increment	integer

Returns

• integer

C Prototype

s32 camera_approach_s16_symmetric_bool(s16 *current, s16 target, s16 increment);

🔼

camera_course_processing

Lua Example

local integerValue = camera_course_processing(c)

Parameters

Field	Type
c	Camera

Returns

• integer

C Prototype

s16 camera_course_processing(struct Camera *c);

🔼

camera_set_use_course_specific_settings

Lua Example

camera_set_use_course_specific_settings(enable)

Parameters

Field	Type
enable	integer

Returns

• None

C Prototype

void camera_set_use_course_specific_settings(u8 enable);

🔼

center_rom_hack_camera

Lua Example

center_rom_hack_camera()

Parameters

• None

Returns

• None

C Prototype

void center_rom_hack_camera(void);

🔼

clamp_pitch

Lua Example

local integerValue = clamp_pitch(from, to, maxPitch, minPitch)

Parameters

Field	Type
from	Vec3f
to	Vec3f
maxPitch	integer
minPitch	integer

Returns

• integer

C Prototype

s32 clamp_pitch(Vec3f from, Vec3f to, s16 maxPitch, s16 minPitch);

🔼

clamp_positions_and_find_yaw

Lua Example

local integerValue = clamp_positions_and_find_yaw(pos, origin, xMax, xMin, zMax, zMin)

Parameters

Field	Type
pos	Vec3f
origin	Vec3f
xMax	number
xMin	number
zMax	number
zMin	number

Returns

• integer

C Prototype

s32 clamp_positions_and_find_yaw(Vec3f pos, Vec3f origin, f32 xMax, f32 xMin, f32 zMax, f32 zMin);

🔼

collide_with_walls

Lua Example

local integerValue = collide_with_walls(pos, offsetY, radius)

Parameters

Field	Type
pos	Vec3f
offsetY	number
radius	number

Returns

• integer

C Prototype

s32 collide_with_walls(Vec3f pos, f32 offsetY, f32 radius);

🔼

cutscene_object

Lua Example

local integerValue = cutscene_object(cutscene, o)

Parameters

Field	Type
cutscene	integer
o	Object

Returns

• integer

C Prototype

s16 cutscene_object(u8 cutscene, struct Object *o);

🔼

cutscene_object_with_dialog

Lua Example

local integerValue = cutscene_object_with_dialog(cutscene, o, dialogID)

Parameters

Field	Type
cutscene	integer
o	Object
dialogID	integer

Returns

• integer

C Prototype

s16 cutscene_object_with_dialog(u8 cutscene, struct Object *o, s16 dialogID);

🔼

cutscene_object_without_dialog

Lua Example

local integerValue = cutscene_object_without_dialog(cutscene, o)

Parameters

Field	Type
cutscene	integer
o	Object

Returns

• integer

C Prototype

s16 cutscene_object_without_dialog(u8 cutscene, struct Object *o);

🔼

cutscene_set_fov_shake_preset

Lua Example

cutscene_set_fov_shake_preset(preset)

Parameters

Field	Type
preset	integer

Returns

• None

C Prototype

void cutscene_set_fov_shake_preset(u8 preset);

🔼

cutscene_spawn_obj

Lua Example

local integerValue = cutscene_spawn_obj(obj, frame)

Parameters

Field	Type
obj	integer
frame	integer

Returns

• integer

C Prototype

s32 cutscene_spawn_obj(u32 obj, s16 frame);

🔼

find_c_buttons_pressed

Lua Example

local integerValue = find_c_buttons_pressed(currentState, buttonsPressed, buttonsDown)

Parameters

Field	Type
currentState	integer
buttonsPressed	integer
buttonsDown	integer

Returns

• integer

C Prototype

s32 find_c_buttons_pressed(u16 currentState, u16 buttonsPressed, u16 buttonsDown);

🔼

find_mario_floor_and_ceil

Lua Example

find_mario_floor_and_ceil(pg)

Parameters

Field	Type
pg	PlayerGeometry

Returns

• None

C Prototype

void find_mario_floor_and_ceil(struct PlayerGeometry *pg);

🔼

get_cutscene_from_mario_status

Lua Example

local integerValue = get_cutscene_from_mario_status(c)

Parameters

Field	Type
c	Camera

Returns

• integer

C Prototype

u8 get_cutscene_from_mario_status(struct Camera *c);

🔼

handle_c_button_movement

Lua Example

handle_c_button_movement(c)

Parameters

Field	Type
c	Camera

Returns

• None

C Prototype

void handle_c_button_movement(struct Camera *c);

🔼

is_range_behind_surface

Lua Example

local integerValue = is_range_behind_surface(from, to, surf, range, surfType)

Parameters

Field	Type
from	Vec3f
to	Vec3f
surf	Surface
range	integer
surfType	integer

Returns

• integer

C Prototype

s32 is_range_behind_surface(Vec3f from, Vec3f to, struct Surface *surf, s16 range, s16 surfType);

🔼

is_within_100_units_of_mario

Lua Example

local integerValue = is_within_100_units_of_mario(posX, posY, posZ)

Parameters

Field	Type
posX	number
posY	number
posZ	number

Returns

• integer

C Prototype

s32 is_within_100_units_of_mario(f32 posX, f32 posY, f32 posZ);

🔼

move_mario_head_c_up

Lua Example

move_mario_head_c_up(c)

Parameters

Field	Type
c	Camera

Returns

• None

C Prototype

void move_mario_head_c_up(UNUSED struct Camera *c);

🔼

next_lakitu_state

Lua Example

local integerValue = next_lakitu_state(newPos, newFoc, curPos, curFoc, oldPos, oldFoc, yaw)

Parameters

Field	Type
newPos	Vec3f
newFoc	Vec3f
curPos	Vec3f
curFoc	Vec3f
oldPos	Vec3f
oldFoc	Vec3f
yaw	integer

Returns

• integer

C Prototype

s16 next_lakitu_state(Vec3f newPos, Vec3f newFoc, Vec3f curPos, Vec3f curFoc, Vec3f oldPos, Vec3f oldFoc, s16 yaw);

🔼

obj_rotate_towards_point

Lua Example

obj_rotate_towards_point(o, point, pitchOff, yawOff, pitchDiv, yawDiv)

Parameters

Field	Type
o	Object
point	Vec3f
pitchOff	integer
yawOff	integer
pitchDiv	integer
yawDiv	integer

Returns

• None

C Prototype

void obj_rotate_towards_point(struct Object *o, Vec3f point, s16 pitchOff, s16 yawOff, s16 pitchDiv, s16 yawDiv);

🔼

object_pos_to_vec3f

Lua Example

object_pos_to_vec3f(dst, o)

Parameters

Field	Type
dst	Vec3f
o	Object

Returns

• None

C Prototype

void object_pos_to_vec3f(Vec3f dst, struct Object *o);

🔼

offset_rotated

Lua Example

offset_rotated(dst, from, to, rotation)

Parameters

Field	Type
dst	Vec3f
from	Vec3f
to	Vec3f
rotation	Vec3s

Returns

• None

C Prototype

void offset_rotated(Vec3f dst, Vec3f from, Vec3f to, Vec3s rotation);

🔼

offset_yaw_outward_radial

Lua Example

local integerValue = offset_yaw_outward_radial(c, areaYaw)

Parameters

Field	Type
c	Camera
areaYaw	integer

Returns

• integer

C Prototype

s32 offset_yaw_outward_radial(struct Camera *c, s16 areaYaw);

🔼

play_camera_buzz_if_c_sideways

Lua Example

play_camera_buzz_if_c_sideways()

Parameters

• None

Returns

• None

C Prototype

void play_camera_buzz_if_c_sideways(void);

🔼

play_camera_buzz_if_cbutton

Lua Example

play_camera_buzz_if_cbutton()

Parameters

• None

Returns

• None

C Prototype

void play_camera_buzz_if_cbutton(void);

🔼

play_camera_buzz_if_cdown

Lua Example

play_camera_buzz_if_cdown()

Parameters

• None

Returns

• None

C Prototype

void play_camera_buzz_if_cdown(void);

🔼

play_cutscene

Lua Example

play_cutscene(c)

Parameters

Field	Type
c	Camera

Returns

• None

C Prototype

void play_cutscene(struct Camera *c);

🔼

play_sound_button_change_blocked

Lua Example

play_sound_button_change_blocked()

Parameters

• None

Returns

• None

C Prototype

void play_sound_button_change_blocked(void);

🔼

play_sound_cbutton_down

Lua Example

play_sound_cbutton_down()

Parameters

• None

Returns

• None

C Prototype

void play_sound_cbutton_down(void);

🔼

play_sound_cbutton_side

Lua Example

play_sound_cbutton_side()

Parameters

• None

Returns

• None

C Prototype

void play_sound_cbutton_side(void);

🔼

play_sound_cbutton_up

Lua Example

play_sound_cbutton_up()

Parameters

• None

Returns

• None

C Prototype

void play_sound_cbutton_up(void);

🔼

play_sound_if_cam_switched_to_lakitu_or_mario

Lua Example

play_sound_if_cam_switched_to_lakitu_or_mario()

Parameters

• None

Returns

• None

C Prototype

void play_sound_if_cam_switched_to_lakitu_or_mario(void);

🔼

play_sound_rbutton_changed

Lua Example

play_sound_rbutton_changed()

Parameters

• None

Returns

• None

C Prototype

void play_sound_rbutton_changed(void);

🔼

radial_camera_input

Lua Example

local integerValue = radial_camera_input(c, unused)

Parameters

Field	Type
c	Camera
unused	number

Returns

• integer

C Prototype

s32 radial_camera_input(struct Camera *c, UNUSED f32 unused);

🔼

random_vec3s

Lua Example

random_vec3s(dst, xRange, yRange, zRange)

Parameters

Field	Type
dst	Vec3s
xRange	integer
yRange	integer
zRange	integer

Returns

• None

C Prototype

void random_vec3s(Vec3s dst, s16 xRange, s16 yRange, s16 zRange);

🔼

reset_camera

Lua Example

reset_camera(c)

Parameters

Field	Type
c	Camera

Returns

• None

C Prototype

void reset_camera(struct Camera *c);

🔼

resolve_geometry_collisions

Lua Example

resolve_geometry_collisions(pos, lastGood)

Parameters

Field	Type
pos	Vec3f
lastGood	Vec3f

Returns

• None

C Prototype

void resolve_geometry_collisions(Vec3f pos, UNUSED Vec3f lastGood);

🔼

rom_hack_cam_set_collisions

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

🔼

rotate_camera_around_walls

Lua Example

local integerValue = rotate_camera_around_walls(c, cPos, avoidYaw, yawRange)

Parameters

Field	Type
c	Camera
cPos	Vec3f
avoidYaw	Pointer <integer>
yawRange	integer

Returns

• integer

C Prototype

s32 rotate_camera_around_walls(struct Camera *c, Vec3f cPos, s16 *avoidYaw, s16 yawRange);

🔼

rotate_in_xz

Lua Example

rotate_in_xz(dst, src, yaw)

Parameters

Field	Type
dst	Vec3f
src	Vec3f
yaw	integer

Returns

• None

C Prototype

void rotate_in_xz(Vec3f dst, Vec3f src, s16 yaw);

🔼

rotate_in_yz

Lua Example

rotate_in_yz(dst, src, pitch)

Parameters

Field	Type
dst	Vec3f
src	Vec3f
pitch	integer

Returns

• None

C Prototype

void rotate_in_yz(Vec3f dst, Vec3f src, s16 pitch);

🔼

scale_along_line

Lua Example

scale_along_line(dest, from, to, scale)

Parameters

Field	Type
dest	Vec3f
from	Vec3f
to	Vec3f
scale	number

Returns

• None

C Prototype

void scale_along_line(Vec3f dest, Vec3f from, Vec3f to, f32 scale);

🔼

select_mario_cam_mode

Lua Example

select_mario_cam_mode()

Parameters

• None

Returns

• None

C Prototype

void select_mario_cam_mode(void);

🔼

set_cam_angle

Lua Example

local integerValue = set_cam_angle(mode)

Parameters

Field	Type
mode	integer

Returns

• integer

C Prototype

s32 set_cam_angle(s32 mode);

🔼

set_camera_mode

Lua Example

set_camera_mode(c, mode, frames)

Parameters

Field	Type
c	Camera
mode	integer
frames	integer

Returns

• None

C Prototype

void set_camera_mode(struct Camera *c, s16 mode, s16 frames);

🔼

set_camera_mode_fixed

Lua Example

local integerValue = set_camera_mode_fixed(c, x, y, z)

Parameters

Field	Type
c	Camera
x	integer
y	integer
z	integer

Returns

• integer

C Prototype

s32 set_camera_mode_fixed(struct Camera* c, s16 x, s16 y, s16 z);

🔼

set_camera_pitch_shake

Lua Example

set_camera_pitch_shake(mag, decay, inc)

Parameters

Field	Type
mag	integer
decay	integer
inc	integer

Returns

• None

C Prototype

void set_camera_pitch_shake(s16 mag, s16 decay, s16 inc);

🔼

set_camera_roll_shake

Lua Example

set_camera_roll_shake(mag, decay, inc)

Parameters

Field	Type
mag	integer
decay	integer
inc	integer

Returns

• None

C Prototype

void set_camera_roll_shake(s16 mag, s16 decay, s16 inc);

🔼

set_camera_shake_from_hit

Lua Example

set_camera_shake_from_hit(shake)

Parameters

Field	Type
shake	integer

Returns

• None

C Prototype

void set_camera_shake_from_hit(s16 shake);

🔼

set_camera_shake_from_point

Lua Example

set_camera_shake_from_point(shake, posX, posY, posZ)

Parameters

Field	Type
shake	integer
posX	number
posY	number
posZ	number

Returns

• None

C Prototype

void set_camera_shake_from_point(s16 shake, f32 posX, f32 posY, f32 posZ);

🔼

set_camera_yaw_shake

Lua Example

set_camera_yaw_shake(mag, decay, inc)

Parameters

Field	Type
mag	integer
decay	integer
inc	integer

Returns

• None

C Prototype

void set_camera_yaw_shake(s16 mag, s16 decay, s16 inc);

🔼

set_environmental_camera_shake

Lua Example

set_environmental_camera_shake(shake)

Parameters

Field	Type
shake	integer

Returns

• None

C Prototype

void set_environmental_camera_shake(s16 shake);

🔼

set_fixed_cam_axis_sa_lobby

Lua Example

set_fixed_cam_axis_sa_lobby(preset)

Parameters

Field	Type
preset	integer

Returns

• None

C Prototype

void set_fixed_cam_axis_sa_lobby(UNUSED s16 preset);

🔼

set_fov_function

Lua Example

set_fov_function(func)

Parameters

Field	Type
func	integer

Returns

• None

C Prototype

void set_fov_function(u8 func);

🔼

set_fov_shake

Lua Example

set_fov_shake(amplitude, decay, shakeSpeed)

Parameters

Field	Type
amplitude	integer
decay	integer
shakeSpeed	integer

Returns

• None

C Prototype

void set_fov_shake(s16 amplitude, s16 decay, s16 shakeSpeed);

🔼

set_fov_shake_from_point_preset

Lua Example

set_fov_shake_from_point_preset(preset, posX, posY, posZ)

Parameters

Field	Type
preset	integer
posX	number
posY	number
posZ	number

Returns

• None

C Prototype

void set_fov_shake_from_point_preset(u8 preset, f32 posX, f32 posY, f32 posZ);

🔼

set_handheld_shake

Lua Example

set_handheld_shake(mode)

Parameters

Field	Type
mode	integer

Returns

• None

C Prototype

void set_handheld_shake(u8 mode);

🔼

set_or_approach_f32_asymptotic

Lua Example

local integerValue = set_or_approach_f32_asymptotic(dst, goal, scale)

Parameters

Field	Type
dst	Pointer <number>
goal	number
scale	number

Returns

• integer

C Prototype

s32 set_or_approach_f32_asymptotic(f32 *dst, f32 goal, f32 scale);

🔼

set_or_approach_s16_symmetric

Lua Example

local integerValue = set_or_approach_s16_symmetric(current, target, increment)

Parameters

Field	Type
current	Pointer <integer>
target	integer
increment	integer

Returns

• integer

C Prototype

s32 set_or_approach_s16_symmetric(s16 *current, s16 target, s16 increment);

🔼

set_or_approach_vec3f_asymptotic

Lua Example

set_or_approach_vec3f_asymptotic(dst, goal, xMul, yMul, zMul)

Parameters

Field	Type
dst	Vec3f
goal	Vec3f
xMul	number
yMul	number
zMul	number

Returns

• None

C Prototype

void set_or_approach_vec3f_asymptotic(Vec3f dst, Vec3f goal, f32 xMul, f32 yMul, f32 zMul);

🔼

set_pitch_shake_from_point

Lua Example

set_pitch_shake_from_point(mag, decay, inc, maxDist, posX, posY, posZ)

Parameters

Field	Type
mag	integer
decay	integer
inc	integer
maxDist	number
posX	number
posY	number
posZ	number

Returns

• None

C Prototype

void set_pitch_shake_from_point(s16 mag, s16 decay, s16 inc, f32 maxDist, f32 posX, f32 posY, f32 posZ);

🔼

shake_camera_handheld

Lua Example

shake_camera_handheld(pos, focus)

Parameters

Field	Type
pos	Vec3f
focus	Vec3f

Returns

• None

C Prototype

void shake_camera_handheld(Vec3f pos, Vec3f focus);

🔼

shake_camera_pitch

Lua Example

shake_camera_pitch(pos, focus)

Parameters

Field	Type
pos	Vec3f
focus	Vec3f

Returns

• None

C Prototype

void shake_camera_pitch(Vec3f pos, Vec3f focus);

🔼

shake_camera_roll

Lua Example

shake_camera_roll(roll)

Parameters

Field	Type
roll	Pointer <integer>

Returns

• None

C Prototype

void shake_camera_roll(s16 *roll);

🔼

shake_camera_yaw

Lua Example

shake_camera_yaw(pos, focus)

Parameters

Field	Type
pos	Vec3f
focus	Vec3f

Returns

• None

C Prototype

void shake_camera_yaw(Vec3f pos, Vec3f focus);

🔼

soft_reset_camera

Lua Example

soft_reset_camera(c)

Parameters

Field	Type
c	Camera

Returns

• None

C Prototype

void soft_reset_camera(struct Camera* c);

🔼

start_cutscene

Lua Example

start_cutscene(c, cutscene)

Parameters

Field	Type
c	Camera
cutscene	integer

Returns

• None

C Prototype

void start_cutscene(struct Camera *c, u8 cutscene);

🔼

start_object_cutscene_without_focus

Lua Example

local integerValue = start_object_cutscene_without_focus(cutscene)

Parameters

Field	Type
cutscene	integer

Returns

• integer

C Prototype

u8 start_object_cutscene_without_focus(u8 cutscene);

🔼

transition_next_state

Lua Example

transition_next_state(c, frames)

Parameters

Field	Type
c	Camera
frames	integer

Returns

• None

C Prototype

void transition_next_state(UNUSED struct Camera *c, s16 frames);

🔼

trigger_cutscene_dialog

Lua Example

local integerValue = trigger_cutscene_dialog(trigger)

Parameters

Field	Type
trigger	integer

Returns

• integer

C Prototype

s32 trigger_cutscene_dialog(s32 trigger);

🔼

vec3f_sub

Lua Example

vec3f_sub(dst, src)

Parameters

Field	Type
dst	Vec3f
src	Vec3f

Returns

• None

C Prototype

void vec3f_sub(Vec3f dst, Vec3f src);

🔼

vec3f_to_object_pos

Lua Example

vec3f_to_object_pos(o, src)

Parameters

Field	Type
o	Object
src	Vec3f

Returns

• None

C Prototype

void vec3f_to_object_pos(struct Object *o, Vec3f src);

🔼

warp_camera

Lua Example

warp_camera(displacementX, displacementY, displacementZ)

Parameters

Field	Type
displacementX	number
displacementY	number
displacementZ	number

Returns

• None

C Prototype

void warp_camera(f32 displacementX, f32 displacementY, f32 displacementZ);

🔼

---

functions from characters.h

get_character

Lua Example

local CharacterValue = get_character(m)

Parameters

Field	Type
m	MarioState

Returns

Character

C Prototype

struct Character* get_character(struct MarioState* m);

🔼

get_character_anim

Lua Example

local integerValue = get_character_anim(m, characterAnim)

Parameters

Field	Type
m	MarioState
characterAnim	enum CharacterAnimID

Returns

• integer

C Prototype

s32 get_character_anim(struct MarioState* m, enum CharacterAnimID characterAnim);

🔼

get_character_anim_offset

Lua Example

local numberValue = get_character_anim_offset(m)

Parameters

Field	Type
m	MarioState

Returns

• number

C Prototype

f32 get_character_anim_offset(struct MarioState* m);

🔼

play_character_sound

Lua Example

play_character_sound(m, characterSound)

Parameters

Field	Type
m	MarioState
characterSound	enum CharacterSound

Returns

• None

C Prototype

void play_character_sound(struct MarioState* m, enum CharacterSound characterSound);

🔼

play_character_sound_if_no_flag

Lua Example

play_character_sound_if_no_flag(m, characterSound, flags)

Parameters

Field	Type
m	MarioState
characterSound	enum CharacterSound
flags	integer

Returns

• None

C Prototype

void play_character_sound_if_no_flag(struct MarioState* m, enum CharacterSound characterSound, u32 flags);

🔼

play_character_sound_offset

Lua Example

play_character_sound_offset(m, characterSound, offset)

Parameters

Field	Type
m	MarioState
characterSound	enum CharacterSound
offset	integer

Returns

• None

C Prototype

void play_character_sound_offset(struct MarioState* m, enum CharacterSound characterSound, u32 offset);

🔼

update_character_anim_offset

Lua Example

update_character_anim_offset(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_character_anim_offset(struct MarioState* m);

🔼

---

functions from djui_chat_message.h

djui_chat_message_create

Lua Example

djui_chat_message_create(message)

Parameters

Field	Type
message	string

Returns

• None

C Prototype

void djui_chat_message_create(const char* message);

🔼

---

functions from djui_console.h

djui_console_message_dequeue

Lua Example

djui_console_message_dequeue()

Parameters

• None

Returns

• None

C Prototype

void djui_console_message_dequeue(void);

🔼

djui_console_toggle

Lua Example

djui_console_toggle()

Parameters

• None

Returns

• None

C Prototype

void djui_console_toggle(void);

🔼

---

functions from djui_hud_utils.h

djui_hud_get_color

Lua Example

local DjuiColorValue = djui_hud_get_color()

Parameters

• None

Returns

DjuiColor

C Prototype

struct DjuiColor* djui_hud_get_color(void);

🔼

djui_hud_get_filter

Lua Example

local integerValue = djui_hud_get_filter()

Parameters

• None

Returns

• integer

C Prototype

u8 djui_hud_get_filter(void);

🔼

djui_hud_get_font

Lua Example

local integerValue = djui_hud_get_font()

Parameters

• None

Returns

• integer

C Prototype

u8 djui_hud_get_font(void);

🔼

djui_hud_get_mouse_x

Lua Example

local numberValue = djui_hud_get_mouse_x()

Parameters

• None

Returns

• number

C Prototype

f32 djui_hud_get_mouse_x(void);

🔼

djui_hud_get_mouse_y

Lua Example

local numberValue = djui_hud_get_mouse_y()

Parameters

• None

Returns

• number

C Prototype

f32 djui_hud_get_mouse_y(void);

🔼

djui_hud_get_raw_mouse_x

Lua Example

local numberValue = djui_hud_get_raw_mouse_x()

Parameters

• None

Returns

• number

C Prototype

f32 djui_hud_get_raw_mouse_x(void);

🔼

djui_hud_get_raw_mouse_y

Lua Example

local numberValue = djui_hud_get_raw_mouse_y()

Parameters

• None

Returns

• number

C Prototype

f32 djui_hud_get_raw_mouse_y(void);

🔼

djui_hud_get_resolution

Lua Example

local integerValue = djui_hud_get_resolution()

Parameters

• None

Returns

• integer

C Prototype

u8 djui_hud_get_resolution(void);

🔼

djui_hud_get_rotation

Lua Example

local HudUtilsRotationValue = djui_hud_get_rotation()

Parameters

• None

Returns

HudUtilsRotation

C Prototype

struct HudUtilsRotation* djui_hud_get_rotation(void);

🔼

djui_hud_get_screen_height

Lua Example

local integerValue = djui_hud_get_screen_height()

Parameters

• None

Returns

• integer

C Prototype

u32 djui_hud_get_screen_height(void);

🔼

djui_hud_get_screen_width

Lua Example

local integerValue = djui_hud_get_screen_width()

Parameters

• None

Returns

• integer

C Prototype

u32 djui_hud_get_screen_width(void);

🔼

djui_hud_is_pause_menu_created

Lua Example

local booleanValue = djui_hud_is_pause_menu_created()

Parameters

• None

Returns

• boolean

C Prototype

bool djui_hud_is_pause_menu_created(void);

🔼

djui_hud_measure_text

Lua Example

local numberValue = djui_hud_measure_text(message)

Parameters

Field	Type
message	string

Returns

• number

C Prototype

f32 djui_hud_measure_text(const char* message);

🔼

djui_hud_print_text

Lua Example

djui_hud_print_text(message, x, y, scale)

Parameters

Field	Type
message	string
x	number
y	number
scale	number

Returns

• None

C Prototype

void djui_hud_print_text(const char* message, f32 x, f32 y, f32 scale);

🔼

djui_hud_print_text_interpolated

Lua Example

djui_hud_print_text_interpolated(message, prevX, prevY, prevScale, x, y, scale)

Parameters

Field	Type
message	string
prevX	number
prevY	number
prevScale	number
x	number
y	number
scale	number

Returns

• None

C Prototype

void djui_hud_print_text_interpolated(const char* message, f32 prevX, f32 prevY, f32 prevScale, f32 x, f32 y, f32 scale);

🔼

djui_hud_render_rect

Lua Example

djui_hud_render_rect(x, y, width, height)

Parameters

Field	Type
x	number
y	number
width	number
height	number

Returns

• None

C Prototype

void djui_hud_render_rect(f32 x, f32 y, f32 width, f32 height);

🔼

djui_hud_render_rect_interpolated

Lua Example

djui_hud_render_rect_interpolated(prevX, prevY, prevWidth, prevHeight, x, y, width, height)

Parameters

Field	Type
prevX	number
prevY	number
prevWidth	number
prevHeight	number
x	number
y	number
width	number
height	number

Returns

• None

C Prototype

void djui_hud_render_rect_interpolated(f32 prevX, f32 prevY, f32 prevWidth, f32 prevHeight, f32 x, f32 y, f32 width, f32 height);

🔼

djui_hud_reset_color

Lua Example

djui_hud_reset_color()

Parameters

• None

Returns

• None

C Prototype

void djui_hud_reset_color(void);

🔼

djui_hud_set_color

Lua Example

djui_hud_set_color(r, g, b, a)

Parameters

Field	Type
r	integer
g	integer
b	integer
a	integer

Returns

• None

C Prototype

void djui_hud_set_color(u8 r, u8 g, u8 b, u8 a);

🔼

djui_hud_set_filter

Lua Example

djui_hud_set_filter(filterType)

Parameters

Field	Type
filterType	enum HudUtilsFilter

Returns

• None

C Prototype

void djui_hud_set_filter(enum HudUtilsFilter filterType);

🔼

djui_hud_set_font

Lua Example

djui_hud_set_font(fontType)

Parameters

Field	Type
fontType	integer

Returns

• None

C Prototype

void djui_hud_set_font(s8 fontType);

🔼

djui_hud_set_mouse_locked

Lua Example

djui_hud_set_mouse_locked(locked)

Parameters

Field	Type
locked	boolean

Returns

• None

C Prototype

void djui_hud_set_mouse_locked(bool locked);

🔼

djui_hud_set_resolution

Lua Example

djui_hud_set_resolution(resolutionType)

Parameters

Field	Type
resolutionType	enum HudUtilsResolution

Returns

• None

C Prototype

void djui_hud_set_resolution(enum HudUtilsResolution resolutionType);

🔼

djui_hud_set_rotation

Lua Example

djui_hud_set_rotation(rotation, pivotX, pivotY)

Parameters

Field	Type
rotation	integer
pivotX	number
pivotY	number

Returns

• None

C Prototype

void djui_hud_set_rotation(s16 rotation, f32 pivotX, f32 pivotY);

🔼

djui_hud_world_pos_to_screen_pos

Lua Example

local booleanValue = djui_hud_world_pos_to_screen_pos(pos, out)

Parameters

Field	Type
pos	Vec3f
out	Vec3f

Returns

• boolean

C Prototype

bool djui_hud_world_pos_to_screen_pos(Vec3f pos, Vec3f out);

🔼

djui_open_pause_menu

Lua Example

djui_open_pause_menu()

Parameters

• None

Returns

• None

C Prototype

void djui_open_pause_menu(void);

🔼

---

functions from djui_popup.h

djui_popup_create

Lua Example

djui_popup_create(message, lines)

Parameters

Field	Type
message	string
lines	integer

Returns

• None

C Prototype

void djui_popup_create(const char* message, int lines);

🔼

---

functions from external.h

drop_queued_background_music

Lua Example

drop_queued_background_music()

Parameters

• None

Returns

• None

C Prototype

void drop_queued_background_music(void);

🔼

fade_volume_scale

Lua Example

fade_volume_scale(player, targetScale, fadeDuration)

Parameters

Field	Type
player	integer
targetScale	integer
fadeDuration	integer

Returns

• None

C Prototype

void fade_volume_scale(u8 player, u8 targetScale, u16 fadeDuration);

🔼

fadeout_background_music

Lua Example

fadeout_background_music(arg0, fadeOut)

Parameters

Field	Type
arg0	integer
fadeOut	integer

Returns

• None

C Prototype

void fadeout_background_music(u16 arg0, u16 fadeOut);

🔼

get_current_background_music

Lua Example

local integerValue = get_current_background_music()

Parameters

• None

Returns

• integer

C Prototype

u16 get_current_background_music(void);

🔼

get_current_background_music_default_volume

Lua Example

local integerValue = get_current_background_music_default_volume()

Parameters

• None

Returns

• integer

C Prototype

u8 get_current_background_music_default_volume(void);

🔼

get_current_background_music_max_target_volume

Lua Example

local integerValue = get_current_background_music_max_target_volume()

Parameters

• None

Returns

• integer

C Prototype

u8 get_current_background_music_max_target_volume(void);

🔼

get_current_background_music_target_volume

Lua Example

local integerValue = get_current_background_music_target_volume()

Parameters

• None

Returns

• integer

C Prototype

u8 get_current_background_music_target_volume(void);

🔼

is_current_background_music_volume_lowered

Lua Example

local integerValue = is_current_background_music_volume_lowered()

Parameters

• None

Returns

• integer

C Prototype

u8 is_current_background_music_volume_lowered(void);

🔼

play_course_clear

Lua Example

play_course_clear()

Parameters

• None

Returns

• None

C Prototype

void play_course_clear(void);

🔼

play_dialog_sound

Lua Example

play_dialog_sound(dialogID)

Parameters

Field	Type
dialogID	integer

Returns

• None

C Prototype

void play_dialog_sound(u8 dialogID);

🔼

play_music

Lua Example

play_music(player, seqArgs, fadeTimer)

Parameters

Field	Type
player	integer
seqArgs	integer
fadeTimer	integer

Returns

• None

C Prototype

void play_music(u8 player, u16 seqArgs, u16 fadeTimer);

🔼

play_peachs_jingle

Lua Example

play_peachs_jingle()

Parameters

• None

Returns

• None

C Prototype

void play_peachs_jingle(void);

🔼

play_power_star_jingle

Lua Example

play_power_star_jingle(arg0)

Parameters

Field	Type
arg0	integer

Returns

• None

C Prototype

void play_power_star_jingle(u8 arg0);

🔼

play_puzzle_jingle

Lua Example

play_puzzle_jingle()

Parameters

• None

Returns

• None

C Prototype

void play_puzzle_jingle(void);

🔼

play_race_fanfare

Lua Example

play_race_fanfare()

Parameters

• None

Returns

• None

C Prototype

void play_race_fanfare(void);

🔼

play_secondary_music

Lua Example

play_secondary_music(seqId, bgMusicVolume, volume, fadeTimer)

Parameters

Field	Type
seqId	integer
bgMusicVolume	integer
volume	integer
fadeTimer	integer

Returns

• None

C Prototype

void play_secondary_music(u8 seqId, u8 bgMusicVolume, u8 volume, u16 fadeTimer);

🔼

play_sound

Lua Example

play_sound(soundBits, pos)

Parameters

Field	Type
soundBits	integer
pos	Vec3f

Returns

• None

C Prototype

void play_sound(s32 soundBits, f32 *pos);

🔼

play_sound_with_freq_scale

Lua Example

play_sound_with_freq_scale(soundBits, pos, freqScale)

Parameters

Field	Type
soundBits	integer
pos	Vec3f
freqScale	number

Returns

• None

C Prototype

void play_sound_with_freq_scale(s32 soundBits, f32* pos, f32 freqScale);

🔼

play_star_fanfare

Lua Example

play_star_fanfare()

Parameters

• None

Returns

• None

C Prototype

void play_star_fanfare(void);

🔼

play_toads_jingle

Lua Example

play_toads_jingle()

Parameters

• None

Returns

• None

C Prototype

void play_toads_jingle(void);

🔼

seq_player_fade_out

Lua Example

seq_player_fade_out(player, fadeDuration)

Parameters

Field	Type
player	integer
fadeDuration	integer

Returns

• None

C Prototype

void seq_player_fade_out(u8 player, u16 fadeDuration);

🔼

seq_player_lower_volume

Lua Example

seq_player_lower_volume(player, fadeDuration, percentage)

Parameters

Field	Type
player	integer
fadeDuration	integer
percentage	integer

Returns

• None

C Prototype

void seq_player_lower_volume(u8 player, u16 fadeDuration, u8 percentage);

🔼

seq_player_unlower_volume

Lua Example

seq_player_unlower_volume(player, fadeDuration)

Parameters

Field	Type
player	integer
fadeDuration	integer

Returns

• None

C Prototype

void seq_player_unlower_volume(u8 player, u16 fadeDuration);

🔼

set_audio_fadeout

Lua Example

set_audio_fadeout(fadeOutTime)

Parameters

Field	Type
fadeOutTime	integer

Returns

• None

C Prototype

void set_audio_fadeout(u16 fadeOutTime);

🔼

sound_banks_disable

Lua Example

sound_banks_disable(player, bankMask)

Parameters

Field	Type
player	integer
bankMask	integer

Returns

• None

C Prototype

void sound_banks_disable(u8 player, u16 bankMask);

🔼

sound_banks_enable

Lua Example

sound_banks_enable(player, bankMask)

Parameters

Field	Type
player	integer
bankMask	integer

Returns

• None

C Prototype

void sound_banks_enable(u8 player, u16 bankMask);

🔼

stop_background_music

Lua Example

stop_background_music(seqId)

Parameters

Field	Type
seqId	integer

Returns

• None

C Prototype

void stop_background_music(u16 seqId);

🔼

stop_secondary_music

Lua Example

stop_secondary_music(fadeTimer)

Parameters

Field	Type
fadeTimer	integer

Returns

• None

C Prototype

void stop_secondary_music(u16 fadeTimer);

🔼

stop_sound

Lua Example

stop_sound(soundBits, pos)

Parameters

Field	Type
soundBits	integer
pos	Vec3f

Returns

• None

C Prototype

void stop_sound(u32 soundBits, f32 *pos);

🔼

stop_sounds_from_source

Lua Example

stop_sounds_from_source(pos)

Parameters

Field	Type
pos	Vec3f

Returns

• None

C Prototype

void stop_sounds_from_source(f32 *pos);

🔼

stop_sounds_in_continuous_banks

Lua Example

stop_sounds_in_continuous_banks()

Parameters

• None

Returns

• None

C Prototype

void stop_sounds_in_continuous_banks(void);

🔼

---

functions from first_person_cam.h

first_person_check_cancels

Lua Example

local booleanValue = first_person_check_cancels(m)

Parameters

Field	Type
m	MarioState

Returns

• boolean

C Prototype

bool first_person_check_cancels(struct MarioState *m);

🔼

first_person_reset

Lua Example

first_person_reset()

Parameters

• None

Returns

• None

C Prototype

void first_person_reset(void);

🔼

get_first_person_enabled

Lua Example

local booleanValue = get_first_person_enabled()

Parameters

• None

Returns

• boolean

C Prototype

bool get_first_person_enabled(void);

🔼

set_first_person_enabled

Lua Example

set_first_person_enabled(enable)

Parameters

Field	Type
enable	boolean

Returns

• None

C Prototype

void set_first_person_enabled(bool enable);

🔼

---

functions from ingame_menu.h

reset_dialog_override_color

Lua Example

reset_dialog_override_color()

Parameters

• None

Returns

• None

C Prototype

void reset_dialog_override_color();

🔼

reset_dialog_override_pos

Lua Example

reset_dialog_override_pos()

Parameters

• None

Returns

• None

C Prototype

void reset_dialog_override_pos();

🔼

set_dialog_override_color

Lua Example

set_dialog_override_color(bgR, bgG, bgB, bgA, textR, textG, textB, textA)

Parameters

Field	Type
bgR	integer
bgG	integer
bgB	integer
bgA	integer
textR	integer
textG	integer
textB	integer
textA	integer

Returns

• None

C Prototype

void set_dialog_override_color(u8 bgR, u8 bgG, u8 bgB, u8 bgA, u8 textR, u8 textG, u8 textB, u8 textA);

🔼

set_dialog_override_pos

Lua Example

set_dialog_override_pos(x, y)

Parameters

Field	Type
x	integer
y	integer

Returns

• None

C Prototype

void set_dialog_override_pos(s16 x, s16 y);

🔼

set_min_dialog_width

Lua Example

set_min_dialog_width(width)

Parameters

Field	Type
width	integer

Returns

• None

C Prototype

void set_min_dialog_width(s16 width);

🔼

---

functions from interaction.h

determine_interaction

Lua Example

local integerValue = determine_interaction(m, o)

Parameters

Field	Type
m	MarioState
o	Object

Returns

• integer

C Prototype

u32 determine_interaction(struct MarioState *m, struct Object *o);

🔼

does_mario_have_normal_cap_on_head

Lua Example

local integerValue = does_mario_have_normal_cap_on_head(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

u32 does_mario_have_normal_cap_on_head(struct MarioState *m);

🔼

get_door_save_file_flag

Lua Example

local integerValue = get_door_save_file_flag(door)

Parameters

Field	Type
door	Object

Returns

• integer

C Prototype

u32 get_door_save_file_flag(struct Object *door);

🔼

interact_damage

Lua Example

local integerValue = interact_damage(m, interactType, o)

Parameters

Field	Type
m	MarioState
interactType	integer
o	Object

Returns

• integer

C Prototype

u32 interact_damage(struct MarioState *m, UNUSED u32 interactType, struct Object *o);

🔼

mario_blow_off_cap

Lua Example

mario_blow_off_cap(m, capSpeed)

Parameters

Field	Type
m	MarioState
capSpeed	number

Returns

• None

C Prototype

void mario_blow_off_cap(struct MarioState *m, f32 capSpeed);

🔼

mario_check_object_grab

Lua Example

local integerValue = mario_check_object_grab(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

u32 mario_check_object_grab(struct MarioState *m);

🔼

mario_drop_held_object

Lua Example

mario_drop_held_object(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void mario_drop_held_object(struct MarioState *m);

🔼

mario_get_collided_object

Lua Example

local ObjectValue = mario_get_collided_object(m, interactType)

Parameters

Field	Type
m	MarioState
interactType	integer

Returns

Object

C Prototype

struct Object *mario_get_collided_object(struct MarioState *m, u32 interactType);

🔼

mario_grab_used_object

Lua Example

mario_grab_used_object(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void mario_grab_used_object(struct MarioState *m);

🔼

mario_lose_cap_to_enemy

Lua Example

local integerValue = mario_lose_cap_to_enemy(m, arg)

Parameters

Field	Type
m	MarioState
arg	integer

Returns

• integer

C Prototype

u32 mario_lose_cap_to_enemy(struct MarioState* m, u32 arg);

🔼

mario_obj_angle_to_object

Lua Example

local integerValue = mario_obj_angle_to_object(m, o)

Parameters

Field	Type
m	MarioState
o	Object

Returns

• integer

C Prototype

s16 mario_obj_angle_to_object(struct MarioState *m, struct Object *o);

🔼

mario_retrieve_cap

Lua Example

mario_retrieve_cap(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void mario_retrieve_cap(struct MarioState* m);

🔼

mario_stop_riding_and_holding

Lua Example

mario_stop_riding_and_holding(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void mario_stop_riding_and_holding(struct MarioState *m);

🔼

mario_stop_riding_object

Lua Example

mario_stop_riding_object(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void mario_stop_riding_object(struct MarioState *m);

🔼

mario_throw_held_object

Lua Example

mario_throw_held_object(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void mario_throw_held_object(struct MarioState *m);

🔼

passes_pvp_interaction_checks

Lua Example

local integerValue = passes_pvp_interaction_checks(attacker, victim)

Parameters

Field	Type
attacker	MarioState
victim	MarioState

Returns

• integer

C Prototype

u8 passes_pvp_interaction_checks(struct MarioState* attacker, struct MarioState* victim);

🔼

take_damage_and_knock_back

Lua Example

local integerValue = take_damage_and_knock_back(m, o)

Parameters

Field	Type
m	MarioState
o	Object

Returns

• integer

C Prototype

u32 take_damage_and_knock_back(struct MarioState *m, struct Object *o);

🔼

---

functions from lag_compensation.h

lag_compensation_get_local_state

Lua Example

local MarioStateValue = lag_compensation_get_local_state(otherNp)

Parameters

Field	Type
otherNp	NetworkPlayer

Returns

MarioState

C Prototype

struct MarioState* lag_compensation_get_local_state(struct NetworkPlayer* otherNp);

🔼

---

functions from level_info.h

get_level_name

Lua Example

local stringValue = get_level_name(courseNum, levelNum, areaIndex)

Parameters

Field	Type
courseNum	integer
levelNum	integer
areaIndex	integer

Returns

• string

C Prototype

const char *get_level_name(s16 courseNum, s16 levelNum, s16 areaIndex);

🔼

get_level_name_ascii

Lua Example

local stringValue = get_level_name_ascii(courseNum, levelNum, areaIndex, charCase)

Parameters

Field	Type
courseNum	integer
levelNum	integer
areaIndex	integer
charCase	integer

Returns

• string

C Prototype

const char *get_level_name_ascii(s16 courseNum, s16 levelNum, s16 areaIndex, s16 charCase);

🔼

get_level_name_sm64

Lua Example

local PointerValue = get_level_name_sm64(courseNum, levelNum, areaIndex, charCase)

Parameters

Field	Type
courseNum	integer
levelNum	integer
areaIndex	integer
charCase	integer

Returns

• Pointer <integer>

C Prototype

const u8 *get_level_name_sm64(s16 courseNum, s16 levelNum, s16 areaIndex, s16 charCase);

🔼

get_star_name

Lua Example

local stringValue = get_star_name(courseNum, starNum)

Parameters

Field	Type
courseNum	integer
starNum	integer

Returns

• string

C Prototype

const char *get_star_name(s16 courseNum, s16 starNum);

🔼

get_star_name_ascii

Lua Example

local stringValue = get_star_name_ascii(courseNum, starNum, charCase)

Parameters

Field	Type
courseNum	integer
starNum	integer
charCase	integer

Returns

• string

C Prototype

const char *get_star_name_ascii(s16 courseNum, s16 starNum, s16 charCase);

🔼

get_star_name_sm64

Lua Example

local PointerValue = get_star_name_sm64(courseNum, starNum, charCase)

Parameters

Field	Type
courseNum	integer
starNum	integer
charCase	integer

Returns

• Pointer <integer>

C Prototype

const u8 *get_star_name_sm64(s16 courseNum, s16 starNum, s16 charCase);

🔼

---

functions from level_script.h

area_create_warp_node

Lua Example

local ObjectWarpNodeValue = area_create_warp_node(id, destLevel, destArea, destNode, checkpoint, o)

Parameters

Field	Type
id	integer
destLevel	integer
destArea	integer
destNode	integer
checkpoint	integer
o	Object

Returns

ObjectWarpNode

C Prototype

struct ObjectWarpNode *area_create_warp_node(u8 id, u8 destLevel, u8 destArea, u8 destNode, u8 checkpoint, struct Object *o);

🔼

---

functions from level_update.h

get_painting_warp_node

Lua Example

local WarpNodeValue = get_painting_warp_node()

Parameters

• None

Returns

WarpNode

C Prototype

struct WarpNode *get_painting_warp_node(void);

🔼

initiate_painting_warp

Lua Example

initiate_painting_warp(paintingIndex)

Parameters

Field	Type
paintingIndex	integer

Returns

• None

C Prototype

void initiate_painting_warp(s16 paintingIndex);

🔼

level_control_timer_running

Lua Example

local integerValue = level_control_timer_running()

Parameters

• None

Returns

• integer

C Prototype

u8 level_control_timer_running(void);

🔼

level_trigger_warp

Lua Example

local integerValue = level_trigger_warp(m, warpOp)

Parameters

Field	Type
m	MarioState
warpOp	integer

Returns

• integer

C Prototype

s16 level_trigger_warp(struct MarioState *m, s32 warpOp);

🔼

lvl_set_current_level

Lua Example

local integerValue = lvl_set_current_level(arg0, levelNum)

Parameters

Field	Type
arg0	integer
levelNum	integer

Returns

• integer

C Prototype

s32 lvl_set_current_level(UNUSED s16 arg0, s32 levelNum);

🔼

warp_special

Lua Example

warp_special(arg)

Parameters

Field	Type
arg	integer

Returns

• None

C Prototype

void warp_special(s32 arg);

🔼

---

functions from mario.h

adjust_sound_for_speed

Lua Example

adjust_sound_for_speed(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void adjust_sound_for_speed(struct MarioState *m);

🔼

check_common_action_exits

Lua Example

local integerValue = check_common_action_exits(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_common_action_exits(struct MarioState *m);

🔼

check_common_hold_action_exits

Lua Example

local integerValue = check_common_hold_action_exits(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_common_hold_action_exits(struct MarioState *m);

🔼

drop_and_set_mario_action

Lua Example

local integerValue = drop_and_set_mario_action(m, action, actionArg)

Parameters

Field	Type
m	MarioState
action	integer
actionArg	integer

Returns

• integer

C Prototype

s32 drop_and_set_mario_action(struct MarioState *m, u32 action, u32 actionArg);

🔼

execute_mario_action

Lua Example

local integerValue = execute_mario_action(o)

Parameters

Field	Type
o	Object

Returns

• integer

C Prototype

s32 execute_mario_action(UNUSED struct Object *o);

🔼

find_floor_height_relative_polar

Lua Example

local numberValue = find_floor_height_relative_polar(m, angleFromMario, distFromMario)

Parameters

Field	Type
m	MarioState
angleFromMario	integer
distFromMario	number

Returns

• number

C Prototype

f32 find_floor_height_relative_polar(struct MarioState *m, s16 angleFromMario, f32 distFromMario);

🔼

find_floor_slope

Lua Example

local integerValue = find_floor_slope(m, yawOffset)

Parameters

Field	Type
m	MarioState
yawOffset	integer

Returns

• integer

C Prototype

s16 find_floor_slope(struct MarioState *m, s16 yawOffset);

🔼

find_mario_anim_flags_and_translation

Lua Example

local integerValue = find_mario_anim_flags_and_translation(o, yaw, translation)

Parameters

Field	Type
o	Object
yaw	integer
translation	Vec3s

Returns

• integer

C Prototype

s16 find_mario_anim_flags_and_translation(struct Object *o, s32 yaw, Vec3s translation);

🔼

force_idle_state

Lua Example

local integerValue = force_idle_state(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 force_idle_state(struct MarioState* m);

🔼

hurt_and_set_mario_action

Lua Example

local integerValue = hurt_and_set_mario_action(m, action, actionArg, hurtCounter)

Parameters

Field	Type
m	MarioState
action	integer
actionArg	integer
hurtCounter	integer

Returns

• integer

C Prototype

s32 hurt_and_set_mario_action(struct MarioState *m, u32 action, u32 actionArg, s16 hurtCounter);

🔼

init_single_mario

Lua Example

init_single_mario(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void init_single_mario(struct MarioState* m);

🔼

is_anim_at_end

Lua Example

local integerValue = is_anim_at_end(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 is_anim_at_end(struct MarioState *m);

🔼

is_anim_past_end

Lua Example

local integerValue = is_anim_past_end(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 is_anim_past_end(struct MarioState *m);

🔼

is_anim_past_frame

Lua Example

local integerValue = is_anim_past_frame(m, animFrame)

Parameters

Field	Type
m	MarioState
animFrame	integer

Returns

• integer

C Prototype

s32 is_anim_past_frame(struct MarioState *m, s16 animFrame);

🔼

mario_can_bubble

Lua Example

local booleanValue = mario_can_bubble(m)

Parameters

Field	Type
m	MarioState

Returns

• boolean

C Prototype

bool mario_can_bubble(struct MarioState* m);

🔼

mario_facing_downhill

Lua Example

local integerValue = mario_facing_downhill(m, turnYaw)

Parameters

Field	Type
m	MarioState
turnYaw	integer

Returns

• integer

C Prototype

s32 mario_facing_downhill(struct MarioState *m, s32 turnYaw);

🔼

mario_floor_is_slippery

Lua Example

local integerValue = mario_floor_is_slippery(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

u32 mario_floor_is_slippery(struct MarioState *m);

🔼

mario_floor_is_slope

Lua Example

local integerValue = mario_floor_is_slope(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 mario_floor_is_slope(struct MarioState *m);

🔼

mario_floor_is_steep

Lua Example

local integerValue = mario_floor_is_steep(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 mario_floor_is_steep(struct MarioState *m);

🔼

mario_get_floor_class

Lua Example

local integerValue = mario_get_floor_class(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 mario_get_floor_class(struct MarioState *m);

🔼

mario_get_terrain_sound_addend

Lua Example

local integerValue = mario_get_terrain_sound_addend(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

u32 mario_get_terrain_sound_addend(struct MarioState *m);

🔼

mario_is_crouching

Lua Example

local booleanValue = mario_is_crouching(m)

Parameters

Field	Type
m	MarioState

Returns

• boolean

C Prototype

bool mario_is_crouching(struct MarioState *m);

🔼

mario_set_bubbled

Lua Example

mario_set_bubbled(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void mario_set_bubbled(struct MarioState* m);

🔼

mario_set_forward_vel

Lua Example

mario_set_forward_vel(m, speed)

Parameters

Field	Type
m	MarioState
speed	number

Returns

• None

C Prototype

void mario_set_forward_vel(struct MarioState *m, f32 speed);

🔼

mario_update_wall

Lua Example

mario_update_wall(m, wcd)

Parameters

Field	Type
m	MarioState
wcd	WallCollisionData

Returns

• None

C Prototype

void mario_update_wall(struct MarioState* m, struct WallCollisionData* wcd);

🔼

play_mario_action_sound

Lua Example

play_mario_action_sound(m, soundBits, waveParticleType)

Parameters

Field	Type
m	MarioState
soundBits	integer
waveParticleType	integer

Returns

• None

C Prototype

void play_mario_action_sound(struct MarioState *m, u32 soundBits, u32 waveParticleType);

🔼

play_mario_heavy_landing_sound

Lua Example

play_mario_heavy_landing_sound(m, soundBits)

Parameters

Field	Type
m	MarioState
soundBits	integer

Returns

• None

C Prototype

void play_mario_heavy_landing_sound(struct MarioState *m, u32 soundBits);

🔼

play_mario_heavy_landing_sound_once

Lua Example

play_mario_heavy_landing_sound_once(m, soundBits)

Parameters

Field	Type
m	MarioState
soundBits	integer

Returns

• None

C Prototype

void play_mario_heavy_landing_sound_once(struct MarioState *m, u32 soundBits);

🔼

play_mario_jump_sound

Lua Example

play_mario_jump_sound(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void play_mario_jump_sound(struct MarioState *m);

🔼

play_mario_landing_sound

Lua Example

play_mario_landing_sound(m, soundBits)

Parameters

Field	Type
m	MarioState
soundBits	integer

Returns

• None

C Prototype

void play_mario_landing_sound(struct MarioState *m, u32 soundBits);

🔼

play_mario_landing_sound_once

Lua Example

play_mario_landing_sound_once(m, soundBits)

Parameters

Field	Type
m	MarioState
soundBits	integer

Returns

• None

C Prototype

void play_mario_landing_sound_once(struct MarioState *m, u32 soundBits);

🔼

play_mario_sound

Lua Example

play_mario_sound(m, primarySoundBits, scondarySoundBits)

Parameters

Field	Type
m	MarioState
primarySoundBits	integer
scondarySoundBits	integer

Returns

• None

C Prototype

void play_mario_sound(struct MarioState *m, s32 primarySoundBits, s32 scondarySoundBits);

🔼

play_sound_and_spawn_particles

Lua Example

play_sound_and_spawn_particles(m, soundBits, waveParticleType)

Parameters

Field	Type
m	MarioState
soundBits	integer
waveParticleType	integer

Returns

• None

C Prototype

void play_sound_and_spawn_particles(struct MarioState *m, u32 soundBits, u32 waveParticleType);

🔼

play_sound_if_no_flag

Lua Example

play_sound_if_no_flag(m, soundBits, flags)

Parameters

Field	Type
m	MarioState
soundBits	integer
flags	integer

Returns

• None

C Prototype

void play_sound_if_no_flag(struct MarioState *m, u32 soundBits, u32 flags);

🔼

resolve_and_return_wall_collisions

Lua Example

local SurfaceValue = resolve_and_return_wall_collisions(pos, offset, radius)

Parameters

Field	Type
pos	Vec3f
offset	number
radius	number

Returns

Surface

C Prototype

struct Surface *resolve_and_return_wall_collisions(Vec3f pos, f32 offset, f32 radius);

🔼

resolve_and_return_wall_collisions_data

Lua Example

resolve_and_return_wall_collisions_data(pos, offset, radius, collisionData)

Parameters

Field	Type
pos	Vec3f
offset	number
radius	number
collisionData	WallCollisionData

Returns

• None

C Prototype

void resolve_and_return_wall_collisions_data(Vec3f pos, f32 offset, f32 radius, struct WallCollisionData* collisionData);

🔼

return_mario_anim_y_translation

Lua Example

local integerValue = return_mario_anim_y_translation(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s16 return_mario_anim_y_translation(struct MarioState *m);

🔼

set_anim_to_frame

Lua Example

set_anim_to_frame(m, animFrame)

Parameters

Field	Type
m	MarioState
animFrame	integer

Returns

• None

C Prototype

void set_anim_to_frame(struct MarioState *m, s16 animFrame);

🔼

set_character_anim_with_accel

Lua Example

local integerValue = set_character_anim_with_accel(m, targetAnimID, accel)

Parameters

Field	Type
m	MarioState
targetAnimID	integer
accel	integer

Returns

• integer

C Prototype

s16 set_character_anim_with_accel(struct MarioState *m, s32 targetAnimID, s32 accel);

🔼

set_character_animation

Lua Example

local integerValue = set_character_animation(m, targetAnimID)

Parameters

Field	Type
m	MarioState
targetAnimID	integer

Returns

• integer

C Prototype

s16 set_character_animation(struct MarioState *m, s32 targetAnimID);

🔼

set_jump_from_landing

Lua Example

local integerValue = set_jump_from_landing(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 set_jump_from_landing(struct MarioState *m);

🔼

set_jumping_action

Lua Example

local integerValue = set_jumping_action(m, action, actionArg)

Parameters

Field	Type
m	MarioState
action	integer
actionArg	integer

Returns

• integer

C Prototype

s32 set_jumping_action(struct MarioState *m, u32 action, u32 actionArg);

🔼

set_mario_action

Lua Example

local integerValue = set_mario_action(m, action, actionArg)

Parameters

Field	Type
m	MarioState
action	integer
actionArg	integer

Returns

• integer

C Prototype

u32 set_mario_action(struct MarioState *m, u32 action, u32 actionArg);

🔼

set_mario_anim_with_accel

Lua Example

local integerValue = set_mario_anim_with_accel(m, targetAnimID, accel)

Parameters

Field	Type
m	MarioState
targetAnimID	integer
accel	integer

Returns

• integer

C Prototype

s16 set_mario_anim_with_accel(struct MarioState *m, s32 targetAnimID, s32 accel);

🔼

set_mario_animation

Lua Example

local integerValue = set_mario_animation(m, targetAnimID)

Parameters

Field	Type
m	MarioState
targetAnimID	integer

Returns

• integer

C Prototype

s16 set_mario_animation(struct MarioState *m, s32 targetAnimID);

🔼

set_mario_particle_flags

Lua Example

set_mario_particle_flags(m, flags, clear)

Parameters

Field	Type
m	MarioState
flags	integer
clear	integer

Returns

• None

C Prototype

void set_mario_particle_flags(struct MarioState* m, u32 flags, u8 clear);

🔼

set_mario_y_vel_based_on_fspeed

Lua Example

set_mario_y_vel_based_on_fspeed(m, initialVelY, multiplier)

Parameters

Field	Type
m	MarioState
initialVelY	number
multiplier	number

Returns

• None

C Prototype

void set_mario_y_vel_based_on_fspeed(struct MarioState *m, f32 initialVelY, f32 multiplier);

🔼

set_steep_jump_action

Lua Example

set_steep_jump_action(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void set_steep_jump_action(struct MarioState *m);

🔼

set_water_plunge_action

Lua Example

local integerValue = set_water_plunge_action(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 set_water_plunge_action(struct MarioState *m);

🔼

transition_submerged_to_walking

Lua Example

local integerValue = transition_submerged_to_walking(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 transition_submerged_to_walking(struct MarioState *m);

🔼

update_mario_pos_for_anim

Lua Example

update_mario_pos_for_anim(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_mario_pos_for_anim(struct MarioState *m);

🔼

update_mario_sound_and_camera

Lua Example

update_mario_sound_and_camera(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_mario_sound_and_camera(struct MarioState *m);

🔼

---

functions from mario_actions_airborne.c

check_common_airborne_cancels

Lua Example

local integerValue = check_common_airborne_cancels(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_common_airborne_cancels(struct MarioState *m);

🔼

check_fall_damage

Lua Example

local integerValue = check_fall_damage(m, hardFallAction)

Parameters

Field	Type
m	MarioState
hardFallAction	integer

Returns

• integer

C Prototype

s32 check_fall_damage(struct MarioState *m, u32 hardFallAction);

🔼

check_fall_damage_or_get_stuck

Lua Example

local integerValue = check_fall_damage_or_get_stuck(m, hardFallAction)

Parameters

Field	Type
m	MarioState
hardFallAction	integer

Returns

• integer

C Prototype

s32 check_fall_damage_or_get_stuck(struct MarioState *m, u32 hardFallAction);

🔼

check_horizontal_wind

Lua Example

local integerValue = check_horizontal_wind(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_horizontal_wind(struct MarioState *m);

🔼

check_kick_or_dive_in_air

Lua Example

local integerValue = check_kick_or_dive_in_air(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_kick_or_dive_in_air(struct MarioState *m);

🔼

check_wall_kick

Lua Example

local integerValue = check_wall_kick(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_wall_kick(struct MarioState *m);

🔼

common_air_action_step

Lua Example

local integerValue = common_air_action_step(m, landAction, animation, stepArg)

Parameters

Field	Type
m	MarioState
landAction	integer
animation	integer
stepArg	integer

Returns

• integer

C Prototype

u32 common_air_action_step(struct MarioState *m, u32 landAction, s32 animation, u32 stepArg);

🔼

common_air_knockback_step

Lua Example

local integerValue = common_air_knockback_step(m, landAction, hardFallAction, animation, speed)

Parameters

Field	Type
m	MarioState
landAction	integer
hardFallAction	integer
animation	integer
speed	number

Returns

• integer

C Prototype

u32 common_air_knockback_step(struct MarioState *m, u32 landAction, u32 hardFallAction, s32 animation, f32 speed);

🔼

lava_boost_on_wall

Lua Example

local integerValue = lava_boost_on_wall(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 lava_boost_on_wall(struct MarioState *m);

🔼

mario_execute_airborne_action

Lua Example

local integerValue = mario_execute_airborne_action(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 mario_execute_airborne_action(struct MarioState *m);

🔼

play_far_fall_sound

Lua Example

play_far_fall_sound(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void play_far_fall_sound(struct MarioState *m);

🔼

play_flip_sounds

Lua Example

play_flip_sounds(m, frame1, frame2, frame3)

Parameters

Field	Type
m	MarioState
frame1	integer
frame2	integer
frame3	integer

Returns

• None

C Prototype

void play_flip_sounds(struct MarioState *m, s16 frame1, s16 frame2, s16 frame3);

🔼

play_knockback_sound

Lua Example

play_knockback_sound(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void play_knockback_sound(struct MarioState *m);

🔼

should_get_stuck_in_ground

Lua Example

local integerValue = should_get_stuck_in_ground(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 should_get_stuck_in_ground(struct MarioState *m);

🔼

update_air_with_turn

Lua Example

update_air_with_turn(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_air_with_turn(struct MarioState *m);

🔼

update_air_without_turn

Lua Example

update_air_without_turn(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_air_without_turn(struct MarioState *m);

🔼

update_flying

Lua Example

update_flying(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_flying(struct MarioState *m);

🔼

update_flying_pitch

Lua Example

update_flying_pitch(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_flying_pitch(struct MarioState *m);

🔼

update_flying_yaw

Lua Example

update_flying_yaw(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_flying_yaw(struct MarioState *m);

🔼

update_lava_boost_or_twirling

Lua Example

update_lava_boost_or_twirling(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_lava_boost_or_twirling(struct MarioState *m);

🔼

---

functions from mario_actions_automatic.c

add_tree_leaf_particles

Lua Example

add_tree_leaf_particles(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void add_tree_leaf_particles(struct MarioState *m);

🔼

check_common_automatic_cancels

Lua Example

local integerValue = check_common_automatic_cancels(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_common_automatic_cancels(struct MarioState *m);

🔼

climb_up_ledge

Lua Example

climb_up_ledge(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void climb_up_ledge(struct MarioState *m);

🔼

let_go_of_ledge

Lua Example

local integerValue = let_go_of_ledge(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 let_go_of_ledge(struct MarioState *m);

🔼

mario_execute_automatic_action

Lua Example

local integerValue = mario_execute_automatic_action(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 mario_execute_automatic_action(struct MarioState *m);

🔼

perform_hanging_step

Lua Example

local integerValue = perform_hanging_step(m, nextPos)

Parameters

Field	Type
m	MarioState
nextPos	Vec3f

Returns

• integer

C Prototype

s32 perform_hanging_step(struct MarioState *m, Vec3f nextPos);

🔼

play_climbing_sounds

Lua Example

play_climbing_sounds(m, b)

Parameters

Field	Type
m	MarioState
b	integer

Returns

• None

C Prototype

void play_climbing_sounds(struct MarioState *m, s32 b);

🔼

set_pole_position

Lua Example

local integerValue = set_pole_position(m, offsetY)

Parameters

Field	Type
m	MarioState
offsetY	number

Returns

• integer

C Prototype

s32 set_pole_position(struct MarioState *m, f32 offsetY);

🔼

update_hang_moving

Lua Example

local integerValue = update_hang_moving(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 update_hang_moving(struct MarioState *m);

🔼

update_hang_stationary

Lua Example

update_hang_stationary(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_hang_stationary(struct MarioState *m);

🔼

update_ledge_climb

Lua Example

update_ledge_climb(m, animation, endAction)

Parameters

Field	Type
m	MarioState
animation	integer
endAction	integer

Returns

• None

C Prototype

void update_ledge_climb(struct MarioState *m, s32 animation, u32 endAction);

🔼

update_ledge_climb_camera

Lua Example

update_ledge_climb_camera(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_ledge_climb_camera(struct MarioState *m);

🔼

---

functions from mario_actions_cutscene.c

bhv_end_peach_loop

Lua Example

bhv_end_peach_loop()

Parameters

• None

Returns

• None

C Prototype

void bhv_end_peach_loop(void);

🔼

bhv_end_toad_loop

Lua Example

bhv_end_toad_loop()

Parameters

• None

Returns

• None

C Prototype

void bhv_end_toad_loop(void);

🔼

common_death_handler

Lua Example

local integerValue = common_death_handler(m, animation, frameToDeathWarp)

Parameters

Field	Type
m	MarioState
animation	integer
frameToDeathWarp	integer

Returns

• integer

C Prototype

s32 common_death_handler(struct MarioState *m, s32 animation, s32 frameToDeathWarp);

🔼

cutscene_put_cap_on

Lua Example

cutscene_put_cap_on(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void cutscene_put_cap_on(struct MarioState *m);

🔼

cutscene_take_cap_off

Lua Example

cutscene_take_cap_off(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void cutscene_take_cap_off(struct MarioState *m);

🔼

general_star_dance_handler

Lua Example

general_star_dance_handler(m, isInWater)

Parameters

Field	Type
m	MarioState
isInWater	integer

Returns

• None

C Prototype

void general_star_dance_handler(struct MarioState *m, s32 isInWater);

🔼

generate_yellow_sparkles

Lua Example

generate_yellow_sparkles(x, y, z, radius)

Parameters

Field	Type
x	integer
y	integer
z	integer
radius	number

Returns

• None

C Prototype

void generate_yellow_sparkles(s16 x, s16 y, s16 z, f32 radius);

🔼

get_credits_str_width

Lua Example

local integerValue = get_credits_str_width(str)

Parameters

Field	Type
str	Pointer <integer>

Returns

• integer

C Prototype

s32 get_credits_str_width(char *str);

🔼

get_star_collection_dialog

Lua Example

local integerValue = get_star_collection_dialog(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 get_star_collection_dialog(struct MarioState *m);

🔼

handle_save_menu

Lua Example

handle_save_menu(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void handle_save_menu(struct MarioState *m);

🔼

launch_mario_until_land

Lua Example

local integerValue = launch_mario_until_land(m, endAction, animation, forwardVel)

Parameters

Field	Type
m	MarioState
endAction	integer
animation	integer
forwardVel	number

Returns

• integer

C Prototype

s32 launch_mario_until_land(struct MarioState *m, s32 endAction, s32 animation, f32 forwardVel);

🔼

mario_execute_cutscene_action

Lua Example

local integerValue = mario_execute_cutscene_action(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 mario_execute_cutscene_action(struct MarioState *m);

🔼

mario_ready_to_speak

Lua Example

local integerValue = mario_ready_to_speak(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 mario_ready_to_speak(struct MarioState* m);

🔼

should_start_or_continue_dialog

Lua Example

local integerValue = should_start_or_continue_dialog(m, object)

Parameters

Field	Type
m	MarioState
object	Object

Returns

• integer

C Prototype

u8 should_start_or_continue_dialog(struct MarioState* m, struct Object* object);

🔼

stuck_in_ground_handler

Lua Example

stuck_in_ground_handler(m, animation, unstuckFrame, target2, target3, endAction)

Parameters

Field	Type
m	MarioState
animation	integer
unstuckFrame	integer
target2	integer
target3	integer
endAction	integer

Returns

• None

C Prototype

void stuck_in_ground_handler(struct MarioState *m, s32 animation, s32 unstuckFrame, s32 target2, s32 target3, s32 endAction);

🔼

---

functions from mario_actions_moving.c

align_with_floor

Lua Example

align_with_floor(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void align_with_floor(struct MarioState *m);

🔼

analog_stick_held_back

Lua Example

local integerValue = analog_stick_held_back(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 analog_stick_held_back(struct MarioState *m);

🔼

anim_and_audio_for_heavy_walk

Lua Example

anim_and_audio_for_heavy_walk(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void anim_and_audio_for_heavy_walk(struct MarioState *m);

🔼

anim_and_audio_for_hold_walk

Lua Example

anim_and_audio_for_hold_walk(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void anim_and_audio_for_hold_walk(struct MarioState *m);

🔼

anim_and_audio_for_walk

Lua Example

anim_and_audio_for_walk(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void anim_and_audio_for_walk(struct MarioState *m);

🔼

apply_landing_accel

Lua Example

local integerValue = apply_landing_accel(m, frictionFactor)

Parameters

Field	Type
m	MarioState
frictionFactor	number

Returns

• integer

C Prototype

s32 apply_landing_accel(struct MarioState *m, f32 frictionFactor);

🔼

apply_slope_accel

Lua Example

apply_slope_accel(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void apply_slope_accel(struct MarioState *m);

🔼

apply_slope_decel

Lua Example

local integerValue = apply_slope_decel(m, decelCoef)

Parameters

Field	Type
m	MarioState
decelCoef	number

Returns

• integer

C Prototype

s32 apply_slope_decel(struct MarioState *m, f32 decelCoef);

🔼

begin_braking_action

Lua Example

local integerValue = begin_braking_action(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 begin_braking_action(struct MarioState *m);

🔼

begin_walking_action

Lua Example

local integerValue = begin_walking_action(m, forwardVel, action, actionArg)

Parameters

Field	Type
m	MarioState
forwardVel	number
action	integer
actionArg	integer

Returns

• integer

C Prototype

s32 begin_walking_action(struct MarioState *m, f32 forwardVel, u32 action, u32 actionArg);

🔼

check_common_moving_cancels

Lua Example

local integerValue = check_common_moving_cancels(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_common_moving_cancels(struct MarioState *m);

🔼

check_ground_dive_or_punch

Lua Example

local integerValue = check_ground_dive_or_punch(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_ground_dive_or_punch(struct MarioState *m);

🔼

check_ledge_climb_down

Lua Example

check_ledge_climb_down(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void check_ledge_climb_down(struct MarioState *m);

🔼

common_ground_knockback_action

Lua Example

local integerValue = common_ground_knockback_action(m, animation, arg2, arg3, arg4)

Parameters

Field	Type
m	MarioState
animation	integer
arg2	integer
arg3	integer
arg4	integer

Returns

• integer

C Prototype

s32 common_ground_knockback_action(struct MarioState *m, s32 animation, s32 arg2, s32 arg3, s32 arg4);

🔼

common_landing_action

Lua Example

local integerValue = common_landing_action(m, animation, airAction)

Parameters

Field	Type
m	MarioState
animation	integer
airAction	integer

Returns

• integer

C Prototype

u32 common_landing_action(struct MarioState *m, s16 animation, u32 airAction);

🔼

common_slide_action

Lua Example

common_slide_action(m, endAction, airAction, animation)

Parameters

Field	Type
m	MarioState
endAction	integer
airAction	integer
animation	integer

Returns

• None

C Prototype

void common_slide_action(struct MarioState *m, u32 endAction, u32 airAction, s32 animation);

🔼

common_slide_action_with_jump

Lua Example

local integerValue = common_slide_action_with_jump(m, stopAction, jumpAction, airAction, animation)

Parameters

Field	Type
m	MarioState
stopAction	integer
jumpAction	integer
airAction	integer
animation	integer

Returns

• integer

C Prototype

s32 common_slide_action_with_jump(struct MarioState *m, u32 stopAction, u32 jumpAction, u32 airAction, s32 animation);

🔼

mario_execute_moving_action

Lua Example

local integerValue = mario_execute_moving_action(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 mario_execute_moving_action(struct MarioState *m);

🔼

play_step_sound

Lua Example

play_step_sound(m, frame1, frame2)

Parameters

Field	Type
m	MarioState
frame1	integer
frame2	integer

Returns

• None

C Prototype

void play_step_sound(struct MarioState *m, s16 frame1, s16 frame2);

🔼

push_or_sidle_wall

Lua Example

push_or_sidle_wall(m, startPos)

Parameters

Field	Type
m	MarioState
startPos	Vec3f

Returns

• None

C Prototype

void push_or_sidle_wall(struct MarioState *m, Vec3f startPos);

🔼

quicksand_jump_land_action

Lua Example

local integerValue = quicksand_jump_land_action(m, animation1, animation2, endAction, airAction)

Parameters

Field	Type
m	MarioState
animation1	integer
animation2	integer
endAction	integer
airAction	integer

Returns

• integer

C Prototype

s32 quicksand_jump_land_action(struct MarioState *m, s32 animation1, s32 animation2, u32 endAction, u32 airAction);

🔼

set_triple_jump_action

Lua Example

local integerValue = set_triple_jump_action(m, action, actionArg)

Parameters

Field	Type
m	MarioState
action	integer
actionArg	integer

Returns

• integer

C Prototype

s32 set_triple_jump_action(struct MarioState *m, UNUSED u32 action, UNUSED u32 actionArg);

🔼

should_begin_sliding

Lua Example

local integerValue = should_begin_sliding(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 should_begin_sliding(struct MarioState *m);

🔼

slide_bonk

Lua Example

slide_bonk(m, fastAction, slowAction)

Parameters

Field	Type
m	MarioState
fastAction	integer
slowAction	integer

Returns

• None

C Prototype

void slide_bonk(struct MarioState *m, u32 fastAction, u32 slowAction);

🔼

stomach_slide_action

Lua Example

local integerValue = stomach_slide_action(m, stopAction, airAction, animation)

Parameters

Field	Type
m	MarioState
stopAction	integer
airAction	integer
animation	integer

Returns

• integer

C Prototype

s32 stomach_slide_action(struct MarioState *m, u32 stopAction, u32 airAction, s32 animation);

🔼

tilt_body_butt_slide

Lua Example

tilt_body_butt_slide(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void tilt_body_butt_slide(struct MarioState *m);

🔼

tilt_body_ground_shell

Lua Example

tilt_body_ground_shell(m, startYaw)

Parameters

Field	Type
m	MarioState
startYaw	integer

Returns

• None

C Prototype

void tilt_body_ground_shell(struct MarioState *m, s16 startYaw);

🔼

tilt_body_running

Lua Example

local integerValue = tilt_body_running(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s16 tilt_body_running(struct MarioState *m);

🔼

tilt_body_walking

Lua Example

tilt_body_walking(m, startYaw)

Parameters

Field	Type
m	MarioState
startYaw	integer

Returns

• None

C Prototype

void tilt_body_walking(struct MarioState *m, s16 startYaw);

🔼

update_decelerating_speed

Lua Example

local integerValue = update_decelerating_speed(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 update_decelerating_speed(struct MarioState *m);

🔼

update_shell_speed

Lua Example

update_shell_speed(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_shell_speed(struct MarioState *m);

🔼

update_sliding

Lua Example

local integerValue = update_sliding(m, stopSpeed)

Parameters

Field	Type
m	MarioState
stopSpeed	number

Returns

• integer

C Prototype

s32 update_sliding(struct MarioState *m, f32 stopSpeed);

🔼

update_sliding_angle

Lua Example

update_sliding_angle(m, accel, lossFactor)

Parameters

Field	Type
m	MarioState
accel	number
lossFactor	number

Returns

• None

C Prototype

void update_sliding_angle(struct MarioState *m, f32 accel, f32 lossFactor);

🔼

update_walking_speed

Lua Example

update_walking_speed(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void update_walking_speed(struct MarioState *m);

🔼

---

functions from mario_actions_object.c

animated_stationary_ground_step

Lua Example

animated_stationary_ground_step(m, animation, endAction)

Parameters

Field	Type
m	MarioState
animation	integer
endAction	integer

Returns

• None

C Prototype

void animated_stationary_ground_step(struct MarioState *m, s32 animation, u32 endAction);

🔼

check_common_object_cancels

Lua Example

local integerValue = check_common_object_cancels(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_common_object_cancels(struct MarioState *m);

🔼

mario_execute_object_action

Lua Example

local integerValue = mario_execute_object_action(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 mario_execute_object_action(struct MarioState *m);

🔼

mario_update_punch_sequence

Lua Example

local integerValue = mario_update_punch_sequence(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 mario_update_punch_sequence(struct MarioState *m);

🔼

---

functions from mario_actions_stationary.c

check_common_hold_idle_cancels

Lua Example

local integerValue = check_common_hold_idle_cancels(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_common_hold_idle_cancels(struct MarioState *m);

🔼

check_common_idle_cancels

Lua Example

local integerValue = check_common_idle_cancels(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_common_idle_cancels(struct MarioState *m);

🔼

check_common_landing_cancels

Lua Example

local integerValue = check_common_landing_cancels(m, action)

Parameters

Field	Type
m	MarioState
action	integer

Returns

• integer

C Prototype

s32 check_common_landing_cancels(struct MarioState *m, u32 action);

🔼

check_common_stationary_cancels

Lua Example

local integerValue = check_common_stationary_cancels(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 check_common_stationary_cancels(struct MarioState *m);

🔼

landing_step

Lua Example

local integerValue = landing_step(m, arg1, action)

Parameters

Field	Type
m	MarioState
arg1	integer
action	integer

Returns

• integer

C Prototype

s32 landing_step(struct MarioState *m, s32 arg1, u32 action);

🔼

mario_execute_stationary_action

Lua Example

local integerValue = mario_execute_stationary_action(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 mario_execute_stationary_action(struct MarioState *m);

🔼

play_anim_sound

Lua Example

play_anim_sound(m, actionState, animFrame, sound)

Parameters

Field	Type
m	MarioState
actionState	integer
animFrame	integer
sound	integer

Returns

• None

C Prototype

void play_anim_sound(struct MarioState *m, u32 actionState, s32 animFrame, u32 sound);

🔼

stopping_step

Lua Example

stopping_step(m, animID, action)

Parameters

Field	Type
m	MarioState
animID	integer
action	integer

Returns

• None

C Prototype

void stopping_step(struct MarioState *m, s32 animID, u32 action);

🔼

---

functions from mario_actions_submerged.c

apply_water_current

Lua Example

apply_water_current(m, step)

Parameters

Field	Type
m	MarioState
step	Vec3f

Returns

• None

C Prototype

void apply_water_current(struct MarioState *m, Vec3f step);

🔼

float_surface_gfx

Lua Example

float_surface_gfx(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void float_surface_gfx(struct MarioState *m);

🔼

mario_execute_submerged_action

Lua Example

local integerValue = mario_execute_submerged_action(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

s32 mario_execute_submerged_action(struct MarioState *m);

🔼

perform_water_full_step

Lua Example

local integerValue = perform_water_full_step(m, nextPos)

Parameters

Field	Type
m	MarioState
nextPos	Vec3f

Returns

• integer

C Prototype

u32 perform_water_full_step(struct MarioState *m, Vec3f nextPos);

🔼

perform_water_step

Lua Example

local integerValue = perform_water_step(m)

Parameters

Field	Type
m	MarioState

Returns

• integer

C Prototype

u32 perform_water_step(struct MarioState *m);

🔼

set_swimming_at_surface_particles

Lua Example

set_swimming_at_surface_particles(m, particleFlag)

Parameters

Field	Type
m	MarioState
particleFlag	integer

Returns

• None

C Prototype

void set_swimming_at_surface_particles(struct MarioState *m, u32 particleFlag);

🔼

---

functions from mario_misc.h

bhv_toad_message_init

Lua Example

bhv_toad_message_init()

Parameters

• None

Returns

• None

C Prototype

void bhv_toad_message_init(void);

🔼

bhv_toad_message_loop

Lua Example

bhv_toad_message_loop()

Parameters

• None

Returns

• None

C Prototype

void bhv_toad_message_loop(void);

🔼

bhv_unlock_door_star_init

Lua Example

bhv_unlock_door_star_init()

Parameters

• None

Returns

• None

C Prototype

void bhv_unlock_door_star_init(void);

🔼

bhv_unlock_door_star_loop

Lua Example

bhv_unlock_door_star_loop()

Parameters

• None

Returns

• None

C Prototype

void bhv_unlock_door_star_loop(void);

🔼

---

functions from mario_step.h

get_additive_y_vel_for_jumps

Lua Example

local numberValue = get_additive_y_vel_for_jumps()

Parameters

• None

Returns

• number

C Prototype

f32 get_additive_y_vel_for_jumps(void);

🔼

init_bully_collision_data

Lua Example

init_bully_collision_data(data, posX, posZ, forwardVel, yaw, conversionRatio, radius)

Parameters

Field	Type
data	BullyCollisionData
posX	number
posZ	number
forwardVel	number
yaw	integer
conversionRatio	number
radius	number

Returns

• None

C Prototype

void init_bully_collision_data(struct BullyCollisionData *data, f32 posX, f32 posZ, f32 forwardVel, s16 yaw, f32 conversionRatio, f32 radius);

🔼

mario_bonk_reflection

Lua Example

mario_bonk_reflection(arg0, arg1)

Parameters

Field	Type
arg0	MarioState
arg1	integer

Returns

• None

C Prototype

void mario_bonk_reflection(struct MarioState *, u32);

🔼

mario_push_off_steep_floor

Lua Example

local integerValue = mario_push_off_steep_floor(arg0, arg1, arg2)

Parameters

Field	Type
arg0	MarioState
arg1	integer
arg2	integer

Returns

• integer

C Prototype

u32 mario_push_off_steep_floor(struct MarioState *, u32, u32);

🔼

mario_update_moving_sand

Lua Example

local integerValue = mario_update_moving_sand(arg0)

Parameters

Field	Type
arg0	MarioState

Returns

• integer

C Prototype

u32 mario_update_moving_sand(struct MarioState *);

🔼

mario_update_quicksand

Lua Example

local integerValue = mario_update_quicksand(arg0, arg1)

Parameters

Field	Type
arg0	MarioState
arg1	number

Returns

• integer

C Prototype

u32 mario_update_quicksand(struct MarioState *, f32);

🔼

mario_update_windy_ground

Lua Example

local integerValue = mario_update_windy_ground(arg0)

Parameters

Field	Type
arg0	MarioState

Returns

• integer

C Prototype

u32 mario_update_windy_ground(struct MarioState *);

🔼

perform_air_step

Lua Example

local integerValue = perform_air_step(arg0, arg1)

Parameters

Field	Type
arg0	MarioState
arg1	integer

Returns

• integer

C Prototype

s32 perform_air_step(struct MarioState *, u32);

🔼

perform_ground_step

Lua Example

local integerValue = perform_ground_step(arg0)

Parameters

Field	Type
arg0	MarioState

Returns

• integer

C Prototype

s32 perform_ground_step(struct MarioState *);

🔼

set_vel_from_pitch_and_yaw

Lua Example

set_vel_from_pitch_and_yaw(m)

Parameters

Field	Type
m	MarioState

Returns

• None

C Prototype

void set_vel_from_pitch_and_yaw(struct MarioState* m);

🔼

stationary_ground_step

Lua Example

local integerValue = stationary_ground_step(arg0)

Parameters

Field	Type
arg0	MarioState

Returns

• integer

C Prototype

s32 stationary_ground_step(struct MarioState *);

🔼

stop_and_set_height_to_floor

Lua Example

stop_and_set_height_to_floor(arg0)

Parameters

Field	Type
arg0	MarioState

Returns

• None

C Prototype

void stop_and_set_height_to_floor(struct MarioState *);

🔼

---

functions from math_util.h

anim_spline_init

Lua Example

anim_spline_init(m, keyFrames)

Parameters

Field	Type
m	MarioState
keyFrames	Pointer <Vec4s>

Returns

• None

C Prototype

void anim_spline_init(struct MarioState* m, Vec4s *keyFrames);

🔼

anim_spline_poll

Lua Example

local integerValue = anim_spline_poll(m, result)

Parameters

Field	Type
m	MarioState
result	Vec3f

Returns

• integer

C Prototype

s32 anim_spline_poll(struct MarioState* m, Vec3f result);

🔼

approach_f32

Lua Example

local numberValue = approach_f32(current, target, inc, dec)

Parameters

Field	Type
current	number
target	number
inc	number
dec	number

Returns

• number

C Prototype

f32 approach_f32(f32 current, f32 target, f32 inc, f32 dec);

🔼

approach_s32

Lua Example

local integerValue = approach_s32(current, target, inc, dec)

Parameters

Field	Type
current	integer
target	integer
inc	integer
dec	integer

Returns

• integer

C Prototype

s32 approach_s32(s32 current, s32 target, s32 inc, s32 dec);

🔼

find_vector_perpendicular_to_plane

Lua Example

local voidValue = find_vector_perpendicular_to_plane(dest, a, b, c)

Parameters

Field	Type
dest	Vec3f
a	Vec3f
b	Vec3f
c	Vec3f

Returns

• void *

C Prototype

void *find_vector_perpendicular_to_plane(Vec3f dest, Vec3f a, Vec3f b, Vec3f c);

🔼

get_pos_from_transform_mtx

Lua Example

get_pos_from_transform_mtx(dest, objMtx, camMtx)

Parameters

Field	Type
dest	Vec3f
objMtx	Mat4
camMtx	Mat4

Returns

• None

C Prototype

void get_pos_from_transform_mtx(Vec3f dest, Mat4 objMtx, Mat4 camMtx);

🔼

mtxf_align_terrain_normal

Lua Example

mtxf_align_terrain_normal(dest, upDir, pos, yaw)

Parameters

Field	Type
dest	Mat4
upDir	Vec3f
pos	Vec3f
yaw	integer

Returns

• None

C Prototype

void mtxf_align_terrain_normal(Mat4 dest, Vec3f upDir, Vec3f pos, s16 yaw);

🔼

mtxf_align_terrain_triangle

Lua Example

mtxf_align_terrain_triangle(mtx, pos, yaw, radius)

Parameters

Field	Type
mtx	Mat4
pos	Vec3f
yaw	integer
radius	number

Returns

• None

C Prototype

void mtxf_align_terrain_triangle(Mat4 mtx, Vec3f pos, s16 yaw, f32 radius);

🔼

mtxf_billboard

Lua Example

mtxf_billboard(dest, mtx, position, angle)

Parameters

Field	Type
dest	Mat4
mtx	Mat4
position	Vec3f
angle	integer

Returns

• None

C Prototype

void mtxf_billboard(Mat4 dest, Mat4 mtx, Vec3f position, s16 angle);

🔼

mtxf_copy

Lua Example

mtxf_copy(dest, src)

Parameters

Field	Type
dest	Mat4
src	Mat4

Returns

• None

C Prototype

void mtxf_copy(Mat4 dest, Mat4 src);

🔼

mtxf_cylboard

Lua Example

mtxf_cylboard(dest, mtx, position, angle)

Parameters

Field	Type
dest	Mat4
mtx	Mat4
position	Vec3f
angle	integer

Returns

• None

C Prototype

void mtxf_cylboard(Mat4 dest, Mat4 mtx, Vec3f position, s16 angle);

🔼

mtxf_identity

Lua Example

mtxf_identity(mtx)

Parameters

Field	Type
mtx	Mat4

Returns

• None

C Prototype

void mtxf_identity(Mat4 mtx);

🔼

mtxf_inverse

Lua Example

mtxf_inverse(dest, src)

Parameters

Field	Type
dest	Mat4
src	Mat4

Returns

• None

C Prototype

void mtxf_inverse(Mat4 dest, Mat4 src);

🔼

mtxf_lookat

Lua Example

mtxf_lookat(mtx, from, to, roll)

Parameters

Field	Type
mtx	Mat4
from	Vec3f
to	Vec3f
roll	integer

Returns

• None

C Prototype

void mtxf_lookat(Mat4 mtx, Vec3f from, Vec3f to, s16 roll);

🔼

mtxf_mul

Lua Example

mtxf_mul(dest, a, b)

Parameters

Field	Type
dest	Mat4
a	Mat4
b	Mat4

Returns

• None

C Prototype

void mtxf_mul(Mat4 dest, Mat4 a, Mat4 b);

🔼

mtxf_mul_vec3s

Lua Example

mtxf_mul_vec3s(mtx, b)

Parameters

Field	Type
mtx	Mat4
b	Vec3s

Returns

• None

C Prototype

void mtxf_mul_vec3s(Mat4 mtx, Vec3s b);

🔼

mtxf_rotate_xy

Lua Example

mtxf_rotate_xy(mtx, angle)

Parameters

Field	Type
mtx	Pointer <Mtx>
angle	integer

Returns

• None

C Prototype

void mtxf_rotate_xy(Mtx *mtx, s16 angle);

🔼

mtxf_rotate_xyz_and_translate

Lua Example

mtxf_rotate_xyz_and_translate(dest, b, c)

Parameters

Field	Type
dest	Mat4
b	Vec3f
c	Vec3s

Returns

• None

C Prototype

void mtxf_rotate_xyz_and_translate(Mat4 dest, Vec3f b, Vec3s c);

🔼

mtxf_rotate_zxy_and_translate

Lua Example

mtxf_rotate_zxy_and_translate(dest, translate, rotate)

Parameters

Field	Type
dest	Mat4
translate	Vec3f
rotate	Vec3s

Returns

• None

C Prototype

void mtxf_rotate_zxy_and_translate(Mat4 dest, Vec3f translate, Vec3s rotate);

🔼

mtxf_scale_vec3f

Lua Example

mtxf_scale_vec3f(dest, mtx, s)

Parameters

Field	Type
dest	Mat4
mtx	Mat4
s	Vec3f

Returns

• None

C Prototype

void mtxf_scale_vec3f(Mat4 dest, Mat4 mtx, Vec3f s);

🔼

mtxf_to_mtx

Lua Example

mtxf_to_mtx(dest, src)

Parameters

Field	Type
dest	Pointer <Mtx>
src	Mat4

Returns

• None

C Prototype

void mtxf_to_mtx(Mtx *dest, Mat4 src);

🔼

mtxf_translate

Lua Example

mtxf_translate(dest, b)

Parameters

Field	Type
dest	Mat4
b	Vec3f

Returns

• None

C Prototype

void mtxf_translate(Mat4 dest, Vec3f b);

🔼

not_zero

Lua Example

local numberValue = not_zero(value, replacement)

Parameters

Field	Type
value	number
replacement	number

Returns

• number

C Prototype

f32 not_zero(f32 value, f32 replacement);

🔼

spline_get_weights

Lua Example

spline_get_weights(m, result, t, c)

Parameters

Field	Type
m	MarioState
result	Vec4f
t	number
c	integer

Returns

• None

C Prototype

void spline_get_weights(struct MarioState* m, Vec4f result, f32 t, UNUSED s32 c);

🔼

vec3f_add

Lua Example

local voidValue = vec3f_add(dest, a)

Parameters

Field	Type
dest	Vec3f
a	Vec3f

Returns

• void *

C Prototype

void *vec3f_add(Vec3f dest, Vec3f a);

🔼

vec3f_combine

Lua Example

vec3f_combine(dest, vecA, vecB, sclA, sclB)

Parameters

Field	Type
dest	Vec3f
vecA	Vec3f
vecB	Vec3f
sclA	number
sclB	number

Returns

• None

C Prototype

void vec3f_combine(Vec3f dest, Vec3f vecA, Vec3f vecB, f32 sclA, f32 sclB);

🔼

vec3f_copy

Lua Example

local voidValue = vec3f_copy(dest, src)

Parameters

Field	Type
dest	Vec3f
src	Vec3f

Returns

• void *

C Prototype

void *vec3f_copy(Vec3f dest, Vec3f src);

🔼

vec3f_cross

Lua Example

local voidValue = vec3f_cross(dest, a, b)

Parameters

Field	Type
dest	Vec3f
a	Vec3f
b	Vec3f

Returns

• void *

C Prototype

void *vec3f_cross(Vec3f dest, Vec3f a, Vec3f b);

🔼

vec3f_dif

Lua Example

local voidValue = vec3f_dif(dest, a, b)

Parameters

Field	Type
dest	Vec3f
a	Vec3f
b	Vec3f

Returns

• void *

C Prototype

void *vec3f_dif(Vec3f dest, Vec3f a, Vec3f b);

🔼

vec3f_dist

Lua Example

local numberValue = vec3f_dist(v1, v2)

Parameters

Field	Type
v1	Vec3f
v2	Vec3f

Returns

• number

C Prototype

f32 vec3f_dist(Vec3f v1, Vec3f v2);

🔼

vec3f_dot

Lua Example

local numberValue = vec3f_dot(a, b)

Parameters

Field	Type
a	Vec3f
b	Vec3f

Returns

• number

C Prototype

f32 vec3f_dot(Vec3f a, Vec3f b);

🔼

vec3f_get_dist_and_angle

Lua Example

vec3f_get_dist_and_angle(from, to, dist, pitch, yaw)

Parameters

Field	Type
from	Vec3f
to	Vec3f
dist	Pointer <number>
pitch	Pointer <integer>
yaw	Pointer <integer>

Returns

• None

C Prototype

void vec3f_get_dist_and_angle(Vec3f from, Vec3f to, f32 *dist, s16 *pitch, s16 *yaw);

🔼

vec3f_length

Lua Example

local numberValue = vec3f_length(a)

Parameters

Field	Type
a	Vec3f

Returns

• number

C Prototype

f32 vec3f_length(Vec3f a);

🔼

vec3f_mul

Lua Example

local voidValue = vec3f_mul(dest, a)

Parameters

Field	Type
dest	Vec3f
a	number

Returns

• void *

C Prototype

void *vec3f_mul(Vec3f dest, f32 a);

🔼

vec3f_normalize

Lua Example

local voidValue = vec3f_normalize(dest)

Parameters

Field	Type
dest	Vec3f

Returns

• void *

C Prototype

void *vec3f_normalize(Vec3f dest);

🔼

vec3f_project

Lua Example

vec3f_project(vec, onto, out)

Parameters

Field	Type
vec	Vec3f
onto	Vec3f
out	Vec3f

Returns

• None

C Prototype

void vec3f_project(Vec3f vec, Vec3f onto, Vec3f out);

🔼

vec3f_rotate_zxy

Lua Example

local voidValue = vec3f_rotate_zxy(v, rotate)

Parameters

Field	Type
v	Vec3f
rotate	Vec3s

Returns

• void *

C Prototype

void *vec3f_rotate_zxy(Vec3f v, Vec3s rotate);

🔼

vec3f_set

Lua Example

local voidValue = vec3f_set(dest, x, y, z)

Parameters

Field	Type
dest	Vec3f
x	number
y	number
z	number

Returns

• void *

C Prototype

void *vec3f_set(Vec3f dest, f32 x, f32 y, f32 z);

🔼

vec3f_set_dist_and_angle

Lua Example

vec3f_set_dist_and_angle(from, to, dist, pitch, yaw)

Parameters

Field	Type
from	Vec3f
to	Vec3f
dist	number
pitch	integer
yaw	integer

Returns

• None

C Prototype

void vec3f_set_dist_and_angle(Vec3f from, Vec3f to, f32 dist, s16 pitch, s16 yaw);

🔼

vec3f_sum

Lua Example

local voidValue = vec3f_sum(dest, a, b)

Parameters

Field	Type
dest	Vec3f
a	Vec3f
b	Vec3f

Returns

• void *

C Prototype

void *vec3f_sum(Vec3f dest, Vec3f a, Vec3f b);

🔼

vec3f_to_vec3s

Lua Example

local voidValue = vec3f_to_vec3s(dest, a)

Parameters

Field	Type
dest	Vec3s
a	Vec3f

Returns

• void *

C Prototype

void *vec3f_to_vec3s(Vec3s dest, Vec3f a);

🔼

vec3s_add

Lua Example

local voidValue = vec3s_add(dest, a)

Parameters

Field	Type
dest	Vec3s
a	Vec3s

Returns

• void *

C Prototype

void *vec3s_add(Vec3s dest, Vec3s a);

🔼

vec3s_copy

Lua Example

local voidValue = vec3s_copy(dest, src)

Parameters

Field	Type
dest	Vec3s
src	Vec3s

Returns

• void *

C Prototype

void *vec3s_copy(Vec3s dest, Vec3s src);

🔼

vec3s_set

Lua Example

local voidValue = vec3s_set(dest, x, y, z)

Parameters

Field	Type
dest	Vec3s
x	integer
y	integer
z	integer

Returns

• void *

C Prototype

void *vec3s_set(Vec3s dest, s16 x, s16 y, s16 z);

🔼

vec3s_sum

Lua Example

local voidValue = vec3s_sum(dest, a, b)

Parameters

Field	Type
dest	Vec3s
a	Vec3s
b	Vec3s

Returns

• void *

C Prototype

void *vec3s_sum(Vec3s dest, Vec3s a, Vec3s b);

🔼

vec3s_to_vec3f

Lua Example

local voidValue = vec3s_to_vec3f(dest, a)

Parameters

Field	Type
dest	Vec3f
a	Vec3s

Returns

• void *

C Prototype

void *vec3s_to_vec3f(Vec3f dest, Vec3s a);

🔼

---

functions from misc.h

update_all_mario_stars

Lua Example

update_all_mario_stars()

Parameters

• None

Returns

• None

C Prototype

void update_all_mario_stars(void);

🔼

---

functions from mod_storage.h

mod_storage_clear

Lua Example

local booleanValue = mod_storage_clear()

Parameters

• None

Returns

• boolean

C Prototype

bool mod_storage_clear(void);

🔼

mod_storage_load

Lua Example

local stringValue = mod_storage_load(key)

Parameters

Field	Type
key	string

Returns

• string

C Prototype

const char *mod_storage_load(const char* key);

🔼

mod_storage_load_bool

Lua Example

local booleanValue = mod_storage_load_bool(key)

Parameters

Field	Type
key	string

Returns

• boolean

C Prototype

bool mod_storage_load_bool(const char* key);

🔼

mod_storage_load_number

Lua Example

local numberValue = mod_storage_load_number(key)

Parameters

Field	Type
key	string

Returns

• number

C Prototype

double mod_storage_load_number(const char* key);

🔼

mod_storage_remove

Lua Example

local booleanValue = mod_storage_remove(key)

Parameters

Field	Type
key	string

Returns

• boolean

C Prototype

bool mod_storage_remove(const char* key);

🔼

mod_storage_save

Lua Example

local booleanValue = mod_storage_save(key, value)

Parameters

Field	Type
key	string
value	string

Returns

• boolean

C Prototype

bool mod_storage_save(const char* key, const char* value);

🔼

mod_storage_save_bool

Lua Example

local booleanValue = mod_storage_save_bool(key, value)

Parameters

Field	Type
key	string
value	boolean

Returns

• boolean

C Prototype

bool mod_storage_save_bool(const char* key, bool value);

🔼

mod_storage_save_number

Lua Example

local booleanValue = mod_storage_save_number(key, value)

Parameters

Field	Type
key	string
value	number

Returns

• boolean

C Prototype

bool mod_storage_save_number(const char* key, double value);

🔼

---

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