class XIVAPI::Dataclasses::Character

• XIVAPI::Dataclasses::Character
• Reference
• Object

Overview

Dataclass containing a Character's data.

Defined in:

dataclasses/character/character.cr

Constructors

• .new(__temp_273 : JSON::PullParser)

Instance Method Summary

• #active_class_job : XIVAPI::Dataclasses::ClassJob

  A ClassJob class representing the Class or Job the Character currently is at the time of the previous XIVAPI update.

• #active_class_job=(_active_class_job : ClassJob)
• #avatar : String

  URL to the avatar for the Character.

• #avatar=(_avatar : String)
• #bio : String

  The Lodestone bio of the Character.

• #bio=(_bio : String)
• #class_jobs : Array(XIVAPI::Dataclasses::ClassJob)

  An array of ClassJob classes for all of the Classes and Jobs the Character currently has unlocked.

• #class_jobs=(_class_jobs : Array(ClassJob))
• #free_company_id : String?

  The Lodestone ID of the Character's current Free Company

• #free_company_id=(_free_company_id : ::Union(String, Nil))
• #gear_set : XIVAPI::Dataclasses::GearSet

  A GearSet class representing the Character's currently equipped Gear Set.

• #gear_set=(_gear_set : GearSet)
• #gender : UInt8

  An integer specifying the Character's gender.

• #gender=(_gender : UInt8)
• #grand_company : XIVAPI::Dataclasses::GrandCompanyCharacterData?

  A GrandCompanyCharacterData class containing the Character's Grand Company information.

• #grand_company=(_grand_company : ::Union(GrandCompanyCharacterData, Nil))
• #guardian_deity : XIVAPI::Dataclasses::GuardianDeity

  A GuardianDeity class containing the Character's Guardian Deity information.

• #guardian_deity=(_guardian_deity : GuardianDeity)
• #id : UInt64

  The Lodestone ID of the Character.

• #id=(_id : UInt64)
• #minions : Array(XIVAPI::Dataclasses::MinionMount)

  An Array of MinionMount classs representing the Minions owned by the Character.

• #minions=(_minions : Array(MinionMount))
• #minions_count : UInt64

  An integer value for the number of Minions currently owned by the Character.

• #minions_count=(_minions_count : UInt64)
• #minions_progress : String

  A string value indicating the percentage of the total number of Minions that the Character currently owns.

• #minions_progress=(_minions_progress : String)
• #minions_total : UInt64

  An integer representing the total number of Minions currently in XIVAPI.

• #minions_total=(_minions_total : UInt64)
• #mounts : Array(XIVAPI::Dataclasses::MinionMount)

  An Array of MinionMount classs representing the Mounts owned by the Character.

• #mounts=(_mounts : Array(MinionMount))
• #mounts_count : UInt64

  An integer value for the number of Mounts currently owned by the Character.

• #mounts_count=(_mounts_count : UInt64)
• #mounts_progress : String

  A string value indicating the percentage of the total number of Mounts that the Character currently owns.

• #mounts_progress=(_mounts_progress : String)
• #mounts_total : UInt64

  An integer representing the total number of Mounts currently in XIVAPI.

• #mounts_total=(_mounts_total : UInt64)
• #name : String

  The Character's name

• #name=(_name : String)
• #nameday : String

  The Character's nameday

• #nameday=(_nameday : String)
• #portrait : String

  URL for the Character's portrait.

• #portrait=(_portrait : String)
• #pvp_team_id : UInt64?

  The Lodestone ID of the Character's PVP Team

• #pvp_team_id=(_pvp_team_id : ::Union(UInt64, Nil))
• #race : XIVAPI::Dataclasses::IDNameUrl

  An IDNameUrl class containing the Character's racial information.

• #race=(_race : IDNameUrl)
• #server : String

  The Server that the Character is currently in.

• #server=(_server : String)
• #title : XIVAPI::Dataclasses::IDIconNameUrl?

  An IDIconNameUrl class containing the details about the Character's current title.

• #title=(_title : ::Union(IDIconNameUrl, Nil))
• #to_json(json : JSON::Builder)
• #town : XIVAPI::Dataclasses::IDIconNameUrl

  An IDIconNameUrl class containing the details about the Character's starting town.

• #town=(_town : IDIconNameUrl)
• #tribe : XIVAPI::Dataclasses::IDNameUrl

  An IDNameUrl class containing the details about the Character's race clan.

• #tribe=(_tribe : IDNameUrl)

Constructor Detail

Instance Method Detail