# Table of Contents - [Starting Guide | API v2.0](#starting-guide-api-v2-0) - [Classes | API v2.0](#classes-api-v2-0) - [Color | API v2.0](#color-api-v2-0) - [Callbacks | API v2.0](#callbacks-api-v2-0) - [CFirstTab | API v2.0](#cfirsttab-api-v2-0) - [CTabSection | API v2.0](#ctabsection-api-v2-0) - [CSecondTab | API v2.0](#csecondtab-api-v2-0) - [Menu | API v2.0](#menu-api-v2-0) - [CThirdTab | API v2.0](#cthirdtab-api-v2-0) - [Math | API v2.0](#math-api-v2-0) - [Vertex | API v2.0](#vertex-api-v2-0) - [Widgets | API v2.0](#widgets-api-v2-0) - [Angle | API v2.0](#angle-api-v2-0) - [Abilities | API v2.0](#abilities-api-v2-0) - [Couriers | API v2.0](#couriers-api-v2-0) - [Entities | API v2.0](#entities-api-v2-0) - [Vec2 | API v2.0](#vec2-api-v2-0) - [Players | API v2.0](#players-api-v2-0) - [Physical Items | API v2.0](#physical-items-api-v2-0) - [CMenuSwitch | API v2.0](#cmenuswitch-api-v2-0) - [Runes | API v2.0](#runes-api-v2-0) - [Lists | API v2.0](#lists-api-v2-0) - [CMenuColorPickerAttachment | API v2.0](#cmenucolorpickerattachment-api-v2-0) - [CustomEntities | API v2.0](#customentities-api-v2-0) - [Camps | API v2.0](#camps-api-v2-0) - [Towers | API v2.0](#towers-api-v2-0) - [Networking & APIs | API v2.0](#networking-apis-api-v2-0) - [Rendering & Visuals | API v2.0](#rendering-visuals-api-v2-0) - [TempTrees | API v2.0](#temptrees-api-v2-0) - [CMenuButton | API v2.0](#cmenubutton-api-v2-0) - [Trees | API v2.0](#trees-api-v2-0) - [Panorama | API v2.0](#panorama-api-v2-0) - [Heroes | API v2.0](#heroes-api-v2-0) - [CMenuComboBox | API v2.0](#cmenucombobox-api-v2-0) - [Game Engine | API v2.0](#game-engine-api-v2-0) - [CMenuColorPicker | API v2.0](#cmenucolorpicker-api-v2-0) - [LinearProjectiles | API v2.0](#linearprojectiles-api-v2-0) - [Game Coordinator | API v2.0](#game-coordinator-api-v2-0) - [GlobalVars | API v2.0](#globalvars-api-v2-0) - [Chat | API v2.0](#chat-api-v2-0) - [Steam | API v2.0](#steam-api-v2-0) - [CMenuLabel | API v2.0](#cmenulabel-api-v2-0) - [CMenuSliderInt | API v2.0](#cmenusliderint-api-v2-0) - [Modifiers | API v2.0](#modifiers-api-v2-0) - [CMenuSliderFloat | API v2.0](#cmenusliderfloat-api-v2-0) - [HTTP | API v2.0](#http-api-v2-0) - [NPCs | API v2.0](#npcs-api-v2-0) - [NetChannel | API v2.0](#netchannel-api-v2-0) - [FogOfWar | API v2.0](#fogofwar-api-v2-0) - [World | API v2.0](#world-api-v2-0) - [CMenuInputBox | API v2.0](#cmenuinputbox-api-v2-0) - [Log | API v2.0](#log-api-v2-0) - [Rune | API v2.0](#rune-api-v2-0) - [Protobuf | API v2.0](#protobuf-api-v2-0) - [CMenuMultiSelect | API v2.0](#cmenumultiselect-api-v2-0) - [CMenuMultiComboBox | API v2.0](#cmenumulticombobox-api-v2-0) - [Configuration & Utilities | API v2.0](#configuration-utilities-api-v2-0) - [Core | API v2.0](#core-api-v2-0) - [Tree | API v2.0](#tree-api-v2-0) - [Event | API v2.0](#event-api-v2-0) - [Chronos | API v2.0](#chronos-api-v2-0) - [CMenuGroup | API v2.0](#cmenugroup-api-v2-0) - [CMenuGearAttachment | API v2.0](#cmenugearattachment-api-v2-0) - [Localizer | API v2.0](#localizer-api-v2-0) - [StringBuilder | API v2.0](#stringbuilder-api-v2-0) - [Logger | API v2.0](#logger-api-v2-0) - [Panorama | API v2.0](#panorama-api-v2-0) - [Humanizer | API v2.0](#humanizer-api-v2-0) - [GameLocalizer | API v2.0](#gamelocalizer-api-v2-0) - [Particle | API v2.0](#particle-api-v2-0) - [Bottle | API v2.0](#bottle-api-v2-0) - [Vambrace | API v2.0](#vambrace-api-v2-0) - [ConVar | API v2.0](#convar-api-v2-0) - [PowerTreads | API v2.0](#powertreads-api-v2-0) - [MiniMap | API v2.0](#minimap-api-v2-0) - [CMenuBind | API v2.0](#cmenubind-api-v2-0) - [TierToken | API v2.0](#tiertoken-api-v2-0) - [Tower | API v2.0](#tower-api-v2-0) - [DrunkenBrawler | API v2.0](#drunkenbrawler-api-v2-0) - [PhysicalItem | API v2.0](#physicalitem-api-v2-0) - [GridNav | API v2.0](#gridnav-api-v2-0) - [Config | API v2.0](#config-api-v2-0) - [Input | API v2.0](#input-api-v2-0) - [Camp | API v2.0](#camp-api-v2-0) - [GameRules | API v2.0](#gamerules-api-v2-0) - [Vector | API v2.0](#vector-api-v2-0) - [Courier | API v2.0](#courier-api-v2-0) - [Engine | API v2.0](#engine-api-v2-0) - [table | API v2.0](#table-api-v2-0) - [Hero | API v2.0](#hero-api-v2-0) - [Item | API v2.0](#item-api-v2-0) - [UIPanel | API v2.0](#uipanel-api-v2-0) --- # Starting Guide | API v2.0 To execute your script move the `.lua` file into the `%cheat_dir%/scripts` folder. * * * [hashtag](https://uczone.gitbook.io/api-v2.0#callbacks) Callbacks ---------------------------------------------------------------------- Most of your code will be executed inside the callbacks. To register the callback function, your script should return a table in the following format: Copy return { CallbackName = FuncHandler, } chevron-rightExample[hashtag](https://uczone.gitbook.io/api-v2.0#example) Copy -- much more convenient way for big scripts local script = {} function script.OnUpdate() print("OnUpdate") end return script or Copy return { OnUpdate = function() print("OnUpdate") end, } * * * [hashtag](https://uczone.gitbook.io/api-v2.0#example-scripts) Example Scripts ---------------------------------------------------------------------------------- There is example scripts you can rely on: chevron-rightDebug Script[hashtag](https://uczone.gitbook.io/api-v2.0#debug-script) Copy ---@diagnostic disable: undefined-global, param-type-mismatch, inject-field local debug = {} local tab = Menu.Create("General", "Debug", "Debug", "Debug") local inworld_group = tab:Create("In-World") local callbacks_group = tab:Create("Callbacks") local inworld_settings_group = tab:Create("In-World Settings", 1) local callbacks_settings_group = tab:Create("Callbacks Settings", 2) --#region UI local ui = {} ui.inworld = {} ui.inworld.global_switch = inworld_group:Switch("In-World Enabled", false) ui.inworld.name = inworld_group:Switch("Unit Name", false) ui.inworld.position = inworld_group:Switch("Unit Position", false) ui.inworld.modifier = inworld_group:Switch("Modifiers", false) ui.inworld.ability = inworld_group:Switch("Abilities", false) ui.inworld.item = inworld_group:Switch("Items", false) ui.inworld.modifier_state = inworld_group:Switch("Modifier State", false) ui.inworld.modifier_state_duration = inworld_group:Switch("Modifier State Duration", false) ui.inworld_settings = {} ui.inworld_settings.hero_only = inworld_settings_group:Switch("Only heroes", true) ui.inworld_settings.on_draw = inworld_settings_group:Switch("Render in OnDraw \a{primary}fps drop", false) ui.callbacks = {} ui.callbacks.modifier = callbacks_group:Switch("Modifier", false) ui.callbacks.animation = callbacks_group:Switch("Animation", false) ui.callbacks.add_entity = callbacks_group:Switch("Entity Create/Remove", false) ui.callbacks.projectile = callbacks_group:Switch("Projectile", false) ui.callbacks.particle = callbacks_group:Switch("Particle", false) ui.callbacks.gesture = callbacks_group:Switch("Gesture", false) ui.callbacks.sound = callbacks_group:Switch("Sound", false) ui.callbacks.order = callbacks_group:Switch("Unit Order", false) ui.callbacks_settings = {} ui.callbacks_settings.divider = callbacks_settings_group:Switch("Add 'divider' in the end of the log message", true) ui.callbacks_settings.add_more_info = callbacks_settings_group:Switch("More info. Starts with [m] prefix", true) --#endregion local font = Render.LoadFont("Arial", 0, 500) local function add_divider() if ui.callbacks_settings.divider:Get() then print("+---+---+---+---+---+---+---+") end end -- we can't modify the original table in callbacks, so we need to copy it to add more info function table.copy(t) local u = { } for k, v in pairs(t) do u[k] = v end return u end --#region Callbacks --#region Modifier function debug.OnModifierCreate(ent, mod) if not ui.callbacks.modifier:Get() then return end print("OnModifierCreate") local modifier_name = Modifier.GetName(mod) local owner = Ability.GetOwner(Modifier.GetAbility(mod)) local owner_name = NPC.GetUnitName(owner) print(("%s | %s -> %s"):format(modifier_name, owner_name, NPC.GetUnitName(ent))) add_divider() end function debug.OnModifierDestroy(ent, mod) if not ui.callbacks.modifier:Get() then return end print("OnModifierDestroy") local modifier_name = Modifier.GetName(mod) local owner = Ability.GetOwner(Modifier.GetAbility(mod)) local owner_name = NPC.GetUnitName(owner) print(("%s | %s -> %s"):format(modifier_name, owner_name, NPC.GetUnitName(ent))) add_divider() end --#endregion --#region Animation function debug.OnUnitAnimation(a) if not ui.callbacks.animation:Get() then return end print("OnUnitAnimation") if (ui.callbacks_settings.add_more_info:Get() and a.unit and Entity.IsNPC(a.unit)) then a = table.copy(a) local unit_name = NPC.GetUnitName(a.unit) a["[m]unit_name"] = unit_name end print(a) add_divider() end function debug.OnUnitAnimationEnd(a) if not ui.callbacks.animation:Get() then return end print("OnUnitAnimationEnd") if (ui.callbacks_settings.add_more_info:Get() and a.unit and Entity.IsNPC(a.unit)) then a = table.copy(a) local unit_name = NPC.GetUnitName(a.unit) a["[m]unit_name"] = unit_name end print(a) add_divider() end --#endregion --#region EntityCreate function debug.OnEntityCreate(entity) if not ui.callbacks.add_entity:Get() then return end print('OnEntityCreate') -- can't use NPC.GetUnitNameor Abilit.GetName because entity is not fully filled in the first tick local type = (function () if Entity.IsAbility(entity) then return "Ability" elseif Entity.IsNPC(entity) then return "NPC" elseif Entity.IsPlayer(entity) then return "Player" else return "Entity" end end)() print(("%s | %s | %d"):format(type, Entity.GetClassName(entity), Entity.GetIndex(entity))) add_divider() end function debug.OnEntityDestroy(entity) if not ui.callbacks.add_entity:Get() then return end print('OnEntityDestroy') local type = (function () if Entity.IsAbility(entity) then return "Ability" elseif Entity.IsNPC(entity) then return "NPC" elseif Entity.IsPlayer(entity) then return "Player" else return "Entity" end end)() print(("%s | %s | %d"):format(type, Entity.GetClassName(entity), Entity.GetIndex(entity))) add_divider() end --#endregion --#region Projectile function debug.OnProjectile(proj) -- range autoatacks, target abilities if not ui.callbacks.projectile:Get() then return end print("OnProjectile") if ui.callbacks_settings.add_more_info:Get() then proj = table.copy(proj) if (proj.source and Entity.IsNPC(proj.source)) then local unit_name = NPC.GetUnitName(proj.source) proj["[m]unit_name"] = unit_name end if (proj.target and Entity.IsNPC(proj.target)) then local unit_name = NPC.GetUnitName(proj.target) proj["[m]target_name"] = unit_name end end print(proj) add_divider() end function debug.OnLinearProjectileCreate(proj) -- mirana's arrow if not ui.callbacks.projectile:Get() then return end print("OnLinearProjectileCreate") if ui.callbacks_settings.add_more_info:Get() then proj = table.copy(proj) if (proj.source and Entity.IsNPC(proj.source)) then local unit_name = NPC.GetUnitName(proj.source) proj["[m]unit_name"] = unit_name end end print(proj) add_divider() end function debug.OnProjectileLoc(proj) if not ui.callbacks.projectile:Get() then return end -- tinker's rockets print("OnProjectileLoc") print(proj) add_divider() end --#endregion --#region Particle local particle_name_map = {} function debug.OnParticleCreate(prt) if not ui.callbacks.particle:Get() then return end print("OnParticleCreate") if ui.callbacks_settings.add_more_info:Get() then prt = table.copy(prt) if (prt.entity and Entity.IsNPC(prt.entity)) then local unit_name = NPC.GetUnitName(prt.entity) prt["[m]entity_name"] = unit_name end if (prt.entityForModifiers and Entity.IsNPC(prt.entityForModifiers)) then local unit_name = NPC.GetUnitName(prt.entityForModifiers) prt["[m]entityForModifiers_name"] = unit_name end particle_name_map[prt.index] = prt.name end print(prt) add_divider() end function debug.OnParticleUpdate(prt) if not ui.callbacks.particle:Get() then return end -- wisp's tentacles spam if (prt.controlPoint == 2 and prt.position == Vector(1.0, 1.0, 1.0)) then return end print("OnParticleUpdate") if ui.callbacks_settings.add_more_info:Get() then prt = table.copy(prt) if particle_name_map[prt.index] then prt["[m]name"] = particle_name_map[prt.index] end end print(prt) add_divider() end function debug.OnParticleUpdateEntity(prt) if not ui.callbacks.particle:Get() then return end print("OnParticleUpdateEntity") if ui.callbacks_settings.add_more_info:Get() then prt = table.copy(prt) if (prt.entity and Entity.IsNPC(prt.entity)) then local unit_name = NPC.GetUnitName(prt.entity) prt["[m]entity_name"] = unit_name end if particle_name_map[prt.index] then prt["[m]name"] = particle_name_map[prt.index] end end print(prt) add_divider() end function debug.OnParticleUpdateFallback(prt) if not ui.callbacks.particle:Get() then return end print("OnParticleUpdateFallback") if ui.callbacks_settings.add_more_info:Get() then prt = table.copy(prt) if particle_name_map[prt.index] then prt["[m]name"] = particle_name_map[prt.index] end end print(prt) add_divider() end function debug.OnParticleDestroy(prt) if not ui.callbacks.particle:Get() then return end print("OnParticleDestroy") if ui.callbacks_settings.add_more_info:Get() then prt = table.copy(prt) if particle_name_map[prt.index] then prt["[m]name"] = particle_name_map[prt.index] end end print(prt) add_divider() particle_name_map[prt.index] = nil end --#endregion --#region Gesture function debug.OnUnitAddGesture(a) if not ui.callbacks.gesture:Get() then return end print("OnUnitAddGesture") print(a) add_divider() end --#endregion --#region Sound function debug.OnStartSound(obj) if not ui.callbacks.sound:Get() then return end print("OnStartSound") if ui.callbacks_settings.add_more_info:Get() then obj = table.copy(obj) if (obj.source and Entity.IsNPC(obj.source)) then local unit_name = NPC.GetUnitName(obj.source) obj["[m]source_name"] = unit_name end end print(obj) add_divider() end --#endregion --#region Order local flipped_order_enum = {} for i, v in pairs(Enum.UnitOrder) do flipped_order_enum[v] = i end local flipped_issuer_enum = {} for i, v in pairs(Enum.PlayerOrderIssuer) do flipped_issuer_enum[v] = i end function debug.OnPrepareUnitOrders(order) if not ui.callbacks.order:Get() then return end print("OnPrepareUnitOrders") if ui.callbacks_settings.add_more_info:Get() then order = table.copy(order) if (order.npc and Entity.IsNPC(order.npc)) then local unit_name = NPC.GetUnitName(order.npc) order["[m]npc_name"] = unit_name end if (order.target and Entity.IsNPC(order.target)) then local unit_name = NPC.GetUnitName(order.target) order["[m]target_name"] = unit_name end if (order.ability and Entity.IsAbility(order.ability)) then local ability_name = Ability.GetName(order.ability) order["[m]ability_name"] = ability_name end if (order.order) then local order_name = flipped_order_enum[order.order] if order_name then order["[m]order_name"] = order_name end end end print(order) add_divider() end --#endregion --#endregion local text_color = Color(255, 255, 255, 255) local font_size = 14 local line_height = 18 local floor = math.floor local flipped_modstate_enum = {} for i, v in pairs(Enum.ModifierState) do flipped_modstate_enum[v] = i end local function inworld_processing() if not ui.inworld.global_switch:Get() then return end local render_names = ui.inworld.name:Get() local render_position = ui.inworld.position:Get() local render_modifiers = ui.inworld.modifier:Get() local render_abilities = ui.inworld.ability:Get() local render_items = ui.inworld.item:Get() local render_modifier_state = ui.inworld.modifier_state:Get() local render_modifier_state_duration = ui.inworld.modifier_state_duration:Get() local list = ui.inworld_settings.hero_only:Get() and Heroes.GetAll() or NPCs.GetAll() for i, unit in pairs(list) do if unit then local pos = Entity.GetAbsOrigin(unit) local screen_pos, is_visible = pos:ToScreen() if not is_visible then goto continue end if render_names then local text = ("%s | %s | %d"):format( Entity.GetClassName(unit), Entity.GetClassName(unit), Entity.GetIndex(unit) ) Render.Text(font, font_size, text, screen_pos, text_color) screen_pos = screen_pos + Vec2(0, line_height) end if render_position then local text = ("%d, %d, %d"):format( floor(pos.x), floor(pos.y), floor(pos.z) ) Render.Text(font, font_size, text, screen_pos, text_color) screen_pos = screen_pos + Vec2(0, line_height) end if render_modifiers then local modifiers = NPC.GetModifiers(unit) if modifiers then for _, mod in pairs(modifiers) do local text = Modifier.GetName(mod) Render.Text(font, font_size, text, screen_pos, text_color) screen_pos = screen_pos + Vec2(0, line_height) end end end if render_abilities then for i = 0, 25 do local ab = NPC.GetAbilityByIndex(unit, i) if ab then local text = ("%d: %s"):format(i, Ability.GetName(ab)) Render.Text(font, font_size, text, screen_pos, text_color) screen_pos = screen_pos + Vec2(0, line_height) end end end if render_items then for i = 0, 20 do local item = NPC.GetItemByIndex(unit, i) if item then local text = ("%d: %s"):format(i, Ability.GetName(item)) Render.Text(font, font_size, text, screen_pos, text_color) screen_pos = screen_pos + Vec2(0, line_height) end end end if render_modifier_state then for state_name, state_value in pairs(Enum.ModifierState) do local has_state = NPC.HasState(unit, state_value) if (has_state) then local text = state_name Render.Text(font, font_size, text, screen_pos, text_color) screen_pos = screen_pos + Vec2(0, line_height) end end end if render_modifier_state_duration then local payload = {} for i = 0, Enum.ModifierState.MODIFIER_STATE_LAST, 1 do payload[i] = true end local states = NPC.GetStatesDuration(unit, payload, false) for mod_state, duration in pairs(states) do if (duration > 0.0) then local name = flipped_modstate_enum[mod_state] if (name) then local text = ("%s: %.2f"):format(name, duration) Render.Text(font, font_size, text, screen_pos, text_color) screen_pos = screen_pos + Vec2(0, line_height) end end end end end ::continue:: end end function debug.OnDraw() if not ui.inworld_settings.on_draw:Get() then return end inworld_processing() end function debug.OnUpdate() if ui.inworld_settings.on_draw:Get() then return end inworld_processing() end return debug chevron-rightExample[hashtag](https://uczone.gitbook.io/api-v2.0#example-1) Copy local example = {} --#region UI local tab = Menu.Create("General", "Main", "Example") tab:Icon("\u{f6b6}") local group = tab:Create("Main"):Create("Group") local ui = {} ui.global_switch = group:Switch("Global Switch", false, "\u{f00c}") ui.auto_phase = group:Switch("Auto Phase Boots", true, "panorama/images/items/phase_boots_png.vtex_c") ui.custom_radius = group:Slider("Custom Radius", 0, 1000, 0, function (value) if value == 0 then return "Disabled" end return tostring(value) end) ui.custom_radius:Icon("\u{f1ce}") ui.radius_color = group:ColorPicker("Radius Color", Color(255, 255, 255), "\u{f53f}") ui.vbe_render = group:Switch("VBE Render", false, "\u{f06e}") ui.particle_notif = group:Switch("Particle Notification", false, "\u{f0f3}") ui.global_switch:SetCallback(function () ui.auto_phase:Disabled(not ui.global_switch:Get()) ui.custom_radius:Disabled(not ui.global_switch:Get()) ui.radius_color:Disabled(not ui.global_switch:Get()) ui.vbe_render:Disabled(not ui.global_switch:Get()) ui.particle_notif:Disabled(not ui.global_switch:Get()) end, true) --#endregion UI --#region Vars local my_hero = nil local particle = nil local need_update_particle = false local need_update_color = false ui.custom_radius:SetCallback(function () need_update_particle = true if ui.global_switch:Get() then ui.radius_color:Disabled(ui.custom_radius:Get() == 0) end end, true) ui.radius_color:SetCallback(function () need_update_color = true end) --#endregion Vars local auto_phase = function () if not ui.auto_phase:Get() then return end local item = NPC.GetItem(my_hero, "item_phase_boots") if not item then return end if not Ability.IsCastable(item, NPC.GetMana(my_hero)) then return end if not NPC.IsRunning(my_hero) then return end Ability.CastNoTarget(item) return true end local custom_radius = function () if ui.custom_radius:Get() == 0 or need_update_particle or not Entity.IsAlive(my_hero) then Particle.Destroy(particle) particle = nil need_update_particle = false return end if not particle then particle = Particle.Create("particles/ui_mouseactions/drag_selected_ring.vpcf", Enum.ParticleAttachment.PATTACH_ABSORIGIN_FOLLOW, my_hero) Particle.SetControlPoint(particle, 2, Vector(ui.custom_radius:Get(), 255, 255)) local color = ui.radius_color:Get() color = Vector(color.r, color.g, color.b) Particle.SetControlPoint(particle, 1, color) end if particle and need_update_color then local color = ui.radius_color:Get() color = Vector(color.r, color.g, color.b) Particle.SetControlPoint(particle, 1, color) end end local font = Render.LoadFont("MuseoSansEx", Enum.FontCreate.FONTFLAG_ANTIALIAS) local vbe_render = function () if not ui.vbe_render:Get() then return end local is_visible = NPC.IsVisibleToEnemies(my_hero) if not is_visible then return end local pos = Entity.GetAbsOrigin(my_hero) + Vector(0, 0, NPC.GetHealthBarOffset(my_hero)) local render_pos, pos_is_visible = Render.WorldToScreen(pos) if not pos_is_visible then return end local x, y = render_pos.x, render_pos.y - 80 local text = "Visible" local text_size = Render.TextSize(font, 30, text) x = x - text_size.x / 2 Render.Text(font, 30, text, Vec2(x + 1, y + 1), Color(0, 0, 0)) Render.Text(font, 30, text, Vec2(x, y), Color(255, 255, 255)) end --#region Callbacks example.OnParticleCreate = function (data) if not ui.global_switch:Get() or not ui.particle_notif:Get() then return end --[[ data:\ {\ "index": "4",\ "entity_id": "-1",\ "fullName": "particles/units/heroes/hero_crystalmaiden/maiden_crystal_nova.vpcf",\ "hash": "3519047136",\ "particleNameIndex": "-2119646217882970990",\ "name": "maiden_crystal_nova",\ "attachType": "2",\ "entityForModifiers": "",\ "entity_for_modifiers_id": "214"\ }\ ]] if data.entityForModifiers then local str = ''.." "..data.fullName Chat.Print("ConsoleChat", str) --chat Notification ({ --side duration = 3, timer = 3, hero = Entity.GetUnitName(data.entityForModifiers), -- primary_text = "Sunstrike", -- primary_image = "panorama/images/spellicons/invoker_sun_strike_png.vtex_c", --secondary_image = "panorama/images/spellicons/invoker/magus_apex/invoker_sun_strike_png.vtex_c", secondary_text = data.fullName, -- active = false, position = Entity.GetAbsOrigin(data.entityForModifiers), --sound = "sounds/ui/yoink" }) else Chat.Print("ConsoleChat", data.fullName) --chat Notification ({ --side duration = 3, timer = 3, --hero = Entity.GetUnitName(data.entityForModifiers), primary_text = "Particle Create", primary_image = "panorama/images/emoticons/dotakin_roshan_stars_png.vtex_c", secondary_image = "\u{2b}", secondary_text = data.fullName, -- active = false, --position = Entity.GetAbsOrigin(data.entityForModifiers), --sound = "sounds/ui/yoink" }) end end example.OnDraw = function () if not ui.global_switch:Get() or not my_hero then return end vbe_render() end example.OnUpdate = function () if not ui.global_switch:Get() then if particle then Particle.Destroy(particle) particle = nil end return end if not my_hero then my_hero = Heroes.GetLocal(); return end custom_radius() if auto_phase() then return end end --#endregion Callbacks return example * * * [hashtag](https://uczone.gitbook.io/api-v2.0#debugging) Debugging ---------------------------------------------------------------------- You can use `print` or `log` function to print messages to the console and `%cheat_dir%/debug.log` file. This is useful for debugging your scripts. circle-info This functions will automaticly stringify your tables chevron-rightExample[hashtag](https://uczone.gitbook.io/api-v2.0#example-2) Copy -- print all towers names and their positions for _, tower in pairs(Towers.GetAll()) do print(NPC.GetUnitName(tower), Entity.GetAbsOrigin(tower)) end [hashtag](https://uczone.gitbook.io/api-v2.0#useful-links) Useful Links ---------------------------------------------------------------------------- Here are some useful links: * [Lua 5.4 Manualarrow-up-right](https://www.lua.org/manual/5.4/) * [VS Code Umbrella Extentionarrow-up-right](https://marketplace.visualstudio.com/items?itemName=ILKA.umbrella-vscode) [NextCallbackschevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks) Last updated 1 year ago --- # Classes | API v2.0 [🎨Colorchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) [📋Menuchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu) [🧩Widgetschevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets) [🔢Mathchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math) [PreviousEnumschevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums) [NextColorchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Last updated 12 months ago --- # Color | API v2.0 Color metatable ### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#fields) Fields Name Type Description **r** `**number**` red **g** `**number**` green **b** `**number**` blue **a** `**number**` alpha [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#eq) \_\_eq ----------------------------------------------------------------------------------------------------- `:__eq(other):` `**boolean**` Name Type Description **other** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Compares two colors for equality. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#set) Set --------------------------------------------------------------------------------------------------- `:Set(r, g, b, [a]):` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Name Type Description **r** `**number**` **g** `**number**` **b** `**number**` **a** `**[?]**` `**number**` `(default: 255)` Sets r, g, b, a components. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#lerpinplace) LerpInPlace ------------------------------------------------------------------------------------------------------------------- `:LerpInPlace(other, t):` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Name Type Description **other** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) **t** `**number**` Linearly interpolates this color towards other in-place. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#iszero) IsZero --------------------------------------------------------------------------------------------------------- `:IsZero([tolerance]):` `**boolean**` Name Type Description **tolerance** `**[?]**` `**number**` `(default: 0.01)` Returns true if all components are near zero within tolerance. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#color) Color ------------------------------------------------------------------------------------------------------- `Color([r], [g], [b], [a]):` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Name Type Description **r** `**[?]**` `**number**` `(default: 255)` **g** `**[?]**` `**number**` `(default: 255)` **b** `**[?]**` `**number**` `(default: 255)` **a** `**[?]**` `**number**` `(default: 255)` Create a new Color. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#color-1) Color --------------------------------------------------------------------------------------------------------- `Color(hex):` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Name Type Description **hex** `**string**` Hex string. Do not use "#" symbol. Create a new Color from hex string. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#asfraction) AsFraction ----------------------------------------------------------------------------------------------------------------- `:AsFraction(r, g, b, a):` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Name Type Description **r** `**number**` New R color range as a percentage in the range \[0.0, 1.0\] **g** `**number**` New G color range as a percentage in the range \[0.0, 1.0\] **b** `**number**` New B color range as a percentage in the range \[0.0, 1.0\] **a** `**number**` New A color range as a percentage in the range \[0.0, 1.0\] Overwrites the color's ranges using the fraction values. Returns itself. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#asint) AsInt ------------------------------------------------------------------------------------------------------- `:AsInt(value):` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Name Type Description **value** `**number**` int color value Overwrites the color's ranges converting the int value to RGBA values. Returns itself. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#ashsv) AsHsv ------------------------------------------------------------------------------------------------------- `:AsHsv(h, s, v, a):` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Name Type Description **h** `**number**` Hue color range \[0.0, 1.0\] **s** `**number**` Saturation color range \[0.0, 1.0\] **v** `**number**` Value color range \[0.0, 1.0\] **a** `**number**` Alpha color range \[0.0, 1.0\] Overwrites the color's ranges converting the HSV to RGBA values. Returns itself. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#ashsl) AsHsl ------------------------------------------------------------------------------------------------------- `:AsHsl(h, s, l, a):` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Name Type Description **h** `**number**` Hue color range \[0.0, 1.0\] **s** `**number**` Saturation color range \[0.0, 1.0\] **l** `**number**` Lightness color range \[0.0, 1.0\] **a** `**number**` Alpha color range \[0.0, 1.0\] Overwrites the color's ranges converting the HSL to RGBA values. Returns itself. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#tofraction) ToFraction ----------------------------------------------------------------------------------------------------------------- `:ToFraction():` `**number**`, `**number**`, `**number**`, `**number**` Returns the r, g, b, and a ranges of the color as a percentage in the range of \[0.0, 1.0\]. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#toint) ToInt ------------------------------------------------------------------------------------------------------- `:ToInt():` `**number**` Returns the int value representing the color. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#tohsv) ToHsv ------------------------------------------------------------------------------------------------------- `:ToHsv():` `**number**`, `**number**`, `**number**` Returns the HSV representation of the color. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#tohsl) ToHsl ------------------------------------------------------------------------------------------------------- `:ToHsl():` `**number**`, `**number**`, `**number**` Returns the ToHsl representation of the color. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#tohex) ToHex ------------------------------------------------------------------------------------------------------- `:ToHex():` `**string**` Returns the hex string representing the color. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#lerp) Lerp ----------------------------------------------------------------------------------------------------- `:Lerp(other, weight):` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Name Type Description **other** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) The color to interpolate to **weight** `**number**` A value between 0 and 1 that indicates the weight of **other** Returns the linearly interpolated color between two colors by the specified weight. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#grayscale) Grayscale --------------------------------------------------------------------------------------------------------------- `:Grayscale(weight):` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Name Type Description **weight** `**number**` A value between 0 and 1 that indicates the weight of **grayscale** Returns the grayscaled color. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#alphamodulate) AlphaModulate ----------------------------------------------------------------------------------------------------------------------- `:AlphaModulate(alpha):` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Name Type Description **alpha** `**number**` Alpha color range \[0.0, 1.0\] Returns the alpha modulated color. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#clone) Clone ------------------------------------------------------------------------------------------------------- `:Clone():` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Creates and returns a copy of the color object. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#unpack) Unpack --------------------------------------------------------------------------------------------------------- `:Unpack():` `**number**`, `**number**`, `**number**`, `**number**` Returns the r, g, b, and a values of the color. Note that these fields can be accessed by indexing r, g, b, and a. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#tostring) \_\_tostring ----------------------------------------------------------------------------------------------------------------- `:__tostring():` `**string**` Returns hex string representing the color. [PreviousClasseschevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes) [NextMenuchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu) Last updated 1 month ago * [Fields](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#fields) * [\_\_eq](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#eq) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#set) * [LerpInPlace](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#lerpinplace) * [IsZero](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#iszero) * [Color](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#color) * [Color](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#color-1) * [AsFraction](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#asfraction) * [AsInt](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#asint) * [AsHsv](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#ashsv) * [AsHsl](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#ashsl) * [ToFraction](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#tofraction) * [ToInt](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#toint) * [ToHsv](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#tohsv) * [ToHsl](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#tohsl) * [ToHex](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#tohex) * [Lerp](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#lerp) * [Grayscale](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#grayscale) * [AlphaModulate](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#alphamodulate) * [Clone](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#clone) * [Unpack](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#unpack) * [\_\_tostring](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color#tostring) sun-brightdesktopmoon sun-brightdesktopmoon --- # Callbacks | API v2.0 Callbacks for lua Scripts should return a table with the following functions. If the table contains one of the functions below, it will be registered as a callback and will be called at the appropriate time. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onscriptsloaded) OnScriptsLoaded ----------------------------------------------------------------------------------------------------------------------- `Callbacks.OnScriptsLoaded():` `**nil**` Called after all scripts are loaded. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#ondraw) OnDraw ----------------------------------------------------------------------------------------------------- `Callbacks.OnDraw():` `**nil**` Called when the game is drawing. Works only in the game. Recommended to use for drawing only. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onframe) OnFrame ------------------------------------------------------------------------------------------------------- `Callbacks.OnFrame():` `**nil**` The same as OnDraw, but called in the menu too. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onupdate) OnUpdate --------------------------------------------------------------------------------------------------------- `Callbacks.OnUpdate():` `**nil**` Called every game update. Works only in the game. Recommended to use for logic. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onprehumanizer) OnPreHumanizer --------------------------------------------------------------------------------------------------------------------- `Callbacks.OnPreHumanizer():` `**nil**` TODO [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onupdateex) OnUpdateEx ------------------------------------------------------------------------------------------------------------- `Callbacks.OnUpdateEx():` `**nil**` Called every game update. Same as OnUpdate but as well called in the menu. Recommended to use for logic. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onentitycreate) OnEntityCreate --------------------------------------------------------------------------------------------------------------------- `Callbacks.OnEntityCreate(entity):` `**nil**` Name Type Description **entity** [`**CEntity**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) The entity that was created. Called when a new entity is created. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onnpcspawned) OnNpcSpawned ----------------------------------------------------------------------------------------------------------------- `Callbacks.OnNpcSpawned(npc):` `**nil**` Name Type Description **npc** `**CNpc**` The npc that was created. Called when a npc is spawned. Unlike OnAddEntity, the entity is fully initialized here. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onentitydestroy) OnEntityDestroy ----------------------------------------------------------------------------------------------------------------------- `Callbacks.OnEntityDestroy(entity):` `**nil**` Name Type Description **entity** [`**CEntity**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) The entity that was destroyed. Called when an entity is destroyed. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onmodifiercreate) OnModifierCreate ------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnModifierCreate(entity, modifier):` `**nil**` Name Type Description **entity** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The entity that has the modifier. **modifier** [`**CModifier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/modifier) The modifier that was created. Called when a modifier is created. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onmodifierdestroy) OnModifierDestroy --------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnModifierDestroy(entity, modifier):` `**nil**` Name Type Description **entity** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The entity that has the modifier. **modifier** [`**CModifier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/modifier) The modifier that was destroyed. Called when a modifier is destroyed. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onmodifierupdate) OnModifierUpdate ------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnModifierUpdate(entity, modifier):` `**nil**` Name Type Description **entity** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The entity that has the modifier. **modifier** [`**CModifier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/modifier) The modifier that was updated. Called when a modifier is updated/refreshed. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onentityhurt) OnEntityHurt ----------------------------------------------------------------------------------------------------------------- circle-info This callback is called only in unsafe mode. `Callbacks.OnEntityHurt(data):` `**nil**` Name Type Description **data** `**{source:CEntity**` | `**nil, target:CEntity**` | `**nil, ability:CAbility**` | `**nil, damage:number}**` The data about the event. Called when an entity is hurt. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onentitykilled) OnEntityKilled --------------------------------------------------------------------------------------------------------------------- circle-info This callback is called only in unsafe mode. `Callbacks.OnEntityKilled(data):` `**nil**` Name Type Description **data** `**{source:CEntity**` | `**nil, target:CEntity**` | `**nil, ability:CAbility**` | `**nil}**` The data about the event. Called when an entity is killed. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onfireeventclient) OnFireEventClient --------------------------------------------------------------------------------------------------------------------------- circle-info This callback is called only in unsafe mode. \`Callbacks.OnFireEventClient(data):\` \*\*\`nil\`\*\* Name Type Description **data** `**{name:string, event:Event}**` The data about the event. Called when a game event is fired. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onunitanimation) OnUnitAnimation ----------------------------------------------------------------------------------------------------------------------- `Callbacks.OnUnitAnimation(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**unit** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The unit that played the animation.  .**sequenceVariant** `**number**` The sequence variant.  .**playbackRate** `**number**` The playback rate.  .**castpoint** `**number**` The castpoint.  .**type** `**integer**` The type.  .**activity** `**integer**` The activity.  .**sequence** `**integer**` The sequence.  .**sequenceName** `**string**` The sequence name.  .**lag\_compensation\_time** `**number**` The lag compensation time. Called when a unit animation is played. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onunitanimationend) OnUnitAnimationEnd ----------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnUnitAnimationEnd(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**unit** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The unit that played the animation.  .**snap** `**boolean**` The snap. Called when a unit animation ends. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onprojectile) OnProjectile ----------------------------------------------------------------------------------------------------------------- `Callbacks.OnProjectile(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**source** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The source entity.  .**target** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The target entity.  .**ability** [`**CAbility**`](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) The ability linked to the projectile.  .**moveSpeed** `**integer**` The move speed.  .**sourceAttachment** `**integer**` The source attachment.  .**particleSystemHandle** `**integer**` The particle system handle.  .**dodgeable** `**boolean**` The dodgeable.  .**isAttack** `**boolean**` The is attack.  .**expireTime** `**number**` The expire time.  .**maxImpactTime** `**number**` The max impact time.  .**launch\_tick** `**integer**` The tick the pojectile was launched.  .**colorGemColor** `**integer**` The color gem color.  .**fullName** `**string**` The full name of projectile.  .**name** `**string**` The short name of projectile.  .**handle** `**integer**` The handle of projectile.  .**target\_loc** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) The location of the target.  .**original\_move\_speed** `**integer**` The original move speed. Called when new projectile is created. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onprojectileloc) OnProjectileLoc ----------------------------------------------------------------------------------------------------------------------- `Callbacks.OnProjectileLoc(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**target** `**[?]**` [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The source entity. `(default: nil)`  .**sourceLoc** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) The source location.  .**targetLoc** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) The target location.  .**moveSpeed** `**integer**` The move speed.  .**original\_move\_speed** `**integer**` The original move speed.  .**particleSystemHandle** `**integer**` The particle system handle.  .**dodgeable** `**boolean**` The dodgeable.  .**isAttack** `**boolean**` The is attack.  .**expireTime** `**number**` The expire time.  .**colorGemColor** `**integer**` The color gem color.  .**launchTick** `**integer**` The launch tick.  .**handle** `**integer**` The handle of projectile.  .**fullName** `**string**` The full name of projectile.  .**name** `**string**` The short name of projectile. Called when new projectile loc is created. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onlinearprojectilecreate) OnLinearProjectileCreate ----------------------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnLinearProjectileCreate(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**source** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The source entity.  .**origin** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) The origin.  .**velocity** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) The velocity.  .**particleIndex** `**integer**` The particle index.  .**handle** `**integer**` The handle of projectile.  .**acceleration** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) The acceleration.  .**maxSpeed** `**number**` The max speed.  .**fowRadius** `**number**` The fow radius.  .**distance** `**number**` The distance.  .**colorGemColor** `**integer**` The color gem color.  .**fullName** `**string**` The full name of projectile.  .**name** `**string**` The short name of projectile. Called when new linear projectile is created. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onlinearprojectiledestroy) OnLinearProjectileDestroy ------------------------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnLinearProjectileDestroy(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**handle** `**integer**` The handle of projectile. Called when linear projectile is destroyed. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onparticlecreate) OnParticleCreate ------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnParticleCreate(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**index** `**integer**` The index of particle.  .**entity** `**[?]**` [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The entity. `(default: nil)`  .**entity\_id** `**integer**` The entity id.  .**entityForModifiers** `**[?]**` [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The entity for modifiers. `(default: nil)`  .**entity\_for\_modifiers\_id** `**integer**` The entity for modifiers id.  .**attachType** [`**Enum.ParticleAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.particleattachment) The attach type.  .**fullName** `**string**` The full name of particle.  .**name** `**string**` The short name of particle.  .**hash** `**integer**` The hash of particle.  .**particleNameIndex** `**integer**` The particle name index. Called when new particle is created. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onparticleupdate) OnParticleUpdate ------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnParticleUpdate(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**index** `**integer**` The index of particle.  .**controlPoint** `**integer**` The control point.  .**position** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) The position. Called when particle is updated. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onparticleupdatefallback) OnParticleUpdateFallback ----------------------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnParticleUpdateFallback(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**index** `**integer**` The index of particle.  .**controlPoint** `**integer**` The control point.  .**position** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) The position. Called when particle is updated. Alternative version for some particles. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onparticleupdateentity) OnParticleUpdateEntity ------------------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnParticleUpdateEntity(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**index** `**integer**` The index of particle.  .**controlPoint** `**integer**` The control point.  .**entity** [`**CEntity**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) The entity.  .**entIdx** `**integer**` The entity id.  .**attachType** [`**Enum.ParticleAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.particleattachment) The attach type.  .**attachmentName** `**string**` The attachment name.  .**position** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) The position.  .**includeWearables** `**boolean**` Include wearables. Called when particle is updated on entity. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onparticledestroy) OnParticleDestroy --------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnParticleDestroy(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**index** `**integer**` The index of destroyed particle.  .**destroyImmediately** `**boolean**` Destroy immediately. Called when particle is destroyed. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onstartsound) OnStartSound ----------------------------------------------------------------------------------------------------------------- `Callbacks.OnStartSound(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**source** `**[?]**` [`**CEntity**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) The source of sound. `(default: nil)`  .**hash** `**integer**` The hash of sound.  .**guid** `**integer**` The guid of sound.  .**seed** `**integer**` The seed of sound.  .**name** `**string**` The name of sound.  .**position** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) The position of sound. Called when sound is started. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onspeak) OnSpeak ------------------------------------------------------------------------------------------------------- `Callbacks.OnSpeak(data):` `**boolean**` Name Type Description **data** `**table**` The data about the event.  .**source** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) | `**nil**` The unit who speak.  .**name** `**string**` The name of the sound. Called every time unit/announcer talk. You could return false to prevent the sound from being played. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onchatevent) OnChatEvent --------------------------------------------------------------------------------------------------------------- `Callbacks.OnChatEvent(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**type** `**integer**` The type of chat event.  .**value** `**integer**` The value of chat event.  .**value2** `**integer**` The value2 of chat event.  .**value3** `**integer**` The value3 of chat event.  .**playerid\_1** `**integer**` The playerid\_1 of chat event.  .**playerid\_2** `**integer**` The playerid\_2 of chat event.  .**playerid\_3** `**integer**` The playerid\_3 of chat event.  .**playerid\_4** `**integer**` The playerid\_4 of chat event.  .**playerid\_5** `**integer**` The playerid\_5 of chat event.  .**playerid\_6** `**integer**` The playerid\_6 of chat event. Called on chat event. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onoverheadevent) OnOverHeadEvent ----------------------------------------------------------------------------------------------------------------------- `Callbacks.OnOverHeadEvent(data):` `**nil**` Name Type Description **data** `**{player_source:CPlayer**` | `**nil, player_target:CPlayer**` | `**nil, target_npc:CNPC, value:integer}**` The table with the event info. Called on event above the hero's head. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onunitaddgesture) OnUnitAddGesture ------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnUnitAddGesture(data):` `**nil**` Name Type Description **data** `**table**` The data about the event.  .**npc** `**[?]**` [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The unit that is added to a gesture. `(default: nil)`  .**sequenceVariant** `**integer**` The sequence variant.  .**playbackRate** `**number**` The playback rate.  .**fadeIn** `**number**` The fade in.  .**fadeOut** `**number**` The fade out.  .**slot** `**integer**` The slot.  .**activity** `**integer**` The activity.  .**sequenceName** `**string**` The sequence name. Called when a unit is added to a gesture. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onprepareunitorders) OnPrepareUnitOrders ------------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnPrepareUnitOrders(data):` `**boolean**` Name Type Description **data** `**table**` The data about the event.  .**player** [`**CPlayer**`](https://uczone.gitbook.io/api-v2.0/game-components/core/player) The player that issued the order.  .**order** [`**Enum.UnitOrder**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.unitorder) The order type.  .**target** `**[?]**` [`**CEntity**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) The target of the order. `(default: nil)`  .**position** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) The position of the order.  .**ability** `**[?]**` [`**CAbility**`](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) The ability of the order. `(default: nil)`  .**orderIssuer** [`**Enum.PlayerOrderIssuer**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.playerorderissuer) The order issuer.  .**npc** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The unit of the order.  .**queue** `**boolean**` If the order is queued.  .**showEffects** `**boolean**` The show effects of the order. Called on every player order. Return false to prevent the order from being executed. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#ongcmessage) OnGCMessage --------------------------------------------------------------------------------------------------------------- `Callbacks.OnGCMessage(data):` `**boolean**` Name Type Description **data** `**table**`  .**msg\_type** `**number**` The message type.  .**size** `**number**` The size of the message.  .**binary\_buffer\_send** `**[?]**` `**userdata**` The binary buffer of the send message. `(default: nil)`  .**binary\_buffer\_recv** `**[?]**` `**userdata**` The binary buffer of the recieved message. `(default: nil)` Called when a game coordinator protobuff message is received. Return false to prevent the message from being sent (doesnt work with recieved messages). For more look at GC table description. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onsendnetmessage) OnSendNetMessage ------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnSendNetMessage(data):` `**boolean**` Name Type Description **data** `**table**` The data about the event.  .**message\_id** `**number**` The message id.  .**message\_name** `**string**` The message name.  .**buffer** `**lightuserdata**` The encoded buffer of the message.  .**size** `**number**` The size of the message. Called when a net message is sent. Return false to prevent the message from being sent. See example #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onpostreceivednetmessage) OnPostReceivedNetMessage ----------------------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnPostReceivedNetMessage(data):` `**boolean**` Name Type Description **data** `**table**` The data about the event.  .**message\_id** `**number**` The message id.  .**msg\_object** `**lightuserdata**` The encoded buffer of the message. Called when a net message is received. Return false to prevent the message from being recieved #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#ongameend) OnGameEnd ----------------------------------------------------------------------------------------------------------- `Callbacks.OnGameEnd():` `**nil**` Called on game end. Recommended to use for zeroing. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onkeyevent) OnKeyEvent ------------------------------------------------------------------------------------------------------------- `Callbacks.OnKeyEvent(data):` `**boolean**` Name Type Description **data** `**table**` The data about the event.  .**key** [`**Enum.ButtonCode**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.buttoncode) The key code.  .**event** [`**Enum.EKeyEvent**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.ekeyevent) Key event. Called on key and mouse input. Return false to prevent the event from being processed. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onunitinventoryupdated) OnUnitInventoryUpdated ------------------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnUnitInventoryUpdated(data):` `**nil**` Name Type Description **data** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The data about the event. Called on unit inventory updated. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onsetdormant) OnSetDormant ----------------------------------------------------------------------------------------------------------------- `Callbacks.OnSetDormant(npc, type):` `**nil**` Name Type Description **npc** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The target npc. **type** [`**Enum.DormancyType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.dormancytype) The type of change. Called on NPC dormancy state changed. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#ongamerulesstatechange) OnGameRulesStateChange ------------------------------------------------------------------------------------------------------------------------------------- `Callbacks.OnGameRulesStateChange(data):` `**nil**` Name Type Description **data** `**{}**` The table with new game state info. Called on gamestate change. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onnpcdying) OnNpcDying ------------------------------------------------------------------------------------------------------------- `Callbacks.OnNpcDying(npc):` `**nil**` Name Type Description **npc** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) The target npc. Called on NPC dying. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onthemeupdate) OnThemeUpdate ------------------------------------------------------------------------------------------------------------------- `Callbacks.OnThemeUpdate():` `**nil**` Called when the UI theme colors are changed. This includes animated theme transitions (called every frame during animation) and manual per-color edits via the theme color picker. [PreviousStarting Guidechevron-left](https://uczone.gitbook.io/api-v2.0) [NextEnumschevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums) Last updated 1 month ago * [OnScriptsLoaded](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onscriptsloaded) * [OnDraw](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#ondraw) * [OnFrame](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onframe) * [OnUpdate](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onupdate) * [OnPreHumanizer](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onprehumanizer) * [OnUpdateEx](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onupdateex) * [OnEntityCreate](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onentitycreate) * [OnNpcSpawned](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onnpcspawned) * [OnEntityDestroy](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onentitydestroy) * [OnModifierCreate](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onmodifiercreate) * [OnModifierDestroy](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onmodifierdestroy) * [OnModifierUpdate](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onmodifierupdate) * [OnEntityHurt](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onentityhurt) * [OnEntityKilled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onentitykilled) * [OnFireEventClient](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onfireeventclient) * [OnUnitAnimation](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onunitanimation) * [OnUnitAnimationEnd](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onunitanimationend) * [OnProjectile](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onprojectile) * [OnProjectileLoc](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onprojectileloc) * [OnLinearProjectileCreate](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onlinearprojectilecreate) * [OnLinearProjectileDestroy](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onlinearprojectiledestroy) * [OnParticleCreate](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onparticlecreate) * [OnParticleUpdate](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onparticleupdate) * [OnParticleUpdateFallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onparticleupdatefallback) * [OnParticleUpdateEntity](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onparticleupdateentity) * [OnParticleDestroy](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onparticledestroy) * [OnStartSound](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onstartsound) * [OnSpeak](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onspeak) * [OnChatEvent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onchatevent) * [OnOverHeadEvent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onoverheadevent) * [OnUnitAddGesture](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onunitaddgesture) * [OnPrepareUnitOrders](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onprepareunitorders) * [OnGCMessage](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#ongcmessage) * [OnSendNetMessage](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onsendnetmessage) * [OnPostReceivedNetMessage](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onpostreceivednetmessage) * [OnGameEnd](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#ongameend) * [OnKeyEvent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onkeyevent) * [OnUnitInventoryUpdated](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onunitinventoryupdated) * [OnSetDormant](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onsetdormant) * [OnGameRulesStateChange](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#ongamerulesstatechange) * [OnNpcDying](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onnpcdying) * [OnThemeUpdate](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks#onthemeupdate) sun-brightdesktopmoon Copy -- ongc_message.lua -- import protobuf and json libraries local protobuf = require('protobuf'); local JSON = require('assets.JSON'); -- do the stats request local request = protobuf.encodeFromJSON('CMsgDOTAMatchmakingStatsRequest', JSON:encode({})); GC.SendMessage( request.binary, 7197, request.size ); return { OnGCMessage = function(msg) if (msg.msg_type ~= 7198) then return true; end -- decode the response and print it local response = protobuf.decodeToJSON('CMsgDOTAMatchmakingStatsResponse', msg.binary_buffer_recv, msg.size); Log.Write(response); return true; end } Copy -- onsend_netmsg.lua -- anti-mute script for dota 2 -- redirects all chat messages to console command 'say' or 'say_team' -- import protobuf and json libraries local protobuf = require('protobuf'); local JSON = require('assets.JSON'); return { OnSendNetMessage = function(msg) if msg.message_id ~= 394 then return true; end -- decode protobuf message to json local json_message = JSON:decode(protobuf.decodeToJSON("CDOTAClientMsg_ChatMessage", msg.buffer , msg.size)); if not json_message then return true; end -- message CDOTAClientMsg_ChatMessage { -- optional uint32 channel_type = 1; -- optional string message_text = 2; -- } local text_message = json_message.message_text; -- skip commands starting with '-' if text_message:find("-") == 1 then return true; end -- 11 - all chat if (json_message.channel_type == 11) then Engine.ExecuteCommand('say "'..text_message..'"'); return false; -- 12 - team chat elseif (json_message.channel_type == 12) then Engine.ExecuteCommand('say_team "'..text_message..'"'); return false; end end } Copy -- onrecv_netmsg.lua local protobuf = require('protobuf') local JSON = require('assets.JSON') return { OnPostReceivedNetMessage = function(msg) if msg.message_id == 612 then -- DOTA_UM_ChatMessage https://github.com/SteamDatabase/GameTracking-Dota2/blob/932a8b002f651262ffda6562b758d8ca97c98297/Protobufs/dota_usermessages.proto#L152 local json = protobuf.decodeToJSONfromObject(msg.msg_object); Log.Write(json) local lua_table = JSON:decode(json) -- ... end end } sun-brightdesktopmoon --- # CFirstTab | API v2.0 CFirstTab metatable [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab#name) Name -------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns tab's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab#parent) Parent ------------------------------------------------------------------------------------------------------------------ `:Parent():` `**nil**` Returns parent. It's `nil` for CFirstTab. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab#type) Type -------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab#open) Open -------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab#create) Create ------------------------------------------------------------------------------------------------------------------ `:Create(sectionName):` [`**CTabSection**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection) Name Type Description **sectionName** `**string**` Creates new `CTabSection`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab#find) Find -------------------------------------------------------------------------------------------------------------- `:Find(sectionName):` [`**CTabSection**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection) | `**nil**` Name Type Description **sectionName** `**string**` Finds the `CTabSection` by name. [PreviousCTabSectionchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection) [NextCSecondTabchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab) Last updated 12 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab#open) * [Create](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab#create) * [Find](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab#find) sun-brightdesktopmoon sun-brightdesktopmoon --- # CTabSection | API v2.0 CTabSection metatable [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection#name) Name ---------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns tab's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection#parent) Parent -------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CFirstTab**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab) Returns tab's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection#type) Type ---------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection#open) Open ---------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection#create) Create -------------------------------------------------------------------------------------------------------------------- `:Create(sectionName):` [`**CSecondTab**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab) Name Type Description **sectionName** `**string**` Creates new `CSecondTab`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection#find) Find ---------------------------------------------------------------------------------------------------------------- `:Find(sectionName):` [`**CSecondTab**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab) | `**nil**` Name Type Description **sectionName** `**string**` Finds the `CSecondTab` by name. [PreviousMenuchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu) [NextCFirstTabchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab) Last updated 12 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection#open) * [Create](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection#create) * [Find](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection#find) sun-brightdesktopmoon sun-brightdesktopmoon --- # CSecondTab | API v2.0 CSecondTab metatable [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#name) Name --------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns tab's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#parent) Parent ------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CTabSection**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection) Returns tab's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#type) Type --------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#open) Open --------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#create) Create ------------------------------------------------------------------------------------------------------------------- `:Create(tabName):` [`**CThirdTab**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab) Name Type Description **tabName** `**string**` Creates new `CThirdTab`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#find) Find --------------------------------------------------------------------------------------------------------------- `:Find(tabName):` [`**CThirdTab**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab) | `**nil**` Name Type Description **tabName** `**string**` Finds the `CThirdTab` by name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#image) Image ----------------------------------------------------------------------------------------------------------------- `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#imagehandle) ImageHandle ----------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#icon) Icon --------------------------------------------------------------------------------------------------------------- `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets tab's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#linkhero) LinkHero ----------------------------------------------------------------------------------------------------------------------- `:LinkHero(heroId, attribute):` `**nil**` Name Type Description **heroId** `**integer**` See `Engine.GetHeroIDByName` **attribute** [`**Enum.Attributes**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.attributes) Links tab to hero and attribute. [PreviousCFirstTabchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cfirsttab) [NextCThirdTabchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab) Last updated 9 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#open) * [Create](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#create) * [Find](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#find) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#imagehandle) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#icon) * [LinkHero](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab#linkhero) sun-brightdesktopmoon Copy -- https://fontawesome.com/icons/user?f=classic&s=solid tab:Icon( "\u{f007}" ) sun-brightdesktopmoon --- # Menu | API v2.0 Table to work with Menu. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#find) Find ---------------------------------------------------------------------------------------------------- `Menu.Find(firstTabName, sectionName, secondTabName, thirdTabName, groupTabName, widgetName, attachmentName, widgetInGearName):` [`**CMenuSwitch**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch) | [`**CMenuBind**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind) | [`**CMenuSliderFloat**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat) | [`**CMenuSliderInt**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint) | [`**CMenuColorPicker**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker) | [`**CMenuComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox) | [`**CMenuButton**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton) | [`**CMenuMultiComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox) | [`**CMenuMultiSelect**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect) | [`**CMenuInputBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox) | [`**CMenuLabel**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel) | `**nil**` Name Type Description **firstTabName** `**string**` **sectionName** `**string**` **secondTabName** `**string**` **thirdTabName** `**string**` **groupTabName** `**string**` **widgetName** `**string**` **attachmentName** `**string**` **widgetInGearName** `**string**` Returns menu item. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#create) Create -------------------------------------------------------------------------------------------------------- `Menu.Create(firstTabName, sectionName, secondTabName, thirdTabName, groupTabName):` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) Name Type Description **firstTabName** `**string**` **sectionName** `**string**` **secondTabName** `**string**` **thirdTabName** `**string**` **groupTabName** `**string**` Creates tab/section/group. Returns menu item. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#style) Style ------------------------------------------------------------------------------------------------------ `Menu.Style(styleColor):` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Name Type Description **styleColor** `**string**` Creates tab/section/group. Returns color of specified style var or table of all style colors depends on param. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#opened) Opened -------------------------------------------------------------------------------------------------------- `Menu.Opened():` `**boolean**` Returns current menu open state. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#visualsisenabled) VisualsIsEnabled ---------------------------------------------------------------------------------------------------------------------------- `Menu.VisualsIsEnabled():` `**boolean**` Returns current visuals enabled state. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#alpha) Alpha ------------------------------------------------------------------------------------------------------ `Menu.Alpha():` `**number**` Returns current menu alpha. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#pos) Pos -------------------------------------------------------------------------------------------------- `Menu.Pos():` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Returns current menu pos. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#size) Size ---------------------------------------------------------------------------------------------------- `Menu.Size():` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Returns current menu size. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#scale) Scale ------------------------------------------------------------------------------------------------------ `Menu.Scale():` `**integer**` Returns current menu scale percentage. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#animduration) AnimDuration -------------------------------------------------------------------------------------------------------------------- `Menu.AnimDuration():` `**number**` Returns current menu animation duration. [PreviousColorchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) [NextCTabSectionchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/ctabsection) Last updated 6 months ago * [Find](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#find) * [Create](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#create) * [Style](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#style) * [Opened](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#opened) * [VisualsIsEnabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#visualsisenabled) * [Alpha](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#alpha) * [Pos](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#pos) * [Size](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#size) * [Scale](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#scale) * [AnimDuration](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu#animduration) sun-brightdesktopmoon sun-brightdesktopmoon --- # CThirdTab | API v2.0 CThirdTab metatable [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#name) Name -------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns tab's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#parent) Parent ------------------------------------------------------------------------------------------------------------------ `:Parent():` [`**CSecondTab**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab) Returns tab's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#type) Type -------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#open) Open -------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#create) Create ------------------------------------------------------------------------------------------------------------------ `:Create(groupName, [side]):` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) Name Type Description **groupName** `**string**` **side** `**[?]**` [`**Enum.GroupSide**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.groupside) `(default: Enum.GroupSide.Default)` Creates new `CMenuGroup`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#find) Find -------------------------------------------------------------------------------------------------------------- `:Find(groupName):` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | `**nil**` Name Type Description **groupName** `**string**` Finds the `CMenuGroup` by name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#image) Image ---------------------------------------------------------------------------------------------------------------- `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#imagehandle) ImageHandle ---------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#visible) Visible -------------------------------------------------------------------------------------------------------------------- `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets third tab's visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#visible-1) Visible ---------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#icon) Icon -------------------------------------------------------------------------------------------------------------- `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets tab's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#example-2) Example [PreviousCSecondTabchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/csecondtab) [NextCMenuGroupchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) Last updated 6 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#open) * [Create](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#create) * [Find](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#find) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#imagehandle) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#visible-1) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab#icon) sun-brightdesktopmoon Copy -- setter third_tab:Visible(false) Copy -- getter local isVisible = third_tab:Visible() Copy -- https://fontawesome.com/icons/user?f=classic&s=solid tab:Icon( "\u{f007}") sun-brightdesktopmoon --- # Math | API v2.0 [🌐Vectorchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) [🔄Anglechevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) [🔢Vec2chevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) [🔀Vertexchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex) [PreviousCMenuLabelchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel) [NextVectorchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # Vertex | API v2.0 Vertex metatable ### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex#fields) Fields Name Type Description **pos** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) screen pos **uv** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) texture uv [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex#vertex) Vertex --------------------------------------------------------------------------------------------------------------- `Vertex(pos, uv):` [`**Vertex**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex) Name Type Description **pos** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) **uv** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Create a new Vertex. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex#vertex-1) Vertex ----------------------------------------------------------------------------------------------------------------- `Vertex(posx, posy, uvx, uvy):` [`**Vertex**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex) Name Type Description **posx** `**number**` **posy** `**number**` **uvx** `**number**` **uvy** `**number**` Create a new Vertex(0,0). [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex#tostring) \_\_tostring ----------------------------------------------------------------------------------------------------------------------- `:__tostring():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex#add) \_\_add ------------------------------------------------------------------------------------------------------------- circle-info Overload for operator + `:__add(other):` [`**Vertex**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex) Name Type Description **other** [`**Vertex**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex) | `**number**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex#sub) \_\_sub ------------------------------------------------------------------------------------------------------------- circle-info Overload for operator - \`:\_\_sub(other):\` \[\*\*\`Vertex\`\*\*\](Vertex.md) Name Type Description **other** [`**Vertex**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex) | `**number**` [PreviousVec2chevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) [NextListschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists) Last updated 12 months ago * [Fields](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex#fields) * [Vertex](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex#vertex) * [Vertex](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex#vertex-1) * [\_\_tostring](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex#tostring) * [\_\_add](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex#add) * [\_\_sub](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex#sub) sun-brightdesktopmoon sun-brightdesktopmoon --- # Widgets | API v2.0 [CMenuSwitchchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch) [CMenuSliderFloatchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat) [CMenuSliderIntchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint) [CMenuButtonchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton) [CMenuColorPickerchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker) [CMenuColorPickerAttachmentchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment) [CMenuComboBoxchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox) [CMenuGearAttachmentchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) [CMenuInputBoxchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox) [CMenuMultiComboBoxchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox) [CMenuMultiSelectchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect) [CMenuBindchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind) [CMenuLabelchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel) [PreviousCMenuGroupchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) [NextCMenuSwitchchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # Angle | API v2.0 Angle metatable ### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#fields) Fields Name Type Description **pitch** `**number**` **yaw** `**number**` **roll** `**number**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#eq) \_\_eq ---------------------------------------------------------------------------------------------------------- `:__eq(other):` `**boolean**` Name Type Description **other** [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Compares two angles for equality. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#add) \_\_add ------------------------------------------------------------------------------------------------------------ `:__add(other):` [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Name Type Description **other** [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Adds two angles together. Returns a new Angle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#sub) \_\_sub ------------------------------------------------------------------------------------------------------------ `:__sub(other):` [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Name Type Description **other** [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Subtracts one angle from another. Returns a new Angle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#set) Set -------------------------------------------------------------------------------------------------------- `:Set(pitch, yaw, roll):` [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Name Type Description **pitch** `**number**` **yaw** `**number**` **roll** `**number**` Sets pitch, yaw, roll. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#copyfrom) CopyFrom ------------------------------------------------------------------------------------------------------------------ `:CopyFrom(other):` [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Name Type Description **other** [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Copies values from another angle without allocating. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#clone) Clone ------------------------------------------------------------------------------------------------------------ `:Clone():` [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Creates a new angle with the same values as the original. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#get) Get -------------------------------------------------------------------------------------------------------- `:Get():` `**number**`, `**number**`, `**number**` Returns pitch, yaw, roll as three numbers. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#iszero) IsZero -------------------------------------------------------------------------------------------------------------- `:IsZero([tolerance]):` `**boolean**` Name Type Description **tolerance** `**[?]**` `**number**` `(default: 0.01)` Returns true if all components are near zero within tolerance. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#angle) Angle ------------------------------------------------------------------------------------------------------------ `Angle([pitch], [yaw], [roll]):` [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Name Type Description **pitch** `**[?]**` `**number**` `(default: 0.0)` **yaw** `**[?]**` `**number**` `(default: 0.0)` **roll** `**[?]**` `**number**` `(default: 0.0)` Create a new Angle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#tostring) \_\_tostring ---------------------------------------------------------------------------------------------------------------------- `:__tostring():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#getforward) GetForward ---------------------------------------------------------------------------------------------------------------------- `:GetForward():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Returns the forward vector from a given Angle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#getvectors) GetVectors ---------------------------------------------------------------------------------------------------------------------- `:GetVectors():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) , [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) , [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Returns the forward, right and up. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#getyaw) GetYaw -------------------------------------------------------------------------------------------------------------- `:GetYaw():` `**number**` Returns the yaw. The same as Angle.yaw. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#getroll) GetRoll ---------------------------------------------------------------------------------------------------------------- `:GetRoll():` `**number**` Returns the roll. The same as Angle.roll. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#getpitch) GetPitch ------------------------------------------------------------------------------------------------------------------ `:GetPitch():` `**number**` Returns the pitch. The same as Angle.pitch. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#setyaw) SetYaw -------------------------------------------------------------------------------------------------------------- `:SetYaw(value):` `**nil**` Name Type Description **value** `**number**` Sets the yaw. The same as Angle.yaw = value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#setroll) SetRoll ---------------------------------------------------------------------------------------------------------------- `:SetRoll(value):` `**nil**` Name Type Description **value** `**number**` Sets the roll. The same as Angle.roll = value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#setpitch) SetPitch ------------------------------------------------------------------------------------------------------------------ `:SetPitch(value):` `**nil**` Name Type Description **value** `**number**` Sets the pitch. The same as Angle.pitch = value. [PreviousVectorchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) [NextVec2chevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Last updated 27 days ago * [Fields](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#fields) * [\_\_eq](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#eq) * [\_\_add](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#add) * [\_\_sub](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#sub) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#set) * [CopyFrom](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#copyfrom) * [Clone](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#clone) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#get) * [IsZero](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#iszero) * [Angle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#angle) * [\_\_tostring](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#tostring) * [GetForward](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#getforward) * [GetVectors](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#getvectors) * [GetYaw](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#getyaw) * [GetRoll](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#getroll) * [GetPitch](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#getpitch) * [SetYaw](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#setyaw) * [SetRoll](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#setroll) * [SetPitch](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle#setpitch) sun-brightdesktopmoon sun-brightdesktopmoon --- # Abilities | API v2.0 Table to work with ability list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/abilities#count) Count ---------------------------------------------------------------------------------------------- `Abilities.Count():` `**integer**` Return size of ability list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/abilities#get) Get ------------------------------------------------------------------------------------------ `Abilities.Get(index):` [`**CAbility**`](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) | `**nil**` Name Type Description **index** `**integer**` Index of ability in cheat list. Return ability by index in cheat list. Not the same as in-game index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/abilities#getall) GetAll ------------------------------------------------------------------------------------------------ `Abilities.GetAll():` [`**CAbility[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) Return all abilities in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/abilities#contains) Contains ---------------------------------------------------------------------------------------------------- `Abilities.Contains(ability):` `**boolean**` Name Type Description **ability** [`**CAbility**`](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) Ability to check. Check ability in cheat list. [PreviousListschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists) [NextCourierschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers) Last updated 12 months ago * [Count](https://uczone.gitbook.io/api-v2.0/game-components/lists/abilities#count) * [Get](https://uczone.gitbook.io/api-v2.0/game-components/lists/abilities#get) * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/abilities#getall) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/abilities#contains) sun-brightdesktopmoon sun-brightdesktopmoon --- # Couriers | API v2.0 Table to work with courier list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers#count) Count --------------------------------------------------------------------------------------------- `Couriers.Count():` `**integer**` Return size of courier list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers#get) Get ----------------------------------------------------------------------------------------- `Couriers.Get(index):` [`**CCourier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/courier) | `**nil**` Name Type Description **index** `**integer**` Index of courier in cheat list. Return courier by index in cheat list. Not the same as in-game index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers#getall) GetAll ----------------------------------------------------------------------------------------------- `Couriers.GetAll():` [`**CCourier[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/courier) Return all couriers in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers#contains) Contains --------------------------------------------------------------------------------------------------- `Couriers.Contains(courier):` `**boolean**` Name Type Description **courier** [`**CCourier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/courier) Courier to check. Check courier in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers#getlocal) GetLocal --------------------------------------------------------------------------------------------------- `Couriers.GetLocal():` [`**CCourier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/courier) | `**nil**` Return local courier. [PreviousAbilitieschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/abilities) [NextCustomEntitieschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities) Last updated 12 months ago * [Count](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers#count) * [Get](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers#get) * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers#getall) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers#contains) * [GetLocal](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers#getlocal) sun-brightdesktopmoon sun-brightdesktopmoon --- # Entities | API v2.0 Table to work with entity list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/entities#getall) GetAll ----------------------------------------------------------------------------------------------- `Entities.GetAll():` [`**CEntity[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) Get all entities on the map. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/entities#contains) Contains --------------------------------------------------------------------------------------------------- `Entities.Contains(entity):` `**boolean**` Name Type Description **entity** [`**CEntity**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) Entity to check. Check entity in cheat list. [PreviousCustomEntitieschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities) [NextHeroeschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes) Last updated 12 months ago * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/entities#getall) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/entities#contains) sun-brightdesktopmoon sun-brightdesktopmoon --- # Vec2 | API v2.0 Vec2 metatable ### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#fields) Fields Name Type Description **x** `**number**` **y** `**number**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#addinplace) AddInPlace --------------------------------------------------------------------------------------------------------------------- `:AddInPlace(other):` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Name Type Description **other** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) | `**number**` Adds other to this Vec2 in-place. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#subinplace) SubInPlace --------------------------------------------------------------------------------------------------------------------- `:SubInPlace(other):` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Name Type Description **other** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) | `**number**` Subtracts other from this Vec2 in-place. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#mulinplace) MulInPlace --------------------------------------------------------------------------------------------------------------------- `:MulInPlace(other):` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Name Type Description **other** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) | `**number**` Multiplies this Vec2 by other in-place. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#divinplace) DivInPlace --------------------------------------------------------------------------------------------------------------------- `:DivInPlace(other):` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Name Type Description **other** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) | `**number**` Divides this Vec2 by other in-place. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#copyfrom) CopyFrom ----------------------------------------------------------------------------------------------------------------- `:CopyFrom(other):` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Name Type Description **other** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Copies values from another Vec2 without allocating. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#clone) Clone ----------------------------------------------------------------------------------------------------------- `:Clone():` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Creates a new Vec2 with the same values as the original. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#set) Set ------------------------------------------------------------------------------------------------------- `:Set(x, y):` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Name Type Description **x** `**number**` **y** `**number**` Sets x, y components. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#iszero) IsZero ------------------------------------------------------------------------------------------------------------- `:IsZero([tolerance]):` `**boolean**` Name Type Description **tolerance** `**[?]**` `**number**` `(default: 0.01)` Returns true if all components are near zero within tolerance. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#vec2) Vec2 --------------------------------------------------------------------------------------------------------- `Vec2(x, y):` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Name Type Description **x** `**number**` **y** `**number**` Create a new Vec2. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#vec2-1) Vec2 ----------------------------------------------------------------------------------------------------------- `Vec2():` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Create a new Vec2(0,0). [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#tostring) \_\_tostring --------------------------------------------------------------------------------------------------------------------- `:__tostring():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#add) \_\_add ----------------------------------------------------------------------------------------------------------- circle-info Overload for operator + `:__add(other):` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Name Type Description **other** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) | `**number**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#sub) \_\_sub ----------------------------------------------------------------------------------------------------------- circle-info Overload for operator - `:__sub(other):` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Name Type Description **other** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) | `**number**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#div) \_\_div ----------------------------------------------------------------------------------------------------------- circle-info Overload for operator / `:__div(other):` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Name Type Description **other** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) | `**number**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#mul) \_\_mul ----------------------------------------------------------------------------------------------------------- circle-info Overload for operator \* `:__mul(other):` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Name Type Description **other** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) | `**number**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#eq) \_\_eq --------------------------------------------------------------------------------------------------------- circle-info Overload for operator == \`:\_\_eq(other):\` \*\*\`boolean\`\*\* Name Type Description **other** [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#length) Length ------------------------------------------------------------------------------------------------------------- `:Length():` `**number**` Returns the length of the vector. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#get) Get ------------------------------------------------------------------------------------------------------- `:Get():` `**number**`, `**number**` Returns x, y of this vector. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#getx) GetX --------------------------------------------------------------------------------------------------------- `:GetX():` `**number**` Returns x of this vector. The same as Vec2.x. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#gety) GetY --------------------------------------------------------------------------------------------------------- `:GetY():` `**number**` Returns y of this vector. The same as Vec2.y. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#setx) SetX --------------------------------------------------------------------------------------------------------- `:SetX(value):` `**nil**` Name Type Description **value** `**number**` Sets x. The same as Vec2.x = value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#sety) SetY --------------------------------------------------------------------------------------------------------- `:SetY(value):` `**nil**` Name Type Description **value** `**number**` Sets y. The same as Vec2.y = value. [PreviousAnglechevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) [NextVertexchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex) Last updated 25 days ago * [Fields](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#fields) * [AddInPlace](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#addinplace) * [SubInPlace](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#subinplace) * [MulInPlace](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#mulinplace) * [DivInPlace](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#divinplace) * [CopyFrom](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#copyfrom) * [Clone](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#clone) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#set) * [IsZero](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#iszero) * [Vec2](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#vec2) * [Vec2](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#vec2-1) * [\_\_tostring](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#tostring) * [\_\_add](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#add) * [\_\_sub](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#sub) * [\_\_div](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#div) * [\_\_mul](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#mul) * [\_\_eq](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#eq) * [Length](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#length) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#get) * [GetX](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#getx) * [GetY](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#gety) * [SetX](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#setx) * [SetY](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2#sety) sun-brightdesktopmoon sun-brightdesktopmoon --- # Players | API v2.0 Table to work with player list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/players#count) Count -------------------------------------------------------------------------------------------- `Players.Count():` `**integer**` Return size of player list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/players#get) Get ---------------------------------------------------------------------------------------- `Players.Get(index):` [`**CPlayer**`](https://uczone.gitbook.io/api-v2.0/game-components/core/player) | `**nil**` Name Type Description **index** `**integer**` Index of player in cheat list. Return player by index in cheat list. Not the same as in-game index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/players#getall) GetAll ---------------------------------------------------------------------------------------------- `Players.GetAll():` [`**CPlayer[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/player) Return all players in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/players#contains) Contains -------------------------------------------------------------------------------------------------- `Players.Contains(player):` `**boolean**` Name Type Description **player** [`**CPlayer**`](https://uczone.gitbook.io/api-v2.0/game-components/core/player) Player to check. Check player in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/players#getlocal) GetLocal -------------------------------------------------------------------------------------------------- `Players.GetLocal():` [`**CPlayer**`](https://uczone.gitbook.io/api-v2.0/game-components/core/player) Return local player. [PreviousCampschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps) [NextRuneschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/runes) Last updated 12 months ago * [Count](https://uczone.gitbook.io/api-v2.0/game-components/lists/players#count) * [Get](https://uczone.gitbook.io/api-v2.0/game-components/lists/players#get) * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/players#getall) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/players#contains) * [GetLocal](https://uczone.gitbook.io/api-v2.0/game-components/lists/players#getlocal) sun-brightdesktopmoon sun-brightdesktopmoon --- # Physical Items | API v2.0 Table to work with list of phisical items. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/physicalitems#count) Count -------------------------------------------------------------------------------------------------- `PhysicalItems.Count():` `**integer**` Return size of physical item list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/physicalitems#get) Get ---------------------------------------------------------------------------------------------- `PhysicalItems.Get(index):` [`**CPhysicalItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/physicalitem) | `**nil**` Name Type Description **index** `**integer**` Index of physical item in cheat list. Return physical item by index in cheat list. Not the same as in-game index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/physicalitems#getall) GetAll ---------------------------------------------------------------------------------------------------- `PhysicalItems.GetAll():` [`**CPhysicalItem[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/physicalitem) Return all physical items in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/physicalitems#contains) Contains -------------------------------------------------------------------------------------------------------- `PhysicalItems.Contains(physical):` `**boolean**` Name Type Description **physical** [`**CPhysicalItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/physicalitem) item Physical item to check. Check physical item in cheat list. [PreviousTreeschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees) [NextModifierschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/modifiers) Last updated 12 months ago * [Count](https://uczone.gitbook.io/api-v2.0/game-components/lists/physicalitems#count) * [Get](https://uczone.gitbook.io/api-v2.0/game-components/lists/physicalitems#get) * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/physicalitems#getall) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/physicalitems#contains) sun-brightdesktopmoon sun-brightdesktopmoon --- # CMenuSwitch | API v2.0 CMenuSwitch metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#name) Name ------------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#parent) Parent ----------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#type) Type ------------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#open) Open ------------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#forcelocalization) ForceLocalization --------------------------------------------------------------------------------------------------------------------------------------------- circle-info Not recommended for use due to its complexity `:ForceLocalization(newText):` `**nil**` Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#tooltip) ToolTip ------------------------------------------------------------------------------------------------------------------------- `:ToolTip(newText):` `**string**` Name Type Description **newText** `**string**` Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#tooltip-1) ToolTip --------------------------------------------------------------------------------------------------------------------------- `:ToolTip():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#visible) Visible ------------------------------------------------------------------------------------------------------------------------- `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#visible-1) Visible --------------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#disabled) Disabled --------------------------------------------------------------------------------------------------------------------------- `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#disabled-1) Disabled ----------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#unsafe) Unsafe ----------------------------------------------------------------------------------------------------------------------- `:Unsafe(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets unsafe state. Unsafe widgets have warning sign. Depends on argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#unsafe-1) Unsafe ------------------------------------------------------------------------------------------------------------------------- `:Unsafe():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#get) Get ----------------------------------------------------------------------------------------------------------------- `:Get():` `**boolean**` Returns widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#set) Set ----------------------------------------------------------------------------------------------------------------- `:Set(value):` `**nil**` Name Type Description **value** `**boolean**` Sets widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#image) Image --------------------------------------------------------------------------------------------------------------------- `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets widget's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#imagehandle) ImageHandle --------------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#icon) Icon ------------------------------------------------------------------------------------------------------------------- `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets widget's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#setcallback) SetCallback --------------------------------------------------------------------------------------------------------------------------------- circle-info Multiple callbacks could be set. \`:SetCallback(callback, \[forceCall\]):\` \*\*\`nil\`\*\* Name Type Description **callback** `**fun(this: CMenuSwitch):nil**` function to be called on widget change. **forceCall** `**[?]**` `**boolean**` true if you want to call callback on widget creation. `(default: false)` Sets widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#unsetcallback) UnsetCallback ------------------------------------------------------------------------------------------------------------------------------------- `:UnsetCallback(callback):` `**nil**` Name Type Description **callback** `**fun(this: CMenuSwitch):nil**` function to be removed from widget's callbacks. Removes widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#colorpicker) ColorPicker --------------------------------------------------------------------------------------------------------------------------------- `:ColorPicker(name, color):` [`**CMenuColorPickerAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment) Name Type Description **name** `**string**` Name of the attachment. **color** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Default color. Creates `CMenuColorPickerAttachment` and attaches it to the widget. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#gear) Gear ------------------------------------------------------------------------------------------------------------------- `:Gear(name, [gearIcon], [useSmallFont]):` [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Name Type Description **name** `**string**` Name of the attachment. **gearIcon** `**[?]**` `**string**` Gear FontAwesome icon. `(default: "\uf013")` **useSmallFont** `**[?]**` `**boolean**` Use small font for gear icon. `(default: true)` Creates `CMenuGearAttachment` and attaches it to the widget. [PreviousWidgetschevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets) [NextCMenuSliderFloatchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat) Last updated 9 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#forcelocalization) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#tooltip) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#tooltip-1) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#disabled-1) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#unsafe) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#unsafe-1) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#get) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#set) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#imagehandle) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#icon) * [SetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#setcallback) * [UnsetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#unsetcallback) * [ColorPicker](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#colorpicker) * [Gear](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch#gear) sun-brightdesktopmoon Copy -- setter switch:Visible(false) Copy -- getter local isVisible = switch:Visible() Copy -- setter switch:Disabled( false ) Copy -- getter local isDisabled = switch:Disabled() Copy --https://fontawesome.com/icons/user?f=classic&s=solid switch:Icon("\u{f007}") sun-brightdesktopmoon --- # Runes | API v2.0 Table to work with rune list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/runes#count) Count ------------------------------------------------------------------------------------------ `Runes.Count():` `**integer**` Return size of rune list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/runes#get) Get -------------------------------------------------------------------------------------- `Runes.Get(index):` [`**CRune**`](https://uczone.gitbook.io/api-v2.0/game-components/core/rune) | `**nil**` Name Type Description **index** `**integer**` Index of rune in cheat list. Return rune by index in cheat list. Not the same as in-game index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/runes#getall) GetAll -------------------------------------------------------------------------------------------- `Runes.GetAll():` [`**CRune[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/rune) Return all runes in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/runes#contains) Contains ------------------------------------------------------------------------------------------------ `Runes.Contains(rune):` `**boolean**` Name Type Description **rune** [`**CRune**`](https://uczone.gitbook.io/api-v2.0/game-components/core/rune) Rune to check. Check rune in cheat list. [PreviousPlayerschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/players) [NextTempTreeschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees) Last updated 12 months ago * [Count](https://uczone.gitbook.io/api-v2.0/game-components/lists/runes#count) * [Get](https://uczone.gitbook.io/api-v2.0/game-components/lists/runes#get) * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/runes#getall) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/runes#contains) sun-brightdesktopmoon sun-brightdesktopmoon --- # Lists | API v2.0 [🔮Abilitieschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/abilities) [🚚Courierschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers) [🛠️CustomEntitieschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities) [👾Entitieschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/entities) [🦸Heroeschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes) [🎭NPCschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs) [🐉Campschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps) [👥Playerschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/players) [🔮Runeschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/runes) [🌳TempTreeschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees) [🏰Towerschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers) [🌲Treeschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees) [🎁Physical Itemschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/physicalitems) [✨Modifierschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/modifiers) [🚀LinearProjectileschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/linearprojectiles) [PreviousVertexchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vertex) [NextAbilitieschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/abilities) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # CMenuColorPickerAttachment | API v2.0 CMenuColorPickerAttachment metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#name) Name ---------------------------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#parent) Parent -------------------------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CMenuSwitch**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch) | [`**CMenuSliderInt**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint) | [`**CMenuSliderFloat**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat) | [`**CMenuMultiComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox) | [`**CMenuLabel**`arrow-up-right](https://github.com/Boyarinov/gitbook-doc-parser/blob/main/generated/menu/CMenuLabel.md) | [`**CMenuInputBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox) | [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | [`**CMenuBind**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#type) Type ---------------------------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#open) Open ---------------------------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#forcelocalization) ForceLocalization ------------------------------------------------------------------------------------------------------------------------------------------------------------ circle-info Not recommended for use due to its complexity `:ForceLocalization(newText):` `**nil**` Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#visible) Visible ---------------------------------------------------------------------------------------------------------------------------------------- `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#visible-1) Visible ------------------------------------------------------------------------------------------------------------------------------------------ `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#disabled) Disabled ------------------------------------------------------------------------------------------------------------------------------------------ `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#disabled-1) Disabled -------------------------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#get) Get -------------------------------------------------------------------------------------------------------------------------------- `:Get():` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Returns widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#set) Set -------------------------------------------------------------------------------------------------------------------------------- `:Set(value):` `**nil**` Name Type Description **value** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Sets widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#setcallback) SetCallback ------------------------------------------------------------------------------------------------------------------------------------------------ circle-info Multiple callbacks could be set. \`:SetCallback(callback, \[forceCall\]):\` \*\*\`nil\`\*\* Name Type Description **callback** `**fun(this: CMenuColorPickerAttachment):nil**` function to be called on widget change. **forceCall** `**[?]**` `**boolean**` true if you want to call callback on widget creation. `(default: false)` Sets widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#unsetcallback) UnsetCallback ---------------------------------------------------------------------------------------------------------------------------------------------------- `:UnsetCallback(callback):` `**nil**` Name Type Description **callback** `**fun(this: CMenuColorPickerAttachment):nil**` function to be removed from widget's callbacks. Removes widget's on change callback. [PreviousCMenuColorPickerchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker) [NextCMenuComboBoxchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox) Last updated 12 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#forcelocalization) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#disabled-1) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#get) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#set) * [SetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#setcallback) * [UnsetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment#unsetcallback) sun-brightdesktopmoon Copy -- setter widget:Visible(false) Copy -- getter local isVisible = widget:Visible() Copy -- setter widget:Disabled( false ) Copy -- getter local isDisabled = widget:Disabled() sun-brightdesktopmoon --- # CustomEntities | API v2.0 Table to work with specific abilities. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities#getspiritbear) GetSpiritBear ------------------------------------------------------------------------------------------------------------------- `CustomEntities.GetSpiritBear(spiritBear):` [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) | `**nil**` Name Type Description **spiritBear** [`**CAbility**`](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) The Spirit Bear ability. Accept the Spirit Bear ability and return linked Bear. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities#getvengeillusion) GetVengeIllusion ------------------------------------------------------------------------------------------------------------------------- `CustomEntities.GetVengeIllusion(commandAura):` [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) | `**nil**` Name Type Description **commandAura** [`**CAbility**`](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) The Command Aura ability. Accept the Vengeful Spirit's Command Aura ability and return scepter linked illusion. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities#gettetheredunit) GetTetheredUnit ----------------------------------------------------------------------------------------------------------------------- `CustomEntities.GetTetheredUnit(tether):` [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) | `**nil**` Name Type Description **tether** [`**CAbility**`](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) The Tether ability. Accept the Wisp's Tether ability and return linked unit. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities#gettempestdouble) GetTempestDouble ------------------------------------------------------------------------------------------------------------------------- `CustomEntities.GetTempestDouble(tempestDouble):` [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) | `**nil**` Name Type Description **tempestDouble** [`**CAbility**`](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) The Tempest Double ability. Accept the Arc Warden's Tempest Double ability and return linked clone. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities#getmeepoindex) GetMeepoIndex ------------------------------------------------------------------------------------------------------------------- `CustomEntities.GetMeepoIndex(dividedWeStand):` `**integer**` | `**nil**` Name Type Description **dividedWeStand** [`**CAbility**`](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) The Divided We Stand ability. Accept the Meepo's Divided We Stand ability and return index of Meepo. [PreviousCourierschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/couriers) [NextEntitieschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/entities) Last updated 1 year ago * [GetSpiritBear](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities#getspiritbear) * [GetVengeIllusion](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities#getvengeillusion) * [GetTetheredUnit](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities#gettetheredunit) * [GetTempestDouble](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities#gettempestdouble) * [GetMeepoIndex](https://uczone.gitbook.io/api-v2.0/game-components/lists/customentities#getmeepoindex) sun-brightdesktopmoon sun-brightdesktopmoon --- # Camps | API v2.0 Table to work with list of neutral spawners. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps#count) Count ------------------------------------------------------------------------------------------ `Camps.Count():` `**integer**` Return size of neutral spawner list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps#get) Get -------------------------------------------------------------------------------------- `Camps.Get(index):` [`**CCamp**`](https://uczone.gitbook.io/api-v2.0/game-components/core/camp) | `**nil**` Name Type Description **index** `**integer**` Index of neutral spawner in cheat list. Return neutral spawner by index in cheat list. Not the same as in-game index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps#getall) GetAll -------------------------------------------------------------------------------------------- `Camps.GetAll():` [`**CCamp[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/camp) Return all neutral spawners in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps#inradius) InRadius ------------------------------------------------------------------------------------------------ `Camps.InRadius(pos, radius):` [`**CCamp[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/camp) Name Type Description **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Position to check. **radius** `**number**` Radius to check. Return all neutral spawners in radius. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps#contains) Contains ------------------------------------------------------------------------------------------------ `Camps.Contains(camp):` `**boolean**` Name Type Description **camp** [`**CCamp**`](https://uczone.gitbook.io/api-v2.0/game-components/core/camp) Neutral spawner to check. Check neutral spawner in cheat list. [PreviousNPCschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs) [NextPlayerschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/players) Last updated 12 months ago * [Count](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps#count) * [Get](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps#get) * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps#getall) * [InRadius](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps#inradius) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps#contains) sun-brightdesktopmoon sun-brightdesktopmoon --- # Towers | API v2.0 Table to work with tower list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers#count) Count ------------------------------------------------------------------------------------------- `Towers.Count():` `**integer**` Return size of tower list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers#get) Get --------------------------------------------------------------------------------------- `Towers.Get(index):` [`**CTower**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tower) | `**nil**` Name Type Description **index** `**integer**` Index of tower in cheat list. Return tower by index in cheat list. Not the same as in-game index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers#getall) GetAll --------------------------------------------------------------------------------------------- `Towers.GetAll():` [`**CTower[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tower) Return all towers in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers#inradius) InRadius ------------------------------------------------------------------------------------------------- `Towers.InRadius(pos, radius, teamNum, [teamType]):` [`**CTower[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tower) Name Type Description **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Position to check. **radius** `**number**` Radius to check. **teamNum** [`**Enum.TeamNum**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.teamnum) Team number to check. **teamType** `**[?]**` [`**Enum.TeamType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.teamtype) Team number to check. `(default: Enum.TeamType.TEAM_ENEMY)` Return all towers in radius. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers#contains) Contains ------------------------------------------------------------------------------------------------- `Towers.Contains(tower):` `**boolean**` Name Type Description **tower** [`**CTower**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tower) Tower to check. Check tower in cheat list. [PreviousTempTreeschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees) [NextTreeschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees) Last updated 12 months ago * [Count](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers#count) * [Get](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers#get) * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers#getall) * [InRadius](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers#inradius) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers#contains) sun-brightdesktopmoon sun-brightdesktopmoon --- # Networking & APIs | API v2.0 [💬Chatchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi) [🌐HTTPchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/http) [🚂Steamchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi) [📡NetChannelchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/netchannel) [🌐Game Coordinatorchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/gc) [📨Protobufchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf) [PreviousConVarchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar) [NextChatchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # Rendering & Visuals | API v2.0 [✨Particlechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle) [🖌️Rendererchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/renderv1) [🎨Renderchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/renderv2) [🗺️MiniMapchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap) [🖼️Panoramachevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama) [PreviousProtobufchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf) [NextParticlechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # TempTrees | API v2.0 Table to work with list of temp trees. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees#count) Count ---------------------------------------------------------------------------------------------- `TempTrees.Count():` `**integer**` Return size of temp trees list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees#get) Get ------------------------------------------------------------------------------------------ `TempTrees.Get(index):` [`**CTree**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tree) | `**nil**` Name Type Description **index** `**integer**` Index of temp tree in cheat list. Return temp tree by index in cheat list. Not the same as in-game index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees#getall) GetAll ------------------------------------------------------------------------------------------------ `TempTrees.GetAll():` [`**CTree[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tree) Return all temp trees in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees#inradius) InRadius ---------------------------------------------------------------------------------------------------- `TempTrees.InRadius(pos, radius):` [`**CTree[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tree) Name Type Description **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Position to check. **radius** `**number**` Radius to check. Return all temp trees in radius. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees#contains) Contains ---------------------------------------------------------------------------------------------------- `TempTrees.Contains(tree):` `**boolean**` Name Type Description **tree** [`**CTree**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tree) Temp tree to check. Check temp tree in cheat list. [PreviousRuneschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/runes) [NextTowerschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers) Last updated 12 months ago * [Count](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees#count) * [Get](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees#get) * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees#getall) * [InRadius](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees#inradius) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/temptrees#contains) sun-brightdesktopmoon sun-brightdesktopmoon --- # CMenuButton | API v2.0 CMenuButton metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#name) Name ------------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#parent) Parent ----------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#type) Type ------------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#open) Open ------------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#forcelocalization) ForceLocalization --------------------------------------------------------------------------------------------------------------------------------------------- circle-info Not recommended for use due to its complexity `:ForceLocalization(newText):` `**nil**` Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#tooltip) ToolTip ------------------------------------------------------------------------------------------------------------------------- `:ToolTip(newText):` `**string**` Name Type Description **newText** `**string**` Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#tooltip-1) ToolTip --------------------------------------------------------------------------------------------------------------------------- `:ToolTip():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#visible) Visible ------------------------------------------------------------------------------------------------------------------------- `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#visible-1) Visible --------------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#disabled) Disabled --------------------------------------------------------------------------------------------------------------------------- `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#disabled-1) Disabled ----------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#unsafe) Unsafe ----------------------------------------------------------------------------------------------------------------------- `:Unsafe(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets unsafe state. Unsafe widgets have warning sign. Depends on argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#unsafe-1) Unsafe ------------------------------------------------------------------------------------------------------------------------- `:Unsafe():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#image) Image --------------------------------------------------------------------------------------------------------------------- `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets widget's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#imagehandle) ImageHandle --------------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#icon) Icon ------------------------------------------------------------------------------------------------------------------- `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets widget's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#setcallback) SetCallback --------------------------------------------------------------------------------------------------------------------------------- circle-info Multiple callbacks could be set. \`:SetCallback(callback, \[forceCall\]):\` \*\*\`nil\`\*\* Name Type Description **callback** `**fun(this: CMenuButton):nil**` function to be called on widget change. **forceCall** `**[?]**` `**boolean**` true if you want to call callback on widget creation. `(default: false)` Sets widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#unsetcallback) UnsetCallback ------------------------------------------------------------------------------------------------------------------------------------- `:UnsetCallback(callback):` `**nil**` Name Type Description **callback** `**fun(this: CMenuButton):nil**` function to be removed from widget's callbacks. Removes widget's on change callback. [PreviousCMenuSliderIntchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint) [NextCMenuColorPickerchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker) Last updated 9 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#forcelocalization) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#tooltip) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#tooltip-1) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#disabled-1) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#unsafe) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#unsafe-1) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#imagehandle) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#icon) * [SetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#setcallback) * [UnsetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton#unsetcallback) sun-brightdesktopmoon Copy -- setter widget:Visible(false) Copy -- getter local isVisible = widget:Visible() Copy -- setter widget:Disabled( false ) Copy -- getter local isDisabled = widget:Disabled() Copy --https://fontawesome.com/icons/user?f=classic&s=solid widget:Icon("\u{f007}") sun-brightdesktopmoon --- # Trees | API v2.0 Table to work with list of trees. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees#count) Count ------------------------------------------------------------------------------------------ `Trees.Count():` `**integer**` Return size of tree list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees#get) Get -------------------------------------------------------------------------------------- `Trees.Get(index):` [`**CTree**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tree) | `**nil**` Name Type Description **index** `**integer**` Index of tree in cheat list. Return tree by index in cheat list. Not the same as in-game index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees#getall) GetAll -------------------------------------------------------------------------------------------- `Trees.GetAll():` [`**CTree[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tree) Return all trees in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees#inradius) InRadius ------------------------------------------------------------------------------------------------ `Trees.InRadius(pos, radius, [active]):` [`**CTree[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tree) Name Type Description **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Position to check. **radius** `**number**` Radius to check. **active** `**[?]**` `**boolean**` Active state to check. `(default: true)` Return all trees in radius. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees#contains) Contains ------------------------------------------------------------------------------------------------ `Trees.Contains(tree):` `**boolean**` Name Type Description **tree** [`**CTree**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tree) Tree to check. Check tree in cheat list. [PreviousTowerschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/towers) [NextPhysical Itemschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/physicalitems) Last updated 12 months ago * [Count](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees#count) * [Get](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees#get) * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees#getall) * [InRadius](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees#inradius) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/trees#contains) sun-brightdesktopmoon sun-brightdesktopmoon --- # Panorama | API v2.0 [🖼️Panoramachevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama) [🖼️UIPanelchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) [PreviousMiniMapchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap) [NextPanoramachevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # Heroes | API v2.0 Table to work with hero list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes#count) Count ------------------------------------------------------------------------------------------- `Heroes.Count():` `**integer**` Return size of hero list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes#get) Get --------------------------------------------------------------------------------------- `Heroes.Get(index):` [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) | `**nil**` Name Type Description **index** `**integer**` Index of hero in cheat list. Return hero by index in cheat list. Not the same as in-game index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes#getall) GetAll --------------------------------------------------------------------------------------------- `Heroes.GetAll():` [`**CHero[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Return all heroes in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes#contains) Contains ------------------------------------------------------------------------------------------------- `Heroes.Contains(hero):` `**boolean**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Hero to check. Check hero in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes#inradius) InRadius ------------------------------------------------------------------------------------------------- `Heroes.InRadius(pos, radius, teamNum, teamType, [omitIllusions], [omitDormant]):` [`**CHero[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Name Type Description **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Position to check. **radius** `**number**` Radius to check. **teamNum** [`**Enum.TeamNum**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.teamnum) Team number to check. **teamType** [`**Enum.TeamType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.teamtype) Team type to filter by. Relative to teamNum param. **omitIllusions** `**[?]**` `**boolean**` `true` if you want to get table without illusions `(default: false)` **omitDormant** `**[?]**` `**boolean**` `true` if you want to get table without dormant units `(default: true)` Return all heroes in radius. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes#getlocal) GetLocal ------------------------------------------------------------------------------------------------- `Heroes.GetLocal():` [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Return local hero. [PreviousEntitieschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/entities) [NextNPCschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs) Last updated 28 days ago * [Count](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes#count) * [Get](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes#get) * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes#getall) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes#contains) * [InRadius](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes#inradius) * [GetLocal](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes#getlocal) sun-brightdesktopmoon sun-brightdesktopmoon --- # CMenuComboBox | API v2.0 CMenuComboBox metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#name) Name --------------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#update) Update ------------------------------------------------------------------------------------------------------------------------- `:Update(items, [defaultValue]):` `**nil**` Name Type Description **items** `**string[]**` **defaultValue** `**[?]**` `**integer**` Index of default item. (starts from 0) `(default: 0)` Update the combo box values. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#parent) Parent ------------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#type) Type --------------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#open) Open --------------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#forcelocalization) ForceLocalization ----------------------------------------------------------------------------------------------------------------------------------------------- circle-info Not recommended for use due to its complexity `:ForceLocalization(newText):` `**nil**` Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#tooltip) ToolTip --------------------------------------------------------------------------------------------------------------------------- `:ToolTip(newText):` `**string**` Name Type Description **newText** `**string**` Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#tooltip-1) ToolTip ----------------------------------------------------------------------------------------------------------------------------- `:ToolTip():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#visible) Visible --------------------------------------------------------------------------------------------------------------------------- `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#visible-1) Visible ----------------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#disabled) Disabled ----------------------------------------------------------------------------------------------------------------------------- `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#disabled-1) Disabled ------------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#unsafe) Unsafe ------------------------------------------------------------------------------------------------------------------------- `:Unsafe(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets unsafe state. Unsafe widgets have warning sign. Depends on argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#unsafe-1) Unsafe --------------------------------------------------------------------------------------------------------------------------- `:Unsafe():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#get) Get ------------------------------------------------------------------------------------------------------------------- `:Get():` `**integer**` Returns index of the selected item. It starts from 0. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#set) Set ------------------------------------------------------------------------------------------------------------------- `:Set(value):` `**nil**` Name Type Description **value** `**integer**` Sets widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#list) List --------------------------------------------------------------------------------------------------------------------- `:List():` `**string[]**` Returns array of the items. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#image) Image ----------------------------------------------------------------------------------------------------------------------- `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets widget's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#imagehandle) ImageHandle ----------------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#icon) Icon --------------------------------------------------------------------------------------------------------------------- `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets widget's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#setcallback) SetCallback ----------------------------------------------------------------------------------------------------------------------------------- circle-info Multiple callbacks could be set. \`:SetCallback(callback, \[forceCall\]):\` \*\*\`nil\`\*\* Name Type Description **callback** `**fun(this: CMenuComboBox):nil**` function to be called on widget change. **forceCall** `**[?]**` `**boolean**` true if you want to call callback on widget creation. `(default: false)` Sets widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#unsetcallback) UnsetCallback --------------------------------------------------------------------------------------------------------------------------------------- `:UnsetCallback(callback):` `**nil**` Name Type Description **callback** `**fun(this: CMenuComboBox):nil**` function to be removed from widget's callbacks. Removes widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#colorpicker) ColorPicker ----------------------------------------------------------------------------------------------------------------------------------- `:ColorPicker(name, color):` [`**CMenuColorPickerAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment) Name Type Description **name** `**string**` Name of the attachment. **color** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Default color. Creates `CMenuColorPickerAttachment` and attaches it to the widget. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#gear) Gear --------------------------------------------------------------------------------------------------------------------- `:Gear(name, [gearIcon], [useSmallFont]):` [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Name Type Description **name** `**string**` Name of the attachment. **gearIcon** `**[?]**` `**string**` Gear FontAwesome icon. `(default: "\uf013")` **useSmallFont** `**[?]**` `**boolean**` Use small font for gear icon. `(default: true)` Creates `CMenuGearAttachment` and attaches it to the widget. [PreviousCMenuColorPickerAttachmentchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment) [NextCMenuGearAttachmentchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Last updated 9 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#name) * [Update](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#update) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#forcelocalization) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#tooltip) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#tooltip-1) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#disabled-1) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#unsafe) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#unsafe-1) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#get) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#set) * [List](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#list) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#imagehandle) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#icon) * [SetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#setcallback) * [UnsetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#unsetcallback) * [ColorPicker](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#colorpicker) * [Gear](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox#gear) sun-brightdesktopmoon Copy -- setter widget:Visible(false) Copy -- getter local isVisible = widget:Visible() Copy -- setter widget:Disabled( false ) Copy -- getter local isDisabled = widget:Disabled() Copy --https://fontawesome.com/icons/user?f=classic&s=solid widget:Icon("\u{f007}") sun-brightdesktopmoon --- # Game Engine | API v2.0 [🔧Enginechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine) [🎉Eventchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event) [📜GameRuleschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules) [🌍GlobalVarschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars) [🧭GridNavchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav) [🎮Inputchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input) [🌍Worldchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/world) [🌫️FogOfWarchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/fogofwar) [⚙️ConVarchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar) [PreviousTierTokenchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/tiertoken) [NextEnginechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # CMenuColorPicker | API v2.0 CMenuColorPicker metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#name) Name ------------------------------------------------------------------------------------------------------------------------ `:Name():` `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#parent) Parent ---------------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#type) Type ------------------------------------------------------------------------------------------------------------------------ `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#open) Open ------------------------------------------------------------------------------------------------------------------------ `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#forcelocalization) ForceLocalization -------------------------------------------------------------------------------------------------------------------------------------------------- circle-info Not recommended for use due to its complexity `:ForceLocalization(newText):` `**nil**` Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#tooltip) ToolTip ------------------------------------------------------------------------------------------------------------------------------ `:ToolTip(newText):` `**string**` Name Type Description **newText** `**string**` Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#tooltip-1) ToolTip -------------------------------------------------------------------------------------------------------------------------------- `:ToolTip():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#visible) Visible ------------------------------------------------------------------------------------------------------------------------------ `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#visible-1) Visible -------------------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#disabled) Disabled -------------------------------------------------------------------------------------------------------------------------------- `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#disabled-1) Disabled ---------------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#unsafe) Unsafe ---------------------------------------------------------------------------------------------------------------------------- `:Unsafe(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets unsafe state. Unsafe widgets have warning sign. Depends on argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#unsafe-1) Unsafe ------------------------------------------------------------------------------------------------------------------------------ `:Unsafe():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#get) Get ---------------------------------------------------------------------------------------------------------------------- `:Get():` [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Returns widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#set) Set ---------------------------------------------------------------------------------------------------------------------- `:Set(value):` `**nil**` Name Type Description **value** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Sets widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#image) Image -------------------------------------------------------------------------------------------------------------------------- `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets widget's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#imagehandle) ImageHandle -------------------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#icon) Icon ------------------------------------------------------------------------------------------------------------------------ `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets widget's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#imagehandle-1) ImageHandle ---------------------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#setcallback) SetCallback -------------------------------------------------------------------------------------------------------------------------------------- circle-info Multiple callbacks could be set. \`:SetCallback(callback, \[forceCall\]):\` \*\*\`nil\`\*\* Name Type Description **callback** `**fun(this: CMenuColorPicker):nil**` function to be called on widget change. **forceCall** `**[?]**` `**boolean**` true if you want to call callback on widget creation. `(default: false)` Sets widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#unsetcallback) UnsetCallback ------------------------------------------------------------------------------------------------------------------------------------------ `:UnsetCallback(callback):` `**nil**` Name Type Description **callback** `**fun(this: CMenuColorPicker):nil**` function to be removed from widget's callbacks. Removes widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#hidealphabar) HideAlphaBar ---------------------------------------------------------------------------------------------------------------------------------------- `:HideAlphaBar(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets alpha bar state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#example-5) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#hidealphabar-1) HideAlphaBar ------------------------------------------------------------------------------------------------------------------------------------------ `:HideAlphaBar():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#example-6) Example [PreviousCMenuButtonchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton) [NextCMenuColorPickerAttachmentchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment) Last updated 9 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#forcelocalization) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#tooltip) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#tooltip-1) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#disabled-1) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#unsafe) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#unsafe-1) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#get) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#set) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#imagehandle) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#icon) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#imagehandle-1) * [SetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#setcallback) * [UnsetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#unsetcallback) * [HideAlphaBar](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#hidealphabar) * [HideAlphaBar](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker#hidealphabar-1) sun-brightdesktopmoon Copy -- setter widget:Visible(false) Copy -- getter local isVisible = widget:Visible() Copy -- setter widget:Disabled( false ) Copy -- getter local isDisabled = widget:Disabled() Copy --https://fontawesome.com/icons/user?f=classic&s=solid widget:Icon("\u{f007}") Copy -- setter widget:HideAlphaBar( true ) Copy -- getter local isAlphaBarHidden = widget:HideAlphaBar() sun-brightdesktopmoon --- # LinearProjectiles | API v2.0 Table to work linear projectiles. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/linearprojectiles#getall) GetAll -------------------------------------------------------------------------------------------------------- `LinearProjectiles.GetAll():` `**{handle: integer, max_speed: number, max_dist: number, start_position: Vector, position: Vector, velocity: Vector, original_velocity: Vector, acceleration: Vector, fow_radius: number, source: CEntity}[]**` Returns the 1-based indexed table with all existing projectiles. See example. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/linearprojectiles#example) Example Copy -- linearprojectiles_getall.lua return { OnUpdate = function () local linears = LinearProjectiles.GetAll(); if (not linears) then return end; for i, projectile in pairs(linears) do Log.Write("+++++++++++++++++++++++") Log.Write(projectile['max_dist']); Log.Write(projectile['handle']); Log.Write(projectile['position']); Log.Write(projectile['velocity']); Log.Write(projectile['start_position']); Log.Write(projectile['max_speed']); Log.Write("+++++++++++++++++++++++") end end } [PreviousModifierschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/modifiers) [NextCorechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # Game Coordinator | API v2.0 Table to work with Game Coordinator (GC). Possible message types and message bodies could be found at [herearrow-up-right](https://github.com/SteamDatabase/GameTracking-Dota2/blob/master/Protobufs) Message type id starts with `k_E` prefix, for example `k_EMsgGCMatchmakingStatsRequest = 7197;`. Message body starts with with `C` prefix instead of "k\_E", for example `message CMsgDOTAMatchmakingStatsRequest {}`. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/gc#sendmessage) SendMessage ----------------------------------------------------------------------------------------------------------------- `GC.SendMessage(msg, msg_type, msg_size):` `**nil**` Name Type Description **msg** `**userdata**` Pointer to protobuf message buffer. **msg\_type** `**integer**` Protobuf message type ID. **msg\_size** `**integer**` Size of the protobuf message. Sends protobuff message to game coordinator. Response will be received in `OnGCMessage` callback. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/gc#example) Example Copy local protobuf = require('protobuf') local JSON = require('assets.JSON') local request = protobuf.encodeFromJSON('CMsgDOTAMatchmakingStatsRequest', JSON:encode({})); GC.SendMessage( request.binary, 7197, request.size ) [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/gc#getsteamid) GetSteamID --------------------------------------------------------------------------------------------------------------- `GC.GetSteamID():` `**string**` Returns local player Steam ID as string. [PreviousNetChannelchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/netchannel) [NextProtobufchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf) Last updated 12 months ago * [SendMessage](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/gc#sendmessage) * [GetSteamID](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/gc#getsteamid) sun-brightdesktopmoon sun-brightdesktopmoon --- # GlobalVars | API v2.0 Talbe to work with game's global variables. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getframecount) GetFrameCount --------------------------------------------------------------------------------------------------------------------- `GlobalVars.GetFrameCount():` `**integer**` Returns absolute frame counter. Continues to increase even if game is paused. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getabsframetime) GetAbsFrameTime ------------------------------------------------------------------------------------------------------------------------- `GlobalVars.GetAbsFrameTime():` `**number**` Returns absolute frame time. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getabsframetimedev) GetAbsFrameTimeDev ------------------------------------------------------------------------------------------------------------------------------- `GlobalVars.GetAbsFrameTimeDev():` `**number**` Returns absolute frame time. No idea what's the difference between this and `GetAbsFrameTime`. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getmapname) GetMapName --------------------------------------------------------------------------------------------------------------- `GlobalVars.GetMapName():` `**string**` Returns full name of the current map. For example, "maps/dota.vpk" or "maps/hero\_demo\_main.vpk". [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getmapgroupname) GetMapGroupName ------------------------------------------------------------------------------------------------------------------------- `GlobalVars.GetMapGroupName():` `**string**` Returns short name of the current map. For example, "dota" or "hero\_demo\_main". [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getcurtime) GetCurTime --------------------------------------------------------------------------------------------------------------- `GlobalVars.GetCurTime():` `**number**` TODO [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getservertick) GetServerTick --------------------------------------------------------------------------------------------------------------------- `GlobalVars.GetServerTick():` `**integer**` TODO [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getintervalpertick) GetIntervalPerTick ------------------------------------------------------------------------------------------------------------------------------- `GlobalVars.GetIntervalPerTick():` `**number**` TODO [PreviousGameRuleschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules) [NextGridNavchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav) Last updated 12 months ago * [GetFrameCount](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getframecount) * [GetAbsFrameTime](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getabsframetime) * [GetAbsFrameTimeDev](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getabsframetimedev) * [GetMapName](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getmapname) * [GetMapGroupName](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getmapgroupname) * [GetCurTime](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getcurtime) * [GetServerTick](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getservertick) * [GetIntervalPerTick](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars#getintervalpertick) sun-brightdesktopmoon sun-brightdesktopmoon --- # Chat | API v2.0 Table to work with chat. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi#getchannels) GetChannels ---------------------------------------------------------------------------------------------------------------------- `Chat.GetChannels():` `**string[]**` Returns an array of channel names. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi#print) Print ---------------------------------------------------------------------------------------------------------- `Chat.Print(channel, text):` `**nil**` Name Type Description **channel** `**string**` The channel name to say the message in. **text** `**string**` The message to say. Print a message in a channel. This message will not be sent to the server. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi#say) Say ------------------------------------------------------------------------------------------------------ `Chat.Say(channel, text):` `**nil**` Name Type Description **channel** `**string**` The channel name to say the message in. **text** `**string**` The message to say. Say a message in a channel. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi#flip) Flip -------------------------------------------------------------------------------------------------------- `Chat.Flip(channel):` `**nil**` Name Type Description **channel** `**string**` The channel name to flip the coin in. Flip the coin in a channel. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi#roll) Roll -------------------------------------------------------------------------------------------------------- `Chat.Roll(channel, [min], [max]):` `**nil**` Name Type Description **channel** `**string**` The channel name to roll the dice in. **min** `**[?]**` `**number**` The minimum number to roll. `(default: 0)` **max** `**[?]**` `**number**` The maximum number to roll. `(default: 100)` Roll a dice in a channel. [PreviousNetworking & APIschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis) [NextHTTPchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/http) Last updated 12 months ago * [GetChannels](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi#getchannels) * [Print](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi#print) * [Say](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi#say) * [Flip](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi#flip) * [Roll](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi#roll) sun-brightdesktopmoon sun-brightdesktopmoon --- # Steam | API v2.0 Table to with Steam API functions [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi#setpersonaname) SetPersonaName ----------------------------------------------------------------------------------------------------------------------------- `Steam.SetPersonaName(name):` `**nil**` Name Type Description **name** `**string**` The name to set Sets the player name, stores it on the server and publishes the changes to all friends who are online. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi#getpersonaname) GetPersonaName ----------------------------------------------------------------------------------------------------------------------------- `Steam.GetPersonaName():` `**string**` Returns the local players name. This is the same name as on the users community profile page. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi#getgamelanguage) GetGameLanguage ------------------------------------------------------------------------------------------------------------------------------- `Steam.GetGameLanguage():` `**string**` Returns the current game language. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi#getprofilepicturebysteamid) GetProfilePictureBySteamId ----------------------------------------------------------------------------------------------------------------------------------------------------- circle-info This function works only if you already got player's user information (EMsg\_ClientRequestFriendData). That means you should be in the same game with the player or he should be in your friend list. `Steam.GetProfilePictureBySteamId(steamID64, [large]):` `**integer**` Name Type Description **steamID64** `**integer**` The Steam ID of the player **large** `**[?]**` `**boolean**` Whether to get the large profile picture `(default: false)` Returns the handle of the profile picture of the given Steam ID. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi#getprofilepicturebyaccountid) GetProfilePictureByAccountId --------------------------------------------------------------------------------------------------------------------------------------------------------- circle-info This function works only if you already got player's user information (EMsg\_ClientRequestFriendData). That means you should be in the same game with the player or he should be in your friend list. \`Steam.GetProfilePictureByAccountId(steamID64, \[large\]):\` \*\*\`integer\`\*\* Name Type Description **steamID64** `**integer**` The account id of the player **large** `**[?]**` `**boolean**` Whether to get the large profile picture `(default: false)` Returns the handle of the profile picture of the given account id. [PreviousHTTPchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/http) [NextNetChannelchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/netchannel) Last updated 12 months ago * [SetPersonaName](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi#setpersonaname) * [GetPersonaName](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi#getpersonaname) * [GetGameLanguage](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi#getgamelanguage) * [GetProfilePictureBySteamId](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi#getprofilepicturebysteamid) * [GetProfilePictureByAccountId](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi#getprofilepicturebyaccountid) sun-brightdesktopmoon sun-brightdesktopmoon --- # CMenuLabel | API v2.0 CMenuLabel metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#name) Name ------------------------------------------------------------------------------------------------------------------ `:Name(newText):` `**string**` Name Type Description **newText** `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#name-1) Name -------------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#parent) Parent ---------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#type) Type ------------------------------------------------------------------------------------------------------------------ `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#open) Open ------------------------------------------------------------------------------------------------------------------ `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#forcelocalization) ForceLocalization -------------------------------------------------------------------------------------------------------------------------------------------- circle-info Not recommended for use due to its complexity \`:ForceLocalization(newText):\` \*\*\`nil\`\*\* Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#tooltip) ToolTip ------------------------------------------------------------------------------------------------------------------------ `:ToolTip(newText):` `**string**` Name Type Description **newText** `**string**` Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#tooltip-1) ToolTip -------------------------------------------------------------------------------------------------------------------------- `:ToolTip():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#visible) Visible ------------------------------------------------------------------------------------------------------------------------ `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#visible-1) Visible -------------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#disabled) Disabled -------------------------------------------------------------------------------------------------------------------------- `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#disabled-1) Disabled ---------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#unsafe) Unsafe ---------------------------------------------------------------------------------------------------------------------- `:Unsafe(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets unsafe state. Unsafe widgets have warning sign. Depends on argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#unsafe-1) Unsafe ------------------------------------------------------------------------------------------------------------------------ `:Unsafe():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#image) Image -------------------------------------------------------------------------------------------------------------------- `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets widget's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#imagehandle) ImageHandle -------------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#icon) Icon ------------------------------------------------------------------------------------------------------------------ `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets widget's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#colorpicker) ColorPicker -------------------------------------------------------------------------------------------------------------------------------- `:ColorPicker(name, color):` [`**CMenuColorPickerAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment) Name Type Description **name** `**string**` Name of the attachment. **color** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Default color. Creates `CMenuColorPickerAttachment` and attaches it to the widget. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#gear) Gear ------------------------------------------------------------------------------------------------------------------ `:Gear(name, [gearIcon], [useSmallFont]):` [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Name Type Description **name** `**string**` Name of the attachment. **gearIcon** `**[?]**` `**string**` Gear FontAwesome icon. `(default: "\uf013")` **useSmallFont** `**[?]**` `**boolean**` Use small font for gear icon. `(default: true)` Creates `CMenuGearAttachment` and attaches it to the widget. [PreviousCMenuBindchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind) [NextMathchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math) Last updated 2 days ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#name) * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#name-1) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#forcelocalization) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#tooltip) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#tooltip-1) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#disabled-1) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#unsafe) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#unsafe-1) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#imagehandle) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#icon) * [ColorPicker](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#colorpicker) * [Gear](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel#gear) sun-brightdesktopmoon Copy -- setter widget:Visible(false) Copy -- getter local isVisible = widget:Visible() Copy -- setter widget:Disabled( false ) Copy -- getter local isDisabled = widget:Disabled() Copy --https://fontawesome.com/icons/user?f=classic&s=solid widget:Icon("\u{f007}") sun-brightdesktopmoon --- # CMenuSliderInt | API v2.0 CMenuSliderInt metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#update) Update -------------------------------------------------------------------------------------------------------------------------- `:Update(minValue, maxValue, defaultValue):` `**nil**` Name Type Description **minValue** `**integer**` **maxValue** `**integer**` **defaultValue** `**integer**` Updates the slider values. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#name) Name ---------------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#parent) Parent -------------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#type) Type ---------------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#open) Open ---------------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#forcelocalization) ForceLocalization ------------------------------------------------------------------------------------------------------------------------------------------------ circle-info Not recommended for use due to its complexity `:ForceLocalization(newText):` `**nil**` Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#tooltip) ToolTip ---------------------------------------------------------------------------------------------------------------------------- `:ToolTip(newText):` `**string**` Name Type Description **newText** `**string**` Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#tooltip-1) ToolTip ------------------------------------------------------------------------------------------------------------------------------ `:ToolTip():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#visible) Visible ---------------------------------------------------------------------------------------------------------------------------- `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#visible-1) Visible ------------------------------------------------------------------------------------------------------------------------------ `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#disabled) Disabled ------------------------------------------------------------------------------------------------------------------------------ `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#disabled-1) Disabled -------------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#unsafe) Unsafe -------------------------------------------------------------------------------------------------------------------------- `:Unsafe(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets unsafe state. Unsafe widgets have warning sign. Depends on argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#unsafe-1) Unsafe ---------------------------------------------------------------------------------------------------------------------------- `:Unsafe():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#get) Get -------------------------------------------------------------------------------------------------------------------- `:Get():` `**integer**` Returns widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#set) Set -------------------------------------------------------------------------------------------------------------------- `:Set(value):` `**nil**` Name Type Description **value** `**integer**` Sets widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#image) Image ------------------------------------------------------------------------------------------------------------------------ `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets widget's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#imagehandle) ImageHandle ------------------------------------------------------------------------------------------------------------------------------------ `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#icon) Icon ---------------------------------------------------------------------------------------------------------------------- `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets widget's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#setcallback) SetCallback ------------------------------------------------------------------------------------------------------------------------------------ circle-info Multiple callbacks could be set. \`:SetCallback(callback, \[forceCall\]):\` \*\*\`nil\`\*\* Name Type Description **callback** `**fun(this: CMenuSliderInt):nil**` function to be called on widget change. **forceCall** `**[?]**` `**boolean**` true if you want to call callback on widget creation. `(default: false)` Sets widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#unsetcallback) UnsetCallback ---------------------------------------------------------------------------------------------------------------------------------------- `:UnsetCallback(callback):` `**nil**` Name Type Description **callback** `**fun(this: CMenuSliderInt):nil**` function to be removed from widget's callbacks. Removes widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#colorpicker) ColorPicker ------------------------------------------------------------------------------------------------------------------------------------ `:ColorPicker(name, color):` [`**CMenuColorPickerAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment) Name Type Description **name** `**string**` Name of the attachment. **color** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Default color. Creates `CMenuColorPickerAttachment` and attaches it to the widget. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#gear) Gear ---------------------------------------------------------------------------------------------------------------------- `:Gear(name, [gearIcon], [useSmallFont]):` [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Name Type Description **name** `**string**` Name of the attachment. **gearIcon** `**[?]**` `**string**` Gear FontAwesome icon. `(default: "\uf013")` **useSmallFont** `**[?]**` `**boolean**` Use small font for gear icon. `(default: true)` Creates `CMenuGearAttachment` and attaches it to the widget. [PreviousCMenuSliderFloatchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat) [NextCMenuButtonchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton) Last updated 9 months ago * [Update](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#update) * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#forcelocalization) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#tooltip) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#tooltip-1) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#disabled-1) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#unsafe) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#unsafe-1) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#get) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#set) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#imagehandle) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#icon) * [SetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#setcallback) * [UnsetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#unsetcallback) * [ColorPicker](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#colorpicker) * [Gear](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint#gear) sun-brightdesktopmoon Copy -- setter switch:Visible(false) Copy -- getter local isVisible = switch:Visible() Copy -- setter switch:Disabled( false ) Copy -- getter local isDisabled = switch:Disabled() Copy --https://fontawesome.com/icons/user?f=classic&s=solid switch:Icon("\u{f007}") sun-brightdesktopmoon --- # Modifiers | API v2.0 Table to work with list of modifiers. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/modifiers#count) Count ---------------------------------------------------------------------------------------------- `Modifiers.Count():` `**integer**` Returns size of modifiers list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/modifiers#get) Get ------------------------------------------------------------------------------------------ `Modifiers.Get(index):` [`**CModifier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/modifier) | `**nil**` Name Type Description **index** `**integer**` Index of temp tree in cheat list. Returns modifiers by index in cheat list. Not the same as in-game index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/modifiers#getall) GetAll ------------------------------------------------------------------------------------------------ `Modifiers.GetAll():` [`**CModifier[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/modifier) Returns all modifiers in cheat list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/modifiers#contains) Contains ---------------------------------------------------------------------------------------------------- `Modifiers.Contains(tree):` `**boolean**` Name Type Description **tree** [`**CModifier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/modifier) Temp tree to check. Checks if modifiers is in list. [PreviousPhysical Itemschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/physicalitems) [NextLinearProjectileschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/linearprojectiles) Last updated 12 months ago * [Count](https://uczone.gitbook.io/api-v2.0/game-components/lists/modifiers#count) * [Get](https://uczone.gitbook.io/api-v2.0/game-components/lists/modifiers#get) * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/modifiers#getall) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/modifiers#contains) sun-brightdesktopmoon sun-brightdesktopmoon --- # CMenuSliderFloat | API v2.0 CMenuSliderFloat metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#update) Update ---------------------------------------------------------------------------------------------------------------------------- `:Update(minValue, maxValue, defaultValue):` `**nil**` Name Type Description **minValue** `**number**` **maxValue** `**number**` **defaultValue** `**number**` Updates the slider values. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#name) Name ------------------------------------------------------------------------------------------------------------------------ `:Name():` `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#parent) Parent ---------------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#type) Type ------------------------------------------------------------------------------------------------------------------------ `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#open) Open ------------------------------------------------------------------------------------------------------------------------ `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#forcelocalization) ForceLocalization -------------------------------------------------------------------------------------------------------------------------------------------------- circle-info Not recommended for use due to its complexity `:ForceLocalization(newText):` `**nil**` Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#tooltip) ToolTip ------------------------------------------------------------------------------------------------------------------------------ `:ToolTip(newText):` `**string**` Name Type Description **newText** `**string**` Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#tooltip-1) ToolTip -------------------------------------------------------------------------------------------------------------------------------- `:ToolTip():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#visible) Visible ------------------------------------------------------------------------------------------------------------------------------ `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#visible-1) Visible -------------------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#disabled) Disabled -------------------------------------------------------------------------------------------------------------------------------- `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#disabled-1) Disabled ---------------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#unsafe) Unsafe ---------------------------------------------------------------------------------------------------------------------------- `:Unsafe(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets unsafe state. Unsafe widgets have warning sign. Depends on argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#unsafe-1) Unsafe ------------------------------------------------------------------------------------------------------------------------------ `:Unsafe():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#get) Get ---------------------------------------------------------------------------------------------------------------------- `:Get():` `**number**` Returns widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#set) Set ---------------------------------------------------------------------------------------------------------------------- `:Set(value):` `**nil**` Name Type Description **value** `**number**` Sets widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#image) Image -------------------------------------------------------------------------------------------------------------------------- `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets widget's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#imagehandle) ImageHandle -------------------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#icon) Icon ------------------------------------------------------------------------------------------------------------------------ `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets widget's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#setcallback) SetCallback -------------------------------------------------------------------------------------------------------------------------------------- circle-info Multiple callbacks could be set. \`:SetCallback(callback, \[forceCall\]):\` \*\*\`nil\`\*\* Name Type Description **callback** `**fun(this: CMenuSliderFloat):nil**` function to be called on widget change.\\ **forceCall** `**[?]**` `**boolean**` true if you want to call callback on widget creation. `(default: false)` Sets widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#unsetcallback) UnsetCallback ------------------------------------------------------------------------------------------------------------------------------------------ `:UnsetCallback(callback):` `**nil**` Name Type Description **callback** `**fun(this: CMenuSliderFloat):nil**` function to be removed from widget's callbacks. Removes widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#colorpicker) ColorPicker -------------------------------------------------------------------------------------------------------------------------------------- `:ColorPicker(name, color):` [`**CMenuColorPickerAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment) Name Type Description **name** `**string**` Name of the attachment. **color** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Default color. Creates `CMenuColorPickerAttachment` and attaches it to the widget. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#gear) Gear ------------------------------------------------------------------------------------------------------------------------ `:Gear(name, [gearIcon], [useSmallFont]):` [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Name Type Description **name** `**string**` Name of the attachment. **gearIcon** `**[?]**` `**string**` Gear FontAwesome icon. `(default: "\uf013")` **useSmallFont** `**[?]**` `**boolean**` Use small font for gear icon. `(default: true)` Creates `CMenuGearAttachment` and attaches it to the widget. [PreviousCMenuSwitchchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch) [NextCMenuSliderIntchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint) Last updated 9 months ago * [Update](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#update) * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#forcelocalization) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#tooltip) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#tooltip-1) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#disabled-1) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#unsafe) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#unsafe-1) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#get) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#set) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#imagehandle) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#icon) * [SetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#setcallback) * [UnsetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#unsetcallback) * [ColorPicker](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#colorpicker) * [Gear](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat#gear) sun-brightdesktopmoon Copy -- setter switch:Visible(false) Copy -- getter local isVisible = switch:Visible() Copy -- setter switch:Disabled( false ) Copy -- getter local isDisabled = switch:Disabled() Copy --https://fontawesome.com/icons/user?f=classic&s=solid switch:Icon("\u{f007}") sun-brightdesktopmoon --- # HTTP | API v2.0 Table to work with HTTP requests. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/http#request) Request ----------------------------------------------------------------------------------------------------------- `HTTP.Request(method, url, [data], callback, [param]):` `**boolean**` Name Type Description **method** `**string**` HTTP method **url** `**string**` URL **data** `**[?]**` `**{headers:table, cookies:string**` | `**table, data:string**` | `**table, timeout:number}**` data to send `(default: {})` **callback** `**fun(tbl: {response: string, code: string, header: string, param: string}):nil**` callback function to call when request is done. Take 1 argument - response data table, see example. **param** `**[?]**` `**string**` string parameter to pass to callback function to identify request `(default: "")` Do HTTP request. Returns `true` if request was sent successfully. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/http#example) Example Copy -- http_request.lua local url = "https://reqres.in/api/users/2"; local headers = { ["User-Agent"] = "Umbrella/1.0", ['Connection'] = 'Keep-Alive', } local JSON = require('assets.JSON') local callback = function(response) Log.Write(response["response"]); Log.Write(response["code"]); Log.Write(response["header"]); Log.Write(response["param"]); local json = JSON:decode(response["response"]); Log.Write(json["data"]["email"]); end HTTP.Request("GET", url, { headers = headers, }, callback, "reqres_get"); [PreviousChatchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/chatapi) [NextSteamchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi) Last updated 11 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # NPCs | API v2.0 Table to work with NPC list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#count) Count ----------------------------------------------------------------------------------------- `NPCs.Count():` `**integer**` Return size of NPC list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#get) Get ------------------------------------------------------------------------------------- `NPCs.Get(index):` [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) | `**nil**` Name Type Description **index** `**integer**` Index of NPC in cheat list. Return NPC by index in cheat list. Not the same as in-game index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#getall) GetAll ------------------------------------------------------------------------------------------- `NPCs.GetAll([filter]):` [`**CNPC[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) Name Type Description **filter** `**[?]**` [`**Enum.UnitTypeFlags**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.unittypeflags) | `**fun(npc: CNPC):boolean**` `(default: nil)` Return all NPCs in cheat list. Can be filtered by unit type or custom function. Unit type filter is a much faster than custom function and can be or'ed to filter multiple types. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#example) Example Copy -- filter function to get all structures except towers for _, v in pairs(NPCs.GetAll(function (npc) return NPC.IsStructure(npc) and not NPC.IsTower(npc); end)) do print(NPC.GetUnitName(v)) end -- get all towers and heroes (x5 times faster than filter function) for _, v in pairs(NPCs.GetAll(Enum.UnitTypeFlags.TYPE_TOWER | Enum.UnitTypeFlags.TYPE_HERO)) do print(NPC.GetUnitName(v)) end [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#getinscreen) GetInScreen ----------------------------------------------------------------------------------------------------- `NPCs.GetInScreen([filter], [skipDormant]):` `**{entity:CNPC, position:Vec2}[]**` Name Type Description **filter** `**[?]**` [`**Enum.UnitTypeFlags**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.unittypeflags) | `**nil**` `(default: nil)` **skipDormant** `**[?]**` `**boolean**` `true` if you want to get table without dormant units `(default: true)` Return all NPCs in cheat list that visible on your screen. Can be filtered by unit type argument. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#inradius) InRadius ----------------------------------------------------------------------------------------------- `NPCs.InRadius(pos, radius, teamNum, teamType, [omitIllusions], [omitDormant]):` [`**CNPC[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) Name Type Description **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Position to check. **radius** `**number**` Radius to check. **teamNum** [`**Enum.TeamNum**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.teamnum) Team number to check. **teamType** [`**Enum.TeamType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.teamtype) Team type to filter by. Relative to teamNum param. **omitIllusions** `**[?]**` `**boolean**` `true` if you want to get table without illusions `(default: false)` **omitDormant** `**[?]**` `**boolean**` `true` if you want to get table without dormant units `(default: true)` Return all NPCs in radius. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#contains) Contains ----------------------------------------------------------------------------------------------- `NPCs.Contains(npc):` `**boolean**` Name Type Description **npc** [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) NPC to check. Check NPC in cheat list. [PreviousHeroeschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/heroes) [NextCampschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/lists/camps) Last updated 9 months ago * [Count](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#count) * [Get](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#get) * [GetAll](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#getall) * [GetInScreen](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#getinscreen) * [InRadius](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#inradius) * [Contains](https://uczone.gitbook.io/api-v2.0/game-components/lists/npcs#contains) sun-brightdesktopmoon sun-brightdesktopmoon --- # NetChannel | API v2.0 Table to work with game's net channel. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/netchannel#getlatency) GetLatency ----------------------------------------------------------------------------------------------------------------------- `NetChannel.GetLatency([flow]):` `**number**` Name Type Description **flow** `**[?]**` [`**Enum.Flow**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.flow) flow to get latency of `(default: Enum.Flow.FLOW_OUTGOING)` Returns the latency/ping of the net channel in seconds. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/netchannel#getavglatency) GetAvgLatency ----------------------------------------------------------------------------------------------------------------------------- `NetChannel.GetAvgLatency([flow]):` `**number**` Name Type Description **flow** `**[?]**` [`**Enum.Flow**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.flow) flow to get average latency of `(default: Enum.Flow.FLOW_OUTGOING)` Returns the average latency/ping of the net channel in seconds. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/netchannel#sendnetmessage) SendNetMessage ------------------------------------------------------------------------------------------------------------------------------- circle-info You can repeat the same message from OnSendNetMessage if you want to know the format of the message. \`NetChannel.SendNetMessage(name, json):\` \*\*\`nil\`\*\* Name Type Description **name** `**string**` name of the net message **json** `**string**` json of the net message Sends a protobuff message to the game server. [List of messagesarrow-up-right](https://github.com/SteamDatabase/GameTracking-Dota2/blob/master/Protobufs) , #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/netchannel#example) Example [PreviousSteamchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/steamapi) [NextGame Coordinatorchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/gc) Last updated 12 months ago * [GetLatency](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/netchannel#getlatency) * [GetAvgLatency](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/netchannel#getavglatency) * [SendNetMessage](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/netchannel#sendnetmessage) sun-brightdesktopmoon Copy -- send_netmsg.lua -- import json encoder local JSON = require('assets.JSON'); -- https://github.com/SteamDatabase/GameTracking-Dota2/blob/master/Protobufs/dota_clientmessages.proto#L395 -- message CDOTAClientMsg_RollDice { -- optional uint32 channel_type = 1; -- optional uint32 roll_min = 2; -- optional uint32 roll_max = 3; -- } NetChannel.SendNetMessage("CDOTAClientMsg_RollDice", JSON:encode({ channel_type = 13, roll_min = 11, roll_max = 222 })); sun-brightdesktopmoon --- # FogOfWar | API v2.0 Table to work with FogOfWar API. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/fogofwar#ispointvisible) IsPointVisible --------------------------------------------------------------------------------------------------------------------- `FogOfWar.IsPointVisible(pos):` `**boolean**` Name Type Description **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) position to check Returns `true` if the world position is visible. [PreviousWorldchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/world) [NextConVarchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # World | API v2.0 Table containing functions for interacting with the world. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/world#getgroundz) GetGroundZ ---------------------------------------------------------------------------------------------------------- `World.GetGroundZ(x, y):` `**number**` Name Type Description **x** `**number**` The X position to get the ground Z from. **y** `**number**` The Y position to get the ground Z from. Returns the ground Z at the given position. [PreviousInputchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input) [NextFogOfWarchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/fogofwar) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # CMenuInputBox | API v2.0 CMenuInputBox metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#name) Name --------------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#parent) Parent ------------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#type) Type --------------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#open) Open --------------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#forcelocalization) ForceLocalization ----------------------------------------------------------------------------------------------------------------------------------------------- circle-info Not recommended for use due to its complexity `:ForceLocalization(newText):` `**nil**` Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#tooltip) ToolTip --------------------------------------------------------------------------------------------------------------------------- `:ToolTip(newText):` `**string**` Name Type Description **newText** `**string**` Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#tooltip-1) ToolTip ----------------------------------------------------------------------------------------------------------------------------- `:ToolTip():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#visible) Visible --------------------------------------------------------------------------------------------------------------------------- `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#visible-1) Visible ----------------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#disabled) Disabled ----------------------------------------------------------------------------------------------------------------------------- `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#disabled-1) Disabled ------------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#unsafe) Unsafe ------------------------------------------------------------------------------------------------------------------------- `:Unsafe(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets unsafe state. Unsafe widgets have warning sign. Depends on argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#unsafe-1) Unsafe --------------------------------------------------------------------------------------------------------------------------- `:Unsafe():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#get) Get ------------------------------------------------------------------------------------------------------------------- `:Get():` `**string**` Returns widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#set) Set ------------------------------------------------------------------------------------------------------------------- `:Set(value):` `**nil**` Name Type Description **value** `**string**` Sets widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#image) Image ----------------------------------------------------------------------------------------------------------------------- `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets widget's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#imagehandle) ImageHandle ----------------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#icon) Icon --------------------------------------------------------------------------------------------------------------------- `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets widget's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#setcallback) SetCallback ----------------------------------------------------------------------------------------------------------------------------------- circle-info Multiple callbacks could be set. \`:SetCallback(callback, \[forceCall\]):\` \*\*\`nil\`\*\* Name Type Description **callback** `**fun(this: CMenuInputBox):nil**` function to be called on widget change. **forceCall** `**[?]**` `**boolean**` true if you want to call callback on widget creation. `(default: false)` Sets widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#unsetcallback) UnsetCallback --------------------------------------------------------------------------------------------------------------------------------------- `:UnsetCallback(callback):` `**nil**` Name Type Description **callback** `**fun(this: CMenuInputBox):nil**` function to be removed from widget's callbacks. Removes widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#colorpicker) ColorPicker ----------------------------------------------------------------------------------------------------------------------------------- `:ColorPicker(name, color):` [`**CMenuColorPickerAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment) Name Type Description **name** `**string**` Name of the attachment. **color** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Default color. Creates `CMenuColorPickerAttachment` and attaches it to the widget. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#gear) Gear --------------------------------------------------------------------------------------------------------------------- `:Gear(name, [gearIcon], [useSmallFont]):` [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Name Type Description **name** `**string**` Name of the attachment. **gearIcon** `**[?]**` `**string**` Gear FontAwesome icon. `(default: "\uf013")` **useSmallFont** `**[?]**` `**boolean**` Use small font for gear icon. `(default: true)` Creates `CMenuGearAttachment` and attaches it to the widget. [PreviousCMenuGearAttachmentchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) [NextCMenuMultiComboBoxchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox) Last updated 9 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#forcelocalization) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#tooltip) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#tooltip-1) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#disabled-1) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#unsafe) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#unsafe-1) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#get) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#set) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#imagehandle) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#icon) * [SetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#setcallback) * [UnsetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#unsetcallback) * [ColorPicker](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#colorpicker) * [Gear](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox#gear) sun-brightdesktopmoon Copy -- setter switch:Visible(false) Copy -- getter local isVisible = switch:Visible() Copy -- setter switch:Disabled( false ) Copy -- getter local isDisabled = switch:Disabled() Copy --https://fontawesome.com/icons/user?f=classic&s=solid switch:Icon("\u{f007}") sun-brightdesktopmoon --- # Log | API v2.0 Table to log. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/log#write) Write -------------------------------------------------------------------------------------------------------------- `Log.Write(arg):` `**nil**` Name Type Description **arg** `**any**` Message to write Writes a message to the console. [PreviousHumanizerchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer) [NextLoggerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # Rune | API v2.0 Table to work with `CRune`.`**CRune**` extends `**CEntity**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/rune#getrunetype) GetRuneType ---------------------------------------------------------------------------------------------------- `Rune.GetRuneType(rune):` [`**Enum.RuneType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.runetype) Name Type Description **rune** [`**CRune**`](https://uczone.gitbook.io/api-v2.0/game-components/core/rune) Returns `Enum.RuneType` the rune type. [PreviousItemchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/item) [NextTowerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/tower) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # Protobuf | API v2.0 Protobuf encoding/decoding module for working with Dota 2 network messages. Loaded as a require-able library: `local protobuf = require('protobuf')`. Message type names correspond to protobuf definitions from [Dota 2 Protobufsarrow-up-right](https://github.com/SteamDatabase/GameTracking-Dota2/blob/master/Protobufs) . [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf#encode) encode ------------------------------------------------------------------------------------------------------------- `protobuf.encode(name, data):` `**table**` Name Type Description **name** `**string**` Protobuf message type name **data** `**table**` Lua table with message fields Encodes a Lua table into a serialized protobuf message. Returns a table with `binary` (userdata pointer) and `size` (number) fields. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf#encodefromjson) encodeFromJSON ----------------------------------------------------------------------------------------------------------------------------- `protobuf.encodeFromJSON(name, json):` `**table**` Name Type Description **name** `**string**` Protobuf message type name **json** `**string**` JSON string representing the message Encodes a JSON string into a serialized protobuf message. Returns a table with `binary` (userdata pointer) and `size` (number) fields. Copy local protobuf = require('protobuf') local JSON = require('assets.JSON') local request = protobuf.encodeFromJSON('CMsgDOTAMatchmakingStatsRequest', JSON:encode({})) GC.SendMessage(request.binary, 7197, request.size) [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf#decodetojson) decodeToJSON ------------------------------------------------------------------------------------------------------------------------- `protobuf.decodeToJSON(name, binary, size):` `**string**` Name Type Description **name** `**string**` Protobuf message type name **binary** `**userdata**` Pointer to serialized protobuf data **size** `**integer**` Size of the serialized data in bytes Decodes a serialized protobuf message (from a raw pointer) into a JSON string. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf#decodetojsonfromstring) decodeToJSONfromString --------------------------------------------------------------------------------------------------------------------------------------------- `protobuf.decodeToJSONfromString(name, base64data):` `**string**` Name Type Description **name** `**string**` Protobuf message type name **base64data** `**string**` Base64-encoded serialized protobuf data Decodes a base64-encoded protobuf message into a JSON string. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf#decodetojsonfromobject) decodeToJSONfromObject --------------------------------------------------------------------------------------------------------------------------------------------- `protobuf.decodeToJSONfromObject(msg_object):` `**string**` Name Type Description **msg\_object** `**userdata**` Protobuf message object pointer Decodes a protobuf message object directly into a JSON string. Useful with callback message objects that provide a direct protobuf pointer. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf#free) free --------------------------------------------------------------------------------------------------------- `protobuf.free(binary):` `**boolean**` Name Type Description **binary** `**userdata**` Pointer to previously encoded protobuf data Frees memory allocated by `encode` or `encodeFromJSON`. Returns `true` on success. [PreviousGame Coordinatorchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/gc) [NextRendering & Visualschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals) Last updated 24 days ago * [encode](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf#encode) * [encodeFromJSON](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf#encodefromjson) * [decodeToJSON](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf#decodetojson) * [decodeToJSONfromString](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf#decodetojsonfromstring) * [decodeToJSONfromObject](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf#decodetojsonfromobject) * [free](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/protobuf#free) sun-brightdesktopmoon Copy local response = protobuf.decodeToJSON('CMsgDOTAMatchmakingStatsResponse', msg.binary_buffer_recv, msg.size) Log.Write(response) sun-brightdesktopmoon --- # CMenuMultiSelect | API v2.0 CMenuMultiSelect metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#name) Name ------------------------------------------------------------------------------------------------------------------------ `:Name():` `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#update) Update ---------------------------------------------------------------------------------------------------------------------------- `:Update(items, [expanded], [saveToConfig]):` `**nil**` Name Type Description **items** `**{nameId: string, imagePath: string, isEnabled: boolean}[]**` See `CMenuGroup:MultiSelect`. **expanded** `**[?]**` `**boolean**` false if you want to create MultiSelect in collapsed state. `(default: false)` **saveToConfig** `**[?]**` `**boolean**` true if you want to save to config `(default: false)` Updates the multiselect values. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#oneitemselection) OneItemSelection ------------------------------------------------------------------------------------------------------------------------------------------------ `:OneItemSelection(newState):` `**boolean**` Name Type Description **newState** `**boolean**` Gets or sets one item selection state. One item selection allows only one item to be selected. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#oneitemselection-1) OneItemSelection -------------------------------------------------------------------------------------------------------------------------------------------------- `:OneItemSelection():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#dragallowed) DragAllowed -------------------------------------------------------------------------------------------------------------------------------------- `:DragAllowed(newState):` `**boolean**` Name Type Description **newState** `**boolean**` Gets or sets drag allowed state. Drag allows items to be ordered by cursor. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#dragallowed-1) DragAllowed ---------------------------------------------------------------------------------------------------------------------------------------- `:DragAllowed():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#parent) Parent ---------------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#type) Type ------------------------------------------------------------------------------------------------------------------------ `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#open) Open ------------------------------------------------------------------------------------------------------------------------ `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#forcelocalization) ForceLocalization -------------------------------------------------------------------------------------------------------------------------------------------------- circle-info Not recommended for use due to its complexity `:ForceLocalization(newText):` `**nil**` Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#tooltip) ToolTip ------------------------------------------------------------------------------------------------------------------------------ `:ToolTip(newText):` `**string**` Name Type Description **newText** `**string**` Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#tooltip-1) ToolTip -------------------------------------------------------------------------------------------------------------------------------- `:ToolTip():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#visible) Visible ------------------------------------------------------------------------------------------------------------------------------ `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#visible-1) Visible -------------------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#disabled) Disabled -------------------------------------------------------------------------------------------------------------------------------- `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#disabled-1) Disabled ---------------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#unsafe) Unsafe ---------------------------------------------------------------------------------------------------------------------------- `:Unsafe(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets unsafe state. Unsafe widgets have warning sign. Depends on argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#unsafe-1) Unsafe ------------------------------------------------------------------------------------------------------------------------------ `:Unsafe():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#get) Get ---------------------------------------------------------------------------------------------------------------------- `:Get(itemId):` `**boolean**` Name Type Description **itemId** `**string**` Returns enable state of the item in multiselect. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#set) Set ---------------------------------------------------------------------------------------------------------------------- `:Set(enabledItems):` `**nil**` Name Type Description **enabledItems** `**string[]**` A table of enabled items; other items will be disabled. Sets a new value for the item by itemId or sets a new list of enabled items [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#set-1) Set ------------------------------------------------------------------------------------------------------------------------ `:Set(itemId, value):` `**nil**` Name Type Description **itemId** `**string**` **value** `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#list) List ------------------------------------------------------------------------------------------------------------------------ `:List():` `**string[]**` Returns array of itemIds. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#listenabled) ListEnabled -------------------------------------------------------------------------------------------------------------------------------------- `:ListEnabled():` `**string[]**` Returns array of enabled itemIds. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#image) Image -------------------------------------------------------------------------------------------------------------------------- `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets widget's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#imagehandle) ImageHandle -------------------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#icon) Icon ------------------------------------------------------------------------------------------------------------------------ `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets widget's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#setcallback) SetCallback -------------------------------------------------------------------------------------------------------------------------------------- circle-info Multiple callbacks could be set. \`:SetCallback(callback, \[forceCall\]):\` \*\*\`nil\`\*\* Name Type Description **callback** `**fun(this: CMenuMultiSelect):nil**` function to be called on widget change. **forceCall** `**[?]**` `**boolean**` true if you want to call callback on widget creation. `(default: false)` Sets widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#unsetcallback) UnsetCallback ------------------------------------------------------------------------------------------------------------------------------------------ `:UnsetCallback(callback):` `**nil**` Name Type Description **callback** `**fun(this: CMenuMultiSelect):nil**` function to be removed from widget's callbacks. Removes widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#updatebackgroundcolors) UpdateBackgroundColors ------------------------------------------------------------------------------------------------------------------------------------------------------------ `:UpdateBackgroundColors(colors):` `**nil**` Name Type Description **colors** `**table**` Table with background colors. Updates widget's background colors. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#updateimagecolors) UpdateImageColors -------------------------------------------------------------------------------------------------------------------------------------------------- `:UpdateImageColors(colors):` `**nil**` Name Type Description **colors** `**table**` Table with image colors. Updates widget's image colors. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#updatetooltips) UpdateToolTips -------------------------------------------------------------------------------------------------------------------------------------------- `:UpdateToolTips(colors):` `**nil**` Name Type Description **colors** `**table**` Table with new tooltips Updates widget's tooltips [PreviousCMenuMultiComboBoxchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox) [NextCMenuBindchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind) Last updated 9 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#name) * [Update](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#update) * [OneItemSelection](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#oneitemselection) * [OneItemSelection](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#oneitemselection-1) * [DragAllowed](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#dragallowed) * [DragAllowed](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#dragallowed-1) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#forcelocalization) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#tooltip) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#tooltip-1) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#disabled-1) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#unsafe) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#unsafe-1) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#get) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#set) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#set-1) * [List](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#list) * [ListEnabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#listenabled) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#imagehandle) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#icon) * [SetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#setcallback) * [UnsetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#unsetcallback) * [UpdateBackgroundColors](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#updatebackgroundcolors) * [UpdateImageColors](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#updateimagecolors) * [UpdateToolTips](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect#updatetooltips) sun-brightdesktopmoon Copy -- setter widget:Visible(false) Copy -- getter local isVisible = widget:Visible() Copy -- setter widget:Disabled( false ) Copy -- getter local isDisabled = widget:Disabled() Copy --https://fontawesome.com/icons/user?f=classic&s=solid widget:Icon("\u{f007}") sun-brightdesktopmoon --- # CMenuMultiComboBox | API v2.0 CMenuMultiComboBox metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#name) Name -------------------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#update) Update ------------------------------------------------------------------------------------------------------------------------------ `:Update(items, enabledItems):` `**nil**` Name Type Description **items** `**string[]**` **enabledItems** `**string[]**` table of enabled items Updates the multicombo values. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#parent) Parent ------------------------------------------------------------------------------------------------------------------------------ `:Parent():` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#type) Type -------------------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#open) Open -------------------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#forcelocalization) ForceLocalization ---------------------------------------------------------------------------------------------------------------------------------------------------- circle-info Not recommended for use due to its complexity `:ForceLocalization(newText):` `**nil**` Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#tooltip) ToolTip -------------------------------------------------------------------------------------------------------------------------------- `:ToolTip(newText):` `**string**` Name Type Description **newText** `**string**` Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#tooltip-1) ToolTip ---------------------------------------------------------------------------------------------------------------------------------- `:ToolTip():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#visible) Visible -------------------------------------------------------------------------------------------------------------------------------- `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#visible-1) Visible ---------------------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#disabled) Disabled ---------------------------------------------------------------------------------------------------------------------------------- `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#disabled-1) Disabled ------------------------------------------------------------------------------------------------------------------------------------ `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#unsafe) Unsafe ------------------------------------------------------------------------------------------------------------------------------ `:Unsafe(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets unsafe state. Unsafe widgets have warning sign. Depends on argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#unsafe-1) Unsafe -------------------------------------------------------------------------------------------------------------------------------- `:Unsafe():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#get) Get ------------------------------------------------------------------------------------------------------------------------ `:Get(itemId):` `**boolean**` Name Type Description **itemId** `**string**` Returns enable state of the item in combo box. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#set) Set ------------------------------------------------------------------------------------------------------------------------ `:Set(enabledItems):` `**nil**` Name Type Description **enabledItems** `**string[]**` A table of enabled items; other items will be disabled. Sets a new value for the item by itemId or sets a new list of enabled items [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#set-1) Set -------------------------------------------------------------------------------------------------------------------------- `:Set(itemId, value):` `**nil**` Name Type Description **itemId** `**string**` **value** `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#list) List -------------------------------------------------------------------------------------------------------------------------- `:List():` `**string[]**` Returns array of itemIds. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#listenabled) ListEnabled ---------------------------------------------------------------------------------------------------------------------------------------- `:ListEnabled():` `**string[]**` Returns array of enabled itemIds. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#image) Image ---------------------------------------------------------------------------------------------------------------------------- `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets widget's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#imagehandle) ImageHandle ---------------------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#icon) Icon -------------------------------------------------------------------------------------------------------------------------- `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets widget's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#setcallback) SetCallback ---------------------------------------------------------------------------------------------------------------------------------------- circle-info Multiple callbacks could be set. \`:SetCallback(callback, \[forceCall\]):\` \*\*\`nil\`\*\* Name Type Description **callback** `**fun(this: CMenuMultiComboBox):nil**` function to be called on widget change. **forceCall** `**[?]**` `**boolean**` true if you want to call callback on widget creation. `(default: false)` Sets widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#unsetcallback) UnsetCallback -------------------------------------------------------------------------------------------------------------------------------------------- `:UnsetCallback(callback):` `**nil**` Name Type Description **callback** `**fun(this: CMenuMultiComboBox):nil**` function to be removed from widget's callbacks. Removes widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#colorpicker) ColorPicker ---------------------------------------------------------------------------------------------------------------------------------------- `:ColorPicker(name, color):` [`**CMenuColorPickerAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment) Name Type Description **name** `**string**` Name of the attachment. **color** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Default color. Creates `CMenuColorPickerAttachment` and attaches it to the widget. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#gear) Gear -------------------------------------------------------------------------------------------------------------------------- `:Gear(name, [gearIcon], [useSmallFont]):` [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Name Type Description **name** `**string**` Name of the attachment. **gearIcon** `**[?]**` `**string**` Gear FontAwesome icon. `(default: "\uf013")` **useSmallFont** `**[?]**` `**boolean**` Use small font for gear icon. `(default: true)` Creates `CMenuGearAttachment` and attaches it to the widget. [PreviousCMenuInputBoxchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox) [NextCMenuMultiSelectchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect) Last updated 9 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#name) * [Update](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#update) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#forcelocalization) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#tooltip) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#tooltip-1) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#disabled-1) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#unsafe) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#unsafe-1) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#get) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#set) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#set-1) * [List](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#list) * [ListEnabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#listenabled) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#imagehandle) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#icon) * [SetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#setcallback) * [UnsetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#unsetcallback) * [ColorPicker](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#colorpicker) * [Gear](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox#gear) sun-brightdesktopmoon Copy -- setter widget:Visible(false) Copy -- getter local isVisible = widget:Visible() Copy -- setter widget:Disabled( false ) Copy -- getter local isDisabled = widget:Disabled() Copy --https://fontawesome.com/icons/user?f=classic&s=solid widget:Icon("\u{f007}") sun-brightdesktopmoon --- # Configuration & Utilities | API v2.0 [⚒️Configchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config) [🤖Humanizerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer) [📓Logchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/log) [🪵Loggerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger) [🗣️Localizerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/localizer) [📝GameLocalizerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer) [⚙️tablechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext) [🔤StringBuilderchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder) [⏱️Chronoschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/chronos) [PreviousUIPanelchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) [NextConfigchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # Core | API v2.0 [👤Playerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/player) [✨Modifierchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/modifier) [👾Entitychevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) [🎭NPCchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) [🦸Herochevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) [🌟Abilitychevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) [🔑Itemchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/item) [🔮Runechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/rune) [🏰Towerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/tower) [🌳Treechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/tree) [🔱Vambracechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/vambrace) [🐉Campchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/camp) [🍾Bottlechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/bottle) [🚚Courierchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/courier) [🍻DrunkenBrawlerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/drunkenbrawler) [📦PhysicalItemchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/physicalitem) [👟PowerTreadschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/powertreads) [🪙TierTokenchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/tiertoken) [PreviousLinearProjectileschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/lists/linearprojectiles) [NextPlayerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/player) Last updated 9 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # Tree | API v2.0 Table to work with `CTree`.`**CTree**` extends `**CEntity**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/tree#isactive) IsActive ---------------------------------------------------------------------------------------------- `Tree.IsActive(tree):` `**boolean**` Name Type Description **tree** [`**CTree**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tree) Returns if the tree is not cut. [PreviousTowerchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/tower) [NextVambracechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/vambrace) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # Event | API v2.0 Table to work with game events. When you install events, you send the subscribe message to the server, which is potentially unsafe. Therefore, you won't be able to install new listeners when you have unsafe features disabled in the Settings -> Security tab. The list of events can be found in the "pak01\_dir.vpk" under "resource/game.gameevents." [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#addlistener) AddListener ------------------------------------------------------------------------------------------------------------ `Event.AddListener(name):` `**nil**` Name Type Description **name** `**string**` Event name Installs an event listener for the desired event. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#isreliable) IsReliable ---------------------------------------------------------------------------------------------------------- `Event.IsReliable(event):` `**boolean**` Name Type Description **event** [`**CEvent**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event) Checks if the event is reliable. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#islocal) IsLocal ---------------------------------------------------------------------------------------------------- `Event.IsLocal(event):` `**boolean**` Name Type Description **event** [`**CEvent**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event) Checks if the event is local or networked. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#isempty) IsEmpty ---------------------------------------------------------------------------------------------------- `Event.IsEmpty(event):` `**boolean**` Name Type Description **event** [`**CEvent**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event) Checks if the event is empty. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#getbool) GetBool ---------------------------------------------------------------------------------------------------- `Event.GetBool(event, field):` `**boolean**` Name Type Description **event** [`**CEvent**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event) **field** `**string**` Field name Returns the boolean value of the specified event field. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#getint) GetInt -------------------------------------------------------------------------------------------------- `Event.GetInt(event, field):` `**integer**` Name Type Description **event** [`**CEvent**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event) **field** `**string**` Field name Returns the integer value of the specified event field. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#getuint64) GetUint64 -------------------------------------------------------------------------------------------------------- `Event.GetUint64(event, field):` `**integer**` Name Type Description **event** [`**CEvent**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event) **field** `**string**` Field name Returns the uint64 value of the specified event field. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#getfloat) GetFloat ------------------------------------------------------------------------------------------------------ `Event.GetFloat(event, field):` `**number**` Name Type Description **event** [`**CEvent**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event) **field** `**string**` Field name Returns the floating value of the specified event field. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#getstring) GetString -------------------------------------------------------------------------------------------------------- `Event.GetString(event, field):` `**string**` Name Type Description **event** [`**CEvent**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event) **field** `**string**` Field name Returns the string value of the specified event field. [PreviousEnginechevron-left](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine) [NextGameRuleschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules) Last updated 12 months ago * [AddListener](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#addlistener) * [IsReliable](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#isreliable) * [IsLocal](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#islocal) * [IsEmpty](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#isempty) * [GetBool](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#getbool) * [GetInt](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#getint) * [GetUint64](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#getuint64) * [GetFloat](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#getfloat) * [GetString](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event#getstring) sun-brightdesktopmoon sun-brightdesktopmoon --- # Chronos | API v2.0 High-resolution monotonic timer module. Loaded as a require-able library: `local chronos = require('chronos')`. Uses `QueryPerformanceCounter` on Windows for nanosecond-class precision. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/chronos#nanotime) nanotime ------------------------------------------------------------------------------------------------------------------------ `chronos.nanotime():` `**number**` Returns the current monotonic time in seconds with nanosecond precision. The returned value is relative to an unspecified epoch — only differences between two calls are meaningful. Copy local chronos = require('chronos') local start = chronos.nanotime() -- ... work ... local elapsed = chronos.nanotime() - start Log.Write("Elapsed: " .. tostring(elapsed) .. " seconds") [PreviousStringBuilderchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder) Last updated 23 days ago sun-brightdesktopmoon sun-brightdesktopmoon --- # CMenuGroup | API v2.0 CMenuGroup metatable [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#name) Name --------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns group's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#parent) Parent ------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CThirdTab**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab) Returns group's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#type) Type --------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#open) Open --------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#find) Find --------------------------------------------------------------------------------------------------------------- `:Find(widgetName):` [`**CMenuSwitch**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch) | [`**CMenuBind**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind) | [`**CMenuSliderFloat**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat) | [`**CMenuSliderInt**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint) | [`**CMenuColorPicker**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker) | [`**CMenuComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox) | [`**CMenuButton**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton) | [`**CMenuMultiComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox) | [`**CMenuMultiSelect**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect) | [`**CMenuInputBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox) | [`**CMenuLabel**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel) | `**nil**` Name Type Description **widgetName** `**string**` Finds the widget by name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#switch) Switch ------------------------------------------------------------------------------------------------------------------- `:Switch(switchName, [defaultValue], [imageIcon]):` [`**CMenuSwitch**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch) Name Type Description **switchName** `**string**` **defaultValue** `**[?]**` `**boolean**` `(default: false)` **imageIcon** `**[?]**` `**string**` Path to image or FontAwesome icon unicode. `(default: "")` Creates new `CMenuSwitch`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#bind) Bind --------------------------------------------------------------------------------------------------------------- `:Bind(bindName, [defaultValue], [imageIcon]):` [`**CMenuBind**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind) Name Type Description **bindName** `**string**` **defaultValue** `**[?]**` [`**Enum.ButtonCode**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.buttoncode) `(default: Enum.ButtonCode.BUTTON_CODE_INVALID)` **imageIcon** `**[?]**` `**string**` Path to image or FontAwesome icon unicode. `(default: "")` Creates new `CMenuBind`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#forcelocalization) ForceLocalization ----------------------------------------------------------------------------------------------------------------------------------------- circle-info Not recommended for use due to its complexity \`:ForceLocalization(newText):\` \*\*\`nil\`\*\* Name Type Description **newText** `**string**` Changes text in the group header. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#slider) Slider ------------------------------------------------------------------------------------------------------------------- `:Slider(sliderName, minValue, maxValue, defaultValue, [format]):` [`**CMenuSliderInt**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint) Name Type Description **sliderName** `**string**` **minValue** `**integer**` **maxValue** `**integer**` **defaultValue** `**integer**` **format** `**[?]**` `**string**` | `**fun(value: integer):string**` Format string or function to format value. See example. `(default: "%d")` Creates new `CMenuSliderInt` or `CMenuSliderFloat` depents on arg types. `minValue`, `maxValue` and `defaultValue` should be integer to create `CMenuSliderInt`. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#slider-1) Slider --------------------------------------------------------------------------------------------------------------------- `:Slider(sliderName, minValue, maxValue, defaultValue, [format]):` [`**CMenuSliderFloat**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat) Name Type Description **sliderName** `**string**` **minValue** `**number**` **maxValue** `**number**` **defaultValue** `**number**` **format** `**[?]**` `**string**` | `**fun(value: number):string**` Format string or function to format value. See example. `(default: "%f")` Creates new `CMenuSliderFloat`. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#colorpicker) ColorPicker ----------------------------------------------------------------------------------------------------------------------------- `:ColorPicker(colorPickerName, color, [imageIcon]):` [`**CMenuColorPicker**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker) Name Type Description **colorPickerName** `**string**` **color** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) **imageIcon** `**[?]**` `**string**` Path to image or FontAwesome icon unicode. `(default: "")` Creates new `CMenuColorPicker`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#button) Button ------------------------------------------------------------------------------------------------------------------- `:Button(buttonName, callback, [altStyle], [widthPercent]):` [`**CMenuButton**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton) Name Type Description **buttonName** `**string**` **callback** `**fun(this: CMenuButton):nil**` function to call on button click. **altStyle** `**[?]**` `**boolean**` Use alternative button style. `(default: false)` **widthPercent** `**[?]**` `**number**` Button width in percents. \[0.0, 1.0\] `(default: 1.0)` Creates new `CMenuButton`. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#combo) Combo ----------------------------------------------------------------------------------------------------------------- `:Combo(comboName, items, [defaultValue]):` [`**CMenuComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox) Name Type Description **comboName** `**string**` **items** `**string[]**` **defaultValue** `**[?]**` `**integer**` Index of default item. (starts from 0) `(default: 0)` Creates new `CMenuComboBox`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#multicombo) MultiCombo --------------------------------------------------------------------------------------------------------------------------- `:MultiCombo(multiComboName, items, enabledItems):` [`**CMenuMultiComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox) Name Type Description **multiComboName** `**string**` **items** `**string[]**` **enabledItems** `**string[]**` table of enabled items Creates new `CMenuMultiComboBox`. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#multiselect) MultiSelect ----------------------------------------------------------------------------------------------------------------------------- `:MultiSelect(multiSelectName, items, [expanded]):` [`**CMenuMultiSelect**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect) Name Type Description **multiSelectName** `**string**` **items** `**{nameId: string, imagePath: string, isEnabled: boolean}[]**` See example. **expanded** `**[?]**` `**boolean**` false if you want to create MultiSelect in collapsed state. `(default: false)` Creates new `CMenuMultiSelect`. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#input) Input ----------------------------------------------------------------------------------------------------------------- `:Input(inputName, defaultValue, [imageIcon]):` [`**CMenuInputBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox) Name Type Description **inputName** `**string**` **defaultValue** `**string**` **imageIcon** `**[?]**` `**string**` Path to image or FontAwesome icon unicode. `(default: "")` Creates new `CMenuInputBox`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#label) Label ----------------------------------------------------------------------------------------------------------------- `:Label(labelText, [imageIcon]):` [`**CMenuLabel**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel) Name Type Description **labelText** `**string**` **imageIcon** `**[?]**` `**string**` Path to image or FontAwesome icon unicode. `(default: "")` Creates new `CMenuLabel`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#disabled) Disabled ----------------------------------------------------------------------------------------------------------------------- `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets group's disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#example-5) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#disabled-1) Disabled ------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#example-6) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#visible) Visible --------------------------------------------------------------------------------------------------------------------- `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets group's visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#example-7) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#visible-1) Visible ----------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#example-8) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#searchhidden) SearchHidden ------------------------------------------------------------------------------------------------------------------------------- `:SearchHidden(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets group's search state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#example-9) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#searchhidden-1) SearchHidden --------------------------------------------------------------------------------------------------------------------------------- `:SearchHidden():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#example-10) Example [PreviousCThirdTabchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab) [NextWidgetschevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets) Last updated 25 days ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#open) * [Find](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#find) * [Switch](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#switch) * [Bind](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#bind) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#forcelocalization) * [Slider](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#slider) * [Slider](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#slider-1) * [ColorPicker](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#colorpicker) * [Button](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#button) * [Combo](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#combo) * [MultiCombo](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#multicombo) * [MultiSelect](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#multiselect) * [Input](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#input) * [Label](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#label) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#disabled-1) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#visible-1) * [SearchHidden](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#searchhidden) * [SearchHidden](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup#searchhidden-1) sun-brightdesktopmoon Copy -- Create slider with integer values group:Slider( "slider", 0, 100, 50, "%d" ) -- Create slider with integer values and custom format function group:Slider( "slider", 0, 100, 50, function( value ) return "%d%%" end ) -- turns into "50%" Copy -- Create slider with float values group:Slider( "slider", 0.0, 1.0, 0.5, "%.2f" ) -- turns into "0.50" -- Create slider with float values and custom format function group:Slider( "slider", 0.0, 100.0, 50.0, function( value ) if value < 50 then return "Low(%f)" else return "High(%f)" end end ) Copy group:Button( "button", function( this ) Log.Write( "Button '" .. this:Name() .. "' has been clicked." ) end ) Copy group:MultiCombo( "multiCombo", { "item1", "item2", "item3" }, { "item1", "item3" } ) Copy group:MultiSelect( "multiSelect", { { "1", "panorama/images/heroes/icons/npc_dota_hero_antimage_png.vtex_c", false }, { "2", "panorama/images/heroes/icons/npc_dota_hero_antimage_png.vtex_c", false }, }, true ) Copy -- setter group:Disabled( false ) Copy -- getter local isDisabled = group:Disabled() Copy -- setter group:Visible(false) Copy -- getter local isVisible = group:Visible() Copy -- setter group:SearchHidden(false) Copy -- getter local isSearchHidden = group:SearchHidden() sun-brightdesktopmoon --- # CMenuGearAttachment | API v2.0 CMenuGearAttachment metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#name) Name --------------------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#parent) Parent ------------------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CMenuSwitch**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch) | [`**CMenuSliderInt**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint) | [`**CMenuSliderFloat**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat) | [`**CMenuMultiComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox) | [`**CMenuLabel**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel) | [`**CMenuInputBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox) | [`**CMenuComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox) | [`**CMenuBind**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#type) Type --------------------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#open) Open --------------------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#forcelocalization) ForceLocalization ----------------------------------------------------------------------------------------------------------------------------------------------------- circle-info Not recommended for use due to its complexity \`:ForceLocalization(newText):\` \*\*\`nil\`\*\* Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#find) Find --------------------------------------------------------------------------------------------------------------------------- `:Find(widgetName):` [`**CMenuSwitch**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch) | [`**CMenuBind**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind) | [`**CMenuSliderFloat**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat) | [`**CMenuSliderInt**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint) | [`**CMenuColorPicker**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker) | [`**CMenuComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox) | [`**CMenuMultiComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox) | [`**CMenuMultiSelect**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect) | [`**CMenuInputBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox) | [`**CMenuLabel**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel) | `**nil**` Name Type Description **widgetName** `**string**` Finds the widget by name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#switch) Switch ------------------------------------------------------------------------------------------------------------------------------- `:Switch(switchName, [defaultValue], [imageIcon]):` [`**CMenuSwitch**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch) Name Type Description **switchName** `**string**` **defaultValue** `**[?]**` `**boolean**` `(default: false)` **imageIcon** `**[?]**` `**string**` Path to image or FontAwesome icon unicode. `(default: "")` Creates new `CMenuSwitch`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#bind) Bind --------------------------------------------------------------------------------------------------------------------------- `:Bind(bindName, [defaultValue], [imageIcon]):` [`**CMenuBind**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind) Name Type Description **bindName** `**string**` **defaultValue** `**[?]**` [`**Enum.ButtonCode**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.buttoncode) `(default: Enum.ButtonCode.BUTTON_CODE_INVALID)` **imageIcon** `**[?]**` `**string**` Path to image or FontAwesome icon unicode. `(default: "")` Creates new `CMenuBind`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#slider) Slider ------------------------------------------------------------------------------------------------------------------------------- `:Slider(sliderName, minValue, maxValue, defaultValue, [format]):` [`**CMenuSliderInt**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint) Name Type Description **sliderName** `**string**` **minValue** `**integer**` **maxValue** `**integer**` **defaultValue** `**integer**` **format** `**[?]**` `**string**` | `**fun(value: integer):string**` Format string or function to format value. See example. `(default: "%d")` Creates new `CMenuSliderInt` or `CMenuSliderFloat` depents on arg types. `minValue`, `maxValue` and `defaultValue` should be integer to create `CMenuSliderInt`. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#slider-1) Slider --------------------------------------------------------------------------------------------------------------------------------- `:Slider(sliderName, minValue, maxValue, defaultValue, [format]):` [`**CMenuSliderFloat**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat) Name Type Description **sliderName** `**string**` **minValue** `**number**` **maxValue** `**number**` **defaultValue** `**number**` **format** `**[?]**` `**string**` | `**fun(value: number):string**` Format string or function to format value. See example. `(default: "%f")` Creates new `CMenuSliderFloat`. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#colorpicker) ColorPicker ----------------------------------------------------------------------------------------------------------------------------------------- `:ColorPicker(colorPickerName, color, [imageIcon]):` [`**CMenuColorPicker**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker) Name Type Description **colorPickerName** `**string**` **color** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) **imageIcon** `**[?]**` `**string**` Path to image or FontAwesome icon unicode. `(default: "")` Creates new `CMenuColorPicker`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#combo) Combo ----------------------------------------------------------------------------------------------------------------------------- `:Combo(comboName, items, [defaultValue]):` [`**CMenuComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox) Name Type Description **comboName** `**string**` **items** `**string[]**` **defaultValue** `**[?]**` `**integer**` Index of default item. (starts from 0) `(default: 0)` Creates new `CMenuComboBox`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#multicombo) MultiCombo --------------------------------------------------------------------------------------------------------------------------------------- `:MultiCombo(multiComboName, items, enabledItems):` [`**CMenuMultiComboBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox) Name Type Description **multiComboName** `**string**` **items** `**string[]**` **enabledItems** `**string[]**` table of enabled items Creates new `CMenuMultiComboBox`. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#multiselect) MultiSelect ----------------------------------------------------------------------------------------------------------------------------------------- `:MultiSelect(multiSelectName, items, [expanded]):` [`**CMenuMultiSelect**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect) Name Type Description **multiSelectName** `**string**` **items** `**{nameId: string, imagePath: string, isEnabled: boolean}[]**` See example. **expanded** `**[?]**` `**boolean**` false if you want to create MultiSelect in collapsed state. `(default: false)` Creates new `CMenuMultiSelect`. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#input) Input ----------------------------------------------------------------------------------------------------------------------------- `:Input(inputName, [defaultValue], [imageIcon]):` [`**CMenuInputBox**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox) Name Type Description **inputName** `**string**` **defaultValue** `**[?]**` `**string**` `(default: "")` **imageIcon** `**[?]**` `**string**` Path to image or FontAwesome icon unicode. `(default: "")` Creates new `CMenuInputBox`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#label) Label ----------------------------------------------------------------------------------------------------------------------------- `:Label(labelText, [imageIcon]):` [`**CMenuLabel**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel) Name Type Description **labelText** `**string**` **imageIcon** `**[?]**` `**string**` Path to image or FontAwesome icon unicode. `(default: "")` Creates new `CMenuLabel`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#visible) Visible --------------------------------------------------------------------------------------------------------------------------------- `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#visible-1) Visible ----------------------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#example-5) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#disabled) Disabled ----------------------------------------------------------------------------------------------------------------------------------- `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#example-6) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#disabled-1) Disabled ------------------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#example-7) Example [PreviousCMenuComboBoxchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox) [NextCMenuInputBoxchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox) Last updated 6 months ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#forcelocalization) * [Find](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#find) * [Switch](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#switch) * [Bind](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#bind) * [Slider](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#slider) * [Slider](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#slider-1) * [ColorPicker](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#colorpicker) * [Combo](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#combo) * [MultiCombo](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#multicombo) * [MultiSelect](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#multiselect) * [Input](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#input) * [Label](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#label) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment#disabled-1) sun-brightdesktopmoon Copy -- Create slider with integer values gear:Slider( "slider", 0, 100, 50, "%d" ) -- Create slider with integer values and custom format function gear:Slider( "slider", 0, 100, 50, function( value ) return "%d%%" end ) -- turns into "50%" Copy -- Create slider with float values gear:Slider( "slider", 0.0, 1.0, 0.5, "%.2f" ) -- turns into "0.50" -- Create slider with float values and custom format function gear:Slider( "slider", 0.0, 100.0, 50.0, function( value ) if value < 50 then return "Low(%f)" else return "High(%f)" end end ) Copy gear:MultiCombo( "multiCombo", { "item1", "item2", "item3" }, { "item1", "item3" } ) Copy gear:MultiSelect( "multiSelect", { { "1", "panorama/images/heroes/icons/npc_dota_hero_antimage_png.vtex_c", false }, { "2", "panorama/images/heroes/icons/npc_dota_hero_antimage_png.vtex_c", false }, }, true ) Copy -- setter widget:Visible(false) Copy -- getter local isVisible = widget:Visible() Copy -- setter widget:Disabled( false ) Copy -- getter local isDisabled = widget:Disabled() sun-brightdesktopmoon --- # Localizer | API v2.0 Table to work with cheat localizer. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/localizer#get) Get ---------------------------------------------------------------------------------------------------------------- `Localizer.Get(str):` `**string**` Name Type Description **str** `**string**` Returns localized string using current language. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/localizer#regtoken) RegToken -------------------------------------------------------------------------------------------------------------------------- `Localizer.RegToken(str):` `**nil**` Name Type Description **str** `**string**` Registers key (token) string to localizer. [PreviousLoggerchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger) [NextGameLocalizerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer) Last updated 12 months ago * [Get](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/localizer#get) * [RegToken](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/localizer#regtoken) sun-brightdesktopmoon sun-brightdesktopmoon --- # StringBuilder | API v2.0 Efficient string builder for incremental string construction. Backed by a single pre-allocated C++ buffer. Avoids O(n^2) cost of repeated Lua string concatenation. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder#stringbuilder) StringBuilder ---------------------------------------------------------------------------------------------------------------------------------------- `StringBuilder():` `**StringBuilder**` Create a new StringBuilder with default capacity (256 bytes). [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder#append) append -------------------------------------------------------------------------------------------------------------------------- `:append(...):` `**StringBuilder**` Name Type Description **...** `**any**` Append values to the buffer. Each argument is converted to string (strings/numbers handled inline, others via tostring). Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder#appendf) appendf ---------------------------------------------------------------------------------------------------------------------------- `:appendf(fmt, ...):` `**StringBuilder**` Name Type Description **fmt** `**string**` **...** `**any**` Append formatted string with "{}" placeholders replaced left-to-right. Excess placeholders are kept literal. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder#clear) clear ------------------------------------------------------------------------------------------------------------------------ `:clear():` `**StringBuilder**` Clear the buffer contents. Retains allocated memory. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder#tostring) \_\_tostring ---------------------------------------------------------------------------------------------------------------------------------- `:__tostring():` `**string**` Returns the accumulated string. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder#len) \_\_len ------------------------------------------------------------------------------------------------------------------------ `:__len():` `**number**` Returns the byte length of the buffer. [Previoustablechevron-left](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext) [NextChronoschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/chronos) Last updated 23 days ago * [StringBuilder](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder#stringbuilder) * [append](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder#append) * [appendf](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder#appendf) * [clear](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder#clear) * [\_\_tostring](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder#tostring) * [\_\_len](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder#len) sun-brightdesktopmoon sun-brightdesktopmoon --- # Logger | API v2.0 Named logger with per-level methods and per-logger level filtering. Messages are written to the debug log as \[LEVEL\] \[LoggerName\] message. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#logger) Logger ------------------------------------------------------------------------------------------------------------------- `Logger(name):` `**Logger**` Name Type Description **name** `**string**` Create a new Logger with the given name. Default level is DEBUG (all messages pass). [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#debug) debug ----------------------------------------------------------------------------------------------------------------- `:debug(...):` `**nil**` Name Type Description **...** `**any**` Log a debug-level message. Arguments are converted to strings and joined with spaces. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#info) info --------------------------------------------------------------------------------------------------------------- `:info(...):` `**nil**` Name Type Description **...** `**any**` Log an info-level message. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#warning) warning --------------------------------------------------------------------------------------------------------------------- `:warning(...):` `**nil**` Name Type Description **...** `**any**` Log a warning-level message. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#error) error ----------------------------------------------------------------------------------------------------------------- `:error(...):` `**nil**` Name Type Description **...** `**any**` Log an error-level message. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#set_level) set\_level -------------------------------------------------------------------------------------------------------------------------- `:set_level(level):` `**nil**` Name Type Description **level** `**number**` Logger.DEBUG Set the minimum log level. Messages below this level are suppressed. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#get_level) get\_level -------------------------------------------------------------------------------------------------------------------------- `:get_level():` `**number**` Get the current minimum log level. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#get_name) get\_name ------------------------------------------------------------------------------------------------------------------------ `:get_name():` `**string**` Get the logger name. [PreviousLogchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/log) [NextLocalizerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/localizer) Last updated 23 days ago * [Logger](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#logger) * [debug](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#debug) * [info](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#info) * [warning](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#warning) * [error](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#error) * [set\_level](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#set_level) * [get\_level](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#get_level) * [get\_name](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/logger#get_name) sun-brightdesktopmoon sun-brightdesktopmoon --- # Panorama | API v2.0 Table to work with Dota Panorama system. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama#getpanelinfo) GetPanelInfo ------------------------------------------------------------------------------------------------------------------------------------ `Panorama.GetPanelInfo(path, [bLogError], [useJsFunc]):` `**{x:number, y:number, w:number, h:number}**` Name Type Description **path** `**string[]**` Path to the panel. **bLogError** `**[?]**` `**boolean**` | `**nil**` `(default: false)` **useJsFunc** `**[?]**` `**boolean**` | `**nil**` Use js GetPositionWithinWindow function to get position. `(default: false)` Get panel info. GetPanelByName for first argument then FindChild others and accumulate x and y. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama#getpanelbypath) GetPanelByPath ---------------------------------------------------------------------------------------------------------------------------------------- `Panorama.GetPanelByPath(path, [bLogError]):` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Name Type Description **path** `**string[]**` Path to the panel. **bLogError** `**[?]**` `**boolean**` Log error if panel not found. `(default: false)` Get panel by path. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama#getpanelbyname) GetPanelByName ---------------------------------------------------------------------------------------------------------------------------------------- `Panorama.GetPanelByName(id, is_type_name):` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Name Type Description **id** `**string**` Id of the panel. **is\_type\_name** `**boolean**` Check type name instead of names. Get panel by id. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama#createpanel) CreatePanel ---------------------------------------------------------------------------------------------------------------------------------- `Panorama.CreatePanel(type, id, parent, classes, styles):` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) Name Type Description **type** `**string**` panel type to create **id** `**string**` | `**nil**` id of the panel **parent** [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) parent panel **classes** `**string**` | `**nil**` space separated classes to add **styles** `**string**` | `**nil**` styles to set Creates a new panorama panel #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama#example) Example [PreviousPanoramachevron-left](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama) [NextUIPanelchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) Last updated 1 year ago * [GetPanelInfo](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama#getpanelinfo) * [GetPanelByPath](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama#getpanelbypath) * [GetPanelByName](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama#getpanelbyname) * [CreatePanel](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama#createpanel) sun-brightdesktopmoon Copy -- create_panel.lua function create_category() local panel = Panorama.GetPanelByPath({"DOTAHeroesPage", "HeroGrid", "Footer", "ViewModeControls", "Filters"}, true); if (not panel) then print("not on hero grid page"); return end; local filter_category = Panorama.CreatePanel("Panel", nil, panel, "FilterCategory") local filter_category_title = Panorama.CreatePanel("Label", nil, filter_category, "FilterCategoryTitle"); filter_category_title:SetText("Filter"); local items_panel = Panorama.CreatePanel("Panel", nil, filter_category, "FilterCategoryItems") items_panel:AddClasses("FilterCategoryItems") local button_styles = { ["CrossButton"] = 'background-image: url("s2r://panorama/images/control_icons/purgatory_png.vtex");', ["GearButton"] = 'background-image: url("s2r://panorama/images/control_icons/settings_png.vtex");', }; local buttons = {} for id, style in pairs(button_styles) do buttons[id] = Panorama.CreatePanel("Button", id, items_panel, "FilterButton", style) end local button_id, button = next(buttons); -- set up the button events Engine.RunScript(([[\ (function(){\ let ctx = $.GetContextPanel();\ let button = ctx.FindChildTraverse("%s")\ let items_panel = button.GetParent();\ \ let children = items_panel.Children();\ let children_count = children.length;\ for (let i = 0; i < children_count; i++) {\ let item = children[i];\ item.SetPanelEvent("onmouseover", () => $.DispatchEvent("UIShowTextTooltipStyled", item, ("Button Id: " + item.id), "GameModeTooltip"));\ item.SetPanelEvent("onmouseout", () => $.DispatchEvent("UIHideTextTooltip", item));\ item.SetPanelEvent("onactivate", () => $.Msg(item.id + " was clicked!"));\ }\ })()\ ]]):format(button_id), button) end create_category(); sun-brightdesktopmoon --- # Humanizer | API v2.0 Table to work with humanizer. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#isinservercamerabounds) IsInServerCameraBounds ------------------------------------------------------------------------------------------------------------------------------------------------------ `Humanizer.IsInServerCameraBounds(pos):` `**boolean**` Name Type Description **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) position to check Returns `true` if the world position is in server camera bounds. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#getservercamerapos) GetServerCameraPos ---------------------------------------------------------------------------------------------------------------------------------------------- `Humanizer.GetServerCameraPos():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Returns server camera position. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#getclientcamerapos) GetClientCameraPos ---------------------------------------------------------------------------------------------------------------------------------------------- `Humanizer.GetClientCameraPos():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Returns client camera position. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#getservercursorpos) GetServerCursorPos ---------------------------------------------------------------------------------------------------------------------------------------------- `Humanizer.GetServerCursorPos():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Returns the server cursor position. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#getorderqueue) GetOrderQueue ------------------------------------------------------------------------------------------------------------------------------------ `Humanizer.GetOrderQueue():` `**{player: CPlayer, orderType: Enum.UnitOrder, targetIndex: integer, position: Vector, abilityIndex: integer, orderIssuer: Enum.PlayerOrderIssuer, unit: CNPC, orderQueueBehavior: integer, showEffects: boolean, triggerCallBack: boolean, isByMiniMap: boolean, addTime: number }[]**` Returns information about the current humanizer order queue. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#issafetarget) IsSafeTarget ---------------------------------------------------------------------------------------------------------------------------------- `Humanizer.IsSafeTarget(entity):` `**boolean**` Name Type Description **entity** [`**CEntity**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) Returns information about the current humanizer order queue. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#forceuserorderbyminimap) ForceUserOrderByMinimap -------------------------------------------------------------------------------------------------------------------------------------------------------- `Humanizer.ForceUserOrderByMinimap():` `**nil**` Forces current user order by minimap. Must be called in OnPrepareUnitOrder [PreviousConfigchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config) [NextLogchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/log) Last updated 9 months ago * [IsInServerCameraBounds](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#isinservercamerabounds) * [GetServerCameraPos](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#getservercamerapos) * [GetClientCameraPos](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#getclientcamerapos) * [GetServerCursorPos](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#getservercursorpos) * [GetOrderQueue](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#getorderqueue) * [IsSafeTarget](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#issafetarget) * [ForceUserOrderByMinimap](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer#forceuserorderbyminimap) sun-brightdesktopmoon sun-brightdesktopmoon --- # GameLocalizer | API v2.0 Table to work with game localization. Localization tokens are stored in `resource/localization` folder in `pak01_dir.vpk` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer#find) Find ---------------------------------------------------------------------------------------------------------------------- `GameLocalizer.Find(token):` `**string**` Name Type Description **token** `**string**` should be in format `#token` Returns localized string by token or returns empty string if token not found. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer#example) Example Copy GameLocalizer.Find("#DOTA_AutocastAbility5") -- Autocast Ability Ultimate [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer#findability) FindAbility ------------------------------------------------------------------------------------------------------------------------------------ `GameLocalizer.FindAbility(ability_name):` `**string**` Name Type Description **ability\_name** `**string**` Returns localized string by ability name or returns empty string if ability not found. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer#example-1) Example Copy GameLocalizer.FindAbility("antimage_mana_void") -- Mana Void [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer#finditem) FindItem ------------------------------------------------------------------------------------------------------------------------------ `GameLocalizer.FindItem(item_name):` `**string**` Name Type Description **item\_name** `**string**` Returns localized string by item name or returns empty string if item not found. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer#findnpc) FindNPC ---------------------------------------------------------------------------------------------------------------------------- `GameLocalizer.FindNPC(unit_name):` `**string**` Name Type Description **unit\_name** `**string**` Returns localized string by unit name or returns empty string if unit not found. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer#example-3) Example [PreviousLocalizerchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/localizer) [Nexttablechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext) Last updated 12 months ago * [Find](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer#find) * [FindAbility](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer#findability) * [FindItem](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer#finditem) * [FindNPC](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer#findnpc) sun-brightdesktopmoon Copy GameLocalizer.FindItem("item_blink") -- Blink Dagger GameLocalizer.FindItem("item_recipe_arcane_blink") -- Recipe: Arcane Blink Copy GameLocalizer.FindNPC("npc_dota_hero_necrolyte") -- Necrophos sun-brightdesktopmoon --- # Particle | API v2.0 Table to work with particles. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle#create) Create --------------------------------------------------------------------------------------------------------------- `Particle.Create(particle, [attach_type], [entity]):` `**integer**` Name Type Description **particle** `**string**` Particle path **attach\_type** `**[?]**` [`**Enum.ParticleAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.particleattachment) attach\_type Attach type `(default: Enum.ParticleAttachment.PATTACH_WORLDORIGIN)` **entity** `**[?]**` [`**CEntity**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) Entity to own of the particle. If not specified, the local hero will be used. `(default: Players.GetLocal())` Creates a particle and returns its index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle#setcontrolpoint) SetControlPoint --------------------------------------------------------------------------------------------------------------------------------- `Particle.SetControlPoint(particle_index, control_point, value):` `**nil**` Name Type Description **particle\_index** `**integer**` Particle index **control\_point** `**integer**` Control point **value** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Control point value Sets the control point value of a particle. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle#setshoulddraw) SetShouldDraw ----------------------------------------------------------------------------------------------------------------------------- `Particle.SetShouldDraw(particle_index, value):` `**nil**` Name Type Description **particle\_index** `**integer**` Particle index **value** `**boolean**` set value Enables or disables the drawing of a particle. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle#setcontrolpointent) SetControlPointEnt --------------------------------------------------------------------------------------------------------------------------------------- `Particle.SetControlPointEnt(particle_index, control_point, entity, attach_type, attach_name, position, lock_orientation):` `**nil**` Name Type Description **particle\_index** `**integer**` Particle index **control\_point** `**integer**` Control point **entity** [`**CEntity**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) Entity to attach **attach\_type** [`**Enum.ParticleAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.particleattachment) Attach type **attach\_name** `**string**` | `**nil**` Attach name. See `NPC.GetAttachment` function **position** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Control point position **lock\_orientation** `**boolean**` Lock orientation. No idea what it does Sets the control point entity value of a particle. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle#setparticlecontroltransform) SetParticleControlTransform --------------------------------------------------------------------------------------------------------------------------------------------------------- `Particle.SetParticleControlTransform(particle_index, control_point, position, angle):` `**nil**` Name Type Description **particle\_index** `**integer**` Particle index **control\_point** `**integer**` Control point **position** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Control point position **angle** [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Control point angle Sets the control point's position and angle. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle#destroy) Destroy ----------------------------------------------------------------------------------------------------------------- `Particle.Destroy(particle_index):` `**nil**` Name Type Description **particle\_index** `**integer**` Particle index Destroys the particle by index. [PreviousRendering & Visualschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals) [NextRendererchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/renderv1) Last updated 28 days ago * [Create](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle#create) * [SetControlPoint](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle#setcontrolpoint) * [SetShouldDraw](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle#setshoulddraw) * [SetControlPointEnt](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle#setcontrolpointent) * [SetParticleControlTransform](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle#setparticlecontroltransform) * [Destroy](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/particle#destroy) sun-brightdesktopmoon sun-brightdesktopmoon --- # Bottle | API v2.0 Table to work with `CBottle`. `**CBottle**` extends `**CItem**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/bottle#getrunetype) GetRuneType ------------------------------------------------------------------------------------------------------ `Bottle.GetRuneType(bottle):` [`**Enum.RuneType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.runetype) Name Type Description **bottle** [`**CBottle**`](https://uczone.gitbook.io/api-v2.0/game-components/core/bottle) Returns the rune inside the bottle. [PreviousCampchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/camp) [NextCourierchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/courier) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # Vambrace | API v2.0 Table to work with `CVambrace`.`**CVambrace**` extends `**CItem**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/vambrace#getstats) GetStats -------------------------------------------------------------------------------------------------- `Vambrace.GetStats(vambrace):` [`**Enum.Attributes**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.attributes) Name Type Description **vambrace** [`**CVambrace**`](https://uczone.gitbook.io/api-v2.0/game-components/core/vambrace) Returns selected `Enum.Attributes` attribute. [PreviousTreechevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/tree) [NextCampchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/camp) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # ConVar | API v2.0 Table to work with `CConVars`. ConVars are game variable that can be used to retrieve or change some game engine settings. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#find) Find ----------------------------------------------------------------------------------------------- `ConVar.Find(name):` [`**CConVar**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar) | `**nil**` Name Type Description **name** `**string**` Returns the found ConVar. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#example) Example Copy local convar = ConVar.Find("dota_camera_distance") local camera_distance = ConVar.GetFloat(convar) [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#getstring) GetString --------------------------------------------------------------------------------------------------------- `ConVar.GetString(convar):` `**string**` Name Type Description **convar** [`**CConVar**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar) Returns string value of the Convar [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#getint) GetInt --------------------------------------------------------------------------------------------------- `ConVar.GetInt(convar):` `**integer**` Name Type Description **convar** [`**CConVar**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar) Returns int value of the Convar [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#getfloat) GetFloat ------------------------------------------------------------------------------------------------------- `ConVar.GetFloat(convar):` `**number**` Name Type Description **convar** [`**CConVar**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar) Returns float value of the Convar [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#getbool) GetBool ----------------------------------------------------------------------------------------------------- `ConVar.GetBool(convar):` `**boolean**` Name Type Description **convar** [`**CConVar**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar) Returns boolean value of the Convar [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#setstring) SetString --------------------------------------------------------------------------------------------------------- `ConVar.SetString(convar, value):` `**nil**` Name Type Description **convar** [`**CConVar**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar) **value** `**string**` Assigns new string value to the ConVar [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#setint) SetInt --------------------------------------------------------------------------------------------------- `ConVar.SetInt(convar, value):` `**nil**` Name Type Description **convar** [`**CConVar**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar) **value** `**integer**` Assigns new int value to the ConVar [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#setfloat) SetFloat ------------------------------------------------------------------------------------------------------- `ConVar.SetFloat(convar, value):` `**nil**` Name Type Description **convar** [`**CConVar**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar) **value** `**number**` Assigns new float value to the ConVar [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#setbool) SetBool ----------------------------------------------------------------------------------------------------- `ConVar.SetBool(convar, value):` `**nil**` Name Type Description **convar** [`**CConVar**`](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar) **value** `**boolean**` Assigns new boolean value to the ConVar [PreviousFogOfWarchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/fogofwar) [NextNetworking & APIschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis) Last updated 12 months ago * [Find](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#find) * [GetString](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#getstring) * [GetInt](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#getint) * [GetFloat](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#getfloat) * [GetBool](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#getbool) * [SetString](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#setstring) * [SetInt](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#setint) * [SetFloat](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#setfloat) * [SetBool](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/convar#setbool) sun-brightdesktopmoon sun-brightdesktopmoon --- # PowerTreads | API v2.0 Table to work with `CPowerTreads`.`**CTower**` extends `**CItem**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/powertreads#getstats) GetStats ----------------------------------------------------------------------------------------------------- `PowerTreads.GetStats(power_tread):` [`**Enum.Attributes**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.attributes) Name Type Description **power\_tread** [`**CPowerTreads**`](https://uczone.gitbook.io/api-v2.0/game-components/core/powertreads) Returns selected `Enum.Attributes` attribute. [PreviousPhysicalItemchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/physicalitem) [NextTierTokenchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/tiertoken) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # MiniMap | API v2.0 Table to work with in-game minimap. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#ping) Ping ---------------------------------------------------------------------------------------------------------- `MiniMap.Ping(pos, type):` `**nil**` Name Type Description **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) world position to ping **type** [`**Enum.PingType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.pingtype) ping type Pings on the minimap. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#sendline) SendLine ------------------------------------------------------------------------------------------------------------------ `MiniMap.SendLine(pos, initial, clientside):` `**nil**` Name Type Description **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) world position to draw line to **initial** `**boolean**` start a new line, otherwise continue the last one **clientside** `**boolean**` draw only for local player Draws a line on the minimap. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#sendline-1) SendLine -------------------------------------------------------------------------------------------------------------------- `MiniMap.SendLine(x, y, initial, clientside):` `**nil**` Name Type Description **x** `**number**` x world position to draw line **y** `**number**` y world position to draw line **initial** `**boolean**` start a new line, otherwise continue the last one **clientside** `**boolean**` draw only for local player Draws a line on the minimap. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#drawcircle) DrawCircle ---------------------------------------------------------------------------------------------------------------------- `MiniMap.DrawCircle(pos, [r], [g], [b], [a], [size]):` `**nil**` Name Type Description **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) world position to draw circle **r** `**[?]**` `**integer**` red color `(default: 255)` **g** `**[?]**` `**integer**` green color `(default: 255)` **b** `**[?]**` `**integer**` blue color `(default: 255)` **a** `**[?]**` `**integer**` alpha color `(default: 255)` **size** `**[?]**` `**number**` circle size `(default: 800)` Draws a circle on the minimap. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#drawheroicon) DrawHeroIcon -------------------------------------------------------------------------------------------------------------------------- `MiniMap.DrawHeroIcon(unitName, pos, [r], [g], [b], [a], [size]):` `**nil**` Name Type Description **unitName** `**string**` unit name to draw icon. Can get it from `NPC.GetUnitName` **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) world position to draw icon **r** `**[?]**` `**integer**` red color `(default: 255)` **g** `**[?]**` `**integer**` green color `(default: 255)` **b** `**[?]**` `**integer**` blue color `(default: 255)` **a** `**[?]**` `**integer**` alpha color `(default: 255)` **size** `**[?]**` `**number**` icon size `(default: 800)` Draws a hero icon on the minimap. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#drawiconbyname) DrawIconByName ------------------------------------------------------------------------------------------------------------------------------ `MiniMap.DrawIconByName(iconName, pos, [r], [g], [b], [a], [size]):` `**nil**` Name Type Description **iconName** `**string**` could get it from game\\dota\\pak01\_dir.vpk (scripts\\mod\_textures.txt). **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) world position to draw icon **r** `**[?]**` `**integer**` red color `(default: 255)` **g** `**[?]**` `**integer**` green color `(default: 255)` **b** `**[?]**` `**integer**` blue color `(default: 255)` **a** `**[?]**` `**integer**` alpha color `(default: 255)` **size** `**[?]**` `**number**` icon size `(default: 800)` Draws a icon on the minimap. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#getmouseposinworld) GetMousePosInWorld -------------------------------------------------------------------------------------------------------------------------------------- `MiniMap.GetMousePosInWorld():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Returns world position the mouse on the minimap, if the mouse is not on the minimap, it will return (0,0,0). [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#iscursoronminimap) IsCursorOnMinimap ------------------------------------------------------------------------------------------------------------------------------------ `MiniMap.IsCursorOnMinimap():` `**boolean**` Returns `true` if the mouse is on the minimap. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#getminimaptoworld) GetMinimapToWorld ------------------------------------------------------------------------------------------------------------------------------------ `MiniMap.GetMinimapToWorld(ScreenX, ScreenY):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **ScreenX** `**integer**` **ScreenY** `**integer**` Returns world position from minimap position. The same as `GetMousePosInWorld`, but you can pass any position on screen, not only mouse position. [PreviousRenderchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/renderv2) [NextPanoramachevron-right](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama) Last updated 12 months ago * [Ping](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#ping) * [SendLine](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#sendline) * [SendLine](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#sendline-1) * [DrawCircle](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#drawcircle) * [DrawHeroIcon](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#drawheroicon) * [DrawIconByName](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#drawiconbyname) * [GetMousePosInWorld](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#getmouseposinworld) * [IsCursorOnMinimap](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#iscursoronminimap) * [GetMinimapToWorld](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/minimap#getminimaptoworld) sun-brightdesktopmoon sun-brightdesktopmoon --- # CMenuBind | API v2.0 CMenuBind metatable. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#name) Name ----------------------------------------------------------------------------------------------------------------- `:Name():` `**string**` Returns widget's name. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#parent) Parent --------------------------------------------------------------------------------------------------------------------- `:Parent():` [`**CMenuGroup**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup) | [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Returns widget's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#type) Type ----------------------------------------------------------------------------------------------------------------- `:Type():` [`**Enum.WidgetType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.widgettype) Returns widget's type. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#open) Open ----------------------------------------------------------------------------------------------------------------- `:Open():` `**nil**` Opens parent tabs. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#forcelocalization) ForceLocalization ------------------------------------------------------------------------------------------------------------------------------------------- circle-info Not recommended for use due to its complexity `:ForceLocalization(newText):` `**nil**` Name Type Description **newText** `**string**` Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#tooltip) ToolTip ----------------------------------------------------------------------------------------------------------------------- `:ToolTip(newText):` `**string**` Name Type Description **newText** `**string**` Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#tooltip-1) ToolTip ------------------------------------------------------------------------------------------------------------------------- `:ToolTip():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#visible) Visible ----------------------------------------------------------------------------------------------------------------------- `:Visible(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets visible state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#visible-1) Visible ------------------------------------------------------------------------------------------------------------------------- `:Visible():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#disabled) Disabled ------------------------------------------------------------------------------------------------------------------------- `:Disabled(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets disabled state. Depends on argument. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#disabled-1) Disabled --------------------------------------------------------------------------------------------------------------------------- `:Disabled():` `**boolean**` #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#unsafe) Unsafe --------------------------------------------------------------------------------------------------------------------- `:Unsafe(value):` `**nil**` Name Type Description **value** `**boolean**` Gets or sets unsafe state. Unsafe widgets have warning sign. Depends on argument. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#unsafe-1) Unsafe ----------------------------------------------------------------------------------------------------------------------- `:Unsafe():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#get) Get --------------------------------------------------------------------------------------------------------------- `:Get([idx]):` [`**Enum.ButtonCode**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.buttoncode) Name Type Description **idx** `**[?]**` `**0**` | `**1**` index of the button to get value from `(default: 0)` Returns widget's value. To get both of the buttons use `Buttons` method. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#set) Set --------------------------------------------------------------------------------------------------------------- `:Set(key1, [key2]):` `**nil**` Name Type Description **key1** [`**Enum.ButtonCode**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.buttoncode) primary button code **key2** `**[?]**` [`**Enum.ButtonCode**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.buttoncode) secondary button code `(default: Enum.ButtonCode.KEY_NONE)` Sets widget's value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#buttons) Buttons ----------------------------------------------------------------------------------------------------------------------- `:Buttons():` [`**Enum.ButtonCode**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.buttoncode) , [`**Enum.ButtonCode**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.buttoncode) Returns widget's buttons value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#isdown) IsDown --------------------------------------------------------------------------------------------------------------------- `:IsDown():` `**boolean**` Returns `true` when the key or both keys is down. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#ispressed) IsPressed --------------------------------------------------------------------------------------------------------------------------- `:IsPressed():` `**boolean**` Returns `true` when the key or both keys is pressed for the first time. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#istoggled) IsToggled --------------------------------------------------------------------------------------------------------------------------- `:IsToggled():` `**boolean**` Bind stores it's toggle state and switches it when the key is pressed. This method returns this state. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#settoggled) SetToggled ----------------------------------------------------------------------------------------------------------------------------- `:SetToggled(value):` `**nil**` Name Type Description **value** `**boolean**` Sets the toggle state manually. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#image) Image ------------------------------------------------------------------------------------------------------------------- `:Image(imagePath, [offset]):` `**nil**` Name Type Description **imagePath** `**string**` Path to the image. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets widget's image. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#imagehandle) ImageHandle ------------------------------------------------------------------------------------------------------------------------------- `:ImageHandle(imageHandle, [offset]):` `**nil**` Name Type Description **imageHandle** `**integer**` **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional image offset. `(default: {0.0, 0.0})` Sets tab's image by already created handle. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#icon) Icon ----------------------------------------------------------------------------------------------------------------- `:Icon(icon, [offset]):` `**nil**` Name Type Description **icon** `**string**` icon unicode. **offset** `**[?]**` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Optional icon offset. `(default: {0.0, 0.0})` Sets widget's icon. [Icons listarrow-up-right](https://fontawesome.com/search?o=r&s=solid&f=classic) #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#setcallback) SetCallback ------------------------------------------------------------------------------------------------------------------------------- circle-info Multiple callbacks could be set. `:SetCallback(callback, [forceCall]):` `**nil**` Name Type Description **callback** `**fun(this: CMenuBind):nil**` function to be called on widget change. **forceCall** `**[?]**` `**boolean**` true if you want to call callback on widget creation. `(default: false)` Sets widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#unsetcallback) UnsetCallback ----------------------------------------------------------------------------------------------------------------------------------- `:UnsetCallback(callback):` `**nil**` Name Type Description **callback** `**fun(this: CMenuBind):nil**` function to be removed from widget's callbacks. Removes widget's on change callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#setkeycallback) SetKeyCallback ------------------------------------------------------------------------------------------------------------------------------------- circle-info Multiple callbacks could be set. \`:SetKeyCallback(callback):\` \*\*\`nil\`\*\* Name Type Description **callback** `**fun(this: CMenuBind, key: Enum.ButtonCode, event: Enum.EKeyEvent):nil**` function to be called on key press/release. Sets widget's on key press/release callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#unsetkeycallback) UnsetKeyCallback ----------------------------------------------------------------------------------------------------------------------------------------- `:UnsetKeyCallback(callback):` `**nil**` Name Type Description **callback** `**fun(this: CMenuBind, key: Enum.ButtonCode, event: Enum.EKeyEvent):nil**` function to be removed. Removes widget's on key press/release callback. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#colorpicker) ColorPicker ------------------------------------------------------------------------------------------------------------------------------- `:ColorPicker(name, color):` [`**CMenuColorPickerAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment) Name Type Description **name** `**string**` Name of the attachment. **color** [`**Color**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/color) Default color. Creates `CMenuColorPickerAttachment` and attaches it to the widget. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#gear) Gear ----------------------------------------------------------------------------------------------------------------- `:Gear(name, [gearIcon], [useSmallFont]):` [`**CMenuGearAttachment**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment) Name Type Description **name** `**string**` Name of the attachment. **gearIcon** `**[?]**` `**string**` Gear FontAwesome icon. `(default: "\uf013")` **useSmallFont** `**[?]**` `**boolean**` Use small font for gear icon. `(default: true)` Creates `CMenuGearAttachment` and attaches it to the widget. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#properties) Properties ----------------------------------------------------------------------------------------------------------------------------- `:Properties([name], [value], [markAsToggle]):` `**nil**` Name Type Description **name** `**[?]**` `**string**` Overridden name to display in bind list. `(default: nil)` **value** `**[?]**` `**string**` Overridden value to display alongside the name in the bind list. This can be used to provide additional context about the bind. `(default: nil)` **markAsToggle** `**[?]**` `**boolean**` Indicates whether the bind should be marked as a toggle, which is particularly useful if the bind's functionality includes toggling states. Recommended to be used in conjunction with the IsToggled(). `(default: false)` Updates the properties of a widget for display in the bind list. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#showinbindisland) ShowInBindIsland ----------------------------------------------------------------------------------------------------------------------------------------- `:ShowInBindIsland(newStatus):` `**boolean**` Name Type Description **newStatus** `**boolean**` Gets or sets the visibility of the bind in the bind island. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#showinbindisland-1) ShowInBindIsland ------------------------------------------------------------------------------------------------------------------------------------------- `:ShowInBindIsland():` `**boolean**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#mousebinding) MouseBinding --------------------------------------------------------------------------------------------------------------------------------- `:MouseBinding(newStatus):` `**boolean**` Name Type Description **newStatus** `**boolean**` Gets or sets the ability to bind the mouse button. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#mousebinding-1) MouseBinding ----------------------------------------------------------------------------------------------------------------------------------- `:MouseBinding():` `**boolean**` [PreviousCMenuMultiSelectchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect) [NextCMenuLabelchevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel) Last updated 1 month ago * [Name](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#name) * [Parent](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#parent) * [Type](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#type) * [Open](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#open) * [ForceLocalization](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#forcelocalization) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#tooltip) * [ToolTip](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#tooltip-1) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#visible) * [Visible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#visible-1) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#disabled) * [Disabled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#disabled-1) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#unsafe) * [Unsafe](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#unsafe-1) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#get) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#set) * [Buttons](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#buttons) * [IsDown](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#isdown) * [IsPressed](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#ispressed) * [IsToggled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#istoggled) * [SetToggled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#settoggled) * [Image](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#image) * [ImageHandle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#imagehandle) * [Icon](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#icon) * [SetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#setcallback) * [UnsetCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#unsetcallback) * [SetKeyCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#setkeycallback) * [UnsetKeyCallback](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#unsetkeycallback) * [ColorPicker](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#colorpicker) * [Gear](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#gear) * [Properties](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#properties) * [ShowInBindIsland](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#showinbindisland) * [ShowInBindIsland](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#showinbindisland-1) * [MouseBinding](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#mousebinding) * [MouseBinding](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind#mousebinding-1) sun-brightdesktopmoon Copy -- setter widget:Visible(false) Copy -- getter local isVisible = widget:Visible() Copy -- setter widget:Disabled( false ) Copy -- getter local isDisabled = widget:Disabled() Copy --https://fontawesome.com/icons/user?f=classic&s=solid switch:Icon("\u{f007}") sun-brightdesktopmoon --- # TierToken | API v2.0 Table to work with `CTierToken`.`**CTierToken**` extends `**CItem**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/tiertoken#getchoices) GetChoices ------------------------------------------------------------------------------------------------------- `TierToken.GetChoices(tier_token):` `**integer[]**` Name Type Description **tier\_token** [`**CTierToken**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tiertoken) The `TierToken` to get the choices from. Returns the choices (ability ids) of the `CTierToken`. [PreviousPowerTreadschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/powertreads) [NextGame Enginechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # Tower | API v2.0 Table to work with `CTower`.`**CTower**` extends `**CNPC**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/tower#getattacktarget) GetAttackTarget ------------------------------------------------------------------------------------------------------------- `Tower.GetAttackTarget(tower):` [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) | `**nil**` Name Type Description **tower** [`**CTower**`](https://uczone.gitbook.io/api-v2.0/game-components/core/tower) Returns `CNPC` that is attacked by the tower now. [PreviousRunechevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/rune) [NextTreechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/tree) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # DrunkenBrawler | API v2.0 Table to work with `CDrunkenBrawler`.`**CDrunkenBrawler**` extends `**CAbility**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/drunkenbrawler#getstate) GetState -------------------------------------------------------------------------------------------------------- `DrunkenBrawler.GetState(ability):` [`**Enum.DrunkenBrawlerState**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.drunkenbrawlerstate) Name Type Description **ability** [`**CDrunkenBrawler**`](https://uczone.gitbook.io/api-v2.0/game-components/core/drunkenbrawler) Returns the state of the CDrunkenBrawler ability. [PreviousCourierchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/courier) [NextPhysicalItemchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/physicalitem) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # PhysicalItem | API v2.0 Table to work with `CPhysicalItem`.`**CPhysicalItem**` extends `**CEntity**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/physicalitem#getitem) GetItem ---------------------------------------------------------------------------------------------------- `PhysicalItem.GetItem(physical_item):` [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) | `**nil**` Name Type Description **physical\_item** [`**CPhysicalItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/physicalitem) Returns `CItem` object from `CPhysicalItem`. [PreviousDrunkenBrawlerchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/drunkenbrawler) [NextPowerTreadschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/powertreads) Last updated 12 months ago sun-brightdesktopmoon sun-brightdesktopmoon --- # GridNav | API v2.0 Table to work with in-game navigation API. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#createnpcmap) CreateNpcMap ---------------------------------------------------------------------------------------------------------------- circle-info You should always call \`GridNav.ReleaseNpcMap\` after you done with your build pathing \`GridNav.CreateNpcMap(\[excluded\_npcs\], \[includeTempTrees\], \[customCollisionSizes\]):\` \[\*\*\`GridNavNpcMap\`\*\*\](GridNavNpcMap.md) Name Type Description **excluded\_npcs** `**[?]**` [`**CEntity[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) | `**nil**` table with npc to exclude from the map. for example you want to exclude local hero if you build path from local hero position `(default: nil)` **includeTempTrees** `**[?]**` `**boolean**` `true` if you want include temp trees to the map e.g. furion's 1st spell, iron branch `(default: true)` **customCollisionSizes** `**[?]**` `**table**` | `**nil**` table where key is entity userdata and value is {left, top, right, bottom} offsets from entity position `(default: nil)` Creates a new `GridNavNpcMap` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#releasenpcmap) ReleaseNpcMap ------------------------------------------------------------------------------------------------------------------ `GridNav.ReleaseNpcMap(npc_map):` `**nil**` Name Type Description **npc\_map** [`**GridNavNpcMap**`arrow-up-right](https://github.com/Boyarinov/gitbook-doc-parser/blob/main/generated/GridNavNpcMap.md) map to release to release Releases allocated memory for `GridNavNpcMap` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#istraversable) IsTraversable ------------------------------------------------------------------------------------------------------------------ `GridNav.IsTraversable(pos, [flag]):` `**boolean**`, `**integer**` Name Type Description **pos** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) position to check **flag** `**[?]**` `**number**` flag to check `(default: 1)` Returns `true` if the world position is traversable. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#buildpath) BuildPath ---------------------------------------------------------------------------------------------------------- `GridNav.BuildPath(start, end_, [ignoreTrees], [npc_map]):` [`**Vector[]**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **start** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) position to start **end\_** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) position to end **ignoreTrees** `**[?]**` `**boolean**` `true` if you want to exclude static trees from the pathing `(default: false)` **npc\_map** `**[?]**` [`**GridNavNpcMap**`arrow-up-right](https://github.com/Boyarinov/gitbook-doc-parser/blob/main/generated/GridNavNpcMap.md) | `**nil**` map with the npc's positions which works as additional mask for terrain map `(default: nil)` Build path from start to end. Returns an array with builded positions. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#istraversablefromto) IsTraversableFromTo ------------------------------------------------------------------------------------------------------------------------------ `GridNav.IsTraversableFromTo(start, end_, [ignoreTrees], [npc_map]):` `**boolean**` Name Type Description **start** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) position to start **end\_** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) position to end **ignoreTrees** `**[?]**` `**boolean**` `true` if you want to exclude static trees from the pathing `(default: false)` **npc\_map** `**[?]**` [`**GridNavNpcMap**`arrow-up-right](https://github.com/Boyarinov/gitbook-doc-parser/blob/main/generated/GridNavNpcMap.md) | `**nil**` map with the npc's positions which works as additional mask for terrain map `(default: nil)` Lite version of GridNav.BuildPath function which just cheking if the path is exists. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#debugrender) DebugRender -------------------------------------------------------------------------------------------------------------- `GridNav.DebugRender([grid_range], [npc_map], [render_cell_flags]):` `**boolean**` Name Type Description **grid\_range** `**[?]**` `**integer**` grid radius in "cell units" from Vector(0,0,0) `(default: 50)` **npc\_map** `**[?]**` [`**GridNavNpcMap**`arrow-up-right](https://github.com/Boyarinov/gitbook-doc-parser/blob/main/generated/GridNavNpcMap.md) | `**nil**` map with the npc's positions which works as additional mask for terrain map `(default: nil)` **render\_cell\_flags** `**[?]**` `**boolean**` render the flags value for each not approachable cell (don't think you ever want to see this numbers, so ignore this arg) `(default: false)` Debug render of current GridNav with GridNavNpcMap (if provided) [PreviousGlobalVarschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars) [NextInputchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input) Last updated 10 months ago * [CreateNpcMap](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#createnpcmap) * [ReleaseNpcMap](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#releasenpcmap) * [IsTraversable](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#istraversable) * [BuildPath](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#buildpath) * [IsTraversableFromTo](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#istraversablefromto) * [DebugRender](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav#debugrender) sun-brightdesktopmoon Copy -- build_path.lua return { OnUpdate = function() local ignore_trees = false; local my_hero = Heroes.GetLocal(); local start_pos = Entity.GetAbsOrigin(my_hero); local end_pos = Input.GetWorldCursorPos(); -- create npc map with the temp trees but with no local hero in it local npc_map = GridNav.CreateNpcMap({Heroes.GetLocal()}, not ignore_trees); local path = GridNav.BuildPath(start_pos, end_pos, ignore_trees, npc_map); local prev_x, prev_y = nil, nil; for i, pos in pairs(path) do local x, y, visible = Renderer.WorldToScreen(pos); if (prev_x and visible) then Renderer.SetDrawColor(255, 255, 255, 255); Renderer.DrawLine(prev_x, prev_y, x, y); end prev_x, prev_y = x, y; end -- releasing allocated npc map after we done with build pathing GridNav.ReleaseNpcMap(npc_map) end } sun-brightdesktopmoon --- # Config | API v2.0 Table to work with configs that are stored in the `configs` folder with the `.ini` extention. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config#readint) ReadInt --------------------------------------------------------------------------------------------------------------------- `Config.ReadInt(config, key, [def]):` `**integer**` Name Type Description **config** `**string**` The config file name. **key** `**string**` The key to read. **def** `**[?]**` `**integer**` The default value to return if the key is not found. `(default: 0)` Read an integer from a config file. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config#readfloat) ReadFloat ------------------------------------------------------------------------------------------------------------------------- `Config.ReadFloat(config, key, [def]):` `**number**` Name Type Description **config** `**string**` The config file name. **key** `**string**` The key to read. **def** `**[?]**` `**number**` The default value to return if the key is not found. `(default: 0.0)` Read a float from a config file. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config#readstring) ReadString --------------------------------------------------------------------------------------------------------------------------- `Config.ReadString(config, key, [def]):` `**string**` Name Type Description **config** `**string**` The config file name. **key** `**string**` The key to read. **def** `**[?]**` `**string**` The default value to return if the key is not found. `(default: "")` Read a string from a config file. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config#writeint) WriteInt ----------------------------------------------------------------------------------------------------------------------- `Config.WriteInt(config, key, value):` `**nil**` Name Type Description **config** `**string**` The config file name. **key** `**string**` The key to write. **value** `**integer**` The value to write. Write an integer to a config file. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config#writefloat) WriteFloat --------------------------------------------------------------------------------------------------------------------------- `Config.WriteFloat(config, key, value):` `**nil**` Name Type Description **config** `**string**` The config file name. **key** `**string**` The key to write. **value** `**number**` The value to write. Write a float to a config file. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config#writestring) WriteString ----------------------------------------------------------------------------------------------------------------------------- `Config.WriteString(config, key, value):` `**nil**` Name Type Description **config** `**string**` The config file name. **key** `**string**` The key to write. **value** `**string**` The value to write. Write a string to a config file. [PreviousConfiguration & Utilitieschevron-left](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities) [NextHumanizerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/humanizer) Last updated 12 months ago * [ReadInt](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config#readint) * [ReadFloat](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config#readfloat) * [ReadString](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config#readstring) * [WriteInt](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config#writeint) * [WriteFloat](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config#writefloat) * [WriteString](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/config#writestring) sun-brightdesktopmoon sun-brightdesktopmoon --- # Input | API v2.0 Table to work with input system. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#getworldcursorpos) GetWorldCursorPos ------------------------------------------------------------------------------------------------------------------------ `Input.GetWorldCursorPos():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Returns world cursor position. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#getcursorpos) GetCursorPos -------------------------------------------------------------------------------------------------------------- `Input.GetCursorPos():` `**number**`, `**number**` Returns screen cursor position (x, y). See example. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#example) Example Copy local x, y = Input.GetCursorPos() [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#iscursorinrect) IsCursorInRect ------------------------------------------------------------------------------------------------------------------ `Input.IsCursorInRect(x, y, w, h):` `**boolean**` Name Type Description **x** `**number**` x position **y** `**number**` **w** `**number**` width **h** `**number**` height Returns `true` if cursor is in rect. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#iscursorinbounds) IsCursorInBounds ---------------------------------------------------------------------------------------------------------------------- `Input.IsCursorInBounds(x0, y0, x1, y1):` `**boolean**` Name Type Description **x0** `**number**` **y0** `**number**` **x1** `**number**` **y1** `**number**` Returns `true` if cursor is in bounds. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#getnearestunittocursor) GetNearestUnitToCursor ---------------------------------------------------------------------------------------------------------------------------------- circle-info Excludes not visible, illusions and dead units. `Input.GetNearestUnitToCursor(teamNum, teamType):` [`**CNPC**`](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) | `**nil**` Name Type Description **teamNum** [`**Enum.TeamNum**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.teamnum) team number. Could be get from `Entity.GetTeamNum` **teamType** [`**Enum.TeamType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.teamtype) team type to search relative to teamNum param Returns nearest unit to cursor. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#getnearestherotocursor) GetNearestHeroToCursor ---------------------------------------------------------------------------------------------------------------------------------- circle-info Excludes not visible, illusions and dead heroes. `Input.GetNearestHeroToCursor(teamNum, teamType):` [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) | `**nil**` Name Type Description **teamNum** [`**Enum.TeamNum**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.teamnum) team number. Could be get from `Entity.GetTeamNum` **teamType** [`**Enum.TeamType**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.teamtype) team type to search relative to teamNum param Returns nearest hero to cursor. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#isinputcaptured) IsInputCaptured -------------------------------------------------------------------------------------------------------------------- `Input.IsInputCaptured():` `**boolean**` Returns `true` if input is captured. e.g. opened console, chat, shop. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#iskeydown) IsKeyDown -------------------------------------------------------------------------------------------------------- `Input.IsKeyDown(KeyCode):` `**boolean**` Name Type Description **KeyCode** [`**Enum.ButtonCode**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.buttoncode) Returns `true` if key is down. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#iskeydownonce) IsKeyDownOnce ---------------------------------------------------------------------------------------------------------------- circle-info This function will return \`true\` only once per key press. \`Input.IsKeyDownOnce(KeyCode):\` \*\*\`boolean\`\*\* Name Type Description **KeyCode** [`**Enum.ButtonCode**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.buttoncode) Return `true` if key is down once. [PreviousGridNavchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav) [NextWorldchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/world) Last updated 12 months ago * [GetWorldCursorPos](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#getworldcursorpos) * [GetCursorPos](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#getcursorpos) * [IsCursorInRect](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#iscursorinrect) * [IsCursorInBounds](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#iscursorinbounds) * [GetNearestUnitToCursor](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#getnearestunittocursor) * [GetNearestHeroToCursor](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#getnearestherotocursor) * [IsInputCaptured](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#isinputcaptured) * [IsKeyDown](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#iskeydown) * [IsKeyDownOnce](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/input#iskeydownonce) sun-brightdesktopmoon sun-brightdesktopmoon --- # Camp | API v2.0 Table to work with `CCamp`.`**CCamp**` extends `**CEntity**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/camp#gettype) GetType -------------------------------------------------------------------------------------------- `Camp.GetType(camp):` `**integer**` Name Type Description **camp** [`**CCamp**`](https://uczone.gitbook.io/api-v2.0/game-components/core/camp) The camp to check. Returns the camp type. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/camp#getcampbox) GetCampBox -------------------------------------------------------------------------------------------------- `Camp.GetCampBox(camp):` `**{min:Vector, max:Vector}**` Name Type Description **camp** [`**CCamp**`](https://uczone.gitbook.io/api-v2.0/game-components/core/camp) The camp to check. Returns camp box as a table with **min** and **max** fields(**Vector**). [PreviousVambracechevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/vambrace) [NextBottlechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/bottle) Last updated 12 months ago * [GetType](https://uczone.gitbook.io/api-v2.0/game-components/core/camp#gettype) * [GetCampBox](https://uczone.gitbook.io/api-v2.0/game-components/core/camp#getcampbox) sun-brightdesktopmoon sun-brightdesktopmoon --- # GameRules | API v2.0 Table to work with GameRules. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getservergamestate) GetServerGameState ------------------------------------------------------------------------------------------------------------------------------ `GameRules.GetServerGameState():` [`**Enum.GameState**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.gamestate) Returns the current server game state. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgamestate) GetGameState ------------------------------------------------------------------------------------------------------------------ `GameRules.GetGameState():` [`**Enum.GameState**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.gamestate) Returns the current game state. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgamemode) GetGameMode ---------------------------------------------------------------------------------------------------------------- `GameRules.GetGameMode():` [`**Enum.GameMode**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.gamemode) Returns the current game mode. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getpregamestarttime) GetPreGameStartTime -------------------------------------------------------------------------------------------------------------------------------- circle-info Pregame time is the time before the game starts, e.g. ban phase, pick time. `GameRules.GetPreGameStartTime():` `**number**` Returns pregame duration or 0 if now is pregame time. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgamestarttime) GetGameStartTime -------------------------------------------------------------------------------------------------------------------------- circle-info Game start time is 0:00 on ingame timer. `GameRules.GetGameStartTime():` `**number**` Returns game start time duration or 0 if game is not start yet. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgameendtime) GetGameEndTime ---------------------------------------------------------------------------------------------------------------------- `GameRules.GetGameEndTime():` `**number**` Returns game end time or 0 if game is not end yet. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgameloadtime) GetGameLoadTime ------------------------------------------------------------------------------------------------------------------------ `GameRules.GetGameLoadTime():` `**number**` No idea what this function does. Returns 0 in all cases what I've tested. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgametime) GetGameTime ---------------------------------------------------------------------------------------------------------------- circle-info Can be used to calculate time in an in-game timer. See the example. `GameRules.GetGameTime():` `**number**` Returns the current game time. Starts counting from pregame state. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#ispaused) IsPaused ---------------------------------------------------------------------------------------------------------- `GameRules.IsPaused():` `**boolean**` Returns `true` if game is paused. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#istemporaryday) IsTemporaryDay ---------------------------------------------------------------------------------------------------------------------- circle-info Example: Phoenix's Supernova. `GameRules.IsTemporaryDay():` `**boolean**` Returns `true` if it's temporary day. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#istemporarynight) IsTemporaryNight -------------------------------------------------------------------------------------------------------------------------- circle-info Example: Luna's Eclipse. `GameRules.IsTemporaryNight():` `**boolean**` Returns `true` if it's temporary night. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#isnightstalkernight) IsNightstalkerNight -------------------------------------------------------------------------------------------------------------------------------- `GameRules.IsNightstalkerNight():` `**boolean**` Returns `true` if it's nightstalker's night. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getmatchid) GetMatchID -------------------------------------------------------------------------------------------------------------- `GameRules.GetMatchID():` `**integer**` Returns current match id. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getlobbyid) GetLobbyID -------------------------------------------------------------------------------------------------------------- `GameRules.GetLobbyID():` `**integer**` Returns current lobby id. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgoodglyphcd) GetGoodGlyphCD ---------------------------------------------------------------------------------------------------------------------- circle-info Could be less than current game time if glyph is already available. `GameRules.GetGoodGlyphCD():` `**number**` Returns game time when next radiant glyph will be available. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getbadglyphcd) GetBadGlyphCD -------------------------------------------------------------------------------------------------------------------- circle-info Could be less than current game time if glyph is already available. `GameRules.GetBadGlyphCD():` `**number**` Returns game time when next dire glyph will be available. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgoodscancd) GetGoodScanCD -------------------------------------------------------------------------------------------------------------------- circle-info Could be less than current game time if scan is already available. `GameRules.GetGoodScanCD():` `**number**` Returns game time when next radiant scan will be available. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getbadscancd) GetBadScanCD ------------------------------------------------------------------------------------------------------------------ circle-info Could be less than current game time if scan is already available. `GameRules.GetBadScanCD():` `**number**` Returns game time when next dire scan will be available. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgoodscancharges) GetGoodScanCharges ------------------------------------------------------------------------------------------------------------------------------ `GameRules.GetGoodScanCharges():` `**integer**` Returns current radiant scan charges. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgoodscancharges-1) GetGoodScanCharges -------------------------------------------------------------------------------------------------------------------------------- `GameRules.GetGoodScanCharges():` `**integer**` Returns current dire scan charges. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getstockcount) GetStockCount -------------------------------------------------------------------------------------------------------------------- circle-info Item id can be found in \`assets/data/items.json\` file in cheat folder. \`GameRules.GetStockCount(item\_id, \[team\]):\` \*\*\`integer\`\*\* Name Type Description **item\_id** `**integer**` **team** `**[?]**` [`**Enum.TeamNum**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.teamnum) \- Optional. Default is local player's team. `(default: Enum.TeamNum.TEAM_RADIANT)` Returns amount of remaining items in shop by item id. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getnextcycletime) GetNextCycleTime -------------------------------------------------------------------------------------------------------------------------- `GameRules.GetNextCycleTime():` `**number**`, `**boolean**` Return time remaining to the next cycle. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getdaytimestart) GetDaytimeStart ------------------------------------------------------------------------------------------------------------------------ `GameRules.GetDaytimeStart():` `**number**` Returns day start time. To work with it use `GameRules.GetTimeOfDay` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getnighttimestart) GetNighttimeStart ---------------------------------------------------------------------------------------------------------------------------- `GameRules.GetNighttimeStart():` `**number**` Returns night start time. To work with it use `GameRules.GetTimeOfDay` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#gettimeofday) GetTimeOfDay ------------------------------------------------------------------------------------------------------------------ `GameRules.GetTimeOfDay():` `**number**` Returns current time of day time. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#isinbanphase) IsInBanPhase ------------------------------------------------------------------------------------------------------------------ `GameRules.IsInBanPhase():` `**boolean**` Returns `true` if game is in ban phase. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getalldraftphase) GetAllDraftPhase -------------------------------------------------------------------------------------------------------------------------- `GameRules.GetAllDraftPhase():` `**integer**` Returns index of the current draft phase. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#isalldraftphaseradiantfirst) IsAllDraftPhaseRadiantFirst ------------------------------------------------------------------------------------------------------------------------------------------------ `GameRules.IsAllDraftPhaseRadiantFirst():` `**boolean**` Returns `true` if Radiant picks first. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getdotatime) GetDOTATime ---------------------------------------------------------------------------------------------------------------- `GameRules.GetDOTATime([pregame], [negative]):` `**number**` Name Type Description **pregame** `**[?]**` `**boolean**` If `true` includes pregame time. `(default: false)` **negative** `**[?]**` `**boolean**` If `true` includes negative time. `(default: false)` Returns the actual DOTA in-game clock time. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getlobbyobjectjson) GetLobbyObjectJson ------------------------------------------------------------------------------------------------------------------------------ `GameRules.GetLobbyObjectJson():` `**string**` | `**nil**` Returns CSODOTALobby protobuf object as JSON string. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getbannedheroes) GetBannedHeroes ------------------------------------------------------------------------------------------------------------------------ `GameRules.GetBannedHeroes():` `**integer[]**` | `**nil**` Returns zero-based array of banned heroes where index corresponds to the player id. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getstatetransitiontime) GetStateTransitionTime -------------------------------------------------------------------------------------------------------------------------------------- `GameRules.GetStateTransitionTime():` `**number**` Returns time remaining between state changes. [PreviousEventchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event) [NextGlobalVarschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/globalvars) Last updated 12 months ago * [GetServerGameState](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getservergamestate) * [GetGameState](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgamestate) * [GetGameMode](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgamemode) * [GetPreGameStartTime](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getpregamestarttime) * [GetGameStartTime](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgamestarttime) * [GetGameEndTime](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgameendtime) * [GetGameLoadTime](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgameloadtime) * [GetGameTime](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgametime) * [IsPaused](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#ispaused) * [IsTemporaryDay](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#istemporaryday) * [IsTemporaryNight](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#istemporarynight) * [IsNightstalkerNight](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#isnightstalkernight) * [GetMatchID](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getmatchid) * [GetLobbyID](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getlobbyid) * [GetGoodGlyphCD](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgoodglyphcd) * [GetBadGlyphCD](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getbadglyphcd) * [GetGoodScanCD](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgoodscancd) * [GetBadScanCD](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getbadscancd) * [GetGoodScanCharges](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgoodscancharges) * [GetGoodScanCharges](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getgoodscancharges-1) * [GetStockCount](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getstockcount) * [GetNextCycleTime](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getnextcycletime) * [GetDaytimeStart](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getdaytimestart) * [GetNighttimeStart](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getnighttimestart) * [GetTimeOfDay](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#gettimeofday) * [IsInBanPhase](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#isinbanphase) * [GetAllDraftPhase](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getalldraftphase) * [IsAllDraftPhaseRadiantFirst](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#isalldraftphaseradiantfirst) * [GetDOTATime](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getdotatime) * [GetLobbyObjectJson](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getlobbyobjectjson) * [GetBannedHeroes](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getbannedheroes) * [GetStateTransitionTime](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules#getstatetransitiontime) sun-brightdesktopmoon Copy local game_time = GameRules.GetGameTime(); local ingame_timer = game_time - GameRules.GetGameStartTime(); Log.Write(string.format("Current time: %d:%02d", math.floor(ingame_timer / 60), math.floor(ingame_timer % 60))) Copy -- "item_ward_observer": { -- "ID": "42", Log.Write("Observers available: " .. GameRules.GetStockCount(42)) sun-brightdesktopmoon --- # Vector | API v2.0 Vector metatable ### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#fields) Fields Name Type Description **x** `**number**` **y** `**number**` **z** `**number**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#addinplace) AddInPlace ----------------------------------------------------------------------------------------------------------------------- `:AddInPlace(other):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) | `**number**` Adds other to this vector in-place. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#subinplace) SubInPlace ----------------------------------------------------------------------------------------------------------------------- `:SubInPlace(other):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) | `**number**` Subtracts other from this vector in-place. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#mulinplace) MulInPlace ----------------------------------------------------------------------------------------------------------------------- `:MulInPlace(other):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) | `**number**` Multiplies this vector by other in-place. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#divinplace) DivInPlace ----------------------------------------------------------------------------------------------------------------------- `:DivInPlace(other):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) | `**number**` Divides this vector by other in-place. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#set) Set --------------------------------------------------------------------------------------------------------- `:Set(x, y, z):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **x** `**number**` **y** `**number**` **z** `**number**` Sets x, y, z components. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#setgroundz) SetGroundZ ----------------------------------------------------------------------------------------------------------------------- `:SetGroundZ():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Sets .z = World.GetGroundZ(.x, .y). Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#lerpinplace) LerpInPlace ------------------------------------------------------------------------------------------------------------------------- `:LerpInPlace(b, t):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **b** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) **t** `**number**` Linearly interpolates this vector towards other in-place. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#copyfrom) CopyFrom ------------------------------------------------------------------------------------------------------------------- `:CopyFrom(other):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Copies values from another vector without allocating. Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#clone) Clone ------------------------------------------------------------------------------------------------------------- `:Clone():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Creates a new vector with the same values as the original. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#directionto) DirectionTo ------------------------------------------------------------------------------------------------------------------------- `:DirectionTo(other, [dist]):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) **dist** `**[?]**` `**number**` optional scale factor `(default: 1.0)` Returns a normalized direction vector from this point to other, optionally scaled by distance. Equivalent to `(other - self):Normalized():Scaled(dist)` but with a single allocation. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#anglebetween2d) AngleBetween2D ------------------------------------------------------------------------------------------------------------------------------- `:AngleBetween2D(middle, point3):` `**number**` Name Type Description **middle** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) the vertex point (this is point1, middle is point2) **point3** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Returns the angle in radians between two 2D vectors formed by three points. Equivalent to the angle at point2 in the triangle point1-point2-point3, ignoring Z. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#closesttopoint) ClosestToPoint ------------------------------------------------------------------------------------------------------------------------------- `:ClosestToPoint(entities):` [`**CEntity**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) | `**nil**`, `**number**` Name Type Description **entities** [`**CEntity[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) Finds the closest entity to this position from a table of entities. Returns the entity and the distance. Uses Distance2D. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#distancesqr2d) DistanceSqr2D ----------------------------------------------------------------------------------------------------------------------------- `:DistanceSqr2D(other):` `**number**` Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Returns the squared 2D distance to another vector. Cheaper than Distance2D (no sqrt). Use for distance comparisons: `a:DistanceSqr2D(b) < range * range`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#isinrange2d) IsInRange2D ------------------------------------------------------------------------------------------------------------------------- `:IsInRange2D(other, range):` `**boolean**` Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) **range** `**number**` Returns true if this position is within range of another position (2D, no sqrt). [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#extend2d) Extend2D ------------------------------------------------------------------------------------------------------------------- `:Extend2D(target, distance):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **target** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) **distance** `**number**` Extends this position towards target by distance (2D, ignores Z). Single allocation. Equivalent to `self + (target - self):Normalized() * distance` without intermediate vectors. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#perpendicular2d) Perpendicular2D --------------------------------------------------------------------------------------------------------------------------------- `:Perpendicular2D():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Returns a 2D perpendicular vector (-y, x, z). Zero allocation if called in-place. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#negate) Negate --------------------------------------------------------------------------------------------------------------- `:Negate():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Negates this vector in-place (-x, -y, -z). Returns self for chaining. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#iszero) IsZero --------------------------------------------------------------------------------------------------------------- `:IsZero([tolerance]):` `**boolean**` Name Type Description **tolerance** `**[?]**` `**number**` `(default: 0.01)` Returns true if all components are near zero within tolerance. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#extrapolate) Extrapolate ------------------------------------------------------------------------------------------------------------------------- `:Extrapolate(direction, scalar):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **direction** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) **scalar** `**number**` Returns `self + direction * scalar`. Single allocation. Useful for position extrapolation: `start:Extrapolate(velocity, dt * speed)`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#vector) Vector --------------------------------------------------------------------------------------------------------------- `Vector([x], [y], [z]):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **x** `**[?]**` `**number**` `(default: 0.0)` **y** `**[?]**` `**number**` `(default: 0.0)` **z** `**[?]**` `**number**` `(default: 0.0)` Create a new Vector. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#tostring) \_\_tostring ----------------------------------------------------------------------------------------------------------------------- `:__tostring():` `**string**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#add) \_\_add ------------------------------------------------------------------------------------------------------------- circle-info Overload for operator + `:__add(other):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) | [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) | `**number**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#sub) \_\_sub ------------------------------------------------------------------------------------------------------------- circle-info Overload for operator - `:__sub(other):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) | [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) | `**number**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#div) \_\_div ------------------------------------------------------------------------------------------------------------- circle-info Overload for operator / `:__div(other):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) | [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) | `**number**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#mul) \_\_mul ------------------------------------------------------------------------------------------------------------- circle-info Overload for operator \* `:__mul(other):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) | [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) | `**number**` [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#eq) \_\_eq ----------------------------------------------------------------------------------------------------------- circle-info Overload for operator == \`:\_\_eq(other):\` \*\*\`boolean\`\*\* Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#distance) Distance ------------------------------------------------------------------------------------------------------------------- `:Distance(other):` `**number**` Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Computes the distance from this vector to other. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#distance2d) Distance2D ----------------------------------------------------------------------------------------------------------------------- `:Distance2D(other):` `**number**` Name Type Description **other** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Computes the distance from this vector to other ignoring Z axis. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#normalized) Normalized ----------------------------------------------------------------------------------------------------------------------- `:Normalized():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Returns this vector with a length of 1. When normalized, a vector keeps the same direction but its length is 1.0. Note that the current vector is unchanged and a new normalized vector is returned. If you want to normalize the current vector, use `Vector:Normalize` function. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#normalize) Normalize --------------------------------------------------------------------------------------------------------------------- `:Normalize():` `**nil**` Makes this vector have a length of 1. When normalized, a vector keeps the same direction but its length is 1.0. Note that this function will change the current vector. If you want to keep the current vector unchanged, use `Vector:Normalized` function. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#dot) Dot --------------------------------------------------------------------------------------------------------- `:Dot(vector):` `**number**` Name Type Description **vector** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Dot Product of two vectors. The dot product is a float value equal to the magnitudes of the two vectors multiplied together and then multiplied by the cosine of the angle between them. For normalized vectors Dot returns 1 if they point in exactly the same direction, -1 if they point in completely opposite directions and zero if the vectors are perpendicular. [Morearrow-up-right](https://medium.com/@r.w.overdijk/unity-vector3-dot-what-11feb258052e) [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#dot2d) Dot2D ------------------------------------------------------------------------------------------------------------- `:Dot2D(vector):` `**number**` Name Type Description **vector** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Dot Product of two vectors ignoring Z axis. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#scaled) Scaled --------------------------------------------------------------------------------------------------------------- `:Scaled(scale):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **scale** `**number**` Returns this vector multiplied by the given number. The same as `Vector * number`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#scale) Scale ------------------------------------------------------------------------------------------------------------- `:Scale(scale):` `**nil**` Name Type Description **scale** `**number**` Multiplies this vector by the given number. The same as `Vector = Vector * number`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#length) Length --------------------------------------------------------------------------------------------------------------- `:Length():` `**number**` Returns the length of this vector. The length of the vector is `math.sqrt(x*x+y*y+z*z)`. If you only need to compare length of some vectors, you can compare squared magnitudes of them using LengthSqr (computing squared length is faster). [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#lengthsqr) LengthSqr --------------------------------------------------------------------------------------------------------------------- `:LengthSqr():` `**number**` Returns the squared length of this vector. This method is faster than Length because it avoids computing a square root. Use this method if you need to compare vectors. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#length2d) Length2D ------------------------------------------------------------------------------------------------------------------- `:Length2D():` `**number**` Returns the length of this vector ignoring Z axis. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#length2dsqr) Length2DSqr ------------------------------------------------------------------------------------------------------------------------- `:Length2DSqr():` `**number**` Returns the squared length of this vector ignoring Z axis. This method is faster than Length2D because it avoids computing a square root. Use this method if you need to compare vectors. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#rotated) Rotated ----------------------------------------------------------------------------------------------------------------- `:Rotated(angle):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **angle** `**number**` | [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Returns the new vector rotated counterclockwise by the given angle in the XY-plane, leaving the Z-axis unaffected. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#rotate) Rotate --------------------------------------------------------------------------------------------------------------- `:Rotate(angle):` `**nil**` Name Type Description **angle** `**number**` | [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Rotates this vector counterclockwise by the given angle in the XY-plane, leaving the Z-axis unaffected. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#lerp) Lerp ----------------------------------------------------------------------------------------------------------- `:Lerp(b, t):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **b** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) end value, returned when t = 1 **t** `**number**` value used to interpolate between a and b. Returns linearly interpolated vector between two vectors. The value returned equals **a + (b - a) \* t** (which can also be written **a \* (1-t) + b\*t**). When `t = 0`, **a:Lerp(b, t)** returns `a`. When `t = 1`, **a:Lerp(b, t)** returns `b`. When `t = 0.5`, **a:Lerp(b, t)** returns the point midway between `a` and `b`. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#cross) Cross ------------------------------------------------------------------------------------------------------------- `:Cross(vector):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **vector** [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Returns cross product of two vectors. [Morearrow-up-right](https://docs.unity3d.com/ScriptReference/Vector3.Cross.html) [Visualizationarrow-up-right](https://www.youtube.com/watch?v=kz92vvioeng) [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#moveforward) MoveForward ------------------------------------------------------------------------------------------------------------------------- `:MoveForward(angle, distance):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Name Type Description **angle** [`**Angle**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) **distance** `**number**` distance to move Moves vector forward by a specified distance in the direction defined by a given Angle. #### [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#toangle) ToAngle ----------------------------------------------------------------------------------------------------------------- `:ToAngle():` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) Converts Vector to Angle. See https://github.com/ValveSoftware/source-sdk-2013/blob/0565403b153dfcde602f6f58d8f4d13483696a13/src/mathlib/mathlib\_base.cpp#L535 [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#toscreen) ToScreen ------------------------------------------------------------------------------------------------------------------- `:ToScreen():` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) , `**boolean**` Converts Vector to screen coordinate [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#isvisible) IsVisible --------------------------------------------------------------------------------------------------------------------- `:IsVisible():` `**boolean**` Returns `true` if position visible on screen. To get screen position use :ToScreen method [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#get) Get --------------------------------------------------------------------------------------------------------- `:Get():` `**number**`, `**number**`, `**number**` Returns x, y and z of this vector. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#getx) GetX ----------------------------------------------------------------------------------------------------------- `:GetX():` `**number**` Returns x of this vector. The same as Vector.x. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#gety) GetY ----------------------------------------------------------------------------------------------------------- `:GetY():` `**number**` Returns y of this vector. The same as Vector.y. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#getz) GetZ ----------------------------------------------------------------------------------------------------------- `:GetZ():` `**number**` Returns z of this vector. The same as Vector.z. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#setx) SetX ----------------------------------------------------------------------------------------------------------- `:SetX(value):` `**nil**` Name Type Description **value** `**number**` Sets x. The same as Vector.x = value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#sety) SetY ----------------------------------------------------------------------------------------------------------- `:SetY(value):` `**nil**` Name Type Description **value** `**number**` Sets y. The same as Vector.y = value. [hashtag](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#setz) SetZ ----------------------------------------------------------------------------------------------------------- `:SetZ(value):` `**nil**` Name Type Description **value** `**number**` Sets z. The same as Vector.z = value. [PreviousMathchevron-left](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math) [NextAnglechevron-right](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle) Last updated 28 days ago * [Fields](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#fields) * [AddInPlace](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#addinplace) * [SubInPlace](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#subinplace) * [MulInPlace](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#mulinplace) * [DivInPlace](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#divinplace) * [Set](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#set) * [SetGroundZ](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#setgroundz) * [LerpInPlace](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#lerpinplace) * [CopyFrom](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#copyfrom) * [Clone](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#clone) * [DirectionTo](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#directionto) * [AngleBetween2D](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#anglebetween2d) * [ClosestToPoint](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#closesttopoint) * [DistanceSqr2D](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#distancesqr2d) * [IsInRange2D](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#isinrange2d) * [Extend2D](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#extend2d) * [Perpendicular2D](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#perpendicular2d) * [Negate](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#negate) * [IsZero](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#iszero) * [Extrapolate](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#extrapolate) * [Vector](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#vector) * [\_\_tostring](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#tostring) * [\_\_add](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#add) * [\_\_sub](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#sub) * [\_\_div](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#div) * [\_\_mul](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#mul) * [\_\_eq](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#eq) * [Distance](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#distance) * [Distance2D](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#distance2d) * [Normalized](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#normalized) * [Normalize](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#normalize) * [Dot](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#dot) * [Dot2D](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#dot2d) * [Scaled](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#scaled) * [Scale](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#scale) * [Length](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#length) * [LengthSqr](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#lengthsqr) * [Length2D](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#length2d) * [Length2DSqr](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#length2dsqr) * [Rotated](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#rotated) * [Rotate](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#rotate) * [Lerp](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#lerp) * [Cross](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#cross) * [MoveForward](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#moveforward) * [ToAngle](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#toangle) * [ToScreen](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#toscreen) * [IsVisible](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#isvisible) * [Get](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#get) * [GetX](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#getx) * [GetY](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#gety) * [GetZ](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#getz) * [SetX](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#setx) * [SetY](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#sety) * [SetZ](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector#setz) sun-brightdesktopmoon Copy -- entity position moved forward by 300 local pos = Entity.GetAbsOrigin(entity):MoveForward(Entity.GetRotation(entity), 300); sun-brightdesktopmoon --- # Courier | API v2.0 Table to work with `CCourier`.`**CCourier**` extends `**CNPC**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/courier#isflyingcourier) IsFlyingCourier --------------------------------------------------------------------------------------------------------------- `Courier.IsFlyingCourier(courier):` `**boolean**` Name Type Description **courier** [`**CCourier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/courier) The courier to check. Returns `true` if the courier is flying. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/courier#getrespawntime) GetRespawnTime ------------------------------------------------------------------------------------------------------------- `Courier.GetRespawnTime(courier):` `**number**` Name Type Description **courier** [`**CCourier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/courier) The courier to check. Returns the game time when the courier will respawn. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/courier#getcourierstate) GetCourierState --------------------------------------------------------------------------------------------------------------- `Courier.GetCourierState(courier):` [`**Enum.CourierState**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.courierstate) Name Type Description **courier** [`**CCourier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/courier) The courier to check. Returns the courier state. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/courier#getplayerid) GetPlayerID ------------------------------------------------------------------------------------------------------- `Courier.GetPlayerID(courier):` `**integer**` Name Type Description **courier** [`**CCourier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/courier) The courier to check. Returns owner's player id. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/courier#getcourierstateentity) GetCourierStateEntity --------------------------------------------------------------------------------------------------------------------------- `Courier.GetCourierStateEntity(courier):` [`**CEntity**`](https://uczone.gitbook.io/api-v2.0/game-components/core/entity) | `**nil**` Name Type Description **courier** [`**CCourier**`](https://uczone.gitbook.io/api-v2.0/game-components/core/courier) The courier to check. Returns the entity that the courier is currently interacting with. [PreviousBottlechevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/bottle) [NextDrunkenBrawlerchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/drunkenbrawler) Last updated 12 months ago * [IsFlyingCourier](https://uczone.gitbook.io/api-v2.0/game-components/core/courier#isflyingcourier) * [GetRespawnTime](https://uczone.gitbook.io/api-v2.0/game-components/core/courier#getrespawntime) * [GetCourierState](https://uczone.gitbook.io/api-v2.0/game-components/core/courier#getcourierstate) * [GetPlayerID](https://uczone.gitbook.io/api-v2.0/game-components/core/courier#getplayerid) * [GetCourierStateEntity](https://uczone.gitbook.io/api-v2.0/game-components/core/courier#getcourierstateentity) sun-brightdesktopmoon sun-brightdesktopmoon --- # Engine | API v2.0 Table to work with game engine. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#isingame) IsInGame ------------------------------------------------------------------------------------------------------- `Engine.IsInGame():` `**boolean**` Returns `true` if the game is in progress. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#isshopopen) IsShopOpen ----------------------------------------------------------------------------------------------------------- `Engine.IsShopOpen():` `**boolean**` Returns `true` if the shop is open. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#setquickbuy) SetQuickBuy ------------------------------------------------------------------------------------------------------------- `Engine.SetQuickBuy(item_name, [reset]):` `**nil**` Name Type Description **item\_name** `**string**` The name of the item to quick buy. (e.g. `blink`, `relic`) **reset** `**[?]**` `**boolean**` Reset the quick buy list. `(default: true)` Add item to quick buy list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#runscript) RunScript --------------------------------------------------------------------------------------------------------- `Engine.RunScript(script, [contextPanel]):` `**boolean**` Name Type Description **script** `**string**` The script to run. **contextPanel** `**[?]**` `**string**` | [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) The id of the panel or the panel itself to run the script in. `(default: "Dashboard")` Run a JS script in the panorama context. Return `true` if the script was executed successfully. [JS documentationarrow-up-right](https://developer.valvesoftware.com/wiki/Dota_2_Workshop_Tools/Panorama/Javascript) #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#executecommand) ExecuteCommand ------------------------------------------------------------------------------------------------------------------- `Engine.ExecuteCommand(command):` `**nil**` Name Type Description **command** `**string**` The command to execute. Execute a console command. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#playvol) PlayVol ----------------------------------------------------------------------------------------------------- `Engine.PlayVol(sound, [volume]):` `**nil**` Name Type Description **sound** `**string**` The sound to play. Could find in `sounds` folder in `pak01_dir.vpk` file. **volume** `**[?]**` `**number**` The volume of the sound. `(default: 0.1)` Play a sound with a specific volume. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#example-2) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#createconfig) CreateConfig --------------------------------------------------------------------------------------------------------------- `Engine.CreateConfig(config_name, categories):` `**nil**` Name Type Description **config\_name** `**string**` The name of the config. **categories** `**{name: string, hero_ids: integer[], x: number, y: number, width: number, height: number}[]**` Creates a new hero grid config. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#example-3) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getcurrentconfigname) GetCurrentConfigName ------------------------------------------------------------------------------------------------------------------------------- `Engine.GetCurrentConfigName():` `**string**` Returns the current hero grid config name [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#setnewgridconfig) SetNewGridConfig ----------------------------------------------------------------------------------------------------------------------- `Engine.SetNewGridConfig(config_name):` `**nil**` Name Type Description **config\_name** `**string**` The name of the config to set Set the new hero grid config by name [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#lookat) LookAt --------------------------------------------------------------------------------------------------- `Engine.LookAt(x, y):` `**nil**` Name Type Description **x** `**number**` **y** `**number**` Move camera to a specific position. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#canacceptmatch) CanAcceptMatch ------------------------------------------------------------------------------------------------------------------- `Engine.CanAcceptMatch():` `**boolean**` Returns `true` if the player can accept the match. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getgamedirectory) GetGameDirectory ----------------------------------------------------------------------------------------------------------------------- `Engine.GetGameDirectory():` `**string**` Returns the current game directory. (e.g. `dota 2 beta`) [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getcheatdirectory) GetCheatDirectory ------------------------------------------------------------------------------------------------------------------------- `Engine.GetCheatDirectory():` `**string**` Returns the current cheat directory. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getlevelname) GetLevelName --------------------------------------------------------------------------------------------------------------- `Engine.GetLevelName():` `**string**` Returns the current level name. (e.g. `maps/hero_demo_main.vpk`) [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getlevelnameshort) GetLevelNameShort ------------------------------------------------------------------------------------------------------------------------- `Engine.GetLevelNameShort():` `**string**` Returns the current level name without the extension and folder. (e.g. `hero_demo_main`) [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#acceptmatch) AcceptMatch ------------------------------------------------------------------------------------------------------------- `Engine.AcceptMatch(state):` `**nil**` Name Type Description **state** `**integer**` DOTALobbyReadyState Accept match. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#consolecolorprintf) ConsoleColorPrintf --------------------------------------------------------------------------------------------------------------------------- `Engine.ConsoleColorPrintf(r, g, b, [a], text):` `**nil**` Name Type Description **r** `**integer**` Red value. **g** `**integer**` Green value. **b** `**integer**` Blue value. **a** `**[?]**` `**integer**` Alpha value. `(default: 255)` **text** `**string**` Text to print. Print a message to the dota console. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getmmr) GetMMR --------------------------------------------------------------------------------------------------- `Engine.GetMMR():` `**integer**` Returns the current MMR. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getmmrv2) GetMMRV2 ------------------------------------------------------------------------------------------------------- `Engine.GetMMRV2():` `**integer**` Returns the current MMR. Works better than `Engine.GetMMR`. Must be called from the game thread. Ex: OnNetUpdateEx, OnGCMessage, not OnFrame or on initialization. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#reloadscriptsystem) ReloadScriptSystem --------------------------------------------------------------------------------------------------------------------------- `Engine.ReloadScriptSystem():` `**nil**` Executes script system reload. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#showdotawindow) ShowDotaWindow ------------------------------------------------------------------------------------------------------------------- `Engine.ShowDotaWindow():` `**nil**` Brings the game window to the forefront if it is minimized. Use this function to make the game window the topmost window. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#isinlobby) IsInLobby --------------------------------------------------------------------------------------------------------- `Engine.IsInLobby():` `**boolean**` Returns `true` if the player is in a lobby. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getbuildversion) GetBuildVersion --------------------------------------------------------------------------------------------------------------------- `Engine.GetBuildVersion():` `**string**` Returns the cheat version. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getheroidbyname) GetHeroIDByName --------------------------------------------------------------------------------------------------------------------- `Engine.GetHeroIDByName(unitName):` `**integer**` | `**nil**` Name Type Description **unitName** `**string**` Can be retrieved from `NPC.GetUnitName` Returns hero ID by unit name. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#example-4) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getdisplaynamebyunitname) GetDisplayNameByUnitName --------------------------------------------------------------------------------------------------------------------------------------- `Engine.GetDisplayNameByUnitName(unitName):` `**string**` | `**nil**` Name Type Description **unitName** `**string**` Can be retrieved from `NPC.GetUnitName` Returns hero display name by unit name. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#example-5) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getheronamebyid) GetHeroNameByID --------------------------------------------------------------------------------------------------------------------- `Engine.GetHeroNameByID(heroID):` `**string**` | `**nil**` Name Type Description **heroID** `**integer**` Returns hero name by ID. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getuistate) GetUIState ----------------------------------------------------------------------------------------------------------- `Engine.GetUIState():` [`**Enum.UIState**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.uistate) Returns current UI state. [PreviousGame Enginechevron-left](https://uczone.gitbook.io/api-v2.0/game-components/game-engine) [NextEventchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event) Last updated 12 months ago * [IsInGame](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#isingame) * [IsShopOpen](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#isshopopen) * [SetQuickBuy](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#setquickbuy) * [RunScript](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#runscript) * [ExecuteCommand](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#executecommand) * [PlayVol](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#playvol) * [CreateConfig](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#createconfig) * [GetCurrentConfigName](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getcurrentconfigname) * [SetNewGridConfig](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#setnewgridconfig) * [LookAt](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#lookat) * [CanAcceptMatch](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#canacceptmatch) * [GetGameDirectory](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getgamedirectory) * [GetCheatDirectory](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getcheatdirectory) * [GetLevelName](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getlevelname) * [GetLevelNameShort](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getlevelnameshort) * [AcceptMatch](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#acceptmatch) * [ConsoleColorPrintf](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#consolecolorprintf) * [GetMMR](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getmmr) * [GetMMRV2](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getmmrv2) * [ReloadScriptSystem](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#reloadscriptsystem) * [ShowDotaWindow](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#showdotawindow) * [IsInLobby](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#isinlobby) * [GetBuildVersion](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getbuildversion) * [GetHeroIDByName](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getheroidbyname) * [GetDisplayNameByUnitName](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getdisplaynamebyunitname) * [GetHeroNameByID](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getheronamebyid) * [GetUIState](https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine#getuistate) sun-brightdesktopmoon Copy -- in dota console, you should see "Hello from Lua!" Engine.RunScript("$.Msg('Hello from Lua!')"); Copy -- in dota chat, you should see "Hello from Lua!" Engine.ExecuteCommand("say \"Hello from Lua!\""); Copy -- play a sound with a volume of 0.5 (very loud) Engine.PlayVol("sounds/npc/courier/courier_acknowledge.vsnd_c", 0.5); Copy Engine.CreateConfig("From lua", { { name = "55%+", hero_ids = {1, 2, 3, 4}, x = 0.0, y = 0.0, width = 300.0, height = 200.0 }, { name = "52%+", hero_ids = {5, 6}, x = 350.0, y = 0.0, width = 300.0, height = 200.0 } }); Copy local abaddonId = Engine.GetHeroIDByName( "npc_dota_hero_abaddon" ) Copy local nevermore_name = Engine.GetDisplayNameByUnitName( "npc_dota_hero_nevermore" ) -- nevermore_name == "Shadow Fiend" sun-brightdesktopmoon --- # table | API v2.0 Extensions for the built-in Lua `table` library. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#isempty) IsEmpty ------------------------------------------------------------------------------------------------------------------------ `table.IsEmpty(t):` `**boolean**` Name Type Description **t** `**table**` Returns true if the table has no entries. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#length) Length ---------------------------------------------------------------------------------------------------------------------- `table.Length(t):` `**integer**` Name Type Description **t** `**table**` Counts ALL entries (array + hash), unlike `#t` which only counts the sequence part. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#keys) Keys ------------------------------------------------------------------------------------------------------------------ `table.Keys(t):` `**table**` Name Type Description **t** `**table**` Returns a new array containing all keys of the table. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#values) Values ---------------------------------------------------------------------------------------------------------------------- `table.Values(t):` `**table**` Name Type Description **t** `**table**` Returns a new array containing all values of the table. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#sum) Sum ---------------------------------------------------------------------------------------------------------------- `table.Sum(t):` `**number**` Name Type Description **t** `**table**` Returns the sum of all numeric values in the table. Non-numeric values are skipped. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#reverse) Reverse ------------------------------------------------------------------------------------------------------------------------ `table.Reverse(t):` `**table**` Name Type Description **t** `**table**` Returns a new array with the sequence part of `t` in reverse order. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#copyshallow) CopyShallow -------------------------------------------------------------------------------------------------------------------------------- `table.CopyShallow(orig, [ignore_mt]):` `**table**` Name Type Description **orig** `**table**` **ignore\_mt** `**[?]**` `**boolean**` If true, the metatable is not copied `(default: false)` Creates a shallow copy of the table. Copies the metatable unless `ignore_mt` is true. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#copy) Copy ------------------------------------------------------------------------------------------------------------------ `table.Copy(orig):` `**table**` Name Type Description **orig** `**table**` Deep-copies a table with cycle detection. Metatables are preserved. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#kvswap) KvSwap ---------------------------------------------------------------------------------------------------------------------- `table.KvSwap(t, [v_to_true]):` `**table**` Name Type Description **t** `**table**` **v\_to\_true** `**[?]**` `**boolean**` If true, new values are `true` instead of the original key `(default: false)` Swaps keys and values. If `v_to_true` is true, all new values become `true` instead of the original key. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#merge) Merge -------------------------------------------------------------------------------------------------------------------- `table.Merge(...):` `**table**` Name Type Description **...** `**table**` Tables to merge Concatenates array-part entries from all argument tables into a new array. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#mergehm) MergeHm ------------------------------------------------------------------------------------------------------------------------ `table.MergeHm(...):` `**table**` Name Type Description **...** `**table**` Tables to merge Merges all key-value pairs from argument tables into a new table. Later tables overwrite earlier ones. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#diff) Diff ------------------------------------------------------------------------------------------------------------------ `table.Diff(new_t, old_t):` `**table**` Name Type Description **new\_t** `**table**` **old\_t** `**table**` Returns entries in `new_t` whose values differ from `old_t` (compared by rawequal). [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#sorted) Sorted ---------------------------------------------------------------------------------------------------------------------- `table.Sorted(t, [compare_func]):` `**table**` Name Type Description **t** `**table**` **compare\_func** `**[?]**` `**fun(a: any, b: any):boolean**` Optional comparison function Sorts the table in-place via the built-in `table.sort`, then returns it. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#map) Map ---------------------------------------------------------------------------------------------------------------- `table.Map(t, func):` `**table**` Name Type Description **t** `**table**` **func** `**fun(value: any, key: any):any**` Callback `func(value, key) -> new_value` Applies `func(value, key)` to every entry and returns a new array of results. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#filter) Filter ---------------------------------------------------------------------------------------------------------------------- `table.Filter(t, func):` `**table**` Name Type Description **t** `**table**` **func** `**fun(value: any, key: any):boolean**` Predicate `func(value, key) -> boolean` Returns a new array containing only entries for which `func(value, key)` returns true. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#any) Any ---------------------------------------------------------------------------------------------------------------- `table.Any(t, func):` `**boolean**` Name Type Description **t** `**table**` **func** `**fun(value: any, key: any):boolean**` Predicate `func(value, key) -> boolean` Returns true if `func(value, key)` returns true for at least one entry. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#all) All ---------------------------------------------------------------------------------------------------------------- `table.All(t, func):` `**boolean**` Name Type Description **t** `**table**` **func** `**fun(value: any, key: any):boolean**` Predicate `func(value, key) -> boolean` Returns true if `func(value, key)` returns true for every entry. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#find) Find ------------------------------------------------------------------------------------------------------------------ `table.Find(t, element):` `**any**`, `**any**` Name Type Description **t** `**table**` **element** `**any**` Element to search for Finds the first entry matching `element` by raw equality. Returns `value, key` on match, or `nil` if not found. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#removeelement) RemoveElement ------------------------------------------------------------------------------------------------------------------------------------ `table.RemoveElement(t, element):` `**boolean**` Name Type Description **t** `**table**` **element** `**any**` | `**function**` Element to find or predicate function Removes the first matching element from the array-part of `t`. If `element` is a function, it is used as a predicate `func(value, index) -> boolean`. Otherwise, finds by raw equality. Shifts remaining elements down to maintain order. [PreviousGameLocalizerchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/gamelocalizer) [NextStringBuilderchevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/stringbuilder) Last updated 23 days ago * [IsEmpty](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#isempty) * [Length](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#length) * [Keys](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#keys) * [Values](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#values) * [Sum](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#sum) * [Reverse](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#reverse) * [CopyShallow](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#copyshallow) * [Copy](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#copy) * [KvSwap](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#kvswap) * [Merge](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#merge) * [MergeHm](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#mergehm) * [Diff](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#diff) * [Sorted](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#sorted) * [Map](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#map) * [Filter](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#filter) * [Any](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#any) * [All](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#all) * [Find](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#find) * [RemoveElement](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities/table_ext#removeelement) sun-brightdesktopmoon sun-brightdesktopmoon --- # Hero | API v2.0 Table to work with `CHero`. `**CHero**` extends `**CNPC**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getcurrentxp) GetCurrentXP ------------------------------------------------------------------------------------------------------ `Hero.GetCurrentXP(hero):` `**integer**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the hero's current XP. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getabilitypoints) GetAbilityPoints -------------------------------------------------------------------------------------------------------------- `Hero.GetAbilityPoints(hero):` `**integer**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the hero's available ability points. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getrespawntime) GetRespawnTime ---------------------------------------------------------------------------------------------------------- circle-info Could be less than current game time if hero is already alive. \`Hero.GetRespawnTime(hero):\` \*\*\`number\`\*\* Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the game time when the hero will respawn. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getrespawntimepenalty) GetRespawnTimePenalty ------------------------------------------------------------------------------------------------------------------------ `Hero.GetRespawnTimePenalty(hero):` `**number**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the next respawn time penalty, e.g. buyback. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getprimaryattribute) GetPrimaryAttribute -------------------------------------------------------------------------------------------------------------------- `Hero.GetPrimaryAttribute(hero):` [`**Enum.Attributes**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.attributes) Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the hero's primary attribute type. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getstrength) GetStrength ---------------------------------------------------------------------------------------------------- `Hero.GetStrength(hero):` `**number**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns `white` value of strength. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getagility) GetAgility -------------------------------------------------------------------------------------------------- `Hero.GetAgility(hero):` `**number**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns `white` value of agility. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getintellect) GetIntellect ------------------------------------------------------------------------------------------------------ `Hero.GetIntellect(hero):` `**number**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns `white` value of intellect. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getstrengthtotal) GetStrengthTotal -------------------------------------------------------------------------------------------------------------- `Hero.GetStrengthTotal(hero):` `**number**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns total value of strength. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getagilitytotal) GetAgilityTotal ------------------------------------------------------------------------------------------------------------ `Hero.GetAgilityTotal(hero):` `**number**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns total value of agility. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getintellecttotal) GetIntellectTotal ---------------------------------------------------------------------------------------------------------------- `Hero.GetIntellectTotal(hero):` `**number**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns total value of intellect. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getlasthurttime) GetLastHurtTime ------------------------------------------------------------------------------------------------------------ `Hero.GetLastHurtTime(hero):` `**number**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the time when the hero was last hurt. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#gethurtamount) GetHurtAmount -------------------------------------------------------------------------------------------------------- `Hero.GetHurtAmount(hero):` `**number**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the amount of damage the hero last received. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getrecentdamage) GetRecentDamage ------------------------------------------------------------------------------------------------------------ `Hero.GetRecentDamage(hero):` `**integer**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the damage taken by the hero in the last in ~1 second. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getpainfactor) GetPainFactor -------------------------------------------------------------------------------------------------------- `Hero.GetPainFactor(hero):` `**number**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the pain factor of the hero. Not sure what it is. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#gettargetpainfactor) GetTargetPainFactor -------------------------------------------------------------------------------------------------------------------- `Hero.GetTargetPainFactor(hero):` `**number**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the pain factor of the hero's target. Not sure what it is. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getlifestate) GetLifeState ------------------------------------------------------------------------------------------------------ `Hero.GetLifeState(hero):` `**boolean**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns `true` if the hero is alive. Recommended to use `Entity.IsAlive` instead. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getplayerid) GetPlayerID ---------------------------------------------------------------------------------------------------- `Hero.GetPlayerID(hero):` `**integer**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the ID of the hero player. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getreplicatingotherheromodel) GetReplicatingOtherHeroModel -------------------------------------------------------------------------------------------------------------------------------------- `Hero.GetReplicatingOtherHeroModel(hero):` [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) | `**nil**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) If the hero is an illusion, Arc's copy, Meepo clone, etc. returns the original hero, otherwise returns nil. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#talentislearned) TalentIsLearned ------------------------------------------------------------------------------------------------------------ `Hero.TalentIsLearned(hero, talent):` `**boolean**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) **talent** [`**Enum.TalentTypes**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.talenttypes) Returns `true` if talent is learned. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getfacetabilities) GetFacetAbilities ---------------------------------------------------------------------------------------------------------------- `Hero.GetFacetAbilities(hero):` [`**CAbility[]**`](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns facet ability array. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getfacetid) GetFacetID -------------------------------------------------------------------------------------------------- `Hero.GetFacetID(hero):` `**integer**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns facet id. Start from 1. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getlastmaphackpos) GetLastMaphackPos ---------------------------------------------------------------------------------------------------------------- `Hero.GetLastMaphackPos(hero):` [`**Vector**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector) | `**nil**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the last hero pos from maphack. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getlastvisibletime) GetLastVisibleTime ------------------------------------------------------------------------------------------------------------------ `Hero.GetLastVisibleTime(hero):` `**float**` | `**nil**` Name Type Description **hero** [`**CHero**`](https://uczone.gitbook.io/api-v2.0/game-components/core/hero) Returns the last visible time from VBE. [PreviousNPCchevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/npc) [NextAbilitychevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) Last updated 5 months ago * [GetCurrentXP](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getcurrentxp) * [GetAbilityPoints](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getabilitypoints) * [GetRespawnTime](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getrespawntime) * [GetRespawnTimePenalty](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getrespawntimepenalty) * [GetPrimaryAttribute](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getprimaryattribute) * [GetStrength](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getstrength) * [GetAgility](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getagility) * [GetIntellect](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getintellect) * [GetStrengthTotal](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getstrengthtotal) * [GetAgilityTotal](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getagilitytotal) * [GetIntellectTotal](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getintellecttotal) * [GetLastHurtTime](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getlasthurttime) * [GetHurtAmount](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#gethurtamount) * [GetRecentDamage](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getrecentdamage) * [GetPainFactor](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getpainfactor) * [GetTargetPainFactor](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#gettargetpainfactor) * [GetLifeState](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getlifestate) * [GetPlayerID](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getplayerid) * [GetReplicatingOtherHeroModel](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getreplicatingotherheromodel) * [TalentIsLearned](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#talentislearned) * [GetFacetAbilities](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getfacetabilities) * [GetFacetID](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getfacetid) * [GetLastMaphackPos](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getlastmaphackpos) * [GetLastVisibleTime](https://uczone.gitbook.io/api-v2.0/game-components/core/hero#getlastvisibletime) sun-brightdesktopmoon Copy TALENT_8 <=> TALENT_7 TALENT_6 <=> TALENT_5 TALENT_4 <=> TALENT_3 TALENT_2 <=> TALENT_1 sun-brightdesktopmoon --- # Item | API v2.0 Table to work with `CItem`. `**CItem**` extends `**CAbility**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#iscombinable) IsCombinable ------------------------------------------------------------------------------------------------------ `Item.IsCombinable(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if the item is combinable. I'm not sure if non-combinable items even exist. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#ispermanent) IsPermanent ---------------------------------------------------------------------------------------------------- `Item.IsPermanent(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if the item is permanent. I'm not sure what permanent items is, but for items with stacks this function returns `false`. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#isstackable) IsStackable ---------------------------------------------------------------------------------------------------- `Item.IsStackable(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if the item is stackable. e.g tangoes, wards, etc. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#isrecipe) IsRecipe ---------------------------------------------------------------------------------------------- `Item.IsRecipe(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if the item is recipe. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getsharability) GetSharability ---------------------------------------------------------------------------------------------------------- `Item.GetSharability(item):` [`**Enum.ShareAbility**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.shareability) Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns item's sharability type. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#isdroppable) IsDroppable ---------------------------------------------------------------------------------------------------- `Item.IsDroppable(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if the item is droppable. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#ispurchasable) IsPurchasable -------------------------------------------------------------------------------------------------------- `Item.IsPurchasable(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if the item is purchasable. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#issellable) IsSellable -------------------------------------------------------------------------------------------------- `Item.IsSellable(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if the item is sellable. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#requirescharges) RequiresCharges ------------------------------------------------------------------------------------------------------------ `Item.RequiresCharges(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if the item requires charges. e.g. urn, vessel etc. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#iskillable) IsKillable -------------------------------------------------------------------------------------------------- `Item.IsKillable(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if item is destroyable by autoatack. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#isdisassemblable) IsDisassemblable -------------------------------------------------------------------------------------------------------------- `Item.IsDisassemblable(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if item is disassemblable. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#isalertable) IsAlertable ---------------------------------------------------------------------------------------------------- `Item.IsAlertable(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if item is alertable. e.g. smoke, mekansm, arcane boots etc. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getinitialcharges) GetInitialCharges ---------------------------------------------------------------------------------------------------------------- `Item.GetInitialCharges(item):` `**integer**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns initial charges of the item. e.g. 3 for bottle, 1 for dust etc. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#castsonpickup) CastsOnPickup -------------------------------------------------------------------------------------------------------- `Item.CastsOnPickup(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) No idea what this function does. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getcurrentcharges) GetCurrentCharges ---------------------------------------------------------------------------------------------------------------- `Item.GetCurrentCharges(item):` `**integer**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns amount of current charges. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getsecondarycharges) GetSecondaryCharges -------------------------------------------------------------------------------------------------------------------- `Item.GetSecondaryCharges(item):` `**integer**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns amount of secondary charges. e.g. pack of both type of wards. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#iscombinelocked) IsCombineLocked ------------------------------------------------------------------------------------------------------------ `Item.IsCombineLocked(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if item locked for combining. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#ismarkedforsell) IsMarkedForSell ------------------------------------------------------------------------------------------------------------ `Item.IsMarkedForSell(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if item is marked for sell. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getpurchasetime) GetPurchaseTime ------------------------------------------------------------------------------------------------------------ `Item.GetPurchaseTime(item):` `**number**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns the game time when the item was purchased. If the item was assembled from other items, It returns the purchase time of the item that had the lowest index at the moment of assembling. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getassembledtime) GetAssembledTime -------------------------------------------------------------------------------------------------------------- `Item.GetAssembledTime(item):` `**number**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns the game time when the item was assembled. If the item was not assembled, returns time when the item was purchased. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#purchasedwhiledead) PurchasedWhileDead ------------------------------------------------------------------------------------------------------------------ `Item.PurchasedWhileDead(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `true` if item was purchased while dead. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#canbeusedoutofinventory) CanBeUsedOutOfInventory ---------------------------------------------------------------------------------------------------------------------------- `Item.CanBeUsedOutOfInventory(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) No idea which specific item example could be used out of inventory. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#isitemenabled) IsItemEnabled -------------------------------------------------------------------------------------------------------- `Item.IsItemEnabled(item):` `**boolean**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns `false` if item has CD after moving from stash. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getenabletime) GetEnableTime -------------------------------------------------------------------------------------------------------- circle-info Could be less than current game time if item is already enabled. `Item.GetEnableTime(item):` `**number**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns game time when item will be enabled. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getplayerownerid) GetPlayerOwnerID -------------------------------------------------------------------------------------------------------------- `Item.GetPlayerOwnerID(item):` `**integer**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns player ID who owns the item. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getcost) GetCost -------------------------------------------------------------------------------------------- `Item.GetCost(item):` `**integer**` Name Type Description **item** [`**CItem**`](https://uczone.gitbook.io/api-v2.0/game-components/core/item) Returns item cost. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getstockcount) GetStockCount -------------------------------------------------------------------------------------------------------- circle-info Item id can be found in \`assets/data/items.json\` file in cheat folder. \`Item.GetStockCount(item\_id, \[team\]):\` \*\*\`integer\`\*\* Name Type Description **item\_id** `**integer**` **team** `**[?]**` [`**Enum.TeamNum**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/enums#enum.teamnum) \- Optional. Default is local player's team. `(default: Enum.TeamNum.TEAM_RADIANT)` Returns amount of remaining items in shop by item id. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/core/item#example) Example [PreviousAbilitychevron-left](https://uczone.gitbook.io/api-v2.0/game-components/core/ability) [NextRunechevron-right](https://uczone.gitbook.io/api-v2.0/game-components/core/rune) Last updated 12 months ago * [IsCombinable](https://uczone.gitbook.io/api-v2.0/game-components/core/item#iscombinable) * [IsPermanent](https://uczone.gitbook.io/api-v2.0/game-components/core/item#ispermanent) * [IsStackable](https://uczone.gitbook.io/api-v2.0/game-components/core/item#isstackable) * [IsRecipe](https://uczone.gitbook.io/api-v2.0/game-components/core/item#isrecipe) * [GetSharability](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getsharability) * [IsDroppable](https://uczone.gitbook.io/api-v2.0/game-components/core/item#isdroppable) * [IsPurchasable](https://uczone.gitbook.io/api-v2.0/game-components/core/item#ispurchasable) * [IsSellable](https://uczone.gitbook.io/api-v2.0/game-components/core/item#issellable) * [RequiresCharges](https://uczone.gitbook.io/api-v2.0/game-components/core/item#requirescharges) * [IsKillable](https://uczone.gitbook.io/api-v2.0/game-components/core/item#iskillable) * [IsDisassemblable](https://uczone.gitbook.io/api-v2.0/game-components/core/item#isdisassemblable) * [IsAlertable](https://uczone.gitbook.io/api-v2.0/game-components/core/item#isalertable) * [GetInitialCharges](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getinitialcharges) * [CastsOnPickup](https://uczone.gitbook.io/api-v2.0/game-components/core/item#castsonpickup) * [GetCurrentCharges](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getcurrentcharges) * [GetSecondaryCharges](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getsecondarycharges) * [IsCombineLocked](https://uczone.gitbook.io/api-v2.0/game-components/core/item#iscombinelocked) * [IsMarkedForSell](https://uczone.gitbook.io/api-v2.0/game-components/core/item#ismarkedforsell) * [GetPurchaseTime](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getpurchasetime) * [GetAssembledTime](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getassembledtime) * [PurchasedWhileDead](https://uczone.gitbook.io/api-v2.0/game-components/core/item#purchasedwhiledead) * [CanBeUsedOutOfInventory](https://uczone.gitbook.io/api-v2.0/game-components/core/item#canbeusedoutofinventory) * [IsItemEnabled](https://uczone.gitbook.io/api-v2.0/game-components/core/item#isitemenabled) * [GetEnableTime](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getenabletime) * [GetPlayerOwnerID](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getplayerownerid) * [GetCost](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getcost) * [GetStockCount](https://uczone.gitbook.io/api-v2.0/game-components/core/item#getstockcount) sun-brightdesktopmoon Copy -- "item_ward_observer": { -- "ID": "42", Log.Write("Observers available: " .. Item.GetStockCount(42)) sun-brightdesktopmoon --- # UIPanel | API v2.0 UIPanel metatable [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#tostring) \_\_tostring ------------------------------------------------------------------------------------------------------------------------------- `:__tostring():` `**nil**` [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#eq) \_\_eq ------------------------------------------------------------------------------------------------------------------- circle-info Overload for operator ==. `:__eq(other):` `**boolean**` Name Type Description **other** [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#findchild) FindChild ----------------------------------------------------------------------------------------------------------------------------- `:FindChild(id):` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Name Type Description **id** `**string**` id of the child. Finds child by ID. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#isvisible) IsVisible ----------------------------------------------------------------------------------------------------------------------------- `:IsVisible():` `**boolean**` Returns visible state. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#setvisible) SetVisible ------------------------------------------------------------------------------------------------------------------------------- `:SetVisible(newState):` `**nil**` Name Type Description **newState** `**boolean**` Sets visible state. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getclasslist) GetClassList ----------------------------------------------------------------------------------------------------------------------------------- `:GetClassList():` `**string[]**` Returns class name list. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#findchildinlayoutfile) FindChildInLayoutFile ----------------------------------------------------------------------------------------------------------------------------------------------------- `:FindChildInLayoutFile(id):` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Name Type Description **id** `**string**` ???. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#findpanelinlayoutfile) FindPanelInLayoutFile ----------------------------------------------------------------------------------------------------------------------------------------------------- `:FindPanelInLayoutFile(id):` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Name Type Description **id** `**string**` ???. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#findchildtraverse) FindChildTraverse --------------------------------------------------------------------------------------------------------------------------------------------- `:FindChildTraverse(id):` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Name Type Description **id** `**string**` Recursive find child by id. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#findchildwithclass) FindChildWithClass ----------------------------------------------------------------------------------------------------------------------------------------------- `:FindChildWithClass(className):` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Name Type Description **className** `**string**` Finds first child with provided class name. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getchildcount) GetChildCount ------------------------------------------------------------------------------------------------------------------------------------- `:GetChildCount():` `**integer**` Returns child by count. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getchild) GetChild --------------------------------------------------------------------------------------------------------------------------- `:GetChild(index):` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Name Type Description **index** `**number**` Returns child by index. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getchildbypath) GetChildByPath --------------------------------------------------------------------------------------------------------------------------------------- `:GetChildByPath(path, [bLogError]):` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Name Type Description **path** `**string[]**` **bLogError** `**[?]**` `**boolean**` Log error if panel not found. `(default: false)` Returns child by path using FindChild. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getchildindex) GetChildIndex ------------------------------------------------------------------------------------------------------------------------------------- `:GetChildIndex():` `**integer**` Returns index in parent children list. Starts from 0. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getfirstchild) GetFirstChild ------------------------------------------------------------------------------------------------------------------------------------- `:GetFirstChild():` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Returns first child. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getlastchild) GetLastChild ----------------------------------------------------------------------------------------------------------------------------------- `:GetLastChild():` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Returns last child. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#hasid) HasID --------------------------------------------------------------------------------------------------------------------- `:HasID():` `**boolean**` Returns `true` if the panel has an id. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getid) GetID --------------------------------------------------------------------------------------------------------------------- `:GetID():` `**string**` Returns id of panel. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#setid) SetID --------------------------------------------------------------------------------------------------------------------- `:SetID(id):` `**nil**` Name Type Description **id** `**string**` Sets the panel's id. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getlayoutheight) GetLayoutHeight ----------------------------------------------------------------------------------------------------------------------------------------- `:GetLayoutHeight():` `**integer**` Returns the panel height. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getlayoutwidth) GetLayoutWidth --------------------------------------------------------------------------------------------------------------------------------------- `:GetLayoutWidth():` `**integer**` Returns the panel width. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getparent) GetParent ----------------------------------------------------------------------------------------------------------------------------- `:GetParent():` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Returns the panel's parent. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getrootparent) GetRootParent ------------------------------------------------------------------------------------------------------------------------------------- `:GetRootParent():` [`**UIPanel**`](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel) | `**nil**` Returns the panel's root parent. ??? [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getxoffset) GetXOffset ------------------------------------------------------------------------------------------------------------------------------- `:GetXOffset():` `**integer**` Returns the panel's relative X offset. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getyoffset) GetYOffset ------------------------------------------------------------------------------------------------------------------------------- `:GetYOffset():` `**integer**` Returns the panel's relative Y offset. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getbounds) GetBounds ----------------------------------------------------------------------------------------------------------------------------- `:GetBounds([useJsFunc]):` `**{x:number, y:number, w:number, h:number}**` Name Type Description **useJsFunc** `**[?]**` `**boolean**` | `**nil**` Use js GetPositionWithinWindow function to get position. `(default: false)` Returns the panel's bounds. Iterate over the parent hierarchy to get the absolute bounds. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getimagesrc) GetImageSrc --------------------------------------------------------------------------------------------------------------------------------- `:GetImageSrc():` `**string**` Return the panel source image. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getpaneltype) GetPanelType ----------------------------------------------------------------------------------------------------------------------------------- `:GetPanelType():` `**string**` Returns the panel's type. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#bsetproperty) BSetProperty ----------------------------------------------------------------------------------------------------------------------------------- `:BSetProperty(key, value):` `**boolean**` Name Type Description **key** `**string**` **value** `**string**` Sets the panel property. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#setstyle) SetStyle --------------------------------------------------------------------------------------------------------------------------- `:SetStyle(cssString):` `**boolean**` Name Type Description **cssString** `**string**` Sets the panel style. #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#example) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#setattribute) SetAttribute ----------------------------------------------------------------------------------------------------------------------------------- `:SetAttribute(key, value):` `**nil**` Name Type Description **key** `**string**` **value** `**string**` Sets the panel's attribute. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getattribute) GetAttribute ----------------------------------------------------------------------------------------------------------------------------------- `:GetAttribute(key, default):` `**string**` | `**nil**` Name Type Description **key** `**string**` **default** `**string**` Returns the panel's attribute. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getpositionwithinwindow) GetPositionWithinWindow --------------------------------------------------------------------------------------------------------------------------------------------------------- `:GetPositionWithinWindow():` [`**Vec2**`](https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2) Returns the panel's window position. Not sure about optimization. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#gettext) GetText ------------------------------------------------------------------------------------------------------------------------- circle-info This method is only available for Label panels. `:GetText():` `**string**` Returns the label panel's text. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#settext) SetText ------------------------------------------------------------------------------------------------------------------------- circle-info This method is only available for Label panels. `:SetText(text):` `**nil**` Name Type Description **text** `**string**` Sets the label panel's text. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#gettexttype) GetTextType --------------------------------------------------------------------------------------------------------------------------------- circle-info This method is only available for Label panels. `:GetTextType():` `**integer**` Gets the label panel's text type. (2 = plain, 3 = html) [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#settexttype) SetTextType --------------------------------------------------------------------------------------------------------------------------------- circle-info This method is only available for Label panels. \`:SetTextType(new):\` \*\*\`nil\`\*\* Name Type Description **new** `**integer**` value Sets the label panel's text type. (2 = plain, 3 = html). Should always set text type before setting the text #### [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#example-1) Example [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#isvalid) IsValid ------------------------------------------------------------------------------------------------------------------------- `:IsValid():` `**boolean**` Checks if the panel is valid [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#hasclass) HasClass --------------------------------------------------------------------------------------------------------------------------- `:HasClass(className):` `**boolean**` Name Type Description **className** `**string**` Class name. Checks if the panel has a class. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#addclasses) AddClasses ------------------------------------------------------------------------------------------------------------------------------- `:AddClasses(classNames):` `**nil**` Name Type Description **classNames** `**string**` Could be a space separated list of classes. Adds a class to the panel. [hashtag](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#removeclasses) RemoveClasses ------------------------------------------------------------------------------------------------------------------------------------- `:RemoveClasses(classNames):` `**nil**` Name Type Description **classNames** `**string**` Could be a space separated list of classes. Removes a class to the panel. [PreviousPanoramachevron-left](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama) [NextConfiguration & Utilitieschevron-right](https://uczone.gitbook.io/api-v2.0/game-components/configuration-and-utilities) Last updated 3 months ago * [\_\_tostring](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#tostring) * [\_\_eq](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#eq) * [FindChild](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#findchild) * [IsVisible](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#isvisible) * [SetVisible](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#setvisible) * [GetClassList](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getclasslist) * [FindChildInLayoutFile](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#findchildinlayoutfile) * [FindPanelInLayoutFile](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#findpanelinlayoutfile) * [FindChildTraverse](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#findchildtraverse) * [FindChildWithClass](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#findchildwithclass) * [GetChildCount](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getchildcount) * [GetChild](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getchild) * [GetChildByPath](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getchildbypath) * [GetChildIndex](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getchildindex) * [GetFirstChild](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getfirstchild) * [GetLastChild](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getlastchild) * [HasID](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#hasid) * [GetID](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getid) * [SetID](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#setid) * [GetLayoutHeight](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getlayoutheight) * [GetLayoutWidth](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getlayoutwidth) * [GetParent](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getparent) * [GetRootParent](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getrootparent) * [GetXOffset](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getxoffset) * [GetYOffset](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getyoffset) * [GetBounds](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getbounds) * [GetImageSrc](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getimagesrc) * [GetPanelType](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getpaneltype) * [BSetProperty](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#bsetproperty) * [SetStyle](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#setstyle) * [SetAttribute](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#setattribute) * [GetAttribute](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getattribute) * [GetPositionWithinWindow](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#getpositionwithinwindow) * [GetText](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#gettext) * [SetText](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#settext) * [GetTextType](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#gettexttype) * [SetTextType](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#settexttype) * [IsValid](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#isvalid) * [HasClass](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#hasclass) * [AddClasses](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#addclasses) * [RemoveClasses](https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel#removeclasses) sun-brightdesktopmoon Copy -- set_style.lua local css_like_table = { ["horizontal-align"] = "center", ["vertical-align"] = "center", ["transform"] = "translate3d( 0px, -0px, 0px ) scale3d(1, 1, 1)", ["padding-left"] = "0px", ["margin"] = "0px", ["border-radius"] = "4px", ["background-color"] = "none", ["box-shadow"] = "none", ["color"] = "gradient( linear, 0% 100%, 0% 0%, from( #ff00FF ), to( #5C9C68 ) )", ["font-size"] = "20px", ["text-align"] = "center", ["text-decoration"] = "none", ["background-size"] = "0% 0%", ["opacity-mask"] = 'url("s2r://panorama/images/masks/hudchat_mask_psd.vtex") 1.0', ["hue-rotation"] = "-10deg", ["text-shadow"] = "2px 2px #111111b0", ["blur"] = "gaussian(0px)", ["line-height"] = "120%", ["font-family"] = "Radiance", ["border-brush"] = "gradient( linear, 0% 0%, 0% 100%, from( #96c5ff96 ), to( #12142d2d ) )", } local function css_to_string(tbl) local str = "" for k, v in pairs(tbl) do str = str .. k .. ": " .. v .. "; " end return str; end local health_label = Panorama.GetPanelByName("HealthLabel"); if (health_label) then health_label:SetStyle(css_to_string(css_like_table)) end Copy label_panel:SetTextType(3) label_panel:SetText("Vitória") sun-brightdesktopmoon ---