UCZone API v2.0

https://uczone.gitbook.io/api-v2.0
Admin
UCZone API v2.0 is a scripting API documentation for creating Lua-based scripts with callbacks, game...
Tokens:94,256
Snippets:1,033
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Full Debug Example Script

Source: https://uczone.gitbook.io/api-v2.0

A complete example demonstrating menu creation, UI switches, and handling various game callbacks like modifiers and animations.

```lua
---@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
```

--------------------------------

### Handle Sound Start Callback

Source: https://uczone.gitbook.io/api-v2.0

Logs sound start events and optionally resolves NPC source names if additional info is enabled.

```lua
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
```

--------------------------------

### Perform an HTTP GET request in Lua

Source: https://uczone.gitbook.io/api-v2.0/game-components/networking-and-apis/http.md

Demonstrates how to initiate an HTTP GET request with custom headers and process the response using a callback function.

```lua
-- 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");
```

--------------------------------

### GameRules.GetDaytimeStart()

Source: https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules.md

Retrieves the start time for the daytime period.

```APIDOC
## GameRules.GetDaytimeStart()

### Description
Returns day start time. To work with it use GameRules.GetTimeOfDay.

### Returns
- **number**
```

--------------------------------

### GameRules.GetGameStartTime

Source: https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules.md

Retrieves the game start time.

```APIDOC
## GameRules.GetGameStartTime()

### Description
Returns the game start time duration (0:00 on ingame timer) or 0 if the game has not started yet.

### Returns
- **number** - The game start time duration.
```

--------------------------------

### Event.AddListener

Source: https://uczone.gitbook.io/api-v2.0/game-components/game-engine/event.md

Installs an event listener for the specified event name.

```APIDOC
## Event.AddListener(name)

### Description
Installs an event listener for the desired event. Note that this requires unsafe features to be enabled in the security settings.

### Signature
`Event.AddListener(name: string): nil`

### Parameters
- **name** (string) - Required - The name of the event to listen for.
```

--------------------------------

### GameRules.GetNighttimeStart()

Source: https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules.md

Retrieves the start time for the nighttime period.

```APIDOC
## GameRules.GetNighttimeStart()

### Description
Returns night start time. To work with it use GameRules.GetTimeOfDay.

### Returns
- **number**
```

--------------------------------

### Debug Script Implementation

Source: https://uczone.gitbook.io/api-v2.0/getting-started/getting_started.md

A comprehensive example demonstrating UI creation, font loading, and various event callbacks.

```lua
---@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
```

--------------------------------

### Perform a documentation query via HTTP GET

Source: https://uczone.gitbook.io/api-v2.0/llms.txt

Use the ask parameter for specific questions and the optional goal parameter to provide context for the query.

```http
GET https://uczone.gitbook.io/api-v2.0/game-components/lists.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### Implement Sound and Order Debug Callbacks

Source: https://uczone.gitbook.io/api-v2.0/getting-started/getting_started.md

Logs sound start events and unit orders, optionally resolving entity names and ability identifiers.

```lua
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
```

--------------------------------

### GET /game-components/lists.md

Source: https://uczone.gitbook.io/api-v2.0/llms.txt

Performs a query against the documentation index to retrieve an answer and relevant sources.

```APIDOC
## GET /game-components/lists.md

### Description
Perform an HTTP GET request on the documentation index to ask a specific question and optionally provide a broader end goal for context.

### Method
GET

### Endpoint
https://uczone.gitbook.io/api-v2.0/game-components/lists.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Visible()

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton.md

Gets the current visibility state.

```APIDOC
## :Visible()

### Description
Retrieves the current visibility state of the widget.

### Returns
- (boolean) - The current visibility state.
```

--------------------------------

### Get

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2.md

Retrieves both x and y coordinates.

```APIDOC
## Get()

### Description
Returns the x and y components of this vector.
```

--------------------------------

### Get

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox.md

Retrieves the enable state of a specific item within the combo box.

```APIDOC
## :Get(itemId)

### Description
Returns the enable state of the item in the combo box.

### Parameters
- **itemId** (string) - The ID of the item to check.

### Returns
- **boolean** - The enable state of the item.
```

--------------------------------

### ToolTip()

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton.md

Gets the current tooltip text.

