Class: PssUser

Classes_API~PssUser(rawUser)

Represents a PSS User (player).

Constructor

new PssUser(rawUser)

constructor - Creates an instance of PssUser based on the given data.

Parameters:
Name Type Description
rawUser Array.<any>

An array representing a user (player) as returned by the PSS Fleet Data API.

Source:

Members

allianceId :integer

allianceId - The AllianceId of the PSS User. Might be null, if the user does not belong to an Alliance.

Type:
  • integer
Source:

allianceJoinDate :Date

allianceJoinDate - The AllianceJoinDate of the PssUser. Might be null, if the user does not belong to an Alliance.

Type:
  • Date
Source:

allianceMembership :AllianceMembership

allianceMembership - The decoded AllianceMembership of the PssUser. Might be null, if the user does not belong to an Alliance.

Type:
  • AllianceMembership
Source:

allianceScore :integer

allianceScore - The AllianceScore (number of stars retrieved) of the PssUser. Might be null, if the user does not belong to an Alliance.

Type:
  • integer
Source:

championshipScore :integer

championshipScore - The ChampionshipScore of the PssUser.

Type:
  • integer
Source:

crewDonated :integer

crewDonated - The CrewDonated of the PssUser.

Type:
  • integer
Source:

crewReceived :integer

crewReceived - The CrewReceived of the PssUser.

Type:
  • integer
Source:

highestTrophy :integer

highestTrophy - The HighestTrophy of the PssUser.

Type:
  • integer
Source:

id :integer

id - The Id of the PSS User.

Type:
  • integer
Source:

lastHeartBeatDate :Date

lastHeartBeatDate - The LastHeartBeatDate of the PssUser.

Type:
  • Date
Source:

lastLoginDate :Date

lastLoginDate - The LastLoginDate of the PssUser.

Type:
  • Date
Source:

name :string

name - The Name of the PSS User.

Type:
  • string
Source:

pvpAttackDraws :integer

pvpAttackDraws - The PVPAttackDraws of the PssUser.

Type:
  • integer
Source:

pvpAttackLosses :integer

pvpAttackLosses - The PVPAttackLosses of the PssUser.

Type:
  • integer
Source:

pvpAttackWins :integer

pvpAttackWins - The PVPAttackWins of the PssUser.

Type:
  • integer
Source:

pvpDefenceDraws :integer

pvpDefenceDraws - The PVPDefenceDraws of the PssUser.

Type:
  • integer
Source:

pvpDefenceLosses :integer

pvpDefenceLosses - The PVPDefenceLosses of the PssUser.

Type:
  • integer
Source:

pvpDefenceWins :integer

pvpDefenceWins - The PVPDefenceWins of the PssUser.

Type:
  • integer
Source:

tournamentBonusScore :integer

tournamentBonusScore - The TournamentBonusScore (number of tournament battles done) of the PssUser.

Type:
  • integer
Source:

trophy :integer

trophy - The Trophy (trophy count) of the PssUser.

Type:
  • integer
Source: