Explore the powerful Lua API of Kiddions Modest Menu, a GTA V Online external mod menu. This documentation guides developers through creating submenus, manipulating players and peds, handling pickups, scripting custom functionalities, and customizing vehicles and weapons. Enhance your GTA V Online experience with Kiddions Modest Menu Lua API.

Kiddion-Modest-Menu-Script-API-Documentation.md

Kiddion Modest Menu Script API Documentation

This comprehensive Lua API documentation outlines the functionality of Kiddions Modest Menu, an external mod menu designed for GTA V Online. The API covers various aspects, including submenu creation, player and ped manipulation, pickup handling, scripting capabilities, stats management, and vehicle and weapon customization.

Developers can leverage the provided methods to create submenus with diverse options, manage and modify player and ped attributes, manipulate pickups, and script custom functionalities. The API also enables control over various vehicle parameters such as speed, health, and suspension, as well as weapon attributes like damage, ammo, and firing behavior.

Whether it's handling in-game entities, tweaking gameplay mechanics, or creating unique features within the mod menu, this documentation serves as a comprehensive guide for script developers looking to extend the capabilities of Kiddions Modest Menu in GTA V Online.

Functions

Return	Method	Parameters
Integer	joaat	String text
nil	sleep	Number seconds
nil	require_game_build	Integer build

Globals

Return	Method	Parameters
bool	globals.get_bool	Integer index
Number	globals.get_float	Integer index
Integer	globals.get_int	Integer index
String	globals.get_string	Integer index
		Integer maxSize
Integer	globals.get_uint	Integer index
nil	globals.set_bool	Integer index
		bool value
nil	globals.set_float	Integer index
		Number value
nil	globals.set_int	Integer index
		Integer value
nil	globals.set_string	Integer index
		String value
		Integer maxSize
nil	globals.set_uint	Integer index
		Integer value

JSON

Return	Method	Parameters
Table	json.loadfile	String filename
nil	json.savefile	String filename
		Table data

---

Menu

Return	Method	Parameters
Int [major]	menu.get_game_version
Int [minor]
Int [build]
Int [patch]
Submenu	menu.add_submenu	String name
		nil function on_enter
nil	menu.add_bare_item	String name
		String|nil function reload
		nil function action
		String|nil function on_left
		String|nil function on_right
nil	menu.add_action	String name
		nil function action
		bool function is_valid
nil	menu.add_array_item	String name
		Integer-to-String Table items
		Integer|nil function getter
		nil function setter(Integer value)
nil	menu.add_float_range	String name
		float step
		float min_value
		float max_value
		Number|nil function getter
		nil function setter(Number value)
nil	menu.add_int_range	String name
		Integer step
		Integer min_value
		Integer max_value
		Integer|nil function getter
		nil function setter(Integer value)
nil	menu.add_toggle	String name
		bool|nil function getter
		nil function setter(bool value)
nil	menu.clear
Submenu	menu.add_player_submenu	String name
		nil function on_enter
nil	menu.add_player_action	String name
		nil function action(Integer index)
nil	menu.add_player_action	String name
		nil unction action(Integer index)
		bool function is_valid(Integer index)
nil	menu.add_player_float_range	String name
		float step
		float min_value
		float max_value
		Number|nil function getter(Integer index)
		nil function setter(Integer index, Number value)
nil	menu.add_player_int_range	String name
		Integer step
		Integer min_value
		Integer max_value
		Integer|nil function getter(Integer index)
		nil function setter(Integer index, Integer value)
nil	menu.add_player_toggle	String name
		bool|nil function getter(Integer index)
		nil function setter(Integer index, bool value)
Integer	menu.get_selected_player_index
nil	menu.player_clear
Lua_ref	menu.register_hotkey	Integer keycode
		function callback
Lua_ref	menu.register_callback	String event
		function callback