```APIDOC
## :ToolTip()

### Description
Retrieves the current tooltip text for the widget.

### Returns
- (string) - The current tooltip text.
```

--------------------------------

### Get

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuswitch.md

Retrieves the current value of the switch widget.

```APIDOC
## :Get()

### Description
Returns the widget's current boolean value.

### Returns
- **boolean** - The current value.
```

--------------------------------

### Ability.GetChannelStartTime

Source: https://uczone.gitbook.io/api-v2.0/game-components/core/ability.md

Returns the gametime the channeling of the ability will start. Requires the ability to be in the cast state when called.

```APIDOC
## Ability.GetChannelStartTime

### Description
Returns the gametime the channeling of the ability will start. Requires the ability to be in the cast state when called.

### Signature
`Ability.GetChannelStartTime(ability: CAbility): number`

### Parameters
- **ability** (CAbility) - Required - The ability instance to query.
```

--------------------------------

### ShowInBindIsland

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind.md

Gets or sets the visibility of the bind in the bind island.

```APIDOC
## :ShowInBindIsland(newStatus)

### Description
Sets the visibility of the bind in the bind island.

### Parameters
- **newStatus** (boolean) - Required - The new visibility status.

### Returns
- (boolean) - The updated visibility status.

## :ShowInBindIsland()

### Description
Gets the current visibility of the bind in the bind island.

### Returns
- (boolean) - The current visibility status.
```

--------------------------------

### :ToolTip(newText)

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumulticombobox.md

Gets or sets the tooltip text for the widget.

```APIDOC
## :ToolTip(newText)

### Description
Gets or sets the tooltip displayed when the mouse cursor is over the widget.

### Parameters
- **newText** (string) - Optional. The new tooltip text to set.

### Returns
- **string** - The current or updated tooltip text.
```

--------------------------------

### Calculate In-Game Timer with GetGameTime

Source: https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules.md

Calculates the elapsed game time by subtracting the start time from the current game time and formatting it as a string.

```lua
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)))
```

--------------------------------

### GridNav.BuildPath

Source: https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav.md

Calculates a path from a starting position to an ending position, returning an array of vectors representing the path.

```APIDOC
## GridNav.BuildPath(start, end_, [ignoreTrees], [npc_map])

### Description
Builds a path from the start position to the end position. Returns an array of Vector objects representing the path.

### Parameters
- **start** (Vector) - Required - The position to start the path from.
- **end_** (Vector) - Required - The position to end the path at.
- **ignoreTrees** (boolean) - Optional - If true, excludes static trees from the pathing calculation (default: false).
- **npc_map** (GridNavNpcMap | nil) - Optional - A map of NPC positions used as an additional mask for the terrain map (default: nil).

### Returns
- **Vector[]** - An array of positions representing the calculated path.
```

--------------------------------

### Player.GetQuickBuyInfo

Source: https://uczone.gitbook.io/api-v2.0/game-components/core/player.md

Retrieves the quick buy information for the specified player.

```APIDOC
## Player.GetQuickBuyInfo(player)

### Description
Returns a table containing quick buy item IDs and their purchasability status.

### Signature
`Player.GetQuickBuyInfo(player): {m_quickBuyItems:integer[], m_quickBuyIsPurchasable:boolean[]}`

### Parameters
- **player** (CPlayer) - The target player.

### Returns
- **m_quickBuyItems** (integer[]) - List of item IDs.
- **m_quickBuyIsPurchasable** (boolean[]) - List of booleans indicating if each item is purchasable.
```

--------------------------------

### Create UI Panels with Panorama

Source: https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/panorama.md

Demonstrates creating a hierarchy of panels, applying styles, and injecting JavaScript event handlers via Engine.RunScript.

```lua
-- 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();
```

--------------------------------

### Get

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment.md

Retrieves the current value of the widget.

```APIDOC
## :Get()

### Description
Returns the current value of the widget.

### Returns
- **Color** - The current color value of the widget.
```

--------------------------------

### Callbacks.OnStartSound

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks.md

Triggered when a sound effect begins playing.

```APIDOC
## Callbacks.OnStartSound(data)

### Description
Called when a sound is started. This function provides details about the sound source, identity, and spatial position.

### Parameters
- **data** (table) - Required - The data about the event.
  - **source** (CEntity) - Optional - The source of sound. (default: nil)
  - **hash** (integer) - Required - The hash of sound.
  - **guid** (integer) - Required - The guid of sound.
  - **seed** (integer) - Required - The seed of sound.
  - **name** (string) - Required - The name of sound.
  - **position** (Vector) - Required - The position of sound.
```

