Fatality.win

https://lua2.fatality.win/
Admin
Fatality.win is a Lua scripting platform that provides an API for creating custom scripts with UI...
Tokens:99,834
Snippets:1,381
Trust Score:6.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Complete UI Integration Example

Source: https://lua2.fatality.win/introduction/creating-scripts/adding-ui.md

A full example demonstrating checkbox creation, group addition, and conditional rendering based on the checkbox state.

```lua
local cb, row = gui.MakeControlEasy('my_checkbox', 'Checkbox', 'checkbox');
local group = gui.ctx:Find('lua>elements a');
group:Add(row);

local function onPresentQueue()
    if cb:GetValue():Get() then
        local d = draw.surface;
        d.font = draw.fonts['gui_main'];
        d:AddText(draw.Vec2(50, 50),
            'Hello drawing! My first script speaking.',
            draw.color.White()
        );
    end
end

events.presentQueue:Add(onPresentQueue);
```

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

### GET /api/instances/gui/notificationsystem.md

Source: https://lua2.fatality.win/api/instances/gui/notificationsystem.md

Query the documentation dynamically by performing an HTTP GET request on the page URL.

```APIDOC
## GET /api/instances/gui/notificationsystem.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page.

### Method
GET

### Endpoint
/api/instances/gui/notificationsystem.md

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

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

### AddWithFrost Lua Example

Source: https://lua2.fatality.win/api/instances/draw/layer.md

Renders a section with a frosted glass effect.

```lua
layer:AddWithFrost(draw.Rect(0, 0, 200, 200), function()
    layer:AddText(draw.Vec2(100, 100), "Chilly", draw.Color.White())
end)
```

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

### GET /api/types/cviewsetup.md

Source: https://lua2.fatality.win/api/types/cviewsetup.md

Query the documentation dynamically by asking a question related to the CViewSetup structure.

```APIDOC
## GET /api/types/cviewsetup.md

### Description
Perform an HTTP GET request on the documentation page to retrieve answers to specific questions regarding the CViewSetup structure.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/types/cviewsetup.md

### Query Parameters
- **ask** (string) - Required - The specific question to ask about the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **sources** (array) - Relevant excerpts and sources from the documentation.
```

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

### GET /introduction/examples.md

Source: https://lua2.fatality.win/introduction/examples.md

Performs a natural language query against the documentation to retrieve answers and relevant context.

```APIDOC
## GET /introduction/examples.md

### Description
Performs an HTTP GET request to query the documentation dynamically. This allows users to ask specific questions and provide an optional goal to receive tailored answers with relevant excerpts.

### Method
GET

### Endpoint
https://lua2.fatality.win/introduction/examples.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal the user is trying to accomplish, used to tailor the response.
```

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

### GET /introduction/creating-scripts/first-steps.md

Source: https://lua2.fatality.win/introduction/creating-scripts/first-steps.md

Queries the documentation dynamically by providing a question and an optional goal to receive a tailored response.

```APIDOC
## GET /introduction/creating-scripts/first-steps.md

### Description
Queries the documentation dynamically to retrieve answers and relevant excerpts based on a specific question.

### Method
GET

### Endpoint
https://lua2.fatality.win/introduction/creating-scripts/first-steps.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Constructing a Shader

Source: https://lua2.fatality.win/api/instances/draw/managed/shader.md

Example of initializing a shader using the constructor with HLSL source code.

```lua
local blur = draw.Shader([[
// define constant buffer.
cbuffer cb : register(b0) {
    float4x4 mvp;
    float2 tex;
    float time;
    float alpha;
};

// define input.
struct PS_INPUT {
    float4 pos : SV_POSITION;
    float4 col : COLOR0;
    float2 uv : TEXCOORD0;
};

// use texture sampler and texture.
sampler sampler0;
Texture2D texture0;

float4 main(PS_INPUT inp) : SV_Target {
    float radius = 2.0; // blur radius
    float2 inv_size = 1.0 / tex.xy; // inversed size of the texture
    float weight = 0.0; // total weight
    float4 color = 0.0; // total color

    // perform a gaussian blur
    for (float x = -radius; x <= radius; x += 1.0)
    {
        for (float y = -radius; y <= radius; y += 1.0)
        {
            float2 coord = inp.uv + float2(x, y) * inv_size;
            color += texture0.Sample(sampler0, coord) * exp(-((x * x + y * y) / (2.0 * radius * radius)));
            weight += exp(-((x * x + y * y) / (2.0 * radius * radius)));
        }
    }

    // average the color
    color /= weight;
    color.a *= inp.col.a; // apply alpha modulation
    return color;
}
]]);
```

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

### GET /api/instances/gui.md

Source: https://lua2.fatality.win/api/instances/gui.md

Queries the documentation for information related to a specific question and optional goal.