nil	menu.emit_event	String custom_event_name
nil	menu.remove_hotkey	Lua_ref reference
nil	menu.remove_callback	Lua_ref reference
nil	menu.send_key_down	Integer keycode
nil	menu.send_key_press	Integer keycode
nil	menu.send_key_up	Integer keycode
nil	menu.call_airstrike
nil	menu.call_heli_backup
nil	menu.clear_wanted_level
nil	menu.deliver_acid_lab
nil	menu.deliver_ammo
nil	menu.deliver_avenger
nil	menu.deliver_avisa
nil	menu.deliver_bullshark
nil	menu.deliver_delivery_bike
nil	menu.deliver_dinghy
nil	menu.deliver_kosatka
nil	menu.deliver_minigun
nil	menu.deliver_moc
nil	menu.deliver_personal_vehicle
nil	menu.deliver_resupplies
nil	menu.deliver_sparrow
nil	menu.deliver_terrorbyte
nil	menu.detach_objects
nil	menu.disconnect_session
nil	menu.drop_beer
nil	menu.empty_session
nil	menu.end_cutscene
nil	menu.enter_personal_vehicle
nil	menu.go_to_cayo_beach_party
nil	menu.heal_all
nil	menu.heal_player
nil	menu.heal_vehicle
nil	menu.instant_bullshark
nil	menu.instant_drone
nil	menu.instant_minigun
nil	menu.instant_minitank
nil	menu.instant_rcbandito
nil	menu.kill_all_vehicles
nil	menu.kill_all_enemies
nil	menu.kill_all_mission_peds
nil	menu.kill_all_mission_vehicles
nil	menu.kill_all_npcs
nil	menu.kill_current_vehicle
nil	menu.level_current_vehicle
nil	menu.max_all_ammo
nil	menu.max_current_ammo
nil	menu.refill_boost
nil	menu.remove_cctvs
nil	menu.remove_insurance_claims
nil	menu.repair_online_vehicle
nil	menu.retrieve_personal_vehicle
nil	menu.start_choose_character
nil	menu.start_creator_mode
nil	menu.start_singleplayer
nil	menu.suicide_player
nil	menu.teleport_forward
nil	menu.teleport_to_current_vehicle
nil	menu.teleport_to_objective
nil	menu.teleport_to_waypoint
nil	menu.trigger_acid_lab_production
nil	menu.trigger_boat_pickup
nil	menu.trigger_bunker_production
nil	menu.trigger_bunker_research
nil	menu.trigger_heli_pickup
nil	menu.trigger_heli_vip_pickup
nil	menu.trigger_mc_production
nil	menu.trigger_nightclub_production
bool	menu.get_assisted_aim
bool	menu.get_big_map
bool	menu.get_blackout
bool	menu.get_bribe_authorities
bool	menu.get_cops_turn_blind_eye
bool	menu.get_disable_send_to_island
bool	menu.get_disable_send_to_job
bool	menu.get_disable_teleport_to_apartment
bool	menu.get_disable_vehicle_kick
bool	menu.get_ghost_organisation
bool	menu.get_mobile_radio
bool	menu.get_nightvision
bool	menu.get_offradar
bool	menu.get_out_of_sight
bool	menu.get_passive
bool	menu.get_reveal_player
bool	menu.get_thermalvision
nil	menu.set_assisted_aim	bool value
nil	menu.set_big_map	bool value
nil	menu.set_blackout	bool value
nil	menu.set_bribe_authorities	bool value
nil	menu.set_cops_turn_blind_eye	bool value
nil	menu.set_disable_send_to_island	bool value
nil	menu.set_disable_send_to_job	bool value
nil	menu.set_disable_teleport_to_apartment	bool value
nil	menu.set_disable_vehicle_kick	bool value
nil	menu.set_ghost_organisation	bool value
nil	menu.set_mobile_radio	bool value
nil	menu.set_nightvision	bool value
nil	menu.set_offradar	bool value
nil	menu.set_out_of_sight	bool value
nil	menu.set_passive	bool value
nil	menu.set_reveal_player	bool value
nil	menu.set_thermalvision	bool value

Supported callback events:
"OnPlayerChanged" -> function(Ped|nil oldPlayer, Ped|nil newPlayer)
"OnPlayerStateChanged" -> function(Integer oldState, Integer newState)
"OnVehicleChanged" -> function(Vehicle|nil oldVehicle, Vehicle|nil newVehicle)
"OnWeaponChanged" -> function(Weapon|nil oldWeapon, Weapon|nil newWeapon)
<custom_event_name> -> function()