--------------------------------

### Configure UI Callbacks

Source: https://uczone.gitbook.io/api-v2.0/getting-started/getting_started.md

Sets up callbacks for UI elements to manage particle updates and color configurations.

```lua
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)
```

--------------------------------

### Get

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vector.md

Retrieves the x, y, and z components of the vector.

```APIDOC
## :Get()

### Description
Returns the x, y, and z components of this vector.

### Returns
- **number, number, number** - The x, y, and z values.
```

--------------------------------

### Get

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat.md

Retrieves the current numerical value of the slider.

```APIDOC
## :Get()

### Description
Returns the widget's current value.

### Returns
- **number** - The current value.
```

--------------------------------

### Create a CMenuButton with a callback

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment.md

Instantiates a new button with a specified name and a callback function that executes upon interaction.

```lua
gear:Button( "button", function( this )
	Log.Write( "Button '" .. this:Name() .. "' has been clicked."  )
end )
```

--------------------------------

### Build a path with GridNav

Source: https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gridnav.md

Demonstrates how to calculate a path from the local hero to the cursor position and render it on the screen. Requires manual release of the NPC map after use to prevent memory leaks.

```lua
-- 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
}
```

--------------------------------

### Get

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint.md

Retrieves the current integer value of the widget.

```APIDOC
## :Get()

### Description
Returns the widget's current integer value.

### Returns
- **integer** - The current value.
```

--------------------------------

### Create a CMenuButton in a CMenuGroup

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup.md

Demonstrates how to add a button to a menu group with a callback function that logs the button's name upon being clicked.

```lua
group:Button( "button", function( this )
	Log.Write( "Button '" .. this:Name() .. "' has been clicked."  )
end )
```

--------------------------------

### Get

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind.md

Retrieves the value of the widget's button.

```APIDOC
## :Get([idx])

### Description
Returns the widget's button value.

### Parameters
- **idx** (0 | 1) - Optional - The index of the button to get the value from (default: 0).

### Returns
- **Enum.ButtonCode** - The value of the specified button.
```

--------------------------------

### Engine.SetQuickBuy

Source: https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine.md

Adds an item to the quick buy list.

```APIDOC
## Engine.SetQuickBuy(item_name, [reset])

### Description
Add item to quick buy list.

### Parameters
- **item_name** (string) - Required - The name of the item to quick buy. (e.g. blink, relic)
- **reset** (boolean) - Optional - Reset the quick buy list. (default: true)

### Returns
- **nil**
```

--------------------------------

### Get

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucombobox.md

Retrieves the index of the currently selected item.

```APIDOC
## :Get()

### Description
Returns the index of the selected item (starts from 0).

### Returns
- **integer** - The index of the selected item.
```

--------------------------------

### Disabled

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment.md

Gets or sets the disabled state of the widget.

```APIDOC
## :Disabled(value)

### Description
Sets the disabled state of the widget.

### Parameters
- **value** (boolean) - Required
```

--------------------------------

### Retrieve trees in radius using Lua

Source: https://uczone.gitbook.io/api-v2.0/game-components/core/entity.md

Demonstrates how to fetch trees within a 400-unit radius of the local hero and iterate through the results to log their class names.

```lua
local hero = Heroes.GetLocal()
-- get all trees in 400 radius
local trees_around = Entity.GetTreesInRadius(hero, 400, true)
for i = 1, #trees_around do
	local tree = trees_around[i];
	Log.Write(Entity.GetClassName(tree) .. " is near!");
end
```

--------------------------------

### Visible

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment.md

Gets or sets the visible state of the widget.

```APIDOC
## :Visible(value)

### Description
Sets the visible state of the widget.

### Parameters
- **value** (boolean) - Required

## :Visible()

### Description
Gets the current visible state of the widget.

### Returns
- **value** (boolean)
```

--------------------------------

### Gear(name, [gearIcon], [useSmallFont])

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenulabel.md

Creates a CMenuGearAttachment and attaches it to the widget.

