> For the complete documentation index, see [llms.txt](https://docs.kojascripts.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kojascripts.eu/koja-lib/weapon.md).

# Weapon

Utility function for reading the player's current weapon state.

***

## getCurrentWeaponInfo

Returns information about the weapon the ped currently has equipped.

```lua
local info = KOJA.Client.getCurrentWeaponInfo(ped)
```

| Parameter | Type     | Description       |
| --------- | -------- | ----------------- |
| `ped`     | `number` | Ped entity handle |

**Returns** `table | nil`

| Field        | Type     | Description                               |
| ------------ | -------- | ----------------------------------------- |
| `weaponHash` | `number` | Hash of the current weapon                |
| `ammoInClip` | `number` | Bullets remaining in the current magazine |
| `totalAmmo`  | `number` | Total ammo carried for this weapon        |

Returns `nil` if the ped has no weapon equipped.

***

## Example

```lua
local ped = PlayerPedId()
local info = KOJA.Client.getCurrentWeaponInfo(ped)

if info then
    print('Weapon hash:', info.weaponHash)
    print('Clip ammo:', info.ammoInClip)
    print('Total ammo:', info.totalAmmo)
else
    print('No weapon equipped')
end
```

**With weapon name lookup:**

```lua
local info = KOJA.Client.getCurrentWeaponInfo(PlayerPedId())
if info then
    local name = GetDisplayNameFromVehicleModel(info.weaponHash)  -- works for weapons too
    print('Equipped:', name)
end
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.kojascripts.eu/koja-lib/weapon.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.