LegendSense SDK

https://docs.legendsen.se/developers/sdk-documentation/
Admin
LegendSense SDK is a Lua-based software development kit that provides APIs for game development,...
Tokens:101,018
Snippets:691
Trust Score:6
Update:8 months ago
Show doc for...
Tokens:
Raw
### SpellBookEntry Examples

Source: https://docs.legendsen.se/developers/sdk-documentation/class/spellbookentry

Provides practical examples of how to use SpellBookEntry properties and functions, particularly focusing on accessing fValue from tooltips.

```APIDOC
## SpellBookEntry Examples

### Description
Examples demonstrating how to access and utilize SpellBookEntry data, such as retrieving specific values from tooltips.

### Example: Accessing fValue from Ignite Tooltip
This example shows how to access the `fValue` array for a spell, using Ignite as a specific case. It involves printing the tooltip first to identify the correct `fValue` index.

```lua
local slot = SpellSlot.F

-- Print tooltip to see which f value we need to use:
Game.localPlayer:GetSpellEntry(slot):PrintTooltip(false)

-- Access 1st fValue (index starts from 1):
print(Game.localPlayer:GetSpellEntry(slot).fValue[1])
-- If Ignite is in the F slot, this will print the Ignite damage value.
```
```

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

### Queue Basic Usage Example

Source: https://docs.legendsen.se/developers/sdk-documentation/library/common/queue

Demonstrates the basic usage of the Queue class, including initializing with values, pushing elements to the left and right, and iterating through the queue. It also shows a more advanced example of using the queue for function execution with prioritized actions.

```lua
local q = Queue({1, 2, 3})
q:PushLeft(1)
q:PushRight(2)
q:PushLeft(0)
for i=1, #q do
    print(q[i])
end

local q = Queue()
q:PushRight(function() print("Action 1") end)
q:PushRight(function() 
    print("Action 2") 
    q:PushLeft(function() print("Top Priority Action!") end)
end)
q:PushRight(function() print("Action 3") end)
while #q > 0 do
    q:PopLeft()()
end
```

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

### DrawPaths Example with Clipper Union

Source: https://docs.legendsen.se/developers/sdk-documentation/renderer/renderer-dev

An example demonstrating the usage of Renderer.DrawPaths in conjunction with Clipper.Union and Clipper.PointInPolygons. It draws a union of two paths, coloring it green if the cursor is inside, and red otherwise.

```lua
Callback.Bind(CallbackType.OnDraw, function()  
    local pos = Game.localPlayer.position2D  
  
    local path1 = Clipper.CreatePath64FromVectors({  
        Math.Vector2(pos.x - 300, pos.y - 300),  
        Math.Vector2(pos.x + 300, pos.y - 300),  
        Math.Vector2(pos.x + 300, pos.y + 300),  
        Math.Vector2(pos.x - 300, pos.y + 300),  
    })  
  
    local path2 = Clipper.CreatePath64FromVectors({  
        Math.Vector2(pos.x - 200 + 300, pos.y - 200),  
        Math.Vector2(pos.x + 200 + 300, pos.y - 200),  
        Math.Vector2(pos.x + 200 + 300, pos.y + 200),  
        Math.Vector2(pos.x - 200 + 300, pos.y + 200),  
    })  
  
    local union = Clipper.Union(Clipper.CreatePaths64({path1}), Clipper.CreatePaths64({path2}), Clipper.FillRule.NonZero)  
  
    Renderer.DrawPaths(union, 1, Clipper.PointInPolygons(Game.GetCursorWorldPosition(), union) and 0xFF00FF00 or 0xFFFF0000)  
end)
```

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

### Draw Fancy Shader Circle Example (Lua)

Source: https://docs.legendsen.se/developers/sdk-documentation/renderer/colorinfo

Demonstrates drawing a glowing circle around a selected target using Renderer.ColorInfo and Renderer.DrawEffectCircle. This example highlights the usage of deprecated ColorInfo for visual effects within a game environment.

```lua
local MyGlowingCircleHash = Game.fnvhash("Example_MyGlowingCircle") -- This must be unique hash per drawing. Use unique prefix.  
local color = Renderer.ColorInfo.new(0xFFFFFFFF, 0xFF5555FF, Renderer.GradientType.Linear)  
local radius = 100  
Callback.Bind(CallbackType.OnDraw, function()  
    local tar = Game.GetSelectedTarget()  
    if tar and tar:IsValid() then  
        Renderer.DrawEffectCircle(MyGlowingCircleHash, tar.position2D, radius, color, Renderer.EffectType.MagicalCircle)  
    end  
end)
```

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

### Bind to OnNewPath Callback Example

Source: https://docs.legendsen.se/developers/sdk-documentation/callbacks/callbacksignatures

This example demonstrates how to bind a function to the OnNewPath callback. The callback is triggered when a unit receives a new path, providing information about the path and movement details. The example iterates through the path points and prints their indices and values to the chat.

```lua
Callback.Bind(CallbackType.OnNewPath,function(sender,isDash,dashSpeed,path)
    for i, v in path:pairs() do
         PrintChat(tostring(i))
         PrintChat(tostring(v))
    end
end)

```

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

### Full Union Example - Clipper (Lua)

Source: https://docs.legendsen.se/developers/sdk-documentation/library/clipper/clipper-api

An example demonstrating the `Clipper.Union` function in Lua. It creates two paths and performs a union operation, then draws the result, highlighting it green if the cursor is inside, otherwise red.

```lua
Callback.Bind(CallbackType.OnDraw, function()
    local pos = Game.localPlayer.position2D

    local path1 = Clipper.CreatePath64FromVectors({
        Math.Vector2(pos.x - 300, pos.y - 300),
        Math.Vector2(pos.x + 300, pos.y - 300),
        Math.Vector2(pos.x + 300, pos.y + 300),
        Math.Vector2(pos.x - 300, pos.y + 300),
    })

    local path2 = Clipper.CreatePath64FromVectors({
        Math.Vector2(pos.x - 200 + 300, pos.y - 200),
        Math.Vector2(pos.x + 200 + 300, pos.y - 200),
        Math.Vector2(pos.x + 200 + 300, pos.y + 200),
        Math.Vector2(pos.x - 200 + 300, pos.y + 200),
    })

    local union = Clipper.Union(Clipper.CreatePaths64({path1}), Clipper.CreatePaths64({path2}), Clipper.FillRule.NonZero)

    Renderer.DrawPaths(union, 1, Clipper.PointInPolygons(Game.GetCursorWorldPosition(), union) and 0xFF00FF00 or 0xFFFF0000)
end)

```

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

### Basic ImGui UI Example

Source: https://docs.legendsen.se/developers/sdk-documentation/renderer/renderer-imgui

Demonstrates the creation of a basic ImGui window with various UI elements such as text, buttons, checkboxes, and progress bars. This is useful for debugging and creating simple developer tools.

```lua
local mainWindowOpen = true
local myCheckBox = true
Callback.Bind(CallbackType.OnImguiDraw, function()
    ImGui.SetNextWindowSize(500, 500)

    mainWindowOpen = ImGui.Begin("My Window", mainWindowOpen, ImGuiWindowFlags.NoResize)

    ImGui.Text("Well hello there, General Kenobi")
    ImGui.TextColored(1, 1, 0, 1, "Well hello there, General Kenobi")
    ImGui.TextDisabled("List:")
    ImGui.BulletText("One")
    ImGui.BulletText("Two")

    ImGui.Text("Buttons:")
    ImGui.Button("50x50", 50, 50) ImGui.SameLine() ImGui.SmallButton("Small Button")
    myCheckBox = ImGui.Checkbox("My Checkbox", myCheckBox)

    ImGui.Text("Progress bar:")
    ImGui.ProgressBar(0.4, 400, 25, "40%")
      
    ImGui.End()
end)
```

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

### Initialize and Use Clipper64 for Union Operation

Source: https://docs.legendsen.se/developers/sdk-documentation/library/clipper/clipper64

Demonstrates how to initialize a Clipper64 object, add subject paths, execute a union operation, and draw the resulting polygon. This example utilizes the `new`, `Clear`, `AddSubject`, `Execute`, and `CreatePath64FromVectors` methods.

```lua
local Clipper64 = Clipper.Clipper64.new();

Callback.Bind(CallbackType.OnDraw, function()
    Clipper64:Clear()
      
    local pos = Game.localPlayer.position2D  

    local path1 = Clipper.CreatePath64FromVectors({
        Math.Vector2(pos.x - 300, pos.y - 300),
        Math.Vector2(pos.x + 300, pos.y - 300),
        Math.Vector2(pos.x + 300, pos.y + 300),
        Math.Vector2(pos.x - 300, pos.y + 300),
    })

    local path2 = Clipper.CreatePath64FromVectors({
        Math.Vector2(pos.x - 200 + 300, pos.y - 200),
        Math.Vector2(pos.x + 200 + 300, pos.y - 200),
        Math.Vector2(pos.x + 200 + 300, pos.y + 200),
        Math.Vector2(pos.x - 200 + 300, pos.y + 200),
    })

    Clipper64:AddSubject(path1)
    Clipper64:AddSubject(path2)

    local paths = Clipper.CreatePaths64({}) -- Output
    Clipper64:Execute(Clipper.ClipType.Union, Clipper.FillRule.NonZero, paths)

    -- Determine color based on whether our cursor is inside this polygon or not:  
    local color = Clipper.PointInPolygons(Game.GetCursorWorldPosition(), union) and 0xFF00FF00 or 0xFFFF0000  

    -- Draw:
    Renderer.DrawPaths(union, 1, color)
end)
```

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

### Find Immobile Enemy and Cast Q

Source: https://docs.legendsen.se/developers/sdk-documentation/objectmanager

This example demonstrates how to iterate through enemy heroes, check if they are valid targets within Q's range, verify if they are immobile, and then cast Q on the first suitable enemy found. It utilizes the ObjectManager.enemyHeroes list and a hypothetical Q ability object.

```lua
for _, entity in ObjectManager.enemyHeroes:pairs() do
    if entity:IsValidTarget(Q.range) and not Champions.CanMove(entity, 0.1) and Q:Cast(entity, menu.Q.hitChanceQ) then
        return
    end
end
```

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

### Start Spell Charging

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/sdkspell

Initiates the charging sequence for a spell at a given position. This function is for spells that require a charge-up time before being cast.

```lua
SDKSpell:StartCharging(pos: Vector3, usePacket: boolean) → boolean
```

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

### Get Buff Stacks by Hash

Source: https://docs.legendsen.se/developers/sdk-documentation/class/aibaseclient

Returns the number of stacks for a buff identified by its FNV hash. Useful for buffs that have multiple stacks.

```lua
AIBaseClient:GetBuffStacks(hash: number - Integer) → number
```

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

### Example: Force Target Under Cursor using TargetSelector

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/targetselector

Demonstrates how to use TargetSelector.SetForcedTarget within a tick callback to force the target under the player's cursor. It checks if the hovered unit is valid before setting it.

```lua
Callback.Bind(CallbackType.OnTick, function()
    local hover = Game.GetHoveredUnit()
    TargetSelector.SetForcedTarget(hover and hover:IsValid() and hover or nil)
end)

```

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

