66 lines
1.5 KiB
TOML
66 lines
1.5 KiB
TOML
|
# LSP Documentation Template for Keywords
|
||
|
|
# Copy this template for each keyword/declaration/type
|
||
|
|
|
||
|
|
[keyword]
|
||
|
|
name = "keyword_name"
|
||
|
|
category = "behavior_tree | declaration | value_type | decorator"
|
||
|
|
short_description = "One-sentence description (used in completion list)"
|
||
|
|
web_url = "https://r3t-studios.github.io/storybook/reference/page.html#anchor"
|
||
|
|
|
||
|
|
[syntax]
|
||
|
|
format = "keyword [optional] { required }"
|
||
|
|
example = """
|
||
|
|
keyword example {
|
||
|
|
child_element
|
||
|
|
}
|
||
|
|
"""
|
||
|
|
|
||
|
|
[hover]
|
||
|
|
markdown = """
|
||
|
|
**`keyword` - Short Name**
|
||
|
|
|
||
|
|
One-sentence description of purpose and behavior.
|
||
|
|
|
||
|
|
**Key behaviors:**
|
||
|
|
- Behavior 1
|
||
|
|
- Behavior 2
|
||
|
|
- Behavior 3
|
||
|
|
|
||
|
|
**Example:**
|
||
|
|
```storybook
|
||
|
|
keyword realistic_label {
|
||
|
|
meaningful_child
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
**Optional features:**
|
||
|
|
- Optional labels for debugging
|
||
|
|
- Optional parameters
|
||
|
|
|
||
|
|
[Learn more →](https://r3t-studios.github.io/storybook/reference/page.html#anchor)
|
||
|
|
"""
|
||
|
|
|
||
|
|
[completion]
|
||
|
|
snippet = "keyword ${1:label} {\n\t$0\n}"
|
||
|
|
description = "Short description for completion dropdown"
|
||
|
|
sort_text = "01-keyword" # Optional: control sort order
|
||
|
|
filter_text = "keyword" # Optional: control filtering
|
||
|
|
|
||
|
|
[signature]
|
||
|
|
# Optional: for keywords that take parameters
|
||
|
|
label = "keyword(param1: Type, param2: Type)"
|
||
|
|
parameters = [
|
||
|
|
"param1: Type - Description",
|
||
|
|
"param2: Type - Description"
|
||
|
|
]
|
||
|
|
|
||
|
|
[context]
|
||
|
|
# Optional: where this keyword is valid
|
||
|
|
valid_in = ["behavior_block", "life_arc_block"]
|
||
|
|
invalid_in = ["character_block"]
|
||
|
|
|
||
|
|
[related]
|
||
|
|
# Optional: related keywords for cross-reference
|
||
|
|
keywords = ["related1", "related2"]
|
||
|
|
concepts = ["concept1", "concept2"]
|