Open yerumaku opened 4 months ago
This actually already works in the Included Files markdown editor.
[click to open the player object](project://obj_player)
Having it work in comments in regular code editors would be of limited use because you can already middle click/F1 an asset name in a comment to go to it.
Being able to use something like search://
or tags://
to find all assets of a particular attribute would be very interesting.
Is your feature request related to a problem?
In large projects, navigation can be problematic. Even if you organize your resources well, you may not be able to quickly jump to the necessary elements, especially with the help of documentation.
Currently, the following link format is supported, which allows you to navigate only to resource files and quickly open them:
This way, you can quickly navigate to the required resources, but the link functionality in notes can be improved to provide better navigation to already marked resources.
Describe the solution you'd like
I propose several new formats for links:
1. Search and filters in the asset browser
1.1. Search in the asset browser
Clicking the [rooms]() link will show the asset browser and set the search field to the string after
search://
, in this examplerm_
, which will display all resources containing this text in their name.1.2. Filtering using tags
Clicking the [tutorial skills]() link will show the asset browser and set the asset filter by tags listed after
tags://
, separated by commas. In this example, the filter will be applied to two tags at once,Tutorial
andSkill
, displaying all resources with these tags in the project metadata.1.3. Filtering using asset types
Clicking the [sequence scripts]() link will show the asset browser and set the asset filter by asset types listed after
assets://
, separated by commas. In this example, the filter will be applied to two asset types,asset_script
andasset_sequence
, displaying all resources with these types.1.4. Combination of multiple filters If using the query style for resource filtering and search, you can combine these asset browser queries to include all necessary filters and find specified resources. Combination using
;
2. Quick jumps to declarations in code To speed up navigation to declarations in code, other protocols or commands can be used.
2.1. - 2.3. Quick jumps to functions, enums, and macros
This way, we can jump to declarations of enums, functions, macros, and even specific object events. Since the IDE already allows navigation to definitions using F1, this can also work when clicking a link in a note.
2.4. Jump to object events
For objects, this can be a combination that allows jumping to specific events.
2.5. Jump to sequence events
When a sequence asset has an event assigned through the sequence editor, you can jump to sequence events directly from the documentation, bypassing the editor.
2.6. Jump to sequence and timeline moments
When a Sequence asset has a moment code assigned through the sequence editor, you can jump to the moment code directly from the documentation, bypassing the editor. Similarly for Timeline asset.
3. Quick code search
Launches a global code search for the fragment
player.x
, similar to the global search command.Describe alternatives you've considered
Nope alternative path.
Additional context
I believe the community can suggest even more ways to improve links within the documentation.