Class BasicAvatarSettings

Namespace

S1API.Avatar

Assembly

S1API.dll

Simplified avatar settings format used by the character creator. Provides a more user-friendly interface for basic character customization compared to the full AvatarSettings.

public sealed class BasicAvatarSettings

Inheritance

object

BasicAvatarSettings

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

Bottom

Bottom clothing layer path/identifier.

public string Bottom { get; set; }

Property Value

string

BottomColor

Bottom clothing color.

public Color BottomColor { get; set; }

Property Value

Color

EyeballColor

Eyeball color.

public Color EyeballColor { get; set; }

Property Value

Color

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

Eyewear

Eyewear accessory path/identifier.

public string Eyewear { get; set; }

Property Value

string

EyewearColor

Eyewear color.

public Color EyewearColor { get; set; }

Property Value

Color

FacialDetails

Facial details layer path/identifier (e.g., scars, makeup).

public string FacialDetails { get; set; }

Property Value

string

FacialDetailsIntensity

Facial details intensity (0.0 to 1.0).

public float FacialDetailsIntensity { get; set; }

Property Value

float

FacialHair

Facial hair layer path/identifier.

public string FacialHair { get; set; }

Property Value

string

Gender

Gender value (0 = male, 1 = female).

public int Gender { get; set; }

Property Value

int

HairColor

Hair color.

public Color HairColor { get; set; }

Property Value

Color

HairStyle

Hair style path/identifier.

public string HairStyle { get; set; }

Property Value

string

Headwear

Headwear accessory path/identifier.

public string Headwear { get; set; }

Property Value

string

HeadwearColor

Headwear color.

public Color HeadwearColor { get; set; }

Property Value

Color

LowerEyeLidRestingPosition

Lower eye lid resting position (0.0 to 1.0).

public float LowerEyeLidRestingPosition { get; set; }

Property Value

float

Mouth

Mouth layer path/identifier.

public string Mouth { get; set; }

Property Value

string

PupilDilation

Pupil dilation value (typically 0.0 to 1.0).

public float PupilDilation { get; set; }

Property Value

float

Shoes

Shoes accessory path/identifier.

public string Shoes { get; set; }

Property Value

string

ShoesColor

Shoes color.

public Color ShoesColor { get; set; }

Property Value

Color

SkinColor

Skin color.

public Color SkinColor { get; set; }

Property Value

Color

Top

Top clothing layer path/identifier.

public string Top { get; set; }

Property Value

string

TopColor

Top clothing color.

public Color TopColor { get; set; }

Property Value

Color

UpperEyeLidRestingPosition

Upper eye lid resting position (0.0 to 1.0).

public float UpperEyeLidRestingPosition { get; set; }

Property Value

float

Weight

Weight value (typically 0.0 to 1.0).

public float Weight { get; set; }

Property Value

float

Methods

AddTattoo(string)

Adds a tattoo layer path to the tattoos list.

public void AddTattoo(string tattooPath)

Parameters

tattooPath string

The tattoo layer path to add.

Create()

Creates a new BasicAvatarSettings instance.

public static BasicAvatarSettings Create()

Returns

BasicAvatarSettings

GetTattoos()

Gets a list of tattoo layer paths.

public List<string> GetTattoos()

Returns

List<string>

GetValue<T>(string)

Gets a field value by name using reflection.

public T GetValue<T>(string fieldName)

Parameters

fieldName string

The name of the field.

Returns

T

The field value, or default(T) if not found.

Type Parameters

T

The type of the value.

SetTattoos(List<string>)

Sets the tattoo layer paths.

public void SetTattoos(List<string> tattoos)

Parameters

tattoos List<string>

List of tattoo layer paths.

SetValue<T>(string, T)

Sets a field value by name using reflection.

public void SetValue<T>(string fieldName, T value)

Parameters

fieldName string

The name of the field.

value T

The value to set.

Type Parameters

T

The type of the value.

ToAvatarSettings()

Converts this BasicAvatarSettings to a full AvatarSettings instance.

public AvatarSettings ToAvatarSettings()

Returns

AvatarSettings

A new AvatarSettings instance with the converted settings.