> For the complete documentation index, see [llms.txt](https://docs.easy.gg/scripting/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.easy.gg/scripting/bedwars-scripting/services/promptservice.md).

# PromptService

Example usage:

<pre class="language-lua"><code class="lang-lua">-- Create a game winning prompt at the end of an obby
local emeraldBlocks = BlockService.getAllBlocks({ ItemType.EMERALD_BLOCK })
<strong>for i, block in ipairs(emeraldBlocks) do
</strong>    -- Create prompt at all emerald blocks with hold duration of 3s
    local prompt = PromptService.createPrompt("Goal", "Win", block.position)
    prompt:setHoldDuration(3)
    
    -- When activated end the match with the activating player as the winner
    prompt:onActivated(function(player)
        local team = TeamService.getTeam(player)
        MatchService.endMatch(team)
    end)
end
</code></pre>

<figure><img src="/files/oCFPkGW7HQREQRCe8FXq" alt="" width="129"><figcaption><p>Result of running the above code</p></figcaption></figure>

### Functions

#### createPrompt(objectText: string, actionText: string, position: [Vector3](https://create.roblox.com/docs/reference/engine/datatypes/Vector3)): [Prompt](/scripting/bedwars-scripting/objects/prompt.md)

Creates an in-world prompt at the specified position. You can further customize and give functionality to it using the returned [Prompt](/scripting/bedwars-scripting/objects/prompt.md) object.


---

# 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, and the optional `goal` query parameter:

```
GET https://docs.easy.gg/scripting/bedwars-scripting/services/promptservice.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.