Component:SimpleAwayIndicator: Difference between revisions

From Resonite Wiki
mNo edit summary
Style. This is no longer a stub. Added a usage description.
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=SimpleAwayIndicatorComponent.png
|Image=SimpleAwayIndicatorComponent.png
Line 12: Line 11:


<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|User|User|User whose away state will be watched. ''On avatars, may be set by an [[Component:AvatarUserReferenceAssigner|AvatarUserReferenceAssigner]] component.''
|User|User|User whose away state will be watched. ''On avatars, may be set by an [[Component:AvatarUserReferenceAssigner|AvatarUserReferenceAssigner]] component.''
Line 25: Line 23:
}}
}}
<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
This is used to make a customized or fancier way of stating that you are focused away into another [[World|world]].


<!--T:5-->
<!--T:5-->
Line 34: Line 33:
</translate>
</translate>
[[Category:Components{{#translation:}}|Simple Away Indicator]]
[[Category:Components{{#translation:}}|Simple Away Indicator]]
[[Category:ComponentStubs]]
[[Category:Components:Users{{#translation:}}|Simple Away Indicator]]
[[Category:Components:Users{{#translation:}}|Simple Away Indicator]]

Revision as of 05:51, 6 October 2024

Component image 
SimpleAwayIndicator component as seen in the Scene Inspector


The SimpleAwayIndicator indicates when a user doesn't have the session focused by temporarily replacing the materials of a MeshRenderer with the specified Away Material.

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.
User User User whose away state will be watched. On avatars, may be set by an AvatarUserReferenceAssigner component.
AwayMaterial Material Material to display when the user is away.
Renderer MeshRenderer Mesh renderer component whose materials should be replaced
_oldMaterials list of Material Backup of the renderer's original material list. Written automatically when "Away" state is triggered.
Methods
Method Parameters Description
SetAway() none Stores the renderer's material list in _oldMaterials and replaces them with the AwayMaterial.
Restore() none Restores the renderer's materials from _oldMaterials.

Usage

This is used to make a customized or fancier way of stating that you are focused away into another world.

Examples

Related Components