# ScriptFAYTCommandData

The **ScriptFAYTCommandData** object is passed to the script-defined entry points for any [script add-ins](../../../scripting/script_add-ins) that [extend the FAYT field](../../../scripting/example_scripts/extending_the_fayt). The method name for these events is defined by the script itself, but generically it's referred to as [**onscriptfaytcommand**](../scripting_events/onscriptfaytcommand).

| Property Name | Return Type                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cmdline       | _string_                                   | Provides the text the user typed into the FAYT field.                                                                                                                                                                                                                                                                                                                                                                                           |
| fayt          | <p><em>string</em><br>or <em>bool</em></p> | The name of the FAYT extension command being invoked. This lets you use the same entry point to implement multiple FAYT extensions if desired. If the value is **False** then this is not a FAYT extension at all, but a regular [script command](scriptcommanddata).                                                                                                                                                                           |
| flags         | _int_                                      | <p>Provides the sum of all the flags the user has enabled for your FAYT extension. These come from the <strong>flags</strong> property you specified when initialising your extension via the <a href="scriptfaytcommand"><strong>scriptfaytcommand</strong></a> object.</p><p>Your script can update the flags in the users' configuration using the <a href="script"><strong>Script</strong></a><strong>.UpdateFAYTFlags</strong> method.</p> |
| key           | _string_                                   | This will equal the string **"return"** if the user pushed the return key to trigger your FAYT extension.                                                                                                                                                                                                                                                                                                                                       |
| suggest       | _bool_                                     | If set to **True** this is a hint that you should update the suggestions list via the [**tab**](tab)**.UpdateFAYTSuggestions** method.                                                                                                                                                                                                                                                                                                          |
| quickkey      | _string_                                   | Provides the key that initially triggered the FAYT in this mode.                                                                                                                                                                                                                                                                                                                                                                                |
| tab           | _object:_[**tab**](tab)                    | Represents the tab in which the FAYT is being interacted with.                                                                                                                                                                                                                                                                                                                                                                                  |