```APIDOC
## GET /api/instances/gui.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
/api/instances/gui.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### GET /api/instances/gui/control.md

Source: https://lua2.fatality.win/api/instances/gui/control.md

Queries the documentation for specific information using natural language.

```APIDOC
## GET /api/instances/gui/control.md

### Description
Queries the documentation dynamically by providing a natural language question. This is used to retrieve answers, excerpts, or sources when information is not explicitly present in the current page.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/gui/control.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

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

### GET /introduction.md

Source: https://lua2.fatality.win/introduction

Queries the documentation for information by providing a specific question and an optional end goal.

```APIDOC
## GET /introduction.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://lua2.fatality.win/introduction.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

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

### SetSphere usage example

Source: https://lua2.fatality.win/api/instances/game/cphysicsqueryinterface/ray_t.md

Configures the ray as a sphere with a defined center and radius.

```lua
local ray = Ray_t()
ray:SetSphere(Vector(0, 0, 0), 10) -- Traces a sphere.
```

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

### IsNull Example

Source: https://lua2.fatality.win/api/instances/game/cengineclient/cnetchan.md

Determines if the channel is a dummy or stubbed channel.

```lua
local chan = game.engine:GetNetChan();
if not chan or chan:IsNull() then
    print('Not connected!');
end
```

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

### GET /api/instances/gui/control/list.md

Source: https://lua2.fatality.win/api/instances/gui/control/list.md

Queries the documentation for specific information using natural language.

```APIDOC
## GET /api/instances/gui/control/list.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/gui/control/list.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### GetObserverPawn Lua Example

Source: https://lua2.fatality.win/api/instances/entities/c_baseentity/c_csplayercontroller.md

Retrieves the observer pawn associated with the controller.

```lua
local obs_pawn = ctrl:GetObserverPawn();
```

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

### Query Documentation via HTTP

Source: https://lua2.fatality.win/api/instances/entities/c_baseentity/c_csweaponbase.md

Perform an HTTP GET request to query the documentation dynamically.

```http
GET https://lua2.fatality.win/api/instances/entities/c_baseentity/c_csweaponbase.md?ask=<question>&goal=<endgoal>
```

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

### Get Main Window

Source: https://lua2.fatality.win/api/instances/gui.md

Returns the main window object of the GUI.

```lua
local wnd = gui.GetMainWindow()
local pos = wnd:GetPosAbs()
```

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

### GetSharedTexture Lua Example

Source: https://lua2.fatality.win/api/instances/draw/adapter.md

Retrieves a shared texture that is updated automatically once before rendering starts.

```lua
local shared = adapter:GetSharedTexture();
```

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

### Complete Hello World Script

Source: https://lua2.fatality.win/introduction/creating-scripts/first-steps.md

A full example demonstrating how to define a callback and register it to the presentQueue event to draw text on screen.

```lua
local function onPresentQueue()
    local d = draw.surface;
    d.font = draw.fonts['gui_main'];
    d:AddText(draw.Vec2(50, 50),
        'Hello drawing! My first script speaking.',
         draw.Color.White()
    );
end

events.presentQueue:Add(onPresentQueue);
```

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

### Get()

Source: https://lua2.fatality.win/api/instances/gui/control/colorpicker.md

Returns the color value directly as an alias for GetValue():Get().

```APIDOC
## Method: Get()

### Description
Returns value directly. Alias for GetValue():Get().

### Returns
- **Color** - Value.

### Example
```lua
local val = color_picker:Get()
```
```

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

### Get()

Source: https://lua2.fatality.win/api/instances/gui/control/combobox.md

Method to retrieve the value directly as an alias for GetValue():Get().

```APIDOC
## Method: Get()

### Description
Returns the value directly. This is an alias for GetValue():Get().

### Returns
- **bits** - The value.

### Example
```lua
local val = cb:Get()
```
```

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

### SetHull usage example

Source: https://lua2.fatality.win/api/instances/game/cphysicsqueryinterface/ray_t.md

Configures the ray as a box/hull with specified minimum and maximum bounds.

```lua
local ray = Ray_t()
ray:SetHull(Vector(-4, -4, -4), Vector(4, 4, 4)) -- Traces a cube (8x8x8).
```

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

### GET /api/instances/entities/observermode_t.md

Source: https://lua2.fatality.win/api/instances/entities/observermode_t.md

Query the documentation for this page dynamically using an HTTP GET request.

```APIDOC
## GET /api/instances/entities/observermode_t.md

### Description
Perform a query against the documentation to retrieve specific information or context regarding the ObserverMode_t enumeration.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/entities/observermode_t.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask about the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### setupViewPre

Source: https://lua2.fatality.win/api/instances/events.md

Invoked every time the game sets up the view information, after the game's internal function runs.

```APIDOC
## setupViewPre

### Description
Invoked every time the game sets up the view information. This event is called after the game's function runs. You can retrieve the view information from the game.viewRender service.

### Arguments
None.
```

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

### GET /api/instances/draw/layer/textparams/textalignment.md

Source: https://lua2.fatality.win/api/instances/draw/layer/textparams/textalignment.md

Query the documentation for this page dynamically using an HTTP GET request.

```APIDOC
## GET /api/instances/draw/layer/textparams/textalignment.md

### Description
Perform a query against the documentation to retrieve specific information or clarification regarding the TextAlignment enum.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/draw/layer/textparams/textalignment.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET https://lua2.fatality.win/api/instances/draw/types/accessor.md

Source: https://lua2.fatality.win/api/instances/draw/types/accessor.md

Query the documentation dynamically by asking a question.

```APIDOC
## GET https://lua2.fatality.win/api/instances/draw/types/accessor.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/draw/types/accessor.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

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

### GET /api/types/refholder_t.md

Source: https://lua2.fatality.win/api/types/refholder_t.md

Query the documentation dynamically by performing an HTTP GET request on the page URL.

```APIDOC
## GET /api/types/refholder_t.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/types/refholder_t.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

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

### GET /api/instances/game.md

Source: https://lua2.fatality.win/api/instances/game.md

Queries the documentation for information based on a specific question and optional goal.

```APIDOC
## GET /api/instances/game.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/game.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### GET /api/instances/draw/managed/shader.md

Source: https://lua2.fatality.win/api/instances/draw/managed/shader.md

Queries the documentation page for specific information using a natural language question.

```APIDOC
## GET /api/instances/draw/managed/shader.md

### Description
Queries the current documentation page to retrieve answers, excerpts, or sources based on a provided question.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/draw/managed/shader.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### GET /api/instances/gui/contextinput/mousebutton.md

Source: https://lua2.fatality.win/api/instances/gui/contextinput/mousebutton.md

Query the documentation for this page dynamically by providing a question and an optional goal.

```APIDOC
## GET /api/instances/gui/contextinput/mousebutton.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/gui/contextinput/mousebutton.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

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

### Construct and configure a Layout

Source: https://lua2.fatality.win/api/instances/gui/container/controlcontainer/layout.md

Initializes a new Layout instance and adds controls to it using the INLINE stacking direction.

```lua
local layout = gui.Layout('my_layout', draw.Vec2(), draw.Vec2(100, 24), 
    gui.StackDirection.INLINE);
    
layout.sizeToParentW = true -- Resizes layout width to parent groupbox.
    
local cb1, ctrl1 = gui.MakeControlEasy('my_cb1', 'Checkbox 1', 'checkbox')
local cb2, ctrl2 = gui.MakeControlEasy('my_cb2', 'Checkbox 2', 'checkbox')

layout:Add(ctrl1)
layout:Add(ctrl2)
```

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

### Perform HTTP GET Request

Source: https://lua2.fatality.win/api/instances/http.md

Executes a GET request. The callback status code is false if an error occurs.

```lua
http.Get('https://example.com', {headers = {['X-My-Header'] = 'Hello'}}, function(status, data) 
    if status == 200 then
        print(data)
    end
end)
```

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

### GET /publishing-tool.md

Source: https://lua2.fatality.win/publishing-tool.md

Queries the documentation dynamically by providing a question and an optional goal to receive a contextual answer.

```APIDOC
## GET /publishing-tool.md

### Description
Perform an HTTP GET request on the documentation page URL to query information dynamically. This allows for retrieving answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://lua2.fatality.win/publishing-tool.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 response.
```

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

### Settings.__call

Source: https://lua2.fatality.win/api/instances/gui/container/controlcontainer/settings.md

Constructs a new Settings instance.

```APIDOC
## __call

### Description
Constructs the settings control, which creates a new instance of the settings popup menu.

### Arguments
- **id** (ControlID|string) - The ID for the settings control.

### Returns
- **Settings** - The created Settings instance.

### Example
```lua
local parent = gui.ctx:Find('lua>elements a')
local settings = gui.Settings('my_settings')

local cb, ctrl = gui.MakeControlEasy('my_cb', 'Checkbox', 'checkbox')
local slider, ctrl2 = gui.MakeControlEasy('my_slider', 'Slider', 'slider', 0, 100)

parent:Add(ctrl)
ctrl:Add(settings)
settings:Add(ctrl2)
```
```

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

### Get ComboBox Value Directly

Source: https://lua2.fatality.win/api/instances/gui/control/combobox.md

Use the Get method as a shorthand alias for retrieving the current value bits.

```lua
local val = cb:Get()
```

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

### GET /api/instances/entities/c_baseentity/c_csplayercontroller.md

Source: https://lua2.fatality.win/api/instances/entities/c_baseentity/c_csplayercontroller.md

Queries the documentation for specific information using natural language questions.

```APIDOC
## GET /api/instances/entities/c_baseentity/c_csplayercontroller.md

