GuildRoleBuilder

Allows a developer to build a Guild Role

local DiscordGuild = GuildRoleBuilder.new()
  :setName("my-discord-role")
  :setColor(0xFF0000)
  :setHoisted(true)
  :setMentionable(false)

Properties

The GuildRoleBuilder instance has no set properties!

GuildRoleBuilder : setName (

name: string
) -> Objects.GuildRoleBuilder

Sets the name of the Role

GuildRoleBuilder : setColor (

color: number
) -> Objects.GuildRoleBuilder

Sets the color of the Role.

GuildRoleBuilder : setHoisted (

hoisted: boolean
) -> Objects.GuildRoleBuilder

Sets weather this role will split users in the roles hierarchy in the guild.

GuildRoleBuilder : setIcon (

imageData: string
) -> Objects.GuildRoleBuilder

Sets the Icon for this role, the imageData should be a base64 encoded, 128x128 jpg file.

GuildRoleBuilder : setUnicodeEmoji (

unicodeEmoji: string
) -> Objects.GuildRoleBuilder

Sets the Emoji for this Role

GuildRoleBuilder : setPosition (

position: number
) -> Objects.GuildRoleBuilder

Set the position of this Role, this will update the roles hierarchy in the guild.

GuildRoleBuilder : setMentionable (

mentionable: boolean
) -> Objects.GuildRoleBuilder

Set if discord members can mention this Role.

GuildRoleBuilder : setFlags (

flags: number
) -> Objects.GuildRoleBuilder

Set the flags for the Guild

GuildRoleBuilder : toPayloadObject () -> Network.Resolvable

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

GuildRoleBuilder . new () -> ()

Creates a new instance of GuildRoleBuilder.