Skip to content
Markski edited this page Nov 14, 2019 · 4 revisions

Don't forget: "Discord ID" is the actual ID that discord uses, whereas "Internal ID" is the integer needed to reference a given channel to the plugin. This is explained on the main page of this wiki.

DCC_FindChannelByName

  • Usage: DCC_FindChannelByName(const channel_name[]), where channel_name is the name of the channel.
  • Returns: Internal ID of the specified channel, with DCC_Channel tag.

DCC_FindChannelById

  • Usage: DCC_FindChannelByID(const channel_id[]), where channel_id is the Discord ID of the channel.
  • Returns: Internal ID of the specified channel, with DCC_Channel tag.

DCC_GetChannelId

  • Usage: DCC_GetChannelId(DCC_Channel:channel, dest[DCC_ID_SIZE], max_size = sizeof dest);, where channel is the internal id for the given channel, dest is an where the Discord ID will be stored as text, and max_size is the size of the given string.
  • Returns: (?) Relevant data is stored in the given parameter.

DCC_GetChannelType

  • Usage: DCC_GetChannelType(DCC_Channel:channel, &DCC_ChannelType:type), where channel is the internal id for the given channel, and type the variable where the channel type will be stored.
  • Returns: (?) Relevant data is stored in the given parameter.

DCC_GetChannelGuild

  • Usage: DCC_GetChannelGuild(DCC_Channel:channel, &DCC_Guild:guild), where channel is the internal id for the given channel, and guild the variable where the guild the channel belongs to will be stored.
  • Returns: (?) Relevant data is stored in the given parameter.

DCC_GetChannelName

  • Usage: DCC_GetChannelId(DCC_Channel:channel, dest[DCC_ID_SIZE], max_size = sizeof dest), where channel is the internal id for the given channel, dest is an where the channel's name will be stored as text, and max_size is the size of the given string.
  • Returns: (?) Relevant data is stored in the given parameter.

DCC_GetChannelTopic

  • Usage: DCC_GetChannelTopic(DCC_Channel:channel, dest[DCC_ID_SIZE], max_size = sizeof dest), where channel is the internal id for the given channel, dest is an where the channel's topic will be stored as text, and max_size is the size of the given string.
  • Returns: (?) Relevant data is stored in the given parameter.

DCC_GetChannelPosition

  • Usage: DCC_GetChannelPosition(DCC_Channel:channel, &position), where channel is the internal id for the given channel, and position is the variable where the channel's position will be stored.
  • Returns: (?) Relevant data is stored in the given parameter.

DCC_IsChannelNsfw

  • Usage: DCC_IsChannelNsfw(DCC_Channel:channel, &bool:is_nsfw), where channel is the internal id for the given channel, and is_nsfw is a boolean which will indicate wether the channel is NSFW or not.
  • Returns: (?) Relevant data is stored in the given parameter.

DCC_GetChannelParentCategory

  • Usage: DCC_GetChannelParentCategory(DCC_Channel:channel, &DCC_Channel:category), where channel is the internal id for the given channel, and category is a variable which will store the category the channel belongs to, if applicable, with a DCC_Channel tag.
  • Returns: (?) Relevant data is stored in the given parameter.

DCC_SendChannelMessage

  • Usage: DCC_SendChannelMessage(DCC_Channel:channel, const message[], const callback[] = "", const format[] = "", {Float, _}:...);, where channel is the internal id for the channel where the message must be sent, message is a string containing the given message, callback (optional) is a public function to be called when the message is confirmed as sent, format (optional) is a format specifier which allows to provide the forementioned function with parameters, and {Float, _}:... represents the space for said parameters to be given.
  • Returns: (?)