IRCChannel

Represents an IRC channel and its state.

Description

A data container that stores information about an active IRC channel, including its name, topic, and the users currently present in the channel along with their privileges and modes.

Tutorials

IRCClient Developer Examples

Properties

String	modes	`""`
String	name	`""`
String	topic	`""`
String	topic_setter	`""`
int	topic_time	`0`

Methods

void	add_user(nick: String, modes: String = "")
String	get_user_modes(nick: String) const
PackedStringArray	get_users() const
bool	has_user(nick: String) const
bool	is_user_operator(nick: String) const
bool	is_user_voiced(nick: String) const
void	remove_user(nick: String)
void	set_user_modes(nick: String, modes: String)

Property Descriptions

String modes = "" 🔗

void set_modes(value: String)
String get_modes()

String representing the active channel modes.

String name = "" 🔗

void set_name(value: String)
String get_name()

Name of the IRC channel.

String topic = "" 🔗

void set_topic(value: String)
String get_topic()

Current topic of the channel.

String topic_setter = "" 🔗

void set_topic_setter(value: String)
String get_topic_setter()

Nickname of the user who last set the channel topic.

int topic_time = 0 🔗

void set_topic_time(value: int)
int get_topic_time()

Unix timestamp indicating when the topic was last set.

Method Descriptions

void add_user(nick: String, modes: String = "") 🔗

Adds a user to the internal channel tracker with the specified modes. nick represents the user's nickname, and modes determines their privileges (e.g., '+o').

String get_user_modes(nick: String) const 🔗

Returns a string representing the modes (e.g., 'o', 'v') of the specified user in the channel. nick is the user's nickname.

PackedStringArray get_users() const 🔗

Returns an array of all nicknames currently present in the channel.

bool has_user(nick: String) const 🔗

Returns true if the specified nickname resides within the channel tracking list. nick is the user's nickname.

bool is_user_operator(nick: String) const 🔗

Returns true if the user possesses operator privileges ('o'/'@') within the channel. nick is the user's nickname.

bool is_user_voiced(nick: String) const 🔗

Returns true if the user possesses voice privileges ('v'/'+') within the channel. nick is the user's nickname.

void remove_user(nick: String) 🔗

Removes a user from the channel tracking list. nick is the user's nickname.

void set_user_modes(nick: String, modes: String) 🔗

Sets the mode tracking strings for a specific user in the channel. nick is the user's nickname, and modes specifies the target modes.