Skip to main content
Version: 1.1.1

Struct CharacterIdentity

Namespace: OblivionMP.SDK.Common.Archetypes.Mixins
Assembly: OblivionMP.SDK.Common.dll

Who a player's character is, as picked in character creation: name, race, sex, class and birthsign.

[ArchetypeMixin(Replication.OwnershipBased)]
public readonly struct CharacterIdentity : 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​

Birthsign​

The form ID of the character's birthsign.

public FormId Birthsign { get; set; }

Property Value​

FormId

Class​

The form ID of the character's class.

public FormId Class { get; set; }

Property Value​

FormId

IsFemale​

Whether the character is female.

public bool IsFemale { get; set; }

Property Value​

bool

Name​

The character's name, as typed in character creation. The player's nickname is NicknameMixin.

public NativeString256 Name { get; set; }

Property Value​

NativeString256

Race​

The form ID of the character's race.

public FormId Race { get; set; }

Property Value​

FormId

Methods​

As<T>()​

public T As<T>() where T : struct, IArchetypeQueryable

Returns​

T

Type Parameters​

T

Is<T>()​

public bool Is<T>() where T : struct, IArchetypeQueryable

Returns​

bool

Type Parameters​

T

Keep()​

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

public CharacterIdentity Keep()

Returns​

CharacterIdentity

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.

TryAs<T>(out T)​

public bool TryAs<T>(out T archetype) where T : struct, IArchetypeQueryable

Parameters​

archetype T

Returns​

bool

Type Parameters​

T

  • Properties
    • Birthsign
    • Class
    • IsFemale
    • Name
    • Race
  • Methods
    • As<T>()
    • Is<T>()
    • Keep()
    • TryAs<T>(out T)