Skip to main content
Version: 1.0.0

Struct Appearance

Namespace: OblivionMp.Sdk.Common.Archetypes.Mixins
Assembly: OblivionMp.Sdk.Common.dll

How a player's character looks: sex, race, face and hair.

[ArchetypeMixin]
public readonly struct Appearance : IArchetypeMixin, IArchetypeQueryable, IEntityShape

Implements​

IArchetypeMixin, IArchetypeQueryable, IEntityShape

Inherited Members​

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Properties​

BeardPath​

The asset path of the beard.

public NativeString256 BeardPath { get; set; }

Property Value​

NativeString256

BoneScalingCount​

public int BoneScalingCount { get; }

Property Value​

int

CustomisationBeardIndex​

Which beard option is picked in the character creator.

public int CustomisationBeardIndex { get; set; }

Property Value​

int

CustomisationEyeMaterialIndex​

Which eye option is picked in the character creator.

public int CustomisationEyeMaterialIndex { get; set; }

Property Value​

int

CustomisationEyebrowsIndex​

Which eyebrows option is picked in the character creator.

public int CustomisationEyebrowsIndex { get; set; }

Property Value​

int

CustomisationHairIndex​

Which hair option is picked in the character creator.

public int CustomisationHairIndex { get; set; }

Property Value​

int

CustomisationMustacheIndex​

Which mustache option is picked in the character creator.

public int CustomisationMustacheIndex { get; set; }

Property Value​

int

EyeMaterialPath​

The asset path of the eye material.

public NativeString256 EyeMaterialPath { get; set; }

Property Value​

NativeString256

EyebrowsPath​

The asset path of the eyebrows.

public NativeString256 EyebrowsPath { get; set; }

Property Value​

NativeString256

FaceBaseMeshPath​

The asset path of the base face mesh.

public NativeString256 FaceBaseMeshPath { get; set; }

Property Value​

NativeString256

FaceMatOverrideCount​

public int FaceMatOverrideCount { get; }

Property Value​

int

FaceMorphCount​

public int FaceMorphCount { get; }

Property Value​

int

FaceMorphsSourcePath​

The asset path of the face morphs source.

public NativeString256 FaceMorphsSourcePath { get; set; }

Property Value​

NativeString256

HairPath​

The asset path of the hair.

public NativeString256 HairPath { get; set; }

Property Value​

NativeString256

MustachePath​

The asset path of the mustache.

public NativeString256 MustachePath { get; set; }

Property Value​

NativeString256

RacePath​

The asset path of the character's race.

public NativeString256 RacePath { get; set; }

Property Value​

NativeString256

SenescenceLevel​

The age level of the character's face.

public int SenescenceLevel { get; set; }

Property Value​

int

Sex​

The character's sex.

public CharacterSex Sex { get; set; }

Property Value​

CharacterSex

SkinColorCount​

public int SkinColorCount { get; }

Property Value​

int

SkinParamCount​

public int SkinParamCount { get; }

Property Value​

int

SkinParameterDefinitionsPath​

The asset path of the skin parameter definitions.

public NativeString256 SkinParameterDefinitionsPath { get; set; }

Property Value​

NativeString256

Methods​

AddBoneScaling(in NativeString256, in float)​

[Changes("Appearance.Field.BoneScaling")]
public bool AddBoneScaling(in NativeString256 key, in float value)

Parameters​

key NativeString256

value float

Returns​

bool

AddFaceMatOverride(in NativeString256, in NativeString256)​

[Changes("Appearance.Field.FaceMatOverride")]
public bool AddFaceMatOverride(in NativeString256 key, in NativeString256 value)

Parameters​

key NativeString256

value NativeString256

Returns​

bool

AddFaceMorph(in NativeString256, in float)​

[Changes("Appearance.Field.FaceMorph")]
public bool AddFaceMorph(in NativeString256 key, in float value)

Parameters​

key NativeString256

value float

Returns​

bool

AddSkinColor(in NativeString256, in Vector4)​

[Changes("Appearance.Field.SkinColor")]
public bool AddSkinColor(in NativeString256 key, in Vector4 value)

Parameters​

key NativeString256

value Vector4

Returns​

bool

AddSkinParam(in NativeString256, in float)​

[Changes("Appearance.Field.SkinParam")]
public bool AddSkinParam(in NativeString256 key, in float value)

Parameters​

key NativeString256

value float

Returns​

bool

ClearBoneScaling()​

[Changes("Appearance.Field.BoneScaling")]
public void ClearBoneScaling()

ClearFaceMatOverride()​

[Changes("Appearance.Field.FaceMatOverride")]
public void ClearFaceMatOverride()

ClearFaceMorph()​

[Changes("Appearance.Field.FaceMorph")]
public void ClearFaceMorph()

ClearSkinColor()​

[Changes("Appearance.Field.SkinColor")]
public void ClearSkinColor()

ClearSkinParam()​

[Changes("Appearance.Field.SkinParam")]
public void ClearSkinParam()

ContainsBoneScaling(in NativeString256, in float)​

public bool ContainsBoneScaling(in NativeString256 key, in float value)

Parameters​

key NativeString256

value float

Returns​

bool

ContainsBoneScalingKey(in NativeString256)​

public bool ContainsBoneScalingKey(in NativeString256 key)

Parameters​

key NativeString256

Returns​

bool

ContainsFaceMatOverride(in NativeString256, in NativeString256)​

public bool ContainsFaceMatOverride(in NativeString256 key, in NativeString256 value)

Parameters​

key NativeString256

value NativeString256

Returns​

bool

ContainsFaceMatOverrideKey(in NativeString256)​

public bool ContainsFaceMatOverrideKey(in NativeString256 key)

Parameters​

key NativeString256

Returns​

bool

ContainsFaceMorph(in NativeString256, in float)​

public bool ContainsFaceMorph(in NativeString256 key, in float value)

Parameters​

key NativeString256

value float

Returns​

bool

ContainsFaceMorphKey(in NativeString256)​

public bool ContainsFaceMorphKey(in NativeString256 key)

Parameters​

key NativeString256

Returns​

bool

ContainsSkinColor(in NativeString256, in Vector4)​

public bool ContainsSkinColor(in NativeString256 key, in Vector4 value)

Parameters​

key NativeString256

value Vector4

Returns​

bool

ContainsSkinColorKey(in NativeString256)​

public bool ContainsSkinColorKey(in NativeString256 key)

Parameters​

key NativeString256

Returns​

bool

ContainsSkinParam(in NativeString256, in float)​

public bool ContainsSkinParam(in NativeString256 key, in float value)

Parameters​

key NativeString256

value float

Returns​

bool

ContainsSkinParamKey(in NativeString256)​

public bool ContainsSkinParamKey(in NativeString256 key)

Parameters​

key NativeString256

Returns​

bool

GetBoneScaling()​

public NativeDictionary<NativeString256, float, NativeStringHash256>.ReadOnly GetBoneScaling()

Returns​

NativeDictionary<NativeString256, float, NativeStringHash256>.ReadOnly

GetBoneScaling(in NativeString256)​

public float GetBoneScaling(in NativeString256 key)

Parameters​

key NativeString256

Returns​

float

GetFaceMatOverride()​

public NativeDictionary<NativeString256, NativeString256, NativeStringHash256>.ReadOnly GetFaceMatOverride()

Returns​

NativeDictionary<NativeString256, NativeString256, NativeStringHash256>.ReadOnly

GetFaceMatOverride(in NativeString256)​

public NativeString256 GetFaceMatOverride(in NativeString256 key)

Parameters​

key NativeString256

Returns​

NativeString256

GetFaceMorph()​

public NativeDictionary<NativeString256, float, NativeStringHash256>.ReadOnly GetFaceMorph()

Returns​

NativeDictionary<NativeString256, float, NativeStringHash256>.ReadOnly

GetFaceMorph(in NativeString256)​

public float GetFaceMorph(in NativeString256 key)

Parameters​

key NativeString256

Returns​

float

GetSkinColor()​

public NativeDictionary<NativeString256, Vector4, NativeStringHash256>.ReadOnly GetSkinColor()

Returns​

NativeDictionary<NativeString256, Vector4, NativeStringHash256>.ReadOnly

GetSkinColor(in NativeString256)​

public Vector4 GetSkinColor(in NativeString256 key)

Parameters​

key NativeString256

Returns​

Vector4

GetSkinParam()​

public NativeDictionary<NativeString256, float, NativeStringHash256>.ReadOnly GetSkinParam()

Returns​

NativeDictionary<NativeString256, float, NativeStringHash256>.ReadOnly

GetSkinParam(in NativeString256)​

public float GetSkinParam(in NativeString256 key)

Parameters​

key NativeString256

Returns​

float

