Style. This is no longer a stub. Added a usage description. |
Added a bit more info about this component. |
||
Line 8: | Line 8: | ||
<!--T:2--> | <!--T:2--> | ||
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''. | 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''. | ||
Usually found on the body [[Slot|slot]] of an [[Avatar|avatar]] (but can be put anywhere in the [[World|world]]), this just needs a [[Reference Type|reference]] to the [[Component:MeshRenderer|MeshRenderer]] or [[Component:SkinnedMeshRenderer|SkinnedMeshRenderer]] components to work. | |||
<!--T:3--> | <!--T:3--> |
Revision as of 05:56, 6 October 2024
Component image
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.
Usually found on the body slot of an avatar (but can be put anywhere in the world), this just needs a reference to the MeshRenderer or SkinnedMeshRenderer components to work.
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 .
|
Usage
This is used to make a customized or fancier way of stating that you are focused away into another world.