TagsPanel
Extends: VBoxContainer
Description
This is the special box that shows tags in the default Object Tool
Properties
OptionButton | setList |
ItemList | tagsList |
Dictionary | tagIndexLookup |
??? | ObjectTool |
bool | TagsEnabled |
Methods
void | UpdateTags ( ) |
Dictionary | Save ( ) |
void | Load ( Dictionary data ) |
void | EnableTags ( bool enable ) |
void | SelectTagSetById ( int id ) |
void | SelectTagSet ( String set ) |
void | ShowCurrentTagSet ( ) |
Property Descriptions
- OptionButton setList:
Dropdown menu that displays the tag sets for the user to choose.
- ItemList tagsList:
The box where the user clicks to select tags. Can multi-select.
- Dictionary tagIndexLookup:
Dictionary that allows you to look up a tag's index. tagIndexLookup[tag] results in a int.
- ObjectTool:
A private reference to the ObjectTool that shouldn't be used in a mod.
- bool TagsEnabled:
Is this TagsPanel visually enabled.
Method Descriptions
- void UpdateTags ( ):
Refresh the tags available by looking up Master.TagSets.
- Dictionary Save ( ):
Serialize the selected tags into a Dictionary. Looks like JSON.
- void Load ( Dictionary data ):
Load a previous user's selected tags by passing in a Dictionary. See Save().
- void EnableTags ( bool enable ):
Enable this TagsPanel so it can be used. When a user clicks on the tags, it calls this method as well.
- void SelectTagSetById ( int id ):
Manually selects the tag set by id in the dropdown and display the corresponding objects in the Object Library Panel.
- void SelectTagSet ( String set ):
Manually selects the tag set by String in the dropdown and display the corresponding objects in the Object Library Panel.
- void ShowCurrentTagSet ( ):
Display the assets associated with this tag in the Object Library Panel.