# AbilityConfig

### Parameters

#### maxProgress: number

The maximum amount of progress that can be stored on the ability.

#### progressPerUse: number

The amount of progress used every time the ability is activated.

#### iconImage: string | nil

An optional [rbxassetid](https://create.roblox.com/docs/projects/assets) of the image that will be shown on the button for the ability.

```lua
Events.UseAbility(function (event)
    if (event.abilityName == "yeehaw") then
        AnnouncementService.sendAnnouncement("YEEHAW!")
    end
end)

-- Create a "yeehaw" ability that is activated with the X key
-- The ability has 2 stacks of "yeehaw"
local abilityConfig = {
    maxProgress = 10, 
    progressPerUse = 5
    iconImage = "rbxassetid://7193644599"
}
AbilityService.createAbility("yeehaw", KeyCode.X, abilityConfig)

-- Add the ability to the host
AbilityService.enableAbility(MatchService.getHost(), "yeehaw")
```


---

# Agent Instructions: 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.easy.gg/scripting/bedwars-scripting/objects/abilityconfig.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.