> For the complete documentation index, see [llms.txt](https://docs.pentafloat.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentafloat.com/documentation/suggestions/suggestor-methods.md).

# Suggestor methods

## Custom suggestor methods[​](https://ghostlike.dk/docs/suggestions#custom-suggestor-methods) <a href="#custom-suggestor-methods" id="custom-suggestor-methods"></a>

To define suggestions based on an entire type (or derived types), the `[Suggestor]` attribute can be placed on a static method that returns `string[]`, and takes a single `CommandInfo.Parameter` parameter.

```csharp
[Suggestor(typeof(Vector3))]
public static string[] VectorSuggestor(CommandInfo.Parameter parameter)
{
    return new string[]
    {
        "(0, 0, 0)",
        "(1, 1, 1)",
        "(1, 0, 0)",
        "(0, 1, 0)",
        "(0, 0, 1)"
    }
}
```

Now whenever the user reaches a `Vector3` parameter, these suggestions will be shown in the suggestion list.

{% hint style="info" %}

#### Note

The reason the method takes a `CommandInfo.Parameter`, is to get more information about the current parameter we are making suggestions for, if needed. Though in most cases, returning a simple string array should be sufficient.
{% endhint %}

{% hint style="info" %}

#### Custom icons

Suggestion icons can be customized with custom textures and colors. Read more about that in the [customization section](/documentation/customization.md).
{% endhint %}


---

# 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.pentafloat.com/documentation/suggestions/suggestor-methods.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.
