Class: UserIconUrl

HungryGames~ UserIconUrl


new UserIconUrl(url, id [, settings] [, fetchSize])

Create a container for an icon to show.
Parameters:
Name Type Argument Description
url string Url of icon.
id string Id of the user the icon belongs to.
settings object.<string> <optional>
Possible settings for the user related to how this icon should be displayed.
fetchSize number <optional>
Size of icon to fetch from Discord.
Source:

Members


<static, constant> fetchSize :number

The default size of the icon to request from discord.
Type:
  • number
Default Value:
  • 128
Source:

fetchSize :number

Size of the icon to request from Discord.
Type:
  • number
Source:

id :string

User ID.
Type:
  • string
Source:

settings :null|object.<string>

Optional user settings for displaying this icon.
Type:
  • null | object.<string>
Source:

url :string

Icon URL.
Type:
  • string
Source:

Methods


<static> from(victims [, attackers])

Get an array of icons urls from an array of users.
Parameters:
Name Type Argument Description
victims Array.<HungryGames~Player> | HungryGames~Player Array of users to process, or single user. Output will always be an array.
attackers Array.<HungryGames~Player> <optional>
Array of users to process.
Source:
Returns:
The user ids and urls for all users avatars.
Type
Array.<HungryGames~UserIconUrl>