Keep()​

This entity, which it already is: a loop over this shape hands over the shape itself.

public Appearance Keep()

Returns​

Appearance

Remarks​

Here so taking something out of a loop reads the same whichever way the loop walks. Whether a shape is walked by chunk follows from what it includes, which the call site cannot see and which changes when an include does.

RemoveBoneScaling(in NativeString256)​

[Changes("Appearance.Field.BoneScaling")]
public bool RemoveBoneScaling(in NativeString256 key)

Parameters​

key NativeString256

Returns​

bool

RemoveFaceMatOverride(in NativeString256)​

[Changes("Appearance.Field.FaceMatOverride")]
public bool RemoveFaceMatOverride(in NativeString256 key)

Parameters​

key NativeString256

Returns​

bool

RemoveFaceMorph(in NativeString256)​

[Changes("Appearance.Field.FaceMorph")]
public bool RemoveFaceMorph(in NativeString256 key)

Parameters​

key NativeString256

Returns​

bool

RemoveSkinColor(in NativeString256)​

[Changes("Appearance.Field.SkinColor")]
public bool RemoveSkinColor(in NativeString256 key)

Parameters​

key NativeString256

Returns​

bool

RemoveSkinParam(in NativeString256)​

[Changes("Appearance.Field.SkinParam")]
public bool RemoveSkinParam(in NativeString256 key)

Parameters​

key NativeString256

Returns​

bool

SetBoneScaling(in NativeDictionary<NativeString256, float, NativeStringHash256>)​

[Changes("Appearance.Field.BoneScaling")]
public void SetBoneScaling(in NativeDictionary<NativeString256, float, NativeStringHash256> value)

Parameters​

value NativeDictionary<NativeString256, float, NativeStringHash256>

SetBoneScaling(in NativeString256, in float)​

[Changes("Appearance.Field.BoneScaling")]
public void SetBoneScaling(in NativeString256 key, in float value)

Parameters​

key NativeString256

value float

SetFaceMatOverride(in NativeDictionary<NativeString256, NativeString256, NativeStringHash256>)​

[Changes("Appearance.Field.FaceMatOverride")]
public void SetFaceMatOverride(in NativeDictionary<NativeString256, NativeString256, NativeStringHash256> value)

Parameters​

value NativeDictionary<NativeString256, NativeString256, NativeStringHash256>

SetFaceMatOverride(in NativeString256, in NativeString256)​

[Changes("Appearance.Field.FaceMatOverride")]
public void SetFaceMatOverride(in NativeString256 key, in NativeString256 value)

Parameters​

key NativeString256

value NativeString256

SetFaceMorph(in NativeDictionary<NativeString256, float, NativeStringHash256>)​

[Changes("Appearance.Field.FaceMorph")]
public void SetFaceMorph(in NativeDictionary<NativeString256, float, NativeStringHash256> value)

Parameters​

value NativeDictionary<NativeString256, float, NativeStringHash256>

SetFaceMorph(in NativeString256, in float)​

[Changes("Appearance.Field.FaceMorph")]
public void SetFaceMorph(in NativeString256 key, in float value)

Parameters​

key NativeString256

value float

SetSkinColor(in NativeDictionary<NativeString256, Vector4, NativeStringHash256>)​

[Changes("Appearance.Field.SkinColor")]
public void SetSkinColor(in NativeDictionary<NativeString256, Vector4, NativeStringHash256> value)

Parameters​

value NativeDictionary<NativeString256, Vector4, NativeStringHash256>

SetSkinColor(in NativeString256, in Vector4)​

[Changes("Appearance.Field.SkinColor")]
public void SetSkinColor(in NativeString256 key, in Vector4 value)

Parameters​

key NativeString256

value Vector4

SetSkinParam(in NativeDictionary<NativeString256, float, NativeStringHash256>)​

[Changes("Appearance.Field.SkinParam")]
public void SetSkinParam(in NativeDictionary<NativeString256, float, NativeStringHash256> value)

Parameters​

value NativeDictionary<NativeString256, float, NativeStringHash256>

SetSkinParam(in NativeString256, in float)​

[Changes("Appearance.Field.SkinParam")]
public void SetSkinParam(in NativeString256 key, in float value)

Parameters​

key NativeString256

value float

TryGetBoneScalingValue(in NativeString256, out float)​

public bool TryGetBoneScalingValue(in NativeString256 key, out float value)

Parameters​

key NativeString256

value float