```APIDOC
## Gear(name, [gearIcon], [useSmallFont])

### Description
Creates a CMenuGearAttachment and attaches it to the widget.

### Parameters
- **name** (string) - Required - Name of the attachment.
- **gearIcon** (string) - Optional - Gear FontAwesome icon. (default: "\uf013")
- **useSmallFont** (boolean) - Optional - Use small font for gear icon. (default: true)

### Returns
- **CMenuGearAttachment** - The created attachment object.
```

--------------------------------

### MouseBinding

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubind.md

Gets or sets the ability to bind the mouse button.

```APIDOC
## :MouseBinding(newStatus)

### Description
Sets the ability to bind the mouse button.

### Parameters
- **newStatus** (boolean) - Required - The new mouse binding status.

### Returns
- (boolean) - The updated mouse binding status.

## :MouseBinding()

### Description
Gets the current ability to bind the mouse button.

### Returns
- (boolean) - The current mouse binding status.
```

--------------------------------

### Create CMenuSliderFloat with Slider method

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup.md

Demonstrates creating sliders using both a format string and a custom formatting function.

```lua
-- 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 )
```

--------------------------------

### Engine.ShowDotaWindow

Source: https://uczone.gitbook.io/api-v2.0/game-components/game-engine/engine.md

Brings the game window to the foreground.

```APIDOC
## Engine.ShowDotaWindow()

### Description
Brings the game window to the forefront if it is minimized. Use this function to make the game window the topmost window.

### Returns
- **nil**
```

--------------------------------

### Gear

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderint.md

Creates and attaches a CMenuGearAttachment to the widget.

```APIDOC
## :Gear(name, [gearIcon], [useSmallFont])

### Description
Creates a new CMenuGearAttachment and attaches it to the widget.

### Parameters
- **name** (string) - Required - Name of the attachment.
- **gearIcon** (string) - Optional - Gear FontAwesome icon. (default: "\uf013")
- **useSmallFont** (boolean) - Optional - Use small font for gear icon. (default: true)
```

--------------------------------

### :Visible(value)

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect.md

Gets or sets the visible state of the widget.

```APIDOC
## :Visible(value)

### Description
Gets or sets visible state. Depends on argument.

### Parameters
- **value** (boolean) - Optional. The visibility state to set.

### Returns
- **nil**

### Example
```lua
-- setter
widget:Visible(false)
```
```

--------------------------------

### Visible

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup.md

Gets or sets the visible state of the menu group.

```APIDOC
## :Visible(value)

### Description
Sets the visible state of the group.

### Parameters
- **value** (boolean) - Required - The visible state to set.

### Example
```lua
group:Visible(false)
```

## :Visible()

### Description
Gets the current visible state of the group.

### Returns
- (boolean) - The current visible state.
```

--------------------------------

### Disabled

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup.md

Gets or sets the disabled state of the menu group.

```APIDOC
## :Disabled(value)

### Description
Sets the disabled state of the group.

### Parameters
- **value** (boolean) - Required - The disabled state to set.

### Example
```lua
group:Disabled(false)
```

## :Disabled()

### Description
Gets the current disabled state of the group.

### Returns
- (boolean) - The current disabled state.
```

--------------------------------

### Create CMenuSliderInt with custom formatting

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup.md

Demonstrates creating a slider widget using either a format string or a custom formatting function.

```lua
-- 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%"
```

--------------------------------

### Get

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/angle.md

Retrieves the pitch, yaw, and roll components of the angle.

```APIDOC
## :Get()

### Description
Returns pitch, yaw, and roll as three separate numbers.

### Returns
- **number, number, number** - The pitch, yaw, and roll values.
```

--------------------------------

### Create UI Menu Elements

Source: https://uczone.gitbook.io/api-v2.0/getting-started/getting_started.md

Defines a menu structure with switches, sliders, and color pickers for user configuration.

```lua
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 ()
```

--------------------------------

### Configure In-World Processing

Source: https://uczone.gitbook.io/api-v2.0/getting-started/getting_started.md

Initializes constants and UI state retrieval for in-world rendering features.

```lua
local text_color <const> = Color(255, 255, 255, 255)
local font_size <const> = 14
local line_height <const> = 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()
```

--------------------------------

### Visible()

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cthirdtab.md

Gets the current visibility state of the third tab.

```APIDOC
## :Visible()

### Description
Gets the third tab's current visible state.

### Returns
- **boolean** - The current visibility state.
```