Submenu

Return	Method	Parameters
Submenu	submenu:add_submenu	String name
		nil function on_enter
nil	submenu:add_bare_item	String name
		String|nil function reload
		nil function action
		String|nil function on_left
		String|nil function on_right
nil	submenu:add_action	String name
		nil function action
		bool function is_valid
nil	submenu:add_array_item	String name
		Integer-to-String Table items
		Integer|nil function getter
		nil function setter(Integer value)
nil	submenu:add_float_range	String name
		float step
		float min_value
		float max_value
		Number|nil function getter
		nil function setter(Integer value)
nil	submenu:add_int_range	String name
		Integer step
		Integer min_value
		Integer max_value
		Integer|nil function getter
		nil function setter(Integer value)
nil	submenu:add_toggle	String name
		bool|nil function getter
		nil function setter(bool value)
nil	submenu:clear

Ped

Return	Method	Parameters
Iterator<Integer>	ped:get_all_weapon_hashes
Integer	ped:get_armour
bool	ped:get_can_be_targeted
bool	ped:get_config_flag	Integer index
Vehicle	ped:get_current_vehicle
Weapon	ped:get_current_weapon
bool	ped:get_everyone_ignore
bool	ped:get_freeze_momentum
bool	ped:get_godmode
Vector3	ped:get_heading
Number	ped:get_health
Number	ped:get_hurt_health
bool	ped:get_infinite_ammo
bool	ped:get_infinite_clip
Number	ped:get_max_health
Integer	ped:get_model_hash
Vehicle	ped:get_nearest_vehicle
bool	ped:get_no_ragdoll
Integer	ped:get_pedtype
Integer	ped:get_player_id
bool	ped:get_police_ignore
Vector3	ped:get_position
bool	ped:get_reset_flag	Integer index
Vector3	ped:get_rotation
Number	ped:get_run_speed
bool	ped:get_seatbelt
Number	ped:get_swim_speed
Vector3	ped:get_velocity
Integer	ped:get_wallet
Integer	ped:get_wanted_level
bool	ped:get_weapon_enabled	Integer weapon_hash
Weapon	ped:get_weapon_by_hash	Integer weapon_hash
bool	ped:is_in_cutscene
bool	ped:is_in_vehicle
nil	ped:set_armour	Integer value
nil	ped:set_can_be_targeted	bool value
nil	ped:set_config_flag	Integer index
		bool value
nil	ped:set_everyone_ignore	bool value
nil	ped:set_freeze_momentum	bool value
nil	ped:set_godmode	bool value
nil	ped:set_health	Number value
nil	ped:set_infinite_ammo	bool value
nil	ped:set_infinite_clip	bool value
nil	ped:set_max_health	Number value
nil	ped:set_model_hash	Integer value
nil	ped:set_no_ragdoll	bool value
nil	ped:set_police_ignore	bool value
nil	ped:set_position	vector3 value
nil	ped:set_reset_flag	Integer index
		bool value
nil	ped:set_rotation	vector3 value
nil	ped:set_run_speed	Number value
nil	ped:set_seatbelt	bool value
nil	ped:set_swim_speed	Number value
nil	ped:set_wallet	Integer value
nil	ped:set_wanted_level	Integer value
nil	ped:set_weapon_enabled	Integer weapon_hash
		bool value

Pickup

Return	Method	Parameters
Integer	pickup:get_amount
Number	pickup:get_health
Integer	pickup:get_model_hash
Integer	pickup:get_pickup_hash
Vector3	pickup:get_position
Vector3	pickup:get_rotation
nil	pickup:set_amount	Integer value
nil	pickup:set_health	Number value
nil	pickup:set_model_hash	Integer value
nil	pickup:set_model_hash	String value
nil	pickup:set_pickup_hash	Integer value
nil	pickup:set_pickup_hash	String value
nil	pickup:set_position	vector3 value
nil	pickup:set_rotation	vector3 value

Player

Return	Method	Parameters
Integer	player.get_number_of_players
String	player.get_player_name	Integer i
ped	player.get_player_ped
ped	player.get_player_ped	Integer i

