Footer

Implementation of discords Footer object as a Luau builder.

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

Summary

Properties

Footer.text :: string?Footer.iconUrl :: string?Footer.proxyIconUrl :: string?

Methods

Footer:setText(text: string) → FooterFooter:setIcon(iconUrl: string, proxyIconUrl: string?) → FooterFooter:build() → JSON

Functions

Footer.new(resource: { text: string?, iconUrl: string?, proxyIconUrl: string?, }?) → Footer

Properties

text

Footer.text  :: string?

---

The text content that appears in the footer.

iconUrl

Footer.iconUrl  :: string?

---

The URL of the footer icon.

proxyIconUrl

Footer.proxyIconUrl  :: string?

---

The proxied URL of the footer icon.

Methods

setText

Footer : setText ( text )  -> Footer

Sets the footer text content.

Parameters

text: string

Returns

Footer

setIcon

Footer : setIcon ( iconUrl ,  proxyIconUrl )  -> Footer

Sets the footer icon URL and optional proxy icon URL.

Parameters

iconUrl: string
proxyIconUrl: string?

Returns

Footer

build

Footer : build ( )  -> JSON

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

Returns

JSON

Functions

new

Footer . new ( resource )  -> Footer

Responsible for creating a new Footer.

local footer = Footer.new({
  text = "Footer text",
  iconUrl = "https://example.com/icon.png"
})

Parameters

resource: { text: string?, iconUrl: string?, proxyIconUrl: string?, }

Returns

Footer