WelcomeScreen

Implementation of discords WelcomeScreen object as a Luau builder.

https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen-json-params

Summary

Properties

WelcomeScreen.enabled :: boolean?WelcomeScreen.description :: string?WelcomeScreen.welcomeChannels :: { Builders.Guild.WelcomeScreenChannel }

Methods

WelcomeScreen:setEnabled(enabled: boolean) → WelcomeScreenWelcomeScreen:setDescription(description: string) → WelcomeScreenWelcomeScreen:addChannel(channel: WelcomeScreenChannel.JSON) → WelcomeScreenWelcomeScreen:build() → JSON

Functions

WelcomeScreen.new(resource: { enabled: boolean?, description: string?, welcomeChannels: { WelcomeScreenChannel.JSON }?, }?) → WelcomeScreen

Properties

enabled

WelcomeScreen.enabled  :: boolean?

---

Whether the welcome screen is enabled or not.

description

WelcomeScreen.description  :: string?

---

The server description shown in the welcome screen.

welcomeChannels

WelcomeScreen.welcomeChannels  :: WelcomeScreenChannel }

---

The channels shown in the welcome screen.

Methods

setEnabled

WelcomeScreen : setEnabled ( enabled )  -> WelcomeScreen

Set weather the welcome screen is enabled or not.

Parameters

enabled: boolean

Returns

WelcomeScreen

setDescription

WelcomeScreen : setDescription ( description )  -> WelcomeScreen

Set the description of the welcome screen.

Parameters

description: string

Returns

WelcomeScreen

addChannel

WelcomeScreen : addChannel ( channel )  -> WelcomeScreen

Add an welcome screen channel to the welcome screen

Parameters

channel: JSON

Returns

WelcomeScreen

build

WelcomeScreen : build ( )  -> JSON

Responsible for building the WelcomeScreenObject JSON that can be parsed by the Discord API.

Returns

JSON

Functions

new

WelcomeScreen . new ( resource )  -> WelcomeScreen

Responsible for creating a new WelcomeScreen.

Parameters

resource: { enabled: boolean?, description: string?, welcomeChannels: { WelcomeScreenChannel.JSON, }

Returns

WelcomeScreen