Class Avatar

Modder-facing wrapper for an Avatar component in the game. Provides access to avatar appearance and state without exposing game types.

public sealed class Avatar

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

The GameObject associated with this avatar.

public GameObject GameObject { get; }

Whether the avatar GameObject is active.

public bool IsActive { get; }

Finds all Avatar instances in the current scene.

public static Avatar[] FindInScene(bool includeInactive = false)

includeInactive bool: Whether to include inactive GameObjects in the search.

Loads avatar settings onto this avatar.

public void LoadAvatarSettings(AvatarSettings settings)