Skip to content
Discord Luau

GuildBuilder

Properties

MFALevel

GuildBuilder.MFALevel  :: table

An enumeration of MFA levels.

  • None: 0
  • Elevated: 1

VerificationLevel

GuildBuilder.VerificationLevel  :: table

An enumeration of filter levels.

  • None: 0
  • Low: 1
  • Medium: 2
  • High: 2
  • VeryHigh: 2

NotificationLevel

GuildBuilder.NotificationLevel  :: table

An enumeration of filter levels.

  • AllMessages: 0
  • OnlyMentions: 1

ExplicitContentFilterLevel

GuildBuilder.ExplicitContentFilterLevel  :: table

An enumeration of filter levels.

  • Disabled: 0
  • MembersWithoutRoles: 1
  • AllMembers: 2

GuildFeature

GuildBuilder.GuildFeature  :: table

An enumeration of guild features.

  • AnimatedBanner: “ANIMATED_BANNER”
  • AnimatedIcon: “ANIMATED_ICON”
  • ApplicationCommandPermissionsV2: “APPLICATION_COMMAND_PERMISSIONS_V2”
  • AutoModeration: “AUTO_MODERATION”
  • Banner: “BANNER”
  • Community: “COMMUNITY”
  • CreatorMonetizableProvisional: “CREATOR_MONETIZABLE_PROVISIONAL”
  • CreatorStorePage: “CREATOR_STORE_PAGE”
  • DeveloperSupportServer: “DEVELOPER_SUPPORT_SERVER”
  • Discoverable: “DISCOVERABLE”
  • Featurable: “FEATURABLE”
  • InvitesDisabled: “INVITES_DISABLED”
  • InviteSplash: “INVITE_SPLASH”
  • MemberVerificationGateEnabled: “MEMBER_VERIFICATION_GATE_ENABLED”
  • MoreStickers: “MORE_STICKERS”
  • News: “NEWS”
  • Partnered: “PARTNERED”
  • PreviewEnabled: “PREVIEW_ENABLED”
  • RaidAlertsDisabled: “RAID_ALERTS_DISABLED”
  • RoleIcons: “ROLE_ICONS”
  • RoleSubscriptionsAvailableForPurchase: “ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE”
  • RoleSubscriptionsEnabled: “ROLE_SUBSCRIPTIONS_ENABLED”
  • TicketedEventsEnabled: “TICKETED_EVENTS_ENABLED”
  • VanityUrl: “VANITY_URL”
  • Verified: “VERIFIED”
  • VipRegions: “VIP_REGIONS”
  • WelcomeScreenEnabled: “WELCOME_SCREEN_ENABLED”

Methods

setName

GuildBuilder : setName (

     name: string
)  -> Objects.GuildBuilder

Sets the name of this discord guild.

setVerificationLevel

GuildBuilder : setVerificationLevel (

     verificationLevel: number
)  -> Objects.GuildBuilder

Sets the verification level for this guild.

setDefaultMessageNotificationLevel

GuildBuilder : setDefaultMessageNotificationLevel (

     notificationLevel: number
)  -> Objects.GuildBuilder

Sets the default message notification level for this guild.

setExplicitContentFilterLevel

GuildBuilder : setExplicitContentFilterLevel (

     notificationLevel: number
)  -> Objects.GuildBuilder

Sets the explicit content filter level for this guild.

setAfkChannelId

GuildBuilder : setAfkChannelId (

     channelId: string
)  -> Objects.GuildBuilder

Sets the discord Afk Voice Channel for this guild.

setAfkTimeout

GuildBuilder : setAfkTimeout (

     timeout: number
)  -> Objects.GuildBuilder

Sets the timeout for members in discord voice channels. Valid inputs are:

  • 60
  • 300
  • 900
  • 1800
  • 3600

setIcon

GuildBuilder : setIcon (

     imageData: string
)  -> Objects.GuildBuilder

Sets the icon of this guild. imageData must be a base64, 1024x1024, encoded binary data for either a png/jpeg/gif

setOwnerId

GuildBuilder : setOwnerId (

     ownerId: string
)  -> Objects.GuildBuilder

Sets the owner of this guild.

setSplash

GuildBuilder : setSplash (

     imageData: string
)  -> Objects.GuildBuilder

Sets the splash for this guild. imageData must be a 16:9, base64, encoded binary data for either a png/jpeg

setDiscoverySplash

GuildBuilder : setDiscoverySplash (

     imageData: string
)  -> Objects.GuildBuilder

Sets the discovery splash for this guild. imageData must be a 16:9, base64, encoded binary data for either a png/jpeg

setSysetBannerstemChannelId

GuildBuilder : setSysetBannerstemChannelId (

     imageData: string
)  -> Objects.GuildBuilder

Sets the banner for this guild. imageData must be a 16:9, base64, encoded binary data for either a png/jpeg

setSystemChannelId

GuildBuilder : setSystemChannelId (

     channelId: string
)  -> Objects.GuildBuilder

Sets the System Channel for this guild.

setSystemChannelFlags

GuildBuilder : setSystemChannelFlags (

     flags: number
)  -> Objects.GuildBuilder

Sets the flags for the System Channel in this guild.

setRulesChannelId

GuildBuilder : setRulesChannelId (

     channelId: string
)  -> Objects.GuildBuilder

Sets the rules channel for this guild.

setPublicUpdateChannelId

GuildBuilder : setPublicUpdateChannelId (

     channelId: string
)  -> Objects.GuildBuilder

Sets the public update channel for this guild

setPreferredLocale

GuildBuilder : setPreferredLocale (

     locale: string
)  -> Objects.GuildBuilder

Sets the preferred locale of this guild

addFeature

GuildBuilder : addFeature (

     feature: string
)  -> Objects.GuildBuilder

Enables developers to specify features that are apart of this guild.

setDescription

GuildBuilder : setDescription (

     description: string
)  -> Objects.GuildBuilder

Sets the description of this guild

setPremiumProgressBarEnabled

GuildBuilder : setPremiumProgressBarEnabled (

     enabled: boolean
)  -> Objects.GuildBuilder

Sets if the Premium Progress bar is enabled

setSafetyAlertsChannelId

GuildBuilder : setSafetyAlertsChannelId (

     channelId: string
)  -> Objects.GuildBuilder

Sets the Safety Alert channel id

addRole

GuildBuilder : addRole (

     role: Objects.GuildRoleBuilder
)  -> Objects.GuildBuilder

Enables developers to add a Role to a discord Guild channel upon creation.

addChannel

GuildBuilder : addChannel (

     channel: Objects.ChannelBuilder
)  -> Objects.GuildBuilder

Enables developers to add a Channel to a discord Guild channel upon creation.

toPayloadObject

GuildBuilder : toPayloadObject ()  -> Network.Resolvable

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

Functions

new

GuildBuilder . new ()  -> ()

Creates a new instance of GuildBuilder.