Astra Unity 2.6.6
Astra Unity Plugin
Astra.Asset.EyeModifierRecord Class Reference

Allows advanced modification of EyeItems. Properties in this class are standardized values such as IrisColor that can be applied to different types of eye shaders. Simple materials/shaders may only use or care about properties such as IrisColor and not have other values. Not all shaders will implement these. More...

Inheritance diagram for Astra.Asset.EyeModifierRecord:

Public Member Functions

 EyeModifierRecord ()
 Generic constructor
 
 EyeModifierRecord (string eyeItemGuid, string secondaryId)
 Constructor, attached to a given item More...
 

Public Attributes

Color ScleraColor
 Defines the region outside the iris and is typically whiteish-yellow overall
 
Color IrisColor
 Defines the primary color of the iris
 
Color IrisColorSecondary
 Defines the 2nd color of the iris
 
Color IrisColorTertiary
 Defines the 3rd color of the iris
 
Color GlowColor
 Provides a glow effect (emission) in the eye, controlled by the mask texture of the base material typically
 
float PupilDilation
 A value of strength that tells how large the pupil should be on the eye
 
float IrisSize
 A value of strength that tells how much large the iris should be in comparison to the overall eye
 
float ParallaxEffect
 The intensity of a parallax effect rendered in the eye
 
float EyeScleraSize
 How much the whiteish part of the sclera should encompass the eye, typically rendered on top of a red blood region
 
float LimbalRing
 How large the limbal ring is in the eye
 
float Specular
 Specular intensity in the eye rendering
 
float Smoothness
 Overall smoothness of the eye material
 
float ReflectionTerm
 How strong environmental reflections should appear in the eye (controlled typically by a mask texture)
 
float OverallBrightness
 A strength of how bright the eye should be, can be used to lower the overall intensity/whiteness of an eye making it more realistic
 
float ScleraShadow
 If using procedural sclera shadows this controls the intensity of them
 
float IrisShadow
 If using procedural iris shadows this controls the intensity of them
 
- Public Attributes inherited from Astra.Asset.ItemModifierRecord
string PrimaryId
 This is primary id, such as an EyeItem.AstraGuid, DecalItem.AstraGuid, or similar
 
string SecondaryId
 This is the reference to the instance id since you could have multiple primary items on your avatar
 
ModifierType Type
 

Additional Inherited Members

- Public Types inherited from Astra.Asset.ItemModifierRecord
enum  ModifierType { Unknown = 0 , Eye = 1 , Material = 2 , Decal = 3 }
 Indicates which type of modifier record this belongs to More...
 
- Properties inherited from Astra.Asset.ItemModifierRecord
string ModifiedItemGuid [getset]
 This is primary id, such as an EyeItem.AstraGuid, DecalItem.AstraGuid, or similar. This is deprecated please switch to ItemModifierRecord.PrimaryId
 
string ModifiedCompoundItemInstanceId [getset]
 This is the reference to the instance id since you could have multiple primary items on your avatar. This is deprecated please switch to ItemModifierRecord.SecondaryId
 

Detailed Description

Allows advanced modification of EyeItems. Properties in this class are standardized values such as IrisColor that can be applied to different types of eye shaders. Simple materials/shaders may only use or care about properties such as IrisColor and not have other values. Not all shaders will implement these.

Constructor & Destructor Documentation

◆ EyeModifierRecord()

Astra.Asset.EyeModifierRecord.EyeModifierRecord ( string  eyeItemGuid,
string  secondaryId 
)
inline

Constructor, attached to a given item

Parameters
eyeItemGuidGuid of the item this is attached to
secondaryIdID of the compound instance this is attached to

The documentation for this class was generated from the following file: