Tag: Difference between revisions

From Resonite Wiki
Added the other tagging section.
Added Default tags section.
Line 1: Line 1:
'''Tags''' are [[Type:string|Strings]] that [[Resonite]] uses to label [[Slot|slots]], [[Dynamic Variables]] (Triggers & Receivers), and other objects that require a tag.
'''Tags''' are [[Type:string|Strings]] that [[Resonite]] uses to label [[Slot|slots]], [[Dynamic Variables]] (Triggers & Receivers), and other objects that require a tag.


== How To Use ==
== How To Use ==
Line 53: Line 55:


{{Note|Currently the [[Component:DelegateTag|Delegate Tag]] Component will crash [[User|users]] in the world when there is an invalid input! [https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/919 DelegateTag With Invalid Type Makes World Unjoinable - Issue 919]|danger}}
{{Note|Currently the [[Component:DelegateTag|Delegate Tag]] Component will crash [[User|users]] in the world when there is an invalid input! [https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/919 DelegateTag With Invalid Type Makes World Unjoinable - Issue 919]|danger}}
== Default Tags ==
Some items and slots have default tags for your convenience (or sometimes left there by the [[Team|Dev Team]]). Here are some notable items that contain default tags:
* The [[Scene Inspector]] & [[Module Snapping Tool]] has a default tag of <code>Developer</code>.
* The [[Dev Tool]], [[Material Tool]], [[Glue Tool]], [[Character Collider Setter Tool]], [[Mesh Visibility Tool]], [[Mesh Tool]], [[Rig Mesh Transfer Tool]], [[Object Slicer Tool]], [[Meter Tool]], & [[World Submitter]] has a default tag, but it is an empty string, not a null string for the tag field.
* The [[Geometry Line Brush]] (Default, Highlighter, Screen Mode) has the default Tag of <code>User</code>.
* The [[Camera]] from the [[Resonite Essentials]] [[Public Folders|public folder]] and streaming camera has the default tag of <code>Media.interactive_camera</code>.
* The default [[Resonite Keyboard|Keyboard]] has the default tag of <code>Userspace.Keyboard</code>.
* The default [[Audio Stream Controller]] has the default tag of <code>Media.user_audio_stream</code>.
* The default [[Color Dialog]] has the default tag of <code>Interface.user_color_dialog</code>.
* The default [[Text Display]] has the default tag of <code>Media.text_import</code>.
* The default [[Url Display]] has the default tag of <code>Media.hyperlink_dialog</code>.
* The default [[Notice Display]] has the default tag of <code>Info.notice_display</code>.
* The default [[Audio Player]] has the default tag of <code>Media.user_audio_player</code>.
* The default [[Video Player]] has the default tag of <code>Media.user_media_player</code>.
* The [[Dawn Modular]] pieces each have a slot hierarchy that lists off their snap points, matching the default tag to their slot name.
* The default [[Avatar]] has the default tag of <code>PlatformRootLayer</code>.

Revision as of 23:47, 20 March 2025

Tags are Strings that Resonite uses to label slots, Dynamic Variables (Triggers & Receivers), and other objects that require a tag.


How To Use

Tags can be used as a simple label, or it can be part of a complex system. Tags can also be swapped for other tags through ProtoFlux, especially when driving a receiver. Here are the following things that require tags:

Rich Text Formatting

Rich Text Formatting (also known as RTF) tags are used to change how the text renders.

Haptics

There are tags for the Haptics system which allow for more control when using these devices. Here is a list relating to tags:

Tagging For Slots

Sometimes you need to mark a slot to have a certain effect to it, there are components that do that found in Transform -> Tagging within the component browser. Here is a list of them:

Similarly, there is the Assets -> Tagging category that contains the following components:

Why Use Tags

(ToDo)

Unknown Tags

Currently the Delegate Tag Component will crash users in the world when there is an invalid input! DelegateTag With Invalid Type Makes World Unjoinable - Issue 919

Default Tags

Some items and slots have default tags for your convenience (or sometimes left there by the Dev Team). Here are some notable items that contain default tags: