class

XIVAPI::Dataclasses::Character

Inherits JSON::Serializable < Reference < Object

Dataclass containing a Character's data.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

active_class_job

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

Source
avatar

URL to the avatar for the Character. The avatar is a headshot of the Character, whereas the portrait is a full body image.

Source
bio

The Lodestone bio of the Character.

Source
class_jobs

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

Source
free_company_id

The Lodestone ID of the Character's current Free Company

Source
gear_set

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

Source
gender

An integer specifying the Character's gender. 1 is Male, 2 is Female.

Source
grand_company

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

Source
guardian_deity

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

Source
id

The Lodestone ID of the Character.

Source
minions

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

Source
minions_count

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

Source
minions_progress

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

Source
minions_total

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

Source
mounts

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

Source
mounts_count

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

Source
mounts_progress

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

Source
mounts_total

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

Source
name

The Character's name

Source
nameday

The Character's nameday

Source
portrait

URL for the Character's portrait. The portrait is a full body image, whereas the avatar is only a headshot of the Character.

Source
pvp_team_id

The Lodestone ID of the Character's PVP Team

Source
race

An IDNameUrl class containing the Character's racial information.

Source
server

The Server that the Character is currently in.

Source
title

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

Source
town

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

Source
tribe

An IDNameUrl class containing the details about the Character's race clan. An Icon field is returned from the API but we've found this to normally be null so we have removed it.

Source