Hri7566
/
sm64coopdx
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
sm64coopdx/docs/lua/functions.md

272 KiB
Raw Blame History

⏪ Lua Reference

Supported Functions



































manually written functions


define_custom_obj_fields

Defines a custom set of overlapping object fields.

The fieldTable table's keys must start with the letter o and the values must be either u32, s32, or f32.

Lua Example

define_custom_obj_fields({ oCustomField1 = 'u32', oCustomField2 = 's32', oCustomField3 = 'f32' })

Parameters

Field Type
fieldTable Lua Table

C Prototype

N/A

🔼

network_init_object

Enables synchronization on an object.

  • Setting standardSync to true will automatically synchronize the object at a rate that is determined based on player distance. The commonly used object fields will be automatically synchronized.
  • Setting standardSync to false will not automatically synchronize the object, or add commonly used object fields. The mod must manually call network_send_object() when fields have changed.

The fieldTable parameter can be nil, or a list of object fields.

Lua Example

network_init_object(obj, true, { 'oCustomField1', 'oCustomField2', 'oCustomField3' })

Parameters

Field Type
object Object
standardSync bool
fieldTable Lua Table

C Prototype

N/A

🔼


network_send_object

Sends a packet that synchronizes an object. This does not need to be called when standardSync is enabled.

The reliable field will ensure that the packet arrives, but should be used sparingly and only when missing a packet would cause a desync.

Lua Example

network_send_object(obj, false)

Parameters

Field Type
object Object
reliable bool

C Prototype

N/A

🔼


functions from behavior_table.h


get_behavior_from_id

Lua Example

local PointerValue = get_behavior_from_id(id)

Parameters

Field Type
id enum BehaviorId

Returns

  • Pointer <BehaviorScript>

C Prototype

const BehaviorScript* get_behavior_from_id(enum BehaviorId id);

🔼


get_id_from_behavior

Lua Example

local enumValue = get_id_from_behavior(behavior)

Parameters

Field Type
behavior Pointer <BehaviorScript>

Returns

enum BehaviorId

C Prototype

enum BehaviorId get_id_from_behavior(const BehaviorScript* behavior);

🔼


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

🔼


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

🔼


move_point_along_spline

Lua Example

local integerValue = move_point_along_spline(p, spline[], splineSegment, progress)

Parameters

Field Type
p Vec3f
spline[] CutsceneSplinePoint
splineSegment Pointer <integer>
progress Pointer <number>

Returns

  • integer

C Prototype

s32 move_point_along_spline(Vec3f p, struct CutsceneSplinePoint spline[], s16 *splineSegment, f32 *progress);

🔼


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

🔼


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_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_hud_utils.h


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_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, float x, float y, float 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_texture

Lua Example

djui_hud_render_texture(texInfo, x, y, scaleW, scaleH)

Parameters

Field Type
texInfo TextureInfo
x number
y number
scaleW number
scaleH number

Returns

  • None

C Prototype

void djui_hud_render_texture(struct TextureInfo* texInfo, f32 x, f32 y, f32 scaleW, f32 scaleH);

🔼


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_font

Lua Example

djui_hud_set_font(fontType)

Parameters

Field Type
fontType enum DjuiFontType

Returns

  • None

C Prototype

void djui_hud_set_font(enum DjuiFontType fontType);

🔼


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

🔼


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


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

🔼


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

🔼


functions from interaction.h


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


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

🔼


print_displaying_credits_entry

Lua Example

print_displaying_credits_entry()

Parameters

  • None

Returns

  • None

C Prototype

void print_displaying_credits_entry(void);

🔼


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_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 network_player.h


get_network_player_from_area

Lua Example

local NetworkPlayerValue = get_network_player_from_area(courseNum, actNum, levelNum, areaIndex)

Parameters

Field Type
courseNum integer
actNum integer
levelNum integer
areaIndex integer

Returns

NetworkPlayer

C Prototype

struct NetworkPlayer* get_network_player_from_area(s16 courseNum, s16 actNum, s16 levelNum, s16 areaIndex);

🔼


get_network_player_from_level

Lua Example

local NetworkPlayerValue = get_network_player_from_level(courseNum, actNum, levelNum)

Parameters

Field Type
courseNum integer
actNum integer
levelNum integer

Returns

NetworkPlayer

C Prototype

struct NetworkPlayer* get_network_player_from_level(s16 courseNum, s16 actNum, s16 levelNum);

🔼


get_network_player_smallest_global

Lua Example

local NetworkPlayerValue = get_network_player_smallest_global()

Parameters

  • None

Returns

NetworkPlayer

C Prototype

struct NetworkPlayer* get_network_player_smallest_global(void);

🔼


network_player_connected_count

Lua Example

local integerValue = network_player_connected_count()

Parameters

  • None

Returns

  • integer

C Prototype

u8 network_player_connected_count(void);

🔼


network_player_from_global_index

Lua Example

local NetworkPlayerValue = network_player_from_global_index(globalIndex)

Parameters

Field Type
globalIndex integer

Returns

NetworkPlayer

C Prototype

struct NetworkPlayer* network_player_from_global_index(u8 globalIndex);

🔼


network_player_set_description

Lua Example

network_player_set_description(np, description, r, g, b, a)

Parameters

Field Type
np NetworkPlayer
description string
r integer
g integer
b integer
a integer

Returns

  • None

C Prototype

void network_player_set_description(struct NetworkPlayer* np, const char* description, u8 r, u8 g, u8 b, u8 a);

🔼


functions from network_utils.h


network_get_player_text_color_string

Lua Example

local stringValue = network_get_player_text_color_string(localIndex)

Parameters

Field Type
localIndex integer

Returns

  • string

C Prototype

char* network_get_player_text_color_string(u8 localIndex);

🔼


network_global_index_from_local

Lua Example

local integerValue = network_global_index_from_local(localIndex)

Parameters

Field Type
localIndex integer

Returns

  • integer

C Prototype

u8 network_global_index_from_local(u8 localIndex);

🔼


network_is_server

Lua Example

local booleanValue = network_is_server()

Parameters

  • None

Returns

  • boolean

C Prototype

bool network_is_server(void);

🔼


network_local_index_from_global

Lua Example

local integerValue = network_local_index_from_global(globalIndex)

Parameters

Field Type
globalIndex integer

Returns

  • integer

C Prototype

u8 network_local_index_from_global(u8 globalIndex);

🔼


functions from obj_behaviors.c


absf_2

Lua Example

local numberValue = absf_2(f)

Parameters

Field Type
f number

Returns

  • number

C Prototype

f32 absf_2(f32 f);

🔼


calc_new_obj_vel_and_pos_y

Lua Example

calc_new_obj_vel_and_pos_y(objFloor, objFloorY, objVelX, objVelZ)

Parameters

Field Type
objFloor Surface
objFloorY number
objVelX number
objVelZ number

Returns

  • None

C Prototype

void calc_new_obj_vel_and_pos_y(struct Surface *objFloor, f32 objFloorY, f32 objVelX, f32 objVelZ);

🔼


calc_new_obj_vel_and_pos_y_underwater

Lua Example

calc_new_obj_vel_and_pos_y_underwater(objFloor, floorY, objVelX, objVelZ, waterY)

Parameters

Field Type
objFloor Surface
floorY number
objVelX number
objVelZ number
waterY number

Returns

  • None

C Prototype

void calc_new_obj_vel_and_pos_y_underwater(struct Surface *objFloor, f32 floorY, f32 objVelX, f32 objVelZ, f32 waterY);

🔼


calc_obj_friction

Lua Example

calc_obj_friction(objFriction, floor_nY)

Parameters

Field Type
objFriction Pointer <number>
floor_nY number

Returns

  • None

C Prototype

void calc_obj_friction(f32 *objFriction, f32 floor_nY);

🔼


current_mario_room_check

Lua Example

local integerValue = current_mario_room_check(room)

Parameters

Field Type
room integer

Returns

  • integer

C Prototype

s8 current_mario_room_check(s16 room);

🔼


is_nearest_mario_state_to_object

Lua Example

local integerValue = is_nearest_mario_state_to_object(m, obj)

Parameters

Field Type
m MarioState
obj Object

Returns

  • integer

C Prototype

u8 is_nearest_mario_state_to_object(struct MarioState *m, struct Object *obj);

🔼


is_nearest_player_to_object

Lua Example

local integerValue = is_nearest_player_to_object(m, obj)

Parameters

Field Type
m Object
obj Object

Returns

  • integer

C Prototype

u8 is_nearest_player_to_object(struct Object *m, struct Object *obj);

🔼


is_player_active

Lua Example

local integerValue = is_player_active(m)

Parameters

Field Type
m MarioState

Returns

  • integer

C Prototype

u8 is_player_active(struct MarioState* m);

🔼


is_point_close_to_object

Lua Example

local integerValue = is_point_close_to_object(obj, x, y, z, dist)

Parameters

Field Type
obj Object
x number
y number
z number
dist integer

Returns

  • integer

C Prototype

s8 is_point_close_to_object(struct Object *obj, f32 x, f32 y, f32 z, s32 dist);

🔼


is_point_within_radius_of_mario

Lua Example

local integerValue = is_point_within_radius_of_mario(x, y, z, dist)

Parameters

Field Type
x number
y number
z number
dist integer

Returns

  • integer

C Prototype

s8 is_point_within_radius_of_mario(f32 x, f32 y, f32 z, s32 dist);

🔼


nearest_mario_state_to_object

Lua Example

local MarioStateValue = nearest_mario_state_to_object(obj)

Parameters

Field Type
obj Object

Returns

MarioState

C Prototype

struct MarioState* nearest_mario_state_to_object(struct Object *obj);

🔼


nearest_player_to_object

Lua Example

local ObjectValue = nearest_player_to_object(obj)

Parameters

Field Type
obj Object

Returns

Object

C Prototype

struct Object* nearest_player_to_object(struct Object *obj);

🔼


obj_check_floor_death

Lua Example

obj_check_floor_death(collisionFlags, floor)

Parameters

Field Type
collisionFlags integer
floor Surface

Returns

  • None

C Prototype

void obj_check_floor_death(s16 collisionFlags, struct Surface *floor);

🔼


obj_check_if_facing_toward_angle

Lua Example

local integerValue = obj_check_if_facing_toward_angle(base, goal, range)

Parameters

Field Type
base integer
goal integer
range integer

Returns

  • integer

C Prototype

s8 obj_check_if_facing_toward_angle(u32 base, u32 goal, s16 range);

🔼


obj_find_wall

Lua Example

local integerValue = obj_find_wall(objNewX, objY, objNewZ, objVelX, objVelZ)

Parameters

Field Type
objNewX number
objY number
objNewZ number
objVelX number
objVelZ number

Returns

  • integer

C Prototype

s8 obj_find_wall(f32 objNewX, f32 objY, f32 objNewZ, f32 objVelX, f32 objVelZ);

🔼


obj_find_wall_displacement

Lua Example

local integerValue = obj_find_wall_displacement(dist, x, y, z, radius)

Parameters

Field Type
dist Vec3f
x number
y number
z number
radius number

Returns

  • integer

C Prototype

s8 obj_find_wall_displacement(Vec3f dist, f32 x, f32 y, f32 z, f32 radius);

🔼


obj_flicker_and_disappear

Lua Example

local integerValue = obj_flicker_and_disappear(obj, lifeSpan)

Parameters

Field Type
obj Object
lifeSpan integer

Returns

  • integer

C Prototype

s8 obj_flicker_and_disappear(struct Object *obj, s16 lifeSpan);

🔼


obj_lava_death

Lua Example

local integerValue = obj_lava_death()

Parameters

  • None

Returns

  • integer

C Prototype

s8 obj_lava_death(void);

