TwitchIRCClient

Inherits: RefCounted < Object

Network handler explicitly bound internally for Twitch IRC logic protocols natively.

Description

The base client socket layer implementing raw stream processing dynamically evaluating standard networking pipelines and replacing them with specific advanced external Twitch v3 architecture features securely tracking data without latency overhead safely.

Tutorials

• IRCClient Developer Examples

Methods

void	ban_user(channel: String, username: String, reason: String = "")
void	clear_chat(channel: String)
Error	connect_to_twitch(username: String, oauth_token: String, use_ssl: bool = true)
void	delete_message(channel: String, message_id: String)
void	disable_followers_only(channel: String)
void	disable_slow_mode(channel: String)
void	disconnect_from_twitch(quit_message: String = "")
Dictionary	get_global_user_state() const
IRCClient	get_irc_client()
PackedStringArray	get_joined_channels() const
Dictionary	get_room_state(channel: String) const
Dictionary	get_user_state(channel: String) const
bool	is_irc_connected() const
void	join_channel(channel: String)
void	part_channel(channel: String)
Error	poll()
void	request_twitch_capabilities()
void	send_action(channel: String, action: String)
void	send_message(channel: String, message: String)
void	send_whisper(username: String, message: String)
void	set_emote_only(channel: String, enabled: bool)
void	set_followers_only(channel: String, duration_minutes: int)
void	set_r9k_mode(channel: String, enabled: bool)
void	set_slow_mode(channel: String, duration: int)
void	set_subscribers_only(channel: String, enabled: bool)
void	timeout_user(channel: String, username: String, duration: int, reason: String = "")
void	unban_user(channel: String, username: String)

---

Signals

joined(channel: String) 🔗

Emitted when joined.

---

parted(channel: String, message: String) 🔗

Emitted when parted.

---

twitch_clearchat(channel: String, username: String, duration: int, tags: Dictionary) 🔗

Emitted when twitch clearchat.

---

twitch_clearmsg(channel: String, message: String, target_msg_id: String, tags: Dictionary) 🔗

Emitted when twitch clearmsg.

---

twitch_connected() 🔗

Emitted when twitch connected.

---

twitch_disconnected(reason: String) 🔗

Emitted when twitch disconnected.

---

twitch_globaluserstate(tags: Dictionary) 🔗

Emitted when twitch globaluserstate.

---

twitch_hosttarget(hosting_channel: String, target_channel: String, viewers: int) 🔗

Emitted when twitch hosttarget.

---

twitch_message(channel: String, sender: String, message: String, tags: Dictionary) 🔗

Emitted when twitch message.

---

twitch_notice(channel: String, msg_id: String, message: String, tags: Dictionary) 🔗

Emitted when twitch notice.

---

twitch_raid(channel: String, raider: String, viewer_count: int, tags: Dictionary) 🔗

Emitted when twitch raid.

---

twitch_ready() 🔗

Emitted when twitch ready.

---

twitch_reconnect() 🔗

Emitted when twitch reconnect.

---

twitch_roomstate(channel: String, tags: Dictionary) 🔗

Emitted when twitch roomstate.

---

twitch_subscription(channel: String, username: String, sub_plan: String, tags: Dictionary) 🔗

Emitted when twitch subscription.

---

twitch_usernotice(channel: String, msg_id: String, system_msg: String, tags: Dictionary) 🔗

Emitted when twitch usernotice.

---

twitch_userstate(channel: String, tags: Dictionary) 🔗

Emitted when twitch userstate.

---

twitch_whisper(sender: String, message: String, tags: Dictionary) 🔗

Emitted when twitch whisper.

---

user_joined(channel: String, user: String) 🔗

Emitted when user joined.

---

user_parted(channel: String, user: String) 🔗

Emitted when user parted.

---

Method Descriptions

void ban_user(channel: String, username: String, reason: String = "") 🔗

Ban user. channel - Channel. username - Username. reason - Reason.

---

void clear_chat(channel: String) 🔗

Clears all chat. channel - Channel.

---

Error connect_to_twitch(username: String, oauth_token: String, use_ssl: bool = true) 🔗

Initiates a secure external web or socket-based handshake actively verifying Twitch backend infrastructure limits utilizing standard credentials and automated Twitch Capability directives seamlessly.

---

void delete_message(channel: String, message_id: String) 🔗

Delete message. channel - Channel. message_id - Message id.

---

void disable_followers_only(channel: String) 🔗

Disables followers only. channel - Channel.

---

void disable_slow_mode(channel: String) 🔗

Disables slow mode. channel - Channel.

---

void disconnect_from_twitch(quit_message: String = "") 🔗

Disconnect from twitch. quit_message - Quit message.

---

Dictionary get_global_user_state() const 🔗

Returns the global user state.

---

IRCClient get_irc_client() 🔗

Returns the irc client.

---

PackedStringArray get_joined_channels() const 🔗

Returns array of all channel names you have joined.

---

Dictionary get_room_state(channel: String) const 🔗

Returns the room state. channel - Channel.

---

Dictionary get_user_state(channel: String) const 🔗

Returns the user state. channel - Channel.

---

bool is_irc_connected() const 🔗

Returns true if the client is connected to Twitch IRC and ready to send/receive messages.

---

void join_channel(channel: String) 🔗

Join channel. channel - Channel.

---

void part_channel(channel: String) 🔗

Part channel. channel - Channel.

---

Error poll() 🔗

Returns poll.

---

void request_twitch_capabilities() 🔗

Requests twitch capabilities from the server.

---

void send_action(channel: String, action: String) 🔗

Sends a CTCP ACTION message (/me action) to a channel or user. channel - Channel. action - Action.

---

void send_message(channel: String, message: String) 🔗

Sends message. channel - Channel. message - Message.

---

void send_whisper(username: String, message: String) 🔗

Sends whisper. username - Username. message - Message.

---

void set_emote_only(channel: String, enabled: bool) 🔗

Sets the emote only. channel - Channel. enabled - Enabled.

---

void set_followers_only(channel: String, duration_minutes: int) 🔗

Sets the followers only. channel - Channel. duration_minutes - Duration minutes.

---

void set_r9k_mode(channel: String, enabled: bool) 🔗

Sets the r9k mode. channel - Channel. enabled - Enabled.

---

void set_slow_mode(channel: String, duration: int) 🔗

Sets the slow mode. channel - Channel. duration - Duration.

---

void set_subscribers_only(channel: String, enabled: bool) 🔗

Sets the subscribers only. channel - Channel. enabled - Enabled.

---

void timeout_user(channel: String, username: String, duration: int, reason: String = "") 🔗

Timeout user. channel - Channel. username - Username. duration - Duration. reason - Reason.

---

void unban_user(channel: String, username: String) 🔗

Unban user. channel - Channel. username - Username.