### Description
Queries the documentation dynamically by providing a natural language question. This is used to retrieve information, clarifications, or context not explicitly found in the current page.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/entities/c_baseentity/c_csplayercontroller.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### GET /api/instances/draw/layer/command/rendermode.md

Source: https://lua2.fatality.win/api/instances/draw/layer/command/rendermode.md

Query the documentation dynamically by asking a question related to the RenderMode API.

```APIDOC
## GET /api/instances/draw/layer/command/rendermode.md

### Description
Perform an HTTP GET request on the current page URL with the `ask` query parameter to retrieve information or clarification regarding the RenderMode documentation.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/draw/layer/command/rendermode.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask about the documentation.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

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

### GET /api/instances/entities.md

Source: https://lua2.fatality.win/api/instances/entities.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /api/instances/entities.md

### Description
Performs a query against the documentation to retrieve answers and relevant excerpts based on a natural language question.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/entities.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

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

### GET /api/instances/game/cphysicsqueryinterface.md

Source: https://lua2.fatality.win/api/instances/game/cphysicsqueryinterface.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /api/instances/game/cphysicsqueryinterface.md

### Description
Performs a dynamic query against the documentation page to retrieve answers, excerpts, or context related to a specific question.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/game/cphysicsqueryinterface.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### Get()

Source: https://lua2.fatality.win/api/instances/entities/c_baseentity/schemaaccessor_t.md

Retrieves the value referenced by the SchemaAccessor_t.

```APIDOC
## Get()

### Description
Returns the value referenced by the SchemaAccessor_t.

### Arguments
None.

### Returns
- **<type>** - The value stored in the field.

### Example
```lua
local health = player.m_iHealth:Get();
```
```

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

### GET /introduction/creating-scripts.md

Source: https://lua2.fatality.win/introduction/creating-scripts.md

Performs a dynamic query against the documentation page to retrieve answers and relevant excerpts based on a provided question.

```APIDOC
## GET /introduction/creating-scripts.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page.

### Method
GET

### Endpoint
https://lua2.fatality.win/introduction/creating-scripts.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /api/types/playerinfocallbackdata/espitempos.md

Source: https://lua2.fatality.win/api/types/playerinfocallbackdata/espitempos.md

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /api/types/playerinfocallbackdata/espitempos.md

### Description
Perform a query against the documentation to retrieve information not explicitly present on the page.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/types/playerinfocallbackdata/espitempos.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### http.Get

Source: https://lua2.fatality.win/api/instances/http.md

Performs an asynchronous GET request to the specified URL.

```APIDOC
## http.Get

### Description
Performs a GET request. The callback parameter `statusCode` will be `false` in case of an error.

### Arguments
- **url** (string) - The desired URL
- **options** (table) - The options table containing headers, etc.
- **callback** (function) - The callback, gets called with `statusCode` and `data`.

### Example
```lua
http.Get('https://example.com', {headers = {['X-My-Header'] = 'Hello'}}, function(status, data) 
    if status == 200 then
        print(data)
    end
end)
```
```

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

### Construct and Populate a Settings Control

Source: https://lua2.fatality.win/api/instances/gui/container/controlcontainer/settings.md

Initializes a new Settings instance and adds child controls like checkboxes and sliders to it.

```lua
local parent = gui.ctx:Find('lua>elements a')
local settings = gui.Settings('my_settings')

local cb, ctrl = gui.MakeControlEasy('my_cb', 'Checkbox', 'checkbox')
local slider, ctrl2 = gui.MakeControlEasy('my_slider', 'Slider', 'slider', 0, 100)

parent:Add(ctrl)
ctrl:Add(settings)
settings:Add(ctrl2)
```

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

### Get Script Title

Source: https://lua2.fatality.win/api/instances/ws.md

Retrieves the title of the current script.

```lua
local title = ws.GetTitle();
```

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

### bits:Get(bit)

Source: https://lua2.fatality.win/api/instances/gui/types/bits.md

Returns the state of a specific bit.

```APIDOC
## bits:Get(bit)

### Description
Returns the state of the bit at the specified position.

### Parameters
- **bit** (int) - Required - Bit number (0-63).

### Returns
- **bool** - Bit status.
```

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

### Construct a Group and add a control

Source: https://lua2.fatality.win/api/instances/gui/container/controlcontainer/group.md

Demonstrates how to instantiate a Group and add a control to it within the GUI context.

```lua
local parent = gui.ctx:Find('lua>groups')
local group = gui.Group('my_group', 'My group', 120, gui.GroupWidthMode.FULL)

local cb, ctrl = gui.MakeControlEasy('my_cb', 'Checkbox', 'checkbox')

parent:Add(group)
group:Add(ctrl)
```

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

