Difference between revisions of "Tag editor"
m |
|||
Line 3: | Line 3: | ||
<br /> | <br /> | ||
== Description == | == Description == | ||
+ | The tag editor lets you edit the tags in your mod, which can then be added to items and characters for scripting purposes. | ||
+ | |||
+ | <br /> | ||
+ | == Components == | ||
+ | [[File:TagEditor_Components|500px|none]] | ||
+ | <sub>The tag editor with each component numbered</sub> | ||
+ | |||
+ | The tag editor consists of the following components: | ||
+ | # [[#Name|Name]] column | ||
+ | # [[#Categories|Categories]] column | ||
+ | # [[#Description|Description]] column | ||
+ | # [[#Module|Module]] column | ||
+ | # [[#Tooltip Key|Tooltip key]] column | ||
+ | # [[#Tooltip|Tooltip]] column | ||
+ | # [[#Tags|Tags]] | ||
+ | # [[#Filtering|Filter]] | ||
+ | |||
+ | <br /> | ||
+ | === Tags === | ||
+ | Each row in the Tag Editor grid defines a tag. Greyed out tags are not editable, likely because they are in another project. | ||
+ | |||
+ | To add custom tags in your own project, scroll all the way down and define your tag in the empty row at the bottom. A new empty row is added each time you finish adding a tag. | ||
+ | |||
+ | To delete a custom tag, simply select the row in which it is defined and hit "Delete" on your keyboard. | ||
+ | |||
+ | <br /> | ||
+ | === Columns === | ||
+ | ==== Name ==== | ||
+ | The "Name" column specifies the access key of this tag. The name must be unique. | ||
+ | |||
+ | <br /> | ||
+ | ==== Categories ==== | ||
+ | The "Categories" column specifies the categories (or type) of the tag. To edit the categories, click the "Edit" button on the right of the cell. | ||
+ | |||
+ | <br /> | ||
+ | ==== Description ==== | ||
+ | |||
+ | <br /> | ||
+ | ==== Module ==== | ||
+ | The "Module" column specifies the project of the tag. You can only edit tags in your current module. Tags from other modules can be [[Filtering|filtered]] out of the grid. | ||
+ | |||
+ | <br /> | ||
+ | ==== Tooltip Key ==== | ||
+ | The "Tooltip Key" column specifies the key for the tag tooltip. By default, this is set to tagkey_{TagName}. When tags are saved, a [[Translated string key editor|translated string key table]] is automatically generated for your tags. | ||
+ | |||
+ | <br /> | ||
+ | ==== Tooltip ==== | ||
+ | The "Tooltip" column shows the content of the generated translated string (see [[#Tooltip Key|Tooltip Key]]). | ||
+ | |||
+ | <br /> | ||
+ | === Filtering === | ||
+ | There are two options for filtering tags: | ||
+ | |||
+ | * Hide inherited tags | ||
+ | *: Check this option to hide all greyed out tags | ||
+ | * Filter | ||
+ | *: You can type in the filter textbox to filter tags by name | ||
<br /> | <br /> |
Revision as of 09:38, 11 September 2017
Contents
Description
The tag editor lets you edit the tags in your mod, which can then be added to items and characters for scripting purposes.
Components
The tag editor with each component numbered
The tag editor consists of the following components:
- Name column
- Categories column
- Description column
- Module column
- Tooltip key column
- Tooltip column
- Tags
- Filter
Tags
Each row in the Tag Editor grid defines a tag. Greyed out tags are not editable, likely because they are in another project.
To add custom tags in your own project, scroll all the way down and define your tag in the empty row at the bottom. A new empty row is added each time you finish adding a tag.
To delete a custom tag, simply select the row in which it is defined and hit "Delete" on your keyboard.
Columns
Name
The "Name" column specifies the access key of this tag. The name must be unique.
Categories
The "Categories" column specifies the categories (or type) of the tag. To edit the categories, click the "Edit" button on the right of the cell.
Description
Module
The "Module" column specifies the project of the tag. You can only edit tags in your current module. Tags from other modules can be filtered out of the grid.
Tooltip Key
The "Tooltip Key" column specifies the key for the tag tooltip. By default, this is set to tagkey_{TagName}. When tags are saved, a translated string key table is automatically generated for your tags.
Tooltip
The "Tooltip" column shows the content of the generated translated string (see Tooltip Key).
Filtering
There are two options for filtering tags:
- Hide inherited tags
- Check this option to hide all greyed out tags
- Filter
- You can type in the filter textbox to filter tags by name