Component:AvatarNameplateVisibilityDriver: Difference between revisions

From Resonite Wiki
imported>QueenHidi
No edit summary
 
fix formatting
 
(5 intermediate revisions by 5 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AvatarNameplateVisibilityDriverComponent.png
|Image=AvatarNameplateVisibilityDriverComponent.png
Line 8: Line 7:
}}
}}


<!--T:2-->
AvatarNameplateVisibilityDriver is used to drive the visibility of nameplates during certain scenarios.
== Intoduction ==
AvatarNameplateVisibilityDriver is used to drive the visibility of nameplates when nameplates are hidden locally through the nameplate visibility facet on the Home tab of the [[Dash Menu]].  


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|AlwaysShowToContacts|Bool|  
|AlwaysShowToContacts|Bool| Show to contacts regardless of whether it should be hidden or not.
|Visible|Bool|  
|Visible|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv1=true| The boolean to drive for nameplate visiblity (like the active of the nameplate slot)
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Behavior ==
This disables the target of <code>Visible</code> when nameplates are hidden locally through the nameplate visibility facet on the Home tab of the [[Dash Menu]]. This also drives the visibility of nameplates for other reasons, like when visibility of default nameplates is needed locally. It also hides the target nameplate during certain render contexts, like when a user is taking a picture with hide nameplates during pictures setting turned on.


<!--T:5-->
<!--T:5-->
== Examples ==
== Examples ==
User default nameplates, and custom nameplates use this component so the nameplate is hidden when needed. Some users may inform you that your nameplate is broken if this component isn't being utilized on it.


<!--T:6-->
<!--T:6-->
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:Components{{#translation:}}|AvatarNameplateVisibilityDriver (Component){{#translation:}}]]
[[Category:Components{{#translation:}}|Avatar Nameplate Visibility Driver]]
[[Category:ComponentStubs]]
[[Category:Components:Users:Common Avatar System:Nameplate{{#translation:}}|Avatar Nameplate Visibility Driver]]
[[Category:Components:Users:Common Avatar System:Nameplate{{#translation:}}|AvatarNameplateVisibilityDriver (Component){{#translation:}}]]

Latest revision as of 16:43, 15 October 2024

Component image 
AvatarNameplateVisibilityDriver component as seen in the Scene Inspector


AvatarNameplateVisibilityDriver is used to drive the visibility of nameplates during certain scenarios.

Usage

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
AlwaysShowToContacts Bool Show to contacts regardless of whether it should be hidden or not.
Visible field drive of Bool The boolean to drive for nameplate visiblity (like the active of the nameplate slot)

Behavior

This disables the target of Visible when nameplates are hidden locally through the nameplate visibility facet on the Home tab of the Dash Menu. This also drives the visibility of nameplates for other reasons, like when visibility of default nameplates is needed locally. It also hides the target nameplate during certain render contexts, like when a user is taking a picture with hide nameplates during pictures setting turned on.

Examples

User default nameplates, and custom nameplates use this component so the nameplate is hidden when needed. Some users may inform you that your nameplate is broken if this component isn't being utilized on it.

Related Components