### Get()

Source: https://lua2.fatality.win/api/instances/gui/control/valueparam.md

Returns the current value held by the ValueParam instance.

```APIDOC
## Get()

### Description
Returns the value held by the instance.

### Returns
- **<type>** - The value.
```

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

### GET /api/instances/game/cphysicsqueryinterface/cplane.md

Source: https://lua2.fatality.win/api/instances/game/cphysicsqueryinterface/cplane.md

Query the documentation for the CPlane object dynamically using the GitBook API.

```APIDOC
## GET https://lua2.fatality.win/api/instances/game/cphysicsqueryinterface/cplane.md

### Description
Query the documentation for the CPlane object to retrieve specific information or clarifications.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/game/cphysicsqueryinterface/cplane.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask about the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### gui.List(id, height)

Source: https://lua2.fatality.win/api/instances/gui/control/list.md

Constructor for creating a new List instance.

```APIDOC
## Constructor: gui.List

### Description
Constructs a new list box instance. Note that lists accept a maximum of 64 items unless `unlimitedMode` is enabled.

### Arguments
- **id** (ControlID|string) - Required - The ID of the control.
- **height** (vec2) - Required - The size of the list.

### Returns
- **List** - The created list box instance.

### Example
```lua
local list = gui.List(id, draw.Vec2(0, 60));
list.sizeToParentW = true;
```
```

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

### Get()

Source: https://lua2.fatality.win/api/instances/gui/control/checkbox.md

Returns the checkbox's boolean value directly.

```APIDOC
## Method: Get()

### Description
Returns value directly. Alias for GetValue():Get().

### Returns
- **boolean** - Value.

### Example
```lua
local val = cb:GetValueRaw()
```
```

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

### GET /api/instances/gui/container/controlcontainer/layout.md

Source: https://lua2.fatality.win/api/instances/gui/container/controlcontainer/layout.md

Queries the documentation for specific information related to the current page context.

```APIDOC
## GET /api/instances/gui/container/controlcontainer/layout.md

### Description
Queries the documentation dynamically by providing a natural language question. The system returns a direct answer along with relevant excerpts and sources.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/gui/container/controlcontainer/layout.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### Querying Documentation via HTTP

Source: https://lua2.fatality.win/api/instances/draw/layer/rounding.md

Perform an HTTP GET request to query the documentation dynamically with a specific question and optional goal.

```http
GET https://lua2.fatality.win/api/instances/draw/layer/rounding.md?ask=<question>&goal=<endgoal>
```

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

### Hotkey:Get

Source: https://lua2.fatality.win/api/instances/gui/control/hotkey.md

Retrieves the currently assigned hotkey value.

```APIDOC
## hotkey:Get()

### Description
Returns the currently assigned hotkey value.

### Arguments
None.

### Returns
- **number** - The assigned hotkey value.

### Example
```lua
local key = hotkey:Get()
```
```

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

### Initialize

Source: https://lua2.fatality.win/api/instances/game/particle_t.md

Initializes the particle snapshot positions.

```APIDOC
## Initialize

### Description
Initializes the particle snapshot positions.

### Parameters
- **positions** (table<Vector>) - Snapshot positions.
```

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

### Get entity handle

Source: https://lua2.fatality.win/api/instances/entities/c_baseentity.md

Retrieves the handle associated with the entity.

```lua
local name = entity:GetHandle()
```

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

### Get Hitbox Name

Source: https://lua2.fatality.win/api/instances/entities/chitboxinfo.md

Retrieves the name of the hitbox as a string.

```lua
local hbox_name = hitbox:GetName();
```

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

### Constructor

Source: https://lua2.fatality.win/api/instances/gui/container/controlcontainer/luacontainercontrol.md

Constructs a new custom container instance.

```APIDOC
## __call(id, proto, position, size)

### Description
Constructs the custom container.

### Arguments
- **id** (ControlID|string) - ID.
- **proto** (LuaContainerProto) - Metatable for this container.
- **position** (Vec2) - Custom offset.
- **size** (Vec2) - Custom size.

### Returns
- **control_container** (LuaContainerControl) - Custom container instance.

### Example
```lua
local container = gui.LuaContainerControl('my_container', gui.LuaContainerProto(), draw.Vec2(), draw.Vec2(100, 24))
```
```

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

### GET /api/instances/events.md

Source: https://lua2.fatality.win/api/instances/events.md

Queries the documentation page dynamically using a natural language question and an optional goal.

```APIDOC
## GET /api/instances/events.md

### Description
Perform a query against the documentation page to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/events.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

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

### renderStartPost

Source: https://lua2.fatality.win/api/instances/events.md

Invoked every time the game starts the scene rendering process, after the game's internal function runs.

```APIDOC
## renderStartPost

### Description
Invoked every time the game starts the scene rendering process. This event is called after the game's function runs.

### Arguments
- **setup** (CViewSetup) - View setup information.
```

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

### Get player name

Source: https://lua2.fatality.win/api/instances/entities/c_baseentity/c_csplayercontroller.md

Retrieves the sanitized name of the player.

```lua
local name = player:GetName();
```

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

### Initialize and configure a LuaTraceFilter_t

Source: https://lua2.fatality.win/api/instances/game/cphysicsqueryinterface/luatracefilter_t.md

Demonstrates creating a filter instance and setting properties to ignore world collisions and specific entities.

```lua
local filter = LuaTraceFilter_t()
filter.ignoreWorld = true
filter.ignoreEntity = entities.GetLocalPawn()
```

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

### Get value from SchemaAccessor_t

Source: https://lua2.fatality.win/api/instances/entities/c_baseentity/schemaaccessor_t.md

Retrieves the current value of the field.

```lua
local health = player.m_iHealth:Get();
```

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

### GET /api/instances/draw/managed/texture.md

Source: https://lua2.fatality.win/api/instances/draw/managed/texture.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /api/instances/draw/managed/texture.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, or sources based on a specific question.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/draw/managed/texture.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### Get Weapon Type

Source: https://lua2.fatality.win/api/instances/entities/c_baseentity/c_csweaponbase.md

Retrieves the weapon type classification.

```lua
local type = wep:GetType();
```

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

### GET /api/instances/entities/ccsweaponbasevdata/cfiringmode.md

Source: https://lua2.fatality.win/api/instances/entities/ccsweaponbasevdata/cfiringmode.md

Query the documentation for CFiringMode dynamically by providing a question and an optional goal.

```APIDOC
## GET /api/instances/entities/ccsweaponbasevdata/cfiringmode.md

### Description
Perform a query against the documentation to retrieve information about CFiringMode or related topics.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/entities/ccsweaponbasevdata/cfiringmode.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask regarding the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Querying Documentation via HTTP

Source: https://lua2.fatality.win/api/enums/clientframestage_t.md

Perform an HTTP GET request to retrieve dynamic information or clarification regarding the documentation.

```http
GET https://lua2.fatality.win/api/enums/clientframestage_t.md?ask=<question>&goal=<endgoal>
```

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

### GET /api/instances/draw/layer/rounding.md

Source: https://lua2.fatality.win/api/instances/draw/layer/rounding.md

Query the documentation for the Rounding enum dynamically.

```APIDOC
## GET /api/instances/draw/layer/rounding.md

### Description
Perform a query against the documentation for the Rounding enum to retrieve specific information or context.

### Method
GET

### Endpoint
/api/instances/draw/layer/rounding.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask about the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GetWeapons Lua Example

Source: https://lua2.fatality.win/api/instances/entities/c_baseentity/c_csplayerpawn.md

Retrieves all weapons in the player's inventory and iterates through them to access their definition index.

```lua
local weapons = player:GetWeapons()
for _, handle in ipairs(weapons) do
    local weapon = handle:Get()
    if weapon ~= nil then
        print(weapon:GetDefIndex())
    end
end
```

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

### FindPattern Lua Example

Source: https://lua2.fatality.win/api/instances/utils.md

Searches for a specific byte pattern within a module's memory space.

```lua
local something = utils.FindPattern('engine2.dll', 'DE AD ? ? ? ? BE EF');
```

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

### Constructing a ControlID

Source: https://lua2.fatality.win/api/instances/gui/types/controlid.md

Demonstrates how to create a ControlID instance or use a string directly in a GUI constructor.

```lua
local cb = gui.Checkbox('my_checkbox_id') -- Auto converts into ControlID
```

```lua
local id = gui.ControlID('my_id');
```

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

### Construct and Register a LuaWidgetControl

Source: https://lua2.fatality.win/api/instances/gui/control/luawidgetcontrol.md

Initializes a new widget with a prototype, position, and size, then adds it to the GUI context.

```lua
local proto = gui.LuaControlProto()

function proto:onRender(contents, _, mi, ma)
  contents:AddRect(draw.Rect(mi, ma), draw.color('#fff'))
end

local widget = gui.LuaWidgetControl('my-widget', proto, draw.Vec2(), draw.Vec2(100, 100)) do
  widget:ToggleVisibility(true)
end

gui.ctx:Add(widget)
```

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

### GetRenderColor Lua Example

Source: https://lua2.fatality.win/api/instances/entities/chitboxinfo.md

Retrieves the rendering color of the hitbox.

```lua
local crc = hitbox:GetRenderColor();
```

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

### GET /api/instances/entities/csweaponmode.md

Source: https://lua2.fatality.win/api/instances/entities/csweaponmode.md

Query the documentation for CSWeaponMode or related information using natural language.

```APIDOC
## GET /api/instances/entities/csweaponmode.md

### Description
Perform a natural language query against the documentation to retrieve information about CSWeaponMode or related topics.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/entities/csweaponmode.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask regarding the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GetBackBufferDownsampled Lua Example

Source: https://lua2.fatality.win/api/instances/draw/adapter.md

Retrieves a 4x downsampled version of the back buffer texture.

```lua
local ds = adapter:GetBackBufferDownsampled();
```

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

### gui.GetMainWindow()

Source: https://lua2.fatality.win/api/instances/gui/control/window.md

Retrieves the main window instance.

```APIDOC
## gui.GetMainWindow()

### Description
Retrieves the main window instance. This type does not have a constructor and there is only one main window.

### Returns
- **Window** - The main window instance.
```

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

### GetCRC Lua Example

Source: https://lua2.fatality.win/api/instances/entities/chitboxinfo.md

Retrieves the CRC value of the hitbox.

```lua
local crc = hitbox:GetCRC();
```

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

### Get and Set Rect Size

Source: https://lua2.fatality.win/api/instances/draw/types/rect.md

Demonstrates retrieving the current size and setting a new size for a rectangle.

```lua
local half_size = rect:Size(rect:Size() * draw.Vec2(0.5, 0.5));
```

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

### IsTranslationOny Lua Example

Source: https://lua2.fatality.win/api/instances/entities/chitboxinfo.md

Checks if the hitbox performs translation only.

```lua
local translate = hitbox:IsTranslationOny();
```

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

### Create directories with FileCreateDirectories

Source: https://lua2.fatality.win/api/instances/utils.md

Creates one or more directories at the specified path relative to the game/csgo folder.

```lua
utils.FileCreateDirectories('fatality/myscript')
```

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

### GetShapeRadius Lua Example

Source: https://lua2.fatality.win/api/instances/entities/chitboxinfo.md

Retrieves the radius of the hitbox as a number.

```lua
local radius = hitbox:GetShapeRadius();
```

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

### GET /api/instances/gui/control/slider.md

Source: https://lua2.fatality.win/api/instances/gui/control/slider.md

Queries the documentation for specific information using a natural language question and an optional goal.

```APIDOC
## GET /api/instances/gui/control/slider.md

### Description
Queries the documentation dynamically by providing a specific question and an optional end goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/gui/control/slider.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Construct a Label

Source: https://lua2.fatality.win/api/instances/gui/control/label.md

Initializes a new Label instance using the constructor.

```lua
local lab = gui.Label(id, 'Hello!');
```

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

### Retrieve the Main Window

Source: https://lua2.fatality.win/api/instances/gui/control/window.md

Use this to access the singleton main window instance.

```lua
local wnd = gui.GetMainWindow()
```

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

### Get event name in Lua

Source: https://lua2.fatality.win/api/types/gameevent_t.md

Retrieves the name of the game event.

```lua
if event:GetName() == 'player_hurt' then
    -- ...
end
```

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

### GET /api/instances/draw/layer/shadowdir.md

Source: https://lua2.fatality.win/api/instances/draw/layer/shadowdir.md

Query the documentation dynamically by asking a question related to the ShadowDir enum.

```APIDOC
## GET /api/instances/draw/layer/shadowdir.md

### Description
Performs a query against the documentation to retrieve information or clarification regarding the ShadowDir enum.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/draw/layer/shadowdir.md

### Query Parameters
- **ask** (string) - Required - The specific question to ask about the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /api/instances/draw/layer/glowparts.md

Source: https://lua2.fatality.win/api/instances/draw/layer/glowparts.md

Queries the documentation for specific information related to the current page context.

```APIDOC
## GET /api/instances/draw/layer/glowparts.md

### Description
Queries the documentation dynamically by providing a natural language question. The response includes a direct answer and relevant excerpts from the documentation.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/draw/layer/glowparts.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Get Bit State

Source: https://lua2.fatality.win/api/instances/gui/types/bits.md

Returns the boolean state of a specific bit.

```lua
if bits:Get(5) then
    -- ...
end
```

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

### gui.input

Source: https://lua2.fatality.win/api/instances/gui.md

Accesses the input context.

```APIDOC
## Field: gui.input

### Description
Returns the input context.

### Type
`ContextInput`
```

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

### Constructing a List

Source: https://lua2.fatality.win/api/instances/gui/control/list.md

Initializes a new List instance with a specified ID and height.

```lua
local list = gui.List(id, draw.Vec2(0, 60));
list.sizeToParentW = true -- Resize width to fill entire container.
```

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

### Get Raw Value

Source: https://lua2.fatality.win/api/instances/gui/types/bits.md

Retrieves the raw integer value of the bitset.

```lua
local raw = bits:GetRaw();
```

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

### Get

Source: https://lua2.fatality.win/api/instances/gui/control/slider.md

Retrieves the slider's current numeric value directly.

```APIDOC
## Method: Get()

