Class Clan

Readonlyid

Readonlyname

addPlayerToWhitelist

• addPlayerToWhitelist(
      player: string | number,
      rankName?: string,
      title?: string,
  ): boolean

  Add a player to the current clan's whitelist. If the player is already in the whitelist this will change their rank or title.

  Parameters

  • player: string | number

    Player id or name

  • OptionalrankName: string

    Rank to give the player. If not provided they will be given the lowest rank

  • title: string = ""

    Title to give the player. If not provided, will be blank

  Returns boolean

  Success

check

• check(): boolean

  Check that this clan is the player's current clan

  Returns boolean

  Whether this is the current clan

getCurrentFax

• getCurrentFax(): Monster | null

  Determine the monster that is currently in the current clan's fax machine if any

  Returns Monster | null

  The current fax monster

getMeatInCoffer

• getMeatInCoffer(): number

  Return the amount of meat in the current clan's coffer

  Returns number

  Amount of meat

getRanks

• getRanks(): Rank[]

  List available ranks (name, degree and id) from the current clan

  Returns Rank[]

  List of ranks

join

• join(): Clan

  Join clan

  Returns Clan

  Joined clan

put

• put(items: Item[]): Item[]

  Put items in the stash

  Parameters

  • items: Item[]

    Items to put in the stash

  Returns Item[]

  Items successfully put in the stash

• put(items: Map<Item, number>): Map<Item, number>

  Put items in the stash

  Parameters

  • items: Map<Item, number>

    Items to put in the stash

  Returns Map<Item, number>

  Items successfully put in the stash

putMeatInCoffer

• putMeatInCoffer(amount: number): boolean

  Add the given amount of meat to the current clan's coffer.

  Parameters

  • amount: number

    Amount of meat to put in coffer

  Returns boolean

  Success

removePlayerFromWhitelist

• removePlayerFromWhitelist(player: string | number): boolean

  Remove a player from the current clan's whitelist

  Parameters

  • player: string | number

    Player id or name

  Returns boolean

  Success

take

• take(items: Item[]): Item[]

  Take items from the stash

  This function will also take equivalent foldables if the original item cannot be found

  Parameters

  • items: Item[]

    Items to take

  Returns Item[]

  Items successfully taken

• take(items: Map<Item, number>): Map<Item, number>

  Take items from the stash

  This function will also take equivalent foldables if the original item cannot be found

  Parameters

  • items: Map<Item, number>

    Items to take

  Returns Map<Item, number>

  Items successfully taken

withStash

• withStash<T>(items: Item[], callback: (borrowedItems: Item[]) => T): T

  Return the monster that is currently in the current clan's fax machine if any

  Type Parameters

  • T

  Parameters

  • items: Item[]
  • callback: (borrowedItems: Item[]) => T

  Returns T

• withStash<T>(
      items: Map<Item, number>,
      callback: (borrowedItems: Map<Item, number>) => T,
  ): T

  Return the monster that is currently in the current clan's fax machine if any

  Type Parameters

  • T

  Parameters

  • items: Map<Item, number>
  • callback: (borrowedItems: Map<Item, number>) => T

  Returns T

Staticget

• get(): Clan

  Get the player's current clan

  Returns Clan

  Player's clan

StaticgetWhitelisted

• getWhitelisted(): Clan[]

  Get list of clans to which the player is whitelisted

  Returns Clan[]

  List of clans

Staticjoin

• join(clanIdOrName: string | number): Clan

  Join a clan

  Parameters

  • clanIdOrName: string | number

    Clan id or name

  Returns Clan

  Instance of joined clan

Staticwith

• with<T>(clanIdOrName: string | number, callback: (clan: Clan) => T): T

  Execute callback as a member of a clan and then restore prior membership

  Type Parameters

  • T

  Parameters

  • clanIdOrName: string | number

    Clan id or name

  • callback: (clan: Clan) => T

    Actions to carry out while member of specified can

  Returns T

  Return value from callback

StaticwithStash

• withStash<T>(
      clanIdOrName: string | number,
      items: Item[],
      callback: (borrowedItems: Item[]) => T,
  ): T

  Execute callback with items from a clan stash and then restore those items to the stash

  During the execution of the callback, player will not be in the stash clan

  Type Parameters

  • T

  Parameters

  • clanIdOrName: string | number

    Clan id or name

  • items: Item[]
  • callback: (borrowedItems: Item[]) => T

  Returns T

• withStash<T>(
      clanIdOrName: string | number,
      items: Map<Item, number>,
      callback: (borrowedItems: Map<Item, number>) => T,
  ): T

  Execute callback with items from a clan stash and then restore those items to the stash

  During the execution of the callback, player will not be in the stash clan

  Type Parameters

  • T

  Parameters

  • clanIdOrName: string | number

    Clan id or name

  • items: Map<Item, number>
  • callback: (borrowedItems: Map<Item, number>) => T

  Returns T