Returns​

bool

TryGetFaceMatOverrideValue(in NativeString256, out NativeString256)​

public bool TryGetFaceMatOverrideValue(in NativeString256 key, out NativeString256 value)

Parameters​

key NativeString256

value NativeString256

Returns​

bool

TryGetFaceMorphValue(in NativeString256, out float)​

public bool TryGetFaceMorphValue(in NativeString256 key, out float value)

Parameters​

key NativeString256

value float

Returns​

bool

TryGetSkinColorValue(in NativeString256, out Vector4)​

public bool TryGetSkinColorValue(in NativeString256 key, out Vector4 value)

Parameters​

key NativeString256

value Vector4

Returns​

bool

TryGetSkinParamValue(in NativeString256, out float)​

public bool TryGetSkinParamValue(in NativeString256 key, out float value)

Parameters​

key NativeString256

value float

Returns​

bool

  • Properties
    • BeardPath
    • BoneScalingCount
    • CustomisationBeardIndex
    • CustomisationEyeMaterialIndex
    • CustomisationEyebrowsIndex
    • CustomisationHairIndex
    • CustomisationMustacheIndex
    • EyeMaterialPath
    • EyebrowsPath
    • FaceBaseMeshPath
    • FaceMatOverrideCount
    • FaceMorphCount
    • FaceMorphsSourcePath
    • HairPath
    • MustachePath
    • RacePath
    • SenescenceLevel
    • Sex
    • SkinColorCount
    • SkinParamCount
    • SkinParameterDefinitionsPath
  • Methods
    • AddBoneScaling(in NativeString256, in float)
    • AddFaceMatOverride(in NativeString256, in NativeString256)
    • AddFaceMorph(in NativeString256, in float)
    • AddSkinColor(in NativeString256, in Vector4)
    • AddSkinParam(in NativeString256, in float)
    • ClearBoneScaling()
    • ClearFaceMatOverride()
    • ClearFaceMorph()
    • ClearSkinColor()
    • ClearSkinParam()
    • ContainsBoneScaling(in NativeString256, in float)
    • ContainsBoneScalingKey(in NativeString256)
    • ContainsFaceMatOverride(in NativeString256, in NativeString256)
    • ContainsFaceMatOverrideKey(in NativeString256)
    • ContainsFaceMorph(in NativeString256, in float)
    • ContainsFaceMorphKey(in NativeString256)
    • ContainsSkinColor(in NativeString256, in Vector4)
    • ContainsSkinColorKey(in NativeString256)
    • ContainsSkinParam(in NativeString256, in float)
    • ContainsSkinParamKey(in NativeString256)
    • GetBoneScaling()
    • GetBoneScaling(in NativeString256)
    • GetFaceMatOverride()
    • GetFaceMatOverride(in NativeString256)
    • GetFaceMorph()
    • GetFaceMorph(in NativeString256)
    • GetSkinColor()
    • GetSkinColor(in NativeString256)
    • GetSkinParam()
    • GetSkinParam(in NativeString256)
    • Keep()
    • RemoveBoneScaling(in NativeString256)
    • RemoveFaceMatOverride(in NativeString256)
    • RemoveFaceMorph(in NativeString256)
    • RemoveSkinColor(in NativeString256)
    • RemoveSkinParam(in NativeString256)
    • SetBoneScaling(in NativeDictionary<NativeString256, float, NativeStringHash256>)
    • SetBoneScaling(in NativeString256, in float)
    • SetFaceMatOverride(in NativeDictionary<NativeString256, NativeString256, NativeStringHash256>)
    • SetFaceMatOverride(in NativeString256, in NativeString256)
    • SetFaceMorph(in NativeDictionary<NativeString256, float, NativeStringHash256>)
    • SetFaceMorph(in NativeString256, in float)
    • SetSkinColor(in NativeDictionary<NativeString256, Vector4, NativeStringHash256>)
    • SetSkinColor(in NativeString256, in Vector4)
    • SetSkinParam(in NativeDictionary<NativeString256, float, NativeStringHash256>)
    • SetSkinParam(in NativeString256, in float)
    • TryGetBoneScalingValue(in NativeString256, out float)
    • TryGetFaceMatOverrideValue(in NativeString256, out NativeString256)
    • TryGetFaceMorphValue(in NativeString256, out float)
    • TryGetSkinColorValue(in NativeString256, out Vector4)
    • TryGetSkinParamValue(in NativeString256, out float)