Class AvatarSettings

Namespace

S1API.Avatar

Assembly

S1API.dll

Modder-facing wrapper for AvatarSettings ScriptableObject. Provides access to avatar appearance configuration without exposing game types.

public sealed class AvatarSettings

Inheritance

object

AvatarSettings

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Properties

AccessoryCount

Accessory settings count.

public int AccessoryCount { get; }

Property Value

int

BodyLayerCount

Body layer settings count.

public int BodyLayerCount { get; }

Property Value

int

EyeBallTint

Eye ball tint color.

public Color EyeBallTint { get; set; }

Property Value

Color

EyeballMaterialIdentifier

Eyeball material identifier.

public string EyeballMaterialIdentifier { get; set; }

Property Value

string

EyebrowRestingAngle

Eyebrow resting angle value.

public float EyebrowRestingAngle { get; set; }

Property Value

float

EyebrowRestingHeight

Eyebrow resting height value.

public float EyebrowRestingHeight { get; set; }

Property Value

float

EyebrowScale

Eyebrow scale value.

public float EyebrowScale { get; set; }

Property Value

float

EyebrowThickness

Eyebrow thickness value.

public float EyebrowThickness { get; set; }

Property Value

float

FaceLayerCount

Face layer settings count.

public int FaceLayerCount { get; }

Property Value

int

Gender

Gender value (0.0 to 1.0).

public float Gender { get; set; }

Property Value

float

HairColor

Hair color.

public Color HairColor { get; set; }

Property Value

Color

HairPath

Hair path/identifier.

public string HairPath { get; set; }

Property Value

string

Height

Height value (typically 0.0 to 1.0).

public float Height { get; set; }

Property Value

float

LeftEyeLidColor

Left eye lid color.

public Color32 LeftEyeLidColor { get; set; }

Property Value

Color32

LeftEyeRestingState

Left eye resting state configuration.

public AvatarSettings.EyeLidConfiguration LeftEyeRestingState { get; set; }

Property Value

AvatarSettings.EyeLidConfiguration

PupilDilation

Pupil dilation value (typically 0.0 to 1.0).

public float PupilDilation { get; set; }

Property Value

float

RightEyeLidColor

Right eye lid color.

public Color32 RightEyeLidColor { get; set; }

Property Value

Color32

RightEyeRestingState

Right eye resting state configuration.

public AvatarSettings.EyeLidConfiguration RightEyeRestingState { get; set; }

Property Value

AvatarSettings.EyeLidConfiguration

SkinColor

Skin color.

public Color32 SkinColor { get; set; }

Property Value

Color32

Weight

Weight value (typically 0.0 to 1.0).

public float Weight { get; set; }

Property Value

float

Methods

AddAccessory(string, Color)

Adds an accessory setting.

public void AddAccessory(string path, Color color)

Parameters

path string

color Color

AddBodyLayer(string, Color)

Adds a body layer setting.

public void AddBodyLayer(string layerPath, Color layerTint)

Parameters

layerPath string

layerTint Color

AddFaceLayer(string, Color)

Adds a face layer setting.

public void AddFaceLayer(string layerPath, Color layerTint)

Parameters

layerPath string

layerTint Color

Create()

Creates a new AvatarSettings instance.

public static AvatarSettings Create()

Returns

AvatarSettings

GetAccessories()

Gets all accessory settings.

public List<AvatarSettings.AccessorySetting> GetAccessories()

Returns

List<AvatarSettings.AccessorySetting>

GetBodyLayers()

Gets all body layer settings.

public List<AvatarSettings.LayerSetting> GetBodyLayers()

Returns

List<AvatarSettings.LayerSetting>

GetFaceLayers()

Gets all face layer settings.

public List<AvatarSettings.LayerSetting> GetFaceLayers()

Returns

List<AvatarSettings.LayerSetting>

SetAccessories(List<AccessorySetting>)

Sets accessory settings from a list.

public void SetAccessories(List<AvatarSettings.AccessorySetting> accessories)

Parameters

accessories List<AvatarSettings.AccessorySetting>

SetBodyLayers(List<LayerSetting>)

Sets body layer settings from a list.

public void SetBodyLayers(List<AvatarSettings.LayerSetting> layers)

Parameters

layers List<AvatarSettings.LayerSetting>

SetFaceLayers(List<LayerSetting>)

Sets face layer settings from a list.

public void SetFaceLayers(List<AvatarSettings.LayerSetting> layers)

Parameters

layers List<AvatarSettings.LayerSetting>