Skip to content

WelcomeScreenBuilder

WelcomeScreenBuilder allows you to build welcome screens for discord guilds.

Usage:

local DiscordLuau = require("../Submodules/DiscordLuau")
local WelcomeScreenBuilder = DiscordLuau.WelcomeScreenBuilder.new()
:addChannel("1048686561685946489", "Super cool discord channel")
:setDescription("Yeah, a super awesome dsicord channel!")

Properties

The WelcomeScreenBuilder instance has no set properties!

Methods

addChannel

WelcomeScreenBuilder : addChannel (

     channelId: string
     description: string
     emojiId: string
     emojiName: string
)  -> Builders.WelcomeScreenBuilder

Adds a channel object to the guilds Welcome Screen

setDescription

WelcomeScreenBuilder : setDescription (

     description: string
)  -> Builders.WelcomeScreenBuilder

Adds a channel object to the guilds Welcome Screen

toPayloadObject

WelcomeScreenBuilder : toPayloadObject ()  -> Network.Resolvable

Converts the message to a JSON object that can be sent to the Discord API.

Functions

new

WelcomeScreenBuilder . new ()  -> ()

Creates a new instance of WelcomeScreenBuilder.