--------------------------------

### Ability.IsReady

Source: https://uczone.gitbook.io/api-v2.0/game-components/core/ability.md

Checks if the specified ability is currently ready to be used.

```APIDOC
## Ability.IsReady(ability)

### Description
Returns true if the ability is ready to use.

### Parameters
- **ability** (CAbility) - Required - The ability component to check.

### Returns
- **boolean** - True if ready, false otherwise.
```

--------------------------------

### Get

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect.md

Retrieves the enable state of a specific item within the multiselect.

```APIDOC
## :Get(itemId)

### Description
Returns the enable state of the specified item in the multiselect.

### Parameters
- **itemId** (string) - The ID of the item to check.

### Returns
- **boolean** - The enable state of the item.
```

--------------------------------

### Implement OnGCMessage Callback

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/callbacks.md

Demonstrates how to register the OnGCMessage callback to intercept and decode game coordinator messages.

```lua
-- 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
}
```

--------------------------------

### Get Disabled State

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox.md

Retrieves the current disabled status of the widget.

```lua
-- getter
local isDisabled = switch:Disabled()
```

--------------------------------

### GetX / GetY

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/math/vec2.md

Retrieves individual vector components.

```APIDOC
## GetX()
Returns the x component of this vector.

## GetY()
Returns the y component of this vector.
```

--------------------------------

### :ToolTip(newText)

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenumultiselect.md

Gets or sets the tooltip displayed when the mouse cursor is over the widget.

```APIDOC
## :ToolTip(newText)

### Description
Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument.

### Parameters
- **newText** (string) - Optional. The new tooltip text to set.

### Returns
- **string** - The current or updated tooltip text.
```

--------------------------------

### Calculate forward position using Entity.GetRotation

Source: https://uczone.gitbook.io/api-v2.0/game-components/core/entity.md

Demonstrates retrieving the local hero's rotation to calculate and draw a circle at a forward position.

```lua
-- forward_pos.lua
return {
    -- get local hero's forward position and draw a circle around it
    OnUpdate = function ()
        local hero = Heroes.GetLocal();
        local rotation = Entity.GetRotation(hero);
        -- forward_direction is a vector that points 100 units in direction of my hero's rotation
        local forward_direction = rotation:GetForward():Normalized():Scaled(100);
        -- add forward_direction to my hero's position to get the forward position
        local forward_pos = Entity.GetAbsOrigin(hero) + forward_direction;
        -- screen_x and screen_y are the coordinates of forward_pos on the screen
        local screen_x, screen_y, is_on_screen = Renderer.WorldToScreen(forward_pos);
        if is_on_screen then
            -- draw a circle around the position
            Renderer.SetDrawColor(255, 255, 255, 255);
            Renderer.DrawFilledCircle(screen_x, screen_y, 10, 10);
            -- result: https://i.imgur.com/ERf1Pxk.png
        end
    end
}
```

--------------------------------

### Create Slider with Integer Values

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenugearattachment.md

Demonstrates creating a slider with a standard format string and a custom formatting function.

```lua
-- 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%"
```

--------------------------------

### HideAlphaBar

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker.md

Gets or sets the visibility state of the alpha bar in the color picker.

```APIDOC
## :HideAlphaBar(value)

### Description
Sets the alpha bar state.

### Parameters
- **value** (boolean) - Required - The visibility state to set.

### Example
```lua
widget:HideAlphaBar(true)
```

## :HideAlphaBar()

### Description
Gets the current alpha bar state.

### Returns
- **boolean** - The current visibility state of the alpha bar.

### Example
```lua
local isAlphaBarHidden = widget:HideAlphaBar()
```
```

--------------------------------

### Unsafe()

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenubutton.md

Gets or sets the unsafe state of the widget, which displays a warning sign.

```APIDOC
## :Unsafe(value)

### Description
Sets the unsafe state of the widget.

### Parameters
- **value** (boolean) - Required - The unsafe state to set.

## :Unsafe()

### Description
Gets the current unsafe state of the widget.

### Returns
- **boolean** - The current unsafe state.
```

--------------------------------

### Abilities.GetAll()

Source: https://uczone.gitbook.io/api-v2.0/game-components/lists/abilities.md

Retrieves all abilities currently stored in the cheat list.