---

Replayinterface

Return	Method
Iterator<ped>	replayinterface.get_peds
Iterator<pickup>	replayinterface.get_pickups
Iterator<vehicle>	replayinterface.get_vehicles

---

Script

Return	Method	Parameters
script	script	Integer scriptNameHash
script	script	String scriptName
bool	script:get_bool	Integer index
Number	script:get_float	Integer index
Integer	script:get_int	Integer index
String	script:get_string	Integer index
		Integer maxSize
Integer	script:get_uint	Integer index
bool	script:is_active
nil	script:set_bool	Integer index
		bool value
nil	script:set_float	Integer index
		Number value
nil	script:set_int	Integer index
		Integer value
nil	script:set_string	Integer index
		String value
		Integer maxSize
nil	script:set_uint	Integer index
		Integer value

Stats

Return	Method	Parameters
bool	stats.get_bool	Integer hash
bool	stats.get_bool	String statName
bool	stats.get_bool_masked	Integer hash
		Integer bitIndex
bool	stats.get_bool_masked	String statName
		Integer bitIndex
Number	stats.get_float	Integer hash
Number	stats.get_float	String statName
Integer	stats.get_int	Integer hash
Integer	stats.get_int	String statName
Integer	stats.get_masked_int	Integer hash
		Integer bitStart
		Integer bitSize
Integer	stats.get_masked_int	String statName
		Integer bitStart
		Integer bitSize
bool	stats.set_bool	Integer hash
		bool value
bool	stats.set_bool	String statName
		bool value
bool	stats.set_bool_masked	Integer hash
		bool value
		Integer bitIndex
bool	stats.set_bool_masked	String statName
		bool value
		Integer bitIndex
bool	stats.set_float	Integer hash
		Number value
bool	stats.set_float	String statName
		Number value
bool	stats.set_int	Integer hash
		Integer value
bool	stats.set_int	String statName
		Integer value
bool	stats.set_masked_int	Integer hash
		Integer value
		Integer bitStart
		Integer bitSize
bool	stats.set_masked_int	String statName
		Integer value
		Integer bitStart
		Integer bitSize

Vehicle

Return	Method	Parameters
Number	vehicle:get_acceleration
Number	vehicle:get_anti_roll_bar_bias_front
Number	vehicle:get_anti_roll_bar_force
Integer	vehicle:get_bomb_count
bool	vehicle:get_boost
bool	vehicle:get_boost_active
bool	vehicle:get_boost_enabled
Number	vehicle:get_bouyance
Number	vehicle:get_brake_bias_front
Number	vehicle:get_brake_force
bool	vehicle:get_bulletproof_tires
Number	vehicle:get_camber_stiffness
bool	vehicle:get_can_be_targeted
bool	vehicle:get_can_be_visibly_damaged
Vector3	vehicle:get_centre_of_mass_offset
Number	vehicle:get_collision_damage_multiplier
Integer	vehicle:get_countermeasure_count
bool	vehicle:get_create_money_pickups
Int [r 0..255]
Int [g 0..255]	vehicle:get_custom_primary_colour
Int [b 0..255]
Int [r 0..255]
Int [g 0..255]	vehicle:get_custom_secondary_colour
Int [b 0..255]
Number	vehicle:get_deformation_damage_multiplier
Number	vehicle:get_dirt_level
Integer	vehicle:get_door_lock_state
Number	vehicle:get_down_shift
bool	vehicle:get_drift_tyres_enabled
Number	vehicle:get_drift_vehicle_reduced_suspension
Number	vehicle:get_drive_bias_front
Number	vehicle:get_drive_inertia
Number	vehicle:get_engine_damage_multiplier
Number	vehicle:get_gravity
bool	vehicle:get_godmode
Number	vehicle:get_handbrake_force
Integer	vehicle:get_handling_name_hash
Vector3	vehicle:get_heading
Number	vehicle:get_health
Vector3	vehicle:get_inertia_multiplier
Number	vehicle:get_initial_drag_coeff
Number	vehicle:get_initial_drive_force
Integer	vehicle:get_initial_drive_gears
Number	vehicle:get_initial_drive_max_flat_velocity
Number	vehicle:get_low_speed_traction_loss_multiplier
Number	vehicle:get_mass
Number	vehicle:get_max_health
Number	vehicle:get_max_speed
Integer	vehicle:get_mission_flags
Integer	vehicle:get_model_hash
Integer	vehicle:get_number_plate_index
String	vehicle:get_number_plate_text
Integer	vehicle:get_parachute_hash
Integer	vehicle:get_parachute_texture_variation
Number	vehicle:get_percent_submerged
Vector3	vehicle:get_position
Number	vehicle:get_roll_centre_height_front
Number	vehicle:get_roll_centre_height_rear
Vector3	vehicle:get_rotation
Number	vehicle:get_steering_lock
Number	vehicle:get_suspension_bias_front
Number	vehicle:get_suspension_comp_damp
Number	vehicle:get_suspension_force
Number	vehicle:get_suspension_height
Number	vehicle:get_suspension_lower_limit
Number	vehicle:get_suspension_raise
Number	vehicle:get_suspension_rebound_damp
Number	vehicle:get_suspension_upper_limit
Number	vehicle:get_traction_bias_front
Number	vehicle:get_traction_curve_lateral
Number	vehicle:get_traction_curve_max
Number	vehicle:get_traction_curve_min
Number	vehicle:get_traction_loss_multiplier
Number	vehicle:get_traction_spring_delta_max
Number	vehicle:get_up_shift
Vector3	vehicle:get_velocity
Number	vehicle:get_weapon_damage_multiplier
bool	vehicle:get_window_collisions_disabled
Integer	vehicle:get_window_tint
nil	vehicle:set_acceleration	Number value
nil	vehicle:set_anti_roll_bar_bias_front	Number value
nil	vehicle:set_anti_roll_bar_force	Number value
nil	vehicle:set_bomb_count	Integer value
nil	vehicle:set_boost	bool value
nil	vehicle:set_boost_enabled	bool value
nil	vehicle:set_bouyance	Number value
nil	vehicle:set_brake_bias_front	Number value
nil	vehicle:set_brake_force	Number value
nil	vehicle:set_bulletproof_tires	bool value
nil	vehicle:set_camber_stiffness	Number value
nil	vehicle:set_can_be_targeted	bool value
nil	vehicle:set_can_be_visibly_damaged	bool value
nil	vehicle:set_centre_of_mass_offset	Vector3 value
nil	vehicle:set_collision_damage_multiplier	Number value
nil	vehicle:set_countermeasure_count	Integer value
nil	vehicle:set_create_money_pickups	bool value
nil	vehicle:set_custom_primary_colour	Integer r
		Integer g
		Integer b
nil	vehicle:set_custom_secondary_colour	Integer r
		Integer g
		Integer b
