Ghost Commands
  • Getting Started
    • Quickstart
    • Syntax
      • Command syntax
      • Arguments with multiple values
    • Custom commands
  • Documentation
    • Commands
      • Static commands
      • Non-static commands
      • Dynamic commands
      • Overloads
      • Parameters
      • Additional attributes
    • Suggestions
      • Suggestion attributes
      • Suggestor methods
    • Converters
      • Custom parameter types
      • Using the ArgumentReader
      • Multiple ways to interpret an argument
    • Processors
      • Creating a processor
      • Setting priorities
      • Cheat codes example
    • Macros
    • Settings
    • Customization
    • Included Commands
Powered by GitBook
On this page

Was this helpful?

  1. Documentation
  2. Suggestions

Suggestor methods

PreviousSuggestion attributesNextConverters

Last updated 7 months ago

Was this helpful?

Custom suggestor methods

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.

[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.

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.

Custom icons

Suggestion icons can be customized with custom textures and colors. Read more about that in the .

​
customization section