```APIDOC
## Abilities.GetAll()

### Description
Return all abilities in the cheat list.

### Returns
- **CAbility[]** - An array of all ability objects.
```

--------------------------------

### GameRules.GetPreGameStartTime

Source: https://uczone.gitbook.io/api-v2.0/game-components/game-engine/gamerules.md

Retrieves the pre-game duration.

```APIDOC
## GameRules.GetPreGameStartTime()

### Description
Returns the pregame duration (e.g., ban phase, pick time) or 0 if the current time is pregame.

### Returns
- **number** - The pregame duration.
```

--------------------------------

### ToolTip

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenuinputbox.md

Gets or sets the tooltip text displayed when the mouse cursor is over the widget.

```APIDOC
## :ToolTip(newText)

### Description
Sets the tooltip text for the widget.

### Parameters
- **newText** (string) - The text to display in the tooltip.

## :ToolTip()

### Description
Gets the current tooltip text.

### Returns
- (string) - The current tooltip text.
```

--------------------------------

### Get Widget Visibility

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpickerattachment.md

Retrieves the current visibility state of the widget as a boolean.

```lua
-- getter
local isVisible = widget:Visible()
```

--------------------------------

### Apply CSS styles to a UI panel

Source: https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel.md

Demonstrates how to convert a Lua table of CSS properties into a string and apply it to a panel using SetStyle.

```lua
-- 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
```

--------------------------------

### Retrieve Entity by Index in Lua

Source: https://uczone.gitbook.io/api-v2.0/game-components/core/entity.md

Demonstrates how to obtain an entity's index and verify it against the original entity object.

```lua
-- get_by_index.lua
local hero = Heroes.GetLocal();
local index = Entity.GetIndex(hero);
local entity_by_index = Entity.Get(index);
assert(hero == entity_by_index, "Entity.Get() is broken!"); -- true
```

--------------------------------

### Get Alpha Bar Visibility

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenucolorpicker.md

Retrieves the current visibility state of the alpha bar.

```lua
-- getter
local isAlphaBarHidden = widget:HideAlphaBar()
```

--------------------------------

### Implement Callback Logic

Source: https://uczone.gitbook.io/api-v2.0/getting-started/getting_started.md

Standard structure for handling hero callbacks and custom logic execution.

```lua
            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
```

--------------------------------

### Gear

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/widgets/cmenusliderfloat.md

Creates and attaches a gear icon component to the widget.

```APIDOC
## :Gear(name, [gearIcon], [useSmallFont])

### Description
Creates a CMenuGearAttachment and attaches it to the widget.

### Parameters
- **name** (string) - Required - Name of the attachment.
- **gearIcon** (string) - Optional - Gear FontAwesome icon (default: "\uf013").
- **useSmallFont** (boolean) - Optional - Use small font for gear icon (default: true).
```

--------------------------------

### GetBounds

Source: https://uczone.gitbook.io/api-v2.0/game-components/rendering-and-visuals/panorama/uipanel.md

Retrieves the panel's bounds. Iterate over the parent hierarchy to get the absolute bounds.

```APIDOC
## GetBounds

### Signature
`:GetBounds([useJsFunc]): {x:number, y:number, w:number, h:number}`

### Parameters
- **useJsFunc** (boolean | nil) - Optional - Use js GetPositionWithinWindow function to get position. (default: false)

### Returns
- **Object** - Returns an object containing x, y, w, and h coordinates.
```

--------------------------------

### Set and Get Visible State

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu/cmenugroup.md

Use these methods to toggle or retrieve the visibility of a menu group.

```lua
-- setter
group:Visible(false)
```

```lua
-- getter
local isVisible = group:Visible()
```

--------------------------------

### Menu.Create

Source: https://uczone.gitbook.io/api-v2.0/cheats-types-and-callbacks/classes/menu.md

Creates a new tab, section, or group within the menu structure.

```APIDOC
## Menu.Create(firstTabName, sectionName, secondTabName, thirdTabName, groupTabName)

### Description
Creates a new tab, section, or group based on the provided hierarchy path.

### Parameters
- **firstTabName** (string) - Required
- **sectionName** (string) - Required
- **secondTabName** (string) - Required
- **thirdTabName** (string) - Required
- **groupTabName** (string) - Required

### Returns
- (CMenuGroup) - The created menu item.
```
Tokens:
Raw