> For the complete documentation index, see [llms.txt](https://tools.continis.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tools.continis.io/scriptable-object-tools/utilities/descriptivescriptableobject.md).

# Descriptive Scriptable Object

The purpose of this simple class is to provide a text area at the top of a ScriptableObject for the developers to write a concise explanation of where the SO is used, what to expect from it, or any other short note.

### Sample usage 💡

For instance, a great idea when using a [Shared Value](/scriptable-object-tools/components/sharedvalues.md) SO is to write which objects in the game write to it. Writing who reads from it might lead to a long description that is not often up to date anyways.

When using [RuntimeAnchors](/scriptable-object-tools/components/runtimeanchors.md), it might make sense to write who is providing the value and in response to what event (is it in Awake, or later?).

***

## Using this class

To use this class, simply inherit from it. The inheritor will display the extra text area at the top of the Inspector.

The text value is editor-only, so it's discarded when making a build.


---

# 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://tools.continis.io/scriptable-object-tools/utilities/descriptivescriptableobject.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.