🔼


obj_move_xyz_using_fvel_and_yaw

Lua Example

obj_move_xyz_using_fvel_and_yaw(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_move_xyz_using_fvel_and_yaw(struct Object *obj);

🔼


obj_orient_graph

Lua Example

obj_orient_graph(obj, normalX, normalY, normalZ)

Parameters

Field Type
obj Object
normalX number
normalY number
normalZ number

Returns

  • None

C Prototype

void obj_orient_graph(struct Object *obj, f32 normalX, f32 normalY, f32 normalZ);

🔼


obj_return_and_displace_home

Lua Example

obj_return_and_displace_home(obj, homeX, homeY, homeZ, baseDisp)

Parameters

Field Type
obj Object
homeX number
homeY number
homeZ number
baseDisp integer

Returns

  • None

C Prototype

void obj_return_and_displace_home(struct Object *obj, f32 homeX, UNUSED f32 homeY, f32 homeZ, s32 baseDisp);

🔼


obj_return_home_if_safe

Lua Example

local integerValue = obj_return_home_if_safe(obj, homeX, y, homeZ, dist)

Parameters

Field Type
obj Object
homeX number
y number
homeZ number
dist integer

Returns

  • integer

C Prototype

s8 obj_return_home_if_safe(struct Object *obj, f32 homeX, f32 y, f32 homeZ, s32 dist);

🔼


obj_spawn_yellow_coins

Lua Example

obj_spawn_yellow_coins(obj, nCoins)

Parameters

Field Type
obj Object
nCoins integer

Returns

  • None

C Prototype

void obj_spawn_yellow_coins(struct Object *obj, s8 nCoins);

🔼


obj_splash

Lua Example

obj_splash(waterY, objY)

Parameters

Field Type
waterY integer
objY integer

Returns

  • None

C Prototype

void obj_splash(s32 waterY, s32 objY);

🔼


obj_update_pos_vel_xz

Lua Example

obj_update_pos_vel_xz()

Parameters

  • None

Returns

  • None

C Prototype

void obj_update_pos_vel_xz(void);

🔼


object_step

Lua Example

local integerValue = object_step()

Parameters

  • None

Returns

  • integer

C Prototype

s16 object_step(void);

🔼


object_step_without_floor_orient

Lua Example

local integerValue = object_step_without_floor_orient()

Parameters

  • None

Returns

  • integer

C Prototype

s16 object_step_without_floor_orient(void);

🔼


set_object_visibility

Lua Example

set_object_visibility(obj, dist)

Parameters

Field Type
obj Object
dist integer

Returns

  • None

C Prototype

void set_object_visibility(struct Object *obj, s32 dist);

🔼


set_yoshi_as_not_dead

Lua Example

set_yoshi_as_not_dead()

Parameters

  • None

Returns

  • None

C Prototype

void set_yoshi_as_not_dead(void);

🔼


spawn_orange_number

Lua Example

spawn_orange_number(behParam, relX, relY, relZ)

Parameters

Field Type
behParam integer
relX integer
relY integer
relZ integer

Returns

  • None

C Prototype

void spawn_orange_number(s8 behParam, s16 relX, s16 relY, s16 relZ);

🔼


turn_obj_away_from_steep_floor

Lua Example

local integerValue = turn_obj_away_from_steep_floor(objFloor, floorY, objVelX, objVelZ)

Parameters

Field Type
objFloor Surface
floorY number
objVelX number
objVelZ number

Returns

  • integer

C Prototype

s8 turn_obj_away_from_steep_floor(struct Surface *objFloor, f32 floorY, f32 objVelX, f32 objVelZ);

🔼


turn_obj_away_from_surface

Lua Example

turn_obj_away_from_surface(velX, velZ, nX, nY, nZ, objYawX, objYawZ)

Parameters

Field Type
velX number
velZ number
nX number
nY number
nZ number
objYawX Pointer <number>
objYawZ Pointer <number>

Returns

  • None

C Prototype

void turn_obj_away_from_surface(f32 velX, f32 velZ, f32 nX, UNUSED f32 nY, f32 nZ, f32 *objYawX, f32 *objYawZ);

🔼


functions from obj_behaviors_2.c


approach_f32_ptr

Lua Example

local integerValue = approach_f32_ptr(px, target, delta)

Parameters

Field Type
px Pointer <number>
target number
delta number

Returns

  • integer

C Prototype

s32 approach_f32_ptr(f32 *px, f32 target, f32 delta);

🔼


cur_obj_init_anim_and_check_if_end

Lua Example

local integerValue = cur_obj_init_anim_and_check_if_end(arg0)

Parameters

Field Type
arg0 integer

Returns

  • integer

C Prototype

s32 cur_obj_init_anim_and_check_if_end(s32 arg0);

🔼


cur_obj_init_anim_check_frame

Lua Example

local integerValue = cur_obj_init_anim_check_frame(arg0, arg1)

Parameters

Field Type
arg0 integer
arg1 integer

Returns

  • integer

C Prototype

s32 cur_obj_init_anim_check_frame(s32 arg0, s32 arg1);

🔼


cur_obj_init_anim_extend

Lua Example

cur_obj_init_anim_extend(arg0)

Parameters

Field Type
arg0 integer

Returns

  • None

C Prototype

void cur_obj_init_anim_extend(s32 arg0);

🔼


cur_obj_play_sound_at_anim_range

Lua Example

local integerValue = cur_obj_play_sound_at_anim_range(arg0, arg1, sound)

Parameters

Field Type
arg0 integer
arg1 integer
sound integer

Returns

  • integer

C Prototype

s32 cur_obj_play_sound_at_anim_range(s8 arg0, s8 arg1, u32 sound);

🔼


cur_obj_set_anim_if_at_end

Lua Example

local integerValue = cur_obj_set_anim_if_at_end(arg0)

Parameters

Field Type
arg0 integer

Returns

  • integer

C Prototype

s32 cur_obj_set_anim_if_at_end(s32 arg0);

🔼


cur_obj_spin_all_dimensions

Lua Example

cur_obj_spin_all_dimensions(arg0, arg1)

Parameters

Field Type
arg0 number
arg1 number

Returns

  • None

C Prototype

void cur_obj_spin_all_dimensions(f32 arg0, f32 arg1);

🔼


obj_act_knockback

Lua Example

obj_act_knockback(baseScale)

Parameters

Field Type
baseScale number

Returns

  • None

C Prototype

void obj_act_knockback(UNUSED f32 baseScale);

🔼


obj_act_squished

Lua Example

obj_act_squished(baseScale)

Parameters

Field Type
baseScale number

Returns

  • None

C Prototype

void obj_act_squished(f32 baseScale);

🔼


obj_bounce_off_walls_edges_objects

Lua Example

local integerValue = obj_bounce_off_walls_edges_objects(targetYaw)

Parameters

Field Type
targetYaw Pointer <integer>

Returns

  • integer

C Prototype

s32 obj_bounce_off_walls_edges_objects(s32 *targetYaw);

🔼


obj_check_attacks

Lua Example

local integerValue = obj_check_attacks(hitbox, attackedMarioAction)

Parameters

Field Type
hitbox ObjectHitbox
attackedMarioAction integer

Returns

  • integer

C Prototype

s32 obj_check_attacks(struct ObjectHitbox *hitbox, s32 attackedMarioAction);

🔼


obj_compute_vel_from_move_pitch

Lua Example

obj_compute_vel_from_move_pitch(speed)

Parameters

Field Type
speed number

Returns

  • None

C Prototype

void obj_compute_vel_from_move_pitch(f32 speed);

🔼


obj_die_if_above_lava_and_health_non_positive

Lua Example

local integerValue = obj_die_if_above_lava_and_health_non_positive()

Parameters

  • None

Returns

  • integer

C Prototype

s32 obj_die_if_above_lava_and_health_non_positive(void);

🔼


obj_die_if_health_non_positive

Lua Example

obj_die_if_health_non_positive()

Parameters

  • None

Returns

  • None

C Prototype

void obj_die_if_health_non_positive(void);

🔼


obj_face_pitch_approach

Lua Example

local integerValue = obj_face_pitch_approach(targetPitch, deltaPitch)

Parameters

Field Type
targetPitch integer
deltaPitch integer

Returns

  • integer

C Prototype

s32 obj_face_pitch_approach(s16 targetPitch, s16 deltaPitch);

🔼


obj_face_roll_approach

Lua Example

local integerValue = obj_face_roll_approach(targetRoll, deltaRoll)

Parameters

Field Type
targetRoll integer
deltaRoll integer

Returns

  • integer

C Prototype

s32 obj_face_roll_approach(s16 targetRoll, s16 deltaRoll);

🔼


obj_face_yaw_approach

Lua Example

local integerValue = obj_face_yaw_approach(targetYaw, deltaYaw)

Parameters

Field Type
targetYaw integer
deltaYaw integer

Returns

  • integer

C Prototype

s32 obj_face_yaw_approach(s16 targetYaw, s16 deltaYaw);

🔼


obj_forward_vel_approach

Lua Example

local integerValue = obj_forward_vel_approach(target, delta)

Parameters

Field Type
target number
delta number

Returns

  • integer

C Prototype

s32 obj_forward_vel_approach(f32 target, f32 delta);

🔼


obj_get_pitch_from_vel

Lua Example

local integerValue = obj_get_pitch_from_vel()

Parameters

  • None

Returns

  • integer

C Prototype

s16 obj_get_pitch_from_vel(void);

🔼


obj_get_pitch_to_home

Lua Example

local integerValue = obj_get_pitch_to_home(latDistToHome)

Parameters

Field Type
latDistToHome number

Returns

  • integer

C Prototype

s16 obj_get_pitch_to_home(f32 latDistToHome);

🔼


obj_grow_then_shrink

Lua Example

local integerValue = obj_grow_then_shrink(scaleVel, shootFireScale, endScale)

Parameters

Field Type
scaleVel Pointer <number>
shootFireScale number
endScale number

Returns

  • integer

C Prototype

s32 obj_grow_then_shrink(f32 *scaleVel, f32 shootFireScale, f32 endScale);

🔼


obj_handle_attacks

Lua Example

local integerValue = obj_handle_attacks(hitbox, attackedMarioAction, attackHandlers)

Parameters

Field Type
hitbox ObjectHitbox
attackedMarioAction integer
attackHandlers Pointer <integer>

Returns

  • integer

C Prototype

s32 obj_handle_attacks(struct ObjectHitbox *hitbox, s32 attackedMarioAction, u8 *attackHandlers);

🔼


obj_is_near_to_and_facing_mario

Lua Example

local integerValue = obj_is_near_to_and_facing_mario(m, maxDist, maxAngleDiff)

Parameters

Field Type
m MarioState
maxDist number
maxAngleDiff integer

Returns

  • integer

C Prototype

s32 obj_is_near_to_and_facing_mario(struct MarioState* m, f32 maxDist, s16 maxAngleDiff);

🔼


obj_is_rendering_enabled

Lua Example

local integerValue = obj_is_rendering_enabled()

Parameters

  • None

Returns

  • integer

C Prototype

s32 obj_is_rendering_enabled(void);

🔼


obj_move_for_one_second

Lua Example

local integerValue = obj_move_for_one_second(endAction)

Parameters

Field Type
endAction integer

Returns

  • integer

C Prototype

s32 obj_move_for_one_second(s32 endAction);

🔼


obj_move_pitch_approach

Lua Example

local integerValue = obj_move_pitch_approach(target, delta)

Parameters

Field Type
target integer
delta integer

Returns

  • integer

C Prototype

s32 obj_move_pitch_approach(s16 target, s16 delta);

🔼


obj_random_fixed_turn

Lua Example

local integerValue = obj_random_fixed_turn(delta)

Parameters

Field Type
delta integer

Returns

  • integer

C Prototype

s16 obj_random_fixed_turn(s16 delta);

🔼


obj_resolve_collisions_and_turn

Lua Example

local integerValue = obj_resolve_collisions_and_turn(targetYaw, turnSpeed)

Parameters

Field Type
targetYaw integer
turnSpeed integer

Returns

  • integer

C Prototype

s32 obj_resolve_collisions_and_turn(s16 targetYaw, s16 turnSpeed);

🔼


obj_resolve_object_collisions

Lua Example

local integerValue = obj_resolve_object_collisions(targetYaw)

Parameters

Field Type
targetYaw Pointer <integer>

Returns

  • integer

C Prototype

s32 obj_resolve_object_collisions(s32 *targetYaw);

🔼


obj_roll_to_match_yaw_turn

Lua Example

obj_roll_to_match_yaw_turn(targetYaw, maxRoll, rollSpeed)

Parameters

Field Type
targetYaw integer
maxRoll integer
rollSpeed integer

Returns

  • None

C Prototype

void obj_roll_to_match_yaw_turn(s16 targetYaw, s16 maxRoll, s16 rollSpeed);

🔼


obj_rotate_yaw_and_bounce_off_walls

Lua Example

obj_rotate_yaw_and_bounce_off_walls(targetYaw, turnAmount)

Parameters

Field Type
targetYaw integer
turnAmount integer

Returns

  • None

C Prototype

void obj_rotate_yaw_and_bounce_off_walls(s16 targetYaw, s16 turnAmount);

🔼


obj_set_dist_from_home

Lua Example

obj_set_dist_from_home(distFromHome)

Parameters

Field Type
distFromHome number

Returns

  • None

C Prototype

void obj_set_dist_from_home(f32 distFromHome);

🔼


obj_set_knockback_action

Lua Example

obj_set_knockback_action(attackType)

Parameters

Field Type
attackType integer

Returns

  • None

C Prototype

void obj_set_knockback_action(s32 attackType);

🔼


obj_set_squished_action

Lua Example

obj_set_squished_action()

Parameters

  • None

Returns

  • None

C Prototype

void obj_set_squished_action(void);

🔼


obj_smooth_turn

Lua Example

local integerValue = obj_smooth_turn(angleVel, angle, targetAngle, targetSpeedProportion, accel, minSpeed, maxSpeed)

Parameters

Field Type
angleVel Pointer <integer>
angle Pointer <integer>
targetAngle integer
targetSpeedProportion number
accel integer
minSpeed integer
maxSpeed integer

Returns

  • integer

C Prototype

s32 obj_smooth_turn(s16 *angleVel, s32 *angle, s16 targetAngle, f32 targetSpeedProportion, s16 accel, s16 minSpeed, s16 maxSpeed);

🔼


obj_spit_fire

Lua Example

local ObjectValue = obj_spit_fire(relativePosX, relativePosY, relativePosZ, scale, model, startSpeed, endSpeed, movePitch)

Parameters

Field Type
relativePosX integer
relativePosY integer
relativePosZ integer
scale number
model integer
startSpeed number
endSpeed number
movePitch integer

Returns

Object

C Prototype

struct Object* obj_spit_fire(s16 relativePosX, s16 relativePosY, s16 relativePosZ, f32 scale, s32 model, f32 startSpeed, f32 endSpeed, s16 movePitch);

🔼


obj_turn_pitch_toward_mario

Lua Example

local integerValue = obj_turn_pitch_toward_mario(m, targetOffsetY, turnAmount)

Parameters

Field Type
m MarioState
targetOffsetY number
turnAmount integer

Returns

  • integer

C Prototype

s16 obj_turn_pitch_toward_mario(struct MarioState* m, f32 targetOffsetY, s16 turnAmount);

🔼


obj_unused_die

Lua Example

obj_unused_die()

Parameters

  • None

Returns

  • None

C Prototype

void obj_unused_die(void);

🔼


obj_update_blinking

Lua Example

obj_update_blinking(blinkTimer, baseCycleLength, cycleLengthRange, blinkLength)

Parameters

Field Type
blinkTimer Pointer <integer>
baseCycleLength integer
cycleLengthRange integer
blinkLength integer

Returns

  • None

C Prototype

void obj_update_blinking(s32 *blinkTimer, s16 baseCycleLength, s16 cycleLengthRange, s16 blinkLength);

🔼


obj_update_standard_actions

Lua Example

local integerValue = obj_update_standard_actions(scale)

Parameters

Field Type
scale number

Returns

  • integer

C Prototype

s32 obj_update_standard_actions(f32 scale);

🔼


obj_y_vel_approach

Lua Example

local integerValue = obj_y_vel_approach(target, delta)

Parameters

Field Type
target number
delta number

Returns

  • integer

C Prototype

s32 obj_y_vel_approach(f32 target, f32 delta);

🔼


oscillate_toward

Lua Example

local integerValue = oscillate_toward(value, vel, target, velCloseToZero, accel, slowdown)

Parameters

Field Type
value Pointer <integer>
vel Pointer <number>
target integer
velCloseToZero number
accel number
slowdown number

Returns

  • integer

C Prototype

s32 oscillate_toward(s32 *value, f32 *vel, s32 target, f32 velCloseToZero, f32 accel, f32 slowdown);

🔼


platform_on_track_update_pos_or_spawn_ball

Lua Example

platform_on_track_update_pos_or_spawn_ball(ballIndex, x, y, z)

Parameters

Field Type
ballIndex integer
x number
y number
z number

Returns

  • None

C Prototype

void platform_on_track_update_pos_or_spawn_ball(s32 ballIndex, f32 x, f32 y, f32 z);

🔼


random_linear_offset

Lua Example

local integerValue = random_linear_offset(base, range)

Parameters

Field Type
base integer
range integer

Returns

  • integer

C Prototype

s16 random_linear_offset(s16 base, s16 range);

🔼


random_mod_offset

Lua Example

local integerValue = random_mod_offset(base, step, mod)

Parameters

Field Type
base integer
step integer
mod integer

Returns

  • integer

C Prototype

s16 random_mod_offset(s16 base, s16 step, s16 mod);

🔼


functions from object_helpers.c


abs_angle_diff

Lua Example

local integerValue = abs_angle_diff(x0, x1)

Parameters

Field Type
x0 integer
x1 integer

Returns

  • integer

C Prototype

s16 abs_angle_diff(s16 x0, s16 x1);

🔼


apply_drag_to_value

Lua Example

apply_drag_to_value(value, dragStrength)

Parameters

Field Type
value Pointer <number>
dragStrength number

Returns

  • None

C Prototype

void apply_drag_to_value(f32 *value, f32 dragStrength);

🔼


approach_f32_signed

Lua Example

local integerValue = approach_f32_signed(value, target, increment)

Parameters

Field Type
value Pointer <number>
target number
increment number

Returns

  • integer

C Prototype

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

🔼


approach_f32_symmetric

Lua Example

local numberValue = approach_f32_symmetric(value, target, increment)

Parameters

Field Type
value number
target number
increment number

Returns

  • number

C Prototype

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

🔼


approach_s16_symmetric

Lua Example

local integerValue = approach_s16_symmetric(value, target, increment)

Parameters

Field Type
value integer
target integer
increment integer

Returns

  • integer

C Prototype

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

🔼


bhv_dust_smoke_loop

Lua Example

bhv_dust_smoke_loop()

Parameters

  • None

Returns

  • None

C Prototype

void bhv_dust_smoke_loop(void);

🔼


bhv_init_room

Lua Example

bhv_init_room()

Parameters

  • None

Returns

  • None

C Prototype

void bhv_init_room(void);

🔼


bit_shift_left

Lua Example

local integerValue = bit_shift_left(a0)

Parameters

Field Type
a0 integer

Returns

  • integer

C Prototype

s32 bit_shift_left(s32 a0);

🔼


chain_segment_init

Lua Example

chain_segment_init(segment)

Parameters

Field Type
segment ChainSegment

Returns

  • None

C Prototype

void chain_segment_init(struct ChainSegment *segment);

🔼


clear_move_flag

Lua Example

local integerValue = clear_move_flag(bitSet, flag)

Parameters

Field Type
bitSet Pointer <integer>
flag integer

Returns

  • integer

C Prototype

s32 clear_move_flag(u32 *bitSet, s32 flag);

🔼


clear_time_stop_flags

Lua Example

clear_time_stop_flags(flags)

Parameters

Field Type
flags integer

Returns

  • None

C Prototype

void clear_time_stop_flags(s32 flags);

🔼


count_objects_with_behavior

Lua Example

local integerValue = count_objects_with_behavior(behavior)

Parameters

Field Type
behavior Pointer <BehaviorScript>

Returns

  • integer

C Prototype

s32 count_objects_with_behavior(const BehaviorScript *behavior);

🔼


count_unimportant_objects

Lua Example

local integerValue = count_unimportant_objects()

Parameters

  • None

Returns

  • integer

C Prototype

s32 count_unimportant_objects(void);

🔼


cur_obj_abs_y_dist_to_home

Lua Example

local numberValue = cur_obj_abs_y_dist_to_home()

Parameters

  • None

Returns

  • number

C Prototype

f32 cur_obj_abs_y_dist_to_home(void);

🔼


cur_obj_advance_looping_anim

Lua Example

local integerValue = cur_obj_advance_looping_anim()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_advance_looping_anim(void);

🔼


cur_obj_align_gfx_with_floor

Lua Example

cur_obj_align_gfx_with_floor()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_align_gfx_with_floor(void);

🔼


cur_obj_angle_to_home

Lua Example

local integerValue = cur_obj_angle_to_home()

Parameters

  • None

Returns

  • integer

C Prototype

s16 cur_obj_angle_to_home(void);

🔼


cur_obj_apply_drag_xz

Lua Example

cur_obj_apply_drag_xz(dragStrength)

Parameters

Field Type
dragStrength number

Returns

  • None

C Prototype

void cur_obj_apply_drag_xz(f32 dragStrength);

🔼


cur_obj_become_intangible

Lua Example

cur_obj_become_intangible()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_become_intangible(void);

🔼


cur_obj_become_tangible

Lua Example

cur_obj_become_tangible()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_become_tangible(void);

🔼


cur_obj_can_mario_activate_textbox

Lua Example

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

Parameters

Field Type
m MarioState
radius number
height number
unused integer

Returns

  • integer

C Prototype

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

🔼


cur_obj_can_mario_activate_textbox_2

Lua Example

local integerValue = cur_obj_can_mario_activate_textbox_2(m, radius, height)

Parameters

Field Type
m MarioState
radius number
height number

Returns

  • integer

C Prototype

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

🔼


cur_obj_change_action

Lua Example

cur_obj_change_action(action)

Parameters

Field Type
action integer

Returns

  • None

C Prototype

void cur_obj_change_action(s32 action);

🔼


cur_obj_check_anim_frame

Lua Example

local integerValue = cur_obj_check_anim_frame(frame)

Parameters

Field Type
frame integer

Returns

  • integer

C Prototype

s32 cur_obj_check_anim_frame(s32 frame);

🔼


cur_obj_check_anim_frame_in_range

Lua Example

local integerValue = cur_obj_check_anim_frame_in_range(startFrame, rangeLength)

Parameters

Field Type
startFrame integer
rangeLength integer

Returns

  • integer

C Prototype

s32 cur_obj_check_anim_frame_in_range(s32 startFrame, s32 rangeLength);

🔼


cur_obj_check_frame_prior_current_frame

Lua Example

local integerValue = cur_obj_check_frame_prior_current_frame(a0)

Parameters

Field Type
a0 Pointer <integer>

Returns

  • integer

C Prototype

s32 cur_obj_check_frame_prior_current_frame(s16 *a0);

🔼


cur_obj_check_grabbed_mario

Lua Example

local integerValue = cur_obj_check_grabbed_mario()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_check_grabbed_mario(void);

🔼


cur_obj_check_if_at_animation_end

Lua Example

local integerValue = cur_obj_check_if_at_animation_end()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_check_if_at_animation_end(void);

🔼


cur_obj_check_if_near_animation_end

Lua Example

local integerValue = cur_obj_check_if_near_animation_end()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_check_if_near_animation_end(void);

🔼


cur_obj_check_interacted

Lua Example

local integerValue = cur_obj_check_interacted()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_check_interacted(void);

🔼


cur_obj_clear_interact_status_flag

Lua Example

local integerValue = cur_obj_clear_interact_status_flag(flag)

Parameters

Field Type
flag integer

Returns

  • integer

C Prototype

s32 cur_obj_clear_interact_status_flag(s32 flag);

🔼


cur_obj_compute_vel_xz

Lua Example

cur_obj_compute_vel_xz()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_compute_vel_xz(void);

🔼


cur_obj_count_objects_with_behavior

Lua Example

local integerValue = cur_obj_count_objects_with_behavior(behavior, dist)

Parameters

Field Type
behavior Pointer <BehaviorScript>
dist number

Returns

  • integer

C Prototype

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

🔼


cur_obj_detect_steep_floor

Lua Example

local integerValue = cur_obj_detect_steep_floor(steepAngleDegrees)

Parameters

Field Type
steepAngleDegrees integer

Returns

  • integer

C Prototype

s32 cur_obj_detect_steep_floor(s16 steepAngleDegrees);

🔼


cur_obj_disable

Lua Example

cur_obj_disable()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_disable(void);

🔼


cur_obj_disable_rendering

Lua Example

cur_obj_disable_rendering()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_disable_rendering(void);

🔼


cur_obj_disable_rendering_and_become_intangible

Lua Example

cur_obj_disable_rendering_and_become_intangible(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void cur_obj_disable_rendering_and_become_intangible(struct Object *obj);

🔼


cur_obj_dist_to_nearest_object_with_behavior

Lua Example

local numberValue = cur_obj_dist_to_nearest_object_with_behavior(behavior)

Parameters

Field Type
behavior Pointer <BehaviorScript>

Returns

  • number

C Prototype

f32 cur_obj_dist_to_nearest_object_with_behavior(const BehaviorScript *behavior);

🔼


cur_obj_enable_rendering

Lua Example

cur_obj_enable_rendering()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_enable_rendering(void);

🔼


cur_obj_enable_rendering_2

Lua Example

cur_obj_enable_rendering_2()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_enable_rendering_2(void);

🔼


cur_obj_enable_rendering_and_become_tangible

Lua Example

cur_obj_enable_rendering_and_become_tangible(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void cur_obj_enable_rendering_and_become_tangible(struct Object *obj);

🔼


cur_obj_enable_rendering_if_mario_in_room

Lua Example

cur_obj_enable_rendering_if_mario_in_room()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_enable_rendering_if_mario_in_room(void);

🔼


cur_obj_end_dialog

Lua Example

cur_obj_end_dialog(m, dialogFlags, dialogResult)

Parameters

Field Type
m MarioState
dialogFlags integer
dialogResult integer

Returns

  • None

C Prototype

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

🔼


cur_obj_extend_animation_if_at_end

Lua Example

cur_obj_extend_animation_if_at_end()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_extend_animation_if_at_end(void);

🔼


cur_obj_find_nearby_held_actor

Lua Example

local ObjectValue = cur_obj_find_nearby_held_actor(behavior, maxDist)

Parameters

Field Type
behavior Pointer <BehaviorScript>
maxDist number

Returns

Object

C Prototype

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

🔼


cur_obj_find_nearest_object_with_behavior

Lua Example

local ObjectValue = cur_obj_find_nearest_object_with_behavior(behavior, dist)

Parameters

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

Returns

Object

C Prototype

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

🔼


cur_obj_find_nearest_pole

Lua Example

local ObjectValue = cur_obj_find_nearest_pole()

Parameters

  • None

Returns

Object

C Prototype

struct Object* cur_obj_find_nearest_pole(void);

🔼


cur_obj_follow_path

Lua Example

local integerValue = cur_obj_follow_path(unusedArg)

Parameters

Field Type
unusedArg integer

Returns

  • integer

C Prototype

s32 cur_obj_follow_path(UNUSED s32 unusedArg);

🔼


cur_obj_forward_vel_approach_upward

Lua Example

cur_obj_forward_vel_approach_upward(target, increment)

Parameters

Field Type
target number
increment number

Returns

  • None

C Prototype

void cur_obj_forward_vel_approach_upward(f32 target, f32 increment);

🔼


cur_obj_get_dropped

Lua Example

cur_obj_get_dropped()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_get_dropped(void);

🔼


cur_obj_get_thrown_or_placed

Lua Example

cur_obj_get_thrown_or_placed(forwardVel, velY, thrownAction)

Parameters

Field Type
forwardVel number
velY number
thrownAction integer

Returns

  • None

C Prototype

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

🔼


cur_obj_has_behavior

Lua Example

local integerValue = cur_obj_has_behavior(behavior)

Parameters

Field Type
behavior Pointer <BehaviorScript>

Returns

  • integer

C Prototype

s32 cur_obj_has_behavior(const BehaviorScript *behavior);

🔼


cur_obj_has_model

Lua Example

local integerValue = cur_obj_has_model(modelID)

Parameters

Field Type
modelID integer

Returns

  • integer

C Prototype

s32 cur_obj_has_model(u16 modelID);

🔼


cur_obj_hide

Lua Example

cur_obj_hide()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_hide(void);

🔼


cur_obj_hide_if_mario_far_away_y

Lua Example

local integerValue = cur_obj_hide_if_mario_far_away_y(distY)

Parameters

Field Type
distY number

Returns

  • integer

C Prototype

s32 cur_obj_hide_if_mario_far_away_y(f32 distY);

🔼


cur_obj_if_hit_wall_bounce_away

Lua Example

cur_obj_if_hit_wall_bounce_away()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_if_hit_wall_bounce_away(void);

🔼


cur_obj_init_animation

Lua Example

cur_obj_init_animation(animIndex)

Parameters

Field Type
animIndex integer

Returns

  • None

C Prototype

void cur_obj_init_animation(s32 animIndex);

🔼


cur_obj_init_animation_and_anim_frame

Lua Example

cur_obj_init_animation_and_anim_frame(animIndex, animFrame)

Parameters

Field Type
animIndex integer
animFrame integer

Returns

  • None

C Prototype

void cur_obj_init_animation_and_anim_frame(s32 animIndex, s32 animFrame);

🔼


cur_obj_init_animation_and_check_if_near_end

Lua Example

local integerValue = cur_obj_init_animation_and_check_if_near_end(animIndex)

Parameters

Field Type
animIndex integer

Returns

  • integer

C Prototype

s32 cur_obj_init_animation_and_check_if_near_end(s32 animIndex);

🔼


cur_obj_init_animation_and_extend_if_at_end

Lua Example

cur_obj_init_animation_and_extend_if_at_end(animIndex)

Parameters

Field Type
animIndex integer

Returns

  • None

C Prototype

void cur_obj_init_animation_and_extend_if_at_end(s32 animIndex);

🔼


cur_obj_init_animation_with_accel_and_sound

Lua Example

cur_obj_init_animation_with_accel_and_sound(animIndex, accel)

Parameters

Field Type
animIndex integer
accel number

Returns

  • None

C Prototype

void cur_obj_init_animation_with_accel_and_sound(s32 animIndex, f32 accel);

🔼


cur_obj_init_animation_with_sound

Lua Example

cur_obj_init_animation_with_sound(animIndex)

Parameters

Field Type
animIndex integer

Returns

  • None

C Prototype

void cur_obj_init_animation_with_sound(s32 animIndex);

🔼


cur_obj_is_any_player_on_platform

Lua Example

local integerValue = cur_obj_is_any_player_on_platform()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_is_any_player_on_platform(void);

🔼


cur_obj_is_mario_ground_pounding_platform

Lua Example

local integerValue = cur_obj_is_mario_ground_pounding_platform()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_is_mario_ground_pounding_platform(void);

🔼


cur_obj_is_mario_on_platform

Lua Example

local integerValue = cur_obj_is_mario_on_platform()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_is_mario_on_platform(void);

🔼


cur_obj_lateral_dist_from_mario_to_home

Lua Example

local numberValue = cur_obj_lateral_dist_from_mario_to_home()

Parameters

  • None

Returns

  • number

C Prototype

f32 cur_obj_lateral_dist_from_mario_to_home(void);

🔼


cur_obj_lateral_dist_from_obj_to_home

Lua Example

local numberValue = cur_obj_lateral_dist_from_obj_to_home(obj)

Parameters

Field Type
obj Object

Returns

  • number

C Prototype

f32 cur_obj_lateral_dist_from_obj_to_home(struct Object *obj);

🔼


cur_obj_lateral_dist_to_home

Lua Example

local numberValue = cur_obj_lateral_dist_to_home()

Parameters

  • None

Returns

  • number

C Prototype

f32 cur_obj_lateral_dist_to_home(void);

🔼


cur_obj_mario_far_away

Lua Example

local integerValue = cur_obj_mario_far_away()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_mario_far_away(void);

🔼


cur_obj_move_after_thrown_or_dropped

Lua Example

cur_obj_move_after_thrown_or_dropped(forwardVel, velY)

Parameters

Field Type
forwardVel number
velY number

Returns

  • None

C Prototype

void cur_obj_move_after_thrown_or_dropped(f32 forwardVel, f32 velY);

🔼


cur_obj_move_standard

Lua Example

cur_obj_move_standard(steepSlopeAngleDegrees)

Parameters

Field Type
steepSlopeAngleDegrees integer

Returns

  • None

C Prototype

void cur_obj_move_standard(s16 steepSlopeAngleDegrees);

🔼


cur_obj_move_up_and_down

Lua Example

local integerValue = cur_obj_move_up_and_down(a0)

Parameters

Field Type
a0 integer

Returns

  • integer

C Prototype

s32 cur_obj_move_up_and_down(s32 a0);

🔼


cur_obj_move_update_ground_air_flags

Lua Example

cur_obj_move_update_ground_air_flags(gravity, bounciness)

Parameters

Field Type
gravity number
bounciness number

Returns

  • None

C Prototype

void cur_obj_move_update_ground_air_flags(UNUSED f32 gravity, f32 bounciness);

🔼


cur_obj_move_update_underwater_flags

Lua Example

cur_obj_move_update_underwater_flags()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_move_update_underwater_flags(void);

🔼


cur_obj_move_using_fvel_and_gravity

Lua Example

cur_obj_move_using_fvel_and_gravity()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_move_using_fvel_and_gravity(void);

🔼


cur_obj_move_using_vel

Lua Example

cur_obj_move_using_vel()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_move_using_vel(void);

🔼


cur_obj_move_using_vel_and_gravity

Lua Example

cur_obj_move_using_vel_and_gravity()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_move_using_vel_and_gravity(void);

🔼


cur_obj_move_xz

Lua Example

local integerValue = cur_obj_move_xz(steepSlopeNormalY, careAboutEdgesAndSteepSlopes)

Parameters

Field Type
steepSlopeNormalY number
careAboutEdgesAndSteepSlopes integer

Returns

  • integer

C Prototype

s32 cur_obj_move_xz(f32 steepSlopeNormalY, s32 careAboutEdgesAndSteepSlopes);

🔼


cur_obj_move_xz_using_fvel_and_yaw

Lua Example

cur_obj_move_xz_using_fvel_and_yaw()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_move_xz_using_fvel_and_yaw(void);

🔼


cur_obj_move_y

Lua Example

cur_obj_move_y(gravity, bounciness, buoyancy)

Parameters

Field Type
gravity number
bounciness number
buoyancy number

Returns

  • None

C Prototype

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

🔼


cur_obj_move_y_and_get_water_level

Lua Example

local numberValue = cur_obj_move_y_and_get_water_level(gravity, buoyancy)

Parameters

Field Type
gravity number
buoyancy number

Returns

  • number

C Prototype

f32 cur_obj_move_y_and_get_water_level(f32 gravity, f32 buoyancy);

🔼


cur_obj_move_y_with_terminal_vel

Lua Example

cur_obj_move_y_with_terminal_vel()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_move_y_with_terminal_vel(void);

🔼


cur_obj_nearest_object_with_behavior

Lua Example

local ObjectValue = cur_obj_nearest_object_with_behavior(behavior)

Parameters

Field Type
behavior Pointer <BehaviorScript>

Returns

Object

C Prototype

struct Object *cur_obj_nearest_object_with_behavior(const BehaviorScript *behavior);

🔼


cur_obj_outside_home_rectangle

Lua Example

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

Parameters

Field Type
minX number
maxX number
minZ number
maxZ number

Returns

  • integer

C Prototype

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

🔼


cur_obj_outside_home_square

Lua Example

local integerValue = cur_obj_outside_home_square(halfLength)

Parameters

Field Type
halfLength number

Returns

  • integer

C Prototype

s32 cur_obj_outside_home_square(f32 halfLength);

🔼


cur_obj_progress_direction_table

Lua Example

local integerValue = cur_obj_progress_direction_table()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_progress_direction_table(void);

🔼


cur_obj_push_mario_away

Lua Example

cur_obj_push_mario_away(radius)

Parameters

Field Type
radius number

Returns

  • None

C Prototype

void cur_obj_push_mario_away(f32 radius);

🔼


cur_obj_push_mario_away_from_cylinder

Lua Example

cur_obj_push_mario_away_from_cylinder(radius, extentY)

Parameters

Field Type
radius number
extentY number

Returns

  • None

C Prototype

void cur_obj_push_mario_away_from_cylinder(f32 radius, f32 extentY);

🔼


cur_obj_reflect_move_angle_off_wall

Lua Example

local integerValue = cur_obj_reflect_move_angle_off_wall()

Parameters

  • None

Returns

  • integer

C Prototype

s16 cur_obj_reflect_move_angle_off_wall(void);

🔼


cur_obj_reset_timer_and_subaction

Lua Example

cur_obj_reset_timer_and_subaction()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_reset_timer_and_subaction(void);

🔼


cur_obj_resolve_wall_collisions

Lua Example

local integerValue = cur_obj_resolve_wall_collisions()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_resolve_wall_collisions(void);

🔼


cur_obj_reverse_animation

Lua Example

cur_obj_reverse_animation()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_reverse_animation(void);

🔼


cur_obj_rotate_face_angle_using_vel

Lua Example

cur_obj_rotate_face_angle_using_vel()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_rotate_face_angle_using_vel(void);

🔼


cur_obj_rotate_move_angle_using_vel

Lua Example

cur_obj_rotate_move_angle_using_vel()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_rotate_move_angle_using_vel(void);

🔼


cur_obj_rotate_yaw_toward

Lua Example

local integerValue = cur_obj_rotate_yaw_toward(target, increment)

Parameters

Field Type
target integer
increment integer

Returns

  • integer

C Prototype

s32 cur_obj_rotate_yaw_toward(s16 target, s16 increment);

🔼


cur_obj_scale

Lua Example

cur_obj_scale(scale)

Parameters

Field Type
scale number

Returns

  • None

C Prototype

void cur_obj_scale(f32 scale);

🔼


cur_obj_scale_over_time

Lua Example

cur_obj_scale_over_time(a0, a1, sp10, sp14)

Parameters

Field Type
a0 integer
a1 integer
sp10 number
sp14 number

Returns

  • None

C Prototype

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

🔼


cur_obj_set_behavior

Lua Example

cur_obj_set_behavior(behavior)

Parameters

Field Type
behavior Pointer <BehaviorScript>

Returns

  • None

C Prototype

void cur_obj_set_behavior(const BehaviorScript *behavior);

🔼


cur_obj_set_direction_table

Lua Example

local integerValue = cur_obj_set_direction_table(a0)

Parameters

Field Type
a0 Pointer <integer>

Returns

  • integer

C Prototype

s32 cur_obj_set_direction_table(s8 *a0);

🔼


cur_obj_set_face_angle_to_move_angle

Lua Example

cur_obj_set_face_angle_to_move_angle()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_set_face_angle_to_move_angle(void);

🔼


cur_obj_set_hitbox_and_die_if_attacked

Lua Example

local integerValue = cur_obj_set_hitbox_and_die_if_attacked(hitbox, deathSound, noLootCoins)

Parameters

Field Type
hitbox ObjectHitbox
deathSound integer
noLootCoins integer

Returns

  • integer

C Prototype

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

🔼


cur_obj_set_hitbox_radius_and_height

Lua Example

cur_obj_set_hitbox_radius_and_height(radius, height)

Parameters

Field Type
radius number
height number

Returns

  • None

C Prototype

void cur_obj_set_hitbox_radius_and_height(f32 radius, f32 height);

🔼


cur_obj_set_hurtbox_radius_and_height

Lua Example

cur_obj_set_hurtbox_radius_and_height(radius, height)

Parameters

Field Type
radius number
height number

Returns

  • None

C Prototype

void cur_obj_set_hurtbox_radius_and_height(f32 radius, f32 height);

🔼


cur_obj_set_model

Lua Example

cur_obj_set_model(modelID)

Parameters

Field Type
modelID integer

Returns

  • None

C Prototype

void cur_obj_set_model(s32 modelID);

🔼


cur_obj_set_pos_relative

Lua Example

cur_obj_set_pos_relative(other, dleft, dy, dforward)

Parameters

Field Type
other Object
dleft number
dy number
dforward number

Returns

  • None

C Prototype

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

🔼


cur_obj_set_pos_relative_to_parent

Lua Example

cur_obj_set_pos_relative_to_parent(dleft, dy, dforward)

Parameters

Field Type
dleft number
dy number
dforward number

Returns

  • None

C Prototype

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

🔼


cur_obj_set_pos_to_home

Lua Example

cur_obj_set_pos_to_home()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_set_pos_to_home(void);

🔼


cur_obj_set_pos_to_home_and_stop

Lua Example

cur_obj_set_pos_to_home_and_stop()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_set_pos_to_home_and_stop(void);

🔼


cur_obj_set_pos_to_home_with_debug

Lua Example

cur_obj_set_pos_to_home_with_debug()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_set_pos_to_home_with_debug(void);

🔼


cur_obj_set_pos_via_transform

Lua Example

cur_obj_set_pos_via_transform()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_set_pos_via_transform(void);

🔼


cur_obj_set_vel_from_mario_vel

Lua Example

cur_obj_set_vel_from_mario_vel(m, f12, f14)

Parameters

Field Type
m MarioState
f12 number
f14 number

Returns

  • None

C Prototype

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

🔼


cur_obj_set_y_vel_and_animation

Lua Example

cur_obj_set_y_vel_and_animation(sp18, sp1C)

Parameters

Field Type
sp18 number
sp1C integer

Returns

  • None

C Prototype

void cur_obj_set_y_vel_and_animation(f32 sp18, s32 sp1C);

🔼


cur_obj_shake_screen

Lua Example

cur_obj_shake_screen(shake)

Parameters

Field Type
shake integer

Returns

  • None

C Prototype

void cur_obj_shake_screen(s32 shake);

🔼


cur_obj_shake_y

Lua Example

cur_obj_shake_y(amount)

Parameters

Field Type
amount number

Returns

  • None

C Prototype

void cur_obj_shake_y(f32 amount);

🔼


cur_obj_shake_y_until

Lua Example

local integerValue = cur_obj_shake_y_until(cycles, amount)

Parameters

Field Type
cycles integer
amount integer

Returns

  • integer

C Prototype

s32 cur_obj_shake_y_until(s32 cycles, s32 amount);

🔼


cur_obj_spawn_loot_blue_coin

Lua Example

cur_obj_spawn_loot_blue_coin()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_spawn_loot_blue_coin(void);

🔼


cur_obj_spawn_loot_coin_at_mario_pos

Lua Example

cur_obj_spawn_loot_coin_at_mario_pos(m)

Parameters

Field Type
m MarioState

Returns

  • None

C Prototype

void cur_obj_spawn_loot_coin_at_mario_pos(struct MarioState* m);

🔼


cur_obj_spawn_particles

Lua Example

cur_obj_spawn_particles(info)

Parameters

Field Type
info SpawnParticlesInfo

Returns

  • None

C Prototype

void cur_obj_spawn_particles(struct SpawnParticlesInfo *info);

🔼


cur_obj_spawn_star_at_y_offset

Lua Example

cur_obj_spawn_star_at_y_offset(targetX, targetY, targetZ, offsetY)

Parameters

Field Type
targetX number
targetY number
targetZ number
offsetY number

Returns

  • None

C Prototype

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

🔼


cur_obj_start_cam_event

Lua Example

cur_obj_start_cam_event(obj, cameraEvent)

Parameters

Field Type
obj Object
cameraEvent integer

Returns

  • None

C Prototype

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

🔼


cur_obj_unhide

Lua Example

cur_obj_unhide()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_unhide(void);

🔼


cur_obj_unrender_and_reset_state

Lua Example

cur_obj_unrender_and_reset_state(sp18, sp1C)

Parameters

Field Type
sp18 integer
sp1C integer

Returns

  • None

C Prototype

void cur_obj_unrender_and_reset_state(s32 sp18, s32 sp1C);

🔼


cur_obj_unused_init_on_floor

Lua Example

cur_obj_unused_init_on_floor()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_unused_init_on_floor(void);

🔼


cur_obj_unused_play_footstep_sound

Lua Example

cur_obj_unused_play_footstep_sound(animFrame1, animFrame2, sound)

Parameters

Field Type
animFrame1 integer
animFrame2 integer
sound integer

Returns

  • None

C Prototype

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

🔼


cur_obj_unused_resolve_wall_collisions

Lua Example

cur_obj_unused_resolve_wall_collisions(offsetY, radius)

Parameters

Field Type
offsetY number
radius number

Returns

  • None

C Prototype

void cur_obj_unused_resolve_wall_collisions(f32 offsetY, f32 radius);

🔼


cur_obj_update_floor

Lua Example

cur_obj_update_floor()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_update_floor(void);

🔼


cur_obj_update_floor_and_resolve_wall_collisions

Lua Example

cur_obj_update_floor_and_resolve_wall_collisions(steepSlopeDegrees)

Parameters

Field Type
steepSlopeDegrees integer

Returns

  • None

C Prototype

void cur_obj_update_floor_and_resolve_wall_collisions(s16 steepSlopeDegrees);

🔼


cur_obj_update_floor_and_walls

Lua Example

cur_obj_update_floor_and_walls()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_update_floor_and_walls(void);

🔼


cur_obj_update_floor_height

Lua Example

cur_obj_update_floor_height()

Parameters

  • None

Returns

  • None

C Prototype

void cur_obj_update_floor_height(void);

🔼


cur_obj_update_floor_height_and_get_floor

Lua Example

local SurfaceValue = cur_obj_update_floor_height_and_get_floor()

Parameters

  • None

Returns

Surface

C Prototype

struct Surface *cur_obj_update_floor_height_and_get_floor(void);

🔼


cur_obj_wait_then_blink

Lua Example

local integerValue = cur_obj_wait_then_blink(timeUntilBlinking, numBlinks)

Parameters

Field Type
timeUntilBlinking integer
numBlinks integer

Returns

  • integer

C Prototype

s32 cur_obj_wait_then_blink(s32 timeUntilBlinking, s32 numBlinks);

🔼


cur_obj_was_attacked_or_ground_pounded

Lua Example

local integerValue = cur_obj_was_attacked_or_ground_pounded()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_was_attacked_or_ground_pounded(void);

🔼


cur_obj_within_12k_bounds

Lua Example

local integerValue = cur_obj_within_12k_bounds()

Parameters

  • None

Returns

  • integer

C Prototype

s32 cur_obj_within_12k_bounds(void);

🔼


disable_time_stop

Lua Example

disable_time_stop()

Parameters

  • None

Returns

  • None

C Prototype

void disable_time_stop(void);

🔼


disable_time_stop_including_mario

Lua Example

disable_time_stop_including_mario()

Parameters

  • None

Returns

  • None

C Prototype

void disable_time_stop_including_mario(void);

🔼


dist_between_object_and_point

Lua Example

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

Parameters

Field Type
obj Object
pointX number
pointY number
pointZ number

Returns

  • number

C Prototype

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

🔼


dist_between_objects

Lua Example

local numberValue = dist_between_objects(obj1, obj2)

Parameters

Field Type
obj1 Object
obj2 Object

Returns

  • number

C Prototype

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

🔼


enable_time_stop

Lua Example

enable_time_stop()

Parameters

  • None

Returns

  • None

C Prototype

void enable_time_stop(void);

🔼


enable_time_stop_including_mario

Lua Example

enable_time_stop_including_mario()

Parameters

  • None

Returns

  • None

C Prototype

void enable_time_stop_including_mario(void);

🔼


find_unimportant_object

Lua Example

local ObjectValue = find_unimportant_object()

Parameters

  • None

Returns

Object

C Prototype

struct Object *find_unimportant_object(void);

🔼


geo_offset_klepto_debug

Lua Example

local integerValue = geo_offset_klepto_debug(callContext, a1, sp8)

Parameters

Field Type
callContext integer
a1 GraphNode
sp8 integer

Returns

  • integer

C Prototype

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

🔼


get_object_list_from_behavior

Lua Example

local integerValue = get_object_list_from_behavior(behavior)

Parameters

Field Type
behavior Pointer <BehaviorScript>

Returns

  • integer

C Prototype

u32 get_object_list_from_behavior(const BehaviorScript *behavior);

🔼


increment_velocity_toward_range

Lua Example

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

Parameters

Field Type
value number
center number
zeroThreshold number
increment number

Returns

  • number

C Prototype

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

🔼


is_item_in_array

Lua Example

local integerValue = is_item_in_array(item, array)

Parameters

Field Type
item integer
array Pointer <integer>

Returns

  • integer

C Prototype

s32 is_item_in_array(s8 item, s8 *array);

🔼


is_mario_moving_fast_or_in_air

Lua Example

local integerValue = is_mario_moving_fast_or_in_air(speedThreshold)

Parameters

Field Type
speedThreshold integer

Returns

  • integer

C Prototype

s32 is_mario_moving_fast_or_in_air(s32 speedThreshold);

🔼


lateral_dist_between_objects

Lua Example

local numberValue = lateral_dist_between_objects(obj1, obj2)

Parameters

Field Type
obj1 Object
obj2 Object

Returns

  • number

C Prototype

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

🔼


mario_is_dive_sliding

Lua Example

local integerValue = mario_is_dive_sliding(m)

Parameters

Field Type
m MarioState

Returns

  • integer

C Prototype

s32 mario_is_dive_sliding(struct MarioState* m);

🔼


mario_is_in_air_action

Lua Example

local integerValue = mario_is_in_air_action(m)

Parameters

Field Type
m MarioState

Returns

  • integer

C Prototype

s32 mario_is_in_air_action(struct MarioState* m);

🔼


mario_is_within_rectangle

Lua Example

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

Parameters

Field Type
minX integer
maxX integer
minZ integer
maxZ integer

Returns

  • integer

C Prototype

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

🔼


mario_set_flag

Lua Example

mario_set_flag(flag)

Parameters

Field Type
flag integer

Returns

  • None

C Prototype

void mario_set_flag(s32 flag);

🔼


obj_angle_to_object

Lua Example

local integerValue = obj_angle_to_object(obj1, obj2)

Parameters

Field Type
obj1 Object
obj2 Object

Returns

  • integer

C Prototype

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

🔼


obj_angle_to_point

Lua Example

local integerValue = obj_angle_to_point(obj, pointX, pointZ)

Parameters

Field Type
obj Object
pointX number
pointZ number

Returns

  • integer

C Prototype

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

🔼


obj_apply_scale_to_transform

Lua Example

obj_apply_scale_to_transform(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_apply_scale_to_transform(struct Object *obj);

🔼


obj_attack_collided_from_other_object

Lua Example

local integerValue = obj_attack_collided_from_other_object(obj)

Parameters

Field Type
obj Object

Returns

  • integer

C Prototype

s32 obj_attack_collided_from_other_object(struct Object *obj);

🔼


obj_become_tangible

Lua Example

obj_become_tangible(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_become_tangible(struct Object *obj);

🔼


obj_build_relative_transform

Lua Example

obj_build_relative_transform(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_build_relative_transform(struct Object *obj);

🔼


obj_build_transform_from_pos_and_angle

Lua Example

obj_build_transform_from_pos_and_angle(obj, posIndex, angleIndex)

Parameters

Field Type
obj Object
posIndex integer
angleIndex integer

Returns

  • None

C Prototype

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

🔼


obj_build_transform_relative_to_parent

Lua Example

obj_build_transform_relative_to_parent(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_build_transform_relative_to_parent(struct Object *obj);

🔼


obj_build_vel_from_transform

Lua Example

obj_build_vel_from_transform(a0)

Parameters

Field Type
a0 Object

Returns

  • None

C Prototype

void obj_build_vel_from_transform(struct Object *a0);

🔼


obj_check_if_collided_with_object

Lua Example

local integerValue = obj_check_if_collided_with_object(obj1, obj2)

Parameters

Field Type
obj1 Object
obj2 Object

Returns

  • integer

C Prototype

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

🔼


obj_copy_angle

Lua Example

obj_copy_angle(dst, src)

Parameters

Field Type
dst Object
src Object

Returns

  • None

C Prototype

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

🔼


obj_copy_behavior_params

Lua Example

obj_copy_behavior_params(dst, src)

Parameters

Field Type
dst Object
src Object

Returns

  • None

C Prototype

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

🔼


obj_copy_graph_y_offset

Lua Example

obj_copy_graph_y_offset(dst, src)

Parameters

Field Type
dst Object
src Object

Returns

  • None

C Prototype

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

🔼


obj_copy_pos

Lua Example

obj_copy_pos(dst, src)

Parameters

Field Type
dst Object
src Object

Returns

  • None

C Prototype

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

🔼


obj_copy_pos_and_angle

Lua Example

obj_copy_pos_and_angle(dst, src)

Parameters

Field Type
dst Object
src Object

Returns

  • None

C Prototype

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

🔼


obj_copy_scale

Lua Example

obj_copy_scale(dst, src)

Parameters

Field Type
dst Object
src Object

Returns

  • None

C Prototype

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

🔼


obj_create_transform_from_self

Lua Example

obj_create_transform_from_self(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_create_transform_from_self(struct Object *obj);

🔼


obj_explode_and_spawn_coins

Lua Example

obj_explode_and_spawn_coins(sp18, sp1C)

Parameters

Field Type
sp18 number
sp1C integer

Returns

  • None

C Prototype

void obj_explode_and_spawn_coins(f32 sp18, s32 sp1C);

🔼


obj_has_behavior

Lua Example

local integerValue = obj_has_behavior(obj, behavior)

Parameters

Field Type
obj Object
behavior Pointer <BehaviorScript>

Returns

  • integer

C Prototype

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

🔼


obj_init_animation

Lua Example

obj_init_animation(obj, animIndex)

Parameters

Field Type
obj Object
animIndex integer

Returns

  • None

C Prototype

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

🔼


obj_is_hidden

Lua Example

local integerValue = obj_is_hidden(obj)

Parameters

Field Type
obj Object

Returns

  • integer

C Prototype

s32 obj_is_hidden(struct Object *obj);

🔼


obj_mark_for_deletion

Lua Example

obj_mark_for_deletion(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_mark_for_deletion(struct Object *obj);

🔼


obj_pitch_to_object

Lua Example

local integerValue = obj_pitch_to_object(obj, target)

Parameters

Field Type
obj Object
target Object

Returns

  • integer

C Prototype

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

🔼


obj_scale

Lua Example

obj_scale(obj, scale)

Parameters

Field Type
obj Object
scale number

Returns

  • None

C Prototype

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

🔼


obj_scale_random

Lua Example

obj_scale_random(obj, rangeLength, minScale)

Parameters

Field Type
obj Object
rangeLength number
minScale number

Returns

  • None

C Prototype

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

🔼


obj_scale_xyz

Lua Example

obj_scale_xyz(obj, xScale, yScale, zScale)

Parameters

Field Type
obj Object
xScale number
yScale number
zScale number

Returns

  • None

C Prototype

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

🔼


obj_set_angle

Lua Example

obj_set_angle(obj, pitch, yaw, roll)

Parameters

Field Type
obj Object
pitch integer
yaw integer
roll integer

Returns

  • None

C Prototype

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

🔼


obj_set_behavior

Lua Example

obj_set_behavior(obj, behavior)

Parameters

Field Type
obj Object
behavior Pointer <BehaviorScript>

Returns

  • None

C Prototype

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

🔼


obj_set_billboard

Lua Example

obj_set_billboard(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_set_billboard(struct Object *obj);

🔼


obj_set_cylboard

Lua Example

obj_set_cylboard(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_set_cylboard(struct Object *obj);

🔼


obj_set_face_angle_to_move_angle

Lua Example

obj_set_face_angle_to_move_angle(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_set_face_angle_to_move_angle(struct Object *obj);

🔼


obj_set_gfx_pos_at_obj_pos

Lua Example

obj_set_gfx_pos_at_obj_pos(obj1, obj2)

Parameters

Field Type
obj1 Object
obj2 Object

Returns

  • None

C Prototype

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

🔼


obj_set_gfx_pos_from_pos

Lua Example

obj_set_gfx_pos_from_pos(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_set_gfx_pos_from_pos(struct Object *obj);

🔼


obj_set_held_state

Lua Example

obj_set_held_state(obj, heldBehavior)

Parameters

Field Type
obj Object
heldBehavior Pointer <BehaviorScript>

Returns

  • None

C Prototype

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

🔼


obj_set_hitbox

Lua Example

obj_set_hitbox(obj, hitbox)

Parameters

Field Type
obj Object
hitbox ObjectHitbox

Returns

  • None

C Prototype

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

🔼


obj_set_parent_relative_pos

Lua Example

obj_set_parent_relative_pos(obj, relX, relY, relZ)

Parameters

Field Type
obj Object
relX integer
relY integer
relZ integer

Returns

  • None

C Prototype

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

🔼


obj_set_pos

Lua Example

obj_set_pos(obj, x, y, z)

Parameters

Field Type
obj Object
x integer
y integer
z integer

Returns

  • None

C Prototype

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

🔼


obj_set_pos_relative

Lua Example

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

Parameters

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

Returns

  • None

C Prototype

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

🔼


obj_set_throw_matrix_from_transform

Lua Example

obj_set_throw_matrix_from_transform(obj)

Parameters

Field Type
obj Object

Returns

  • None

C Prototype

void obj_set_throw_matrix_from_transform(struct Object *obj);

🔼


obj_spawn_loot_blue_coins

Lua Example

obj_spawn_loot_blue_coins(obj, numCoins, sp28, posJitter)

Parameters

Field Type
obj Object
numCoins integer
sp28 number
posJitter integer

Returns

  • None

C Prototype

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

🔼


obj_spawn_loot_coins

Lua Example

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

Parameters

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

Returns

  • None

C Prototype

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

🔼


obj_spawn_loot_yellow_coins

Lua Example

obj_spawn_loot_yellow_coins(obj, numCoins, sp28)

Parameters

Field Type
obj Object
numCoins integer
sp28 number

Returns

  • None

C Prototype

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

🔼


obj_translate_local

Lua Example

obj_translate_local(obj, posIndex, localTranslateIndex)

Parameters

Field Type
obj Object
posIndex integer
localTranslateIndex integer

Returns

  • None

C Prototype

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

🔼


obj_translate_xyz_random

Lua Example

obj_translate_xyz_random(obj, rangeLength)

Parameters

Field Type
obj Object
rangeLength number

Returns

  • None

C Prototype

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

🔼


obj_translate_xz_random

Lua Example

obj_translate_xz_random(obj, rangeLength)

Parameters

Field Type
obj Object
rangeLength number

Returns

  • None

C Prototype

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

🔼


obj_turn_toward_object

Lua Example

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

Parameters

Field Type
obj Object
target Object
angleIndex integer
turnAmount integer

Returns

  • integer

C Prototype

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

🔼


player_performed_grab_escape_action

Lua Example

local integerValue = player_performed_grab_escape_action()

Parameters

  • None

Returns

  • integer

C Prototype

s32 player_performed_grab_escape_action(void);

🔼


random_f32_around_zero

Lua Example

local numberValue = random_f32_around_zero(diameter)

Parameters

Field Type
diameter number

Returns

  • number

C Prototype

f32 random_f32_around_zero(f32 diameter);

🔼


set_mario_interact_hoot_if_in_range

Lua Example

set_mario_interact_hoot_if_in_range(sp0, sp4, sp8)

Parameters

Field Type
sp0 integer
sp4 integer
sp8 number

Returns

  • None

C Prototype

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

🔼


set_time_stop_flags

Lua Example

set_time_stop_flags(flags)

Parameters

Field Type
flags integer

Returns

  • None

C Prototype

void set_time_stop_flags(s32 flags);

🔼


signum_positive

Lua Example

local integerValue = signum_positive(x)

Parameters

Field Type
x integer

Returns

  • integer

C Prototype

s32 signum_positive(s32 x);

🔼


spawn_base_star_with_no_lvl_exit

Lua Example

spawn_base_star_with_no_lvl_exit()

Parameters

  • None

Returns

  • None

C Prototype

void spawn_base_star_with_no_lvl_exit(void);

🔼


spawn_mist_particles

Lua Example

spawn_mist_particles()

Parameters

  • None

Returns

  • None

C Prototype

void spawn_mist_particles(void);

🔼


spawn_mist_particles_with_sound

Lua Example

spawn_mist_particles_with_sound(sp18)

Parameters

Field Type
sp18 integer

Returns

  • None

C Prototype

void spawn_mist_particles_with_sound(u32 sp18);

🔼


spawn_star_with_no_lvl_exit

Lua Example

local ObjectValue = spawn_star_with_no_lvl_exit(sp20, sp24)

Parameters

Field Type
sp20 integer
sp24 integer

Returns

Object

C Prototype

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

🔼


spawn_water_droplet

Lua Example

local ObjectValue = spawn_water_droplet(parent, params)

Parameters

Field Type
parent Object
params WaterDropletParams

Returns

Object

C Prototype

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

🔼


stub_obj_helpers_3

Lua Example

stub_obj_helpers_3(sp0, sp4)

Parameters

Field Type
sp0 integer
sp4 integer

Returns

  • None

C Prototype

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

🔼


stub_obj_helpers_4

Lua Example

stub_obj_helpers_4()

Parameters

  • None

Returns

  • None

C Prototype

void stub_obj_helpers_4(void);

🔼


functions from rumble_init.c


queue_rumble_data

Lua Example

queue_rumble_data(a0, a1)

Parameters

Field Type
a0 integer
a1 integer

Returns

  • None

C Prototype

void queue_rumble_data(s16 a0, s16 a1);

🔼


queue_rumble_data_mario

Lua Example

queue_rumble_data_mario(m, a0, a1)

Parameters

Field Type
m MarioState
a0 integer
a1 integer

Returns

  • None

C Prototype

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

🔼


queue_rumble_data_object

Lua Example

queue_rumble_data_object(object, a0, a1)

Parameters

Field Type
object Object
a0 integer
a1 integer

Returns

  • None

C Prototype

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

🔼


reset_rumble_timers

Lua Example

reset_rumble_timers(m)

Parameters

Field Type
m MarioState

Returns

  • None

C Prototype

void reset_rumble_timers(struct MarioState* m);

🔼


reset_rumble_timers_2

Lua Example

reset_rumble_timers_2(m, a0)

Parameters

Field Type
m MarioState
a0 integer

Returns

  • None

C Prototype

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

🔼


functions from save_file.h


save_file_clear_flags

Lua Example

save_file_clear_flags(flags)

Parameters

Field Type
flags integer

Returns

  • None

C Prototype

void save_file_clear_flags(u32 flags);

🔼


save_file_get_cap_pos

Lua Example

local integerValue = save_file_get_cap_pos(capPos)

Parameters

Field Type
capPos Vec3s

Returns

  • integer

C Prototype

s32 save_file_get_cap_pos(Vec3s capPos);

🔼


save_file_get_course_coin_score

Lua Example

local integerValue = save_file_get_course_coin_score(fileIndex, courseIndex)

Parameters

Field Type
fileIndex integer
courseIndex integer

Returns

  • integer

C Prototype

s32 save_file_get_course_coin_score(s32 fileIndex, s32 courseIndex);

🔼


save_file_get_course_star_count

Lua Example

local integerValue = save_file_get_course_star_count(fileIndex, courseIndex)

Parameters

Field Type
fileIndex integer
courseIndex integer

Returns

  • integer

C Prototype

s32 save_file_get_course_star_count(s32 fileIndex, s32 courseIndex);

🔼


save_file_get_flags

Lua Example

local integerValue = save_file_get_flags()

Parameters

  • None

Returns

  • integer

C Prototype

u32 save_file_get_flags(void);

🔼


save_file_get_max_coin_score

Lua Example

local integerValue = save_file_get_max_coin_score(courseIndex)

Parameters

Field Type
courseIndex integer

Returns

  • integer

C Prototype

u32 save_file_get_max_coin_score(s32 courseIndex);

🔼


save_file_get_sound_mode

Lua Example

local integerValue = save_file_get_sound_mode()

Parameters

  • None

Returns

  • integer

C Prototype

u16 save_file_get_sound_mode(void);

🔼


save_file_get_star_flags

Lua Example

local integerValue = save_file_get_star_flags(fileIndex, courseIndex)

Parameters

Field Type
fileIndex integer
courseIndex integer

Returns

  • integer

C Prototype

u32 save_file_get_star_flags(s32 fileIndex, s32 courseIndex);

🔼


save_file_get_total_star_count

Lua Example

local integerValue = save_file_get_total_star_count(fileIndex, minCourse, maxCourse)

Parameters

Field Type
fileIndex integer
minCourse integer
maxCourse integer

Returns

  • integer

C Prototype

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

🔼


save_file_set_flags

Lua Example

save_file_set_flags(flags)

Parameters

Field Type
flags integer

Returns

  • None

C Prototype

void save_file_set_flags(u32 flags);

🔼


functions from smlua_collision_utils.h


collision_find_surface_on_ray

Lua Example

local RayIntersectionInfoValue = collision_find_surface_on_ray(startX, startY, startZ, endX, endY, endZ)

Parameters

Field Type
startX number
startY number
startZ number
endX number
endY number
endZ number

Returns

RayIntersectionInfo

C Prototype

struct RayIntersectionInfo* collision_find_surface_on_ray(f32 startX, f32 startY, f32 startZ, f32 endX, f32 endY, f32 endZ);

🔼


get_water_surface_pseudo_floor

Lua Example

local SurfaceValue = get_water_surface_pseudo_floor()

Parameters

  • None

Returns

Surface

C Prototype

struct Surface* get_water_surface_pseudo_floor(void);

🔼


functions from smlua_misc_utils.h


allocate_mario_action

Lua Example

local integerValue = allocate_mario_action(actFlags)

Parameters

Field Type
actFlags integer

Returns

  • integer

C Prototype

u32 allocate_mario_action(u32 actFlags);

🔼


get_hand_foot_pos_x

Lua Example

local numberValue = get_hand_foot_pos_x(m, index)

Parameters

Field Type
m MarioState
index integer

Returns

  • number

C Prototype

f32 get_hand_foot_pos_x(struct MarioState* m, u8 index);

🔼


get_hand_foot_pos_y

Lua Example

local numberValue = get_hand_foot_pos_y(m, index)

Parameters

Field Type
m MarioState
index integer

Returns

  • number

C Prototype

f32 get_hand_foot_pos_y(struct MarioState* m, u8 index);

🔼


get_hand_foot_pos_z

Lua Example

local numberValue = get_hand_foot_pos_z(m, index)

Parameters

Field Type
m MarioState
index integer

Returns

  • number

C Prototype

f32 get_hand_foot_pos_z(struct MarioState* m, u8 index);

🔼


get_network_area_timer

Lua Example

local integerValue = get_network_area_timer()

Parameters

  • None

Returns

  • integer

C Prototype

u32 get_network_area_timer(void);

🔼


hud_hide

Lua Example

hud_hide()

Parameters

  • None

Returns

  • None

C Prototype

void hud_hide(void);

🔼


hud_show

Lua Example

hud_show()

Parameters

  • None

Returns

  • None

C Prototype

void hud_show(void);

🔼


warp_exit_level

Lua Example

local booleanValue = warp_exit_level(aDelay)

Parameters

Field Type
aDelay integer

Returns

  • boolean

C Prototype

bool warp_exit_level(s32 aDelay);

🔼


warp_restart_level

Lua Example

local booleanValue = warp_restart_level()

Parameters

  • None

Returns

  • boolean

C Prototype

bool warp_restart_level(void);

🔼


warp_to_castle

Lua Example

local booleanValue = warp_to_castle(aLevel)

Parameters

Field Type
aLevel integer

Returns

  • boolean

C Prototype

bool warp_to_castle(s32 aLevel);

🔼


warp_to_level

Lua Example

local booleanValue = warp_to_level(aLevel, aArea, aAct)

Parameters

Field Type
aLevel integer
aArea integer
aAct integer

Returns

  • boolean

C Prototype

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

🔼


functions from smlua_model_utils.h


smlua_model_util_get_id

Lua Example

local integerValue = smlua_model_util_get_id(name)

Parameters

Field Type
name string

Returns

  • integer

C Prototype

u32 smlua_model_util_get_id(const char* name);

🔼


functions from smlua_obj_utils.h


get_temp_object_hitbox

Lua Example

local ObjectHitboxValue = get_temp_object_hitbox()

Parameters

  • None

Returns

ObjectHitbox

C Prototype

struct ObjectHitbox* get_temp_object_hitbox(void);

🔼


obj_get_first

Lua Example

local ObjectValue = obj_get_first(objList)

Parameters

Field Type
objList enum ObjectList

Returns

Object

C Prototype

struct Object *obj_get_first(enum ObjectList objList);

🔼


obj_get_first_with_behavior_id

Lua Example

local ObjectValue = obj_get_first_with_behavior_id(behaviorId)

Parameters

Field Type
behaviorId enum BehaviorId

Returns

Object

C Prototype

struct Object *obj_get_first_with_behavior_id(enum BehaviorId behaviorId);

🔼


obj_get_first_with_behavior_id_and_field_f32

Lua Example

local ObjectValue = obj_get_first_with_behavior_id_and_field_f32(behaviorId, fieldIndex, value)

Parameters

Field Type
behaviorId enum BehaviorId
fieldIndex integer
value number

Returns

Object

C Prototype

struct Object *obj_get_first_with_behavior_id_and_field_f32(enum BehaviorId behaviorId, s32 fieldIndex, f32 value);

🔼


obj_get_first_with_behavior_id_and_field_s32

Lua Example

local ObjectValue = obj_get_first_with_behavior_id_and_field_s32(behaviorId, fieldIndex, value)

Parameters

Field Type
behaviorId enum BehaviorId
fieldIndex integer
value integer

Returns

Object

C Prototype

struct Object *obj_get_first_with_behavior_id_and_field_s32(enum BehaviorId behaviorId, s32 fieldIndex, s32 value);

🔼


obj_get_next

Lua Example

local ObjectValue = obj_get_next(o)

Parameters

Field Type
o Object

Returns

Object

C Prototype

struct Object *obj_get_next(struct Object *o);

🔼


obj_get_next_with_same_behavior_id

Lua Example

local ObjectValue = obj_get_next_with_same_behavior_id(o)

Parameters

Field Type
o Object

Returns

Object

C Prototype

struct Object *obj_get_next_with_same_behavior_id(struct Object *o);

🔼


obj_get_next_with_same_behavior_id_and_field_f32

Lua Example

local ObjectValue = obj_get_next_with_same_behavior_id_and_field_f32(o, fieldIndex, value)

Parameters

Field Type
o Object
fieldIndex integer
value number

Returns

Object

C Prototype

struct Object *obj_get_next_with_same_behavior_id_and_field_f32(struct Object *o, s32 fieldIndex, f32 value);

🔼


obj_get_next_with_same_behavior_id_and_field_s32

Lua Example

local ObjectValue = obj_get_next_with_same_behavior_id_and_field_s32(o, fieldIndex, value)

Parameters

Field Type
o Object
fieldIndex integer
value integer

Returns

Object

C Prototype

struct Object *obj_get_next_with_same_behavior_id_and_field_s32(struct Object *o, s32 fieldIndex, s32 value);

🔼


obj_get_temp_spawn_particles_info

Lua Example

local SpawnParticlesInfoValue = obj_get_temp_spawn_particles_info(modelId)

Parameters

Field Type
modelId enum ModelExtendedId

Returns

SpawnParticlesInfo

C Prototype

struct SpawnParticlesInfo* obj_get_temp_spawn_particles_info(enum ModelExtendedId modelId);

🔼


obj_has_behavior_id

Lua Example

local integerValue = obj_has_behavior_id(o, behaviorId)

Parameters

Field Type
o Object
behaviorId enum BehaviorId

Returns

  • integer

C Prototype

s32 obj_has_behavior_id(struct Object *o, enum BehaviorId behaviorId);

🔼


obj_has_model_extended

Lua Example

local integerValue = obj_has_model_extended(o, modelId)

Parameters

Field Type
o Object
modelId enum ModelExtendedId

Returns

  • integer

C Prototype

s32 obj_has_model_extended(struct Object *o, enum ModelExtendedId modelId);

🔼


obj_set_model_extended

Lua Example

obj_set_model_extended(o, modelId)

Parameters

Field Type
o Object
modelId enum ModelExtendedId

Returns

  • None

C Prototype

void obj_set_model_extended(struct Object *o, enum ModelExtendedId modelId);

🔼


spawn_non_sync_object

Lua Example

local ObjectValue = spawn_non_sync_object(behaviorId, modelId, x, y, z, objSetupFunction)

Parameters

Field Type
behaviorId enum BehaviorId
modelId enum ModelExtendedId
x number
y number
z number
objSetupFunction Lua Function ()

Returns

Object

C Prototype

struct Object* spawn_non_sync_object(enum BehaviorId behaviorId, enum ModelExtendedId modelId, f32 x, f32 y, f32 z, LuaFunction objSetupFunction);

🔼


spawn_sync_object

Lua Example

local ObjectValue = spawn_sync_object(behaviorId, modelId, x, y, z, objSetupFunction)

Parameters

Field Type
behaviorId enum BehaviorId
modelId enum ModelExtendedId
x number
y number
z number
objSetupFunction Lua Function ()

Returns

Object

C Prototype

struct Object* spawn_sync_object(enum BehaviorId behaviorId, enum ModelExtendedId modelId, f32 x, f32 y, f32 z, LuaFunction objSetupFunction);

🔼


functions from sound_init.h


disable_background_sound

Lua Example

disable_background_sound()

Parameters

  • None

Returns

  • None

C Prototype

void disable_background_sound(void);

🔼


enable_background_sound

Lua Example

enable_background_sound()

Parameters

  • None

Returns

  • None

C Prototype

void enable_background_sound(void);

🔼


fadeout_cap_music

Lua Example

fadeout_cap_music()

Parameters

  • None

Returns

  • None

C Prototype

void fadeout_cap_music(void);

🔼


fadeout_level_music

Lua Example

fadeout_level_music(fadeTimer)

Parameters

Field Type
fadeTimer integer

Returns

  • None

C Prototype

void fadeout_level_music(s16 fadeTimer);

🔼


fadeout_music

Lua Example

fadeout_music(fadeOutTime)

Parameters

Field Type
fadeOutTime integer

Returns

  • None

C Prototype

void fadeout_music(s16 fadeOutTime);

🔼


lower_background_noise

Lua Example

lower_background_noise(a)

Parameters

Field Type
a integer

Returns

  • None

C Prototype

void lower_background_noise(s32 a);

🔼


play_cap_music

Lua Example

play_cap_music(seqArgs)

Parameters

Field Type
seqArgs integer

Returns

  • None

C Prototype

void play_cap_music(u16 seqArgs);

🔼


play_cutscene_music

Lua Example

play_cutscene_music(seqArgs)

Parameters

Field Type
seqArgs integer

Returns

  • None

C Prototype

void play_cutscene_music(u16 seqArgs);

🔼


play_infinite_stairs_music

Lua Example

play_infinite_stairs_music()

Parameters

  • None

Returns

  • None

C Prototype

void play_infinite_stairs_music(void);

🔼


play_menu_sounds

Lua Example

play_menu_sounds(soundMenuFlags)

Parameters

Field Type
soundMenuFlags integer

Returns

  • None

C Prototype

void play_menu_sounds(s16 soundMenuFlags);

🔼


play_painting_eject_sound

Lua Example

play_painting_eject_sound()

Parameters

  • None

Returns

  • None

C Prototype

void play_painting_eject_sound(void);

🔼


play_shell_music

Lua Example

play_shell_music()

Parameters

  • None

Returns

  • None

C Prototype

void play_shell_music(void);

🔼


raise_background_noise

Lua Example

raise_background_noise(a)

Parameters

Field Type
a integer

Returns

  • None

C Prototype

void raise_background_noise(s32 a);

🔼


reset_volume

Lua Example

reset_volume()

Parameters

  • None

Returns

  • None

C Prototype

void reset_volume(void);

🔼


set_background_music

Lua Example

set_background_music(a, seqArgs, fadeTimer)

Parameters

Field Type
a integer
seqArgs integer
fadeTimer integer

Returns

  • None

C Prototype

void set_background_music(u16 a, u16 seqArgs, s16 fadeTimer);

🔼


stop_cap_music

Lua Example

stop_cap_music()

Parameters

  • None

Returns

  • None

C Prototype

void stop_cap_music(void);

🔼


stop_shell_music

Lua Example

stop_shell_music()

Parameters

  • None

Returns

  • None

C Prototype

void stop_shell_music(void);

🔼


functions from spawn_sound.c


calc_dist_to_volume_range_1

Lua Example

local integerValue = calc_dist_to_volume_range_1(distance)

Parameters

Field Type
distance number

Returns

  • integer

C Prototype

s32 calc_dist_to_volume_range_1(f32 distance);

🔼


calc_dist_to_volume_range_2

Lua Example

local integerValue = calc_dist_to_volume_range_2(distance)

Parameters

Field Type
distance number

Returns

  • integer

C Prototype

s32 calc_dist_to_volume_range_2(f32 distance);

🔼


cur_obj_play_sound_1

Lua Example

cur_obj_play_sound_1(soundMagic)

Parameters

Field Type
soundMagic integer

Returns

  • None

C Prototype

void cur_obj_play_sound_1(s32 soundMagic);

🔼


cur_obj_play_sound_2

Lua Example

cur_obj_play_sound_2(soundMagic)

Parameters

Field Type
soundMagic integer

Returns

  • None

C Prototype

void cur_obj_play_sound_2(s32 soundMagic);

🔼


exec_anim_sound_state

Lua Example

exec_anim_sound_state(soundStates)

Parameters

Field Type
soundStates SoundState

Returns

  • None

C Prototype

void exec_anim_sound_state(struct SoundState *soundStates);

🔼


functions from surface_collision.h


find_ceil_height

Lua Example

local numberValue = find_ceil_height(x, y, z)

Parameters

Field Type
x number
y number
z number

Returns

  • number

C Prototype

f32 find_ceil_height(f32 x, f32 y, f32 z);

🔼


find_floor_height

Lua Example

local numberValue = find_floor_height(x, y, z)

Parameters

Field Type
x number
y number
z number

Returns

  • number

C Prototype

f32 find_floor_height(f32 x, f32 y, f32 z);

🔼


find_poison_gas_level

Lua Example

local numberValue = find_poison_gas_level(x, z)

Parameters

Field Type
x number
z number

Returns

  • number

C Prototype

f32 find_poison_gas_level(f32 x, f32 z);

🔼


find_wall_collisions

Lua Example

local integerValue = find_wall_collisions(colData)

Parameters

Field Type
colData WallCollisionData

Returns

  • integer

C Prototype

s32 find_wall_collisions(struct WallCollisionData *colData);

🔼


find_water_level

Lua Example

local numberValue = find_water_level(x, z)

Parameters

Field Type
x number
z number

Returns

  • number

C Prototype

f32 find_water_level(f32 x, f32 z);

🔼


functions from surface_load.h


alloc_surface_pools

Lua Example

alloc_surface_pools()

Parameters

  • None

Returns

  • None

C Prototype

void alloc_surface_pools(void);

🔼


clear_dynamic_surfaces

Lua Example

clear_dynamic_surfaces()

Parameters

  • None

Returns

  • None

C Prototype

void clear_dynamic_surfaces(void);

🔼


get_area_terrain_size

Lua Example

local integerValue = get_area_terrain_size(data)

Parameters

Field Type
data Pointer <integer>

Returns

  • integer

C Prototype

u32 get_area_terrain_size(s16 *data);

🔼


load_area_terrain

Lua Example

load_area_terrain(index, data, surfaceRooms, macroObjects)

Parameters

Field Type
index integer
data Pointer <integer>
surfaceRooms Pointer <integer>
macroObjects Pointer <integer>

Returns

  • None

C Prototype

void load_area_terrain(s16 index, s16 *data, s8 *surfaceRooms, s16 *macroObjects);

🔼


load_object_collision_model

Lua Example

load_object_collision_model()

Parameters

  • None

Returns

  • None

C Prototype

void load_object_collision_model(void);

🔼