Class Guild

Represents a guild from the API

Hierarchy

Constructors

constructor

Properties

apiVersion banner created createdTimestamp hasAdditionalStats level levelProgression libVersion memberSlots members name onlineMembers receivedAt requestedAt respondedAt seasonRanks source stars tag territories timestamp xp xpRaw xpRawLower xpRawUpper xpRequired

Methods

fetchAdditionalStats

Constructors

Private constructor

Properties

apiVersion

apiVersion: `${number}.${number}.${number}`

The version of the requested API route

banner

banner: BannerData

The banner data of the guild

created

created: Date

The creation date of the guild

createdTimestamp

createdTimestamp: number

The creation date of the guild as a unix timestamp

hasAdditionalStats

hasAdditionalStats: boolean

Indicates whether the object has the data returned if GuildRequestOptions.fetchAdditionalStats=true during request

This is used to determine whether `Guild#fetchAdditionalStats()` has an effect.

level

level: number

The level of the guild

levelProgression

levelProgression: number

The progress of the guild to the next level as a number between 0 and 1

libVersion

libVersion: `${number}.${number}.${number}`

The version of the representation of the data by the wrapper

memberSlots

memberSlots: number

The maximum member count of the guild (currently uses outdated data)

members

members: GuildMember[]

The members of the guild

name

name: string

The name of the guild

onlineMembers

onlineMembers: number

The amount of currently online members

receivedAt

receivedAt: number

The unix timestamp indicating when this request was received

This is measured using the local clock.
If the response was returned from cache, then requestedAt, respondedAt and receivedAt may be in the past.

requestedAt

requestedAt: number

The unix timestamp indicating when this request was sent

This is measured using the local clock.
If the response was returned from cache, then requestedAt, respondedAt and receivedAt may be in the past.

respondedAt

respondedAt: number

The unix timestamp indicating when this request was responded to by the API

This is measured using the API server's clock.
If the response was returned from cache, then requestedAt, respondedAt and receivedAt may be in the past.

seasonRanks

seasonRanks: SeasonRank[]

The placement in all seasons the guild participated in

source

source: `https://api.wynncraft.com/${string}`

The route used to request the data for this object

This is the value used to identify cache entries. API results with the same source can use the cache.

stars

stars: number

The amount of guild stars displayed in front of the guild's tag in chat

tag

tag: string

The tag of the guild

territories

territories: number | Territory[]

The amount of territories the guild currently holds

If hasAdditionalStats=true, this is an array of Territories instead.

timestamp

timestamp: number

The unix timestamp indicating when the data of this request was created

You can use this timestamp to determine how old a piece of data is.

xp

xp: number

The XP percentage of the guilds current level; Usually a number between 0 and 1

This number may be more than 1 as levelling up takes a couple minutes. Use Guild#levelprogression instead to get a safe percentage factor.

xpRaw

xpRaw: number

The raw amount of xp the guild has towards the next level; this amount is not exact, refer to Guild.xpRawLower and Guild.xpRawLower for the lower and upper bound

xpRawLower

xpRawLower: number

The lower bound of raw xp the guild has

xpRawUpper

xpRawUpper: number

The upper bound of raw xp the guild has

xpRequired

xpRequired: number

The total amount of XP required for the guild's current level

Methods

fetchAdditionalStats

  • fetchAdditionalStats(options?): Promise<Guild>

  • Mutates the object as if the fetchAdditionalStats property was true when this guild was requested

    This method causes API requests.

    Parameters

    • Optional options: GuildRequestOptions

      The options for the request; the guild field has no effect

    Returns Promise<Guild>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc