Skip to content

soggy.Documentation Back to Soggy ↗

DEVELOPER DOCUMENTATION

Soggy guides8

Welcome Your first script Workshop & libraries 2018 compatibility Working with events Troubleshooting Sources & attribution Runtime API inventory

API reference242

Getting Started

Global Functions

Global Functions assert collectgarbage defer error getfenv getmetatable ipairs load next pairs pcall print printf rawequal rawget rawlen rawset readfile require select setfenv setmetatable tonumber tostring toticks totime type unpack vtable_bind vtable_thunk writefile xpcall

bit

bit bit.arshift bit.band bit.bnot bit.bor bit.bswap bit.bxor bit.lshift bit.rol bit.ror bit.rshift bit.tobit bit.tohex

client

client client.camera_angles client.camera_position client.color_log client.create_interface client.current_threat client.delay_call client.draw_debug_text client.draw_hitboxes client.error_log client.exec client.eye_position client.find_signature client.fire_event client.get_cvar client.get_model_name client.key_state client.latency client.log client.random_float client.random_int client.real_latency client.register_esp_flag client.reload_active_scripts client.request_full_update client.scale_damage client.screen_size client.set_clan_tag client.set_event_callback client.system_time client.timestamp client.trace_bullet client.trace_line client.unix_time client.unset_event_callback client.update_player_list client.userid_to_entindex client.visible

config

config config.export config.import config.load

database

database database.flush database.read database.write

entity

entity entity.get_all entity.get_bounding_box entity.get_classname entity.get_esp_data entity.get_game_rules entity.get_local_player entity.get_origin entity.get_player_name entity.get_player_resource entity.get_players entity.get_player_weapon entity.get_prop entity.get_steam64 entity.hitbox_position entity.is_alive entity.is_dormant entity.is_enemy entity.new_prop entity.set_prop

globals

globals globals.absoluteframetime globals.chokedcommands globals.commandack globals.curtime globals.framecount globals.frametime globals.lastoutgoingcommand globals.mapname globals.maxplayers globals.oldcommandack globals.realtime globals.servertickcount globals.tickcount globals.tickinterval

json

json json.decode_invalid_numbers json.decode_max_depth json.encode_invalid_numbers json.encode_max_depth json.encode_number_precision json.encode_sparse_array json.parse json.stringify

materialsystem

materialsystem materialsystem.arms_material materialsystem.chams_material materialsystem.find_material materialsystem.find_materials materialsystem.find_texture materialsystem.get_model_materials materialsystem.override_material materialsystem.viewmodel_material

math

math math.abs math.acos math.asin math.atan math.atan2 math.ceil math.cos math.cosh math.deg math.exp math.floor math.fmod math.frexp math.ldexp math.log math.log10 math.max math.min math.modf math.pow math.rad math.random math.randomseed math.sin math.sinh math.sqrt math.tan math.tanh

panorama

panorama panorama.loadstring panorama.open

plist

plist plist.get plist.set

renderer

renderer renderer.blur renderer.circle renderer.circle_outline renderer.gradient renderer.indicator renderer.line renderer.load_jpg renderer.load_png renderer.load_rgba renderer.load_svg renderer.measure_text renderer.rectangle renderer.text renderer.texture renderer.triangle renderer.world_to_screen

string

string string.byte string.char string.find string.format string.gmatch string.gsub string.len string.lower string.match string.rep string.reverse string.sub string.upper

ui

ui ui.get ui.is_menu_open ui.menu_position ui.menu_size ui.mouse_position ui.name ui.new_button ui.new_checkbox ui.new_color_picker ui.new_combobox ui.new_hotkey ui.new_label ui.new_listbox ui.new_multiselect ui.new_slider ui.new_string ui.new_textbox ui.reference ui.set ui.set_callback ui.set_enabled ui.set_visible ui.type ui.update

vector

vector vector.__call

Runtime events27

aim_fire aim_hit aim_miss console_input finish_command indicator net_update_end net_update_start output override_view paint paint_ui player_chat post_config_load post_config_save post_render pre_config_load pre_config_save pre_predict_command pre_render pre_render_3d predict_command run_command setup_command shutdown string_cmd voice

CS:GO events169