### Description
Returns the value directly. This is an alias for GetValue():Get().

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

### Example
```lua
local val = slider:Get();
```
```

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

### GET /api/instances/entities/csweaponcategory.md

Source: https://lua2.fatality.win/api/instances/entities/csweaponcategory.md

Queries the documentation page for specific information using natural language questions.

```APIDOC
## GET /api/instances/entities/csweaponcategory.md

### Description
Perform a query against the documentation page to retrieve information or clarification regarding the CSWeaponCategory enum.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/entities/csweaponcategory.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask about the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

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

### Get Center Point

Source: https://lua2.fatality.win/api/instances/draw/types/rect.md

Retrieves the center coordinate of the rectangle as a Vec2.

```lua
local center = rect:Center();
```

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

### gui.ctx

Source: https://lua2.fatality.win/api/instances/gui.md

Accesses the GUI context.

```APIDOC
## Field: gui.ctx

### Description
Returns the current GUI context.

### Type
`Context`
```

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

### GET /api/instances/draw/layer.md

Source: https://lua2.fatality.win/api/instances/draw/layer.md

Queries the documentation for specific information using a natural language question and an optional goal.

```APIDOC
## GET /api/instances/draw/layer.md

### Description
Queries the documentation dynamically by providing a natural language question. The response includes a direct answer along with relevant excerpts and sources.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/draw/layer.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

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

### Get Bottom-Left Vector

Source: https://lua2.fatality.win/api/instances/draw/types/rect.md

Retrieves the bottom-left coordinate of the rectangle as a Vec2.

```lua
local bl = rect:BL();
```

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

### Constructing a LuaPopupControl

Source: https://lua2.fatality.win/api/instances/gui/control/luapopupcontrol.md

Initializes a new popup instance using a prototype, position, and size.

```lua
local proto = gui.LuaControlProto()

function proto:onRender(contents, _, mi, ma)
  contents:AddRect(draw.Rect(mi, ma), draw.color('#fff'))
end

local popup = gui.LuaPopupControl('my-popup', proto, draw.Vec2(), draw.Vec2(100, 100)) do
  popup:Open()
end
```

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

### GET /overview.md

Source: https://lua2.fatality.win/overview.md

Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /overview.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

### Method
GET

### Endpoint
https://lua2.fatality.win/overview.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Get Alpha Component

Source: https://lua2.fatality.win/api/instances/draw/types/color.md

Retrieves the opacity color value as an integer.

```lua
local a = col:GetA();
```

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

### Get Blue Component

Source: https://lua2.fatality.win/api/instances/draw/types/color.md

Retrieves the blue color value as an integer.

```lua
local b = col:GetB();
```

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

### Construct an Image instance

Source: https://lua2.fatality.win/api/instances/gui/control/image.md

Initializes a new Image control using a specified ID.

```lua
local img = gui.Image(id);
```

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

### GET /publishing-tool/libraries-and-dependencies.md

Source: https://lua2.fatality.win/publishing-tool/libraries-and-dependencies.md

Performs a dynamic query against the documentation page to retrieve answers to specific questions or context related to a goal.

```APIDOC
## GET /publishing-tool/libraries-and-dependencies.md

### Description
Queries the documentation dynamically to retrieve information or context based on a specific question.

### Method
GET

### Endpoint
https://lua2.fatality.win/publishing-tool/libraries-and-dependencies.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Get Green Component

Source: https://lua2.fatality.win/api/instances/draw/types/color.md

Retrieves the green color value as an integer.

```lua
local g = col:GetG();
```

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

### Get Red Component

Source: https://lua2.fatality.win/api/instances/draw/types/color.md

Retrieves the red color value as an integer.

```lua
local r = col:GetR();
```

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

### GET /api/instances/gui/types.md

Source: https://lua2.fatality.win/api/instances/gui/types.md

Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer.

```APIDOC
## GET /api/instances/gui/types.md

### Description
Perform a query against the documentation to retrieve answers, excerpts, or sources related to a specific question.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/gui/types.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

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

### GET /api/instances/utils.md

Source: https://lua2.fatality.win/api/instances/utils.md

Queries the documentation for specific information using natural language questions and optional goal context.

```APIDOC
## GET /api/instances/utils.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://lua2.fatality.win/api/instances/utils.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### Get player pawn

Source: https://lua2.fatality.win/api/instances/entities/c_baseentity/c_csplayercontroller.md

Retrieves the C_CSPlayerPawn instance attached to the controller.

```lua
local pawn = ctrl:GetPawn();
```
Tokens:
Raw