No edit summary |
No edit summary |
||
Line 9: | Line 9: | ||
<!--T:2--> | <!--T:2--> | ||
The '''SimpleAwayIndicator''' indicates when a user doesn't have the session focused. | The '''SimpleAwayIndicator''' indicates when a user doesn't have the session focused by temporarily replacing the [Material|materials] of a [[Component:MeshRenderer|MeshRenderer]] with the specified ''Away Material''. | ||
<!--T:3--> | <!--T:3--> | ||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|User|User| | |User|User|User whose away state will be watched. ''On avatars, may be set by an [[Component:AvatarUserReferenceAssigner|AvatarUserReferenceAssigner]] component.'' | ||
|AwayMaterial|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv1=true| | |AwayMaterial|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv1=true|Material to display when the user is away. | ||
|Renderer|'''[[Component:MeshRenderer|MeshRenderer]]'''|TypeAdv2=true| | |Renderer|'''[[Component:MeshRenderer|MeshRenderer]]'''|TypeAdv2=true|Mesh renderer component whose materials should be replaced | ||
|_oldMaterials|{{RootFieldType|SyncAssetList`1|[[Type:Material|Material]]}}|TypeAdv3=true| | |_oldMaterials|{{RootFieldType|SyncAssetList`1|[[Type:Material|Material]]}}|TypeAdv3=true|Backup of the renderer's original material list. ''Written automatically when "Away" state is triggered.'' | ||
}} | }} | ||
{{Table ComponentMethods | |||
|SetAway()||Stores the renderer's material list in <code>_oldMaterials</code> and replaces them with the <code>AwayMaterial</code>. | |||
|Restore()||Restores the renderer's materials from <code>_oldMaterials</code>. | |||
}} | |||
<!--T:4--> | <!--T:4--> | ||
== Behavior == | == Behavior == |
Revision as of 01:40, 28 July 2024
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Component image
The SimpleAwayIndicator indicates when a user doesn't have the session focused by temporarily replacing the [Material|materials] of a MeshRenderer with the specified Away Material.
Usage
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. |
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 .
|