ktlodestone/cloud.drakon.ktlodestone/KtLodestone

KtLodestone

Functions

suspend fun getAchievements(id: Int, pages: Byte? = null): ProfileAchievements

Gets the achievements of a character from The Lodestone. This is equivalent to what is returned by The Lodestone's /achievement endpoint for a character.

getAchievementsAsync

@JvmStatic

fun getAchievementsAsync(id: Int, pages: Byte? = null): CompletableFuture<ProfileAchievements>

Gets the achievements of a character from The Lodestone. This is equivalent to what is returned by The Lodestone's /achievement endpoint for a character. For use outside of Kotlin coroutines.

getAttributes

suspend fun getAttributes(id: Int): ProfileAttributes

Gets the attributes of a character from The Lodestone. This is equivalent to what is returned by The Lodestone's #profile endpoint for a character.

getAttributesAsync

@JvmStatic

fun getAttributesAsync(id: Int): CompletableFuture<ProfileAttributes>

Gets the attributes of a character from The Lodestone. This is equivalent to what is returned by The Lodestone's #profile endpoint for a character. For use outside of Kotlin coroutines.

getCharacter

suspend fun getCharacter(id: Int): ProfileCharacter

Gets a character's profile from The Lodestone. This is equivalent to what is returned by The Lodestone's #profile endpoint for a character.

getCharacterAsync

@JvmStatic

fun getCharacterAsync(id: Int): CompletableFuture<ProfileCharacter>

Gets a character's profile from The Lodestone. This is equivalent to what is returned by The Lodestone's #profile endpoint for a character. For use outside of Kotlin coroutines.

getClassJob

suspend fun getClassJob(id: Int): ProfileClassJob

Gets a characters class/job stats from The Lodestone. This is equivalent to what is returned by The Lodestone's /class_job endpoint for a character.

getClassJobAsync

@JvmStatic

fun getClassJobAsync(id: Int): CompletableFuture<ProfileClassJob>

Gets a characters class/job stats from The Lodestone. This is equivalent to what is returned by The Lodestone's /class_job endpoint for a character. For use outside of Kotlin coroutines.

getGearSet

suspend fun getGearSet(id: Int): ProfileGearSet

Gets a characters equipped gear set from The Lodestone.

getGearSetAsync

@JvmStatic

fun getGearSetAsync(id: Int): CompletableFuture<ProfileGearSet>

Gets a characters equipped gear set from The Lodestone. For use outside of Kotlin coroutines.

getMinions

suspend fun getMinions(id: Int): ProfileMinions

Gets the minions that a character on The Lodestone has acquired. This is equivalent to what is returned by The Lodestone's /minion endpoint for a character.

getMinionsAsync

@JvmStatic

fun getMinionsAsync(id: Int): CompletableFuture<ProfileMinions>

Gets the minions that a character on The Lodestone has acquired. This is equivalent to what is returned by The Lodestone's /minion endpoint for a character. For use outside of Kotlin coroutines.

getMounts

suspend fun getMounts(id: Int): ProfileMounts

Gets the mounts that a character on The Lodestone has acquired. This is equivalent to what is returned by The Lodestone's /mount endpoint for a character.

getMountsAsync

@JvmStatic

fun getMountsAsync(id: Int): CompletableFuture<ProfileMounts>

Gets the mounts that a character on The Lodestone has acquired. This is equivalent to what is returned by The Lodestone's /mount endpoint for a character. For use outside of Kotlin coroutines.

searchCharacter

suspend fun searchCharacter(name: String, world: World): List<CharacterSearchResult>?

Searches for a character on The Lodestone.

searchCharacterAsync

@JvmStatic

fun searchCharacterAsync(name: String, world: World): CompletableFuture<List<CharacterSearchResult>?>

Searches for a character on The Lodestone. For use outside of Kotlin coroutines.