Author

Implementation of discords Author object as a Luau builder.

https://discord.com/developers/docs/resources/message#embed-object-embed-author-structure

Summary

Properties

Author.name :: string?Author.url :: string?Author.iconUrl :: string?Author.proxyIconUrl :: string?

Methods

Author:setName(name: string) → AuthorAuthor:setUrl(url: string) → AuthorAuthor:setIcon(iconUrl: string, proxyIconUrl: string?) → AuthorAuthor:build() → JSON

Functions

Author.new(resource: { name: string?, url: string?, iconUrl: string?, proxyIconUrl: string?, }?) → Author

Properties

name

Author.name  :: string?

---

The name of the author.

url

Author.url  :: string?

---

The url of the author.

iconUrl

Author.iconUrl  :: string?

---

The url of author’s icon image.

proxyIconUrl

Author.proxyIconUrl  :: string?

---

A proxied url of author’s icon image.

Methods

setName

Author : setName ( name )  -> Author

Set the image url for this embed.

Parameters

name: string

Returns

Author

setUrl

Author : setUrl ( url )  -> Author

Set the image height for this embed.

Parameters

url: string

Returns

Author

setIcon

Author : setIcon ( iconUrl ,  proxyIconUrl )  -> Author

Set the image height for this embed.

Parameters

iconUrl: string
proxyIconUrl: string?

Returns

Author

build

Author : build ( )  -> JSON

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

Returns

JSON

Functions

new

Author . new ( resource )  -> Author

Responsible for creating a new Author.

Parameters

resource: { name: string?, url: string?, iconUrl: string?, proxyIconUrl: string?, }

Returns

Author