### Create ColorInfo with Gradient (Lua)

Source: https://docs.legendsen.se/developers/sdk-documentation/renderer/colorinfo

Constructs a ColorInfo object with a starting color, ending color, and a specified gradient type. This function is deprecated and intended for backwards compatibility, with ColorData being the recommended alternative.

```lua
local color = Renderer.ColorInfo.new(0xFFFFFFFF, 0xFF5555FF, Renderer.GradientType.Linear)
```

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

### Get Damage Function Map and Customize Spell Damage

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/damagelib

Retrieves a map of spell damage calculation functions and demonstrates how to customize the damage calculation for a specific spell (Lux's Q). This allows developers to extend or overwrite existing damage calculations.

```lua
local LuxLightBindingSpellDataHash = Game.spelldataHash("LuxLightBinding") -- Spell Data hash is used as key for damageMap  
local damageMap = DamageLib.GetDamageFunctionMap()  
damageMap[LuxLightBindingSpellDataHash] = function(source, target, bRawDamage, stage)  
    rawDamage = 100  
    return bRawDamage and rawDamage or DamageLib.CalculateMagicalDamage(source, target, rawDamage)  
end  
```

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

### Get Pet Handle by Index (Lua)

Source: https://docs.legendsen.se/developers/sdk-documentation/class/aibaseclient

Retrieves an entity's pet handle by its index. This function is useful for iterating through and interacting with multiple pets associated with an entity. It requires checking if the pet handle is valid and then resolving it to an AIBaseClient object.

```lua
local petHandleSize = Game.localPlayer:GetPetHandleSize()
if petHandleSize > 0 then
    for i=0, petHandleSize-1 do
        local petHandle = Game.localPlayer:GetPetHandleByIndex(i)
        local pet = petHandle and ObjectManager.ResolveHandle(petHandle)
        if pet and pet:IsValid() then
            print(pet:GetUniqueName())
        end
    end
end
```

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

### Get Circle Collision Position (Vector3)

Source: https://docs.legendsen.se/developers/sdk-documentation/math/vector3

Calculates a collision position based on inner and outer radii and a team flag, useful for determining intersection points with circular areas. An example demonstrates checking if a Qiyana W ability intersects water.

```lua
function GetCircleCollisionPosition(innerRadius: number, outerRadius: number, teamFlag: number) -> Vector3
-- Returns collision position with a circle.
-- Example: Check for Qiyana W if intersects water.
-- Game.localPlayer.position:GetCircleCollisionPosition(0,366,0):IsWater()
end
```

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

### Create and Configure SDKSpell Instances (Lua)

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/champions

This snippet shows how to create SDKSpell instances for different spell slots (Q, W, E, R) and then configure their skillshot properties. It emphasizes the importance of calling Champions.Clean() on unload and notes the use of math.flt_max for spell speed.

```Lua
-- Creating SDKSpell instances: 
-- IMPORTANT: Make sure to call Champions.Clean() OnUnload to clear these instances! 
Champions.Q = SDKSpell.Create(SpellSlot.Q, 1400, DamageType.Magical) 
Champions.W = SDKSpell.Create(SpellSlot.W, 100, DamageType.Magical) 
Champions.E = SDKSpell.Create(SpellSlot.E, 1200, DamageType.Magical) 
Champions.R = SDKSpell.Create (SpellSlot.R, 5500, DamageType.Magical) 

-- Set skillshot: 
Champions.Q:SetSkillshot(0.25, 60, 1000, SkillshotType.SkillshotLine, true, CollisionFlag.CollidesWithYasuoWall, HitChance.High, true) 
Champions.R:SetSkillshot(1, 65, math.flt_max, SkillshotType.SkillshotCircle, false, CollisionFlag.CollidesWithNothing, HitChance.High, true) 
-- Please note how we use math.flt_max for speed instead of math.huge, this is important 

Callback.Bind(CallbackType.OnUnload, function() 
    Champions.Clean() -- Clean up 
    return CallbackResult.Dispose 
end)
```

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

### Callback System Reference

Source: https://docs.legendsen.se/developers/sdk-documentation/callbacks

This section details the enums, arguments, and callback functions available in the Callback System, including how to bind and unbind event handlers.

```APIDOC
## Callback System Reference

### Description
Provides reference for callback types, arguments, function signatures, and overall usage within the Callback System.

### Enums
Details available enumerations for callback system.

### Arguments
Details available arguments for callback functions.

### Callback

#### Description
Allows binding and unbinding of event handlers (callbacks).

#### Method
POST /callbacks

#### Endpoint
/callbacks

#### Parameters
##### Request Body
- **eventName** (string) - Required - The name of the event to bind or unbind.
- **callbackFunction** (function) - Required - The function to be executed when the event is triggered.

### Callback Signatures

#### Description
Details the expected signatures for callback functions.

#### Method
GET /callback-signatures

#### Endpoint
/callback-signatures

#### Response
##### Success Response (200)
- **signatures** (array) - An array of available callback function signatures.
  - **name** (string) - The name of the signature.
  - **arguments** (array) - An array of argument descriptions for the signature.
    - **name** (string) - The name of the argument.
    - **type** (string) - The data type of the argument.
    - **description** (string) - A description of the argument.
```

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

### Draw Fancy Glow Circle - Renderer

Source: https://docs.legendsen.se/developers/sdk-documentation/renderer/renderer-api

Draws a fancy glow circle using shaders. Requires a unique hash, position, radius, color data, and optional drawing options. The example demonstrates drawing animated spheres with customizable rendering stages and effects.

```lua
Callback.Bind(CallbackType.OnDraw, function() 
    for i = 1, 10, 1 do 
        local tbl = { 
            renderStage = Renderer.RenderStage.HUD, 
            isUsingDepth = false, 
            isUsingHeightMap = false, 
            isCulling = false, 
            rotation = Math.Vector3((Game.GetTime() + i * 0.5 * 1) % (math.pi*2), (Game.GetTime() + i * 0.5 * 1) % (math.pi*2), (Game.GetTime() + i * 0.5 * 1) % (math.pi*2)), 
            blurIn = 30, 
            blurOut = 30, 
        } 
        Renderer.DrawCircleGlow(Game.fnvhash("ExampleB_CircleGlowA" .. i), Game.localPlayer.position, 200 + math.sin(Game.GetTime()) * (50 + i*10) + (50 + i*10), Renderer.ColorData(Renderer.GradientType.Linear, 0x110000FF, 0x11FF0000, ((Game.GetTime()*2 + i) % (math.pi*2)) * 2), tbl)
    end 
    for i = 1, 10, 1 do 
        local tbl = { 
            renderStage = Renderer.RenderStage.HUD, 
            isUsingDepth = true, 
            isUsingHeightMap = false, 
            isCulling = false, 
            rotation = Math.Vector3((Game.GetTime() + i * 0.5 * 1) % (math.pi*2), (Game.GetTime() + i * 0.5 * 1) % (math.pi*2), (Game.GetTime() + i * 0.5 * 1) % (math.pi*2)), 
        } 
        Renderer.DrawCircleGlow(Game.fnvhash("ExampleB_CircleGlowB" .. i), Game.localPlayer.position, 200 + math.sin(Game.GetTime()) * (50 + i*10) + (50 + i*10), Renderer.ColorData(Renderer.GradientType.Linear, 0x77FFFFFF, 0x77FF0000, ((Game.GetTime()*2 + i) % (math.pi*2)) * 2), tbl)
    end 
end)
```

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

### TargetSelector.GetTarget (Overload 2)

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/targetselector

Gets the best target with a custom filter function.

```APIDOC
## GET TargetSelector.GetTarget (with filter)

### Description
Returns the best target based on specified criteria and a custom filter function.

### Method
GET

### Endpoint
`/TargetSelector/GetTarget`

### Parameters
#### Query Parameters
- **range** (number) - Required - Check range.
- **damageType** (DamageType) - Required - Damage type.
- **from** (Vector3) - Required - Check from.
- **addBoundingRadius** (boolean) - Required - Should add target bounding radius.
- **filterFn** (function) - Required - Custom filter function.

### Response
#### Success Response (200)
- **AIHeroClient** - The best target found according to the filter.
```

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

### Access and Override Orbwalker Settings (Lua)

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/ui/ui-api

Demonstrates how to access and temporarily override settings within the UI's root menus, specifically the Orbwalker's HoldRadius. This example uses Lua and includes functions to push and pop setting values, ensuring proper restoration.

```lua
-- Warning: This is just a PoC to give you an idea how it can be done. 
-- We highly advice not to mess around with settings, but if you have to - then please be responsible. 
-- If you override some value - make sure to restore it immediately after you executed your logic. 

local orbwalkerMenu 
for _, v in UI.rootMenus:pairs() do 
    if v and v.name and v.name == "Orbwalker" then -- Locate Orbwalker Menu 
        orbwalkerMenu = v 
        break 
    end 
end 
local holdRadius = orbwalkerMenu["Configuration"]["HoldRadius"] -- Access HoldRadius setting 
local originalHoldRadius 
local function PushHoldRadius(value) 
    if originalHoldRadius then return end -- Make sure we don't override it twice 
    originalHoldRadius = holdRadius.value -- Store original value 
    holdRadius.value = value -- Override value 
end 
local function PopHoldRadius() 
    if not originalHoldRadius then return end 
    holdRadius.value = originalHoldRadius 
    originalHoldRadius = nil 
end 

local function MyLogic() 
    PushHoldRadius(50) -- Override 
    -- Perform logic 
    PopHoldRadius() -- Restore 
end 

Callback.Bind(CallbackType.OnUnload, function() 
    PopHoldRadius() -- Just in case do it OnUnload 
    return CallbackResult.Dispose 
end)
```

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

### TargetSelector.GetTarget (Overload 1)

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/targetselector

Gets the best target based on specified criteria.

```APIDOC
## GET TargetSelector.GetTarget

### Description
Returns the best target based on range, damage type, origin, and bounding radius.

### Method
GET

### Endpoint
`/TargetSelector/GetTarget`

### Parameters
#### Query Parameters
- **range** (number) - Required - Check range.
- **damageType** (DamageType) - Required - Damage type.
- **from** (Vector3) - Required - Check from.
- **addBoundingRadius** (boolean) - Required - Should add target bounding radius.

### Response
#### Success Response (200)
- **AIHeroClient** - The best target found.
```

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

### Get Spell Cooldown

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/sdkspell

Returns the current cooldown time remaining for the spell. This information is vital for timing spell usage.

```lua
SDKSpell:Cooldown() → number
```

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

### CreateMenu Function

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/ui/menu

Creates and returns a root menu item.

```APIDOC
## CreateMenu Function

### Description
Creates and returns a root menu item with specified internal name, display name, and base page.

### Method
`Menu:CreateMenu(name: string, displayName: string, page: number) -> Menu`

### Parameters
#### Arguments
- **name** (string) - Required - Internal name of the menu.
- **displayName** (string) - Required - Display name of the menu.
- **page** (number) - Required - Base menu page.
```

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

### Get Spell Data Instance

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/sdkspell

Retrieves the data instance associated with the spell. This can provide access to detailed spell information.

```lua
SDKSpell:DataInstance() → SpellBookEntry
```

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

### Use Object

Source: https://docs.legendsen.se/developers/sdk-documentation/class/aibaseclient

Allows the client to use an object, such as a lantern. It takes an AttackableUnit as a target.

```lua
AIBaseClient:UseObject(target: AttackableUnit) → void
```

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

### Common.Queue Creation

Source: https://docs.legendsen.se/developers/sdk-documentation/library/common/common-api

Creates and returns an empty Queue instance or a Queue instance based on an initial table of elements.

```APIDOC
## Common.Queue

### Description
Creates and returns a Queue instance. Can be initialized as empty or with a table of elements.

### Method
`Common.Queue()` or `Common.Queue(t)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **t** (any[]) - Optional - A table with elements to initialize the queue. Indices start from 1.

### Request Example
```lua
local emptyQueue = Common.Queue()
local initializedQueue = Common.Queue({1, 2, 3})
```

### Response
#### Success Response (Queue)
Returns a new Queue instance.

#### Response Example
```lua
-- Example of a Queue object (structure may vary)
{
  -- internal queue data
}
```
```

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

### Get Incoming Damage From Unit

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/healthprediction/healthprediction-api

Retrieves the total incoming damage dealt by a specific unit to a target unit.

```typescript
HealthPrediction.GetIncomingDamageFrom(
  unit: AIBaseClient
) → number
```

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

### Renderer.ColorData Constructor (Full)

Source: https://docs.legendsen.se/developers/sdk-documentation/renderer/colordata

Constructs a ColorData object with gradient details.

```APIDOC
## POST /renderer/ColorData (Constructor - Full)

### Description
Creates a new ColorData instance with specified gradient type, two colors, and optional gradient angle and factor.

### Method
POST

### Endpoint
/renderer/ColorData

### Parameters
#### Request Body
- **gradientType** (GradientType) - Required - The type of gradient.
- **from** (number - D3DCOLOR) - Required - The main color.
- **to** (number - D3DCOLOR) - Required - The secondary color for the gradient.
- **gradientAngle** (number) - Optional - The angle of the gradient.
- **gradientFactor** (number) - Optional - The factor of the gradient.

### Request Example
```json
{
  "gradientType": "Linear",
  "from": 16777215,
  "to": 0,
  "gradientAngle": 45.0,
  "gradientFactor": 0.7
}
```

### Response
#### Success Response (200)
- **ColorData** (object) - The newly created ColorData object.

#### Response Example
```json
{
  "from": 16777215,
  "to": 0,
  "gradientType": "Linear",
  "gradientAngle": 45.0,
  "gradientFactor": 0.7
}
```
```

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

### Get Spell Level

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/sdkspell

Returns the current level of the spell. Spell levels often correspond to increased power or reduced cooldowns.

```lua
SDKSpell:Level() → number
```

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

### Get Health Prediction

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/healthprediction/healthprediction-api

Retrieves the predicted health of a unit at a given time. Optionally includes hero attacks in the prediction.

```typescript
HealthPrediction.GetHealthPrediction(
  unit: AIBaseClient,
  time: number,
  includeHeroesAttack?: boolean
) → number
```

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

### Load and Draw Image

Source: https://docs.legendsen.se/developers/sdk-documentation/renderer/renderer-imgui

Loads an image from a file path and returns a handle, which can then be used to draw the image using `DrawImage` or `DrawImageInWindow`. Remember to release the image resource using `ReleaseImage` in the `OnUnload` callback to prevent memory leaks. Ensure file paths use double backslashes.

```lua
local imageHandle = Renderer.LoadImageFromFile("assets\\Default_Texture_A.png") -- Load image
Callback.Bind(CallbackType.OnImguiDraw, function()
    if imageHandle then
        Renderer.DrawImage(imageHandle, Math.Vector2(100, 50), Math.Vector2(600, 100))
    end
end)
Callback.Bind(CallbackType.OnUnload, function()
    Renderer.ReleaseImage(imageHandle) -- IMPORTANT: Release it when disposing
end)
```

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

### Get Grass Group ID

Source: https://docs.legendsen.se/developers/sdk-documentation/class/aibaseclient

Retrieves the ID of the current grass group the entity is within. This function does not require any arguments.

```lua
AIBaseClient:GetGrassGroupToIgnore() → number
```

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

### LoadImageFromFile

Source: https://docs.legendsen.se/developers/sdk-documentation/renderer/renderer-imgui

Loads an image from a file path and returns a handle for use with ImGui functions.

```APIDOC
## POST /Renderer/LoadImageFromFile

### Description
Loads an image from the specified file path. This image can then be drawn using ImGui functions. Returns a unique handle for the image.

### Method
POST

### Endpoint
/Renderer/LoadImageFromFile

### Parameters
#### Request Body
- **filePath** (string) - Required - The relative path to the image file. Use double backslashes (\\) for paths.

### Request Example
```json
{
  "filePath": "assets\\Default_Texture_A.png"
}
```

### Response
#### Success Response (200)
- **imageHandle** (number - integer) - A unique handle to the loaded image.

#### Response Example
```json
{
  "imageHandle": 12345
}
```
```

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

### Get Spell Charge Percentage

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/sdkspell

Returns the current charge percentage of a spell that can be charged. This is useful for UI elements displaying charge progress.

```lua
SDKSpell:ChargePercent() → number
```

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

### Environment.LoadModule

Source: https://docs.legendsen.se/developers/sdk-documentation/environment

Loads a Lua submodule from a specified relative path.

```APIDOC
## Environment.LoadModule

### Description
Loads a Lua submodule from the given relative path.

### Method
`Environment.LoadModule`

### Endpoint
N/A (This is a function call within a Lua environment)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```lua
Environment.LoadModule("path/to/your/module.lua")
```

### Response
#### Success Response (void)
This function does not return any value.

#### Response Example
N/A
```

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

### Access ChampionSpellNetworkData Instance

Source: https://docs.legendsen.se/developers/sdk-documentation/class/championspellnetworkdata

Demonstrates how to access the singleton instance of ChampionSpellNetworkData. This is the primary way to interact with the spell network data.

```lua
local instance = ChampionSpellNetworkData.Instance()
```

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

### Get Spell Mana Cost

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/sdkspell

Returns the mana cost required to cast the spell. This value is crucial for managing player resources during gameplay.

```lua
SDKSpell:ManaCost() → number
```

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

### Circle Building Functions

Source: https://docs.legendsen.se/developers/sdk-documentation/math/math-api

Generates points to form a circle. `BuildCircle` creates a standard circle, while `BuildSafeCircle` offers an option for a safe offset.

```lua
Math.BuildCircle(center: Vector2, radius: number, quality: number) → Vector2[]
Math.BuildSafeCircle(center: Vector2, radius: number, sides: number, bSafeOffset: boolean) → Vector2[]
```

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

### Get UI Language

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/ui/ui-api

Retrieves the currently selected language from the UI. Returns an integer representing the language.

```javascript
UI.GetLanguage()
```

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

### Create ColorInfo with Two Colors (Lua)

Source: https://docs.legendsen.se/developers/sdk-documentation/renderer/colorinfo

Initializes a ColorInfo object using two D3DCOLOR values, representing the main and secondary colors for gradient effects. This constructor is deprecated and maintained for legacy support; ColorData is preferred for new implementations.

```lua
local color = Renderer.ColorInfo.new(0xFFFFFFFF, 0xFF5555FF)
```

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

### Get Buff by Index

Source: https://docs.legendsen.se/developers/sdk-documentation/class/aibaseclient

Retrieves a specific buff from the entity's buff array using its index. Returns a Buff object.

```lua
AIBaseClient:GetBuff(index: Integer) → Buff
```

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

### MakePath

Source: https://docs.legendsen.se/developers/sdk-documentation/library/clipper/clipper-api

Builds a Path64 from a string of coordinates.

```APIDOC
## MakePath

### Description
Builds Path64 from a string with given coordinates.

### Method
Not specified (assumed to be a function call within the SDK)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
*   **pathStr** (string) - A string containing the coordinates to build the path.

### Request Example
```lua
Clipper.MakePath(pathStr)
```

### Response
#### Success Response (200)
*   **Path64**: The generated path.

### Notes
This function may differ in recent Clipper versions.

#### Response Example
(No specific example provided in the source text)
```

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

### Point64 Structure Overview

Source: https://docs.legendsen.se/developers/sdk-documentation/library/clipper/point64

This section details the properties and functions available for the Point64 structure.

```APIDOC
## Point64 Structure

### Description
The Point64 structure is used to represent a single vertex (or coordinate) in a series that together make a path or contour. All coordinates are represented internally using integers.

### Properties
- **x** (number) - X coordinate.
- **y** (number) - Y coordinate.

### Functions
#### Negate
- **Description**: Negates coordinates of this Point64.
- **Method**: (Implicitly part of the Point64 object)
- **Returns**: void

#### __mul (Multiplication Operator)
- **Description**: Multiplies the Point64 coordinates by a scale factor.
- **Method**: (Implicitly part of the Point64 object)
- **Parameters**:
  - **scale** (number) - Required - Multiplicator.
- **Returns**: Point64

#### __add (Addition Operator)
- **Description**: Adds another Point64 to this Point64.
- **Method**: (Implicitly part of the Point64 object)
- **Parameters**:
  - **point** (Point64) - Required - The second point to add.
- **Returns**: Point64

#### __sub (Subtraction Operator)
- **Description**: Subtracts another Point64 from this Point64.
- **Method**: (Implicitly part of the Point64 object)
- **Parameters**:
  - **point** (Point64) - Required - The second point to subtract.
- **Returns**: Point64

#### __tostring (Tostring Operator)
- **Description**: Converts the Point64 to its string representation.
- **Method**: (Implicitly part of the Point64 object)
- **Returns**: string
```

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

### Get Game Resolution - Renderer

Source: https://docs.legendsen.se/developers/sdk-documentation/renderer/renderer-api

Retrieves the current resolution of the game. Returns a Vector2 object representing the width and height.

```lua
Renderer.GetResolution()
```

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

### Get Spell Damage

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/sdkspell

Calculates the damage a spell will deal to a target at a specific stage. This is useful for damage calculation modules and understanding spell effectiveness.

```lua
SDKSpell:GetDamage(target: AIBaseClient, stage: integer) → number
```

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

### Replace Lux Q Damage Calculation with SDK

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/damagelib

This Lua snippet demonstrates how to replace the default Lux Q damage calculation function using the SDK. It retrieves damage from the tooltip and prints it. It utilizes spell data hashes and FNV hashes for accessing spell information and tooltip properties.

```lua
local LuxLightBindingSpellDataHash = Game.spelldataHash("LuxLightBinding") -- Spell Data hash is used as key for damageMap
local LuxLightBindingHash = Game.fnvhash("LuxLightBinding") -- FNV hash is used by AIBaseClient:GetSpellSlot(spellHash)
local TotalDamageHash = Game.fnvhash("TotalDamageTT") -- FNV hash is used to access tooltip property with SpellBookEntry:GetCalculateInfo(...)
local damageMap = DamageLib.GetDamageFunctionMap()

damageMap[LuxLightBindingSpellDataHash] = function(source, target, bRawDamage, stage) 
    local slot = source:GetSpellSlot(LuxLightBindingHash) -- This uses fnv hash
    if slot == SpellSlot.NullSlot then
        return 0
    end

    local entry = source:GetSpellEntry(slot)
    if not entry or not entry:IsValid() then
        return 0
    end

    local rawDamage = entry:GetCalculateInfo(source, TotalDamageHash, slot)

    if bRawDamage or not target or not target:IsValid() then
        return rawDamage
    end

    return DamageLib.CalculateMagicalDamage(source, target, rawDamage)
end

local Q = SDKSpell.Create(SpellSlot.Q, 1300, DamageType.Magical)
print("Q Damage", Q:GetDamage(Game.localPlayer)) -- This will use our custom damage calc function
```

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

### Get Auto Attack Range

Source: https://docs.legendsen.se/developers/sdk-documentation/class/aibaseclient

Calculates the entity's actual auto-attack range, accounting for specific hero mechanics. The target can be null.

```lua
AIBaseClient:GetAutoAttackRange(target: AttackableUnit) → number
```

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

### SDKSpell:StartCharging

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/sdkspell

Initiates the charging sequence for a spell at a specified position.

```APIDOC
## SDKSpell:StartCharging

### Description
Initiates the charging sequence for a spell at a specified position. This is typically used for spells that require a charge-up time before release.

### Method
POST (Assumed, as it modifies game state)

### Endpoint
/SDKSpell/StartCharging

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **pos** (Vector3) - Required - The position where the spell charging should start.
- **usePacket** (boolean) - Optional - Whether to use packet casting (defaults to false).

### Request Example
```json
{
  "pos": {"x": 300, "y": 0, "z": 100},
  "usePacket": true
}
```

### Response
#### Success Response (200)
- **return_value** (boolean) - True if the charging sequence was successfully initiated, false otherwise.

#### Response Example
```json
{
  "return_value": true
}
```
```

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

### DrawLine3D (Vector3)

Source: https://docs.legendsen.se/developers/sdk-documentation/renderer/renderer-imgui

Draws a 3D line segment in the scene using specified start and end points, color, and thickness.

```APIDOC
## POST /Renderer/DrawLine3D

### Description
Draws a 3D line segment using Vector3 points.

### Method
POST

### Endpoint
/Renderer/DrawLine3D

### Parameters
#### Request Body
- **p1** (Vector3) - Required - Start position of the line.
- **p2** (Vector3) - Required - End position of the line.
- **color** (number - D3DCOLOR) - Required - The color of the line.
- **thickness** (number - float) - Required - The thickness of the line.

### Request Example
```json
{
  "p1": {"x": 0.0, "y": 0.0, "z": 0.0},
  "p2": {"x": 1.0, "y": 1.0, "z": 1.0},
  "color": 4294967295,
  "thickness": 1.0
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### Vector3:Unpack() - Get Coordinates

Source: https://docs.legendsen.se/developers/sdk-documentation/math/vector3

Returns the x, y, and z components of the vector as three separate number values. This is a convenient way to access all coordinates at once.

```lua
local vec = Vector3.new(10, 20, 30)
local x, y, z = vec:Unpack()

print(x, y, z) -- Output: 10 20 30
```

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

### Configure Charged Spell

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/sdkspell

Sets up parameters for a charged spell, such as Varus's Q. Requires spell name, buff name, min/max range, and duration. This allows for defining the behavior of spells that can be charged for increased effect.

```lua
SDKSpell:SetCharged(
  spellName: string,
  buffName: string,
  minRange: number,
  maxRange: number,
  duration: number
) → void
```

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

### Get Direction Vector from Orientation using Math.GetDirectionFromOrientation

Source: https://docs.legendsen.se/developers/sdk-documentation/math/math-api

Calculates the direction vector from an orientation matrix. It can take either an EffectEmitter object or a D3DMATRIX as input.

```lua
Math.GetDirectionFromOrientation(obj: EffectEmitter) -> Vector2
Math.GetDirectionFromOrientation(matrix: _D3DMATRIX) -> Vector2
```

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

### ChampionTracker API

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/championtracker

This section details the properties and functions available for the ChampionTracker.

```APIDOC
## ChampionTracker Properties

### Description
Properties associated with a ChampionTracker instance.

### Properties
- **source** (AIHeroClient) - The source of the champion information.
- **lastPosition** (Vector3) - The last known position of the champion.
- **lastWayPoint** (Vector3) - The last waypoint the champion was heading towards.
- **invisibleSince** (number) - Timestamp when the champion became invisible.
- **invisibleTimeCount** (number) - Duration the champion has been invisible.
- **lastAuroWardTime** (number) - Timestamp of the last aura ward interaction.
- **teleportInfo** (TeleportInfo) - Information related to the champion's teleportation status.

## ChampionTracker Functions

### GetChampionInfomation

#### Description
Retrieves a ChampionTracker instance for a given champion network handle.

#### Method
GET (simulated)

#### Endpoint
`/ChampionTracker/GetChampionInfomation`

#### Parameters
##### Query Parameters
- **nethandle** (integer) - Required - The network handle of the champion.

#### Response
##### Success Response (200)
- **ChampionTracker** (ChampionTracker) - A ChampionTracker instance if the champion is found.

### GetSkirmishData

#### Description
Retrieves skirmish data associated with the ChampionTracker.

#### Method
GET (simulated)

#### Endpoint
`/ChampionTracker/GetSkirmishData`

#### Response
##### Success Response (200)
- **skirmishData** - The skirmish data for the champion tracker.
```

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

### Vector3:Direction() - Get Normalized Direction

Source: https://docs.legendsen.se/developers/sdk-documentation/math/vector3

Returns a normalized Vector3 representing the direction from the origin to the vector's endpoint. This is equivalent to calling Normalized() on the vector.

```lua
local vec = Vector3.new(3, 4, 0)
local direction_vec = vec:Direction()

print(direction_vec.x, direction_vec.y, direction_vec.z) -- Output: 0.6 0.8 0.0
```

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

### Renderer.ColorData Constructor (Default)

Source: https://docs.legendsen.se/developers/sdk-documentation/renderer/colordata

Constructs a default ColorData object.

```APIDOC
## POST /renderer/ColorData (Constructor - Default)

### Description
Creates a new ColorData instance with default values.

### Method
POST

### Endpoint
/renderer/ColorData

### Parameters
No parameters required for the default constructor.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **ColorData** (object) - The newly created default ColorData object.

#### Response Example
```json
{
  "from": 0,
  "to": 0,
  "gradientType": "None",
  "gradientAngle": 0.0,
  "gradientFactor": 0.0
}
```
```

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

### Get Spell Prediction

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/sdkspell

Retrieves the predicted movement or outcome for a target unit. This function is crucial for skillshot spells, allowing developers to calculate the best time and position to cast.

```lua
SDKSpell:GetPrediction(target: AIBaseClient) → PredictionOutput
```

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

### IncomingDamage Class Properties

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/healthprediction/incomingdamage

This section details the properties available within the IncomingDamage class.

```APIDOC
## IncomingDamage Class

### Description
Represents incoming damage information in the game, including details about the source, target, and damage characteristics.

### Properties

- **`source`** (AIBaseClient) - The client representing the source of the damage.
- **`target`** (AIBaseClient) - The client representing the target of the damage.
- **`sourceMissile`** (MissileClient) - The missile client associated with the damage, if any.
- **`damage`** (number - float) - The amount of damage dealt.
- **`castDelay`** (number - float) - The delay before the damage was cast.
- **`totalDelay`** (number - float) - The total delay associated with the damage event.
- **`hasMissile`** (boolean) - Indicates whether the damage event involves a missile.
- **`wasCast`** (boolean) - Indicates whether the damage event was successfully cast.
- **`removed`** (boolean) - Indicates whether the damage event has been removed or invalidated.
- **`spellData`** (Spell) - The spell data associated with the damage.
- **`missileNID`** (number - unsigned) - The network ID of the missile, if applicable.
- **`timeStart`** (number - float) - The timestamp when the damage event started.
- **`buffTrigger`** (boolean) - Indicates if a buff was triggered by this damage event.
- **`buff`** (Buff) - The buff object associated with the damage event, if any.
- **`sourcePosition`** (Vector3) - The world position of the damage source.
- **`endPosition`** (Vector3) - The world position where the damage effect ends.
```

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

### Get Skillshot Damage from Caster

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/evade/evade-api

Returns the total damage from skillshots cast by a specific caster unit. This function takes an AIBaseClient object representing the caster as input.

```lua
Evade.GetSkillshotsDamageFrom(caster)
```

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

### Create Base Champion Menu

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/champions

Creates the fundamental menu structure for a champion, allowing for the selection of prediction types. It takes a UI.Menu object and an integer representing the prediction type (0 for default, 1 for fast).

```javascript
Champions.CreateBaseMenu(
  menu: UI.Menu,
  predictionType: integer - 0-1
) → void
```

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

### Get Incoming Damage

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/healthprediction/healthprediction-api

Calculates the total predicted incoming damage to a unit within a specified time frame. Allows customization to include or exclude skillshots and auto-attacks.

```typescript
HealthPrediction.GetIncomingDamage(
  unit: AIBaseClient,
  time: number,
  includeSkillshot?: boolean,
  includeAutoAttacks?: boolean
) → number
```

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

### PredictionInput Constructor (Full)

Source: https://docs.legendsen.se/developers/sdk-documentation/sdk-types-and-functions/prediction/predictioninput

Creates a new PredictionInput object with all available parameters for detailed prediction.

```APIDOC
## PredictionInput.new (Full Constructor)

### Description
Initializes a PredictionInput object with a comprehensive set of parameters for precise skillshot prediction.

### Method
`PredictionInput.new(
  from: Vector3,
  rangeCheckFrom: Vector3,
  delay: float,
  radius: float,
  range: float,
  speed: float,
  type: SkillshotType,
  target: AIBaseClient,
  bUseBoundingRadius: boolean,
  bCollision: boolean,
  collisionFlags: CollisionFlag,
  bAoe: boolean,
  startOffset: float
)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **from** (Vector3) - Required - The starting position of the skillshot.
- **rangeCheckFrom** (Vector3) - Required - The position for range checks.
- **delay** (float) - Required - The delay in seconds.
- **radius** (float) - Required - The radius of the skillshot.
- **range** (float) - Required - The maximum range of the skillshot.
- **speed** (float) - Required - The speed of the skillshot.
- **type** (SkillshotType) - Required - The type of skillshot.
- **target** (AIBaseClient) - Required - The target unit.
- **bUseBoundingRadius** (boolean) - Required - Use target's bounding radius.
- **bCollision** (boolean) - Required - Enable collision detection.
- **collisionFlags** (CollisionFlag) - Required - Flags for collision types.
- **bAoe** (boolean) - Required - Whether the skillshot is area of effect.
- **startOffset** (float) - Required - An offset from the start position.
```
Tokens:
Raw