> For the complete documentation index, see [llms.txt](https://chaoses-ib.gitbook.io/directory-opus/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://chaoses-ib.gitbook.io/directory-opus/manual/reference/scripting_reference/scripting_objects/scriptfaytcommanddata.md).

# ScriptFAYTCommandData

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

| 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](/directory-opus/manual/reference/scripting_reference/scripting_objects/scriptcommanddata.md).                                                                                                                                |
| 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="/pages/8CuDHM0bLESpAJBYSY0j"><strong>scriptfaytcommand</strong></a> object.</p><p>Your script can update the flags in the users' configuration using the <a href="/pages/lhUKHRkTJwDUJUwIbaVn"><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**](/directory-opus/manual/reference/scripting_reference/scripting_objects/tab.md)**.UpdateFAYTSuggestions** method.                                                                                                                                                                                                                                                               |
| quickkey      | *string*                                                                                          | Provides the key that initially triggered the FAYT in this mode.                                                                                                                                                                                                                                                                                                                                                                                                               |
| tab           | *object:*[**tab**](/directory-opus/manual/reference/scripting_reference/scripting_objects/tab.md) | Represents the tab in which the FAYT is being interacted with.                                                                                                                                                                                                                                                                                                                                                                                                                 |