achievement_earned achievement_earned_local achievement_info_loaded ammo_pickup ammo_refill announce_phase_end assassination_target_killed bomb_abortdefuse bomb_abortplant bomb_beep bomb_begindefuse bomb_beginplant bomb_defused bomb_dropped bomb_exploded bomb_pickup bomb_planted bot_takeover bullet_impact buymenu_close buymenu_open buytime_ended choppers_incoming_warning client_disconnect cs_game_disconnected cs_handle_ime_event cs_intermission cs_match_end_restart cs_pre_restart cs_prev_next_spectator cs_win_panel_match cs_win_panel_round decoy_detonate decoy_firing decoy_started defuser_dropped defuser_pickup door_moving drone_above_roof drone_cargo_detached drone_dispatched dronegun_attack dz_item_interaction enable_restart_voting enter_bombzone enter_buyzone enter_rescue_zone exit_bombzone exit_buyzone exit_rescue_zone firstbombs_incoming_warning flashbang_detonate freezecam_started gg_bonus_grenade_achieved gg_final_weapon_achieved gg_killed_enemy gg_leader gg_player_impending_upgrade gg_player_levelup gg_reset_round_start_sounds gg_team_leader ggprogressive_player_levelup ggtr_player_levelup grenade_bounce grenade_thrown guardian_wave_restart hegrenade_detonate hide_freezepanel hltv_changed_mode hostage_call_for_help hostage_follows hostage_hurt hostage_killed hostage_rescued hostage_rescued_all hostage_stops_following inferno_expire inferno_extinguish inferno_startburn inspect_weapon item_equip item_found item_pickup item_pickup_failed item_pickup_slerp item_purchase item_remove items_gifted jointeam_failed loot_crate_opened loot_crate_visible match_end_conditions material_default_complete mb_input_lock_cancel mb_input_lock_success molotov_detonate nav_blocked nav_generate nextlevel_changed open_crate_instr other_death parachute_deploy parachute_pickup player_avenged_teammate player_become_ghost player_blind player_death player_decal player_falldamage player_footstep player_given_c4 player_hurt player_jump player_ping player_ping_stop player_radio player_reset_vote player_spawned player_stats_updated repost_xbox_achievements reset_player_controls round_end round_freeze_end round_mvp round_poststart round_prestart round_start seasoncoin_levelup sfuievent show_freezepanel show_survival_respawn_status silencer_detach silencer_off silencer_on smoke_beacon_paradrop smokegrenade_detonate smokegrenade_expired snowball_hit_player_face spec_mode_updated spec_target_updated start_halftime start_vote survival_no_respawns_final survival_no_respawns_warning survival_paradrop_break survival_paradrop_spawn survival_teammate_respawn switch_team tagrenade_detonate teamchange_pending teamplay_round_start tournament_reward tr_exit_hint_trigger tr_mark_best_time tr_mark_complete tr_player_flashbanged tr_show_exit_msgbox tr_show_finish_msgbox trial_time_expired update_matchmaking_stats vip_escaped vip_killed weapon_fire weapon_fire_on_empty weapon_outofammo weapon_reload weapon_zoom weapon_zoom_rifle write_profile_data

Source events51

achievement_event achievement_increment base_player_teleported bonus_updated break_breakable break_prop browse_replays cart_updated entered_performance_mode entity_killed flare_ignite_npc game_end game_init game_message game_newmap game_start gc_connected helicopter_grenade_punt_miss hltv_changed_mode hltv_changed_target inventory_updated item_schema_initialized physgun_pickup player_changename player_chat player_class player_death player_hintmessage player_hurt player_score player_shoot player_spawn player_team player_use ragdoll_dissolved replay_saved replay_youtube_stats round_end round_start store_pricesheet_updated team_info team_score teamplay_broadcast_audio user_data_downloaded vote_cast vote_changed vote_ended vote_failed vote_options vote_passed vote_started

Snippets11

Code Snippets Basic Input System GetPlayerInfo Material System Adapter Trampoline Hooking Library 2D rounded rectangle with an outline 2D rounded rectangle 3D rectangle with an outline Error Tracing OpenAI Davinci API Simple RGBA Conversion

Open the workshop ↗

Docs / API reference

GameSense reference

This is upstream API documentation. Soggy’s 2018 runtime may differ. Check compatibility notes and the runtime inventory before porting a script.

ui.menu_size

Returns the width, height of the menu, even when closed.

ui.menu_size(): number, number

Returns width: number, height: number

Reference adapted from GameSense Documentation, created by sapphyrus & nex and maintained by the Lua scripting community. Snapshot: 2026-11-04.
Sources & attribution

ON THIS PAGE

Search the docs

Type to search guides, functions and events.