-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[licenses] Simplify example and add more comments
- Loading branch information
Showing
3 changed files
with
128 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| extends PanelContainer | ||
|
|
||
| const Component := preload("res://addons/licenses/component.gd") | ||
| const Licenses := preload("res://addons/licenses/licenses.gd") | ||
| const LicenseContainer := preload("res://examples/licenses/license_container.gd") | ||
|
|
||
| ## First example with tree. | ||
| @export var _tree: Tree | ||
| ## Second example with item list. | ||
| @export var _item_list: ItemList | ||
|
|
||
| ## Container to display the license details. | ||
| @export var _license_container: LicenseContainer | ||
|
|
||
| @export var _example_selector: TabContainer | ||
|
|
||
| var licenses: Array[Component] = [] | ||
|
|
||
| func _ready() -> void: | ||
| # load licenses | ||
| var res: Licenses.LoadResult = Licenses.load(Licenses.get_license_data_filepath()) | ||
| if res.err_msg != "": | ||
| return | ||
| self.licenses = res.components | ||
| # add engine licenses | ||
| self.licenses.append_array(Licenses.get_required_engine_components()) | ||
| # sort licenses by name ascending | ||
| self.licenses.sort_custom(Licenses.new().compare_components_ascending) | ||
|
|
||
| # first example | ||
| self._populate_tree() | ||
| # second example | ||
| self._populate_item_list() | ||
|
|
||
| ## first example with tree | ||
| func _populate_tree() -> void: | ||
| # if an item in the tree is selected, set the license container's component to the selected component | ||
| self._tree.item_selected.connect(self._on_tree_item_selected) | ||
|
|
||
| # populate the tree node | ||
| # create a category cache to easily access already created category items | ||
| var category_cache: Dictionary = {} | ||
| var root: TreeItem = self._tree.create_item(null) | ||
| category_cache[""] = root | ||
|
|
||
| # add each component to the tree | ||
| for idx: int in range(len(self.licenses)): | ||
| var component: Component = self.licenses[idx] | ||
| var parent: TreeItem = self._create_category_item(category_cache, component.category, root) | ||
| var item: TreeItem = self._tree.create_item(parent) | ||
| item.set_text(0, component.name) | ||
| item.set_meta("idx", idx) | ||
|
|
||
| ## create a category item in the tree | ||
| func _create_category_item(category_cache: Dictionary, category: String, root: TreeItem) -> TreeItem: | ||
| if category in category_cache: | ||
| return category_cache[category] | ||
| var category_item: TreeItem | ||
| category_item = self._tree.create_item(root) | ||
| category_item.set_text(0, category) | ||
| category_item.set_selectable(0, false) | ||
| category_cache[category] = category_item | ||
| return category_item | ||
|
|
||
| ## second example with item list | ||
| func _populate_item_list() -> void: | ||
| # if an item in the item list is selected, set the license container's component to the selected component | ||
| self._item_list.item_selected.connect(self._on_item_list_selected) | ||
|
|
||
| # add each component to the item list | ||
| for idx: int in range(len(self.licenses)): | ||
| var component: Component = self.licenses[idx] | ||
| self._item_list.add_item(component.name) | ||
| self._item_list.set_item_metadata(idx, idx) | ||
|
|
||
| ## update the license display container to show the selected license | ||
| func _on_tree_item_selected() -> void: | ||
| self._license_container.set_component(self.licenses[self._tree.get_selected().get_meta("idx")]) | ||
|
|
||
| func _on_item_list_selected(idx: int) -> void: | ||
| self._license_container.set_component(self.licenses[self._item_list.get_item_metadata(idx)]) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters