StarRailUser

Hierarchy

• unknown
  • StarRailUser

Index

Constructors

• constructor

Properties

• achievements
• characterCount
• client
• enkaUserHash
• equilibriumLevel
• forgottenHall
• friends
• icon
• level
• lightConeCount
• nickname
• platform
• signature
• simulatedUniverse
• starfaringCompanions
• supportCharacters
• uid

Methods

• getCharacters

Constructors

constructor

• new StarRailUser(data: JsonObject, client: StarRail): StarRailUser

• Overrides User.constructor

  Parameters

  • data: JsonObject

  • client: StarRail

  Returns StarRailUser

Properties

readonlyachievements

achievements: number

readonlycharacterCount

characterCount: number

readonlyclient

client: StarRail

readonlyenkaUserHash

enkaUserHash: null | string

readonlyequilibriumLevel

equilibriumLevel: number

World level

readonlyforgottenHall

forgottenHall: null | ForgottenHallInfo

This will be null if the user has not yet unlocked Forgotten Hall.

readonlyfriends

friends: number

readonlyicon

icon: UserIcon

readonlylevel

level: number

Trailblaze level

readonlylightConeCount

lightConeCount: number

readonlynickname

nickname: string

readonlyplatform

platform: null | Platform

readonlysignature

signature: null | string

readonlysimulatedUniverse

simulatedUniverse: number

readonlystarfaringCompanions

starfaringCompanions: Character[]

Characters on the user's display. Characters that are also in supportCharacter are omitted if you use Enka.Network API.

readonlysupportCharacters

supportCharacters: Character[]

readonlyuid

uid: number

This will be NaN if this StarRailUser is from EnkaGameAccount and isUidPublic is false.

Methods

getCharacters

• getCharacters(): Character[]

• You should use this method to get characters if you use Enka.Network API.

  ---

  Returns Character[]