nil	vehicle:set_deformation_damage_multiplier	Number value
nil	vehicle:set_dirt_level	Number value
nil	vehicle:set_door_lock_state	Integer value
nil	vehicle:set_down_shift	Number value
nil	vehicle:set_drift_tyres_enabled	bool value
nil	vehicle:set_drift_vehicle_reduced_suspension	bool value
nil	vehicle:set_drive_bias_front	Number value
nil	vehicle:set_drive_inertia	Vector3 value
nil	vehicle:set_engine_damage_multiplier	Number value
nil	vehicle:set_gravity	Number value
nil	vehicle:set_godmode	bool value
nil	vehicle:set_handbrake_force	Number value
nil	vehicle:set_health	Number value
nil	vehicle:set_inertia_multiplier	Number value
nil	vehicle:set_initial_drag_coeff	Number value
nil	vehicle:set_initial_drive_force	Number value
nil	vehicle:set_initial_drive_gears	Integer value
nil	vehicle:set_initial_drive_max_flat_velocity	Number value
nil	vehicle:set_low_speed_traction_loss_multiplier	Number value
nil	vehicle:set_mass	Number value
nil	vehicle:set_max_speed	Number value
nil	vehicle:set_model_hash	Integer value
nil	vehicle:set_number_plate_index	Integer value
nil	vehicle:set_number_plate_text	String value
nil	vehicle:set_parachute_hash	Integer value
nil	vehicle:set_parachute_texture_variation	Integer value
nil	vehicle:set_percent_submerged	Number value
nil	vehicle:set_position	Vector3 value
nil	vehicle:set_roll_centre_height_front	Number value
nil	vehicle:set_roll_centre_height_rear	Number value
nil	vehicle:set_rotation	vector3 value
nil	vehicle:set_steering_lock	Number value
nil	vehicle:set_suspension_bias_front	Number value
nil	vehicle:set_suspension_comp_damp	Number value
nil	vehicle:set_suspension_force	Number value
nil	vehicle:set_suspension_height	Number value
nil	vehicle:set_suspension_lower_limit	Number value
nil	vehicle:set_suspension_raise	Number value
nil	vehicle:set_suspension_rebound_damp	Number value
nil	vehicle:set_suspension_upper_limit	Number value
nil	vehicle:set_traction_bias_front	Number value
nil	vehicle:set_traction_curve_lateral	Number value
nil	vehicle:set_traction_curve_max	Number value
nil	vehicle:set_traction_curve_min	Number value
nil	vehicle:set_traction_loss_multiplier	Number value
nil	vehicle:set_traction_spring_delta_max	Number value
nil	vehicle:set_up_shift	Number value
nil	vehicle:set_weapon_damage_multiplier	Number value
nil	vehicle:set_window_collisions_disabled	bool value
nil	vehicle:set_window_tint	Integer value

Weapon

Return	Method	Parameters
Number	weapon:get_ai_sound_range
Number	weapon:get_aim_fov
Number	weapon:get_bullet_damage
Integer	weapon:get_bullets_in_batch
Integer	weapon:get_current_ammo
Integer	weapon:get_damage_type
Integer	weapon:get_explosion_type
Integer	weapon:get_fire_type
Number	weapon:Weapon, get_heli_force
bool	weapon:get_infinite_ammo
Number	weapon:get_lock_on_range
Integer	weapon:get_max_ammo
Integer	weapon:get_max_mp_ammo
Integer	weapon:get_model_hash
Integer	weapon:get_name_hash
Number	weapon:get_ped_force
Number	weapon:get_range
Number	weapon:get_reload_time_multiplier
Integer	weapon:get_slot_hash
Number	weapon:get_time_between_shots
Number	weapon:get_speed
Number	weapon:get_spread
Number	weapon:get_vehicle_force
nil	weapon:set_ai_sound_range	Number value
nil	weapon:set_aim_fov	Number value
nil	weapon:set_bullet_damage	Number value
nil	weapon:set_bullets_in_batch	Integer value
nil	weapon:set_current_ammo	Integer value
nil	weapon:set_damage_type	Integer value
nil	weapon:set_explosion_type	Integer value
nil	weapon:set_heli_force	Number value
nil	weapon:set_infinite_ammo	bool value
nil	weapon:set_lock_on_range	Number value
nil	weapon:set_ped_force	Number value
nil	weapon:set_range	Number value
nil	weapon:set_reload_time_multiplier	Number value
nil	weapon:set_speed	Number value
nil	weapon:set_spread	Number value
nil	weapon:set_time_between_shots	Number value
nil	weapon:set_vehicle_force	Number value

Disclaimer:

This API documentation is intended strictly for educational and evaluation purposes. It is provided to offer insight into the functionality of Kiddions Modest Menu and to aid script developers in understanding its capabilities within the context of GTA V Online gameplay modification.

It is important to emphasize that the use of external mod menus, including Kiddions Modest Menu, to alter the gameplay experience in GTA V Online may violate the game's terms of service and community guidelines. Such actions can result in penalties, including but not limited to, bans from online services.

By accessing this documentation, users acknowledge and accept that they are solely responsible for any usage of the provided information. The developer of this documentation explicitly disclaims any responsibility or liability for the misuse of the described functionalities.

It is imperative to respect the rules and integrity of the game environment and to refrain from engaging in activities that may disrupt the experience of other players. Any decision to utilize modding tools or scripts should be made with full awareness of the potential consequences.

Remember: Play responsibly and within the boundaries of the game's terms of service.