FFZEmote

FFZEmote

new FFZEmote(channel, id, data)

Description:

  • An FFZ emote.

Source:
Parameters:
Name Type Description
channel Channel

Channel this emote belongs to.
id string

ID of the emote.
data data

The raw emote data.

Extends

Members

animated :boolean

Description:

  • If emote is animated.

Source:

If emote is animated.

Type:
  • boolean

channel :Channel

Description:

  • The channel this emote belongs to.
    Only accurate and constant on Twitch emotes.
    For other types of emotes, use the owner or ownerName property.

Source:
Overrides:

The channel this emote belongs to.
Only accurate and constant on Twitch emotes.
For other types of emotes, use the owner or ownerName property.

Type:

code :string

Description:

  • The code or name of the emote.

Source:
Overrides:

The code or name of the emote.

Type:
  • string

fetcher :EmoteFetcher

Description:

  • The emote fetcher.

Source:
Overrides:

The emote fetcher.

Type:

id :string

Description:

  • The ID of this emote.

Source:
Overrides:

The ID of this emote.

Type:
  • string

imageType :string

Description:

  • The image type of the emote.

Source:

The image type of the emote.

Type:
  • string

modifier :boolean

Description:

  • If the emote is a modifier and should be hidden.

Source:

If the emote is a modifier and should be hidden.

Type:
  • boolean

(readonly, nullable) owner :Channel

Description:

  • The channel of this emote's creator.
    Not guaranteed to contain the emote, or be cached.

Source:

The channel of this emote's creator.
Not guaranteed to contain the emote, or be cached.

Type:

(nullable) ownerName :string

Description:

  • The name of the emote creator's channel.

Source:

The name of the emote creator's channel.

Type:
  • string

sizes :Array.<string>

Description:

  • Available image sizes.

Source:

Available image sizes.

Type:
  • Array.<string>

type :string

Description:

  • The type of this emote.
    Either twitch, bttv, ffz, or '7tv'.

Source:
Overrides:

The type of this emote.
Either twitch, bttv, ffz, or '7tv'.

Type:
  • string

Methods

Description:

  • Gets the image link of the emote.

Source:
Parameters:
Name Type Default Description
size number 0

The size of the image.
Returns:
Type
string

toObject() → {object}

Description:

  • Override for toObject.
    Will result in an Object representation of a FFZEmote

Source:
Overrides:
Returns:
Type
object

(static) fromObject(emoteObjectopt, channelopt) → {FFZEmote}

Description:

  • Converts an emote Object into a FFZEmote

Source:
Parameters:
Name Type Attributes Default Description
emoteObject object <optional>

Object representation of this emote
channel Channel <optional>
 null

Channel this emote belongs to.
Returns:
Type
FFZEmote