subgift
subgift
events are fired when a user gifts a subscription to another user in the channel.
Kind: global variable
Parameters
Param | Type | Default | Description |
---|---|---|---|
color | string | The color of the user's name in chat. | |
count | string | 1 | The total number of gifts the user has given in the channel. |
messageid | string | The ID of the message. | |
months | number | 1 | The length of the gift sub (for multi-month subs only). |
tenure | number | 1 | The total number of months the recipient has been subscribed. |
tier | number | 1 | The tier of the subscription being extended. |
timestamp | string | The millisecond timestamp when the message was sent. | |
userid2 | string | The ID of the user that is receiving the sub. | |
username2 | string | The username of the user that is receiving the sub. | |
userid | string | The ID of the user sending the message. | |
username | string | The username of the user sending the message. |
Examples
Fires a `subgift` event
Simulates a Tier 3 `subgift` event from glEnd2